GCOV - Varnish Cache


/*-
 * Copyright 2009-2018 UPLEX - Nils Goroll Systemoptimierung
 * All rights reserved.
 *
 * Authors: Julian Wiesener <jw@uplex.de>
 *          Nils Goroll <slink@uplex.de>
 *
 * 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 <stdlib.h>
#include <string.h>

#include "cache/cache.h"
#include "vcl.h"

#include "vend.h"

#include "vcc_directors_if.h"
#include "vmod_directors_shard_dir.h"
#include "vmod_directors_shard_cfg.h"
#include "vsb.h"

/* -------------------------------------------------------------------------
 *  shard director: LAZY mode (vdi resolve function), parameter objects
 *
 *  By associating a parameter object with a shard director, we enable LAZY
 *  lookups as with the other directors. Parameter objects are defined with VCL
 *  scope (normal vmod objects), but can be overridden per backend request using
 *  a task priv.
 *
 *  We use the same concept to carry shard.backend() parameters to vdi resolve
 *  for LAZY mode: They get saved in a per-director task scope parameter object.
 *
 *  Each object points to another object providing defaults for values which are
 *  not defined.
 *
 *  Actual resolution of the various parameter objects does not happen before
 *  they are used, which enables changing them independently (ie, shard
 *  .backend() parameters have precedence over an associated parameter object,
 *  which by itself can be overridden).
 *
 *  Overview of parameter objects (pointers are alternatives)
 *
 *  shard() director        shard_param() object    default param
 *
 *               --------------------------------->   vmod static
 *    VCL obj   /                                ->
 *    .param  -+--------->    VCL obj           /  _
 *                            .default  --------   /|
 *                                                /
 *                               ^               /
 *                               |              /
 *                                             /
 *                            .default        /
 *          ------------->    TASK priv      /
 *         /                                /
 *    .default -----------------------------
 *    TASK priv
 */

/* -------------------------------------------------------------------------
 * method arguments and set parameters bitmask in vmod_directors_shard_param
 */

#define arg_by          ((uint32_t)1)
#define arg_key         ((uint32_t)1 << 1)
#define arg_key_blob    ((uint32_t)1 << 2)
#define arg_alt         ((uint32_t)1 << 3)
#define arg_warmup      ((uint32_t)1 << 4)
#define arg_rampup      ((uint32_t)1 << 5)
#define arg_healthy     ((uint32_t)1 << 6)
#define arg_param       ((uint32_t)1 << 7)
#define arg_resolve     ((uint32_t)1 << 8)
#define arg_mask_       ((arg_resolve << 1) - 1)
/* allowed in shard_param.set */
#define arg_mask_set_   (arg_param - 1)
/* allowed in shard_param */
#define arg_mask_param_ ( arg_mask_set_         \
                          & ~arg_key                    \
                          & ~arg_key_blob )

/* -------------------------------------------------------------------------
 * shard parameters - declaration & defaults
 */
enum vmod_directors_shard_param_scope {
        _SCOPE_INVALID = 0,
        SCOPE_VMOD,
        SCOPE_VCL,
        SCOPE_TASK,
        SCOPE_STACK
};

struct vmod_directors_shard_param;

#define VMOD_SHARD_SHARD_PARAM_BLOB             0xdf5ca116

struct vmod_directors_shard_param {
        unsigned                                magic;
#define VMOD_SHARD_SHARD_PARAM_MAGIC            0xdf5ca117

        /* internals */
        uint32_t                                key;
        const char                              *vcl_name;
        const struct vmod_directors_shard_param *defaults;
        enum vmod_directors_shard_param_scope   scope;

        /* parameters */
        VCL_ENUM                                by;
        VCL_ENUM                                healthy;
        uint32_t                                mask;
        VCL_BOOL                                rampup;
        VCL_INT                                 alt;
        VCL_REAL                                warmup;
};

static const struct vmod_directors_shard_param shard_param_default = {
        .magic          = VMOD_SHARD_SHARD_PARAM_MAGIC,

        .key            = 0,
        .vcl_name       = "builtin defaults",
        .defaults       = NULL,
        .scope          = SCOPE_VMOD,

        .mask           = arg_mask_param_,
        .rampup = 1,
        .alt            = 0,
        .warmup         = -1,
};

#define default_by(ptr) (ptr == NULL ? VENUM(HASH) : ptr)
#define default_healthy(ptr) (ptr == NULL ? VENUM(CHOSEN) : ptr)

static struct vmod_directors_shard_param *
shard_param_stack(struct vmod_directors_shard_param *p,
    const struct vmod_directors_shard_param *pa, const char *who);

static const struct vmod_directors_shard_param *
shard_param_task_r(VRT_CTX, const void *id, const char *who,
    const struct vmod_directors_shard_param *pa);

static struct vmod_directors_shard_param *
shard_param_task_l(VRT_CTX, const void *id, const char *who,
    const struct vmod_directors_shard_param *pa);

static const struct vmod_directors_shard_param *
shard_param_blob(VCL_BLOB blob);

static const struct vmod_directors_shard_param *
vmod_shard_param_read(VRT_CTX, const void *id, const char *who,
    const struct vmod_directors_shard_param *p,
    struct vmod_directors_shard_param *pstk);

// XXX #3329 #3330 revisit - for now, treat pipe like backend
#define SHARD_VCL_TASK_REQ (VCL_MET_TASK_C & ~VCL_MET_PIPE)
#define SHARD_VCL_TASK_BEREQ (VCL_MET_TASK_B | VCL_MET_PIPE)
/* -------------------------------------------------------------------------
 * shard vmod interface
 */
static vdi_healthy_f vmod_shard_healthy;
static vdi_resolve_f vmod_shard_resolve;
static vdi_list_f vmod_shard_list;

struct vmod_directors_shard {
        unsigned                                magic;
#define VMOD_SHARD_SHARD_MAGIC                  0x6e63e1bf
        struct sharddir                         *shardd;
        VCL_BACKEND                             dir;
};

static void
shard__assert(void)
{
        VCL_INT t1;
        uint32_t t2a, t2b;

        /* we put our uint32 key in a VCL_INT container */
        assert(sizeof(VCL_INT) >= sizeof(uint32_t));
        t2a = UINT32_MAX;
        t1 = (VCL_INT)t2a;
        t2b = (uint32_t)t1;
        assert(t2a == t2b);
}

static void v_matchproto_(vdi_release_f)
vmod_shard_release(VCL_BACKEND dir)
{
        struct sharddir *shardd;

        CAST_OBJ_NOTNULL(shardd, dir->priv, SHARDDIR_MAGIC);
        sharddir_release(shardd);
}

static void v_matchproto_(vdi_destroy_f)
vmod_shard_destroy(VCL_BACKEND dir)
{
        struct sharddir *shardd;

        CAST_OBJ_NOTNULL(shardd, dir->priv, SHARDDIR_MAGIC);
        sharddir_delete(&shardd);
}

static const struct vdi_methods vmod_shard_methods[1] = {{
        .magic =        VDI_METHODS_MAGIC,
        .type =         "shard",
        .resolve =      vmod_shard_resolve,
        .healthy =      vmod_shard_healthy,
        .release =      vmod_shard_release,
        .destroy =      vmod_shard_destroy,
        .list =         vmod_shard_list
}};


