GCOV - Varnish Cache


/*-
 * Copyright (c) 2006 Verdens Gang AS
 * Copyright (c) 2006-2015 Varnish Software AS
 * All rights reserved.
 *
 * Author: Poul-Henning Kamp <phk@phk.freebsd.dk>
 *
 * 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.
 */

#include "config.h"

#include "cache_varnishd.h"
#include "cache_filter.h"
#include "cache_objhead.h"

void
VDP_Panic(struct vsb *vsb, const struct vdp_ctx *vdc)
{
        struct vdp_entry *vde;

        if (PAN_dump_struct(vsb, vdc, VDP_CTX_MAGIC, "vdc"))
                return;
        VSB_printf(vsb, "nxt = %p,\n", vdc->nxt);
        VSB_printf(vsb, "retval = %d,\n", vdc->retval);

        if (!VTAILQ_EMPTY(&vdc->vdp)) {
                VSB_cat(vsb, "filters = {\n");
                VSB_indent(vsb, 2);
                VTAILQ_FOREACH(vde, &vdc->vdp, list)
                        VSB_printf(vsb, "%s = %p { priv = %p }\n",
                            vde->vdp->name, vde, vde->priv);
                VSB_indent(vsb, -2);
                VSB_cat(vsb, "},\n");
        }

        VSB_indent(vsb, -2);
        VSB_cat(vsb, "},\n");
}

/*
 * Ensure that transports have called VDP_Close()
 * to avoid leaks in VDPs
 */
void
VDP_Fini(const struct vdp_ctx *vdc)
{
        assert(VTAILQ_EMPTY(&vdc->vdp));
}

void
VDP_Init(struct vdp_ctx *vdc, struct worker *wrk, struct vsl_log *vsl,
    const struct req *req, const struct busyobj *bo, intmax_t *clen)
{
        AN(vdc);
        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
        AN(vsl);

        AN(clen);

        assert((req ? 1 : 0) ^ (bo ? 1 : 0));

        AN(clen);
        assert(*clen >= -1);

        INIT_OBJ(vdc, VDP_CTX_MAGIC);
        VTAILQ_INIT(&vdc->vdp);
        vdc->wrk = wrk;
        vdc->vsl = vsl;
        vdc->clen = clen;

        if (req != NULL) {
                CHECK_OBJ(req, REQ_MAGIC);
                vdc->oc = req->objcore;
                vdc->hp = req->resp;
        }
        else {
                CHECK_OBJ_NOTNULL(bo, BUSYOBJ_MAGIC);
                vdc->oc = bo->bereq_body;
                vdc->hp = bo->bereq;
        }
}

/* VDP_bytes
 *
 * Pushes len bytes at ptr down the delivery processor list.
 *
 * This function picks and calls the next delivery processor from the
 * list. The return value is the return value of the delivery
 * processor. Upon seeing a non-zero return value, that lowest value
 * observed is latched in ->retval and all subsequent calls to
 * VDP_bytes will return that value directly without calling the next
 * processor.
 *
 * VDP_END marks the end of successful processing, it is issued by
 * VDP_DeliverObj() and may also be sent downstream by processors ending the
 * stream (for return value != 0)
 *
 * VDP_END must at most be received once per processor, so any VDP sending it
 * downstream must itself not forward it a second time.
 *
 * Valid return values (of VDP_bytes and any VDP function):
 * r < 0:  Error, breaks out early on an error condition
 * r == 0: Continue
 * r > 0:  Stop, breaks out early without error condition
 */

int
VDP_bytes(struct vdp_ctx *vdc, enum vdp_action act,
    const void *ptr, ssize_t len)
{
        int retval;
        struct vdp_entry *vdpe;

        CHECK_OBJ_NOTNULL(vdc, VDP_CTX_MAGIC);
        if (vdc->retval)
                return (vdc->retval);
        vdpe = vdc->nxt;
        CHECK_OBJ_NOTNULL(vdpe, VDP_ENTRY_MAGIC);

        /* at most one VDP_END call */
        assert(vdpe->end == VDP_NULL);

        if (act == VDP_NULL)
                assert(len > 0);
        else if (act == VDP_END)
                vdpe->end = VDP_END;
        else
                assert(act == VDP_FLUSH);

        /* Call the present layer, while pointing to the next layer down */
        vdc->nxt = VTAILQ_NEXT(vdpe, list);
        vdpe->calls++;
        vdc->bytes_done = len;
        retval = vdpe->vdp->bytes(vdc, act, &vdpe->priv, ptr, len);
        vdpe->bytes_in += vdc->bytes_done;
        if (retval && (vdc->retval == 0 || retval < vdc->retval))
                vdc->retval = retval; /* Latch error value */
        vdc->nxt = vdpe;
        return (vdc->retval);
}

