varnish-cache/bin/varnishd/cache/cache_backend.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
 * The director implementation for VCL backends.
31
 *
32
 */
33
34
#include "config.h"
35
36
#include <stdlib.h>
37
38
#include "cache_varnishd.h"
39
#include "cache_director.h"
40
41
#include "vtcp.h"
42
#include "vtim.h"
43
#include "vsa.h"
44
45
#include "cache_backend.h"
46
#include "cache_conn_pool.h"
47
#include "cache_transport.h"
48
#include "cache_vcl.h"
49
#include "http1/cache_http1.h"
50
#include "proxy/cache_proxy.h"
51
52
#include "VSC_vbe.h"
53
54
/*--------------------------------------------------------------------*/
55
56
enum connwait_e {
57
        CW_DO_CONNECT = 1,
58
        CW_QUEUED,
59
        CW_DEQUEUED,
60
        CW_BE_BUSY,
61
};
62
63
struct connwait {
64
        unsigned                        magic;
65
#define CONNWAIT_MAGIC                  0x75c7a52b
66
        enum connwait_e                 cw_state;
67
        VTAILQ_ENTRY(connwait)          cw_list;
68
        pthread_cond_t                  cw_cond;
69
};
70
71
static const char * const vbe_proto_ident = "HTTP Backend";
72
73
static struct lock backends_mtx;
74
75
/*--------------------------------------------------------------------*/
76
77
void
78 1877
VBE_Connect_Error(struct VSC_vbe *vsc, int err)
79
{
80
81 1877
        switch(err) {
82
        case 0:
83
                /*
84
                 * This is kind of brittle, but zero is the only
85
                 * value of errno we can trust to have no meaning.
86
                 */
87 820
                vsc->helddown++;
88 820
                break;
89
        case EACCES:
90
        case EPERM:
91 0
                vsc->fail_eacces++;
92 0
                break;
93
        case EADDRNOTAVAIL:
94 0
                vsc->fail_eaddrnotavail++;
95 0
                break;
96
        case ECONNREFUSED:
97 1057
                vsc->fail_econnrefused++;
98 1057
                break;
99
        case ENETUNREACH:
100 0
                vsc->fail_enetunreach++;
101 0
                break;
102
        case ETIMEDOUT:
103 0
                vsc->fail_etimedout++;
104 0
                break;
105
        default:
106 0
                vsc->fail_other++;
107 0
        }
108 1877
}
109
110
/*--------------------------------------------------------------------*/
111
112
#define FIND_TMO(tmx, dst, bo, be)                                      \
113
        do {                                                            \
114
                CHECK_OBJ_NOTNULL(bo, BUSYOBJ_MAGIC);                   \
115
                dst = bo->tmx;                                          \
116
                if (isnan(dst) && be->tmx >= 0.0)                       \
117
                        dst = be->tmx;                                  \
118
                if (isnan(dst))                                         \
119
                        dst = cache_param->tmx;                         \
120
        } while (0)
121
122
#define FIND_BE_SPEC(tmx, dst, be, def)                                 \
123
        do {                                                            \
124
                CHECK_OBJ_NOTNULL(bp, BACKEND_MAGIC);                   \
125
                dst = be->tmx;                                          \
126
                if (dst == def)                                         \
127
                        dst = cache_param->tmx;                         \
128
        } while (0)
129
130
#define FIND_BE_PARAM(tmx, dst, be)                                     \
131
        FIND_BE_SPEC(tmx, dst, be, 0)
132
133
#define FIND_BE_TMO(tmx, dst, be)                                       \
134
        FIND_BE_SPEC(tmx, dst, be, -1.0)
135
136
#define BE_BUSY(be)     \
137
        (be->max_connections > 0 && be->n_conn >= be->max_connections)
138
139
/*--------------------------------------------------------------------*/
140
141
static void
142 2846
vbe_connwait_broadcast(const struct backend *bp)
143
{
144
        struct connwait *cw;
145
146 2846
        CHECK_OBJ_NOTNULL(bp, BACKEND_MAGIC);
147
148 2846
        Lck_Lock(bp->director->mtx);
149 3206
        VTAILQ_FOREACH(cw, &bp->cw_head, cw_list) {
150 360
                CHECK_OBJ(cw, CONNWAIT_MAGIC);
151 360
                assert(cw->cw_state == CW_QUEUED);
152 360
                PTOK(pthread_cond_signal(&cw->cw_cond));
153 360
        }
154 2846
        Lck_Unlock(bp->director->mtx);
155 2846
}
156
157
static void
158 89837
vbe_connwait_signal_locked(const struct backend *bp)
159
{
160
        struct connwait *cw;
161
162 89837
        Lck_AssertHeld(bp->director->mtx);
163
164 89837
        if (bp->n_conn < bp->max_connections) {
165 440
                cw = VTAILQ_FIRST(&bp->cw_head);
166 440
                if (cw != NULL) {
167 40
                        CHECK_OBJ(cw, CONNWAIT_MAGIC);
168 40
                        assert(cw->cw_state == CW_QUEUED);
169 40
                        PTOK(pthread_cond_signal(&cw->cw_cond));
170 40
                }
171 440
        }
172 89837
}
173
174
static void
175 90396
vbe_connwait_fini(struct connwait *cw)
176
{
177 90396
        CHECK_OBJ_NOTNULL(cw, CONNWAIT_MAGIC);
178 90396
        assert(cw->cw_state != CW_QUEUED);
179 90396
        PTOK(pthread_cond_destroy(&cw->cw_cond));
180 90396
        FINI_OBJ(cw);
181 90396
}
182
183
/*--------------------------------------------------------------------
184
 * Get a connection to the backend
185
 *
186
 * note: wrk is a separate argument because it differs for pipe vs. fetch
187
 */
