vinyl-cache/bin/vinyld/cache/cache_req.c
0
/*-
1
 * Copyright (c) 2006 Verdens Gang AS
2
 * Copyright (c) 2006-2011 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
 * Request management
31
 *
32
 */
33
34
#include "config.h"
35
36 12594
#include <stdio.h>
37 12594
#include <stdlib.h>
38 12594
39 12594
#include "cache_int.h"
40
#include "cache_filter.h"
41
#include "cache_objhead.h"
42
#include "cache_pool.h"
43
#include "cache_transport.h"
44
#include "storage/storage.h"            // stv_default
45
46
#include "common/heritage.h"
47
#include "vtim.h"
48
49
/*--------------------------------------------------------------------
50
 * Facility to keep obcore references until the end of the task across restarts
51
 */
52
53
struct ocstash {
54
        unsigned                magic;
55
#define OCSTASH_MAGIC           0x242031b5
56
        uint16_t                l;
57
        uint16_t                n;
58
        struct objcore *        ocs[] v_counted_by_(l);
59
};
60
61
static void
62 725
ocstash_push(struct ocstash *stash, struct objcore **ocp)
63
{
64
65 725
        CHECK_OBJ_NOTNULL(stash, OCSTASH_MAGIC);
66 725
        assert(stash->n < stash->l);
67 725
        TAKE_OBJ_NOTNULL(stash->ocs[stash->n], ocp, OBJCORE_MAGIC);
68 725
        stash->n++;
69 725
}
70
71
static void
72 17651
ocstash_clear(struct worker *wrk, struct ocstash *stash)
73
{
74
        uint16_t u;
75
76 17651
        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
77 17651
        CHECK_OBJ_NOTNULL(stash, OCSTASH_MAGIC);
78 17651
        assert(stash->n <= stash->l);
79 18376
        for (u = 0; u < stash->n; u++)
80 725
                (void)HSH_DerefObjCore(wrk, &stash->ocs[u]);
81 175408
        for (; u < stash->l; u++)
82 157757
                AZ(stash->ocs[u]);
83 17651
        stash->n = 0;
84 17651
}
85
86
void
87 725
Req_StashObjcore(const struct req *req, struct objcore **ocp)
88
{
89
90 725
        CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
91 725
        ocstash_push(req->stash, ocp);
92 725
}
93
94
/*--------------------------------------------------------------------*/
95
96
void
97 22631
Req_AcctLogCharge(struct VSC_main_wrk *ds, struct req *req)
98
{
99
        struct acct_req *a;
100
101 22631
        AN(ds);
102 22631
        CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
103
104 22631
        a = &req->acct;
105
106 22631
        if (!IS_NO_VXID(req->vsl->wid) && !req->res_pipe) {
107 32774
                VSLb(req->vsl, SLT_ReqAcct, "%ju %ju %ju %ju %ju %ju",
108 16387
                    (uintmax_t)a->req_hdrbytes,
109 16387
                    (uintmax_t)a->req_bodybytes,
110 16387
                    (uintmax_t)(a->req_hdrbytes + a->req_bodybytes),
111 16387
                    (uintmax_t)a->resp_hdrbytes,
112 16387
                    (uintmax_t)a->resp_bodybytes,
113 16387
                    (uintmax_t)(a->resp_hdrbytes + a->resp_bodybytes));
114 16387
        }
115
116 22631
        if (IS_TOPREQ(req)) {
117
#define ACCT(foo) ds->s_##foo += a->foo;
118
#include "tbl/acct_fields_req.h"
119
        }
120 22631
        memset(a, 0, sizeof *a);
121 22631
}
122
123
void
124 4753
Req_LogHit(struct worker *wrk, struct req *req, struct objcore *oc,
125
    intmax_t fetch_progress)