int
VDP_Push(VRT_CTX, struct vdp_ctx *vdc, struct ws *ws, const struct vdp *vdp,
    void *priv)
{
        struct vdp_entry *vdpe;

        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
        CHECK_OBJ_NOTNULL(vdc, VDP_CTX_MAGIC);
        CHECK_OBJ_ORNULL(vdc->oc, OBJCORE_MAGIC);
        CHECK_OBJ_NOTNULL(vdc->hp, HTTP_MAGIC);
        AN(vdc->clen);
        assert(*vdc->clen >= -1);
        AN(ws);
        AN(vdp);
        AN(vdp->name);

        if (vdc->retval)
                return (vdc->retval);

        if (DO_DEBUG(DBG_PROCESSORS))
                VSLb(vdc->vsl, SLT_Debug, "VDP_push(%s)", vdp->name);

        vdpe = WS_Alloc(ws, sizeof *vdpe);
        if (vdpe == NULL) {
                AZ(vdc->retval);
                vdc->retval = -1;
                return (vdc->retval);
        }
        INIT_OBJ(vdpe, VDP_ENTRY_MAGIC);
        vdpe->vdp = vdp;
        vdpe->priv = priv;
        VTAILQ_INSERT_TAIL(&vdc->vdp, vdpe, list);
        vdc->nxt = VTAILQ_FIRST(&vdc->vdp);

        AZ(vdc->retval);
        if (vdpe->vdp->init != NULL)
                vdc->retval = vdpe->vdp->init(ctx, vdc, &vdpe->priv);
        vdc->oc = NULL;

        if (vdc->retval > 0) {
                VTAILQ_REMOVE(&vdc->vdp, vdpe, list);
                vdc->nxt = VTAILQ_FIRST(&vdc->vdp);
                vdc->retval = 0;
        }
        else if (vdc->retval == 0)
                AN(vdp->bytes);
        return (vdc->retval);
}

uint64_t
VDP_Close(struct vdp_ctx *vdc, struct objcore *oc, struct boc *boc)
{
        struct vdp_entry *vdpe;
        uint64_t rv = 0;

        CHECK_OBJ_NOTNULL(vdc, VDP_CTX_MAGIC);
        CHECK_OBJ_NOTNULL(vdc->wrk, WORKER_MAGIC);
        CHECK_OBJ_ORNULL(oc, OBJCORE_MAGIC);
        CHECK_OBJ_ORNULL(boc, BOC_MAGIC);

        while ((vdpe = VTAILQ_FIRST(&vdc->vdp)) != NULL) {
                CHECK_OBJ(vdpe, VDP_ENTRY_MAGIC);
                rv = vdpe->bytes_in;
                VSLb(vdc->vsl, SLT_VdpAcct, "%s %ju %ju", vdpe->vdp->name,
                    (uintmax_t)vdpe->calls, (uintmax_t)rv);
                if (vdpe->vdp->fini != NULL)
                        AZ(vdpe->vdp->fini(vdc, &vdpe->priv));
                AZ(vdpe->priv);
                VTAILQ_REMOVE(&vdc->vdp, vdpe, list);
                vdc->nxt = VTAILQ_FIRST(&vdc->vdp);
#ifdef VDP_PEDANTIC_ARMED
                // enable when we are confident to get VDP_END right
                if (vdc->nxt == NULL && vdc->retval >= 0)
                        assert(vdpe->end == VDP_END);
#endif
        }
        if (oc != NULL)
                HSH_Cancel(vdc->wrk, oc, boc);
        return (rv);
}

/*--------------------------------------------------------------------*/

int v_matchproto_(objiterate_f)
VDP_ObjIterate(void *priv, unsigned flush, const void *ptr, ssize_t len)
{
        enum vdp_action act;

        if (flush == 0)
                act = VDP_NULL;
        else if ((flush & OBJ_ITER_END) != 0)
                act = VDP_END;
        else
                act = VDP_FLUSH;

        return (VDP_bytes(priv, act, ptr, len));
}