188
189
static struct pfd *
190 90600
vbe_dir_getfd(VRT_CTX, struct worker *wrk, VCL_BACKEND dir, struct backend *bp,
191
    unsigned force_fresh)
192
{
193
        struct busyobj *bo;
194
        struct pfd *pfd;
195
        int *fdp, err;
196
        vtim_dur tmod;
197
        char abuf1[VTCP_ADDRBUFSIZE], abuf2[VTCP_ADDRBUFSIZE];
198
        char pbuf1[VTCP_PORTBUFSIZE], pbuf2[VTCP_PORTBUFSIZE];
199
        unsigned wait_limit;
200
        vtim_dur wait_tmod;
201
        vtim_dur wait_end;
202
        struct connwait cw[1];
203
204 90600
        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
205 90600
        CHECK_OBJ_NOTNULL(ctx->bo, BUSYOBJ_MAGIC);
206 90600
        bo = ctx->bo;
207 90600
        CHECK_OBJ_NOTNULL(bp, BACKEND_MAGIC);
208 90600
        AN(bp->vsc);
209
210 90600
        if (!VRT_Healthy(ctx, dir, NULL)) {
211 400
                VSLb(bo->vsl, SLT_FetchError,
212 200
                     "backend %s: unhealthy", VRT_BACKEND_string(dir));
213 200
                bp->vsc->unhealthy++;
214 200
                VSC_C_main->backend_unhealthy++;
215 200
                return (NULL);
216
        }
217 90400
        INIT_OBJ(cw, CONNWAIT_MAGIC);
218 90400
        PTOK(pthread_cond_init(&cw->cw_cond, NULL));
219 90400
        Lck_Lock(bp->director->mtx);
220 90400
        FIND_BE_PARAM(backend_wait_limit, wait_limit, bp);
221 90400
        FIND_BE_TMO(backend_wait_timeout, wait_tmod, bp);
222 90400
        cw->cw_state = CW_DO_CONNECT;
223 90400
        if (!VTAILQ_EMPTY(&bp->cw_head) || BE_BUSY(bp))
224 560
                cw->cw_state = CW_BE_BUSY;
225
226 90880
        if (cw->cw_state == CW_BE_BUSY && wait_limit > 0 &&
227 480
            wait_tmod > 0.0 && bp->cw_count < wait_limit) {
228 480
                VTAILQ_INSERT_TAIL(&bp->cw_head, cw, cw_list);
229 480
                bp->cw_count++;
230 480
                VSC_C_main->backend_wait++;
231 480
                cw->cw_state = CW_QUEUED;
232 480
                wait_end = VTIM_real() + wait_tmod;
233 480
                do {
234 960
                        err = Lck_CondWaitUntil(&cw->cw_cond, bp->director->mtx,
235 480
                            wait_end);
236 480
                } while (err == EINTR);
237 480
                assert(cw->cw_state == CW_QUEUED);
238 480
                VTAILQ_REMOVE(&bp->cw_head, cw, cw_list);
239 480
                cw->cw_state = CW_DEQUEUED;
240 480
                bp->cw_count--;
241 480
                if ((err != 0 && BE_BUSY(bp)) || !VRT_Healthy(ctx, dir, NULL)) {
242 440
                        VSC_C_main->backend_wait_fail++;
243 440
                        cw->cw_state = CW_BE_BUSY;
244 440
                }
245 480
        }
246 90400
        if (cw->cw_state != CW_BE_BUSY)
247 89879
                bp->n_conn++;
248
249 90400
        if (!VTAILQ_EMPTY(&bp->cw_head) && !BE_BUSY(bp)) {
250
                /* Signal the new head of the waiting queue */
251 0
                vbe_connwait_signal_locked(bp);
252 0
        }
253
254 90400
        Lck_Unlock(bp->director->mtx);
255
256 90400
        if (cw->cw_state == CW_BE_BUSY) {
257 1040
                VSLb(bo->vsl, SLT_FetchError,
258 520
                     "backend %s: busy", VRT_BACKEND_string(dir));
259 520
                bp->vsc->busy++;
260 520
                VSC_C_main->backend_busy++;
261 520
                vbe_connwait_fini(cw);
262 520
                return (NULL);
263
        }
264
265 89880
        AZ(bo->htc);
266 89880
        bo->htc = WS_Alloc(bo->ws, sizeof *bo->htc);
267
        /* XXX: we may want to detect the ws overflow sooner */
268 89880
        if (bo->htc == NULL) {
269 1240
                VSLb(bo->vsl, SLT_FetchError, "out of workspace");
270
                /* XXX: counter ? */
271 1240
                Lck_Lock(bp->director->mtx);
272 1240
                bp->n_conn--;
273 1240
                vbe_connwait_signal_locked(bp);
274 1240
                Lck_Unlock(bp->director->mtx);
275 1240
                vbe_connwait_fini(cw);
276 1240
                return (NULL);
277
        }
278 88640
        bo->htc->doclose = SC_NULL;
279 88640
        CHECK_OBJ_NOTNULL(bo->htc->doclose, STREAM_CLOSE_MAGIC);
280
281 88640
        FIND_TMO(connect_timeout, tmod, bo, bp);
282 88640
        pfd = VCP_Get(bp->conn_pool, tmod, wrk, force_fresh, &err);
283 88640
        if (pfd == NULL) {
284 1240
                Lck_Lock(bp->director->mtx);
285 1240
                VBE_Connect_Error(bp->vsc, err);
286 1240
                bp->n_conn--;
287 1240
                vbe_connwait_signal_locked(bp);
288 1240
                Lck_Unlock(bp->director->mtx);
289 2480
                VSLb(bo->vsl, SLT_FetchError,
290
                     "backend %s: fail errno %d (%s)",
291 1240
                     VRT_BACKEND_string(dir), err, VAS_errtxt(err));
292 1240
                VSC_C_main->backend_fail++;
293 1240
                bo->htc = NULL;
294 1240
                vbe_connwait_fini(cw);
295 1240
                return (NULL);
296
        }
297
298 87400
        VSLb_ts_busyobj(bo, "Connected", W_TIM_real(wrk));
299 87400
        fdp = PFD_Fd(pfd);
300 87400
        AN(fdp);
301 87400
        assert(*fdp >= 0);
302
303 87400
        Lck_Lock(bp->director->mtx);
304 87400
        bp->vsc->conn++;
305 87400
        bp->vsc->req++;
306 87400
        Lck_Unlock(bp->director->mtx);
307
308 87400
        CHECK_OBJ_NOTNULL(bo->htc->doclose, STREAM_CLOSE_MAGIC);
309
310 87400
        err = 0;
311 87400
        if (bp->proxy_header != 0)
312 200
                err += VPX_Send_Proxy(*fdp, bp->proxy_header, bo->sp);
313 87400
        if (err < 0) {
314 0
                VSLb(bo->vsl, SLT_FetchError,
315
                     "backend %s: proxy write errno %d (%s)",
316 0
                     VRT_BACKEND_string(dir),
317 0
                     errno, VAS_errtxt(errno));
318
                // account as if connect failed - good idea?
319 0
                VSC_C_main->backend_fail++;
320 0
                bo->htc = NULL;
321 0
                VCP_Close(&pfd);
322 0
                AZ(pfd);
323 0
                Lck_Lock(bp->director->mtx);
324 0
                bp->n_conn--;
325 0
                bp->vsc->conn--;
326 0
                bp->vsc->req--;
327 0
                vbe_connwait_signal_locked(bp);
328 0
                Lck_Unlock(bp->director->mtx);
329 0
                vbe_connwait_fini(cw);
330 0
                return (NULL);
331
        }
332 87400
        bo->acct.bereq_hdrbytes += err;
333
334 87400
        PFD_LocalName(pfd, abuf1, sizeof abuf1, pbuf1, sizeof pbuf1);
335 87400
        PFD_RemoteName(pfd, abuf2, sizeof abuf2, pbuf2, sizeof pbuf2);
336 87400
        if (PFD_State(pfd) != PFD_STATE_STOLEN) {
337 109366
                VSLb(bo->vsl, SLT_BackendOpen, "%d %s %s %s %s %s connect",
338 54683
                    *fdp, VRT_BACKEND_string(dir), abuf2, pbuf2, abuf1, pbuf1);
339 54683
        } else {
340 65434
                VSLb(bo->vsl, SLT_BackendOpen,
341 32717
                    "%d %s %s %s %s %s reuse %.6f %ju", *fdp,
342 32717
                    VRT_BACKEND_string(dir), abuf2, pbuf2, abuf1, pbuf1,
343 32717
                    PFD_Age(pfd), (uintmax_t)PFD_Reused(pfd));
344
        }
345
346 87400
        INIT_OBJ(bo->htc, HTTP_CONN_MAGIC);
347 87400
        bo->htc->priv = pfd;
348 87400
        bo->htc->rfd = fdp;
349 87400
        bo->htc->doclose = SC_NULL;
350 87400
        FIND_TMO(first_byte_timeout,
351
            bo->htc->first_byte_timeout, bo, bp);
352 87400
        FIND_TMO(between_bytes_timeout,
353
            bo->htc->between_bytes_timeout, bo, bp);
354 87400
        vbe_connwait_fini(cw);
355 87400
        return (pfd);
356 90600
}
357
358
static void v_matchproto_(vdi_finish_f)
359 87354
vbe_dir_finish(VRT_CTX, VCL_BACKEND d)
360
{
361
        struct backend *bp;
362
        struct busyobj *bo;
363
        struct pfd *pfd;
364
365 87354
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
366 87354
        CHECK_OBJ_NOTNULL(d, DIRECTOR_MAGIC);
367 87354
        bo = ctx->bo;
368 87354
        CHECK_OBJ_NOTNULL(bo, BUSYOBJ_MAGIC);
369 87354
        CAST_OBJ_NOTNULL(bp, d->priv, BACKEND_MAGIC);
370
371 87354
        CHECK_OBJ_NOTNULL(bo->htc, HTTP_CONN_MAGIC);
372 87354
        CHECK_OBJ_NOTNULL(bo->htc->doclose, STREAM_CLOSE_MAGIC);
373
374 87354
        pfd = bo->htc->priv;
375 87354
        bo->htc->priv = NULL;
376 87354
        if (bo->htc->doclose != SC_NULL || bp->proxy_header != 0) {
377 31674
                VSLb(bo->vsl, SLT_BackendClose, "%d %s close %s", *PFD_Fd(pfd),
378 15837
                    VRT_BACKEND_string(d), bo->htc->doclose->name);
379 15837
                VCP_Close(&pfd);
380 15837
                AZ(pfd);
381 15837
                Lck_Lock(bp->director->mtx);
382 15837
        } else {
383 71517
                assert (PFD_State(pfd) == PFD_STATE_USED);
384 143034
                VSLb(bo->vsl, SLT_BackendClose, "%d %s recycle", *PFD_Fd(pfd),
385 71517
                    VRT_BACKEND_string(d));
386 71517
                Lck_Lock(bp->director->mtx);
387 71517
                VSC_C_main->backend_recycle++;
388 71517
                VCP_Recycle(bo->wrk, &pfd);
389
        }
390 87354
        assert(bp->n_conn > 0);
391 87354
        bp->n_conn--;
392 87354
        AN(bp->vsc);
393 87354
        bp->vsc->conn--;
394
#define ACCT(foo)       bp->vsc->foo += bo->acct.foo;
395
#include "tbl/acct_fields_bereq.h"
396
        vbe_connwait_signal_locked(bp);
397
        Lck_Unlock(bp->director->mtx);
398
        bo->htc = NULL;
399
}
400
401
static int v_matchproto_(vdi_gethdrs_f)
402 89399
vbe_dir_gethdrs(VRT_CTX, VCL_BACKEND d)
403
{
404 89399
        int i, retry_connect = 1;
405
        struct backend *bp;
406
        struct pfd *pfd;
407
        struct busyobj *bo;
408
        struct worker *wrk;
409
410 89399
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
411 89399
        CHECK_OBJ_NOTNULL(d, DIRECTOR_MAGIC);
412 89399
        bo = ctx->bo;
413 89399
        CHECK_OBJ_NOTNULL(bo, BUSYOBJ_MAGIC);
414 89399
        CHECK_OBJ_NOTNULL(bo->bereq, HTTP_MAGIC);
415 89399
        if (bo->htc != NULL)
416 0
                CHECK_OBJ_NOTNULL(bo->htc->doclose, STREAM_CLOSE_MAGIC);
417 89399
        wrk = ctx->bo->wrk;
418 89399
        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
419 89399
        CAST_OBJ_NOTNULL(bp, d->priv, BACKEND_MAGIC);
420
421
        /*
422
         * Now that we know our backend, we can set a default Host:
423
         * header if one is necessary.  This cannot be done in the VCL
424
         * because the backend may be chosen by a director.
425
         */
426 89399
        if (!http_GetHdr(bo->bereq, H_Host, NULL) && bp->hosthdr != NULL)
427 2720
                http_PrintfHeader(bo->bereq, "Host: %s", bp->hosthdr);
428
429 89399
        do {
430 89644
                if (bo->htc != NULL)
431 0
                        CHECK_OBJ_NOTNULL(bo->htc->doclose, STREAM_CLOSE_MAGIC);
432 89644
                pfd = vbe_dir_getfd(ctx, wrk, d, bp, retry_connect == 0 ? 1 : 0);
433 89644
                if (pfd == NULL)
434 3159
                        return (-1);
435 86485
                AN(bo->htc);
436 86485
                CHECK_OBJ_NOTNULL(bo->htc->doclose, STREAM_CLOSE_MAGIC);
437 86485
                if (PFD_State(pfd) != PFD_STATE_STOLEN)
438 53843
                        retry_connect = 0;
439
440 172970
                i = V1F_SendReq(wrk, bo, &bo->acct.bereq_hdrbytes,
441 86485
                    &bo->acct.bereq_bodybytes);
442
443 86485
                if (i == 0 && PFD_State(pfd) != PFD_STATE_USED) {
444 97791
                        if (VCP_Wait(wrk, pfd, VTIM_real() +
445 65194
                            bo->htc->first_byte_timeout) != 0) {
446 40
                                bo->htc->doclose = SC_RX_TIMEOUT;
447 40
                                VSLb(bo->vsl, SLT_FetchError,
448
                                     "first byte timeout (reused connection)");
449 40
                                retry_connect = 0;
450 40
                        }
451 32597
                }
452
453 86485
                if (bo->htc->doclose == SC_NULL) {
454 85125
                        assert(PFD_State(pfd) == PFD_STATE_USED);
455 85125
                        if (i == 0)
456 85118
                                i = V1F_FetchRespHdr(bo);
457 85125
                        if (i == 0) {
458 81875
                                AN(bo->htc->priv);
459 81875
                                http_VSL_log(bo->beresp);
460 81875
                                return (0);
461
                        }
462 3240
                }
463 4600
                CHECK_OBJ_NOTNULL(bo->htc->doclose, STREAM_CLOSE_MAGIC);
464
465
                /*
466
                 * If we recycled a backend connection, there is a finite chance
467
                 * that the backend closed it before we got the bereq to it.
468
                 * In that case do a single automatic retry if req.body allows.
469
                 */
470 4600
                vbe_dir_finish(ctx, d);
471 4600
                AZ(bo->htc);
472 4600
                if (i < 0 || retry_connect == 0)
473 4200
                        break;
474 400
                if (bo->no_retry != NULL)
475 160
                        break;
476 240
                VSC_C_main->backend_retry++;
477 240
        } while (retry_connect--);
478 4367
        return (-1);
479 89401
}
480
481
static VCL_IP v_matchproto_(vdi_getip_f)
482 40
vbe_dir_getip(VRT_CTX, VCL_BACKEND d)
483
{
484
        struct pfd *pfd;
485
486 40
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
487 40
        CHECK_OBJ_NOTNULL(d, DIRECTOR_MAGIC);
488 40
        CHECK_OBJ_NOTNULL(ctx->bo, BUSYOBJ_MAGIC);
489 40
        CHECK_OBJ_NOTNULL(ctx->bo->htc, HTTP_CONN_MAGIC);
490 40
        pfd = ctx->bo->htc->priv;
491
492 40
        return (VCP_GetIp(pfd));
493
}
494
495
/*--------------------------------------------------------------------*/
496
497
static stream_close_t v_matchproto_(vdi_http1pipe_f)
498 960
vbe_dir_http1pipe(VRT_CTX, VCL_BACKEND d)
499
{
500
        int i;
501
        stream_close_t retval;
502
        struct backend *bp;
503
        struct v1p_acct v1a;
504
        struct pfd *pfd;
505
        vtim_real deadline;
506
507 960
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
508 960
        CHECK_OBJ_NOTNULL(d, DIRECTOR_MAGIC);
509 960
        CHECK_OBJ_NOTNULL(ctx->req, REQ_MAGIC);
510 960
        CHECK_OBJ_NOTNULL(ctx->bo, BUSYOBJ_MAGIC);
511 960
        CAST_OBJ_NOTNULL(bp, d->priv, BACKEND_MAGIC);
512
513 960
        memset(&v1a, 0, sizeof v1a);
514
515
        /* This is hackish... */
516 960
        v1a.req = ctx->req->acct.req_hdrbytes;
517 960
        ctx->req->acct.req_hdrbytes = 0;
518
519 960
        ctx->req->res_pipe = 1;
520
521 960
        retval = SC_TX_ERROR;
522 960
        pfd = vbe_dir_getfd(ctx, ctx->req->wrk, d, bp, 0);
523
524 960
        if (pfd != NULL) {
525 920
                CHECK_OBJ_NOTNULL(ctx->bo->htc, HTTP_CONN_MAGIC);
526 1840
                i = V1F_SendReq(ctx->req->wrk, ctx->bo,
527 920
                    &v1a.bereq, &v1a.out);
528 920
                VSLb_ts_req(ctx->req, "Pipe", W_TIM_real(ctx->req->wrk));
529 920
                if (i == 0) {
530 920
                        deadline = ctx->bo->task_deadline;
531 920
                        if (isnan(deadline))
532 880
                                deadline = cache_param->pipe_task_deadline;
533 920
                        if (deadline > 0.)
534 120
                                deadline += ctx->req->sp->t_idle;
535 1840
                        retval = V1P_Process(ctx->req, *PFD_Fd(pfd), &v1a,
536 920
                            deadline);
537 920
                }
538 920
                VSLb_ts_req(ctx->req, "PipeSess", W_TIM_real(ctx->req->wrk));
539 920
                ctx->bo->htc->doclose = retval;
540 920
                vbe_dir_finish(ctx, d);
541 920
        }
542 960
        V1P_Charge(ctx->req, &v1a, bp->vsc);
543 960
        CHECK_OBJ_NOTNULL(retval, STREAM_CLOSE_MAGIC);
544 960
        return (retval);
545
}
546
547
/*--------------------------------------------------------------------*/
548
549
static void
550 62982
vbe_dir_event(const struct director *d, enum vcl_event_e ev)
551
{
552
        struct backend *bp;
553
554 62982
        CHECK_OBJ_NOTNULL(d, DIRECTOR_MAGIC);
555 62982
        CAST_OBJ_NOTNULL(bp, d->priv, BACKEND_MAGIC);
556
557 62982
        if (ev == VCL_EVENT_WARM) {
558 53760
                VRT_VSC_Reveal(bp->vsc_seg);
559 53760
                if (bp->probe != NULL)
560 1480
                        VBP_Control(bp, 1);
561 62982
        } else if (ev == VCL_EVENT_COLD) {
562 3307
                if (bp->probe != NULL)
563 280
                        VBP_Control(bp, 0);
564 3307
                VRT_VSC_Hide(bp->vsc_seg);
565 9222
        } else if (ev == VCL_EVENT_DISCARD) {
566 2669
                VRT_DelDirector(&bp->director);
567 5915
        } else if (ev == VDI_EVENT_SICK) {
568 3246
                const struct vdi_ahealth *ah = d->vdir->admin_health;
569
570 3246
                if (ah == VDI_AH_SICK || (ah == VDI_AH_AUTO && bp->sick))
571 2846
                        vbe_connwait_broadcast(bp);
572 3246
        }
573 62982
}
574
575
/*---------------------------------------------------------------------*/
576
577
static void
578 3229
vbe_free(struct backend *be)
579
{
580
581 3229
        CHECK_OBJ_NOTNULL(be, BACKEND_MAGIC);
582
583 3229
        if (be->probe != NULL)
584 240
                VBP_Remove(be);
585
586 3229
        VSC_vbe_Destroy(&be->vsc_seg);
587 3229
        Lck_Lock(&backends_mtx);
588 3229
        VSC_C_main->n_backend--;
589 3229
        Lck_Unlock(&backends_mtx);
590 3229
        VCP_Rel(&be->conn_pool);
591
592
#define DA(x)   do { if (be->x != NULL) free(be->x); } while (0)
593
#define DN(x)   /**/
594 3229
        VRT_BACKEND_HANDLE();
595
#undef DA
596
#undef DN
597 3229
        free(be->endpoint);
598
599 3229
        assert(VTAILQ_EMPTY(&be->cw_head));
600 3229
        FREE_OBJ(be);
601 3229
}
602
603
static void v_matchproto_(vdi_destroy_f)
604 3229
vbe_destroy(const struct director *d)
605
{
606
        struct backend *be;
607
608 3229
        CAST_OBJ_NOTNULL(be, d->priv, BACKEND_MAGIC);
609 3229
        vbe_free(be);
610 3229
}
611
612
/*--------------------------------------------------------------------*/
613
614
static void
615 240
vbe_panic(const struct director *d, struct vsb *vsb)
616
{
617
        struct backend *bp;
618
619 240
        PAN_CheckMagic(vsb, d, DIRECTOR_MAGIC);
620 240
        bp = d->priv;
621 240
        PAN_CheckMagic(vsb, bp, BACKEND_MAGIC);
622
623 240
        VCP_Panic(vsb, bp->conn_pool);
624 240
        VSB_printf(vsb, "hosthdr = %s,\n", bp->hosthdr);
625 240
        VSB_printf(vsb, "n_conn = %u,\n", bp->n_conn);
626 240
}
627
628
/*--------------------------------------------------------------------
629
 */
