GCOV - Varnish Cache


/*-
 * Copyright (c) 2006 Verdens Gang AS
 * Copyright (c) 2006-2015 Varnish Software AS
 * All rights reserved.
 *
 * Author: Poul-Henning Kamp <phk@phk.freebsd.dk>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * Abstract director API
 *
 * The abstract director API does not know how we talk to the backend or
 * if there even is one in the usual meaning of the word.
 *
 */

#include "config.h"

#include "cache_varnishd.h"
#include "cache_director.h"

#include "vcli_serve.h"
#include "vte.h"
#include "vtim.h"

/* -------------------------------------------------------------------*/

struct vdi_ahealth {
        const char              *name;
        int                     health;
};

#define VBE_AHEALTH(l,u,h)                                              \
        static const struct vdi_ahealth vdi_ah_##l[1] = {{#l,h}};       \
        const struct vdi_ahealth * const VDI_AH_##u = vdi_ah_##l;
VBE_AHEALTH_LIST
#undef VBE_AHEALTH

static const struct vdi_ahealth *
vdi_str2ahealth(const char *t)
{
#define VBE_AHEALTH(l,u,h) if (!strcasecmp(t, #l)) return (VDI_AH_##u);
VBE_AHEALTH_LIST
#undef VBE_AHEALTH
        return (NULL);
}

static const char *
VDI_Ahealth(const struct director *d)
{

        CHECK_OBJ_NOTNULL(d, DIRECTOR_MAGIC);
        AN(d->vdir->admin_health);
        if (d->vdir->admin_health != VDI_AH_AUTO)
                return (d->vdir->admin_health->name);
        if (d->vdir->methods->healthy != NULL)
                return ("probe");
        return ("healthy");
}

/* Resolve director --------------------------------------------------*/

VCL_BACKEND
VRT_DirectorResolve(VRT_CTX, VCL_BACKEND d)
{
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);

        while (d != NULL) {
                CHECK_OBJ(d, DIRECTOR_MAGIC);
                AN(d->vdir);
                if (d->vdir->methods->resolve == NULL)
                        break;
                d = d->vdir->methods->resolve(ctx, d);
        }
        if (d == NULL)
                return (NULL);

        CHECK_OBJ(d, DIRECTOR_MAGIC);
        AN(d->vdir);
        return (d);
}

static VCL_BACKEND
VDI_Resolve(VRT_CTX)
{
        VCL_BACKEND d;
        struct busyobj *bo;

        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
        bo = ctx->bo;
        CHECK_OBJ_NOTNULL(bo, BUSYOBJ_MAGIC);

        if (bo->director_req == NULL) {
                VSLb(bo->vsl, SLT_FetchError, "No backend");
                return (NULL);
        }

        CHECK_OBJ(bo->director_req, DIRECTOR_MAGIC);
        d = VRT_DirectorResolve(ctx, bo->director_req);
        if (d != NULL)
                return (d);

        VSLb(bo->vsl, SLT_FetchError,
            "Director %s returned no backend", bo->director_req->vcl_name);
        return (NULL);
}

/* Get a set of response headers -------------------------------------*/

int
VDI_GetHdr(struct busyobj *bo)
{
        const struct director *d;
        struct vrt_ctx ctx[1];
        int i = -1;

        CHECK_OBJ_NOTNULL(bo, BUSYOBJ_MAGIC);
        INIT_OBJ(ctx, VRT_CTX_MAGIC);
        VCL_Bo2Ctx(ctx, bo);

        d = VDI_Resolve(ctx);
        if (d != NULL) {
                VRT_Assign_Backend(&bo->director_resp, d);
                AN(d->vdir->methods->gethdrs);
                bo->director_state = DIR_S_HDRS;
                i = d->vdir->methods->gethdrs(ctx, d);
        }
        if (i)
                bo->director_state = DIR_S_NULL;
        return (i);
}

/* Get IP number (if any ) -------------------------------------------*/

VCL_IP
VDI_GetIP(struct busyobj *bo)
{
        const struct director *d;
        struct vrt_ctx ctx[1];

        CHECK_OBJ_NOTNULL(bo, BUSYOBJ_MAGIC);
        INIT_OBJ(ctx, VRT_CTX_MAGIC);
        VCL_Bo2Ctx(ctx, bo);

        d = bo->director_resp;
        CHECK_OBJ_NOTNULL(d, DIRECTOR_MAGIC);
        assert(bo->director_state == DIR_S_HDRS ||
           bo->director_state == DIR_S_BODY);
        AZ(d->vdir->methods->resolve);
        if (d->vdir->methods->getip == NULL)
                return (NULL);
        return (d->vdir->methods->getip(ctx, d));
}

