GCOV - Varnish Cache


/*-
 * Copyright (c) 2006 Verdens Gang AS
 * Copyright (c) 2006-2016 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.
 *
 */

#include "config.h"

#include <dlfcn.h>
#include <fnmatch.h>
#include <stdio.h>
#include <stdlib.h>

#include "cache_varnishd.h"
#include "common/heritage.h"

#include "vcl.h"

#include "cache_director.h"
#include "cache_vcl.h"
#include "vbm.h"
#include "vcli_serve.h"
#include "vte.h"
#include "vtim.h"
#include "vcc_interface.h"

const struct vcltemp VCL_TEMP_INIT[1] = {{ .name = "init", .is_cold = 1 }};
const struct vcltemp VCL_TEMP_COLD[1] = {{ .name = "cold", .is_cold = 1 }};
const struct vcltemp VCL_TEMP_WARM[1] = {{ .name = "warm", .is_warm = 1 }};
const struct vcltemp VCL_TEMP_BUSY[1] = {{ .name = "busy", .is_warm = 1 }};
const struct vcltemp VCL_TEMP_COOLING[1] = {{ .name = "cooling" }};

// not really a temperature
static const struct vcltemp VCL_TEMP_LABEL[1] = {{ .name = "label" }};

/*
 * XXX: Presently all modifications to this list happen from the
 * CLI event-engine, so no locking is necessary
 */
static VTAILQ_HEAD(, vcl)       vcl_head =
    VTAILQ_HEAD_INITIALIZER(vcl_head);

struct lock             vcl_mtx;
struct vcl              *vcl_active; /* protected by vcl_mtx */

static struct vrt_ctx ctx_cli;
static struct wrk_vpi wrk_vpi_cli;
static struct ws ws_cli;
static uintptr_t ws_snapshot_cli;
static struct vsl_log vsl_cli;

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

void
VCL_Bo2Ctx(struct vrt_ctx *ctx, struct busyobj *bo)
{

        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
        CHECK_OBJ_NOTNULL(bo, BUSYOBJ_MAGIC);
        CHECK_OBJ_NOTNULL(bo->wrk, WORKER_MAGIC);
        ctx->vcl = bo->vcl;
        ctx->syntax = ctx->vcl->conf->syntax;
        ctx->vsl = bo->vsl;
        ctx->http_bereq = bo->bereq;
        ctx->http_beresp = bo->beresp;
        ctx->bo = bo;
        ctx->sp = bo->sp;
        ctx->now = bo->t_prev;
        ctx->ws = bo->ws;
        ctx->vpi = bo->wrk->vpi;
        ctx->vpi->handling = 0;
        ctx->vpi->trace = bo->trace;
}

void
VCL_Req2Ctx(struct vrt_ctx *ctx, struct req *req)
{

        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
        CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
        CHECK_OBJ_NOTNULL(req->doclose, STREAM_CLOSE_MAGIC);

        ctx->vcl = req->vcl;
        ctx->syntax = ctx->vcl->conf->syntax;
        ctx->vsl = req->vsl;
        ctx->http_req = req->http;
        CHECK_OBJ_NOTNULL(req->top, REQTOP_MAGIC);
        ctx->http_req_top = req->top->topreq->http;
        ctx->http_resp = req->resp;
        ctx->req = req;
        ctx->sp = req->sp;
        ctx->now = req->t_prev;
        ctx->ws = req->ws;
        ctx->vpi = req->wrk->vpi;
        ctx->vpi->handling = 0;
        ctx->vpi->trace = req->trace;
}

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

struct vrt_ctx *
VCL_Get_CliCtx(int msg)
{

        ASSERT_CLI();
        INIT_OBJ(&ctx_cli, VRT_CTX_MAGIC);
        INIT_OBJ(&wrk_vpi_cli, WRK_VPI_MAGIC);
        ctx_cli.vpi = &wrk_vpi_cli;
        wrk_vpi_cli.trace = FEATURE(FEATURE_TRACE);
        ctx_cli.now = VTIM_real();
        if (msg) {
                ctx_cli.msg = VSB_new_auto();
                AN(ctx_cli.msg);
        } else {
                ctx_cli.vsl = &vsl_cli;
        }
        ctx_cli.ws = &ws_cli;
        WS_Assert(ctx_cli.ws);
        return (&ctx_cli);
}

/*
 * releases CLI ctx
 *
 * returns finished error msg vsb if VCL_Get_CliCtx(1) was called
 *
 * caller needs to VSB_destroy a non-NULL return value
 *
 */
struct vsb *
VCL_Rel_CliCtx(struct vrt_ctx **ctx)
{
        struct vsb *r = NULL;

        ASSERT_CLI();
        assert(*ctx == &ctx_cli);
        AN((*ctx)->vpi);
        if (ctx_cli.msg) {
                TAKE_OBJ_NOTNULL(r, &ctx_cli.msg, VSB_MAGIC);
                AZ(VSB_finish(r));
        }
        if (ctx_cli.vsl)
                VSL_Flush(ctx_cli.vsl, 0);
        WS_Assert(ctx_cli.ws);
        WS_Rollback(&ws_cli, ws_snapshot_cli);
        INIT_OBJ(*ctx, VRT_CTX_MAGIC);
        *ctx = NULL;

        return (r);
}

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

/* VRT_fail() can be called
 * - from the vcl sub via a vmod
 * - via a PRIV_TASK .fini callback
 *
 * if this happens during init, we fail it
 * if during fini, we ignore, because otherwise VMOD authors would be forced to
 * handle VCL_MET_FINI specifically everywhere.
 */

static int
vcl_event_handling(VRT_CTX)
{
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);

        if (ctx->vpi->handling == 0)
                return (0);

        assert(ctx->vpi->handling == VCL_RET_FAIL);

        if (ctx->method == VCL_MET_INIT)
                return (1);

        /*
         * EVENT_WARM / EVENT_COLD: method == 0
         * must not set handling
         */
        assert(ctx->method == VCL_MET_FINI);

        ctx->vpi->handling = 0;
        VRT_fail(ctx, "VRT_fail() from vcl_fini{} has no effect");
        return (0);
}

static int
vcl_send_event(struct vcl *vcl, enum vcl_event_e ev, struct vsb **msg)
{
        int r, havemsg;
        unsigned method = 0;
        struct vrt_ctx *ctx;
        void *vbm_alloc = NULL;
        size_t sz;

        ASSERT_CLI();
        ASSERT_VCL_ACTIVE();

        CHECK_OBJ_NOTNULL(vcl, VCL_MAGIC);
        CHECK_OBJ_NOTNULL(vcl->conf, VCL_CONF_MAGIC);
        AN(msg);
        AZ(*msg);

        switch (ev) {
        case VCL_EVENT_LOAD:
                method = VCL_MET_INIT;
                /* FALLTHROUGH */
        case VCL_EVENT_WARM:
                havemsg = 1;
                break;
        case VCL_EVENT_DISCARD:
                method = VCL_MET_FINI;
                /* FALLTHROUGH */
        case VCL_EVENT_COLD:
                havemsg = 0;
                break;
        default:
                WRONG("vcl_event");
        }

        ctx = VCL_Get_CliCtx(havemsg);

        AN(ctx->vpi);
        AZ(ctx->vpi->handling);
        AN(ctx->ws);

        ctx->vcl = vcl;
        ctx->syntax = ctx->vcl->conf->syntax;
        ctx->method = method;

        if (vcl->conf->nsub > 0) {
                sz = VBITMAP_SZ(vcl->conf->nsub);
                vbm_alloc = malloc(sz);
                AN(vbm_alloc);
                ctx->called = vbit_init(vbm_alloc, sz);
        }

        VCL_TaskEnter(cli_task_privs);
        r = ctx->vcl->conf->event_vcl(ctx, ev);
        VCL_TaskLeave(ctx, cli_task_privs);
        r |= vcl_event_handling(ctx);

        *msg = VCL_Rel_CliCtx(&ctx);

        if (r && (ev == VCL_EVENT_COLD || ev == VCL_EVENT_DISCARD))
                WRONG("A VMOD cannot fail COLD or DISCARD events");

        free(vbm_alloc);

        return (r);
}

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