int
VDP_DeliverObj(struct vdp_ctx *vdc, struct objcore *oc)
{
        int r, final;

        CHECK_OBJ_NOTNULL(vdc, VDP_CTX_MAGIC);
        CHECK_OBJ_NOTNULL(oc, OBJCORE_MAGIC);
        CHECK_OBJ_NOTNULL(vdc->wrk, WORKER_MAGIC);
        AN(vdc->vsl);
        AZ(vdc->oc);
        vdc->hp = NULL;
        vdc->clen = NULL;
        final = oc->flags & OC_F_TRANSIENT ? 1 : 0;
        r = ObjIterate(vdc->wrk, oc, vdc, VDP_ObjIterate, final);
        if (r < 0)
                return (r);
        return (0);
}

		varnish-cache/bin/varnishd/cache/cache_deliver_proc.c
0		/*-
1		* Copyright (c) 2006 Verdens Gang AS
2		* Copyright (c) 2006-2015 Varnish Software AS
3		* All rights reserved.
4		*
5		* Author: Poul-Henning Kamp <phk@phk.freebsd.dk>
6		*
7		* SPDX-License-Identifier: BSD-2-Clause
8		*
9		* Redistribution and use in source and binary forms, with or without
10		* modification, are permitted provided that the following conditions
11		* are met:
12		* 1. Redistributions of source code must retain the above copyright
13		* notice, this list of conditions and the following disclaimer.
14		* 2. Redistributions in binary form must reproduce the above copyright
15		* notice, this list of conditions and the following disclaimer in the
16		* documentation and/or other materials provided with the distribution.
17		*
18		* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19		* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20		* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21		* ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
22		* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23		* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24		* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25		* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26		* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27		* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28		* SUCH DAMAGE.
29		*/
30
31		#include "config.h"
32
33		#include "cache_varnishd.h"
34		#include "cache_filter.h"
35		#include "cache_objhead.h"
36
37		void
38	6	VDP_Panic(struct vsb vsb, const struct vdp_ctx vdc)
39		{
40		struct vdp_entry *vde;
41
42	6	if (PAN_dump_struct(vsb, vdc, VDP_CTX_MAGIC, "vdc"))
43	4	return;
44	2	VSB_printf(vsb, "nxt = %p,\n", vdc->nxt);
45	2	VSB_printf(vsb, "retval = %d,\n", vdc->retval);
46
47	2	if (!VTAILQ_EMPTY(&vdc->vdp)) {
48	1	VSB_cat(vsb, "filters = {\n");
49	1	VSB_indent(vsb, 2);
50	4	VTAILQ_FOREACH(vde, &vdc->vdp, list)
51	6	VSB_printf(vsb, "%s = %p { priv = %p }\n",
52	3	vde->vdp->name, vde, vde->priv);
53	1	VSB_indent(vsb, -2);
54	1	VSB_cat(vsb, "},\n");
55	1	}
56
57	2	VSB_indent(vsb, -2);
58	2	VSB_cat(vsb, "},\n");
59	6	}
60
61		/*
62		* Ensure that transports have called VDP_Close()
63		* to avoid leaks in VDPs
64		*/
65		void
66	4045	VDP_Fini(const struct vdp_ctx *vdc)
67		{
68	4045	assert(VTAILQ_EMPTY(&vdc->vdp));
69	4045	}
70
71		void
72	5730	VDP_Init(struct vdp_ctx vdc, struct worker wrk, struct vsl_log *vsl,
73		const struct req req, const struct busyobj bo, intmax_t *clen)
74		{
75	5730	AN(vdc);
76	5730	CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
77	5730	AN(vsl);
78
79	5730	AN(clen);
80
81	5730	assert((req ? 1 : 0) ^ (bo ? 1 : 0));
82
83	5730	AN(clen);
84	5730	assert(*clen >= -1);
85
86	5730	INIT_OBJ(vdc, VDP_CTX_MAGIC);
87	5730	VTAILQ_INIT(&vdc->vdp);
88	5730	vdc->wrk = wrk;
89	5730	vdc->vsl = vsl;
90	5730	vdc->clen = clen;
91
92	5730	if (req != NULL) {
93	3601	CHECK_OBJ(req, REQ_MAGIC);
94	3601	vdc->oc = req->objcore;
95	3601	vdc->hp = req->resp;
96	3601	}
97		else {
98	2129	CHECK_OBJ_NOTNULL(bo, BUSYOBJ_MAGIC);
99	2129	vdc->oc = bo->bereq_body;
100	2129	vdc->hp = bo->bereq;
101		}
102	5730	}
103
104		/* VDP_bytes
105		*
106		* Pushes len bytes at ptr down the delivery processor list.
107		*
108		* This function picks and calls the next delivery processor from the
109		* list. The return value is the return value of the delivery
110		* processor. Upon seeing a non-zero return value, that lowest value
111		* observed is latched in ->retval and all subsequent calls to
112		* VDP_bytes will return that value directly without calling the next
113		* processor.
114		*
115		* VDP_END marks the end of successful processing, it is issued by
116		* VDP_DeliverObj() and may also be sent downstream by processors ending the
117		* stream (for return value != 0)
118		*
119		* VDP_END must at most be received once per processor, so any VDP sending it
120		* downstream must itself not forward it a second time.
121		*
122		* Valid return values (of VDP_bytes and any VDP function):
123		* r < 0: Error, breaks out early on an error condition
124		* r == 0: Continue
125		* r > 0: Stop, breaks out early without error condition
126		*/
127
128		int
129	8076	VDP_bytes(struct vdp_ctx *vdc, enum vdp_action act,
130		const void *ptr, ssize_t len)
131		{
132		int retval;
133		struct vdp_entry *vdpe;
134
135	8076	CHECK_OBJ_NOTNULL(vdc, VDP_CTX_MAGIC);
136	8076	if (vdc->retval)
137	24	return (vdc->retval);
138	8052	vdpe = vdc->nxt;
139	8052	CHECK_OBJ_NOTNULL(vdpe, VDP_ENTRY_MAGIC);
140
141		/* at most one VDP_END call */
142	8052	assert(vdpe->end == VDP_NULL);
143
144	8052	if (act == VDP_NULL)
145	428	assert(len > 0);
146	7624	else if (act == VDP_END)
147	2770	vdpe->end = VDP_END;
148		else
149	4854	assert(act == VDP_FLUSH);
150
151		/* Call the present layer, while pointing to the next layer down */
152	8052	vdc->nxt = VTAILQ_NEXT(vdpe, list);
153	8052	vdpe->calls++;
154	8052	vdc->bytes_done = len;
155	8052	retval = vdpe->vdp->bytes(vdc, act, &vdpe->priv, ptr, len);
156	8052	vdpe->bytes_in += vdc->bytes_done;
157	8052	if (retval && (vdc->retval == 0 \|\| retval < vdc->retval))
158	56	vdc->retval = retval; /* Latch error value */
159	8052	vdc->nxt = vdpe;
160	8052	return (vdc->retval);
161	8076	}
162
163		int
164	5165	VDP_Push(VRT_CTX, struct vdp_ctx vdc, struct ws ws, const struct vdp *vdp,
165		void *priv)
166		{
167		struct vdp_entry *vdpe;
168
169	5165	CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
170	5165	CHECK_OBJ_NOTNULL(vdc, VDP_CTX_MAGIC);
171	5165	CHECK_OBJ_ORNULL(vdc->oc, OBJCORE_MAGIC);
172	5165	CHECK_OBJ_NOTNULL(vdc->hp, HTTP_MAGIC);
173	5165	AN(vdc->clen);
174	5165	assert(*vdc->clen >= -1);
175	5165	AN(ws);
176	5165	AN(vdp);
177	5165	AN(vdp->name);
178
179	5165	if (vdc->retval)
180	0	return (vdc->retval);
181
182	5165	if (DO_DEBUG(DBG_PROCESSORS))
183	0	VSLb(vdc->vsl, SLT_Debug, "VDP_push(%s)", vdp->name);
184
185	5165	vdpe = WS_Alloc(ws, sizeof *vdpe);
186	5165	if (vdpe == NULL) {
187	128	AZ(vdc->retval);
188	128	vdc->retval = -1;
189	128	return (vdc->retval);
190		}
191	5037	INIT_OBJ(vdpe, VDP_ENTRY_MAGIC);
192	5037	vdpe->vdp = vdp;
193	5037	vdpe->priv = priv;
194	5037	VTAILQ_INSERT_TAIL(&vdc->vdp, vdpe, list);
195	5037	vdc->nxt = VTAILQ_FIRST(&vdc->vdp);
196
197	5037	AZ(vdc->retval);
198	5037	if (vdpe->vdp->init != NULL)
199	4726	vdc->retval = vdpe->vdp->init(ctx, vdc, &vdpe->priv);
200	5037	vdc->oc = NULL;
201
202	5037	if (vdc->retval > 0) {
203	39	VTAILQ_REMOVE(&vdc->vdp, vdpe, list);
204	39	vdc->nxt = VTAILQ_FIRST(&vdc->vdp);
205	39	vdc->retval = 0;
206	39	}
207	4998	else if (vdc->retval == 0)
208	4990	AN(vdp->bytes);
209	5037	return (vdc->retval);
210	5165	}
211
212		uint64_t
213	5730	VDP_Close(struct vdp_ctx vdc, struct objcore oc, struct boc *boc)
214		{
215		struct vdp_entry *vdpe;
216	5730	uint64_t rv = 0;
217
218	5730	CHECK_OBJ_NOTNULL(vdc, VDP_CTX_MAGIC);
219	5730	CHECK_OBJ_NOTNULL(vdc->wrk, WORKER_MAGIC);
220	5730	CHECK_OBJ_ORNULL(oc, OBJCORE_MAGIC);
221	5730	CHECK_OBJ_ORNULL(boc, BOC_MAGIC);
222
223	10724	while ((vdpe = VTAILQ_FIRST(&vdc->vdp)) != NULL) {
224	4994	CHECK_OBJ(vdpe, VDP_ENTRY_MAGIC);
225	4994	rv = vdpe->bytes_in;
226	9988	VSLb(vdc->vsl, SLT_VdpAcct, "%s %ju %ju", vdpe->vdp->name,
227	4994	(uintmax_t)vdpe->calls, (uintmax_t)rv);
228	4994	if (vdpe->vdp->fini != NULL)
229	922	AZ(vdpe->vdp->fini(vdc, &vdpe->priv));
230	4994	AZ(vdpe->priv);
231	4994	VTAILQ_REMOVE(&vdc->vdp, vdpe, list);
232	4994	vdc->nxt = VTAILQ_FIRST(&vdc->vdp);
233		#ifdef VDP_PEDANTIC_ARMED
234		// enable when we are confident to get VDP_END right
235		if (vdc->nxt == NULL && vdc->retval >= 0)
236		assert(vdpe->end == VDP_END);
237		#endif
238		}
239	5730	if (oc != NULL)
240	3600	HSH_Cancel(vdc->wrk, oc, boc);
241	5730	return (rv);
242		}
243
244		/--------------------------------------------------------------------/
245
246		int v_matchproto_(objiterate_f)
247	4122	VDP_ObjIterate(void priv, unsigned flush, const void ptr, ssize_t len)
248		{
249		enum vdp_action act;
250
251	4122	if (flush == 0)
252	158	act = VDP_NULL;
253	3964	else if ((flush & OBJ_ITER_END) != 0)
254	2400	act = VDP_END;
255		else
256	1564	act = VDP_FLUSH;
257
258	4122	return (VDP_bytes(priv, act, ptr, len));
259		}
260
261
262		int
263	2338	VDP_DeliverObj(struct vdp_ctx vdc, struct objcore oc)
264		{
265		int r, final;
266
267	2338	CHECK_OBJ_NOTNULL(vdc, VDP_CTX_MAGIC);
268	2338	CHECK_OBJ_NOTNULL(oc, OBJCORE_MAGIC);
269	2338	CHECK_OBJ_NOTNULL(vdc->wrk, WORKER_MAGIC);
270	2338	AN(vdc->vsl);
271	2338	AZ(vdc->oc);
272	2338	vdc->hp = NULL;
273	2338	vdc->clen = NULL;
274	2338	final = oc->flags & OC_F_TRANSIENT ? 1 : 0;
275	2338	r = ObjIterate(vdc->wrk, oc, vdc, VDP_ObjIterate, final);
276	2338	if (r < 0)
277	40	return (r);
278	2298	return (0);
279	2338	}