/* Finish fetch ------------------------------------------------------*/

void
VDI_Finish(struct busyobj *bo)
{
        const struct director *d;
        struct vrt_ctx ctx[1];

        CHECK_OBJ_NOTNULL(bo, BUSYOBJ_MAGIC);
        INIT_OBJ(ctx, VRT_CTX_MAGIC);
        VCL_Bo2Ctx(ctx, bo);

        d = bo->director_resp;
        CHECK_OBJ_NOTNULL(d, DIRECTOR_MAGIC);

        AZ(d->vdir->methods->resolve);
        AN(d->vdir->methods->finish);

        assert(bo->director_state != DIR_S_NULL);
        d->vdir->methods->finish(ctx, d);
        bo->director_state = DIR_S_NULL;
}

/* Get a connection --------------------------------------------------*/

stream_close_t
VDI_Http1Pipe(struct req *req, struct busyobj *bo)
{
        const struct director *d;
        struct vrt_ctx ctx[1];

        CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
        CHECK_OBJ_NOTNULL(bo, BUSYOBJ_MAGIC);
        INIT_OBJ(ctx, VRT_CTX_MAGIC);
        VCL_Bo2Ctx(ctx, bo);
        VCL_Req2Ctx(ctx, req);

        d = VDI_Resolve(ctx);
        if (d == NULL || d->vdir->methods->http1pipe == NULL) {
                VSLb(bo->vsl, SLT_VCL_Error, "Backend does not support pipe");
                return (SC_TX_ERROR);
        }
        VRT_Assign_Backend(&bo->director_resp, d);
        return (d->vdir->methods->http1pipe(ctx, d));
}

/* Check health --------------------------------------------------------
 *
 * If director has no healthy method, we just assume it is healthy.
 */

/*--------------------------------------------------------------------
 * Test if backend is healthy and report when that last changed
 */

VCL_BOOL
VRT_Healthy(VRT_CTX, VCL_BACKEND d, VCL_TIME *changed)
{

        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
        if (d == NULL)
                return (0);
        CHECK_OBJ_NOTNULL(d, DIRECTOR_MAGIC);

        if (d->vdir->admin_health->health >= 0) {
                if (changed != NULL)
                        *changed = d->vdir->health_changed;
                return (d->vdir->admin_health->health);
        }

        if (d->vdir->methods->healthy == NULL) {
                if (changed != NULL)
                        *changed = d->vdir->health_changed;
                return (1);
        }

        return (d->vdir->methods->healthy(ctx, d, changed));
}

/*--------------------------------------------------------------------
 * Update health_changed.
 */
VCL_VOID
VRT_SetChanged(VCL_BACKEND d, VCL_TIME changed)
{

        CHECK_OBJ_ORNULL(d, DIRECTOR_MAGIC);

        if (d != NULL && changed > d->vdir->health_changed)
                d->vdir->health_changed = changed;
}

/* Send Event ----------------------------------------------------------
 */

void
VDI_Event(const struct director *d, enum vcl_event_e ev)
{

        CHECK_OBJ_NOTNULL(d, DIRECTOR_MAGIC);
        if (d->vdir->methods->event != NULL)
                d->vdir->methods->event(d, ev);
}

/* Dump panic info -----------------------------------------------------
 */

void
VDI_Panic(const struct director *d, struct vsb *vsb, const char *nm)
{
        if (d == NULL)
                return;
        VSB_printf(vsb, "%s = %p {\n", nm, d);
        VSB_indent(vsb, 2);
        VSB_printf(vsb, "cli_name = %s,\n", d->vdir->cli_name);
        VSB_printf(vsb, "admin_health = %s, changed = %f,\n",
            VDI_Ahealth(d), d->vdir->health_changed);
        VSB_printf(vsb, "type = %s {\n", d->vdir->methods->type);
        VSB_indent(vsb, 2);
        if (d->vdir->methods->panic != NULL)
                d->vdir->methods->panic(d, vsb);
        VSB_indent(vsb, -2);
        VSB_cat(vsb, "},\n");
        VSB_indent(vsb, -2);
        VSB_cat(vsb, "},\n");
}


/*---------------------------------------------------------------------*/

struct list_args {
        unsigned        magic;
#define LIST_ARGS_MAGIC 0x7e7cefeb
        int             p;
        int             j;
        const char      *jsep;
        struct vsb      *vsb;
        struct vte      *vte;
};