struct vcl *
vcl_find(const char *name)
{
        struct vcl *vcl;

        ASSERT_CLI();
        VTAILQ_FOREACH(vcl, &vcl_head, list) {
                if (vcl->discard)
                        continue;
                if (!strcmp(vcl->loaded_name, name))
                        return (vcl);
        }
        return (NULL);
}

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

static void
vcl_panic_conf(struct vsb *vsb, const struct VCL_conf *conf)
{
        unsigned u;
        const struct vpi_ii *ii;

        if (PAN_dump_struct(vsb, conf, VCL_CONF_MAGIC, "conf"))
                return;
        VSB_printf(vsb, "syntax = \"%u\",\n", conf->syntax);
        VSB_cat(vsb, "srcname = {\n");
        VSB_indent(vsb, 2);
        for (u = 0; u < conf->nsrc; ++u)
                VSB_printf(vsb, "[%u] = \"%s\",\n", u, conf->srcname[u]);
        VSB_indent(vsb, -2);
        VSB_cat(vsb, "},\n");
        VSB_cat(vsb, "instances = {\n");
        VSB_indent(vsb, 2);
        ii = conf->instance_info;
        while (ii != NULL && ii->p != NULL) {
                VSB_printf(vsb, "\"%s\" = %p,\n", ii->name,
                    (const void *)*(const uintptr_t *)ii->p);
                ii++;
        }
        VSB_indent(vsb, -2);
        VSB_cat(vsb, "},\n");
        VSB_indent(vsb, -2);
        VSB_cat(vsb, "},\n");
}

void
VCL_Panic(struct vsb *vsb, const char *nm, const struct vcl *vcl)
{

        AN(vsb);
        if (PAN_dump_struct(vsb, vcl, VCL_MAGIC, "vcl[%s]", nm))
                return;
        VSB_printf(vsb, "name = \"%s\",\n", vcl->loaded_name);
        VSB_printf(vsb, "busy = %u,\n", vcl->busy);
        VSB_printf(vsb, "discard = %u,\n", vcl->discard);
        VSB_printf(vsb, "state = %s,\n", vcl->state);
        VSB_printf(vsb, "temp = %s,\n", vcl->temp ? vcl->temp->name : "(null)");
        vcl_panic_conf(vsb, vcl->conf);
        VSB_indent(vsb, -2);
        VSB_cat(vsb, "},\n");
}

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

void
VCL_Update(struct vcl **vcc, struct vcl *vcl)
{
        struct vcl *old;

        AN(vcc);

        old = *vcc;
        *vcc = NULL;

        CHECK_OBJ_ORNULL(old, VCL_MAGIC);
        ASSERT_VCL_ACTIVE();

        Lck_Lock(&vcl_mtx);
        if (old != NULL) {
                assert(old->busy > 0);
                old->busy--;
        }

        if (vcl == NULL)
                vcl = vcl_active; /* Sample vcl_active under lock to avoid
                                   * race */
        CHECK_OBJ_NOTNULL(vcl, VCL_MAGIC);
        if (vcl->label == NULL) {
                AN(strcmp(vcl->state, VCL_TEMP_LABEL->name));
                *vcc = vcl;
        } else {
                AZ(strcmp(vcl->state, VCL_TEMP_LABEL->name));
                *vcc = vcl->label;
        }
        CHECK_OBJ_NOTNULL(*vcc, VCL_MAGIC);
        AZ((*vcc)->discard);
        (*vcc)->busy++;
        Lck_Unlock(&vcl_mtx);
        assert((*vcc)->temp->is_warm);
}

/*--------------------------------------------------------------------
 * vdire: Vcl DIrector REsignation Management (born out of a dire situation)
 * iterators over the director list need to register.
 * while iterating, directors can not retire immediately,
 * they get put on a list of resigning directors. The
 * last iterator executes the retirement.
 */

static struct vdire *
vdire_new(struct lock *mtx, const struct vcltemp **tempp)
{
        struct vdire *vdire;

        ALLOC_OBJ(vdire, VDIRE_MAGIC);
        AN(vdire);
        AN(mtx);
        VTAILQ_INIT(&vdire->directors);
        VTAILQ_INIT(&vdire->resigning);
        vdire->mtx = mtx;
        PTOK(pthread_cond_init(&vdire->cond, NULL));
        vdire->tempp = tempp;
        return (vdire);
}

/* starting an interation prevents removals from the directors list */
void
vdire_start_iter(struct vdire *vdire)
{

        CHECK_OBJ_NOTNULL(vdire, VDIRE_MAGIC);

        // https://github.com/varnishcache/varnish-cache/pull/4142#issuecomment-2593091097
        ASSERT_CLI();

        Lck_Lock(vdire->mtx);
        while (! VTAILQ_EMPTY(&vdire->resigning))
                (void)Lck_CondWait(&vdire->cond, vdire->mtx);
        vdire->iterating++;
        Lck_Unlock(vdire->mtx);
}

void
vdire_end_iter(struct vdire *vdire)
{
        struct vcldir_head resigning = VTAILQ_HEAD_INITIALIZER(resigning);
        const struct vcltemp *temp = NULL;
        struct vcldir *vdir, *next;
        unsigned n;

        CHECK_OBJ_NOTNULL(vdire, VDIRE_MAGIC);

        Lck_Lock(vdire->mtx);
        AN(vdire->iterating);
        n = --vdire->iterating;

        if (n == 0) {
                VTAILQ_SWAP(&vdire->resigning, &resigning, vcldir, resigning_list);
                VTAILQ_FOREACH(vdir, &resigning, resigning_list)
                        VTAILQ_REMOVE(&vdire->directors, vdir, directors_list);
                temp = *vdire->tempp;
                PTOK(pthread_cond_broadcast(&vdire->cond));
        }
        Lck_Unlock(vdire->mtx);

        VTAILQ_FOREACH_SAFE(vdir, &resigning, resigning_list, next)
                vcldir_retire(vdir, temp);
}

/*
 * like vdire_start_iter, but also prepare for backend_event_*()
 * by setting the checkpoint
 */
static void
vdire_start_event(struct vdire *vdire, const struct vcltemp *temp)
{

        CHECK_OBJ_NOTNULL(vdire, VDIRE_MAGIC);
        AN(temp);

        Lck_AssertHeld(vdire->mtx);

        // https://github.com/varnishcache/varnish-cache/pull/4142#issuecomment-2593091097
        ASSERT_CLI();

        AZ(vdire->checkpoint);
        vdire->checkpoint = VTAILQ_LAST(&vdire->directors, vcldir_head);
        AN(vdire->tempp);
        *vdire->tempp = temp;
        vdire->iterating++;
}

static void
vdire_end_event(struct vdire *vdire)
{
        vdire->checkpoint = NULL;
        vdire_end_iter(vdire);
}

// if there are no iterators, remove from directors and retire
// otherwise put on resigning list to work when iterators end
void
vdire_resign(struct vdire *vdire, struct vcldir *vdir)
{
        const struct vcltemp *temp = NULL;

        CHECK_OBJ_NOTNULL(vdire, VDIRE_MAGIC);
        AN(vdir);

        Lck_Lock(vdire->mtx);
        if (vdire->iterating != 0) {
                VTAILQ_INSERT_TAIL(&vdire->resigning, vdir, resigning_list);
                vdir = NULL;
        } else {
                VTAILQ_REMOVE(&vdire->directors, vdir, directors_list);
                temp = *vdire->tempp;
        }
        Lck_Unlock(vdire->mtx);

        if (vdir != NULL)
                vcldir_retire(vdir, temp);
}