630
631
static void v_matchproto_(vdi_list_f)
632 46640
vbe_list(VRT_CTX, const struct director *d, struct vsb *vsb, int pflag,
633
    int jflag)
634
{
635
        char buf[VTCP_ADDRBUFSIZE];
636
        struct backend *bp;
637
        struct vrt_endpoint *vep;
638
639 46640
        (void)ctx;
640
641 46640
        CHECK_OBJ_NOTNULL(d, DIRECTOR_MAGIC);
642 46640
        CAST_OBJ_NOTNULL(bp, d->priv, BACKEND_MAGIC);
643 46640
        CHECK_OBJ_NOTNULL(bp->endpoint, VRT_ENDPOINT_MAGIC);
644
645 46640
        vep = bp->endpoint;
646
647 46640
        if (bp->probe != NULL)
648 3120
                VBP_Status(vsb, bp, pflag, jflag);
649 43520
        else if (jflag && pflag)
650 120
                VSB_cat(vsb, "{},\n");
651 43400
        else if (jflag)
652 440
                VSB_cat(vsb, "[0, 0, \"healthy\"]");
653 42960
        else if (pflag)
654 360
                return;
655
        else
656 42600
                VSB_cat(vsb, "0/0\thealthy");
657
658 46280
        if (jflag && pflag) {
659 200
                if (vep->ipv4 != NULL) {
660 200
                        VTCP_name(vep->ipv4, buf, sizeof buf, NULL, 0);
661 200
                        VSB_printf(vsb, "\"ipv4\": \"%s\",\n", buf);
662 200
                }
663 200
                if (vep->ipv6 != NULL) {
664 0
                        VTCP_name(vep->ipv6, buf, sizeof buf, NULL, 0);
665 0
                        VSB_printf(vsb, "\"ipv6\": \"%s\",\n", buf);
666 0
                }
667 200
        }
668 46640
}
669
670
/*--------------------------------------------------------------------
671
 */
