varnish-cache/vmod/vmod_std_fileread.c
0
/*-
1
 * Copyright (c) 2010-2011 Varnish Software AS
2
 * All rights reserved.
3
 *
4
 * Author: Sanjoy Das <sanjoy@playingwithpointers.com>
5
 *
6
 * SPDX-License-Identifier: BSD-2-Clause
7
 *
8
 * Redistribution and use in source and binary forms, with or without
9
 * modification, are permitted provided that the following conditions
10
 * are met:
11
 * 1. Redistributions of source code must retain the above copyright
12
 *    notice, this list of conditions and the following disclaimer.
13
 * 2. Redistributions in binary form must reproduce the above copyright
14
 *    notice, this list of conditions and the following disclaimer in the
15
 *    documentation and/or other materials provided with the distribution.
16
 *
17
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20
 * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
21
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27
 * SUCH DAMAGE.
28
 *
29
 * XXX: It might make sense to use just a single global list of all files
30
 * XXX: and use the call-private pointer to point to the file instance on
31
 * XXX: that list.
32
 * XXX: Duplicates in the global list can be avoided by examining the
33
 * XXX: dev+inode fields of the stat structure.
34
 * XXX: Individual files would need to be refcounted, so they can be
35
 * XXX: deleted when no VCL's reference them.
36
 *
37
 * XXX: We should periodically stat(2) the filename and check if the
38
 * XXX: underlying file has been updated.
39
 */
40
41
#include "config.h"
42
43
#include <stdlib.h>
44
#include <string.h>
45
46
#include "cache/cache.h"
47
48
#include "vfil.h"
49
50
#include "vcc_std_if.h"
51
52
struct frfile {
53
        unsigned                        magic;
54
#define CACHED_FILE_MAGIC 0xa8e9d87a
55
        char                            *file_name;
56
        void                            *contents;
57
        struct vrt_blob                 blob[1];
58
        int                             refcount;
59
        VTAILQ_ENTRY(frfile)            list;
60
};
61
62
static VTAILQ_HEAD(, frfile)    frlist = VTAILQ_HEAD_INITIALIZER(frlist);
63
static pthread_mutex_t          frmtx = PTHREAD_MUTEX_INITIALIZER;
64
65
static void
66 212
fini_frfile(VRT_CTX, void *ptr)
67
{
68
        struct frfile *frf;
69
70 212
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
71 212
        CAST_OBJ_NOTNULL(frf, ptr, CACHED_FILE_MAGIC);
72
73 212
        AZ(pthread_mutex_lock(&frmtx));
74 212
        if (--frf->refcount > 0)
75 200
                frf = NULL;
76
        else
77 12
                VTAILQ_REMOVE(&frlist, frf, list);
78 212
        AZ(pthread_mutex_unlock(&frmtx));
79 212
        if (frf != NULL) {
80 12
                free(frf->contents);
81 12
                free(frf->file_name);
82 12
                FREE_OBJ(frf);
83 12
        }
84 212
}
85
86
static const struct vmod_priv_methods frfile_methods[1] = {{
87
        .magic = VMOD_PRIV_METHODS_MAGIC,
88
        .type = "vmod_std_fileread",
89
        .fini = fini_frfile
90
}};
91
92
static struct frfile *
93 1400
find_frfile(struct vmod_priv *priv, VCL_STRING file_name)
94
{
95 1400
        struct frfile *frf = NULL;
96
        char *s;
97
        ssize_t sz;
98
99 1400
        AN(priv);
100
101 1400
        if (file_name == NULL)
102 0
                return (NULL);
103
104 1400
        if (priv->priv != NULL) {
105 800
                CAST_OBJ_NOTNULL(frf, priv->priv, CACHED_FILE_MAGIC);
106 800
                if (!strcmp(file_name, frf->file_name))
107 160
                        return (frf);
108 640
        }
109
110 1240
        AZ(pthread_mutex_lock(&frmtx));
111 1240
        if (frf != NULL)
112 640
                frf->refcount--;
113 2600
        VTAILQ_FOREACH(frf, &frlist, list) {
114 2160
                if (!strcmp(file_name, frf->file_name)) {
115 800
                        frf->refcount++;
116 800
                        break;
117
                }
118 1360
        }
119 1240
        AZ(pthread_mutex_unlock(&frmtx));
120 1240
        if (frf != NULL) {
121 800
                priv->methods = frfile_methods;
122 800
                priv->priv = frf;
123 800
                return (frf);
124
        }
125
126 440
        s = VFIL_readfile(NULL, file_name, &sz);
127 440
        if (s != NULL) {
128 280
                assert(sz > 0);
129 280
                ALLOC_OBJ(frf, CACHED_FILE_MAGIC);
130 280
                AN(frf);
131 280
                REPLACE(frf->file_name, file_name);
132 280
                frf->refcount = 1;
133 280
                frf->contents = s;
134 280
                frf->blob->blob = s;
135 280
                frf->blob->len = (size_t)sz;
136 280
                priv->methods = frfile_methods;
137 280
                priv->priv = frf;
138 280
                AZ(pthread_mutex_lock(&frmtx));
139 280
                VTAILQ_INSERT_HEAD(&frlist, frf, list);
140 280
                AZ(pthread_mutex_unlock(&frmtx));
141 280
        }
142 440
        return (frf);
143 1400
}
144
145
VCL_STRING v_matchproto_(td_std_fileread)
146 1040
vmod_fileread(VRT_CTX, struct vmod_priv *priv, VCL_STRING file_name)
147
{
148
        struct frfile *frf;
149
150 1040
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
151 1040
        AN(priv);
152
153 1040
        frf = find_frfile(priv, file_name);
154 1040
        if (frf == NULL)
155 160
                return (NULL);
156 880
        return (frf->contents);
157 1040
}
158
159
VCL_BLOB v_matchproto_(td_std_blobread)
160 360
vmod_blobread(VRT_CTX, struct vmod_priv *priv, VCL_STRING file_name)
161
{
162
        struct frfile *frf;
163
164 360
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
165 360
        AN(priv);
166
167 360
        frf = find_frfile(priv, file_name);
168 360
        if (frf == NULL)
169 0
                return (NULL);
170 360
        return (frf->blob);
171 360
}