// unlocked version of vcl_iterdir
// pat can also be NULL (to iterate all)
static int
vdire_iter(struct cli *cli, const char *pat, const struct vcl *vcl,
    vcl_be_func *func, void *priv)
{
        int i, found = 0;
        struct vcldir *vdir;
        struct vdire *vdire = vcl->vdire;

        vdire_start_iter(vdire);
        VTAILQ_FOREACH(vdir, &vdire->directors, directors_list) {
                CHECK_OBJ(vdir, VCLDIR_MAGIC);
                if (vdir->refcnt == 0)
                        continue;
                if (pat != NULL && fnmatch(pat, vdir->cli_name, 0))
                        continue;
                found++;
                i = func(cli, vdir->dir, priv);
                if (i < 0) {
                        found = i;
                        break;
                }
                found += i;
        }
        vdire_end_iter(vdire);
        return (found);
}


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

// XXX locked case across VCLs - should do without
static int
vcl_iterdir(struct cli *cli, const char *pat, const struct vcl *vcl,
    vcl_be_func *func, void *priv)
{
        int i, found = 0;
        struct vcldir *vdir;

        AN(vcl->vdire); // no labels

        Lck_AssertHeld(&vcl_mtx);
        VTAILQ_FOREACH(vdir, &vcl->vdire->directors, directors_list) {
                CHECK_OBJ(vdir, VCLDIR_MAGIC);
                if (fnmatch(pat, vdir->cli_name, 0))
                        continue;
                found++;
                i = func(cli, vdir->dir, priv);
                if (i < 0)
                        return (i);
                found += i;
        }
        return (found);
}

int
VCL_IterDirector(struct cli *cli, const char *pat,
    vcl_be_func *func, void *priv)
{
        int i, found = 0;
        struct vsb *vsb;
        struct vcl *vcl;

        ASSERT_CLI();
        ASSERT_VCL_ACTIVE();
        vsb = VSB_new_auto();
        AN(vsb);
        if (pat == NULL || *pat == '\0' || !strcmp(pat, "*")) {
                // all backends in active VCL
                VSB_printf(vsb, "%s.*", VCL_Name(vcl_active));
                vcl = vcl_active;
        } else if (strchr(pat, '.') == NULL) {
                // pattern applies to active vcl
                VSB_printf(vsb, "%s.%s", VCL_Name(vcl_active), pat);
                vcl = vcl_active;
        } else {
                // use pattern as is
                VSB_cat(vsb, pat);
                vcl = NULL;
        }
        AZ(VSB_finish(vsb));
        if (vcl != NULL) {
                found = vdire_iter(cli, VSB_data(vsb), vcl, func, priv);
        } else {
                Lck_Lock(&vcl_mtx);
                VTAILQ_FOREACH(vcl, &vcl_head, list) {
                        // skip labels
                        if (! vcl->vdire)
                                continue;
                        i = vcl_iterdir(cli, VSB_data(vsb), vcl, func, priv);
                        if (i < 0) {
                                found = i;
                                break;
                        } else {
                                found += i;
                        }
                }
                Lck_Unlock(&vcl_mtx);
        }
        VSB_destroy(&vsb);
        return (found);
}

/*
 * vdire_start_event() must have been called before
 *
 * send event to directors pre checkpoint
 */
static void
backend_event_base(const struct vcl *vcl, enum vcl_event_e e)
{
        struct vcldir *vdir;
        struct vdire *vdire;

        ASSERT_CLI();
        CHECK_OBJ_NOTNULL(vcl, VCL_MAGIC);
        AZ(vcl->busy);
        vdire = vcl->vdire;
        AN(vdire->iterating);

        vdir = vdire->checkpoint;
        if (vdir == NULL)
                return;

        CHECK_OBJ(vdir, VCLDIR_MAGIC);
        VTAILQ_FOREACH_REVERSE_FROM(vdir, &vdire->directors,
            vcldir_head, directors_list) {
                CHECK_OBJ(vdir, VCLDIR_MAGIC);
                VDI_Event(vdir->dir, e);
        }
}

/*
 * vdire_start_event() must have been called before
 *
 * set a new temperature.
 * send event to directors added post checkpoint, but before
 * the new temperature
 */
static void
backend_event_delta(const struct vcl *vcl, enum vcl_event_e e, const struct vcltemp *temp)
{
        struct vcldir *vdir, *end;
        struct vdire *vdire;

        ASSERT_CLI();
        CHECK_OBJ_NOTNULL(vcl, VCL_MAGIC);
        AZ(vcl->busy);
        vdire = vcl->vdire;
        AN(temp);
        AN(vdire->iterating);

        Lck_Lock(vdire->mtx);
        if (vdire->checkpoint == NULL)
                vdir = VTAILQ_FIRST(&vdire->directors);
        else
                vdir = VTAILQ_NEXT(vdire->checkpoint, directors_list);
        AN(vdire->tempp);
        *vdire->tempp = temp;
        end = VTAILQ_LAST(&vdire->directors, vcldir_head);
        Lck_Unlock(vdire->mtx);

        while (vdir != NULL) {
                CHECK_OBJ(vdir, VCLDIR_MAGIC);
                VDI_Event(vdir->dir, e);
                if (vdir == end)
                        break;
                vdir = VTAILQ_NEXT(vdir, directors_list);
        }
}

static void
vcl_KillBackends(const struct vcl *vcl)
{
        struct vcldir *vdir, *vdir2;
        struct vdire *vdire;

        CHECK_OBJ_NOTNULL(vcl, VCL_MAGIC);
        assert(vcl->temp == VCL_TEMP_COLD || vcl->temp == VCL_TEMP_INIT);
        vdire = vcl->vdire;
        CHECK_OBJ_NOTNULL(vdire, VDIRE_MAGIC);

        /*
         * ensure all retirement has finished (vdire_start_iter waits for it)
         */
        vdire_start_iter(vdire);
        vdire_end_iter(vdire);
        AZ(vdire->iterating);
        assert(VTAILQ_EMPTY(&vdire->resigning));

        /*
         * Unlocked and sidelining vdire because no further directors can be added, and the
         * remaining ones need to be able to remove themselves.
         */
        VTAILQ_FOREACH_SAFE(vdir, &vdire->directors, directors_list, vdir2) {
                CHECK_OBJ(vdir, VCLDIR_MAGIC);
                VDI_Event(vdir->dir, VCL_EVENT_DISCARD);
        }
        assert(VTAILQ_EMPTY(&vdire->directors));
}

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

static struct vcl *
VCL_Open(const char *fn, struct vsb *msg)
{
        struct vcl *vcl;
        void *dlh;
        struct VCL_conf const *cnf;
        const char *dlerr;
        int err;

        AN(fn);
        AN(msg);

#ifdef RTLD_NOLOAD
        /* Detect bogus caching by dlopen(3) */
        dlh = dlopen(fn, RTLD_NOW | RTLD_NOLOAD);
        AZ(dlh);
#endif
        dlh = dlopen(fn, RTLD_NOW | RTLD_LOCAL);
        if (dlh == NULL) {
                err = errno;
                dlerr = dlerror();
                VSB_cat(msg, "Could not load compiled VCL.\n");
                if (dlerr != NULL)
                        VSB_printf(msg, "\tdlopen() = %s\n", dlerr);
                if (err) {
                        VSB_printf(msg, "\terror = %s (%d)\n",
                            strerror(err), err);
                }
                VSB_cat(msg, "\thint: check for \"noexec\" mount\n");
                VSB_cat(msg, "\thint: check \"vmod_path\" parameter\n");
                return (NULL);
        }
        cnf = dlsym(dlh, "VCL_conf");
        if (cnf == NULL) {
                VSB_cat(msg, "Compiled VCL lacks metadata.\n");
                (void)dlclose(dlh);
                return (NULL);
        }
        if (cnf->magic != VCL_CONF_MAGIC) {
                VSB_cat(msg, "Compiled VCL has mangled metadata.\n");
                (void)dlclose(dlh);
                return (NULL);
        }
        if (cnf->syntax < heritage.min_vcl_version ||
            cnf->syntax > heritage.max_vcl_version) {
                VSB_printf(msg, "Compiled VCL version (%.1f) not supported.\n",
                    .1 * cnf->syntax);
                (void)dlclose(dlh);
                return (NULL);
        }
        ALLOC_OBJ(vcl, VCL_MAGIC);
        AN(vcl);
        vcl->dlh = dlh;
        vcl->conf = cnf;
        vcl->vdire = vdire_new(&vcl_mtx, &vcl->temp);
        return (vcl);
}