672
673
static VCL_BOOL v_matchproto_(vdi_healthy_f)
674 2680
vbe_healthy(VRT_CTX, VCL_BACKEND d, VCL_TIME *t)
675
{
676
        struct backend *bp;
677
678 2680
        (void)ctx;
679 2680
        CHECK_OBJ_NOTNULL(d, DIRECTOR_MAGIC);
680 2680
        CAST_OBJ_NOTNULL(bp, d->priv, BACKEND_MAGIC);
681
682 2680
        if (t != NULL)
683 1680
                *t = bp->changed;
684
685 2680
        return (!bp->sick);
686
}
687
688
/*--------------------------------------------------------------------
689
 */
690
691
static const struct vdi_methods vbe_methods[1] = {{
692
        .magic =                VDI_METHODS_MAGIC,
693
        .type =                 "backend",
694
        .http1pipe =            vbe_dir_http1pipe,
695
        .gethdrs =              vbe_dir_gethdrs,
696
        .getip =                vbe_dir_getip,
697
        .finish =               vbe_dir_finish,
698
        .event =                vbe_dir_event,
699
        .destroy =              vbe_destroy,
700
        .panic =                vbe_panic,
701
        .list =                 vbe_list,
702
        .healthy =              vbe_healthy
703
}};
704
705
static const struct vdi_methods vbe_methods_noprobe[1] = {{
706
        .magic =                VDI_METHODS_MAGIC,
707
        .type =                 "backend",
708
        .http1pipe =            vbe_dir_http1pipe,
709
        .gethdrs =              vbe_dir_gethdrs,
710
        .getip =                vbe_dir_getip,
711
        .finish =               vbe_dir_finish,
712
        .event =                vbe_dir_event,
713
        .destroy =              vbe_destroy,
714
        .panic =                vbe_panic,
715
        .list =                 vbe_list
716
}};
717
718
/*--------------------------------------------------------------------
719
 * Create a new static or dynamic director::backend instance.
720
 */