126
{
127
        const char *clen, *sep;
128
129 4753
        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
130 4753
        CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
131 4753
        CHECK_OBJ_NOTNULL(oc, OBJCORE_MAGIC);
132
133 4753
        if (fetch_progress >= 0) {
134 462
                clen = HTTP_GetHdrPack(wrk, oc, H_Content_Length);
135 462
                if (clen == NULL)
136 48
                        clen = sep = "";
137
                else
138 414
                        sep = " ";
139 924
                VSLb(req->vsl, SLT_Hit, "%ju %.6f %.6f %.6f %jd%s%s",
140 462
                    VXID(ObjGetXID(wrk, oc)), EXP_Dttl(req, oc),
141 462
                    oc->grace, oc->keep,
142 462
                    fetch_progress, sep, clen);
143 462
        } else {
144 8582
                VSLb(req->vsl, SLT_Hit, "%ju %.6f %.6f %.6f",
145 4291
                    VXID(ObjGetXID(wrk, oc)), EXP_Dttl(req, oc),
146 4291
                    oc->grace, oc->keep);
147
        }
148 4753
}
149
150
const char *
151 15906
Req_LogStart(const struct worker *wrk, struct req *req)
152
{
153
        const char *ci, *cp, *endpname;
154
155 15906
        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
156 15906
        CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
157 15906
        CHECK_OBJ_NOTNULL(req->sp, SESS_MAGIC);
158
159 15906
        ci = SES_Get_String_Attr(req->sp, SA_CLIENT_IP);
160 15906
        cp = SES_Get_String_Attr(req->sp, SA_CLIENT_PORT);
161 15906
        CHECK_OBJ_NOTNULL(req->sp->listen_sock, LISTEN_SOCK_MAGIC);
162 15906
        endpname = req->sp->listen_sock->name;
163 15906
        AN(endpname);
164 15906
        VSLb(req->vsl, SLT_ReqStart, "%s %s %s", ci, cp, endpname);
165
166 15906
        return (ci);
167
}
168
169
/*--------------------------------------------------------------------
170
 * Alloc/Free a request
171
 */