static void
VCL_Close(struct vcl **vclp)
{
        struct vcl *vcl;

        TAKE_OBJ_NOTNULL(vcl, vclp, VCL_MAGIC);
        assert(VTAILQ_EMPTY(&vcl->filters));
        AZ(dlclose(vcl->dlh));
        PTOK(pthread_cond_destroy(&vcl->vdire->cond));
        FREE_OBJ(vcl->vdire);
        FREE_OBJ(vcl);
}

/*--------------------------------------------------------------------
 * NB: This function is called in/from the test-load subprocess.
 */

int
VCL_TestLoad(const char *fn)
{
        struct vsb *vsb;
        struct vcl *vcl;
        int retval = 0;

        AN(fn);
        vsb = VSB_new_auto();
        AN(vsb);
        vcl = VCL_Open(fn, vsb);
        if (vcl == NULL) {
                AZ(VSB_finish(vsb));
                fprintf(stderr, "%s", VSB_data(vsb));
                retval = -1;
        } else
                VCL_Close(&vcl);
        VSB_destroy(&vsb);
        return (retval);
}

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

static struct vsb *
vcl_print_refs(const struct vcl *vcl)
{
        struct vsb *msg;
        struct vclref *ref;

        CHECK_OBJ_NOTNULL(vcl, VCL_MAGIC);
        msg = VSB_new_auto();
        AN(msg);

        VSB_printf(msg, "VCL %s is waiting for:", vcl->loaded_name);
        Lck_Lock(&vcl_mtx);
        VTAILQ_FOREACH(ref, &vcl->ref_list, list)
                VSB_printf(msg, "\n\t- %s", ref->desc);
        Lck_Unlock(&vcl_mtx);
        AZ(VSB_finish(msg));
        return (msg);
}

static int
vcl_set_state(struct vcl *vcl, const char *state, struct vsb **msg)
{
        struct vsb *nomsg = NULL;
        int i = 0;

        ASSERT_CLI();

        CHECK_OBJ_NOTNULL(vcl, VCL_MAGIC);
        AN(state);
        AN(msg);
        AZ(*msg);

        AN(vcl->temp);

        switch (state[0]) {
        case '0':
                if (vcl->temp == VCL_TEMP_COLD)
                        break;
                if (vcl->busy == 0 && vcl->temp->is_warm) {
                        Lck_Lock(&vcl_mtx);
                        vdire_start_event(vcl->vdire, VTAILQ_EMPTY(&vcl->ref_list) ?
                            VCL_TEMP_COLD : VCL_TEMP_COOLING);
                        Lck_Unlock(&vcl_mtx);
                        backend_event_base(vcl, VCL_EVENT_COLD);
                        vdire_end_event(vcl->vdire);
                        // delta directors at VCL_TEMP_COLD do not need an event
                        AZ(vcl_send_event(vcl, VCL_EVENT_COLD, msg));
                        AZ(*msg);
                }
                else if (vcl->busy)
                        vcl->temp = VCL_TEMP_BUSY;
                else if (VTAILQ_EMPTY(&vcl->ref_list))
                        vcl->temp = VCL_TEMP_COLD;
                else
                        vcl->temp = VCL_TEMP_COOLING;
                break;
        case '1':
                if (vcl->temp == VCL_TEMP_WARM)
                        break;
                /* The warm VCL hasn't seen a cold event yet */
                if (vcl->temp == VCL_TEMP_BUSY)
                        vcl->temp = VCL_TEMP_WARM;
                /* The VCL must first reach a stable cold state */
                else if (vcl->temp == VCL_TEMP_COOLING) {
                        *msg = vcl_print_refs(vcl);
                        i = -1;
                }
                else {
                        Lck_Lock(&vcl_mtx);
                        vdire_start_event(vcl->vdire, VCL_TEMP_WARM);
                        Lck_Unlock(&vcl_mtx);
                        i = vcl_send_event(vcl, VCL_EVENT_WARM, msg);
                        if (i == 0) {
                                backend_event_base(vcl, VCL_EVENT_WARM);
                                // delta directors are already warm
                                vdire_end_event(vcl->vdire);
                                break;
                        }
                        AZ(vcl_send_event(vcl, VCL_EVENT_COLD, &nomsg));
                        AZ(nomsg);
                        backend_event_delta(vcl, VCL_EVENT_COLD, VCL_TEMP_COLD);
                        vdire_end_event(vcl->vdire);
                }
                break;
        default:
                WRONG("Wrong enum state");
        }
        if (i == 0 && state[1])
                bprintf(vcl->state, "%s", state + 1);

        return (i);
}

static void
vcl_cancel_load(struct vcl *vcl, struct cli *cli, struct vsb *msg,
    const char *name, const char *step)
{

        CHECK_OBJ_NOTNULL(vcl, VCL_MAGIC);
        CHECK_OBJ_NOTNULL(vcl->conf, VCL_CONF_MAGIC);

        VCLI_SetResult(cli, CLIS_CANT);
        VCLI_Out(cli, "VCL \"%s\" Failed %s", name, step);
        if (VSB_len(msg))
                VCLI_Out(cli, "\nMessage:\n\t%s", VSB_data(msg));
        VSB_destroy(&msg);

        AZ(vcl_send_event(vcl, VCL_EVENT_DISCARD, &msg));
        AZ(msg);

        vcl_KillBackends(vcl);
        free(vcl->loaded_name);
        VCL_Close(&vcl);
}

static void
vcl_load(struct cli *cli,
    const char *name, const char *fn, const char *state)
{
        struct vcl *vcl;
        struct vsb *msg;

        ASSERT_CLI();
        ASSERT_VCL_ACTIVE();

        vcl = vcl_find(name);
        AZ(vcl);

        msg = VSB_new_auto();
        AN(msg);
        vcl = VCL_Open(fn, msg);
        AZ(VSB_finish(msg));
        if (vcl == NULL) {
                VCLI_SetResult(cli, CLIS_PARAM);
                VCLI_Out(cli, "%s", VSB_data(msg));
                VSB_destroy(&msg);
                return;
        }

        VSB_destroy(&msg);

        vcl->loaded_name = strdup(name);
        XXXAN(vcl->loaded_name);
        VTAILQ_INIT(&vcl->ref_list);
        VTAILQ_INIT(&vcl->filters);

        vcl->temp = VCL_TEMP_INIT;

        if (vcl_send_event(vcl, VCL_EVENT_LOAD, &msg)) {
                vcl_cancel_load(vcl, cli, msg, name, "initialization");
                return;
        }
        VSB_destroy(&msg);

        if (vcl_set_state(vcl, state, &msg)) {
                assert(*state == '1');
                vcl_cancel_load(vcl, cli, msg, name, "warmup");
                return;
        }
        if (msg)
                VSB_destroy(&msg);

        VCLI_Out(cli, "Loaded \"%s\" as \"%s\"", fn , name);
        VTAILQ_INSERT_TAIL(&vcl_head, vcl, list);
        VSC_C_main->n_vcl++;
        VSC_C_main->n_vcl_avail++;
}

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