static const char *
cli_health(VRT_CTX, const struct director *d)
{
        VCL_BOOL healthy = VRT_Healthy(ctx, d, NULL);

        return (healthy ? "healthy" : "sick");
}

static int v_matchproto_(vcl_be_func)
do_list(struct cli *cli, struct director *d, void *priv)
{
        char time_str[VTIM_FORMAT_SIZE];
        struct list_args *la;
        struct vrt_ctx *ctx;

        AN(cli);
        CAST_OBJ_NOTNULL(la, priv, LIST_ARGS_MAGIC);
        AN(la->vsb);
        AN(la->vte);
        CHECK_OBJ_NOTNULL(d, DIRECTOR_MAGIC);

        if (d->vdir->admin_health == VDI_AH_DELETED)
                return (0);

        ctx = VCL_Get_CliCtx(0);

        VTE_printf(la->vte, "%s\t%s\t", d->vdir->cli_name, VDI_Ahealth(d));

        if (d->vdir->methods->list != NULL) {
                VSB_clear(la->vsb);
                d->vdir->methods->list(ctx, d, la->vsb, 0, 0);
                AZ(VSB_finish(la->vsb));
                VTE_cat(la->vte, VSB_data(la->vsb));
        } else if (d->vdir->methods->healthy != NULL)
                VTE_printf(la->vte, "0/0\t%s", cli_health(ctx, d));
        else
                VTE_cat(la->vte, "0/0\thealthy");

        VTIM_format(d->vdir->health_changed, time_str);
        VTE_printf(la->vte, "\t%s", time_str);
        if (la->p && d->vdir->methods->list != NULL) {
                VSB_clear(la->vsb);
                d->vdir->methods->list(ctx, d, la->vsb, la->p, 0);
                AZ(VSB_finish(la->vsb));
                VTE_cat(la->vte, VSB_data(la->vsb));
        }

        VTE_cat(la->vte, "\n");
        AZ(VCL_Rel_CliCtx(&ctx));
        AZ(ctx);

        return (0);
}

static int v_matchproto_(vcl_be_func)
do_list_json(struct cli *cli, struct director *d, void *priv)
{
        struct list_args *la;
        struct vrt_ctx *ctx;

        CAST_OBJ_NOTNULL(la, priv, LIST_ARGS_MAGIC);
        CHECK_OBJ_NOTNULL(d, DIRECTOR_MAGIC);

        if (d->vdir->admin_health == VDI_AH_DELETED)
                return (0);

        ctx = VCL_Get_CliCtx(0);

        VCLI_Out(cli, "%s", la->jsep);
        la->jsep = ",\n";
        VCLI_JSON_str(cli, d->vdir->cli_name);
        VCLI_Out(cli, ": {\n");
        VSB_indent(cli->sb, 2);
        VCLI_Out(cli, "\"type\": \"%s\",\n", d->vdir->methods->type);
        VCLI_Out(cli, "\"admin_health\": \"%s\",\n", VDI_Ahealth(d));
        VCLI_Out(cli, "\"probe_message\": ");
        if (d->vdir->methods->list != NULL)
                d->vdir->methods->list(ctx, d, cli->sb, 0, 1);
        else if (d->vdir->methods->healthy != NULL)
                VCLI_Out(cli, "[0, 0, \"%s\"]", cli_health(ctx, d));
        else
                VCLI_Out(cli, "[0, 0, \"healthy\"]");

        VCLI_Out(cli, ",\n");

        if (la->p && d->vdir->methods->list != NULL) {
                VCLI_Out(cli, "\"probe_details\": ");
                d->vdir->methods->list(ctx, d, cli->sb, la->p, 1);
        }
        VCLI_Out(cli, "\"last_change\": %.3f\n", d->vdir->health_changed);
        VSB_indent(cli->sb, -2);
        VCLI_Out(cli, "}");

        AZ(VCL_Rel_CliCtx(&ctx));
        AZ(ctx);

        return (0);
}

