varnish-cache/bin/varnishd/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 185684
#include <stdio.h>
37 185684
#include <stdlib.h>
38 185684
39 185684
#include "cache_varnishd.h"
40
#include "cache_filter.h"
41
#include "cache_pool.h"
42
#include "cache_transport.h"
43
44
#include "common/heritage.h"
45
#include "vtim.h"
46
47
void
48 125062
Req_AcctLogCharge(struct VSC_main_wrk *ds, struct req *req)
49
{
50
        struct acct_req *a;
51
52 125062
        AN(ds);
53 125062
        CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
54
55 125062
        a = &req->acct;
56
57 125062
        if (!IS_NO_VXID(req->vsl->wid) && !(req->res_mode & RES_PIPE)) {
58 180744
                VSLb(req->vsl, SLT_ReqAcct, "%ju %ju %ju %ju %ju %ju",
59 90372
                    (uintmax_t)a->req_hdrbytes,
60 90372
                    (uintmax_t)a->req_bodybytes,
61 90372
                    (uintmax_t)(a->req_hdrbytes + a->req_bodybytes),
62 90372
                    (uintmax_t)a->resp_hdrbytes,
63 90372
                    (uintmax_t)a->resp_bodybytes,
64 90372
                    (uintmax_t)(a->resp_hdrbytes + a->resp_bodybytes));
65 90372
        }
66
67 125062
        if (IS_TOPREQ(req)) {
68
#define ACCT(foo) ds->s_##foo += a->foo;
69
#include "tbl/acct_fields_req.h"
70 115983
        }
71 125062
        memset(a, 0, sizeof *a);
72 125062
}
73
74
void
75 26019
Req_LogHit(struct worker *wrk, struct req *req, struct objcore *oc,
76
    intmax_t fetch_progress)
77
{
78
        const char *clen, *sep;
79
80 26019
        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
81 26019
        CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
82 26019
        CHECK_OBJ_NOTNULL(oc, OBJCORE_MAGIC);
83
84 26019
        if (fetch_progress >= 0) {
85 2615
                clen = HTTP_GetHdrPack(wrk, oc, H_Content_Length);
86 2615
                if (clen == NULL)
87 212
                        clen = sep = "";
88
                else
89 2403
                        sep = " ";
90 5230
                VSLb(req->vsl, SLT_Hit, "%ju %.6f %.6f %.6f %jd%s%s",
91 2615
                    VXID(ObjGetXID(wrk, oc)), EXP_Dttl(req, oc),
92 2615
                    oc->grace, oc->keep,
93 2615
                    fetch_progress, sep, clen);
94 2615
        } else {
95 46808
                VSLb(req->vsl, SLT_Hit, "%ju %.6f %.6f %.6f",
96 23404
                    VXID(ObjGetXID(wrk, oc)), EXP_Dttl(req, oc),
97 23404
                    oc->grace, oc->keep);
98
        }
99 26019
}
100
101
const char *
102 87988
Req_LogStart(const struct worker *wrk, struct req *req)
103
{
104
        const char *ci, *cp, *endpname;
105
106 87988
        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
107 87988
        CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
108 87988
        CHECK_OBJ_NOTNULL(req->sp, SESS_MAGIC);
109
110 87988
        ci = SES_Get_String_Attr(req->sp, SA_CLIENT_IP);
111 87988
        cp = SES_Get_String_Attr(req->sp, SA_CLIENT_PORT);
112 87988
        CHECK_OBJ_NOTNULL(req->sp->listen_sock, LISTEN_SOCK_MAGIC);
113 87988
        endpname = req->sp->listen_sock->name;
114 87988
        AN(endpname);
115 87988
        VSLb(req->vsl, SLT_ReqStart, "%s %s %s", ci, cp, endpname);
116
117 87988
        return (ci);
118
}
119
120
/*--------------------------------------------------------------------
121
 * Alloc/Free a request
122
 */