VCL_VOID v_matchproto_(td_directors_shard__init)
vmod_shard__init(VRT_CTX, struct vmod_directors_shard **vshardp,
    const char *vcl_name)
{
        struct vmod_directors_shard *vshard;

        shard__assert();

        AN(vshardp);
        AZ(*vshardp);
        ALLOC_OBJ(vshard, VMOD_SHARD_SHARD_MAGIC);
        AN(vshard);

        *vshardp = vshard;
        sharddir_new(&vshard->shardd, vcl_name, &shard_param_default);

        vshard->dir = VRT_AddDirector(ctx, vmod_shard_methods, vshard->shardd,
            "%s", vcl_name);
}

VCL_VOID v_matchproto_(td_directors_shard__fini)
vmod_shard__fini(struct vmod_directors_shard **vshardp)
{
        struct vmod_directors_shard *vshard;

        TAKE_OBJ_NOTNULL(vshard, vshardp, VMOD_SHARD_SHARD_MAGIC);
        VRT_DelDirector(&vshard->dir);
        FREE_OBJ(vshard);
}

VCL_INT v_matchproto_(td_directors_shard_key)
vmod_shard_key(VRT_CTX, struct vmod_directors_shard *vshard, VCL_STRANDS s)
{

        (void)ctx;
        (void)vshard;

        return ((VCL_INT)VRT_HashStrands32(s));
}

VCL_VOID v_matchproto_(td_directors_set_warmup)
vmod_shard_set_warmup(VRT_CTX, struct vmod_directors_shard *vshard,
    VCL_REAL probability)
{
        CHECK_OBJ_NOTNULL(vshard, VMOD_SHARD_SHARD_MAGIC);
        if (probability < 0 || probability >= 1) {
                shard_notice(ctx->vsl, vshard->shardd->name,
                    ".set_warmup(%f) ignored", probability);
                return;
        }
        shardcfg_set_warmup(vshard->shardd, probability);
}

VCL_VOID v_matchproto_(td_directors_set_rampup)
vmod_shard_set_rampup(VRT_CTX, struct vmod_directors_shard *vshard,
    VCL_DURATION duration)
{
        (void)ctx;
        CHECK_OBJ_NOTNULL(vshard, VMOD_SHARD_SHARD_MAGIC);
        shardcfg_set_rampup(vshard->shardd, duration);
}

VCL_VOID v_matchproto_(td_directors_shard_associate)
vmod_shard_associate(VRT_CTX,
    struct vmod_directors_shard *vshard, VCL_BLOB b)
{
        const struct vmod_directors_shard_param *ppt;
        CHECK_OBJ_NOTNULL(vshard, VMOD_SHARD_SHARD_MAGIC);

        if (b == NULL) {
                sharddir_set_param(vshard->shardd, &shard_param_default);
                return;
        }

        ppt = shard_param_blob(b);

        if (ppt == NULL) {
                shard_fail(ctx, vshard->shardd->name, "%s",
                    "shard .associate param invalid");
                return;
        }

        sharddir_set_param(vshard->shardd, ppt);
}

VCL_BOOL v_matchproto_(td_directors_shard_add_backend)
vmod_shard_add_backend(VRT_CTX, struct vmod_directors_shard *vshard,
    struct VARGS(shard_add_backend) *args)
{
        VCL_REAL weight = 1;

        CHECK_OBJ_NOTNULL(vshard, VMOD_SHARD_SHARD_MAGIC);

        if (args->backend == NULL) {
                shard_fail(ctx, vshard->shardd->name, "%s",
                    "None backend cannot be added");
                return (0);
        }

        if (args->valid_weight) {
                if (args->weight >= 1)
                        weight = args->weight;
                else
                        shard_notice(ctx->vsl, vshard->shardd->name,
                            ".add_backend(weight=%f) ignored", args->weight);
        }

        return (shardcfg_add_backend(ctx, vshard->shardd, args->backend,
            args->valid_ident ? args->ident : NULL,
            args->valid_rampup ? args->rampup : nan(""),
            weight));
}

VCL_BOOL v_matchproto_(td_directors_shard_remove_backend)
vmod_shard_remove_backend(VRT_CTX, struct vmod_directors_shard *vshard,
    struct VARGS(shard_remove_backend) *args)
{
        VCL_BACKEND be = args->valid_backend ? args->backend : NULL;
        VCL_STRING ident = args->valid_ident ? args->ident : NULL;

        CHECK_OBJ_NOTNULL(vshard, VMOD_SHARD_SHARD_MAGIC);

        if (be == NULL && ident == NULL) {
                shard_fail(ctx, vshard->shardd->name, "%s",
                    ".remove_backend(): either backend or ident are required");
                return (0);
        }

        return (shardcfg_remove_backend(ctx, vshard->shardd, be, ident));
}

VCL_BOOL v_matchproto_(td_directors_shard_clear)
vmod_shard_clear(VRT_CTX, struct vmod_directors_shard *vshard)
{
        CHECK_OBJ_NOTNULL(vshard, VMOD_SHARD_SHARD_MAGIC);
        return (shardcfg_clear(ctx, vshard->shardd));
}

VCL_BOOL v_matchproto_(td_directors_shard_reconfigure)
vmod_shard_reconfigure(VRT_CTX, struct vmod_directors_shard *vshard,
    VCL_INT replicas)
{
        return (shardcfg_reconfigure(ctx, vshard->shardd, replicas));
}

static inline uint32_t
shard_get_key(VRT_CTX, const struct vmod_directors_shard_param *p)
{
        struct http *http;
        VCL_ENUM by = default_by(p->by);

        if (by == VENUM(KEY) || by == VENUM(BLOB))
                return (p->key);
        if (by == VENUM(HASH) && ctx->bo != NULL) {
                CHECK_OBJ(ctx->bo, BUSYOBJ_MAGIC);
                return (vbe32dec(ctx->bo->digest));
        }
        if (by == VENUM(HASH) || by == VENUM(URL)) {
                if (ctx->http_req) {
                        AN(http = ctx->http_req);
                } else {
                        AN(ctx->http_bereq);
                        AN(http = ctx->http_bereq);
                }
                return (VRT_HashStrands32(TOSTRAND(http->hd[HTTP_HDR_URL].b)));
        }
        WRONG("by enum");
}

/*
 * merge parameters to resolve all undef values
 * key is to be calculated after merging
 */
