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 12542
#include <stdio.h>
37 12542
#include <stdlib.h>
38 12542
39 12542
#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 937
ocstash_push(struct ocstash *stash, struct objcore **ocp)
63
{
64
65 937
        CHECK_OBJ_NOTNULL(stash, OCSTASH_MAGIC);
66 937
        assert(stash->n < stash->l);
67 937
        TAKE_OBJ_NOTNULL(stash->ocs[stash->n], ocp, OBJCORE_MAGIC);
68 937
        stash->n++;
69 937
}
70
71
static void
72 17815
ocstash_clear(struct worker *wrk, struct ocstash *stash)
73
{
74
        uint16_t u;
75
76 17815
        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
77 17815
        CHECK_OBJ_NOTNULL(stash, OCSTASH_MAGIC);
78 17815
        assert(stash->n <= stash->l);
79 18752
        for (u = 0; u < stash->n; u++)
80 937
                (void)HSH_DerefObjCore(wrk, &stash->ocs[u]);
81 176836
        for (; u < stash->l; u++)
82 159021
                AZ(stash->ocs[u]);
83 17815
        stash->n = 0;
84 17815
}
85
86
void
87 937
Req_StashObjcore(const struct req *req, struct objcore **ocp)
88
{
89
90 937
        CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
91 937
        ocstash_push(req->stash, ocp);
92 937
}
93
94
/*--------------------------------------------------------------------*/
95
96
void
97 22577
Req_AcctLogCharge(struct VSC_main_wrk *ds, struct req *req)
98
{
99
        struct acct_req *a;
100
101 22577
        AN(ds);
102 22577
        CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
103
104 22577
        a = &req->acct;
105
106 22577
        if (!IS_NO_VXID(req->vsl->wid) && !req->res_pipe) {
107 32696
                VSLb(req->vsl, SLT_ReqAcct, "%ju %ju %ju %ju %ju %ju",
108 16348
                    (uintmax_t)a->req_hdrbytes,
109 16348
                    (uintmax_t)a->req_bodybytes,
110 16348
                    (uintmax_t)(a->req_hdrbytes + a->req_bodybytes),
111 16348
                    (uintmax_t)a->resp_hdrbytes,
112 16348
                    (uintmax_t)a->resp_bodybytes,
113 16348
                    (uintmax_t)(a->resp_hdrbytes + a->resp_bodybytes));
114 16348
        }
115
116 22577
        if (IS_TOPREQ(req)) {
117
#define ACCT(foo) ds->s_##foo += a->foo;
118
#include "tbl/acct_fields_req.h"
119
        }
120 22577
        memset(a, 0, sizeof *a);
121 22577
}
122
123
void
124 4750
Req_LogHit(struct worker *wrk, struct req *req, struct objcore *oc,
125
    intmax_t fetch_progress)
126
{
127
        const char *clen, *sep;
128
129 4750
        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
130 4750
        CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
131 4750
        CHECK_OBJ_NOTNULL(oc, OBJCORE_MAGIC);
132
133 4750
        if (fetch_progress >= 0) {
134 437
                clen = HTTP_GetHdrPack(wrk, oc, H_Content_Length);
135 437
                if (clen == NULL)
136 35
                        clen = sep = "";
137
                else
138 402
                        sep = " ";
139 874
                VSLb(req->vsl, SLT_Hit, "%ju %.6f %.6f %.6f %jd%s%s",
140 437
                    VXID(ObjGetXID(wrk, oc)), EXP_Dttl(req, oc),
141 437
                    oc->grace, oc->keep,
142 437
                    fetch_progress, sep, clen);
143 437
        } else {
144 8626
                VSLb(req->vsl, SLT_Hit, "%ju %.6f %.6f %.6f",
145 4313
                    VXID(ObjGetXID(wrk, oc)), EXP_Dttl(req, oc),
146 4313
                    oc->grace, oc->keep);
147
        }
148 4750
}
149
150
const char *
151 15866
Req_LogStart(const struct worker *wrk, struct req *req)
152
{
153
        const char *ci, *cp, *endpname;
154
155 15866
        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
156 15866
        CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
157 15866
        CHECK_OBJ_NOTNULL(req->sp, SESS_MAGIC);
158
159 15866
        ci = SES_Get_String_Attr(req->sp, SA_CLIENT_IP);
160 15866
        cp = SES_Get_String_Attr(req->sp, SA_CLIENT_PORT);
161 15866
        CHECK_OBJ_NOTNULL(req->sp->listen_sock, LISTEN_SOCK_MAGIC);
162 15866
        endpname = req->sp->listen_sock->name;
163 15866
        AN(endpname);
164 15866
        VSLb(req->vsl, SLT_ReqStart, "%s %s %s", ci, cp, endpname);
165
166 15866
        return (ci);
167
}
168
169
/*--------------------------------------------------------------------
170
 * Alloc/Free a request
171
 */