123
124
struct req *
125 70290
Req_New(struct sess *sp)
126
{
127
        struct pool *pp;
128
        struct req *req;
129
        uint16_t nhttp;
130
        unsigned sz, hl;
131
        char *p, *e;
132
133 70290
        CHECK_OBJ_NOTNULL(sp, SESS_MAGIC);
134 70290
        pp = sp->pool;
135 70290
        CHECK_OBJ_NOTNULL(pp, POOL_MAGIC);
136
137 70290
        req = MPL_Get(pp->mpl_req, &sz);
138 70290
        AN(req);
139 70290
        req->magic = REQ_MAGIC;
140 70290
        req->sp = sp;
141
142 70290
        e = (char*)req + sz;
143 70290
        p = (char*)(req + 1);
144 70290
        p = (void*)PRNDUP(p);
145 70290
        assert(p < e);
146
147 70290
        nhttp = (uint16_t)cache_param->http_max_hdr;
148 70290
        hl = HTTP_estimate(nhttp);
149
150 70290
        req->http = HTTP_create(p, nhttp, hl);
151 70290
        p += hl;
152 70290
        p = (void*)PRNDUP(p);
153 70290
        assert(p < e);
154
155 70290
        req->http0 = HTTP_create(p, nhttp, hl);
156 70290
        p += hl;
157 70290
        p = (void*)PRNDUP(p);
158 70290
        assert(p < e);
159
160 70290
        req->resp = HTTP_create(p, nhttp, hl);
161 70290
        p += hl;
162 70290
        p = (void*)PRNDUP(p);
163 70290
        assert(p < e);
164
165 70290
        sz = cache_param->vsl_buffer;
166 70290
        VSL_Setup(req->vsl, p, sz);
167 70290
        p += sz;
168 70290
        p = (void*)PRNDUP(p);
169
170 70290
        req->vfc = (void*)p;
171 70290
        INIT_OBJ(req->vfc, VFP_CTX_MAGIC);
172 70290
        p = (void*)PRNDUP(p + sizeof(*req->vfc));
173
174 70290
        req->vdc = (void*)p;
175 70290
        memset(req->vdc, 0, sizeof *req->vdc);
176 70290
        p = (void*)PRNDUP(p + sizeof(*req->vdc));
177
178 70290
        req->htc = (void*)p;
179 70290
        INIT_OBJ(req->htc, HTTP_CONN_MAGIC);
180 70290
        req->htc->doclose = SC_NULL;
181 70290
        p = (void*)PRNDUP(p + sizeof(*req->htc));
182
183 70290
        req->top = (void*)p;
184 70290
        INIT_OBJ(req->top, REQTOP_MAGIC);
185 70290
        req->top->topreq = req;
186 70290
        p = (void*)PRNDUP(p + sizeof(*req->top));
187
188 70290
        assert(p < e);
189
190 70290
        WS_Init(req->ws, "req", p, e - p);
191
192 70290
        req->t_first = NAN;
193 70290
        req->t_prev = NAN;
194 70290
        req->t_req = NAN;
195 70290
        req->req_step = R_STP_TRANSPORT;
196 70290
        req->doclose = SC_NULL;
197
198 70290
        return (req);
199
}
200
201
void
202 69701
Req_Release(struct req *req)
203
{
204
        struct sess *sp;
205
        struct pool *pp;
206
207 69701
        CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
208
209
        /* Make sure the request counters have all been zeroed */
210
#define ACCT(foo) \
211
        AZ(req->acct.foo);
212
#include "tbl/acct_fields_req.h"
213
214 69701
        AZ(req->vcl);
215 69701
        if (!IS_NO_VXID(req->vsl->wid))
216 50
                VSL_End(req->vsl);
217
#ifdef ENABLE_WORKSPACE_EMULATOR
218
        WS_Rollback(req->ws, 0);
219
#endif
220 69701
        TAKE_OBJ_NOTNULL(sp, &req->sp, SESS_MAGIC);
221 69701
        pp = sp->pool;
222 69701
        CHECK_OBJ_NOTNULL(pp, POOL_MAGIC);
223 69701
        CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
224 69701
        MPL_AssertSane(req);
225 69701
        VSL_Flush(req->vsl, 0);
226 69701
        MPL_Free(pp->mpl_req, req);
227 69701
}
228
229
/*----------------------------------------------------------------------
230
 * TODO:
231
 * - check for code duplication with cnt_recv_prep
232
 * - re-check if complete
233
 * - XXX should PRIV_TOP use vcl0?
234
 * - XXX PRIV_TOP does not get rolled back, should it for !IS_TOPREQ ?
235
 */
