GCOV - Varnish Cache


/*-
 * Copyright (c) 2010-2011 Varnish Software AS
 * All rights reserved.
 *
 * Author: Sanjoy Das <sanjoy@playingwithpointers.com>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * XXX: It might make sense to use just a single global list of all files
 * XXX: and use the call-private pointer to point to the file instance on
 * XXX: that list.
 * XXX: Duplicates in the global list can be avoided by examining the
 * XXX: dev+inode fields of the stat structure.
 * XXX: Individual files would need to be refcounted, so they can be
 * XXX: deleted when no VCL's reference them.
 *
 * XXX: We should periodically stat(2) the filename and check if the
 * XXX: underlying file has been updated.
 */

#include "config.h"

#include <stdlib.h>
#include <string.h>

#include "cache/cache.h"

#include "vfil.h"

#include "vcc_std_if.h"

struct frfile {
        unsigned                        magic;
#define CACHED_FILE_MAGIC 0xa8e9d87a
        char                            *file_name;
        void                            *contents;
        struct vrt_blob                 blob[1];
        int                             refcount;
        VTAILQ_ENTRY(frfile)            list;
};

static VTAILQ_HEAD(, frfile)    frlist = VTAILQ_HEAD_INITIALIZER(frlist);
static pthread_mutex_t          frmtx = PTHREAD_MUTEX_INITIALIZER;

static void
fini_frfile(VRT_CTX, void *ptr)
{
        struct frfile *frf;

        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
        CAST_OBJ_NOTNULL(frf, ptr, CACHED_FILE_MAGIC);

        PTOK(pthread_mutex_lock(&frmtx));
        if (--frf->refcount > 0)
                frf = NULL;
        else
                VTAILQ_REMOVE(&frlist, frf, list);
        PTOK(pthread_mutex_unlock(&frmtx));
        if (frf != NULL) {
                free(frf->contents);
                free(frf->file_name);
                FREE_OBJ(frf);
        }
}

static const struct vmod_priv_methods frfile_methods[1] = {{
        .magic = VMOD_PRIV_METHODS_MAGIC,
        .type = "vmod_std_fileread",
        .fini = fini_frfile
}};

static struct frfile *
find_frfile(struct vmod_priv *priv, VCL_STRING file_name)
{
        struct frfile *frf = NULL;
        char *s;
        ssize_t sz;

        AN(priv);

        if (file_name == NULL)
                return (NULL);

        if (priv->priv != NULL) {
                CAST_OBJ_NOTNULL(frf, priv->priv, CACHED_FILE_MAGIC);
                if (!strcmp(file_name, frf->file_name))
                        return (frf);
        }

        PTOK(pthread_mutex_lock(&frmtx));
        if (frf != NULL)
                frf->refcount--;
        VTAILQ_FOREACH(frf, &frlist, list) {
                if (!strcmp(file_name, frf->file_name)) {
                        frf->refcount++;
                        break;
                }
        }
        PTOK(pthread_mutex_unlock(&frmtx));
        if (frf != NULL) {
                priv->methods = frfile_methods;
                priv->priv = frf;
                return (frf);
        }

        s = VFIL_readfile(NULL, file_name, &sz);
        if (s != NULL) {
                assert(sz > 0);
                ALLOC_OBJ(frf, CACHED_FILE_MAGIC);
                AN(frf);
                REPLACE(frf->file_name, file_name);
                frf->refcount = 1;
                frf->contents = s;
                frf->blob->magic = VRT_BLOB_MAGIC;
                frf->blob->blob = s;
                frf->blob->len = (size_t)sz;
                priv->methods = frfile_methods;
                priv->priv = frf;
                PTOK(pthread_mutex_lock(&frmtx));
                VTAILQ_INSERT_HEAD(&frlist, frf, list);
                PTOK(pthread_mutex_unlock(&frmtx));
        }
        return (frf);
}

VCL_STRING v_matchproto_(td_std_fileread)
vmod_fileread(VRT_CTX, struct vmod_priv *priv, VCL_STRING file_name)
{
        struct frfile *frf;

        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
        AN(priv);

        frf = find_frfile(priv, file_name);
        if (frf == NULL)
                return (NULL);
        return (frf->contents);
}

VCL_BLOB v_matchproto_(td_std_blobread)
vmod_blobread(VRT_CTX, struct vmod_priv *priv, VCL_STRING file_name)
{
        struct frfile *frf;

        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
        AN(priv);

        frf = find_frfile(priv, file_name);
        if (frf == NULL)
                return (NULL);
        return (frf->blob);
}

		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	332	fini_frfile(VRT_CTX, void *ptr)
67		{
68		struct frfile *frf;
69
70	332	CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
71	332	CAST_OBJ_NOTNULL(frf, ptr, CACHED_FILE_MAGIC);
72
73	332	PTOK(pthread_mutex_lock(&frmtx));
74	332	if (--frf->refcount > 0)
75	200	frf = NULL;
76		else
77	132	VTAILQ_REMOVE(&frlist, frf, list);
78	332	PTOK(pthread_mutex_unlock(&frmtx));
79	332	if (frf != NULL) {
80	132	free(frf->contents);
81	132	free(frf->file_name);
82	132	FREE_OBJ(frf);
83	132	}
84	332	}
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	PTOK(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	PTOK(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->magic = VRT_BLOB_MAGIC;
135	280	frf->blob->blob = s;
136	280	frf->blob->len = (size_t)sz;
137	280	priv->methods = frfile_methods;
138	280	priv->priv = frf;
139	280	PTOK(pthread_mutex_lock(&frmtx));
140	280	VTAILQ_INSERT_HEAD(&frlist, frf, list);
141	280	PTOK(pthread_mutex_unlock(&frmtx));
142	280	}
143	440	return (frf);
144	1400	}
145
146		VCL_STRING v_matchproto_(td_std_fileread)
147	1040	vmod_fileread(VRT_CTX, struct vmod_priv *priv, VCL_STRING file_name)
148		{
149		struct frfile *frf;
150
151	1040	CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
152	1040	AN(priv);
153
154	1040	frf = find_frfile(priv, file_name);
155	1040	if (frf == NULL)
156	160	return (NULL);
157	880	return (frf->contents);
158	1040	}
159
160		VCL_BLOB v_matchproto_(td_std_blobread)
161	360	vmod_blobread(VRT_CTX, struct vmod_priv *priv, VCL_STRING file_name)
162		{
163		struct frfile *frf;
164
165	360	CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
166	360	AN(priv);
167
168	360	frf = find_frfile(priv, file_name);
169	360	if (frf == NULL)
170	0	return (NULL);
171	360	return (frf->blob);
172	360	}