721
722
size_t
723 49880
VRT_backend_vsm_need(VRT_CTX)
724
{
725 49880
        (void)ctx;
726 49880
        return (VRT_VSC_Overhead(VSC_vbe_size));
727
}
728
729
/*
730
 * The new_backend via parameter is a VCL_BACKEND, but we need a (struct
731
 * backend)
732
 *
733
 * For now, we resolve it when creating the backend, which implies no redundancy
734
 * / load balancing across the via director if it is more than a simple backend.
735
 */
736
737
static const struct backend *
738 320
via_resolve(VRT_CTX, const struct vrt_endpoint *vep, VCL_BACKEND via)
739
{
740 320
        const struct backend *viabe = NULL;
741
742 320
        CHECK_OBJ_NOTNULL(vep, VRT_ENDPOINT_MAGIC);
743 320
        CHECK_OBJ_NOTNULL(via, DIRECTOR_MAGIC);
744
745 320
        if (vep->uds_path) {
746 0
                VRT_fail(ctx, "Via is only supported for IP addresses");
747 0
                return (NULL);
748
        }
749
750 320
        via = VRT_DirectorResolve(ctx, via);
751
752 320
        if (via == NULL) {
753 0
                VRT_fail(ctx, "Via resolution failed");
754 0
                return (NULL);
755
        }
756
757 320
        CHECK_OBJ(via, DIRECTOR_MAGIC);
758 320
        CHECK_OBJ_NOTNULL(via->vdir, VCLDIR_MAGIC);
759
760 320
        if (via->vdir->methods == vbe_methods ||
761 320
            via->vdir->methods == vbe_methods_noprobe)
762 320
                CAST_OBJ_NOTNULL(viabe, via->priv, BACKEND_MAGIC);
763
764 320
        if (viabe == NULL)
765 0
                VRT_fail(ctx, "Via does not resolve to a backend");
766
767 320
        return (viabe);
768 320
}
769
770
/*
771
 * construct a new endpoint identical to vep with sa in a proxy header
772
 */