void
VCL_Poll(void)
{
        struct vsb *nomsg = NULL;
        struct vcl *vcl, *vcl2;

        ASSERT_CLI();
        ASSERT_VCL_ACTIVE();
        VTAILQ_FOREACH_SAFE(vcl, &vcl_head, list, vcl2) {
                if (vcl->temp == VCL_TEMP_BUSY ||
                    vcl->temp == VCL_TEMP_COOLING)
                        AZ(vcl_set_state(vcl, "0", &nomsg));
                AZ(nomsg);
                if (vcl->discard && vcl->temp == VCL_TEMP_COLD) {
                        AZ(vcl->busy);
                        assert(vcl != vcl_active);
                        assert(VTAILQ_EMPTY(&vcl->ref_list));
                        VTAILQ_REMOVE(&vcl_head, vcl, list);
                        AZ(vcl_send_event(vcl, VCL_EVENT_DISCARD, &nomsg));
                        AZ(nomsg);
                        vcl_KillBackends(vcl);
                        free(vcl->loaded_name);
                        VCL_Close(&vcl);
                        VSC_C_main->n_vcl--;
                        VSC_C_main->n_vcl_discard--;
                }
        }
}

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

static void v_matchproto_(cli_func_t)
vcl_cli_list(struct cli *cli, const char * const *av, void *priv)
{
        struct vcl *vcl;
        const char *flg;
        struct vte *vte;

        /* NB: Shall generate same output as mcf_vcl_list() */

        (void)av;
        (void)priv;
        ASSERT_CLI();
        ASSERT_VCL_ACTIVE();
        vte = VTE_new(7, 80);
        AN(vte);
        VTAILQ_FOREACH(vcl, &vcl_head, list) {
                if (vcl == vcl_active) {
                        flg = "active";
                } else if (vcl->discard) {
                        flg = "discarded";
                } else
                        flg = "available";
                VTE_printf(vte, "%s\t%s\t%s\t\v%u\t%s", flg, vcl->state,
                    vcl->temp->name, vcl->busy, vcl->loaded_name);
                if (vcl->label != NULL) {
                        VTE_printf(vte, "\t->\t%s", vcl->label->loaded_name);
                        if (vcl->nrefs)
                                VTE_printf(vte, " (%d return(vcl)%s)",
                                    vcl->nrefs, vcl->nrefs > 1 ? "'s" : "");
                } else if (vcl->nlabels > 0) {
                        VTE_printf(vte, "\t<-\t(%d label%s)",
                            vcl->nlabels, vcl->nlabels > 1 ? "s" : "");
                }
                VTE_cat(vte, "\n");
        }
        AZ(VTE_finish(vte));
        AZ(VTE_format(vte, VCLI_VTE_format, cli));
        VTE_destroy(&vte);
}

static void v_matchproto_(cli_func_t)
vcl_cli_list_json(struct cli *cli, const char * const *av, void *priv)
{
        struct vcl *vcl;

        (void)priv;
        ASSERT_CLI();
        ASSERT_VCL_ACTIVE();
        VCLI_JSON_begin(cli, 2, av);
        VCLI_Out(cli, ",\n");
        VTAILQ_FOREACH(vcl, &vcl_head, list) {
                VCLI_Out(cli, "{\n");
                VSB_indent(cli->sb, 2);
                VCLI_Out(cli, "\"status\": ");
                if (vcl == vcl_active) {
                        VCLI_Out(cli, "\"active\",\n");
                } else if (vcl->discard) {
                        VCLI_Out(cli, "\"discarded\",\n");
                } else
                        VCLI_Out(cli, "\"available\",\n");
                VCLI_Out(cli, "\"state\": \"%s\",\n", vcl->state);
                VCLI_Out(cli, "\"temperature\": \"%s\",\n", vcl->temp->name);
                VCLI_Out(cli, "\"busy\": %u,\n", vcl->busy);
                VCLI_Out(cli, "\"name\": \"%s\"", vcl->loaded_name);
                if (vcl->label != NULL) {
                        VCLI_Out(cli, ",\n");
                        VCLI_Out(cli, "\"label\": {\n");
                        VSB_indent(cli->sb, 2);
                                VCLI_Out(cli, "\"name\": \"%s\"",
                                         vcl->label->loaded_name);
                        if (vcl->nrefs)
                                VCLI_Out(cli, ",\n\"refs\": %d", vcl->nrefs);
                        VCLI_Out(cli, "\n");
                        VCLI_Out(cli, "}");
                        VSB_indent(cli->sb, -2);
                } else if (vcl->nlabels > 0) {
                        VCLI_Out(cli, ",\n");
                        VCLI_Out(cli, "\"labels\": %d", vcl->nlabels);
                }
                VSB_indent(cli->sb, -2);
                VCLI_Out(cli, "\n}");
                if (VTAILQ_NEXT(vcl, list) != NULL)
                        VCLI_Out(cli, ",\n");
        }
        VCLI_JSON_end(cli);
}

static void v_matchproto_(cli_func_t)
vcl_cli_load(struct cli *cli, const char * const *av, void *priv)
{

        AZ(priv);
        ASSERT_CLI();
        // XXX move back code from vcl_load?
        vcl_load(cli, av[2], av[3], av[4]);
}

static void v_matchproto_(cli_func_t)
vcl_cli_state(struct cli *cli, const char * const *av, void *priv)
{
        struct vcl *vcl;
        struct vsb *msg = NULL;

        AZ(priv);
        ASSERT_CLI();
        ASSERT_VCL_ACTIVE();
        AN(av[2]);
        AN(av[3]);

        vcl = vcl_find(av[2]);
        AN(vcl);

        if (vcl_set_state(vcl, av[3], &msg)) {
                CHECK_OBJ_NOTNULL(msg, VSB_MAGIC);

                VCLI_SetResult(cli, CLIS_CANT);
                VCLI_Out(cli, "Failed <vcl.state %s %s>", vcl->loaded_name,
                    av[3] + 1);
                if (VSB_len(msg))
                        VCLI_Out(cli, "\nMessage:\n\t%s", VSB_data(msg));
        }
        if (msg)
                VSB_destroy(&msg);
}

static void v_matchproto_(cli_func_t)
vcl_cli_discard(struct cli *cli, const char * const *av, void *priv)
{
        struct vcl *vcl;

        ASSERT_CLI();
        ASSERT_VCL_ACTIVE();
        (void)cli;
        AZ(priv);
        vcl = vcl_find(av[2]);
        CHECK_OBJ_NOTNULL(vcl, VCL_MAGIC);              // MGT ensures this
        Lck_Lock(&vcl_mtx);
        assert (vcl != vcl_active);     // MGT ensures this
        AZ(vcl->nlabels);               // MGT ensures this
        VSC_C_main->n_vcl_discard++;
        VSC_C_main->n_vcl_avail--;
        vcl->discard = 1;
        if (vcl->label != NULL) {
                AZ(strcmp(vcl->state, VCL_TEMP_LABEL->name));
                vcl->label->nlabels--;
                vcl->label= NULL;
        }
        Lck_Unlock(&vcl_mtx);

        if (!strcmp(vcl->state, VCL_TEMP_LABEL->name)) {
                VTAILQ_REMOVE(&vcl_head, vcl, list);
                free(vcl->loaded_name);
                AZ(vcl->vdire);
                FREE_OBJ(vcl);
        } else if (vcl->temp == VCL_TEMP_COLD) {
                VCL_Poll();
        }
}

static void v_matchproto_(cli_func_t)
vcl_cli_label(struct cli *cli, const char * const *av, void *priv)
{
        struct vcl *lbl;
        struct vcl *vcl;

        ASSERT_CLI();
        ASSERT_VCL_ACTIVE();
        (void)cli;
        (void)priv;
        vcl = vcl_find(av[3]);
        AN(vcl);                                // MGT ensures this
        lbl = vcl_find(av[2]);
        if (lbl == NULL) {
                ALLOC_OBJ(lbl, VCL_MAGIC);
                AN(lbl);
                bprintf(lbl->state, "%s", VCL_TEMP_LABEL->name);
                lbl->temp = VCL_TEMP_WARM;
                REPLACE(lbl->loaded_name, av[2]);
                VTAILQ_INSERT_TAIL(&vcl_head, lbl, list);
        }
        if (lbl->label != NULL)
                lbl->label->nlabels--;
        lbl->label = vcl;
        vcl->nlabels++;
}

