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 5
                VTAILQ_FOREACH(vde, &vdc->vdp, list)
51 8
                        VSB_printf(vsb, "%s = %p { priv = %p }\n",
52 4
                            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 4078
VDP_Fini(const struct vdp_ctx *vdc)
67
{
68 4078
        assert(VTAILQ_EMPTY(&vdc->vdp));
69 4078
}
70
71
void
72 5774
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 5774
        AN(vdc);
76 5774
        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
77 5774
        AN(vsl);
78
79 5774
        AN(clen);
80
81 5774
        assert((req ? 1 : 0) ^ (bo ? 1 : 0));
82
83 5774
        AN(clen);
84 5774
        assert(*clen >= -1);
85
86 5774
        INIT_OBJ(vdc, VDP_CTX_MAGIC);
87 5774
        VTAILQ_INIT(&vdc->vdp);
88 5774
        vdc->wrk = wrk;
89 5774
        vdc->vsl = vsl;
90 5774
        vdc->clen = clen;
91
92 5774
        if (req != NULL) {
93 3642
                CHECK_OBJ(req, REQ_MAGIC);
94 3642
                vdc->oc = req->objcore;
95 3642
                vdc->hp = req->resp;
96 3642
        }
97
        else {
98 2132
                CHECK_OBJ_NOTNULL(bo, BUSYOBJ_MAGIC);
99 2132
                vdc->oc = bo->bereq_body;
100 2132
                vdc->hp = bo->bereq;
101
        }
102 5774
}
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 21254
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 21254
        CHECK_OBJ_NOTNULL(vdc, VDP_CTX_MAGIC);
136 21254
        if (vdc->retval)
137 24
                return (vdc->retval);
138 21230
        vdpe = vdc->nxt;
139 21230
        CHECK_OBJ_NOTNULL(vdpe, VDP_ENTRY_MAGIC);
140
141
        /* at most one VDP_END call */
142 21230
        assert(vdpe->end == VDP_NULL);
143
144 21230
        if (act == VDP_NULL)
145 668
                assert(len > 0);
146 20562
        else if (act == VDP_END)
147 2806
                vdpe->end = VDP_END;
148
        else
149 17756
                assert(act == VDP_FLUSH);
150
151
        /* Call the present layer, while pointing to the next layer down */
152 21230
        vdc->nxt = VTAILQ_NEXT(vdpe, list);
153 21230
        vdpe->calls++;
154 21230
        vdc->bytes_done = len;
155 21230
        retval = vdpe->vdp->bytes(vdc, act, &vdpe->priv, ptr, len);
156 21230
        vdpe->bytes_in += vdc->bytes_done;
157 21230
        if (retval && (vdc->retval == 0 || retval < vdc->retval))
158 56
                vdc->retval = retval; /* Latch error value */
159 21230
        vdc->nxt = vdpe;
160 21230
        return (vdc->retval);
161 21254
}
162
163
int
164 5220
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 5220
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
170 5220
        CHECK_OBJ_NOTNULL(vdc, VDP_CTX_MAGIC);
171 5220
        CHECK_OBJ_ORNULL(vdc->oc, OBJCORE_MAGIC);
172 5220
        CHECK_OBJ_NOTNULL(vdc->hp, HTTP_MAGIC);
173 5220
        AN(vdc->clen);
174 5220
        assert(*vdc->clen >= -1);
175 5220
        AN(ws);
176 5220
        AN(vdp);
177 5220
        AN(vdp->name);
178
179 5220
        if (vdc->retval)
180 0
                return (vdc->retval);
181
182 5220
        if (DO_DEBUG(DBG_PROCESSORS))
183 49
                VSLb(vdc->vsl, SLT_Debug, "VDP_push(%s)", vdp->name);
184
185 5220
        vdpe = WS_Alloc(ws, sizeof *vdpe);
186 5220
        if (vdpe == NULL) {
187 128
                AZ(vdc->retval);
188 128
                vdc->retval = -1;
189 128
                return (vdc->retval);
190
        }
191 5092
        INIT_OBJ(vdpe, VDP_ENTRY_MAGIC);
192 5092
        vdpe->vdp = vdp;
193 5092
        vdpe->priv = priv;