172
173
struct req *
174 12578
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 12578
        CHECK_OBJ_NOTNULL(sp, SESS_MAGIC);
183 12578
        pp = sp->pool;
184 12578
        CHECK_OBJ_NOTNULL(pp, POOL_MAGIC);
185 12578
        CHECK_OBJ_ORNULL(preq, REQ_MAGIC);
186
187 12578
        req = MPL_Get(pp->mpl_req, &sz);
188 12578
        AN(req);
189 12578
        req->magic = REQ_MAGIC;
190 12578
        req->sp = sp;
191
192 12578
        e = (char*)req + sz;
193 12578
        p = (char*)(req + 1);
194 12578
        p = (void*)PRNDUP(p);
195 12578
        assert(p < e);
196
197 12578
        nhttp = (uint16_t)cache_param->http_max_hdr;
198 12578
        hl = HTTP_estimate(nhttp);
199
200 12578
        req->http = HTTP_create(p, nhttp, hl);
201 12578
        p += hl;
202 12578
        p = (void*)PRNDUP(p);
203 12578
        assert(p < e);
204
205 12578
        req->http0 = HTTP_create(p, nhttp, hl);
206 12578
        p += hl;
207 12578
        p = (void*)PRNDUP(p);
208 12578
        assert(p < e);
209
210 12578
        req->resp = HTTP_create(p, nhttp, hl);
211 12578
        p += hl;
212 12578
        p = (void*)PRNDUP(p);
213 12578
        assert(p < e);
214
215 12578
        sz = cache_param->vsl_buffer;
216 12578
        VSL_Init(req->vsl, p, sz);
217 12578
        p += sz;
218 12578
        p = (void*)PRNDUP(p);
219
220 12578
        req->vfc = (void*)p;
221 12578
        INIT_OBJ(req->vfc, VFP_CTX_MAGIC);
222 12578
        p = (void*)PRNDUP(p + sizeof(*req->vfc));
223
224 12578
        req->vdc = (void*)p;
225 12578
        ZERO_OBJ(req->vdc, sizeof *req->vdc);
226 12578
        p = (void*)PRNDUP(p + sizeof(*req->vdc));
227
228 12578
        req->htc = (void*)p;
229 12578
        INIT_OBJ(req->htc, HTTP_CONN_MAGIC);
230 12578
        req->htc->doclose = SC_NULL;
231 12578
        p = (void*)PRNDUP(p + sizeof(*req->htc));
232
233 12578
        if (UNLIKELY(preq != NULL))
234 1469
                req->top = preq->top;
235
        else {
236 11109
                req->top = (void*)p;
237 11109
                INIT_OBJ(req->top, REQTOP_MAGIC);
238 11109
                req->top->topreq = req;
239 11109
                p = (void*)PRNDUP(p + sizeof(*req->top));
240
        }
241
242 12578
        req->max_restarts = cache_param->max_restarts;
243 12578
        assert(req->max_restarts + 1 <= UINT16_MAX);
244
        // each restart may ref one stale_oc and one oc
245 12578
        l = (2 * req->max_restarts) + 1;
246 12578
        sz = SIZEOF_FLEX_OBJ(req->stash, ocs, l);
247 12578
        req->stash = (void*)p;
248 12578
        req->stash->magic = OCSTASH_MAGIC;
249 12578
        req->stash->l = l;
250 12578
        p += sz;
251 12578
        p = (void*)PRNDUP(p);
252
253 12578
        assert(p < e);
254
255 12578
        WS_Init(req->ws, "req", p, e - p);
256
257 12578
        req->t_first = NAN;
258 12578
        req->t_prev = NAN;
259 12578
        req->t_req = NAN;
260 12578
        req->req_step = R_STP_TRANSPORT;
261 12578
        req->doclose = SC_NULL;
262
263 12578
        return (req);