773
static struct vrt_endpoint *
774 320
via_endpoint(const struct vrt_endpoint *vep, const struct suckaddr *sa,
775
    const char *auth)
776
{
777
        struct vsb *preamble;
778
        struct vrt_blob blob[1];
779
        struct vrt_endpoint *nvep, *ret;
780
        const struct suckaddr *client_bogo;
781
782 320
        CHECK_OBJ_NOTNULL(vep, VRT_ENDPOINT_MAGIC);
783 320
        AN(sa);
784
785 320
        nvep = VRT_Endpoint_Clone(vep);
786 320
        CHECK_OBJ_NOTNULL(nvep, VRT_ENDPOINT_MAGIC);
787
788 320
        if (VSA_Get_Proto(sa) == AF_INET6)
789 0
                client_bogo = bogo_ip6;
790
        else
791 320
                client_bogo = bogo_ip;
792
793 320
        preamble = VSB_new_auto();
794 320
        AN(preamble);
795 320
        VPX_Format_Proxy(preamble, 2, client_bogo, sa, auth);
796 320
        INIT_OBJ(blob, VRT_BLOB_MAGIC);
797 320
        blob->blob = VSB_data(preamble);
798 320
        blob->len = VSB_len(preamble);
799 320
        nvep->preamble = blob;
800 320
        ret = VRT_Endpoint_Clone(nvep);
801 320
        CHECK_OBJ_NOTNULL(ret, VRT_ENDPOINT_MAGIC);
802 320
        VSB_destroy(&preamble);
803 320
        FREE_OBJ(nvep);
804
805 320
        return (ret);
806
}
807
808
VCL_BACKEND
809 54040
VRT_new_backend_clustered(VRT_CTX, struct vsmw_cluster *vc,
810
    const struct vrt_backend *vrt, VCL_BACKEND via)