172
173
struct req *
174 12633
Req_New(struct sess *sp, const struct req *preq)
175
{
176
        struct pool *pp;
177
        struct req *req;
178
        uint16_t l, nhttp;
179
        unsigned sz, hl;
180
        char *p, *e;
181
182 12633
        CHECK_OBJ_NOTNULL(sp, SESS_MAGIC);
183 12633
        pp = sp->pool;
184 12633
        CHECK_OBJ_NOTNULL(pp, POOL_MAGIC);
185 12633
        CHECK_OBJ_ORNULL(preq, REQ_MAGIC);
186
187 12633
        req = MPL_Get(pp->mpl_req, &sz);
188 12633
        AN(req);
189 12633
        req->magic = REQ_MAGIC;
190 12633
        req->sp = sp;
191
192 12633
        e = (char*)req + sz;
193 12633
        p = (char*)(req + 1);
194 12633
        p = (void*)PRNDUP(p);
195 12633
        assert(p < e);
196
197 12633
        nhttp = (uint16_t)cache_param->http_max_hdr;
198 12633
        hl = HTTP_estimate(nhttp);
199
200 12633
        req->http = HTTP_create(p, nhttp, hl);
201 12633
        p += hl;
202 12633
        p = (void*)PRNDUP(p);
203 12633
        assert(p < e);
204
205 12633
        req->http0 = HTTP_create(p, nhttp, hl);
206 12633
        p += hl;
207 12633
        p = (void*)PRNDUP(p);
208 12633
        assert(p < e);
209
210 12633
        req->resp = HTTP_create(p, nhttp, hl);
211 12633
        p += hl;
212 12633
        p = (void*)PRNDUP(p);
213 12633
        assert(p < e);
214
215 12633
        sz = cache_param->vsl_buffer;
216 12633
        VSL_Init(req->vsl, p, sz);
217 12633
        p += sz;
218 12633
        p = (void*)PRNDUP(p);
219
220 12633
        req->vfc = (void*)p;
221 12633
        INIT_OBJ(req->vfc, VFP_CTX_MAGIC);
222 12633
        p = (void*)PRNDUP(p + sizeof(*req->vfc));
223
224 12633
        req->vdc = (void*)p;
225 12633
        ZERO_OBJ(req->vdc, sizeof *req->vdc);
226 12633
        p = (void*)PRNDUP(p + sizeof(*req->vdc));
227
228 12633
        req->htc = (void*)p;
229 12633
        INIT_OBJ(req->htc, HTTP_CONN_MAGIC);
230 12633
        req->htc->doclose = SC_NULL;
231 12633
        p = (void*)PRNDUP(p + sizeof(*req->htc));
232
233 12633
        if (UNLIKELY(preq != NULL))
234 1468
                req->top = preq->top;
235
        else {
236 11165
                req->top = (void*)p;
237 11165
                INIT_OBJ(req->top, REQTOP_MAGIC);
238 11165
                req->top->topreq = req;
239 11165
                p = (void*)PRNDUP(p + sizeof(*req->top));
240
        }
241
242 12633
        req->max_restarts = cache_param->max_restarts;
243 12633
        assert(req->max_restarts + 1 <= UINT16_MAX);
244
        // each restart may ref one stale_oc and one oc
245 12633
        l = (2 * req->max_restarts) + 1;
246 12633
        sz = SIZEOF_FLEX_OBJ(req->stash, ocs, l);
247 12633
        req->stash = (void*)p;
248 12633
        req->stash->magic = OCSTASH_MAGIC;
249 12633
        req->stash->l = l;
250 12633
        p += sz;
251 12633
        p = (void*)PRNDUP(p);
252
253 12633
        assert(p < e);
254
255 12633
        WS_Init(req->ws, "req", p, e - p);
256
257 12633
        req->t_first = NAN;
258 12633
        req->t_prev = NAN;
259 12633
        req->t_req = NAN;
260 12633
        req->req_step = R_STP_TRANSPORT;
261 12633
        req->doclose = SC_NULL;
262
263 12633
        return (req);
264
}
265
266
void
267 12594
Req_Release(struct req *req)
268
{
269
        struct sess *sp;
270
        struct pool *pp;
271
272 12594
        CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
273
274
        /* Make sure the request counters have all been zeroed */
275
#define ACCT(foo) \
276
        AZ(req->acct.foo);
277
#include "tbl/acct_fields_req.h"
278
279 12594
        AZ(req->vcl);
280 12594
        if (!IS_NO_VXID(req->vsl->wid))
281 8
                VSL_End(req->vsl);
282
#ifdef ENABLE_WORKSPACE_EMULATOR
283
        WS_Rollback(req->ws, 0);
284
#endif
285 12594
        TAKE_OBJ_NOTNULL(sp, &req->sp, SESS_MAGIC);
286
        pp = sp->pool;
287 12594
        CHECK_OBJ_NOTNULL(pp, POOL_MAGIC);
288 12594
        CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
289
        MPL_AssertSane(req);
290
        VSL_Flush(req->vsl, 0);
291
        MPL_Free(pp->mpl_req, req);
292
}
293
294
/*----------------------------------------------------------------------
295
 * TODO:
296
 * - check for code duplication with cnt_recv_prep
297
 * - re-check if complete
298
 * - XXX should PRIV_TOP use vcl0?
299
 * - XXX PRIV_TOP does not get rolled back, should it for !IS_TOPREQ ?
300
 */
301
302
void
303 552
Req_Rollback(VRT_CTX)
304
{
305
        struct req *req;
306
307 552
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
308 552
        req = ctx->req;
309 552
        CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
310
311 552
        if (IS_TOPREQ(req))
312 540
                VCL_TaskLeave(ctx, req->top->privs);
313 552
        VCL_TaskLeave(ctx, req->privs);
314 552
        ocstash_clear(req->wrk, req->stash);
315 552
        VCL_TaskEnter(req->privs);
316 552
        if (IS_TOPREQ(req))
317 540
                VCL_TaskEnter(req->top->privs);
318 552
        HTTP_Clone(req->http, req->http0);
319 552
        req->vdp_filter_list = NULL;
320 552
        req->vfp_filter_list = NULL;
321 552
        req->vcf = NULL;
322 552
        if (WS_Overflowed(req->ws))
323 40
                req->wrk->stats->ws_client_overflow++;
324 552
        AN(req->ws_req);
325 552
        WS_Rollback(req->ws, req->ws_req);
326 552
}
327
328
/*----------------------------------------------------------------------
329
 * TODO: remove code duplication with cnt_recv_prep
330
 */