236
237
void
238 4525
Req_Rollback(VRT_CTX)
239
{
240
        struct req *req;
241
242 4525
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
243 4525
        req = ctx->req;
244 4525
        CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
245
246 4525
        if (IS_TOPREQ(req))
247 4450
                VCL_TaskLeave(ctx, req->top->privs);
248 4525
        VCL_TaskLeave(ctx, req->privs);
249 4525
        VCL_TaskEnter(req->privs);
250 4525
        if (IS_TOPREQ(req))
251 4450
                VCL_TaskEnter(req->top->privs);
252 4525
        HTTP_Clone(req->http, req->http0);
253 4525
        req->vdp_filter_list = NULL;
254 4525
        req->vcf = NULL;
255 4525
        if (WS_Overflowed(req->ws))
256 250
                req->wrk->stats->ws_client_overflow++;
257 4525
        AN(req->ws_req);
258 4525
        WS_Rollback(req->ws, req->ws_req);
259 4525
}
260
261
/*----------------------------------------------------------------------
262
 * TODO: remove code duplication with cnt_recv_prep
263
 */
264
265
void
266 94209
Req_Cleanup(struct sess *sp, struct worker *wrk, struct req *req)
267
{
268
269 94209
        CHECK_OBJ_NOTNULL(sp, SESS_MAGIC);
270 94209
        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
271 94209
        CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
272 94209
        assert(sp == req->sp);
273 94209
        if (IS_TOPREQ(req))
274 85133
                AZ(req->top->vcl0);
275
276 94209
        AZ(req->director_hint);
277 94209
        req->restarts = 0;
278
279 94209
        if (req->vcl != NULL)
280 76631
                VCL_Recache(wrk, &req->vcl);
281
282
        /* Charge and log byte counters */
283 94209
        if (!IS_NO_VXID(req->vsl->wid)) {
284 90944
                Req_AcctLogCharge(wrk->stats, req);
285 90944
                if (!IS_SAME_VXID(req->vsl->wid, sp->vxid))
286 87734
                        VSL_End(req->vsl);
287
                else
288 3210
                        req->vsl->wid = NO_VXID; /* ending an h2 stream 0 */
289 90944
        }
290
291 94209
        if (!isnan(req->t_prev) && req->t_prev > 0. && req->t_prev > sp->t_idle)
292 87212
                sp->t_idle = req->t_prev;
293
        else
294 6997
                sp->t_idle = W_TIM_real(wrk);
295
296 94209
        req->t_first = NAN;
297 94209
        req->t_prev = NAN;
298 94209
        req->t_req = NAN;
299 94209
        req->req_body_status = NULL;
300
301 94209
        req->hash_always_miss = 0;
302 94209
        req->hash_ignore_busy = 0;
303 94209
        req->hash_ignore_vary = 0;
304 94209
        req->esi_level = 0;
305 94209
        req->is_hit = 0;
306 94209
        req->req_step = R_STP_TRANSPORT;
307 94209
        req->vcf = NULL;
308 94209
        req->doclose = SC_NULL;
309 94209
        req->htc->doclose = SC_NULL;
310
311 94209
        if (WS_Overflowed(req->ws))
312 4175
                wrk->stats->ws_client_overflow++;
313
314 94209
        wrk->seen_methods = 0;
315 94209
}
316
317
/*----------------------------------------------------------------------
318
 */
319
320
void v_matchproto_(vtr_req_fail_f)
321 725
Req_Fail(struct req *req, stream_close_t reason)
322
{
323 725
        CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
324
325 725
        AN(req->transport->req_fail);
326 725
        req->transport->req_fail(req, reason);
327 725
}