811
{
812
        struct backend *be;
813
        struct vcl *vcl;
814
        const struct vrt_backend_probe *vbp;
815
        const struct vrt_endpoint *vep;
816
        const struct vdi_methods *m;
817 54040
        const struct suckaddr *sa = NULL;
818
        char abuf[VTCP_ADDRBUFSIZE];
819 54040
        const struct backend *viabe = NULL;
820
821 54040
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
822 54040
        CHECK_OBJ_NOTNULL(vrt, VRT_BACKEND_MAGIC);
823 54040
        vep = vrt->endpoint;
824 54040
        CHECK_OBJ_NOTNULL(vep, VRT_ENDPOINT_MAGIC);
825 54040
        if (vep->uds_path == NULL) {
826 52200
                if (vep->ipv4 == NULL && vep->ipv6 == NULL) {
827 0
                        VRT_fail(ctx, "%s: Illegal IP", __func__);
828 0
                        return (NULL);
829
                }
830 52200
        } else {
831 1840
                assert(vep->ipv4== NULL && vep->ipv6== NULL);
832
        }
833
834 54040
        if (via != NULL) {
835 320
                viabe = via_resolve(ctx, vep, via);
836 320
                if (viabe == NULL)
837 0
                        return (NULL);
838 320
        }
839
840 54040
        vcl = ctx->vcl;
841 54040
        AN(vcl);
842 54040
        AN(vrt->vcl_name);
843
844
        /* Create new backend */
845 54040
        ALLOC_OBJ(be, BACKEND_MAGIC);
846 54040
        if (be == NULL)
847 0
                return (NULL);
848 54040
        VTAILQ_INIT(&be->cw_head);
849
850
#define DA(x)   do { if (vrt->x != NULL) REPLACE((be->x), (vrt->x)); } while (0)
851
#define DN(x)   do { be->x = vrt->x; } while (0)
852 54040
        VRT_BACKEND_HANDLE();
853
#undef DA
854
#undef DN
855
856
#define CPTMO(a, b, x) do {                             \
857
                if ((a)->x < 0.0 || isnan((a)->x))      \
858
                        (a)->x = (b)->x;                \
859
        } while(0)