331
332
void
333 17099
Req_Cleanup(struct sess *sp, struct worker *wrk, struct req *req)
334
{
335
336 17099
        CHECK_OBJ_NOTNULL(sp, SESS_MAGIC);
337 17099
        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
338 17099
        CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
339 17099
        assert(sp == req->sp);
340 17099
        if (IS_TOPREQ(req))
341 15631
                AZ(req->top->vcl0);
342
343 17099
        AZ(req->director_hint);
344 17099
        req->restarts = 0;
345
346 17099
        ocstash_clear(wrk, req->stash);
347
348 17099
        if (req->vcl != NULL)
349 14029
                VCL_Recache(wrk, &req->vcl);
350
351
        /* Charge and log byte counters */
352 17099
        if (!IS_NO_VXID(req->vsl->wid)) {
353 16474
                Req_AcctLogCharge(wrk->stats, req);
354 16474
                if (!IS_SAME_VXID(req->vsl->wid, sp->vxid))
355 15859
                        VSL_End(req->vsl);
356
                else
357 615
                        req->vsl->wid = NO_VXID; /* ending an h2 stream 0 */
358 16474
        }
359
360 17099
        if (!isnan(req->t_prev) && req->t_prev > 0. && req->t_prev > sp->t_idle)
361 15524
                sp->t_idle = req->t_prev;
362
        else
363 1575
                sp->t_idle = W_TIM_real(wrk);
364
365 17099
        req->t_first = NAN;
366 17099
        req->t_prev = NAN;
367 17099
        req->t_req = NAN;
368 17099
        req->req_body_status = NULL;
369
370 17099
        req->hash_always_miss = 0;
371 17099
        req->hash_ignore_busy = 0;
372 17099
        req->hash_ignore_vary = 0;
373 17099
        req->esi_level = 0;
374 17099
        req->is_hit = 0;
375 17099
        req->req_step = R_STP_TRANSPORT;
376 17099
        req->vcf = NULL;
377 17099
        req->doclose = SC_NULL;
378 17099
        req->htc->doclose = SC_NULL;
379 17099
        req->htc->body_status = NULL;
380
381 17099
        if (WS_Overflowed(req->ws))
382 672
                wrk->stats->ws_client_overflow++;
383
384 17099
        wrk->seen_methods = 0;
385
386 17099
        VDP_Fini(req->vdc);
387 17099
}
388
389
/*----------------------------------------------------------------------
390
 * response body for vcl_synth {}
391
 */
392
393
static void
394 20
resp_u_storage(struct req *req)
395
{
396
397 20
        CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
398 20
        HSH_DerefBoc(req->wrk, req->objcore);
399 20
        (void)HSH_DerefObjCore(req->wrk, &req->objcore);
400 20
}
401
402
int
403 1964
Resp_l_storage(struct req *req, const struct stevedore *stv)
404
{
405
        int r;
406
407 1964
        CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
408 1964
        CHECK_OBJ_NOTNULL(stv, STEVEDORE_MAGIC);
409
410 1964
        if (req->objcore != NULL)
411 12
                resp_u_storage(req);
412 1964
        AZ(req->objcore);
413 1964
        req->objcore = HSH_Private(req->wrk);
414 1964
        CHECK_OBJ_NOTNULL(req->objcore, OBJCORE_MAGIC);
415 1964
        r = STV_NewObject(req->wrk, req->objcore, stv, 0);
416 1964
        if (r == 0)
417 8
                resp_u_storage(req);
418 1964
        return (r);
419
}
420
421
422
/*----------------------------------------------------------------------
423
 */
424
425
void v_matchproto_(vtr_req_fail_f)
426 120
Req_Fail(struct req *req, stream_close_t reason)
427
{
428 120
        CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
429
430 120
        AN(req->transport->req_fail);
431 120
        req->transport->req_fail(req, reason);
432 120
}