264
}
265
266
void
267 12542
Req_Release(struct req *req)
268
{
269
        struct sess *sp;
270
        struct pool *pp;
271
272 12542
        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 12542
        AZ(req->vcl);
280 12542
        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 12542
        TAKE_OBJ_NOTNULL(sp, &req->sp, SESS_MAGIC);
286
        pp = sp->pool;
287 12542
        CHECK_OBJ_NOTNULL(pp, POOL_MAGIC);
288 12542
        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 755
Req_Rollback(VRT_CTX)
304
{
305
        struct req *req;
306
307 755
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
308 755
        req = ctx->req;
309 755
        CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
310
311 755
        if (IS_TOPREQ(req))
312 744
                VCL_TaskLeave(ctx, req->top->privs);
313 755
        VCL_TaskLeave(ctx, req->privs);
314 755
        ocstash_clear(req->wrk, req->stash);
315 755
        VCL_TaskEnter(req->privs);
316 755
        if (IS_TOPREQ(req))
317 743
                VCL_TaskEnter(req->top->privs);
318 755
        HTTP_Clone(req->http, req->http0);
319 755
        req->vdp_filter_list = NULL;
320 755
        req->vfp_filter_list = NULL;
321 755
        req->vcf = NULL;
322 755
        if (WS_Overflowed(req->ws))
323 40
                req->wrk->stats->ws_client_overflow++;
324 755
        AN(req->ws_req);
325 755
        WS_Rollback(req->ws, req->ws_req);
326 755
}
327
328
/*----------------------------------------------------------------------
329
 * TODO: remove code duplication with cnt_recv_prep
330
 */
331
332
void
333 17061
Req_Cleanup(struct sess *sp, struct worker *wrk, struct req *req)
334
{
335
336 17061
        CHECK_OBJ_NOTNULL(sp, SESS_MAGIC);
337 17061
        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
338 17061
        CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
339 17061
        assert(sp == req->sp);
340 17061
        if (IS_TOPREQ(req))
341 15592
                AZ(req->top->vcl0);
342
343 17061
        AZ(req->director_hint);
344 17061
        req->restarts = 0;
345
346 17061
        ocstash_clear(wrk, req->stash);
347
348 17061
        if (req->vcl != NULL)
349 13987
                VCL_Recache(wrk, &req->vcl);
350
351
        /* Charge and log byte counters */
352 17061
        if (!IS_NO_VXID(req->vsl->wid)) {
353 16437
                Req_AcctLogCharge(wrk->stats, req);
354 16437
                if (!IS_SAME_VXID(req->vsl->wid, sp->vxid))
355 15821
                        VSL_End(req->vsl);
356
                else
357 616
                        req->vsl->wid = NO_VXID; /* ending an h2 stream 0 */
358 16437
        }
359
360 17061
        if (!isnan(req->t_prev) && req->t_prev > 0. && req->t_prev > sp->t_idle)
361 15485
                sp->t_idle = req->t_prev;
362
        else
363 1576
                sp->t_idle = W_TIM_real(wrk);
364
365 17061
        req->t_first = NAN;
366 17061
        req->t_prev = NAN;
367 17061
        req->t_req = NAN;
368 17061
        req->req_body_status = NULL;
369
370 17061
        req->hash_always_miss = 0;
371 17061
        req->hash_ignore_busy = 0;
372 17061
        req->hash_ignore_vary = 0;
373 17061
        req->esi_level = 0;
374 17061
        req->is_hit = 0;
375 17061
        req->req_step = R_STP_TRANSPORT;
376 17061
        req->vcf = NULL;
377 17061
        req->doclose = SC_NULL;
378 17061
        req->htc->doclose = SC_NULL;
379 17061
        req->htc->body_status = NULL;
380
381 17061
        if (WS_Overflowed(req->ws))
382 668
                wrk->stats->ws_client_overflow++;
383
384 17061
        wrk->seen_methods = 0;
385
386 17061
        VDP_Fini(req->vdc);
387 17061
}
388
389
/*----------------------------------------------------------------------
390
 * response body for vcl_synth {}
391
 */
392
393
static void
394 16
resp_u_storage(struct req *req)
395
{
396
397 16
        CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
398 16
        HSH_DerefBoc(req->wrk, req->objcore);
399 16
        (void)HSH_DerefObjCore(req->wrk, &req->objcore);
400 16
}
401
402
int
403 2140
Resp_l_storage(struct req *req, const struct stevedore *stv)
404
{
405
        int r;
406
407 2140
        CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
408 2140
        CHECK_OBJ_NOTNULL(stv, STEVEDORE_MAGIC);
409
410 2140
        if (req->objcore != NULL)
411 12
                resp_u_storage(req);
412 2140
        AZ(req->objcore);
413 2140
        req->objcore = HSH_Private(req->wrk);
414 2140
        CHECK_OBJ_NOTNULL(req->objcore, OBJCORE_MAGIC);
415 2140
        r = STV_NewObject(req->wrk, req->objcore, stv, 0);
416 2140
        if (r == 0)
417 4
                resp_u_storage(req);
418 2140
        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
}