860
861 53960
        if (viabe != NULL) {
862 320
                CPTMO(be, viabe, connect_timeout);
863 320
                CPTMO(be, viabe, first_byte_timeout);
864 320
                CPTMO(be, viabe, between_bytes_timeout);
865 320
        }
866
#undef CPTMO
867
868 53960
        if (viabe || be->hosthdr == NULL) {
869 360
                if (vrt->endpoint->uds_path != NULL)
870 40
                        sa = bogo_ip;
871 320
                else if (cache_param->prefer_ipv6 && vep->ipv6 != NULL)
872 0
                        sa = vep->ipv6;
873 320
                else if (vep->ipv4!= NULL)
874 320
                        sa = vep->ipv4;
875
                else
876 0
                        sa = vep->ipv6;
877 360
                if (be->hosthdr == NULL) {
878 40
                        VTCP_name(sa, abuf, sizeof abuf, NULL, 0);
879 40
                        REPLACE(be->hosthdr, abuf);
880 40
                }
881 360
        }
882
883 107920
        be->vsc = VSC_vbe_New(vc, &be->vsc_seg,
884 53960
            "%s.%s", VCL_Name(ctx->vcl), vrt->vcl_name);
885 53960
        AN(be->vsc);
886 53960
        if (! vcl->temp->is_warm)
887 53440
                VRT_VSC_Hide(be->vsc_seg);
888
889 53960
        if (viabe)
890 560
                vep = be->endpoint = via_endpoint(viabe->endpoint, sa,
891 280
                    be->authority);
892
        else
893 53680
                vep = be->endpoint = VRT_Endpoint_Clone(vep);
894
895 53960
        AN(vep);
896 53960
        be->conn_pool = VCP_Ref(vep, vbe_proto_ident);
897 53960
        AN(be->conn_pool);
898
899 53960
        vbp = vrt->probe;
900 53960
        if (vbp == NULL)
901 53000
                vbp = VCL_DefaultProbe(vcl);
902
903 53960
        if (vbp != NULL) {
904 1440
                VBP_Insert(be, vbp, be->conn_pool);
905 1440
                m = vbe_methods;
906 1440
        } else {
907 52520
                be->sick = 0;
908 52520
                be->vsc->happy = UINT64_MAX;
909 52520
                m = vbe_methods_noprobe;
910
        }
911
912 53960
        Lck_Lock(&backends_mtx);
913 53960
        VSC_C_main->n_backend++;
914 53960
        Lck_Unlock(&backends_mtx);
915
916 53960
        be->director = VRT_AddDirector(ctx, m, be, "%s", vrt->vcl_name);
917
918 53960
        if (be->director == NULL) {
919 0
                vbe_free(be);
920 0
                return (NULL);
921
        }
922
        /* for cold VCL, update initial director state */
923 53960
        if (be->probe != NULL)
924 1480
                VBP_Update_Backend(be->probe);
925 53960
        return (be->director);
926 53960
}
927
928
VCL_BACKEND
929 1280
VRT_new_backend(VRT_CTX, const struct vrt_backend *vrt, VCL_BACKEND via)
930
{
931
932 1280
        CHECK_OBJ_NOTNULL(vrt, VRT_BACKEND_MAGIC);
933 1280
        CHECK_OBJ_NOTNULL(vrt->endpoint, VRT_ENDPOINT_MAGIC);
934 1280
        return (VRT_new_backend_clustered(ctx, NULL, vrt, via));
935
}
936
937
/*--------------------------------------------------------------------
938
 * Delete a dynamic director::backend instance.  Undeleted dynamic and
939
 * static instances are GC'ed when the VCL is discarded (in cache_vcl.c)
940
 */
941
942
void
943 3149
VRT_delete_backend(VRT_CTX, VCL_BACKEND *dp)
944
{
945
946 3149
        (void)ctx;
947 3149
        CHECK_OBJ_NOTNULL(*dp, DIRECTOR_MAGIC);
948 3149
        VRT_DisableDirector(*dp);
949 3149
        VRT_Assign_Backend(dp, NULL);
950 3149
}
951
952
/*---------------------------------------------------------------------*/
953
954
void
955 38349
VBE_InitCfg(void)
956
{
957
958 38349
        Lck_New(&backends_mtx, lck_vbe);
959 38349
}