static void v_matchproto_(cli_func_t)
cli_backend_list(struct cli *cli, const char * const *av, void *priv)
{
        const char *p;
        struct list_args la[1];
        int i;

        (void)priv;
        ASSERT_CLI();
        INIT_OBJ(la, LIST_ARGS_MAGIC);
        la->jsep = "";
        for (i = 2; av[i] != NULL && av[i][0] == '-'; i++) {
                for(p = av[i] + 1; *p; p++) {
                        switch(*p) {
                        case 'j': la->j = 1; break;
                        case 'p': la->p = !la->p; break;
                        default:
                                VCLI_Out(cli, "Invalid flag %c", *p);
                                VCLI_SetResult(cli, CLIS_PARAM);
                                return;
                        }
                }
        }
        if (av[i] != NULL && av[i+1] != NULL) {
                VCLI_Out(cli, "Too many arguments");
                VCLI_SetResult(cli, CLIS_PARAM);
                return;
        }
        if (la->j) {
                VCLI_JSON_begin(cli, 3, av);
                VCLI_Out(cli, ",\n");
                VCLI_Out(cli, "{\n");
                VSB_indent(cli->sb, 2);
                (void)VCL_IterDirector(cli, av[i], do_list_json, la);
                VSB_indent(cli->sb, -2);
                VCLI_Out(cli, "\n");
                VCLI_Out(cli, "}");
                VCLI_JSON_end(cli);
        } else {
                la->vsb = VSB_new_auto();
                AN(la->vsb);
                la->vte = VTE_new(5, 80);
                AN(la->vte);
                VTE_printf(la->vte, "%s\t%s\t%s\t%s\t%s\n",
                    "Backend name", "Admin", "Probe", "Health", "Last change");
                (void)VCL_IterDirector(cli, av[i], do_list, la);
                AZ(VTE_finish(la->vte));
                AZ(VTE_format(la->vte, VCLI_VTE_format, cli));
                VTE_destroy(&la->vte);
                VSB_destroy(&la->vsb);
        }
}

/*---------------------------------------------------------------------*/

struct set_health {
        unsigned                        magic;
#define SET_HEALTH_MAGIC                0x0c46b9fb
        const struct vdi_ahealth        *ah;
};

static int v_matchproto_(vcl_be_func)
do_set_health(struct cli *cli, struct director *d, void *priv)
{
        struct set_health *sh;

        (void)cli;
        CHECK_OBJ_NOTNULL(d, DIRECTOR_MAGIC);
        CAST_OBJ_NOTNULL(sh, priv, SET_HEALTH_MAGIC);

        if (d->vdir->admin_health == VDI_AH_DELETED)
                return (0);
        if (d->vdir->admin_health != sh->ah) {
                d->vdir->health_changed = VTIM_real();
                d->vdir->admin_health = sh->ah;
                VDI_Event(d, VDI_EVENT_SICK);
        }
        return (0);
}

static void v_matchproto_()
cli_backend_set_health(struct cli *cli, const char * const *av, void *priv)
{
        int n;
        struct set_health sh[1];

        (void)av;
        (void)priv;
        ASSERT_CLI();
        AN(av[2]);
        AN(av[3]);
        INIT_OBJ(sh, SET_HEALTH_MAGIC);
        sh->ah = vdi_str2ahealth(av[3]);
        if (sh->ah == NULL || sh->ah == VDI_AH_DELETED) {
                VCLI_Out(cli, "Invalid state %s", av[3]);
                VCLI_SetResult(cli, CLIS_PARAM);
                return;
        }
        n = VCL_IterDirector(cli, av[2], do_set_health, sh);
        if (n == 0) {
                VCLI_Out(cli, "No Backends matches");
                VCLI_SetResult(cli, CLIS_PARAM);
        }
}

/*---------------------------------------------------------------------*/

static struct cli_proto backend_cmds[] = {
        { CLICMD_BACKEND_LIST,          "",
             cli_backend_list, cli_backend_list },
        { CLICMD_BACKEND_SET_HEALTH,    "", cli_backend_set_health },
        { NULL }
};

/*---------------------------------------------------------------------*/

void
VDI_Init(void)
{

        CLI_AddFuncs(backend_cmds);
}

		varnish-cache/bin/varnishd/cache/cache_director.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		* Abstract director API