194 5092
        VTAILQ_INSERT_TAIL(&vdc->vdp, vdpe, list);
195 5092
        vdc->nxt = VTAILQ_FIRST(&vdc->vdp);
196
197 5092
        AZ(vdc->retval);
198 5092
        if (vdpe->vdp->init != NULL)
199 4782
                vdc->retval = vdpe->vdp->init(ctx, vdc, &vdpe->priv);
200 5092
        vdc->oc = NULL;
201
202 5092
        if (vdc->retval > 0) {
203 47
                VTAILQ_REMOVE(&vdc->vdp, vdpe, list);
204 47
                vdc->nxt = VTAILQ_FIRST(&vdc->vdp);
205 47
                vdc->retval = 0;
206 47
        }
207 5045
        else if (vdc->retval == 0)
208 5037
                AN(vdp->bytes);
209 5092
        return (vdc->retval);
210 5220
}
211
212
uint64_t
213 5774
VDP_Close(struct vdp_ctx *vdc, struct objcore *oc, struct boc *boc)
214
{
215
        struct vdp_entry *vdpe;
216 5774
        uint64_t rv = 0;
217
218 5774
        CHECK_OBJ_NOTNULL(vdc, VDP_CTX_MAGIC);
219 5774
        CHECK_OBJ_NOTNULL(vdc->wrk, WORKER_MAGIC);
220 5774
        CHECK_OBJ_ORNULL(oc, OBJCORE_MAGIC);
221 5774
        CHECK_OBJ_ORNULL(boc, BOC_MAGIC);
222
223 10801
        while ((vdpe = VTAILQ_FIRST(&vdc->vdp)) != NULL) {
224 5027
                CHECK_OBJ(vdpe, VDP_ENTRY_MAGIC);
225 5027
                rv = vdpe->bytes_in;
226 10054
                VSLb(vdc->vsl, SLT_VdpAcct, "%s %ju %ju", vdpe->vdp->name,
227 5027
                    (uintmax_t)vdpe->calls, (uintmax_t)rv);
228 5027
                if (vdpe->vdp->fini != NULL)
229 941
                        AZ(vdpe->vdp->fini(vdc, &vdpe->priv));
230 5027
                AZ(vdpe->priv);
231 5027
                VTAILQ_REMOVE(&vdc->vdp, vdpe, list);
232 5027
                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 5774
        if (oc != NULL)
240 3641
                HSH_Cancel(vdc->wrk, oc, boc);
241 5774
        return (rv);
242
}
243
244
/*--------------------------------------------------------------------*/
245
246
/*
247
 * Push a VDPIO vdp. This can only be used with only vdpio-enabled VDPs or
248
 * after a successful upgrade
249
 */
250
int
251 64
VDPIO_Push(VRT_CTX, struct vdp_ctx *vdc, struct ws *ws, const struct vdp *vdp,
252
    void *priv)
253
{
254
        struct vdp_entry *vdpe;
255
        int r;
256
257 64
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
258 64
        CHECK_OBJ_NOTNULL(vdc, VDP_CTX_MAGIC);
259 64
        CHECK_OBJ_ORNULL(vdc->oc, OBJCORE_MAGIC);
260 64
        CHECK_OBJ_NOTNULL(vdc->hp, HTTP_MAGIC);
261 64
        AN(vdc->clen);
262 64
        assert(*vdc->clen >= -1);
263 64
        AN(ws);
264 64
        AN(vdp);
265 64
        AN(vdp->name);
266
267 64
        if (vdc->retval < 0)
268 0
                return (vdc->retval);
269
270 64
        AN(vdp->io_init);
271
272
        // the first VDP (which leases from storage) only gets the minimum
273
        // capacity requirement of 1
274 64
        if (vdc->retval == 0) {
275 0
                assert(VTAILQ_EMPTY(&vdc->vdp));
276 0
                vdc->retval = 1;
277 0
        }
278
279 64
        if (DO_DEBUG(DBG_PROCESSORS))
280 64
                VSLb(vdc->vsl, SLT_Debug, "VDPIO_push(%s)", vdp->name);
281
282 64
        vdpe = WS_Alloc(ws, sizeof *vdpe);
283 64
        if (vdpe == NULL) {
284 0
                vdc->retval = -ENOMEM;
285 0
                return (vdc->retval);
286
        }
287 64
        INIT_OBJ(vdpe, VDP_ENTRY_MAGIC);
288 64
        vdpe->vdp = vdp;
289 64
        vdpe->priv = priv;
290 64
        VTAILQ_INSERT_TAIL(&vdc->vdp, vdpe, list);
291 64
        vdc->nxt = VTAILQ_FIRST(&vdc->vdp);
292
293 64
        assert(vdc->retval > 0);
294 64
        if (vdpe->vdp->io_init != NULL) {
295 64
                r = vdpe->vdp->io_init(ctx, vdc, &vdpe->priv, vdc->retval);
296 64
                if (r <= 0) {
297 0
                        VTAILQ_REMOVE(&vdc->vdp, vdpe, list);
298 0
                        vdc->nxt = VTAILQ_FIRST(&vdc->vdp);
299 0
                }
300
                else
301 64
                        AN(vdp->io_lease);
302 64
                if (r != 0)
303 64
                        vdc->retval = r;
304 64
        }
305 64
        vdc->oc = NULL;
306 64
        return (vdc->retval);
307 64
}
308
309
/*
310
 * upgrade an already initialized VDP filter chain to VDPIO, if possible
311
 * returns:
312
 * > 0 cap
313
 * -ENOTSUP io_upgrade missing for at least one filter
314
 * vdc->retval if < 0
315
 */
316
int
317 40
VDPIO_Upgrade(VRT_CTX, struct vdp_ctx *vdc)
318
{
319
        struct vdp_entry *vdpe;
320
        int cap, r;
321
322 40
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
323 40
        CHECK_OBJ_NOTNULL(vdc, VDP_CTX_MAGIC);
324
325 64
        VTAILQ_FOREACH(vdpe, &vdc->vdp, list)
326 32
                if (vdpe->vdp->io_upgrade == NULL)
327 8
                        return (-ENOTSUP);
328
329 32
        if (vdc->retval < 0)
330 0
                return (vdc->retval);
331
332
        // minimum capacity requirement for the first filter (after storage)
333 32
        r = cap = 1;
334 48
        VTAILQ_FOREACH(vdpe, &vdc->vdp, list) {
335 16
                r = vdpe->vdp->io_upgrade(ctx, vdc, &vdpe->priv, cap);
336 16
                if (DO_DEBUG(DBG_PROCESSORS)) {
337 32
                        VSLb(vdc->vsl, SLT_Debug, "VDPIO_Upgrade "
338
                            "%d = %s(cap = %d)",
339 16
                            r, vdpe->vdp->name, cap);
340 16
                }
341 16
                if (r < 0)
342 0
                        return ((vdc->retval = r));
343
                // XXX remove if filter does not want to be pushed?
344 16
                assert(r != 0);
345 16
                cap = r;
346 16
        }
347 32
        return ((vdc->retval = r));
348 40
}
349
350
uint64_t
351 80
VDPIO_Close1(struct vdp_ctx *vdc, struct vdp_entry *vdpe)
352
{
353
        uint64_t rv;
354
355 80
        CHECK_OBJ_NOTNULL(vdpe, VDP_ENTRY_MAGIC);
356 80
        rv = vdpe->bytes_in;
357 160
        VSLb(vdc->vsl, SLT_VdpAcct, "%s %ju %ju", vdpe->vdp->name,
358 80
            (uintmax_t)vdpe->calls, (uintmax_t)rv);
359 80
        if (vdpe->vdp->io_fini != NULL)
360 16
                vdpe->vdp->io_fini(vdc, &vdpe->priv);
361 80
        AZ(vdpe->priv);
362 80
        VTAILQ_REMOVE(&vdc->vdp, vdpe, list);
363 80
        vdc->nxt = VTAILQ_FIRST(&vdc->vdp);
364 80
        return (rv);
365
}
366
367
uint64_t
368 32
VDPIO_Close(struct vdp_ctx *vdc, struct objcore *oc, struct boc *boc)
369
{
370
        struct vdp_entry *vdpe;
371 32
        uint64_t rv = 0;
372
373 32
        CHECK_OBJ_NOTNULL(vdc, VDP_CTX_MAGIC);
374 32
        CHECK_OBJ_NOTNULL(vdc->wrk, WORKER_MAGIC);
375 32
        CHECK_OBJ_ORNULL(oc, OBJCORE_MAGIC);
376 32
        CHECK_OBJ_ORNULL(boc, BOC_MAGIC);
377
378 80
        while ((vdpe = VTAILQ_FIRST(&vdc->vdp)) != NULL)
379 48
                rv = VDPIO_Close1(vdc, vdpe);
380
381 32
        if (oc != NULL)
382 32
                HSH_Cancel(vdc->wrk, oc, boc);
383 32
        return (rv);
384
}
385
386
/*
387
 * ============================================================
388
 * VDPIO helpers: VAI management
389
 *
390
 * Transports should not need to talk to the VAI Object interface directly,
391
 * because its state is kept in the vdp_ctx
392
 *
393
 * So we wrap init, return and fini
394
 */
395
396
// return true if error
397
int
398 32
VDPIO_Init(struct vdp_ctx *vdc, struct objcore *oc, struct ws *ws,
399
    vai_notify_cb *notify_cb, void *notify_priv, struct vscaret *scaret)
400
{
401 32
        CHECK_OBJ_NOTNULL(vdc, VDP_CTX_MAGIC);
402 32
        VSCARET_CHECK_NOTNULL(scaret);
403 32
        AN(scaret->capacity);
404 32
        AZ(scaret->used);
405
406 32
        AZ(vdc->vai_hdl);
407 32
        vdc->vai_hdl = ObjVAIinit(vdc->wrk, oc, ws, notify_cb, notify_priv);
408 32
        if (vdc->vai_hdl == NULL)
409 0
                return (1);
410 32
        vdc->scaret = scaret;
411 32
        return (0);
412 32
}
413
414
// return leases stashed in scaret
415
void
416 35
VDPIO_Return(const struct vdp_ctx *vdc)
417
{
418 35
        CHECK_OBJ_NOTNULL(vdc, VDP_CTX_MAGIC);
419
420 35
        ObjVAIreturn(vdc->wrk, vdc->vai_hdl, vdc->scaret);
421 35
}
422
423
void
424 32
VDPIO_Fini(struct vdp_ctx *vdc)
425
{
426 32
        CHECK_OBJ_NOTNULL(vdc, VDP_CTX_MAGIC);
427
428 32
        VDPIO_Return(vdc);
429 32
        ObjVAIfini(vdc->wrk, &vdc->vai_hdl);
430 32
}
431
432
/*--------------------------------------------------------------------*/
433
int v_matchproto_(objiterate_f)
434 4156
VDP_ObjIterate(void *priv, unsigned flush, const void *ptr, ssize_t len)
435
{
436
        enum vdp_action act;
437
438 4156
        if (flush == 0)
439 392
                act = VDP_NULL;
440 3764
        else if ((flush & OBJ_ITER_END) != 0)
441 2411
                act = VDP_END;
442
        else
443 1353
                act = VDP_FLUSH;
444
445 4156
        return (VDP_bytes(priv, act, ptr, len));
446
}
447
448
449
int
450 2349
VDP_DeliverObj(struct vdp_ctx *vdc, struct objcore *oc)
451
{
452
        int r, final;
453
454 2349
        CHECK_OBJ_NOTNULL(vdc, VDP_CTX_MAGIC);
455 2349
        CHECK_OBJ_NOTNULL(oc, OBJCORE_MAGIC);
456 2349
        CHECK_OBJ_NOTNULL(vdc->wrk, WORKER_MAGIC);
457 2349
        AN(vdc->vsl);
458 2349
        AZ(vdc->oc);
459 2349
        vdc->hp = NULL;
460 2349
        vdc->clen = NULL;
461 2349
        final = oc->flags & OC_F_TRANSIENT ? 1 : 0;
462 2349
        r = ObjIterate(vdc->wrk, oc, vdc, VDP_ObjIterate, final);
463 2349
        if (r < 0)
464 40
                return (r);
465 2309
        return (0);
466 2349
}