static void
shard_param_merge(struct vmod_directors_shard_param *to,
                  const struct vmod_directors_shard_param *from)
{
        CHECK_OBJ_NOTNULL(to, VMOD_SHARD_SHARD_PARAM_MAGIC);
        assert((to->mask & ~arg_mask_param_) == 0);

        if (to->mask == arg_mask_param_)
                return;

        CHECK_OBJ_NOTNULL(from, VMOD_SHARD_SHARD_PARAM_MAGIC);
        assert((from->mask & ~arg_mask_param_) == 0);

        if ((to->mask & arg_by) == 0 && (from->mask & arg_by) != 0) {
                to->by = from->by;
                if (from->by == VENUM(KEY) || from->by == VENUM(BLOB))
                        to->key = from->key;
        }

#define mrg(to, from, field) do {                                       \
                if (((to)->mask & arg_ ## field) == 0 &&                \
                    ((from)->mask & arg_ ## field) != 0)                \
                        (to)->field = (from)->field;                    \
        } while(0)

        mrg(to, from, healthy);
        mrg(to, from, rampup);
        mrg(to, from, alt);
        mrg(to, from, warmup);
#undef mrg

        to->mask |= from->mask;

        if (to->mask == arg_mask_param_)
                return;

        AN(from->defaults);
        shard_param_merge(to, from->defaults);
}

static uint32_t
shard_blob_key(VCL_BLOB key_blob)
{
        uint8_t k[4] = { 0 };
        const uint8_t *b;
        size_t i, ki;

        AN(key_blob);
        AN(key_blob->blob);
        assert(key_blob->len > 0);

        if (key_blob->len >= 4)
                ki = 0;
        else
                ki = 4 - key_blob->len;

        b = key_blob->blob;
        for (i = 0; ki < 4; i++, ki++)
                k[ki] = b[i];
        assert(i <= key_blob->len);

        return (vbe32dec(k));
}

/*
 * convert vmod interface valid_* to our bitmask
 */

#define tobit(args, name) ((args)->valid_##name ? arg_##name : 0)

static uint32_t
shard_backendarg_mask_(const struct VARGS(shard_backend) * const a)
{
        return (tobit(a, by)            |
                tobit(a, key)           |
                tobit(a, key_blob)      |
                tobit(a, alt)           |
                tobit(a, warmup)        |
                tobit(a, rampup)        |
                tobit(a, healthy)       |
                tobit(a, param)         |
                tobit(a, resolve));
}
static uint32_t
shard_param_set_mask(const struct VARGS(shard_param_set) * const a)
{
        return (tobit(a, by)            |
                tobit(a, key)           |
                tobit(a, key_blob)      |
                tobit(a, alt)           |
                tobit(a, warmup)        |
                tobit(a, rampup)        |
                tobit(a, healthy));
}
#undef tobit

/*
 * check arguments and return in a struct param
 */
static struct vmod_directors_shard_param *
shard_param_args(VRT_CTX,
    struct vmod_directors_shard_param *p, const char *func,
    uint32_t args, VCL_ENUM by_s, VCL_INT key_int, VCL_BLOB key_blob,
    VCL_INT alt, VCL_REAL warmup, VCL_BOOL rampup, VCL_ENUM healthy_s)
{

        CHECK_OBJ_NOTNULL(p, VMOD_SHARD_SHARD_PARAM_MAGIC);
        AN(p->vcl_name);

        assert((args & ~arg_mask_set_) == 0);

        if (!(args & arg_by))
                by_s = NULL;
        by_s = default_by(by_s);

        /* by_s / key_int / key_blob */
        if (by_s == VENUM(KEY)) {
                if ((args & arg_key) == 0) {
                        shard_fail(ctx, p->vcl_name,
                            "%s missing key argument with by=%s",
                            func, by_s);
                        return (NULL);
                }
                if (key_int < 0 || key_int > UINT32_MAX) {
                        shard_fail(ctx, p->vcl_name,
                            "%s invalid key argument %jd with by=%s",
                            func, (intmax_t)key_int, by_s);
                        return (NULL);
                }
                assert(key_int >= 0);
                assert(key_int <= UINT32_MAX);
                p->key = (uint32_t)key_int;
        } else if (by_s == VENUM(BLOB)) {
                if ((args & arg_key_blob) == 0) {
                        shard_fail(ctx, p->vcl_name,
                            "%s missing key_blob argument with by=%s",
                            func, by_s);
                        return (NULL);
                }
                if (key_blob == NULL || key_blob->len == 0 ||
                    key_blob->blob == NULL) {
                        shard_err(ctx->vsl, p->vcl_name,
                            "%s by=BLOB but no or empty key_blob - using key 0",
                            func);
                        p->key = 0;
                } else
                        p->key = shard_blob_key(key_blob);
        } else if (by_s == VENUM(HASH) || by_s == VENUM(URL)) {
                if (args & (arg_key|arg_key_blob)) {
                        shard_fail(ctx, p->vcl_name,
                            "%s key and key_blob arguments are "
                            "invalid with by=%s", func, by_s);
                        return (NULL);
                }
        } else {
                WRONG("by enum");
        }
        p->by = by_s;

        if (args & arg_alt) {
                if (alt < 0) {
                        shard_fail(ctx, p->vcl_name,
                            "%s invalid alt argument %jd",
                            func, (intmax_t)alt);
                        return (NULL);
                }
                p->alt = alt;
        }

        if (args & arg_warmup) {
                if ((warmup < 0 && warmup != -1) || warmup > 1) {
                        shard_fail(ctx, p->vcl_name,
                            "%s invalid warmup argument %f",
                            func, warmup);
                        return (NULL);
                }
                p->warmup = warmup;
        }

        if (args & arg_rampup)
                p->rampup = !!rampup;

        if (args & arg_healthy)
                p->healthy = healthy_s;

        p->mask = args & arg_mask_param_;
        return (p);
}

VCL_BACKEND v_matchproto_(td_directors_shard_backend)
vmod_shard_backend(VRT_CTX, struct vmod_directors_shard *vshard,
                   struct VARGS(shard_backend) *a)
{
        struct sharddir *shardd;
        struct vmod_directors_shard_param pstk;
        struct vmod_directors_shard_param *pp = NULL;
        const struct vmod_directors_shard_param *ppt;
        VCL_ENUM resolve;
        uint32_t args = shard_backendarg_mask_(a);

        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
        CHECK_OBJ_NOTNULL(vshard, VMOD_SHARD_SHARD_MAGIC);
        shardd = vshard->shardd;
        CHECK_OBJ_NOTNULL(shardd, SHARDDIR_MAGIC);
        assert((args & ~arg_mask_) == 0);

        if (args & arg_resolve)
                resolve = a->resolve;
        else if (ctx->method & VCL_MET_TASK_H)
                resolve = VENUM(LAZY);
        else
                resolve = VENUM(NOW);

        if (resolve == VENUM(LAZY)) {
                if ((args & ~arg_resolve) == 0) {
                        AN(vshard->dir);
                        return (vshard->dir);
                }

                if ((ctx->method & SHARD_VCL_TASK_BEREQ) == 0) {
                        shard_fail(ctx, shardd->name, "%s",
                            ".backend(resolve=LAZY) with other "
                            "parameters can only be used in backend/pipe "
                            "context");
                        return (NULL);
                }

                pp = shard_param_task_l(ctx, shardd, shardd->name,
                    shardd->param);
                if (pp == NULL)
                        return (NULL);
        } else if (resolve == VENUM(NOW)) {
                if (ctx->method & VCL_MET_TASK_H) {
                        shard_fail(ctx, shardd->name, "%s",
                            ".backend(resolve=NOW) cannot be "
                            "used in vcl_init{}/vcl_fini{}");
                        return (NULL);
                }
                ppt = shard_param_task_r(ctx, shardd, shardd->name,
                    shardd->param);
                AN(ppt);
                pp = shard_param_stack(&pstk, ppt, shardd->name);
        } else {
                WRONG("resolve enum");
        }

        AN(pp);

        if (args & arg_param) {
                ppt = shard_param_blob(a->param);
                if (ppt == NULL) {
                        shard_fail(ctx, shardd->name, "%s",
                            ".backend(key_blob) param invalid");
                        return (NULL);
                }
                pp->defaults = ppt;
        }

        pp = shard_param_args(ctx, pp, "shard.backend()",
                              args & arg_mask_set_,
                              a->by, a->key, a->key_blob, a->alt, a->warmup,
                              a->rampup, a->healthy);
        if (pp == NULL)
                return (NULL);

        if (resolve == VENUM(LAZY))
                return (vshard->dir);

        assert(resolve == VENUM(NOW));
        shard_param_merge(pp, pp->defaults);
        return (sharddir_pick_be(ctx, shardd, shard_get_key(ctx, pp),
            pp->alt, pp->warmup, pp->rampup, pp->healthy));
}

static VCL_BOOL v_matchproto_(vdi_healthy)
vmod_shard_healthy(VRT_CTX, VCL_BACKEND dir, VCL_TIME *changed)
{
        struct sharddir *shardd;

        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
        CHECK_OBJ_NOTNULL(dir, DIRECTOR_MAGIC);
        CAST_OBJ_NOTNULL(shardd, dir->priv, SHARDDIR_MAGIC);
        return (sharddir_any_healthy(ctx, shardd, changed));
}

static VCL_BACKEND v_matchproto_(vdi_resolve_f)
vmod_shard_resolve(VRT_CTX, VCL_BACKEND dir)
{
        struct sharddir *shardd;
        struct vmod_directors_shard_param pstk[1];
        const struct vmod_directors_shard_param *pp;

        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
        CHECK_OBJ_NOTNULL(dir, DIRECTOR_MAGIC);
        CAST_OBJ_NOTNULL(shardd, dir->priv, SHARDDIR_MAGIC);

        pp = vmod_shard_param_read(ctx, shardd, shardd->name,
            shardd->param, pstk);
        CHECK_OBJ_NOTNULL(pp, VMOD_SHARD_SHARD_PARAM_MAGIC);

        return (sharddir_pick_be(ctx, shardd,
                                 shard_get_key(ctx, pp), pp->alt, pp->warmup,
                                 pp->rampup, pp->healthy));
}

static void v_matchproto_(vdi_list_f)
vmod_shard_list(VRT_CTX, VCL_BACKEND dir, struct vsb *vsb, int pflag, int jflag)
{
        struct sharddir *shardd;
        struct shard_backend *sbe;
        VCL_TIME c, changed = 0;
        VCL_DURATION rampup_d, d;
        VCL_BACKEND be;
        VCL_BOOL h;
        unsigned i, nh = 0;
        double rampup_p;

        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
        CHECK_OBJ_NOTNULL(dir, DIRECTOR_MAGIC);
        CAST_OBJ_NOTNULL(shardd, dir->priv, SHARDDIR_MAGIC);

        if (pflag) {
                if (jflag) {
                        VSB_cat(vsb, "{\n");
                        VSB_indent(vsb, 2);
                        VSB_printf(vsb, "\"warmup\": %f,\n", shardd->warmup);
                        VSB_printf(vsb, "\"rampup_duration\": %f,\n",
                            shardd->rampup_duration);
                        VSB_cat(vsb, "\"backends\": {\n");
                        VSB_indent(vsb, 2);
                } else {
                        VSB_cat(vsb, "\n\n\tBackend\tIdent\tHealth\t"
                            "Rampup  Remaining\n");
                }
        }

        sharddir_rdlock(shardd);
        for (i = 0; i < shardd->n_backend; i++) {
                sbe = &shardd->backend[i];
                AN(sbe);
                be = sbe->backend;
                CHECK_OBJ_NOTNULL(be, DIRECTOR_MAGIC);

                c = 0;
                h = VRT_Healthy(ctx, be, &c);
                if (h)
                        nh++;
                if (c > changed)
                        changed = c;
                if ((pflag) == 0)
                        continue;

                d = ctx->now - c;
                rampup_d = shardcfg_get_rampup(shardd, i);
                if (! h) {
                        rampup_p = 0.0;
                        rampup_d = 0.0;
                } else if (d < rampup_d) {
                        rampup_p = d / rampup_d;
                        rampup_d -= d;
                } else {
                        rampup_p = 1.0;
                        rampup_d = 0.0;
                }

                if (jflag) {
                        if (i)
                                VSB_cat(vsb, ",\n");
                        VSB_printf(vsb, "\"%s\": {\n",
                            be->vcl_name);
                        VSB_indent(vsb, 2);
                        VSB_printf(vsb, "\"ident\": \"%s\",\n",
                            sbe->ident ? sbe->ident : be->vcl_name);
                        VSB_printf(vsb, "\"health\": \"%s\",\n",
                            h ? "healthy" : "sick");
                        VSB_printf(vsb, "\"rampup\": %f,\n", rampup_p);
                        VSB_printf(vsb, "\"rampup_remaining\": %.3f\n",
                            rampup_d);
                        VSB_indent(vsb, -2);
                        VSB_cat(vsb, "}");
                } else {
                        VSB_printf(vsb, "\t%s\t%s\t%s\t%6.2f%% %8.3fs\n",
                            be->vcl_name,
                            sbe->ident ? sbe->ident : be->vcl_name,
                            h ? "healthy" : "sick",
                            rampup_p * 100, rampup_d);
                }
        }
        sharddir_unlock(shardd);

        if (jflag && (pflag)) {
                VSB_cat(vsb, "\n");
                VSB_indent(vsb, -2);
                VSB_cat(vsb, "}\n");
                VSB_indent(vsb, -2);
                VSB_cat(vsb, "},\n");
        }

        if (pflag)
                return;

        if (jflag)
                VSB_printf(vsb, "[%u, %u, \"%s\"]", nh, i,
                    nh ? "healthy" : "sick");
        else
                VSB_printf(vsb, "%u/%u\t%s", nh, i, nh ? "healthy" : "sick");
}

VCL_VOID v_matchproto_(td_directors_shard_backend)
vmod_shard_debug(VRT_CTX, struct vmod_directors_shard *vshard,
    VCL_INT i)
{
        CHECK_OBJ_NOTNULL(vshard, VMOD_SHARD_SHARD_MAGIC);

        (void)ctx;
        sharddir_debug(vshard->shardd, i & UINT32_MAX);
}

/* =============================================================
 * shard_param
 */

VCL_VOID v_matchproto_(td_directors_shard_param__init)
vmod_shard_param__init(VRT_CTX,
    struct vmod_directors_shard_param **pp, const char *vcl_name)
{
        struct vmod_directors_shard_param *p;

        (void) ctx;
        AN(pp);
        AZ(*pp);
        ALLOC_OBJ(p, VMOD_SHARD_SHARD_PARAM_MAGIC);
        AN(p);
        p->vcl_name = vcl_name;
        p->scope = SCOPE_VCL;
        p->defaults = &shard_param_default;

        *pp = p;
}

VCL_VOID v_matchproto_(td_directors_shard_param__fini)
vmod_shard_param__fini(struct vmod_directors_shard_param **pp)
{
        struct vmod_directors_shard_param *p;

        TAKE_OBJ_NOTNULL(p, pp, VMOD_SHARD_SHARD_PARAM_MAGIC);
        FREE_OBJ(p);
}

/*
 * init a stack param struct defaulting to pa with the given name
 */
static struct vmod_directors_shard_param *
shard_param_stack(struct vmod_directors_shard_param *p,
    const struct vmod_directors_shard_param *pa, const char *who)
{
        CHECK_OBJ_NOTNULL(pa, VMOD_SHARD_SHARD_PARAM_MAGIC);
        assert(pa->scope > _SCOPE_INVALID);

        AN(p);
        INIT_OBJ(p, VMOD_SHARD_SHARD_PARAM_MAGIC);
        p->vcl_name = who;
        p->scope = SCOPE_STACK;
        p->defaults = pa;

        return (p);
}

static const struct vmod_directors_shard_param *
shard_param_task_r(VRT_CTX, const void *id, const char *who,
   const struct vmod_directors_shard_param *pa)
{
        const struct vmod_directors_shard_param *p;
        const struct vmod_priv *task;
        const void *task_id;

        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
        CHECK_OBJ_NOTNULL(pa, VMOD_SHARD_SHARD_PARAM_MAGIC);
        assert(pa->scope > _SCOPE_INVALID);

        task_id = (const char *)id + task_off_param;
        task = VRT_priv_task_get(ctx, task_id);

        if (task) {
                CAST_OBJ_NOTNULL(p, task->priv, VMOD_SHARD_SHARD_PARAM_MAGIC);
                assert(p->scope == SCOPE_TASK);
                assert(who == p->vcl_name);
                return (p);
        }

        if (id == pa || pa->scope != SCOPE_VCL)
                return (pa);

        return (shard_param_task_r(ctx, pa, pa->vcl_name, pa));
}

/*
 * get a task scoped param struct for id defaulting to pa
 * if id != pa and pa has VCL scope, also get a task scoped param struct for pa
 */
static struct vmod_directors_shard_param *
shard_param_task_l(VRT_CTX, const void *id, const char *who,
   const struct vmod_directors_shard_param *pa)
{
        struct vmod_directors_shard_param *p;
        struct vmod_priv *task;
        const void *task_id;

        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
        CHECK_OBJ_NOTNULL(pa, VMOD_SHARD_SHARD_PARAM_MAGIC);
        assert(pa->scope > _SCOPE_INVALID);

        task_id = (const char *)id + task_off_param;
        task = VRT_priv_task(ctx, task_id);

        if (task == NULL) {
                shard_fail(ctx, who, "%s", "no priv_task");
                return (NULL);
        }

        if (task->priv) {
                CAST_OBJ_NOTNULL(p, task->priv, VMOD_SHARD_SHARD_PARAM_MAGIC);
                assert(p->scope == SCOPE_TASK);
                assert(who == p->vcl_name);
                return (p);
        }

        WS_TASK_ALLOC_OBJ(ctx, p, VMOD_SHARD_SHARD_PARAM_MAGIC);
        if (p == NULL)
                return (NULL);
        task->priv = p;
        p->vcl_name = who;
        p->scope = SCOPE_TASK;

        if (id == pa || pa->scope != SCOPE_VCL)
                p->defaults = pa;
        else
                p->defaults = shard_param_task_l(ctx, pa, pa->vcl_name, pa);

        if (p->defaults == NULL)
                return (NULL);

        return (p);
}

static struct vmod_directors_shard_param *
shard_param_prep(VRT_CTX, struct vmod_directors_shard_param *p,
    const char *who)
{
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
        CHECK_OBJ_NOTNULL(p, VMOD_SHARD_SHARD_PARAM_MAGIC);

        if (ctx->method & SHARD_VCL_TASK_REQ) {
                shard_fail(ctx, p->vcl_name, "%s may only be used "
                    "in vcl_init and in backend/pipe context", who);
                return (NULL);
        } else if (ctx->method & SHARD_VCL_TASK_BEREQ)
                p = shard_param_task_l(ctx, p, p->vcl_name, p);
        else
                assert(ctx->method & VCL_MET_TASK_H);

        return (p);
}

VCL_VOID v_matchproto_(td_directors_shard_param_set)
vmod_shard_param_set(VRT_CTX, struct vmod_directors_shard_param *p,
                     struct VARGS(shard_param_set) *a)
{
        uint32_t args = shard_param_set_mask(a);

        assert((args & ~arg_mask_set_) == 0);

        p = shard_param_prep(ctx, p, "shard_param.set()");
        if (p == NULL)
                return;
        (void) shard_param_args(ctx, p, "shard_param.set()", args,
                                a->by, a->key, a->key_blob, a->alt, a->warmup,
                                a->rampup, a->healthy);
}

VCL_VOID v_matchproto_(td_directors_shard_param_clear)
vmod_shard_param_clear(VRT_CTX,
    struct vmod_directors_shard_param *p)
{
        p = shard_param_prep(ctx, p, "shard_param.clear()");
        if (p == NULL)
                return;
        p->mask = 0;
}

static const struct vmod_directors_shard_param *
vmod_shard_param_read(VRT_CTX, const void *id, const char *who,
    const struct vmod_directors_shard_param *p,
    struct vmod_directors_shard_param *pstk)
{
        struct vmod_directors_shard_param *pp;

        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
        CHECK_OBJ_NOTNULL(p, VMOD_SHARD_SHARD_PARAM_MAGIC);

        if (ctx->method == 0 || (ctx->method & SHARD_VCL_TASK_BEREQ))
                p = shard_param_task_r(ctx, id, who, p);

        CHECK_OBJ_NOTNULL(p, VMOD_SHARD_SHARD_PARAM_MAGIC);
        pp = shard_param_stack(pstk, p, p->vcl_name);
        shard_param_merge(pp, p);
        return (pp);
}

VCL_STRING v_matchproto_(td_directors_shard_param_get_by)
vmod_shard_param_get_by(VRT_CTX,
    struct vmod_directors_shard_param *p)
{
        struct vmod_directors_shard_param pstk;
        const struct vmod_directors_shard_param *pp;

        pp = vmod_shard_param_read(ctx, p, p->vcl_name, p, &pstk);
        CHECK_OBJ_NOTNULL(pp, VMOD_SHARD_SHARD_PARAM_MAGIC);
        return (default_by(pp->by));
}

VCL_INT v_matchproto_(td_directors_shard_param_get_key)
vmod_shard_param_get_key(VRT_CTX,
    struct vmod_directors_shard_param *p)
{
        struct vmod_directors_shard_param pstk;
        const struct vmod_directors_shard_param *pp;

        pp = vmod_shard_param_read(ctx, p, p->vcl_name, p, &pstk);
        CHECK_OBJ_NOTNULL(pp, VMOD_SHARD_SHARD_PARAM_MAGIC);
        return ((VCL_INT)shard_get_key(ctx, pp));
}
VCL_INT v_matchproto_(td_directors_shard_param_get_alt)
vmod_shard_param_get_alt(VRT_CTX,
    struct vmod_directors_shard_param *p)
{
        struct vmod_directors_shard_param pstk;
        const struct vmod_directors_shard_param *pp;

        pp = vmod_shard_param_read(ctx, p, p->vcl_name, p, &pstk);
        CHECK_OBJ_NOTNULL(pp, VMOD_SHARD_SHARD_PARAM_MAGIC);
        return (pp->alt);
}

VCL_REAL v_matchproto_(td_directors_shard_param_get_warmup)
vmod_shard_param_get_warmup(VRT_CTX,
    struct vmod_directors_shard_param *p)
{
        struct vmod_directors_shard_param pstk;
        const struct vmod_directors_shard_param *pp;

        pp = vmod_shard_param_read(ctx, p, p->vcl_name, p, &pstk);
        CHECK_OBJ_NOTNULL(pp, VMOD_SHARD_SHARD_PARAM_MAGIC);
        return (pp->warmup);
}

VCL_BOOL v_matchproto_(td_directors_shard_param_get_rampup)
vmod_shard_param_get_rampup(VRT_CTX,
    struct vmod_directors_shard_param *p)
{
        struct vmod_directors_shard_param pstk;
        const struct vmod_directors_shard_param *pp;

        pp = vmod_shard_param_read(ctx, p, p->vcl_name, p, &pstk);
        CHECK_OBJ_NOTNULL(pp, VMOD_SHARD_SHARD_PARAM_MAGIC);
        return (pp->rampup);
}

VCL_STRING v_matchproto_(td_directors_shard_param_get_healthy)
vmod_shard_param_get_healthy(VRT_CTX,
    struct vmod_directors_shard_param *p)
{
        struct vmod_directors_shard_param pstk;
        const struct vmod_directors_shard_param *pp;

        pp = vmod_shard_param_read(ctx, p, p->vcl_name, p, &pstk);
        CHECK_OBJ_NOTNULL(pp, VMOD_SHARD_SHARD_PARAM_MAGIC);
        return (default_healthy(pp->healthy));
}

static const struct vmod_directors_shard_param *
shard_param_blob(VCL_BLOB blob)
{
        const struct vmod_directors_shard_param *p;

        if (blob && blob->type == VMOD_SHARD_SHARD_PARAM_BLOB &&
            blob->blob != NULL &&
            blob->len == sizeof(struct vmod_directors_shard_param)) {
                CAST_OBJ_NOTNULL(p, blob->blob, VMOD_SHARD_SHARD_PARAM_MAGIC);
                return (p);
        }

        return (NULL);
}

VCL_BLOB v_matchproto_(td_directors_shard_param_use)
vmod_shard_param_use(VRT_CTX,
    struct vmod_directors_shard_param *p)
{
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
        CHECK_OBJ_NOTNULL(p, VMOD_SHARD_SHARD_PARAM_MAGIC);

        return (VRT_blob(ctx, "xshard_param.use()", p, sizeof *p,
            VMOD_SHARD_SHARD_PARAM_BLOB));
}

		varnish-cache/vmod/vmod_directors_shard.c
0		/*-
1		* Copyright 2009-2018 UPLEX - Nils Goroll Systemoptimierung
2		* All rights reserved.
3		*
4		* Authors: Julian Wiesener <jw@uplex.de>
5		* Nils Goroll <slink@uplex.de>
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		#include "config.h"
32
33		#include <stdlib.h>
34		#include <string.h>
35
36		#include "cache/cache.h"
37		#include "vcl.h"
38
39		#include "vend.h"
40
41		#include "vcc_directors_if.h"
42		#include "vmod_directors_shard_dir.h"
43		#include "vmod_directors_shard_cfg.h"
44		#include "vsb.h"
45
46		/* -------------------------------------------------------------------------
47		* shard director: LAZY mode (vdi resolve function), parameter objects
48		*
49		* By associating a parameter object with a shard director, we enable LAZY
50		* lookups as with the other directors. Parameter objects are defined with VCL
51		* scope (normal vmod objects), but can be overridden per backend request using
52		* a task priv.
53		*
54		* We use the same concept to carry shard.backend() parameters to vdi resolve
55		* for LAZY mode: They get saved in a per-director task scope parameter object.
56		*
57		* Each object points to another object providing defaults for values which are
58		* not defined.
59		*
60		* Actual resolution of the various parameter objects does not happen before
61		* they are used, which enables changing them independently (ie, shard
62		* .backend() parameters have precedence over an associated parameter object,
63		* which by itself can be overridden).
64		*
65		* Overview of parameter objects (pointers are alternatives)
66		*
67		* shard() director shard_param() object default param
68		*
69		* ---------------------------------> vmod static
70		* VCL obj / ->
71		* .param -+---------> VCL obj / _
72		* .default -------- /\|
73		* /
74		* ^ /
75		* \| /
76		* /
77		* .default /
78		* -------------> TASK priv /
79		* / /
80		* .default -----------------------------
81		* TASK priv
82		*/
83
84		/* -------------------------------------------------------------------------
85		* method arguments and set parameters bitmask in vmod_directors_shard_param
86		*/
87
88		#define arg_by ((uint32_t)1)
89		#define arg_key ((uint32_t)1 << 1)
90		#define arg_key_blob ((uint32_t)1 << 2)
91		#define arg_alt ((uint32_t)1 << 3)
92		#define arg_warmup ((uint32_t)1 << 4)
93		#define arg_rampup ((uint32_t)1 << 5)
94		#define arg_healthy ((uint32_t)1 << 6)
95		#define arg_param ((uint32_t)1 << 7)
96		#define arg_resolve ((uint32_t)1 << 8)
97		#define arg_mask_ ((arg_resolve << 1) - 1)
98		/* allowed in shard_param.set */
99		#define arg_mask_set_ (arg_param - 1)
100		/* allowed in shard_param */
101		#define arg_mask_param_ ( arg_mask_set_ \
102		& ~arg_key \
103		& ~arg_key_blob )
104
105		/* -------------------------------------------------------------------------
106		* shard parameters - declaration & defaults
107		*/
108		enum vmod_directors_shard_param_scope {
109		_SCOPE_INVALID = 0,
110		SCOPE_VMOD,
111		SCOPE_VCL,
112		SCOPE_TASK,
113		SCOPE_STACK
114		};
115
116		struct vmod_directors_shard_param;
117
118		#define VMOD_SHARD_SHARD_PARAM_BLOB 0xdf5ca116
119
120		struct vmod_directors_shard_param {
121		unsigned magic;
122		#define VMOD_SHARD_SHARD_PARAM_MAGIC 0xdf5ca117
123
124		/* internals */
125		uint32_t key;
126		const char *vcl_name;
127		const struct vmod_directors_shard_param *defaults;
128		enum vmod_directors_shard_param_scope scope;
129
130		/* parameters */
131		VCL_ENUM by;
132		VCL_ENUM healthy;
133		uint32_t mask;
134		VCL_BOOL rampup;
135		VCL_INT alt;
136		VCL_REAL warmup;
137		};
138
139		static const struct vmod_directors_shard_param shard_param_default = {
140		.magic = VMOD_SHARD_SHARD_PARAM_MAGIC,
141
142		.key = 0,
143		.vcl_name = "builtin defaults",
144		.defaults = NULL,
145		.scope = SCOPE_VMOD,
146
147		.mask = arg_mask_param_,
148		.rampup = 1,
149		.alt = 0,
150		.warmup = -1,
151		};
152
153		#define default_by(ptr) (ptr == NULL ? VENUM(HASH) : ptr)
154		#define default_healthy(ptr) (ptr == NULL ? VENUM(CHOSEN) : ptr)
155
156		static struct vmod_directors_shard_param *
157		shard_param_stack(struct vmod_directors_shard_param *p,
158		const struct vmod_directors_shard_param pa, const char who);
159
160		static const struct vmod_directors_shard_param *
161		shard_param_task_r(VRT_CTX, const void id, const char who,
162		const struct vmod_directors_shard_param *pa);
163
164		static struct vmod_directors_shard_param *
165		shard_param_task_l(VRT_CTX, const void id, const char who,
166		const struct vmod_directors_shard_param *pa);
167
168		static const struct vmod_directors_shard_param *
169		shard_param_blob(VCL_BLOB blob);
170
171		static const struct vmod_directors_shard_param *
172		vmod_shard_param_read(VRT_CTX, const void id, const char who,
173		const struct vmod_directors_shard_param *p,
174		struct vmod_directors_shard_param *pstk);
175
176		// XXX #3329 #3330 revisit - for now, treat pipe like backend
177		#define SHARD_VCL_TASK_REQ (VCL_MET_TASK_C & ~VCL_MET_PIPE)
178		#define SHARD_VCL_TASK_BEREQ (VCL_MET_TASK_B \| VCL_MET_PIPE)
179		/* -------------------------------------------------------------------------
180		* shard vmod interface
181		*/
182		static vdi_healthy_f vmod_shard_healthy;
183		static vdi_resolve_f vmod_shard_resolve;
184		static vdi_list_f vmod_shard_list;
185
186		struct vmod_directors_shard {
187		unsigned magic;
188		#define VMOD_SHARD_SHARD_MAGIC 0x6e63e1bf
189		struct sharddir *shardd;
190		VCL_BACKEND dir;
191		};
192
193		static void
194	1000	shard__assert(void)
195		{
196		VCL_INT t1;
197		uint32_t t2a, t2b;
198
199		/* we put our uint32 key in a VCL_INT container */
200	1000	assert(sizeof(VCL_INT) >= sizeof(uint32_t));
201	1000	t2a = UINT32_MAX;
202	1000	t1 = (VCL_INT)t2a;
203	1000	t2b = (uint32_t)t1;
204	1000	assert(t2a == t2b);
205	1000	}
206
207		static void v_matchproto_(vdi_release_f)
208	200	vmod_shard_release(VCL_BACKEND dir)
209		{
210		struct sharddir *shardd;
211
212	200	CAST_OBJ_NOTNULL(shardd, dir->priv, SHARDDIR_MAGIC);
213	200	sharddir_release(shardd);
214	200	}
215
216		static void v_matchproto_(vdi_destroy_f)
217	200	vmod_shard_destroy(VCL_BACKEND dir)
218		{
219		struct sharddir *shardd;
220
221	200	CAST_OBJ_NOTNULL(shardd, dir->priv, SHARDDIR_MAGIC);
222	200	sharddir_delete(&shardd);
223	200	}
224
225		static const struct vdi_methods vmod_shard_methods[1] = {{
226		.magic = VDI_METHODS_MAGIC,
227		.type = "shard",
228		.resolve = vmod_shard_resolve,
229		.healthy = vmod_shard_healthy,
230		.release = vmod_shard_release,
231		.destroy = vmod_shard_destroy,
232		.list = vmod_shard_list
233		}};
234
235
236		VCL_VOID v_matchproto_(td_directors_shard__init)
237	1000	vmod_shard__init(VRT_CTX, struct vmod_directors_shard **vshardp,
238		const char *vcl_name)
239		{
240		struct vmod_directors_shard *vshard;
241
242	1000	shard__assert();
243
244	1000	AN(vshardp);
245	1000	AZ(*vshardp);
246	1000	ALLOC_OBJ(vshard, VMOD_SHARD_SHARD_MAGIC);
247	1000	AN(vshard);
248
249	1000	*vshardp = vshard;
250	1000	sharddir_new(&vshard->shardd, vcl_name, &shard_param_default);
251
252	2000	vshard->dir = VRT_AddDirector(ctx, vmod_shard_methods, vshard->shardd,
253	1000	"%s", vcl_name);
254	1000	}
255
256		VCL_VOID v_matchproto_(td_directors_shard__fini)
257	200	vmod_shard__fini(struct vmod_directors_shard **vshardp)
258		{
259		struct vmod_directors_shard *vshard;
260
261	200	TAKE_OBJ_NOTNULL(vshard, vshardp, VMOD_SHARD_SHARD_MAGIC);
262	200	VRT_DelDirector(&vshard->dir);
263	200	FREE_OBJ(vshard);
264	200	}
265
266		VCL_INT v_matchproto_(td_directors_shard_key)
267	440	vmod_shard_key(VRT_CTX, struct vmod_directors_shard *vshard, VCL_STRANDS s)
268		{
269
270	440	(void)ctx;
271	440	(void)vshard;
272
273	440	return ((VCL_INT)VRT_HashStrands32(s));
274		}
275
276		VCL_VOID v_matchproto_(td_directors_set_warmup)
277	160	vmod_shard_set_warmup(VRT_CTX, struct vmod_directors_shard *vshard,
278		VCL_REAL probability)
279		{
280	160	CHECK_OBJ_NOTNULL(vshard, VMOD_SHARD_SHARD_MAGIC);
281	160	if (probability < 0 \|\| probability >= 1) {
282	80	shard_notice(ctx->vsl, vshard->shardd->name,
283		".set_warmup(%f) ignored", probability);
284	80	return;
285		}
286	80	shardcfg_set_warmup(vshard->shardd, probability);
287	160	}
288
289		VCL_VOID v_matchproto_(td_directors_set_rampup)
290	80	vmod_shard_set_rampup(VRT_CTX, struct vmod_directors_shard *vshard,
291		VCL_DURATION duration)
292		{
293	80	(void)ctx;
294	80	CHECK_OBJ_NOTNULL(vshard, VMOD_SHARD_SHARD_MAGIC);
295	80	shardcfg_set_rampup(vshard->shardd, duration);
296	80	}
297
298		VCL_VOID v_matchproto_(td_directors_shard_associate)
299	160	vmod_shard_associate(VRT_CTX,
300		struct vmod_directors_shard *vshard, VCL_BLOB b)
301		{
302		const struct vmod_directors_shard_param *ppt;
303	160	CHECK_OBJ_NOTNULL(vshard, VMOD_SHARD_SHARD_MAGIC);
304
305	160	if (b == NULL) {
306	40	sharddir_set_param(vshard->shardd, &shard_param_default);
307	40	return;
308		}
309
310	120	ppt = shard_param_blob(b);
311
312	120	if (ppt == NULL) {
313	40	shard_fail(ctx, vshard->shardd->name, "%s",
314		"shard .associate param invalid");
315	40	return;
316		}
317
318	80	sharddir_set_param(vshard->shardd, ppt);
319	160	}
320
321		VCL_BOOL v_matchproto_(td_directors_shard_add_backend)
322	4560	vmod_shard_add_backend(VRT_CTX, struct vmod_directors_shard *vshard,
323		struct VARGS(shard_add_backend) *args)
324		{
325	4560	VCL_REAL weight = 1;
326
327	4560	CHECK_OBJ_NOTNULL(vshard, VMOD_SHARD_SHARD_MAGIC);
328
329	4560	if (args->backend == NULL) {
330	40	shard_fail(ctx, vshard->shardd->name, "%s",
331		"None backend cannot be added");
332	40	return (0);
333		}
334
335	4520	if (args->valid_weight) {
336	120	if (args->weight >= 1)
337	80	weight = args->weight;
338		else
339	40	shard_notice(ctx->vsl, vshard->shardd->name,
340		".add_backend(weight=%f) ignored", args->weight);
341	120	}
342
343	9040	return (shardcfg_add_backend(ctx, vshard->shardd, args->backend,
344	4520	args->valid_ident ? args->ident : NULL,
345	4520	args->valid_rampup ? args->rampup : nan(""),
346	4520	weight));
347	4560	}
348
349		VCL_BOOL v_matchproto_(td_directors_shard_remove_backend)
350	1200	vmod_shard_remove_backend(VRT_CTX, struct vmod_directors_shard *vshard,
351		struct VARGS(shard_remove_backend) *args)
352		{
353	1200	VCL_BACKEND be = args->valid_backend ? args->backend : NULL;
354	1200	VCL_STRING ident = args->valid_ident ? args->ident : NULL;
355
356	1200	CHECK_OBJ_NOTNULL(vshard, VMOD_SHARD_SHARD_MAGIC);
357
358	1200	if (be == NULL && ident == NULL) {
359	40	shard_fail(ctx, vshard->shardd->name, "%s",
360		".remove_backend(): either backend or ident are required");
361	40	return (0);
362		}
363
364	1160	return (shardcfg_remove_backend(ctx, vshard->shardd, be, ident));
365	1200	}
366
367		VCL_BOOL v_matchproto_(td_directors_shard_clear)
368	600	vmod_shard_clear(VRT_CTX, struct vmod_directors_shard *vshard)
369		{
370	600	CHECK_OBJ_NOTNULL(vshard, VMOD_SHARD_SHARD_MAGIC);
371	600	return (shardcfg_clear(ctx, vshard->shardd));
372		}
373
374		VCL_BOOL v_matchproto_(td_directors_shard_reconfigure)
375	1680	vmod_shard_reconfigure(VRT_CTX, struct vmod_directors_shard *vshard,
376		VCL_INT replicas)
377		{
378	1680	return (shardcfg_reconfigure(ctx, vshard->shardd, replicas));
379		}
380
381		static inline uint32_t
382	5160	shard_get_key(VRT_CTX, const struct vmod_directors_shard_param *p)
383		{
384		struct http *http;
385	5160	VCL_ENUM by = default_by(p->by);
386
387	5160	if (by == VENUM(KEY) \|\| by == VENUM(BLOB))
388	4080	return (p->key);
389	1080	if (by == VENUM(HASH) && ctx->bo != NULL) {
390	280	CHECK_OBJ(ctx->bo, BUSYOBJ_MAGIC);
391	280	return (vbe32dec(ctx->bo->digest));
392		}
393	800	if (by == VENUM(HASH) \|\| by == VENUM(URL)) {
394	800	if (ctx->http_req) {
395	560	AN(http = ctx->http_req);
396	560	} else {
397	240	AN(ctx->http_bereq);
398	240	AN(http = ctx->http_bereq);
399		}
400	800	return (VRT_HashStrands32(TOSTRAND(http->hd[HTTP_HDR_URL].b)));
401		}
402	0	WRONG("by enum");
403	5160	}
404
405		/*
406		* merge parameters to resolve all undef values
407		* key is to be calculated after merging
408		*/
409		static void
410	23040	shard_param_merge(struct vmod_directors_shard_param *to,
411		const struct vmod_directors_shard_param *from)
412		{
413	23040	CHECK_OBJ_NOTNULL(to, VMOD_SHARD_SHARD_PARAM_MAGIC);
414	23040	assert((to->mask & ~arg_mask_param_) == 0);
415
416	23040	if (to->mask == arg_mask_param_)
417	0	return;
418
419	23040	CHECK_OBJ_NOTNULL(from, VMOD_SHARD_SHARD_PARAM_MAGIC);
420	23040	assert((from->mask & ~arg_mask_param_) == 0);
421
422	23040	if ((to->mask & arg_by) == 0 && (from->mask & arg_by) != 0) {
423	8360	to->by = from->by;
424	8360	if (from->by == VENUM(KEY) \|\| from->by == VENUM(BLOB))
425	4080	to->key = from->key;
426	8360	}
427
428		#define mrg(to, from, field) do { \
429		if (((to)->mask & arg_ ## field) == 0 && \
430		((from)->mask & arg_ ## field) != 0) \
431		(to)->field = (from)->field; \
432		} while(0)
433
434	23040	mrg(to, from, healthy);
435	23040	mrg(to, from, rampup);
436	23040	mrg(to, from, alt);
437	23040	mrg(to, from, warmup);
438		#undef mrg
439
440	23040	to->mask \|= from->mask;
441
442	23040	if (to->mask == arg_mask_param_)
443	10160	return;
444
445	12880	AN(from->defaults);
446	12880	shard_param_merge(to, from->defaults);
447	23040	}
448
449		static uint32_t
450	400	shard_blob_key(VCL_BLOB key_blob)
451		{
452	400	uint8_t k[4] = { 0 };
453		const uint8_t *b;
454		size_t i, ki;
455
456	400	AN(key_blob);
457	400	AN(key_blob->blob);
458	400	assert(key_blob->len > 0);
459
460	400	if (key_blob->len >= 4)
461	400	ki = 0;
462		else
463	0	ki = 4 - key_blob->len;
464
465	400	b = key_blob->blob;
466	2000	for (i = 0; ki < 4; i++, ki++)
467	1600	k[ki] = b[i];
468	400	assert(i <= key_blob->len);
469
470	400	return (vbe32dec(k));
471		}
472
473		/*
474		* convert vmod interface valid_* to our bitmask
475		*/
476
477		#define tobit(args, name) ((args)->valid_##name ? arg_##name : 0)
478
479		static uint32_t
480	4280	shard_backendarg_mask_(const struct VARGS(shard_backend) * const a)
481		{
482	12840	return (tobit(a, by) \|
483	8560	tobit(a, key) \|
484	8560	tobit(a, key_blob) \|
485	8560	tobit(a, alt) \|
486	8560	tobit(a, warmup) \|
487	8560	tobit(a, rampup) \|
488	8560	tobit(a, healthy) \|
489	8560	tobit(a, param) \|
490	4280	tobit(a, resolve));
491		}
492		static uint32_t
493	3920	shard_param_set_mask(const struct VARGS(shard_param_set) * const a)
494		{
495	11760	return (tobit(a, by) \|
496	7840	tobit(a, key) \|
497	7840	tobit(a, key_blob) \|
498	7840	tobit(a, alt) \|
499	7840	tobit(a, warmup) \|