31		*
32		* The abstract director API does not know how we talk to the backend or
33		* if there even is one in the usual meaning of the word.
34		*
35		*/
36
37		#include "config.h"
38
39		#include "cache_varnishd.h"
40		#include "cache_director.h"
41
42		#include "vcli_serve.h"
43		#include "vte.h"
44		#include "vtim.h"
45
46		/* -------------------------------------------------------------------*/
47
48		struct vdi_ahealth {
49		const char *name;
50		int health;
51		};
52
53		#define VBE_AHEALTH(l,u,h) \
54		static const struct vdi_ahealth vdi_ah_##l[1] = {{#l,h}}; \
55		const struct vdi_ahealth * const VDI_AH_##u = vdi_ah_##l;
56		VBE_AHEALTH_LIST
57		#undef VBE_AHEALTH
58
59		static const struct vdi_ahealth *
60	168	vdi_str2ahealth(const char *t)
61		{
62		#define VBE_AHEALTH(l,u,h) if (!strcasecmp(t, #l)) return (VDI_AH_##u);
63	168	VBE_AHEALTH_LIST
64		#undef VBE_AHEALTH
65	16	return (NULL);
66	168	}
67
68		static const char *
69	5080	VDI_Ahealth(const struct director *d)
70		{
71
72	5080	CHECK_OBJ_NOTNULL(d, DIRECTOR_MAGIC);
73	5080	AN(d->vdir->admin_health);
74	5080	if (d->vdir->admin_health != VDI_AH_AUTO)
75	140	return (d->vdir->admin_health->name);
76	4940	if (d->vdir->methods->healthy != NULL)
77	536	return ("probe");
78	4404	return ("healthy");
79	5080	}
80
81		/* Resolve director --------------------------------------------------*/
82
83		VCL_BACKEND
84	8848	VRT_DirectorResolve(VRT_CTX, VCL_BACKEND d)
85		{
86	8848	CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
87
88	9336	while (d != NULL) {
89	9328	CHECK_OBJ(d, DIRECTOR_MAGIC);
90	9328	AN(d->vdir);
91	9328	if (d->vdir->methods->resolve == NULL)
92	8840	break;
93	488	d = d->vdir->methods->resolve(ctx, d);
94		}
95	8848	if (d == NULL)
96	8	return (NULL);
97
98	8840	CHECK_OBJ(d, DIRECTOR_MAGIC);
99	8840	AN(d->vdir);
100	8840	return (d);
101	8848	}
102
103		static VCL_BACKEND
104	9100	VDI_Resolve(VRT_CTX)
105		{
106		VCL_BACKEND d;
107		struct busyobj *bo;
108
109	9100	CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
110	9100	bo = ctx->bo;
111	9100	CHECK_OBJ_NOTNULL(bo, BUSYOBJ_MAGIC);
112
113	9100	if (bo->director_req == NULL) {
114	312	VSLb(bo->vsl, SLT_FetchError, "No backend");
115	312	return (NULL);
116		}
117
118	8788	CHECK_OBJ(bo->director_req, DIRECTOR_MAGIC);
119	8788	d = VRT_DirectorResolve(ctx, bo->director_req);
120	8788	if (d != NULL)
121	8780	return (d);
122
123	16	VSLb(bo->vsl, SLT_FetchError,
124	8	"Director %s returned no backend", bo->director_req->vcl_name);
125	8	return (NULL);
126	9100	}
127
128		/* Get a set of response headers -------------------------------------*/
129
130		int
131	8999	VDI_GetHdr(struct busyobj *bo)
132		{
133		const struct director *d;
134		struct vrt_ctx ctx[1];
135	8999	int i = -1;
136
137	8999	CHECK_OBJ_NOTNULL(bo, BUSYOBJ_MAGIC);
138	8999	INIT_OBJ(ctx, VRT_CTX_MAGIC);
139	8999	VCL_Bo2Ctx(ctx, bo);
140
141	8999	d = VDI_Resolve(ctx);
142	8999	if (d != NULL) {
143	8680	VRT_Assign_Backend(&bo->director_resp, d);
144	8680	AN(d->vdir->methods->gethdrs);
145	8680	bo->director_state = DIR_S_HDRS;
146	8680	i = d->vdir->methods->gethdrs(ctx, d);
147	8680	}
148	8999	if (i)
149	1032	bo->director_state = DIR_S_NULL;
150	8999	return (i);
151		}
152
153		/* Get IP number (if any ) -------------------------------------------*/
154
155		VCL_IP
156	4	VDI_GetIP(struct busyobj *bo)
157		{
158		const struct director *d;
159		struct vrt_ctx ctx[1];
160
161	4	CHECK_OBJ_NOTNULL(bo, BUSYOBJ_MAGIC);
162	4	INIT_OBJ(ctx, VRT_CTX_MAGIC);
163	4	VCL_Bo2Ctx(ctx, bo);
164
165	4	d = bo->director_resp;
166	4	CHECK_OBJ_NOTNULL(d, DIRECTOR_MAGIC);
167	4	assert(bo->director_state == DIR_S_HDRS \|\|
168		bo->director_state == DIR_S_BODY);
169	4	AZ(d->vdir->methods->resolve);
170	4	if (d->vdir->methods->getip == NULL)
171	0	return (NULL);
172	4	return (d->vdir->methods->getip(ctx, d));
173	4	}
174
175		/* Finish fetch ------------------------------------------------------*/
176
177		void
178	7964	VDI_Finish(struct busyobj *bo)
179		{
180		const struct director *d;
181		struct vrt_ctx ctx[1];
182
183	7964	CHECK_OBJ_NOTNULL(bo, BUSYOBJ_MAGIC);
184	7964	INIT_OBJ(ctx, VRT_CTX_MAGIC);
185	7964	VCL_Bo2Ctx(ctx, bo);
186
187	7964	d = bo->director_resp;
188	7964	CHECK_OBJ_NOTNULL(d, DIRECTOR_MAGIC);
189
190	7964	AZ(d->vdir->methods->resolve);
191	7964	AN(d->vdir->methods->finish);
192
193	7964	assert(bo->director_state != DIR_S_NULL);
194	7964	d->vdir->methods->finish(ctx, d);
195	7964	bo->director_state = DIR_S_NULL;
196	7964	}
197
198		/* Get a connection --------------------------------------------------*/
199
200		stream_close_t
201	100	VDI_Http1Pipe(struct req req, struct busyobj bo)
202		{
203		const struct director *d;
204		struct vrt_ctx ctx[1];
205
206	100	CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
207	100	CHECK_OBJ_NOTNULL(bo, BUSYOBJ_MAGIC);
208	100	INIT_OBJ(ctx, VRT_CTX_MAGIC);
209	100	VCL_Bo2Ctx(ctx, bo);
210	100	VCL_Req2Ctx(ctx, req);
211
212	100	d = VDI_Resolve(ctx);
213	100	if (d == NULL \|\| d->vdir->methods->http1pipe == NULL) {
214	0	VSLb(bo->vsl, SLT_VCL_Error, "Backend does not support pipe");
215	0	return (SC_TX_ERROR);
216		}
217	100	VRT_Assign_Backend(&bo->director_resp, d);
218	100	return (d->vdir->methods->http1pipe(ctx, d));
219	100	}
220
221		/* Check health --------------------------------------------------------
222		*
223		* If director has no healthy method, we just assume it is healthy.
224		*/
225
226		/*--------------------------------------------------------------------
227		* Test if backend is healthy and report when that last changed
228		*/
229
230		VCL_BOOL
231	11956	VRT_Healthy(VRT_CTX, VCL_BACKEND d, VCL_TIME *changed)
232		{
233
234	11956	CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
235	11956	if (d == NULL)
236	0	return (0);
237	11956	CHECK_OBJ_NOTNULL(d, DIRECTOR_MAGIC);
238
239	11956	if (d->vdir->admin_health->health >= 0) {
240	404	if (changed != NULL)
241	228	*changed = d->vdir->health_changed;
242	404	return (d->vdir->admin_health->health);
243		}
244
245	11552	if (d->vdir->methods->healthy == NULL) {
246	11016	if (changed != NULL)
247	2144	*changed = d->vdir->health_changed;
248	11016	return (1);
249		}
250
251	536	return (d->vdir->methods->healthy(ctx, d, changed));
252	11956	}
253
254		/*--------------------------------------------------------------------
255		* Update health_changed.
256		*/
257		VCL_VOID
258	448	VRT_SetChanged(VCL_BACKEND d, VCL_TIME changed)
259		{
260
261	448	CHECK_OBJ_ORNULL(d, DIRECTOR_MAGIC);
262
263	448	if (d != NULL && changed > d->vdir->health_changed)
264	32	d->vdir->health_changed = changed;
265	448	}
266
267		/* Send Event ----------------------------------------------------------
268		*/
269
270		void
271	7177	VDI_Event(const struct director *d, enum vcl_event_e ev)
272		{
273
274	7177	CHECK_OBJ_NOTNULL(d, DIRECTOR_MAGIC);
275	7177	if (d->vdir->methods->event != NULL)
276	6147	d->vdir->methods->event(d, ev);
277	7177	}
278
279		/* Dump panic info -----------------------------------------------------
280		*/
281
282		void
283	28	VDI_Panic(const struct director d, struct vsb vsb, const char *nm)
284		{
285	28	if (d == NULL)
286	4	return;
287	24	VSB_printf(vsb, "%s = %p {\n", nm, d);
288	24	VSB_indent(vsb, 2);
289	24	VSB_printf(vsb, "cli_name = %s,\n", d->vdir->cli_name);
290	48	VSB_printf(vsb, "admin_health = %s, changed = %f,\n",
291	24	VDI_Ahealth(d), d->vdir->health_changed);
292	24	VSB_printf(vsb, "type = %s {\n", d->vdir->methods->type);
293	24	VSB_indent(vsb, 2);
294	24	if (d->vdir->methods->panic != NULL)
295	24	d->vdir->methods->panic(d, vsb);
296	24	VSB_indent(vsb, -2);
297	24	VSB_cat(vsb, "},\n");
298	24	VSB_indent(vsb, -2);
299	24	VSB_cat(vsb, "},\n");
300	28	}
301
302
303		/---------------------------------------------------------------------/
304
305		struct list_args {
306		unsigned magic;
307		#define LIST_ARGS_MAGIC 0x7e7cefeb
308		int p;
309		int j;
310		const char *jsep;
311		struct vsb *vsb;
312		struct vte *vte;
313		};
314
315		static const char *
316	4	cli_health(VRT_CTX, const struct director *d)
317		{
318	4	VCL_BOOL healthy = VRT_Healthy(ctx, d, NULL);
319
320	4	return (healthy ? "healthy" : "sick");
321		}
322
323		static int v_matchproto_(vcl_be_func)
324	4932	do_list(struct cli cli, struct director d, void *priv)
325		{
326		char time_str[VTIM_FORMAT_SIZE];
327		struct list_args *la;
328		struct vrt_ctx *ctx;
329
330	4932	AN(cli);
331	4932	CAST_OBJ_NOTNULL(la, priv, LIST_ARGS_MAGIC);
332	4932	AN(la->vsb);
333	4932	AN(la->vte);
334	4932	CHECK_OBJ_NOTNULL(d, DIRECTOR_MAGIC);
335
336	4932	if (d->vdir->admin_health == VDI_AH_DELETED)
337	0	return (0);
338
339	4932	ctx = VCL_Get_CliCtx(0);
340
341	4932	VTE_printf(la->vte, "%s\t%s\t", d->vdir->cli_name, VDI_Ahealth(d));
342
343	4932	if (d->vdir->methods->list != NULL) {
344	4684	VSB_clear(la->vsb);
345	4684	d->vdir->methods->list(ctx, d, la->vsb, 0, 0);
346	4684	AZ(VSB_finish(la->vsb));
347	4684	VTE_cat(la->vte, VSB_data(la->vsb));
348	4932	} else if (d->vdir->methods->healthy != NULL)
349	4	VTE_printf(la->vte, "0/0\t%s", cli_health(ctx, d));
350		else
351	244	VTE_cat(la->vte, "0/0\thealthy");
352
353	4932	VTIM_format(d->vdir->health_changed, time_str);
354	4932	VTE_printf(la->vte, "\t%s", time_str);
355	4932	if (la->p && d->vdir->methods->list != NULL) {
356	112	VSB_clear(la->vsb);
357	112	d->vdir->methods->list(ctx, d, la->vsb, la->p, 0);
358	112	AZ(VSB_finish(la->vsb));
359	112	VTE_cat(la->vte, VSB_data(la->vsb));
360	112	}
361
362	4932	VTE_cat(la->vte, "\n");
363	4932	AZ(VCL_Rel_CliCtx(&ctx));
364	4932	AZ(ctx);
365
366	4932	return (0);
367	4932	}
368
369		static int v_matchproto_(vcl_be_func)
370	124	do_list_json(struct cli cli, struct director d, void *priv)
371		{
372		struct list_args *la;
373		struct vrt_ctx *ctx;
374
375	124	CAST_OBJ_NOTNULL(la, priv, LIST_ARGS_MAGIC);
376	124	CHECK_OBJ_NOTNULL(d, DIRECTOR_MAGIC);
377
378	124	if (d->vdir->admin_health == VDI_AH_DELETED)
379	0	return (0);
380
381	124	ctx = VCL_Get_CliCtx(0);
382
383	124	VCLI_Out(cli, "%s", la->jsep);
384	124	la->jsep = ",\n";
385	124	VCLI_JSON_str(cli, d->vdir->cli_name);
386	124	VCLI_Out(cli, ": {\n");
387	124	VSB_indent(cli->sb, 2);
388	124	VCLI_Out(cli, "\"type\": \"%s\",\n", d->vdir->methods->type);
389	124	VCLI_Out(cli, "\"admin_health\": \"%s\",\n", VDI_Ahealth(d));
390	124	VCLI_Out(cli, "\"probe_message\": ");
391	124	if (d->vdir->methods->list != NULL)
392	116	d->vdir->methods->list(ctx, d, cli->sb, 0, 1);
393	8	else if (d->vdir->methods->healthy != NULL)
394	0	VCLI_Out(cli, "[0, 0, \"%s\"]", cli_health(ctx, d));
395		else
396	8	VCLI_Out(cli, "[0, 0, \"healthy\"]");
397
398	124	VCLI_Out(cli, ",\n");
399
400	124	if (la->p && d->vdir->methods->list != NULL) {
401	44	VCLI_Out(cli, "\"probe_details\": ");
402	44	d->vdir->methods->list(ctx, d, cli->sb, la->p, 1);
403	44	}
404	124	VCLI_Out(cli, "\"last_change\": %.3f\n", d->vdir->health_changed);
405	124	VSB_indent(cli->sb, -2);
406	124	VCLI_Out(cli, "}");
407
408	124	AZ(VCL_Rel_CliCtx(&ctx));
409	124	AZ(ctx);
410
411	124	return (0);
412	124	}
413
414		static void v_matchproto_(cli_func_t)
415	3668	cli_backend_list(struct cli cli, const char const av, void priv)
416		{
417		const char *p;
418		struct list_args la[1];
419		int i;
420
421	3668	(void)priv;
422	3668	ASSERT_CLI();
423	3668	INIT_OBJ(la, LIST_ARGS_MAGIC);
424	3668	la->jsep = "";
425	3748	for (i = 2; av[i] != NULL && av[i][0] == '-'; i++) {
426	164	for(p = av[i] + 1; *p; p++) {
427	84	switch(*p) {
428	20	case 'j': la->j = 1; break;
429	64	case 'p': la->p = !la->p; break;
430		default:
431	0	VCLI_Out(cli, "Invalid flag %c", *p);
432	0	VCLI_SetResult(cli, CLIS_PARAM);
433	0	return;
434		}
435	84	}
436	80	}
437	3668	if (av[i] != NULL && av[i+1] != NULL) {
438	0	VCLI_Out(cli, "Too many arguments");
439	0	VCLI_SetResult(cli, CLIS_PARAM);
440	0	return;
441		}
442	3668	if (la->j) {
443	20	VCLI_JSON_begin(cli, 3, av);
444	20	VCLI_Out(cli, ",\n");
445	20	VCLI_Out(cli, "{\n");
446	20	VSB_indent(cli->sb, 2);
447	20	(void)VCL_IterDirector(cli, av[i], do_list_json, la);
448	20	VSB_indent(cli->sb, -2);
449	20	VCLI_Out(cli, "\n");
450	20	VCLI_Out(cli, "}");
451	20	VCLI_JSON_end(cli);
452	20	} else {
453	3648	la->vsb = VSB_new_auto();
454	3648	AN(la->vsb);
455	3648	la->vte = VTE_new(5, 80);
456	3648	AN(la->vte);
457	3648	VTE_printf(la->vte, "%s\t%s\t%s\t%s\t%s\n",
458		"Backend name", "Admin", "Probe", "Health", "Last change");
459	3648	(void)VCL_IterDirector(cli, av[i], do_list, la);
460	3648	AZ(VTE_finish(la->vte));
461	3648	AZ(VTE_format(la->vte, VCLI_VTE_format, cli));
462	3648	VTE_destroy(&la->vte);
463	3648	VSB_destroy(&la->vsb);
464		}
465	3668	}
466
467		/---------------------------------------------------------------------/
468
469		struct set_health {
470		unsigned magic;
471		#define SET_HEALTH_MAGIC 0x0c46b9fb
472		const struct vdi_ahealth *ah;
473		};
474
475		static int v_matchproto_(vcl_be_func)
476	140	do_set_health(struct cli cli, struct director d, void *priv)
477		{
478		struct set_health *sh;
479
480	140	(void)cli;
481	140	CHECK_OBJ_NOTNULL(d, DIRECTOR_MAGIC);
482	140	CAST_OBJ_NOTNULL(sh, priv, SET_HEALTH_MAGIC);
483
484	140	if (d->vdir->admin_health == VDI_AH_DELETED)
485	0	return (0);
486	140	if (d->vdir->admin_health != sh->ah) {
487	128	d->vdir->health_changed = VTIM_real();
488	128	d->vdir->admin_health = sh->ah;
489	128	VDI_Event(d, VDI_EVENT_SICK);
490	128	}
491	140	return (0);
492	140	}
493
494		static void v_matchproto_()
495	168	cli_backend_set_health(struct cli cli, const char const av, void priv)
496		{
497		int n;
498		struct set_health sh[1];
499