static void v_matchproto_(cli_func_t)
vcl_cli_use(struct cli *cli, const char * const *av, void *priv)
{
        struct vcl *vcl;

        ASSERT_CLI();
        ASSERT_VCL_ACTIVE();
        AN(cli);
        AZ(priv);
        vcl = vcl_find(av[2]);
        AN(vcl);                                // MGT ensures this
        assert(vcl->temp == VCL_TEMP_WARM);     // MGT ensures this
        Lck_Lock(&vcl_mtx);
        vcl_active = vcl;
        Lck_Unlock(&vcl_mtx);
}

static void v_matchproto_(cli_func_t)
vcl_cli_show(struct cli *cli, const char * const *av, void *priv)
{
        struct vcl *vcl;
        int verbose = 0;
        int i = 2;
        unsigned u;

        ASSERT_CLI();
        ASSERT_VCL_ACTIVE();
        AZ(priv);

        if (av[i] != NULL && !strcmp(av[i], "-v")) {
                verbose = 1;
                i++;
        }

        if (av[i] == NULL) {
                vcl = vcl_active;
                AN(vcl);
        } else {
                vcl = vcl_find(av[i]);
                i++;
        }

        if (av[i] != NULL) {
                VCLI_Out(cli, "Too many parameters: '%s'", av[i]);
                VCLI_SetResult(cli, CLIS_PARAM);
                return;
        }

        if (vcl == NULL) {
                VCLI_Out(cli, "No VCL named '%s'", av[i - 1]);
                VCLI_SetResult(cli, CLIS_PARAM);
                return;
        }
        CHECK_OBJ_NOTNULL(vcl, VCL_MAGIC);
        if (vcl->label) {
                vcl = vcl->label;
                CHECK_OBJ_NOTNULL(vcl, VCL_MAGIC);
                AZ(vcl->label);
        }
        CHECK_OBJ_NOTNULL(vcl->conf, VCL_CONF_MAGIC);
        if (verbose) {
                for (u = 0; u < vcl->conf->nsrc; u++)
                        VCLI_Out(cli, "// VCL.SHOW %u %zd %s\n%s\n",
                            u, strlen(vcl->conf->srcbody[u]),
                            vcl->conf->srcname[u],
                            vcl->conf->srcbody[u]);
        } else {
                VCLI_Out(cli, "%s", vcl->conf->srcbody[0]);
        }
}

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

static struct cli_proto vcl_cmds[] = {
        { CLICMD_VCL_LOAD,              "", vcl_cli_load },
        { CLICMD_VCL_LIST,              "", vcl_cli_list, vcl_cli_list_json },
        { CLICMD_VCL_STATE,             "", vcl_cli_state },
        { CLICMD_VCL_DISCARD,           "", vcl_cli_discard },
        { CLICMD_VCL_USE,               "", vcl_cli_use },
        { CLICMD_VCL_SHOW,              "", vcl_cli_show },
        { CLICMD_VCL_LABEL,             "", vcl_cli_label },
        { NULL }
};

void
VCL_Init(void)
{

        assert(cache_param->workspace_client > 0);
        WS_Init(&ws_cli, "cli", malloc(cache_param->workspace_client),
            cache_param->workspace_client);
        ws_snapshot_cli = WS_Snapshot(&ws_cli);
        CLI_AddFuncs(vcl_cmds);
        Lck_New(&vcl_mtx, lck_vcl);
        VSL_Setup(&vsl_cli, NULL, 0);
}

void
VCL_Shutdown(void)
{
        struct vcl *vcl;
        unsigned c = 0;

        while (1) {
                Lck_Lock(&vcl_mtx);
                VTAILQ_FOREACH(vcl, &vcl_head, list)
                        if (vcl->busy)
                                break;
                Lck_Unlock(&vcl_mtx);
                if (vcl == NULL)
                        return;
                if (++c % 10 == 0) {
                        fprintf(stderr, "shutdown waiting for %u reference%s "
                            "on %s\n", vcl->busy, vcl->busy > 1 ? "s" : "",
                            vcl->loaded_name);
                }
                usleep(100 * 1000);
        }
}

		varnish-cache/bin/varnishd/cache/cache_vcl.c
0		/*-
1		* Copyright (c) 2006 Verdens Gang AS
2		* Copyright (c) 2006-2016 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		*/
31
32		#include "config.h"
33
34		#include <dlfcn.h>
35		#include <fnmatch.h>
36		#include <stdio.h>
37		#include <stdlib.h>
38
39		#include "cache_varnishd.h"
40		#include "common/heritage.h"
41
42		#include "vcl.h"
43
44		#include "cache_director.h"
45		#include "cache_vcl.h"
46		#include "vbm.h"
47		#include "vcli_serve.h"
48		#include "vte.h"
49		#include "vtim.h"
50		#include "vcc_interface.h"
51
52		const struct vcltemp VCL_TEMP_INIT[1] = {{ .name = "init", .is_cold = 1 }};
53		const struct vcltemp VCL_TEMP_COLD[1] = {{ .name = "cold", .is_cold = 1 }};
54		const struct vcltemp VCL_TEMP_WARM[1] = {{ .name = "warm", .is_warm = 1 }};
55		const struct vcltemp VCL_TEMP_BUSY[1] = {{ .name = "busy", .is_warm = 1 }};
56		const struct vcltemp VCL_TEMP_COOLING[1] = {{ .name = "cooling" }};
57
58		// not really a temperature
59		static const struct vcltemp VCL_TEMP_LABEL[1] = {{ .name = "label" }};
60
61		/*
62		* XXX: Presently all modifications to this list happen from the
63		* CLI event-engine, so no locking is necessary
64		*/
65		static VTAILQ_HEAD(, vcl) vcl_head =
66		VTAILQ_HEAD_INITIALIZER(vcl_head);
67
68		struct lock vcl_mtx;
69		struct vcl vcl_active; / protected by vcl_mtx */
70
71		static struct vrt_ctx ctx_cli;
72		static struct wrk_vpi wrk_vpi_cli;
73		static struct ws ws_cli;
74		static uintptr_t ws_snapshot_cli;
75		static struct vsl_log vsl_cli;
76
77		/--------------------------------------------------------------------/
78
79		void
80	558871	VCL_Bo2Ctx(struct vrt_ctx ctx, struct busyobj bo)
81		{
82
83	558871	CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
84	558871	CHECK_OBJ_NOTNULL(bo, BUSYOBJ_MAGIC);
85	558871	CHECK_OBJ_NOTNULL(bo->wrk, WORKER_MAGIC);
86	558871	ctx->vcl = bo->vcl;
87	558871	ctx->syntax = ctx->vcl->conf->syntax;
88	558871	ctx->vsl = bo->vsl;
89	558871	ctx->http_bereq = bo->bereq;
90	558871	ctx->http_beresp = bo->beresp;
91	558871	ctx->bo = bo;
92	558871	ctx->sp = bo->sp;
93	558871	ctx->now = bo->t_prev;
94	558871	ctx->ws = bo->ws;
95	558871	ctx->vpi = bo->wrk->vpi;
96	558871	ctx->vpi->handling = 0;
97	558871	ctx->vpi->trace = bo->trace;
98	558871	}
99
100		void
101	902069	VCL_Req2Ctx(struct vrt_ctx ctx, struct req req)
102		{
103
104	902069	CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
105	902069	CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
106	902069	CHECK_OBJ_NOTNULL(req->doclose, STREAM_CLOSE_MAGIC);
107
108	902069	ctx->vcl = req->vcl;
109	902069	ctx->syntax = ctx->vcl->conf->syntax;
110	902069	ctx->vsl = req->vsl;
111	902069	ctx->http_req = req->http;
112	902069	CHECK_OBJ_NOTNULL(req->top, REQTOP_MAGIC);
113	902069	ctx->http_req_top = req->top->topreq->http;
114	902069	ctx->http_resp = req->resp;
115	902069	ctx->req = req;
116	902069	ctx->sp = req->sp;
117	902069	ctx->now = req->t_prev;
118	902069	ctx->ws = req->ws;
119	902069	ctx->vpi = req->wrk->vpi;
120	902069	ctx->vpi->handling = 0;
121	902069	ctx->vpi->trace = req->trace;
122	902069	}
123
124		/--------------------------------------------------------------------/
125
126		struct vrt_ctx *
127	138184	VCL_Get_CliCtx(int msg)
128		{
129
130	138184	ASSERT_CLI();
131	138184	INIT_OBJ(&ctx_cli, VRT_CTX_MAGIC);
132	138184	INIT_OBJ(&wrk_vpi_cli, WRK_VPI_MAGIC);
133	138184	ctx_cli.vpi = &wrk_vpi_cli;
134	138184	wrk_vpi_cli.trace = FEATURE(FEATURE_TRACE);
135	138184	ctx_cli.now = VTIM_real();
136	138184	if (msg) {
137	87480	ctx_cli.msg = VSB_new_auto();
138	87480	AN(ctx_cli.msg);
139	87480	} else {
140	50704	ctx_cli.vsl = &vsl_cli;
141		}
142	138184	ctx_cli.ws = &ws_cli;
143	138184	WS_Assert(ctx_cli.ws);
144	138184	return (&ctx_cli);
145		}
146
147		/*
148		* releases CLI ctx
149		*
150		* returns finished error msg vsb if VCL_Get_CliCtx(1) was called
151		*
152		* caller needs to VSB_destroy a non-NULL return value
153		*
154		*/
155		struct vsb *
156	138148	VCL_Rel_CliCtx(struct vrt_ctx **ctx)
157		{
158	138148	struct vsb *r = NULL;
159
160	138148	ASSERT_CLI();
161	138148	assert(*ctx == &ctx_cli);
162	138148	AN((*ctx)->vpi);
163	138148	if (ctx_cli.msg) {
164	87480	TAKE_OBJ_NOTNULL(r, &ctx_cli.msg, VSB_MAGIC);
165	87480	AZ(VSB_finish(r));
166	87480	}
167	138148	if (ctx_cli.vsl)
168	50668	VSL_Flush(ctx_cli.vsl, 0);
169	138148	WS_Assert(ctx_cli.ws);
170	138148	WS_Rollback(&ws_cli, ws_snapshot_cli);
171	138148	INIT_OBJ(*ctx, VRT_CTX_MAGIC);
172	138148	*ctx = NULL;
173
174	138148	return (r);
175		}
176
177		/--------------------------------------------------------------------/
178
179		/* VRT_fail() can be called
180		* - from the vcl sub via a vmod
181		* - via a PRIV_TASK .fini callback
182		*
183		* if this happens during init, we fail it
184		* if during fini, we ignore, because otherwise VMOD authors would be forced to
185		* handle VCL_MET_FINI specifically everywhere.
186		*/
187
188		static int
189	91960	vcl_event_handling(VRT_CTX)
190		{
191	91960	CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
192
193	91960	if (ctx->vpi->handling == 0)
194	90412	return (0);
195
196	1548	assert(ctx->vpi->handling == VCL_RET_FAIL);
197
198	1548	if (ctx->method == VCL_MET_INIT)
199	1476	return (1);
200
201		/*
202		* EVENT_WARM / EVENT_COLD: method == 0
203		* must not set handling
204		*/
205	72	assert(ctx->method == VCL_MET_FINI);
206
207	72	ctx->vpi->handling = 0;
208	72	VRT_fail(ctx, "VRT_fail() from vcl_fini{} has no effect");
209	72	return (0);
210	91960	}
211
212		static int
213	91996	vcl_send_event(struct vcl vcl, enum vcl_event_e ev, struct vsb *msg)
214		{
215		int r, havemsg;
216	91996	unsigned method = 0;
217		struct vrt_ctx *ctx;
218	91996	void *vbm_alloc = NULL;
219		size_t sz;
220
221	91996	ASSERT_CLI();
222	91996	ASSERT_VCL_ACTIVE();
223
224	91996	CHECK_OBJ_NOTNULL(vcl, VCL_MAGIC);
225	91996	CHECK_OBJ_NOTNULL(vcl->conf, VCL_CONF_MAGIC);
226	91996	AN(msg);
227	91996	AZ(*msg);
228
229	91996	switch (ev) {
230		case VCL_EVENT_LOAD:
231	44460	method = VCL_MET_INIT;
232		/* FALLTHROUGH */
233		case VCL_EVENT_WARM:
234	87480	havemsg = 1;
235	87480	break;
236		case VCL_EVENT_DISCARD:
237	2799	method = VCL_MET_FINI;
238		/* FALLTHROUGH */
239		case VCL_EVENT_COLD:
240	4516	havemsg = 0;
241	4516	break;
242		default:
243	0	WRONG("vcl_event");
244	0	}
245
246	91996	ctx = VCL_Get_CliCtx(havemsg);
247
248	91996	AN(ctx->vpi);
249	91996	AZ(ctx->vpi->handling);
250	91996	AN(ctx->ws);
251
252	91996	ctx->vcl = vcl;
253	91996	ctx->syntax = ctx->vcl->conf->syntax;
254	91996	ctx->method = method;
255
256	91996	if (vcl->conf->nsub > 0) {
257	432	sz = VBITMAP_SZ(vcl->conf->nsub);
258	432	vbm_alloc = malloc(sz);
259	432	AN(vbm_alloc);
260	432	ctx->called = vbit_init(vbm_alloc, sz);
261	432	}
262
263	91996	VCL_TaskEnter(cli_task_privs);
264	91996	r = ctx->vcl->conf->event_vcl(ctx, ev);
265	91996	VCL_TaskLeave(ctx, cli_task_privs);
266	91996	r \|= vcl_event_handling(ctx);
267
268	91996	*msg = VCL_Rel_CliCtx(&ctx);
269
270	91996	if (r && (ev == VCL_EVENT_COLD \|\| ev == VCL_EVENT_DISCARD))
271	0	WRONG("A VMOD cannot fail COLD or DISCARD events");
272
273	91996	free(vbm_alloc);
274
275	91996	return (r);
276		}
277
278		/--------------------------------------------------------------------/
279
280		struct vcl *
281	92340	vcl_find(const char *name)
282		{
283		struct vcl *vcl;
284
285	92340	ASSERT_CLI();
286	140036	VTAILQ_FOREACH(vcl, &vcl_head, list) {
287	94640	if (vcl->discard)
288	32	continue;
289	94608	if (!strcmp(vcl->loaded_name, name))
290	46944	return (vcl);
291	47664	}
292	45396	return (NULL);
293	92340	}
294
295		/--------------------------------------------------------------------/
296
297		static void
298	252	vcl_panic_conf(struct vsb vsb, const struct VCL_conf conf)
299		{
300		unsigned u;
301		const struct vpi_ii *ii;
302
303	252	if (PAN_dump_struct(vsb, conf, VCL_CONF_MAGIC, "conf"))
304	0	return;
305	252	VSB_printf(vsb, "syntax = \"%u\",\n", conf->syntax);
306	252	VSB_cat(vsb, "srcname = {\n");
307	252	VSB_indent(vsb, 2);
308	756	for (u = 0; u < conf->nsrc; ++u)
309	504	VSB_printf(vsb, "[%u] = \"%s\",\n", u, conf->srcname[u]);
310	252	VSB_indent(vsb, -2);
311	252	VSB_cat(vsb, "},\n");
312	252	VSB_cat(vsb, "instances = {\n");
313	252	VSB_indent(vsb, 2);
314	252	ii = conf->instance_info;
315	396	while (ii != NULL && ii->p != NULL) {
316	288	VSB_printf(vsb, "\"%s\" = %p,\n", ii->name,
317	144	(const void )(const uintptr_t *)ii->p);
318	144	ii++;
319		}
320	252	VSB_indent(vsb, -2);
321	252	VSB_cat(vsb, "},\n");
322	252	VSB_indent(vsb, -2);
323	252	VSB_cat(vsb, "},\n");
324	252	}
325
326		void
327	468	VCL_Panic(struct vsb vsb, const char nm, const struct vcl *vcl)
328		{
329
330	468	AN(vsb);
331	468	if (PAN_dump_struct(vsb, vcl, VCL_MAGIC, "vcl[%s]", nm))
332	216	return;
333	252	VSB_printf(vsb, "name = \"%s\",\n", vcl->loaded_name);
334	252	VSB_printf(vsb, "busy = %u,\n", vcl->busy);
335	252	VSB_printf(vsb, "discard = %u,\n", vcl->discard);
336	252	VSB_printf(vsb, "state = %s,\n", vcl->state);
337	252	VSB_printf(vsb, "temp = %s,\n", vcl->temp ? vcl->temp->name : "(null)");
338	252	vcl_panic_conf(vsb, vcl->conf);
339	252	VSB_indent(vsb, -2);
340	252	VSB_cat(vsb, "},\n");
341	468	}
342
343		/--------------------------------------------------------------------/
344
345		void
346	52282	VCL_Update(struct vcl *vcc, struct vcl vcl)
347		{
348		struct vcl *old;
349
350	52282	AN(vcc);
351
352	52282	old = *vcc;
353	52282	*vcc = NULL;
354
355	52282	CHECK_OBJ_ORNULL(old, VCL_MAGIC);
356	52282	ASSERT_VCL_ACTIVE();
357
358	52282	Lck_Lock(&vcl_mtx);
359	52282	if (old != NULL) {
360	2745	assert(old->busy > 0);
361	2745	old->busy--;
362	2745	}
363
364	52282	if (vcl == NULL)
365	51814	vcl = vcl_active; /* Sample vcl_active under lock to avoid
366		* race */
367	52282	CHECK_OBJ_NOTNULL(vcl, VCL_MAGIC);
368	52282	if (vcl->label == NULL) {
369	51706	AN(strcmp(vcl->state, VCL_TEMP_LABEL->name));
370	51706	*vcc = vcl;
371	51706	} else {
372	576	AZ(strcmp(vcl->state, VCL_TEMP_LABEL->name));
373	576	*vcc = vcl->label;
374		}
375	52282	CHECK_OBJ_NOTNULL(*vcc, VCL_MAGIC);
376	52282	AZ((*vcc)->discard);
377	52282	(*vcc)->busy++;
378	52282	Lck_Unlock(&vcl_mtx);
379	52282	assert((*vcc)->temp->is_warm);
380	52282	}
381
382		/*--------------------------------------------------------------------
383		* vdire: Vcl DIrector REsignation Management (born out of a dire situation)
384		* iterators over the director list need to register.
385		* while iterating, directors can not retire immediately,
386		* they get put on a list of resigning directors. The
387		* last iterator executes the retirement.
388		*/
389
390		static struct vdire *
391	89064	vdire_new(struct lock mtx, const struct vcltemp *tempp)
392		{
393		struct vdire *vdire;
394
395	89064	ALLOC_OBJ(vdire, VDIRE_MAGIC);
396	89064	AN(vdire);
397	89064	AN(mtx);
398	89064	VTAILQ_INIT(&vdire->directors);
399	89064	VTAILQ_INIT(&vdire->resigning);
400	89064	vdire->mtx = mtx;
401	89064	PTOK(pthread_cond_init(&vdire->cond, NULL));
402	89064	vdire->tempp = tempp;
403	89064	return (vdire);
404		}
405
406		/* starting an interation prevents removals from the directors list */
407		void
408	37719	vdire_start_iter(struct vdire *vdire)
409		{
410
411	37719	CHECK_OBJ_NOTNULL(vdire, VDIRE_MAGIC);
412
413		// https://github.com/varnishcache/varnish-cache/pull/4142#issuecomment-2593091097
414	37719	ASSERT_CLI();
415
416	37719	Lck_Lock(vdire->mtx);
417	37719	while (! VTAILQ_EMPTY(&vdire->resigning))
418	0	(void)Lck_CondWait(&vdire->cond, vdire->mtx);
419	37719	vdire->iterating++;
420	37719	Lck_Unlock(vdire->mtx);
421	37719	}
422
423		void
424	82348	vdire_end_iter(struct vdire *vdire)
425		{
426	82348	struct vcldir_head resigning = VTAILQ_HEAD_INITIALIZER(resigning);
427	82348	const struct vcltemp *temp = NULL;
428		struct vcldir vdir, next;
429		unsigned n;
430
431	82348	CHECK_OBJ_NOTNULL(vdire, VDIRE_MAGIC);
432
433	82348	Lck_Lock(vdire->mtx);
434	82348	AN(vdire->iterating);
435	82348	n = --vdire->iterating;
436
437	82348	if (n == 0) {
438	82348	VTAILQ_SWAP(&vdire->resigning, &resigning, vcldir, resigning_list);
439	82348	VTAILQ_FOREACH(vdir, &resigning, resigning_list)
440	0	VTAILQ_REMOVE(&vdire->directors, vdir, directors_list);
441	82348	temp = *vdire->tempp;
442	82348	PTOK(pthread_cond_broadcast(&vdire->cond));
443	82348	}
444	82348	Lck_Unlock(vdire->mtx);
445
446	82348	VTAILQ_FOREACH_SAFE(vdir, &resigning, resigning_list, next)
447	0	vcldir_retire(vdir, temp);
448	82348	}
449
450		/*
451		* like vdire_start_iter, but also prepare for backend_event_*()
452		* by setting the checkpoint
453		*/
454		static void
455	44629	vdire_start_event(struct vdire vdire, const struct vcltemp temp)
456		{
457
458	44629	CHECK_OBJ_NOTNULL(vdire, VDIRE_MAGIC);
459	44629	AN(temp);
460
461	44629	Lck_AssertHeld(vdire->mtx);
462
463		// https://github.com/varnishcache/varnish-cache/pull/4142#issuecomment-2593091097
464	44629	ASSERT_CLI();
465
466	44629	AZ(vdire->checkpoint);
467	44629	vdire->checkpoint = VTAILQ_LAST(&vdire->directors, vcldir_head);
468	44629	AN(vdire->tempp);
469	44629	*vdire->tempp = temp;
470	44629	vdire->iterating++;
471	44629	}
472
473		static void
474	44629	vdire_end_event(struct vdire *vdire)
475		{
476	44629	vdire->checkpoint = NULL;
477	44629	vdire_end_iter(vdire);
478	44629	}
479
480		// if there are no iterators, remove from directors and retire
481		// otherwise put on resigning list to work when iterators end
482		void
483	3913	vdire_resign(struct vdire vdire, struct vcldir vdir)
484		{
485	3913	const struct vcltemp *temp = NULL;
486
487	3913	CHECK_OBJ_NOTNULL(vdire, VDIRE_MAGIC);
488	3913	AN(vdir);
489
490	3913	Lck_Lock(vdire->mtx);
491	3913	if (vdire->iterating != 0) {
492	0	VTAILQ_INSERT_TAIL(&vdire->resigning, vdir, resigning_list);
493	0	vdir = NULL;
494	0	} else {
495	3913	VTAILQ_REMOVE(&vdire->directors, vdir, directors_list);
496	3913	temp = *vdire->tempp;
497		}
498	3913	Lck_Unlock(vdire->mtx);
499