| | 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 |
25 |
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 |
25 |
assert(sizeof(VCL_INT) >= sizeof(uint32_t)); |
| 201 |
25 |
t2a = UINT32_MAX; |
| 202 |
25 |
t1 = (VCL_INT)t2a; |
| 203 |
25 |
t2b = (uint32_t)t1; |
| 204 |
25 |
assert(t2a == t2b); |
| 205 |
25 |
} |
| 206 |
|
|
| 207 |
|
static void v_matchproto_(vdi_release_f) |
| 208 |
5 |
vmod_shard_release(VCL_BACKEND dir) |
| 209 |
|
{ |
| 210 |
|
struct sharddir *shardd; |
| 211 |
|
|
| 212 |
5 |
CAST_OBJ_NOTNULL(shardd, dir->priv, SHARDDIR_MAGIC); |
| 213 |
5 |
sharddir_release(shardd); |
| 214 |
5 |
} |
| 215 |
|
|
| 216 |
|
static void v_matchproto_(vdi_destroy_f) |
| 217 |
5 |
vmod_shard_destroy(VCL_BACKEND dir) |
| 218 |
|
{ |
| 219 |
|
struct sharddir *shardd; |
| 220 |
|
|
| 221 |
5 |
CAST_OBJ_NOTNULL(shardd, dir->priv, SHARDDIR_MAGIC); |
| 222 |
5 |
sharddir_delete(&shardd); |
| 223 |
5 |
} |
| 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 |
25 |
vmod_shard__init(VRT_CTX, struct vmod_directors_shard **vshardp, |
| 238 |
|
const char *vcl_name) |
| 239 |
|
{ |
| 240 |
|
struct vmod_directors_shard *vshard; |
| 241 |
|
|
| 242 |
25 |
shard__assert(); |
| 243 |
|
|
| 244 |
25 |
AN(vshardp); |
| 245 |
25 |
AZ(*vshardp); |
| 246 |
25 |
ALLOC_OBJ(vshard, VMOD_SHARD_SHARD_MAGIC); |
| 247 |
25 |
AN(vshard); |
| 248 |
|
|
| 249 |
25 |
*vshardp = vshard; |
| 250 |
25 |
sharddir_new(&vshard->shardd, vcl_name, &shard_param_default); |
| 251 |
|
|
| 252 |
50 |
vshard->dir = VRT_AddDirector(ctx, vmod_shard_methods, vshard->shardd, |
| 253 |
25 |
"%s", vcl_name); |
| 254 |
25 |
} |
| 255 |
|
|
| 256 |
|
VCL_VOID v_matchproto_(td_directors_shard__fini) |
| 257 |
5 |
vmod_shard__fini(struct vmod_directors_shard **vshardp) |
| 258 |
|
{ |
| 259 |
|
struct vmod_directors_shard *vshard; |
| 260 |
|
|
| 261 |
5 |
TAKE_OBJ_NOTNULL(vshard, vshardp, VMOD_SHARD_SHARD_MAGIC); |
| 262 |
5 |
VRT_DelDirector(&vshard->dir); |
| 263 |
5 |
FREE_OBJ(vshard); |
| 264 |
5 |
} |
| 265 |
|
|
| 266 |
|
VCL_INT v_matchproto_(td_directors_shard_key) |
| 267 |
11 |
vmod_shard_key(VRT_CTX, struct vmod_directors_shard *vshard, VCL_STRANDS s) |
| 268 |
|
{ |
| 269 |
|
|
| 270 |
11 |
(void)ctx; |
| 271 |
11 |
(void)vshard; |
| 272 |
|
|
| 273 |
11 |
return ((VCL_INT)VRT_HashStrands32(s)); |
| 274 |
|
} |
| 275 |
|
|
| 276 |
|
VCL_VOID v_matchproto_(td_directors_set_warmup) |
| 277 |
4 |
vmod_shard_set_warmup(VRT_CTX, struct vmod_directors_shard *vshard, |
| 278 |
|
VCL_REAL probability) |
| 279 |
|
{ |
| 280 |
4 |
CHECK_OBJ_NOTNULL(vshard, VMOD_SHARD_SHARD_MAGIC); |
| 281 |
4 |
if (probability < 0 || probability >= 1) { |
| 282 |
2 |
shard_notice(ctx->vsl, vshard->shardd->name, |
| 283 |
|
".set_warmup(%f) ignored", probability); |
| 284 |
2 |
return; |
| 285 |
|
} |
| 286 |
2 |
shardcfg_set_warmup(vshard->shardd, probability); |
| 287 |
4 |
} |
| 288 |
|
|
| 289 |
|
VCL_VOID v_matchproto_(td_directors_set_rampup) |
| 290 |
2 |
vmod_shard_set_rampup(VRT_CTX, struct vmod_directors_shard *vshard, |
| 291 |
|
VCL_DURATION duration) |
| 292 |
|
{ |
| 293 |
2 |
(void)ctx; |
| 294 |
2 |
CHECK_OBJ_NOTNULL(vshard, VMOD_SHARD_SHARD_MAGIC); |
| 295 |
2 |
shardcfg_set_rampup(vshard->shardd, duration); |
| 296 |
2 |
} |
| 297 |
|
|
| 298 |
|
VCL_VOID v_matchproto_(td_directors_shard_associate) |
| 299 |
4 |
vmod_shard_associate(VRT_CTX, |
| 300 |
|
struct vmod_directors_shard *vshard, VCL_BLOB b) |
| 301 |
|
{ |
| 302 |
|
const struct vmod_directors_shard_param *ppt; |
| 303 |
4 |
CHECK_OBJ_NOTNULL(vshard, VMOD_SHARD_SHARD_MAGIC); |
| 304 |
|
|
| 305 |
4 |
if (b == NULL) { |
| 306 |
1 |
sharddir_set_param(vshard->shardd, &shard_param_default); |
| 307 |
1 |
return; |
| 308 |
|
} |
| 309 |
|
|
| 310 |
3 |
ppt = shard_param_blob(b); |
| 311 |
|
|
| 312 |
3 |
if (ppt == NULL) { |
| 313 |
1 |
shard_fail(ctx, vshard->shardd->name, "%s", |
| 314 |
|
"shard .associate param invalid"); |
| 315 |
1 |
return; |
| 316 |
|
} |
| 317 |
|
|
| 318 |
2 |
sharddir_set_param(vshard->shardd, ppt); |
| 319 |
4 |
} |
| 320 |
|
|
| 321 |
|
VCL_BOOL v_matchproto_(td_directors_shard_add_backend) |
| 322 |
114 |
vmod_shard_add_backend(VRT_CTX, struct vmod_directors_shard *vshard, |
| 323 |
|
struct VARGS(shard_add_backend) *args) |
| 324 |
|
{ |
| 325 |
114 |
VCL_REAL weight = 1; |
| 326 |
|
|
| 327 |
114 |
CHECK_OBJ_NOTNULL(vshard, VMOD_SHARD_SHARD_MAGIC); |
| 328 |
|
|
| 329 |
114 |
if (args->backend == NULL) { |
| 330 |
1 |
shard_fail(ctx, vshard->shardd->name, "%s", |
| 331 |
|
"None backend cannot be added"); |
| 332 |
1 |
return (0); |
| 333 |
|
} |
| 334 |
|
|
| 335 |
113 |
if (args->valid_weight) { |
| 336 |
3 |
if (args->weight >= 1) |
| 337 |
2 |
weight = args->weight; |
| 338 |
|
else |
| 339 |
1 |
shard_notice(ctx->vsl, vshard->shardd->name, |
| 340 |
|
".add_backend(weight=%f) ignored", args->weight); |
| 341 |
3 |
} |
| 342 |
|
|
| 343 |
226 |
return (shardcfg_add_backend(ctx, vshard->shardd, args->backend, |
| 344 |
113 |
args->valid_ident ? args->ident : NULL, |
| 345 |
113 |
args->valid_rampup ? args->rampup : nan(""), |
| 346 |
113 |
weight)); |
| 347 |
114 |
} |
| 348 |
|
|
| 349 |
|
VCL_BOOL v_matchproto_(td_directors_shard_remove_backend) |
| 350 |
30 |
vmod_shard_remove_backend(VRT_CTX, struct vmod_directors_shard *vshard, |
| 351 |
|
struct VARGS(shard_remove_backend) *args) |
| 352 |
|
{ |
| 353 |
30 |
VCL_BACKEND be = args->valid_backend ? args->backend : NULL; |
| 354 |
30 |
VCL_STRING ident = args->valid_ident ? args->ident : NULL; |
| 355 |
|
|
| 356 |
30 |
CHECK_OBJ_NOTNULL(vshard, VMOD_SHARD_SHARD_MAGIC); |
| 357 |
|
|
| 358 |
30 |
if (be == NULL && ident == NULL) { |
| 359 |
1 |
shard_fail(ctx, vshard->shardd->name, "%s", |
| 360 |
|
".remove_backend(): either backend or ident are required"); |
| 361 |
1 |
return (0); |
| 362 |
|
} |
| 363 |
|
|
| 364 |
29 |
return (shardcfg_remove_backend(ctx, vshard->shardd, be, ident)); |
| 365 |
30 |
} |
| 366 |
|
|
| 367 |
|
VCL_BOOL v_matchproto_(td_directors_shard_clear) |
| 368 |
15 |
vmod_shard_clear(VRT_CTX, struct vmod_directors_shard *vshard) |
| 369 |
|
{ |
| 370 |
15 |
CHECK_OBJ_NOTNULL(vshard, VMOD_SHARD_SHARD_MAGIC); |
| 371 |
15 |
return (shardcfg_clear(ctx, vshard->shardd)); |
| 372 |
|
} |
| 373 |
|
|
| 374 |
|
VCL_BOOL v_matchproto_(td_directors_shard_reconfigure) |
| 375 |
42 |
vmod_shard_reconfigure(VRT_CTX, struct vmod_directors_shard *vshard, |
| 376 |
|
VCL_INT replicas) |
| 377 |
|
{ |
| 378 |
42 |
return (shardcfg_reconfigure(ctx, vshard->shardd, replicas)); |
| 379 |
|
} |
| 380 |
|
|
| 381 |
|
static inline uint32_t |
| 382 |
129 |
shard_get_key(VRT_CTX, const struct vmod_directors_shard_param *p) |
| 383 |
|
{ |
| 384 |
|
struct http *http; |
| 385 |
129 |
VCL_ENUM by = default_by(p->by); |
| 386 |
|
|
| 387 |
129 |
if (by == VENUM(KEY) || by == VENUM(BLOB)) |
| 388 |
102 |
return (p->key); |
| 389 |
27 |
if (by == VENUM(HASH) && ctx->bo != NULL) { |
| 390 |
7 |
CHECK_OBJ(ctx->bo, BUSYOBJ_MAGIC); |
| 391 |
7 |
return (vbe32dec(ctx->bo->digest)); |
| 392 |
|
} |
| 393 |
20 |
if (by == VENUM(HASH) || by == VENUM(URL)) { |
| 394 |
20 |
if (ctx->http_req) { |
| 395 |
14 |
AN(http = ctx->http_req); |
| 396 |
14 |
} else { |
| 397 |
6 |
AN(ctx->http_bereq); |
| 398 |
6 |
AN(http = ctx->http_bereq); |
| 399 |
|
} |
| 400 |
20 |
return (VRT_HashStrands32(TOSTRAND(http->hd[HTTP_HDR_URL].b))); |
| 401 |
|
} |
| 402 |
0 |
WRONG("by enum"); |
| 403 |
129 |
} |
| 404 |
|
|
| 405 |
|
/* |
| 406 |
|
* merge parameters to resolve all undef values |
| 407 |
|
* key is to be calculated after merging |
| 408 |
|
*/ |
| 409 |
|
static void |
| 410 |
576 |
shard_param_merge(struct vmod_directors_shard_param *to, |
| 411 |
|
const struct vmod_directors_shard_param *from) |
| 412 |
|
{ |
| 413 |
576 |
CHECK_OBJ_NOTNULL(to, VMOD_SHARD_SHARD_PARAM_MAGIC); |
| 414 |
576 |
assert((to->mask & ~arg_mask_param_) == 0); |
| 415 |
|
|
| 416 |
576 |
if (to->mask == arg_mask_param_) |
| 417 |
0 |
return; |
| 418 |
|
|
| 419 |
576 |
CHECK_OBJ_NOTNULL(from, VMOD_SHARD_SHARD_PARAM_MAGIC); |
| 420 |
576 |
assert((from->mask & ~arg_mask_param_) == 0); |
| 421 |
|
|
| 422 |
576 |
if ((to->mask & arg_by) == 0 && (from->mask & arg_by) != 0) { |
| 423 |
209 |
to->by = from->by; |
| 424 |
209 |
if (from->by == VENUM(KEY) || from->by == VENUM(BLOB)) |
| 425 |
102 |
to->key = from->key; |
| 426 |
209 |
} |
| 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 |
576 |
mrg(to, from, healthy); |
| 435 |
576 |
mrg(to, from, rampup); |
| 436 |
576 |
mrg(to, from, alt); |
| 437 |
576 |
mrg(to, from, warmup); |
| 438 |
|
#undef mrg |
| 439 |
|
|
| 440 |
576 |
to->mask |= from->mask; |
| 441 |
|
|
| 442 |
576 |
if (to->mask == arg_mask_param_) |
| 443 |
254 |
return; |
| 444 |
|
|
| 445 |
322 |
AN(from->defaults); |
| 446 |
322 |
shard_param_merge(to, from->defaults); |
| 447 |
576 |
} |
| 448 |
|
|
| 449 |
|
static uint32_t |
| 450 |
10 |
shard_blob_key(VCL_BLOB key_blob) |
| 451 |
|
{ |
| 452 |
10 |
uint8_t k[4] = { 0 }; |
| 453 |
|
const uint8_t *b; |
| 454 |
|
size_t i, ki; |
| 455 |
|
|
| 456 |
10 |
AN(key_blob); |
| 457 |
10 |
AN(key_blob->blob); |
| 458 |
10 |
assert(key_blob->len > 0); |
| 459 |
|
|
| 460 |
10 |
if (key_blob->len >= 4) |
| 461 |
10 |
ki = 0; |
| 462 |
|
else |
| 463 |
0 |
ki = 4 - key_blob->len; |
| 464 |
|
|
| 465 |
10 |
b = key_blob->blob; |
| 466 |
50 |
for (i = 0; ki < 4; i++, ki++) |
| 467 |
40 |
k[ki] = b[i]; |
| 468 |
10 |
assert(i <= key_blob->len); |
| 469 |
|
|
| 470 |
10 |
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 |
107 |
shard_backendarg_mask_(const struct VARGS(shard_backend) * const a) |
| 481 |
|
{ |
| 482 |
321 |
return (tobit(a, by) | |
| 483 |
214 |
tobit(a, key) | |
| 484 |
214 |
tobit(a, key_blob) | |
| 485 |
214 |
tobit(a, alt) | |
| 486 |
214 |
tobit(a, warmup) | |
| 487 |
214 |
tobit(a, rampup) | |
| 488 |
214 |
tobit(a, healthy) | |
| 489 |
214 |
tobit(a, param) | |
| 490 |
107 |
tobit(a, resolve)); |
| 491 |
|
} |
| 492 |
|
static uint32_t |
| 493 |
98 |
shard_param_set_mask(const struct VARGS(shard_param_set) * const a) |
| 494 |
|
{ |
| 495 |
294 |
return (tobit(a, by) | |
| 496 |
196 |
tobit(a, key) | |
| 497 |
196 |
tobit(a, key_blob) | |
| 498 |
196 |
tobit(a, alt) | |
| 499 |
196 |
tobit(a, warmup) | |
| 500 |
196 |
tobit(a, rampup) | |
| 501 |
98 |
tobit(a, healthy)); |
| 502 |
|
} |
| 503 |
|
#undef tobit |
| 504 |
|
|
| 505 |
|
/* |
| 506 |
|
* check arguments and return in a struct param |
| 507 |
|
*/ |
| 508 |
|
static struct vmod_directors_shard_param * |
| 509 |
195 |
shard_param_args(VRT_CTX, |
| 510 |
|
struct vmod_directors_shard_param *p, const char *func, |
| 511 |
|
uint32_t args, VCL_ENUM by_s, VCL_INT key_int, VCL_BLOB key_blob, |
| 512 |
|
VCL_INT alt, VCL_REAL warmup, VCL_BOOL rampup, VCL_ENUM healthy_s) |
| 513 |
|
{ |
| 514 |
|
|
| 515 |
195 |
CHECK_OBJ_NOTNULL(p, VMOD_SHARD_SHARD_PARAM_MAGIC); |
| 516 |
195 |
AN(p->vcl_name); |
| 517 |
|
|
| 518 |
195 |
assert((args & ~arg_mask_set_) == 0); |
| 519 |
|
|
| 520 |
195 |
if (!(args & arg_by)) |
| 521 |
50 |
by_s = NULL; |
| 522 |
195 |
by_s = default_by(by_s); |
| 523 |
|
|
| 524 |
|
/* by_s / key_int / key_blob */ |
| 525 |
195 |
if (by_s == VENUM(KEY)) { |
| 526 |
80 |
if ((args & arg_key) == 0) { |
| 527 |
1 |
shard_fail(ctx, p->vcl_name, |
| 528 |
|
"%s missing key argument with by=%s", |
| 529 |
|
func, by_s); |
| 530 |
1 |
return (NULL); |
| 531 |
|
} |
| 532 |
79 |
if (key_int < 0 || key_int > UINT32_MAX) { |
| 533 |
1 |
shard_fail(ctx, p->vcl_name, |
| 534 |
|
"%s invalid key argument %jd with by=%s", |
| 535 |
|
func, (intmax_t)key_int, by_s); |
| 536 |
1 |
return (NULL); |
| 537 |
|
} |
| 538 |
78 |
assert(key_int >= 0); |
| 539 |
78 |
assert(key_int <= UINT32_MAX); |
| 540 |
78 |
p->key = (uint32_t)key_int; |
| 541 |
193 |
} else if (by_s == VENUM(BLOB)) { |
| 542 |
12 |
if ((args & arg_key_blob) == 0) { |
| 543 |
1 |
shard_fail(ctx, p->vcl_name, |
| 544 |
|
"%s missing key_blob argument with by=%s", |
| 545 |
|
func, by_s); |
| 546 |
1 |
return (NULL); |
| 547 |
|
} |
| 548 |
11 |
if (key_blob == NULL || key_blob->len == 0 || |
| 549 |
10 |
key_blob->blob == NULL) { |
| 550 |
1 |
shard_err(ctx->vsl, p->vcl_name, |
| 551 |
|
"%s by=BLOB but no or empty key_blob - using key 0", |
| 552 |
|
func); |
| 553 |
1 |
p->key = 0; |
| 554 |
1 |
} else |
| 555 |
10 |
p->key = shard_blob_key(key_blob); |
| 556 |
114 |
} else if (by_s == VENUM(HASH) || by_s == VENUM(URL)) { |
| 557 |
103 |
if (args & (arg_key|arg_key_blob)) { |
| 558 |
2 |
shard_fail(ctx, p->vcl_name, |
| 559 |
|
"%s key and key_blob arguments are " |
| 560 |
|
"invalid with by=%s", func, by_s); |
| 561 |
2 |
return (NULL); |
| 562 |
|
} |
| 563 |
101 |
} else { |
| 564 |
0 |
WRONG("by enum"); |
| 565 |
|
} |
| 566 |
190 |
p->by = by_s; |
| 567 |
|
|
| 568 |
190 |
if (args & arg_alt) { |
| 569 |
63 |
if (alt < 0) { |
| 570 |
1 |
shard_fail(ctx, p->vcl_name, |
| 571 |
|
"%s invalid alt argument %jd", |
| 572 |
|
func, (intmax_t)alt); |
| 573 |
1 |
return (NULL); |
| 574 |
|
} |
| 575 |
62 |
p->alt = alt; |
| 576 |
62 |
} |
| 577 |
|
|
| 578 |
189 |
if (args & arg_warmup) { |
| 579 |
19 |
if ((warmup < 0 && warmup != -1) || warmup > 1) { |
| 580 |
2 |
shard_fail(ctx, p->vcl_name, |
| 581 |
|
"%s invalid warmup argument %f", |
| 582 |
|
func, warmup); |
| 583 |
2 |
return (NULL); |
| 584 |
|
} |
| 585 |
17 |
p->warmup = warmup; |
| 586 |
17 |
} |
| 587 |
|
|
| 588 |
187 |
if (args & arg_rampup) |
| 589 |
6 |
p->rampup = !!rampup; |
| 590 |
|
|
| 591 |
187 |
if (args & arg_healthy) |
| 592 |
33 |
p->healthy = healthy_s; |
| 593 |
|
|
| 594 |
187 |
p->mask = args & arg_mask_param_; |
| 595 |
187 |
return (p); |
| 596 |
195 |
} |
| 597 |
|
|
| 598 |
|
VCL_BACKEND v_matchproto_(td_directors_shard_backend) |
| 599 |
107 |
vmod_shard_backend(VRT_CTX, struct vmod_directors_shard *vshard, |
| 600 |
|
struct VARGS(shard_backend) *a) |
| 601 |
|
{ |
| 602 |
|
struct sharddir *shardd; |
| 603 |
|
struct vmod_directors_shard_param pstk; |
| 604 |
107 |
struct vmod_directors_shard_param *pp = NULL; |
| 605 |
|
const struct vmod_directors_shard_param *ppt; |
| 606 |
|
VCL_ENUM resolve; |
| 607 |
107 |
uint32_t args = shard_backendarg_mask_(a); |
| 608 |
|
|
| 609 |
107 |
CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC); |
| 610 |
107 |
CHECK_OBJ_NOTNULL(vshard, VMOD_SHARD_SHARD_MAGIC); |
| 611 |
107 |
shardd = vshard->shardd; |
| 612 |
107 |
CHECK_OBJ_NOTNULL(shardd, SHARDDIR_MAGIC); |
| 613 |
107 |
assert((args & ~arg_mask_) == 0); |
| 614 |
|
|
| 615 |
107 |
if (args & arg_resolve) |
| 616 |
49 |
resolve = a->resolve; |
| 617 |
58 |
else if (ctx->method & VCL_MET_TASK_H) |
| 618 |
1 |
resolve = VENUM(LAZY); |
| 619 |
|
else |
| 620 |
57 |
resolve = VENUM(NOW); |
| 621 |
|
|
| 622 |
107 |
if (resolve == VENUM(LAZY)) { |
| 623 |
16 |
if ((args & ~arg_resolve) == 0) { |
| 624 |
7 |
AN(vshard->dir); |
| 625 |
7 |
return (vshard->dir); |
| 626 |
|
} |
| 627 |
|
|
| 628 |
9 |
if ((ctx->method & SHARD_VCL_TASK_BEREQ) == 0) { |
| 629 |
1 |
shard_fail(ctx, shardd->name, "%s", |
| 630 |
|
".backend(resolve=LAZY) with other " |
| 631 |
|
"parameters can only be used in backend/pipe " |
| 632 |
|
"context"); |
| 633 |
1 |
return (NULL); |
| 634 |
|
} |
| 635 |
|
|
| 636 |
16 |
pp = shard_param_task_l(ctx, shardd, shardd->name, |
| 637 |
8 |
shardd->param); |
| 638 |
8 |
if (pp == NULL) |
| 639 |
0 |
return (NULL); |
| 640 |
99 |
} else if (resolve == VENUM(NOW)) { |
| 641 |
91 |
if (ctx->method & VCL_MET_TASK_H) { |
| 642 |
1 |
shard_fail(ctx, shardd->name, "%s", |
| 643 |
|
".backend(resolve=NOW) cannot be " |
| 644 |
|
"used in vcl_init{}/vcl_fini{}"); |
| 645 |
1 |
return (NULL); |
| 646 |
|
} |
| 647 |
180 |
ppt = shard_param_task_r(ctx, shardd, shardd->name, |
| 648 |
90 |
shardd->param); |
| 649 |
90 |
AN(ppt); |
| 650 |
90 |
pp = shard_param_stack(&pstk, ppt, shardd->name); |
| 651 |
90 |
} else { |
| 652 |
0 |
WRONG("resolve enum"); |
| 653 |
|
} |
| 654 |
|
|
| 655 |
98 |
AN(pp); |
| 656 |
|
|
| 657 |
98 |
if (args & arg_param) { |
| 658 |
3 |
ppt = shard_param_blob(a->param); |
| 659 |
3 |
if (ppt == NULL) { |
| 660 |
1 |
shard_fail(ctx, shardd->name, "%s", |
| 661 |
|
".backend(key_blob) param invalid"); |
| 662 |
1 |
return (NULL); |
| 663 |
|
} |
| 664 |
2 |
pp->defaults = ppt; |
| 665 |
2 |
} |
| 666 |
|
|
| 667 |
194 |
pp = shard_param_args(ctx, pp, "shard.backend()", |
| 668 |
97 |
args & arg_mask_set_, |
| 669 |
97 |
a->by, a->key, a->key_blob, a->alt, a->warmup, |
| 670 |
97 |
a->rampup, a->healthy); |
| 671 |
97 |
if (pp == NULL) |
| 672 |
0 |
return (NULL); |
| 673 |
|
|
| 674 |
97 |
if (resolve == VENUM(LAZY)) |
| 675 |
8 |
return (vshard->dir); |
| 676 |
|
|
| 677 |
89 |
assert(resolve == VENUM(NOW)); |
| 678 |
89 |
shard_param_merge(pp, pp->defaults); |
| 679 |
178 |
return (sharddir_pick_be(ctx, shardd, shard_get_key(ctx, pp), |
| 680 |
89 |
pp->alt, pp->warmup, pp->rampup, pp->healthy)); |
| 681 |
107 |
} |
| 682 |
|
|
| 683 |
|
static VCL_BOOL v_matchproto_(vdi_healthy) |
| 684 |
16 |
vmod_shard_healthy(VRT_CTX, VCL_BACKEND dir, VCL_TIME *changed) |
| 685 |
|
{ |
| 686 |
|
struct sharddir *shardd; |
| 687 |
|
|
| 688 |
16 |
CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC); |
| 689 |
16 |
CHECK_OBJ_NOTNULL(dir, DIRECTOR_MAGIC); |
| 690 |
16 |
CAST_OBJ_NOTNULL(shardd, dir->priv, SHARDDIR_MAGIC); |
| 691 |
16 |
return (sharddir_any_healthy(ctx, shardd, changed)); |
| 692 |
|
} |
| 693 |
|
|
| 694 |
|
static VCL_BACKEND v_matchproto_(vdi_resolve_f) |
| 695 |
15 |
vmod_shard_resolve(VRT_CTX, VCL_BACKEND dir) |
| 696 |
|
{ |
| 697 |
|
struct sharddir *shardd; |
| 698 |
|
struct vmod_directors_shard_param pstk[1]; |
| 699 |
|
const struct vmod_directors_shard_param *pp; |
| 700 |
|
|
| 701 |
15 |
CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC); |
| 702 |
15 |
CHECK_OBJ_NOTNULL(dir, DIRECTOR_MAGIC); |
| 703 |
15 |
CAST_OBJ_NOTNULL(shardd, dir->priv, SHARDDIR_MAGIC); |
| 704 |
|
|
| 705 |
30 |
pp = vmod_shard_param_read(ctx, shardd, shardd->name, |
| 706 |
15 |
shardd->param, pstk); |
| 707 |
15 |
CHECK_OBJ_NOTNULL(pp, VMOD_SHARD_SHARD_PARAM_MAGIC); |
| 708 |
|
|
| 709 |
30 |
return (sharddir_pick_be(ctx, shardd, |
| 710 |
15 |
shard_get_key(ctx, pp), pp->alt, pp->warmup, |
| 711 |
15 |
pp->rampup, pp->healthy)); |
| 712 |
|
} |
| 713 |
|
|
| 714 |
|
static void v_matchproto_(vdi_list_f) |
| 715 |
30 |
vmod_shard_list(VRT_CTX, VCL_BACKEND dir, struct vsb *vsb, int pflag, int jflag) |
| 716 |
|
{ |
| 717 |
|
struct sharddir *shardd; |
| 718 |
|
struct shard_backend *sbe; |
| 719 |
30 |
VCL_TIME c, changed = 0; |
| 720 |
|
VCL_DURATION rampup_d, d; |
| 721 |
|
VCL_BACKEND be; |
| 722 |
|
VCL_BOOL h; |
| 723 |
30 |
unsigned i, nh = 0; |
| 724 |
|
double rampup_p; |
| 725 |
|
|
| 726 |
30 |
CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC); |
| 727 |
30 |
CHECK_OBJ_NOTNULL(dir, DIRECTOR_MAGIC); |
| 728 |
30 |
CAST_OBJ_NOTNULL(shardd, dir->priv, SHARDDIR_MAGIC); |
| 729 |
|
|
| 730 |
30 |
if (pflag) { |
| 731 |
4 |
if (jflag) { |
| 732 |
1 |
VSB_cat(vsb, "{\n"); |
| 733 |
1 |
VSB_indent(vsb, 2); |
| 734 |
1 |
VSB_printf(vsb, "\"warmup\": %f,\n", shardd->warmup); |
| 735 |
2 |
VSB_printf(vsb, "\"rampup_duration\": %f,\n", |
| 736 |
1 |
shardd->rampup_duration); |
| 737 |
1 |
VSB_cat(vsb, "\"backends\": {\n"); |
| 738 |
1 |
VSB_indent(vsb, 2); |
| 739 |
1 |
} else { |
| 740 |
3 |
VSB_cat(vsb, "\n\n\tBackend\tIdent\tHealth\t" |
| 741 |
|
"Rampup Remaining\n"); |
| 742 |
|
} |
| 743 |
4 |
} |
| 744 |
|
|
| 745 |
30 |
sharddir_rdlock(shardd); |
| 746 |
121 |
for (i = 0; i < shardd->n_backend; i++) { |
| 747 |
91 |
sbe = &shardd->backend[i]; |
| 748 |
91 |
AN(sbe); |
| 749 |
91 |
be = sbe->backend; |
| 750 |
91 |
CHECK_OBJ_NOTNULL(be, DIRECTOR_MAGIC); |
| 751 |
|
|
| 752 |
91 |
c = 0; |
| 753 |
91 |
h = VRT_Healthy(ctx, be, &c); |
| 754 |
91 |
if (h) |
| 755 |
82 |
nh++; |
| 756 |
91 |
if (c > changed) |
| 757 |
70 |
changed = c; |
| 758 |
91 |
if ((pflag) == 0) |
| 759 |
75 |
continue; |
| 760 |
|
|
| 761 |
16 |
d = ctx->now - c; |
| 762 |
16 |
rampup_d = shardcfg_get_rampup(shardd, i); |
| 763 |
16 |
if (! h) { |
| 764 |
2 |
rampup_p = 0.0; |
| 765 |
2 |
rampup_d = 0.0; |
| 766 |
16 |
} else if (d < rampup_d) { |
| 767 |
6 |
rampup_p = d / rampup_d; |
| 768 |
6 |
rampup_d -= d; |
| 769 |
6 |
} else { |
| 770 |
8 |
rampup_p = 1.0; |
| 771 |
8 |
rampup_d = 0.0; |
| 772 |
|
} |
| 773 |
|
|
| 774 |
16 |
if (jflag) { |
| 775 |
4 |
if (i) |
| 776 |
3 |
VSB_cat(vsb, ",\n"); |
| 777 |
8 |
VSB_printf(vsb, "\"%s\": {\n", |
| 778 |
4 |
be->vcl_name); |
| 779 |
4 |
VSB_indent(vsb, 2); |
| 780 |
8 |
VSB_printf(vsb, "\"ident\": \"%s\",\n", |
| 781 |
4 |
sbe->ident ? sbe->ident : be->vcl_name); |
| 782 |
8 |
VSB_printf(vsb, "\"health\": \"%s\",\n", |
| 783 |
4 |
h ? "healthy" : "sick"); |
| 784 |
4 |
VSB_printf(vsb, "\"rampup\": %f,\n", rampup_p); |
| 785 |
8 |
VSB_printf(vsb, "\"rampup_remaining\": %.3f\n", |
| 786 |
4 |
rampup_d); |
| 787 |
4 |
VSB_indent(vsb, -2); |
| 788 |
4 |
VSB_cat(vsb, "}"); |
| 789 |
4 |
} else { |
| 790 |
24 |
VSB_printf(vsb, "\t%s\t%s\t%s\t%6.2f%% %8.3fs\n", |
| 791 |
12 |
be->vcl_name, |
| 792 |
12 |
sbe->ident ? sbe->ident : be->vcl_name, |
| 793 |
12 |
h ? "healthy" : "sick", |
| 794 |
12 |
rampup_p * 100, rampup_d); |
| 795 |
|
} |
| 796 |
16 |
} |
| 797 |
30 |
sharddir_unlock(shardd); |
| 798 |
|
|
| 799 |
30 |
if (jflag && (pflag)) { |
| 800 |
1 |
VSB_cat(vsb, "\n"); |
| 801 |
1 |
VSB_indent(vsb, -2); |
| 802 |
1 |
VSB_cat(vsb, "}\n"); |
| 803 |
1 |
VSB_indent(vsb, -2); |
| 804 |
1 |
VSB_cat(vsb, "},\n"); |
| 805 |
1 |
} |
| 806 |
|
|
| 807 |
30 |
if (pflag) |
| 808 |
4 |
return; |
| 809 |
|
|
| 810 |
26 |
if (jflag) |
| 811 |
4 |
VSB_printf(vsb, "[%u, %u, \"%s\"]", nh, i, |
| 812 |
2 |
nh ? "healthy" : "sick"); |
| 813 |
|
else |
| 814 |
24 |
VSB_printf(vsb, "%u/%u\t%s", nh, i, nh ? "healthy" : "sick"); |
| 815 |
30 |
} |
| 816 |
|
|
| 817 |
|
VCL_VOID v_matchproto_(td_directors_shard_backend) |
| 818 |
7 |
vmod_shard_debug(VRT_CTX, struct vmod_directors_shard *vshard, |
| 819 |
|
VCL_INT i) |
| 820 |
|
{ |
| 821 |
7 |
CHECK_OBJ_NOTNULL(vshard, VMOD_SHARD_SHARD_MAGIC); |
| 822 |
|
|
| 823 |
7 |
(void)ctx; |
| 824 |
7 |
sharddir_debug(vshard->shardd, i & UINT32_MAX); |
| 825 |
7 |
} |
| 826 |
|
|
| 827 |
|
/* ============================================================= |
| 828 |
|
* shard_param |
| 829 |
|
*/ |
| 830 |
|
|
| 831 |
|
VCL_VOID v_matchproto_(td_directors_shard_param__init) |
| 832 |
17 |
vmod_shard_param__init(VRT_CTX, |
| 833 |
|
struct vmod_directors_shard_param **pp, const char *vcl_name) |
| 834 |
|
{ |
| 835 |
|
struct vmod_directors_shard_param *p; |
| 836 |
|
|
| 837 |
17 |
(void) ctx; |
| 838 |
17 |
AN(pp); |
| 839 |
17 |
AZ(*pp); |
| 840 |
17 |
ALLOC_OBJ(p, VMOD_SHARD_SHARD_PARAM_MAGIC); |
| 841 |
17 |
AN(p); |
| 842 |
17 |
p->vcl_name = vcl_name; |
| 843 |
17 |
p->scope = SCOPE_VCL; |
| 844 |
17 |
p->defaults = &shard_param_default; |
| 845 |
|
|
| 846 |
17 |
*pp = p; |
| 847 |
17 |
} |
| 848 |
|
|
| 849 |
|
VCL_VOID v_matchproto_(td_directors_shard_param__fini) |
| 850 |
8 |
vmod_shard_param__fini(struct vmod_directors_shard_param **pp) |
| 851 |
|
{ |
| 852 |
|
struct vmod_directors_shard_param *p; |
| 853 |
|
|
| 854 |
8 |
TAKE_OBJ_NOTNULL(p, pp, VMOD_SHARD_SHARD_PARAM_MAGIC); |
| 855 |
8 |
FREE_OBJ(p); |
| 856 |
8 |
} |
| 857 |
|
|
| 858 |
|
/* |
| 859 |
|
* init a stack param struct defaulting to pa with the given name |
| 860 |
|
*/ |
| 861 |
|
static struct vmod_directors_shard_param * |
| 862 |
255 |
shard_param_stack(struct vmod_directors_shard_param *p, |
| 863 |
|
const struct vmod_directors_shard_param *pa, const char *who) |
| 864 |
|
{ |
| 865 |
255 |
CHECK_OBJ_NOTNULL(pa, VMOD_SHARD_SHARD_PARAM_MAGIC); |
| 866 |
255 |
assert(pa->scope > _SCOPE_INVALID); |
| 867 |
|
|
| 868 |
255 |
AN(p); |
| 869 |
255 |
INIT_OBJ(p, VMOD_SHARD_SHARD_PARAM_MAGIC); |
| 870 |
255 |
p->vcl_name = who; |
| 871 |
255 |
p->scope = SCOPE_STACK; |
| 872 |
255 |
p->defaults = pa; |
| 873 |
|
|
| 874 |
255 |
return (p); |
| 875 |
|
} |
| 876 |
|
|
| 877 |
|
static const struct vmod_directors_shard_param * |
| 878 |
259 |
shard_param_task_r(VRT_CTX, const void *id, const char *who, |
| 879 |
|
const struct vmod_directors_shard_param *pa) |
| 880 |
|
{ |
| 881 |
|
const struct vmod_directors_shard_param *p; |
| 882 |
|
const struct vmod_priv *task; |
| 883 |
|
const void *task_id; |
| 884 |
|
|
| 885 |
259 |
CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC); |
| 886 |
259 |
CHECK_OBJ_NOTNULL(pa, VMOD_SHARD_SHARD_PARAM_MAGIC); |
| 887 |
259 |
assert(pa->scope > _SCOPE_INVALID); |
| 888 |
|
|
| 889 |
259 |
task_id = (const char *)id + task_off_param; |
| 890 |
259 |
task = VRT_priv_task_get(ctx, task_id); |
| 891 |
|
|
| 892 |
259 |
if (task) { |
| 893 |
136 |
CAST_OBJ_NOTNULL(p, task->priv, VMOD_SHARD_SHARD_PARAM_MAGIC); |
| 894 |
136 |
assert(p->scope == SCOPE_TASK); |
| 895 |
136 |
assert(who == p->vcl_name); |
| 896 |
136 |
return (p); |
| 897 |
|
} |
| 898 |
|
|
| 899 |
123 |
if (id == pa || pa->scope != SCOPE_VCL) |
| 900 |
89 |
return (pa); |
| 901 |
|
|
| 902 |
34 |
return (shard_param_task_r(ctx, pa, pa->vcl_name, pa)); |
| 903 |
259 |
} |
| 904 |
|
|
| 905 |
|
/* |
| 906 |
|
* get a task scoped param struct for id defaulting to pa |
| 907 |
|
* if id != pa and pa has VCL scope, also get a task scoped param struct for pa |
| 908 |
|
*/ |
| 909 |
|
static struct vmod_directors_shard_param * |
| 910 |
98 |
shard_param_task_l(VRT_CTX, const void *id, const char *who, |
| 911 |
|
const struct vmod_directors_shard_param *pa) |
| 912 |
|
{ |
| 913 |
|
struct vmod_directors_shard_param *p; |
| 914 |
|
struct vmod_priv *task; |
| 915 |
|
const void *task_id; |
| 916 |
|
|
| 917 |
98 |
CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC); |
| 918 |
98 |
CHECK_OBJ_NOTNULL(pa, VMOD_SHARD_SHARD_PARAM_MAGIC); |
| 919 |
98 |
assert(pa->scope > _SCOPE_INVALID); |
| 920 |
|
|
| 921 |
98 |
task_id = (const char *)id + task_off_param; |
| 922 |
98 |
task = VRT_priv_task(ctx, task_id); |
| 923 |
|
|
| 924 |
98 |
if (task == NULL) { |
| 925 |
0 |
shard_fail(ctx, who, "%s", "no priv_task"); |
| 926 |
0 |
return (NULL); |
| 927 |
|
} |
| 928 |
|
|
| 929 |
98 |
if (task->priv) { |
| 930 |
8 |
CAST_OBJ_NOTNULL(p, task->priv, VMOD_SHARD_SHARD_PARAM_MAGIC); |
| 931 |
8 |
assert(p->scope == SCOPE_TASK); |
| 932 |
8 |
assert(who == p->vcl_name); |
| 933 |
8 |
return (p); |
| 934 |
|
} |
| 935 |
|
|
| 936 |
180 |
WS_TASK_ALLOC_OBJ(ctx, p, VMOD_SHARD_SHARD_PARAM_MAGIC); |
| 937 |
90 |
if (p == NULL) |
| 938 |
0 |
return (NULL); |
| 939 |
90 |
task->priv = p; |
| 940 |
90 |
p->vcl_name = who; |
| 941 |
90 |
p->scope = SCOPE_TASK; |
| 942 |
|
|
| 943 |
90 |
if (id == pa || pa->scope != SCOPE_VCL) |
| 944 |
88 |
p->defaults = pa; |
| 945 |
|
else |
| 946 |
2 |
p->defaults = shard_param_task_l(ctx, pa, pa->vcl_name, pa); |
| 947 |
|
|
| 948 |
90 |
if (p->defaults == NULL) |
| 949 |
0 |
return (NULL); |
| 950 |
|
|
| 951 |
90 |
return (p); |
| 952 |
98 |
} |
| 953 |
|
|
| 954 |
|
static struct vmod_directors_shard_param * |
| 955 |
103 |
shard_param_prep(VRT_CTX, struct vmod_directors_shard_param *p, |
| 956 |
|
const char *who) |
| 957 |
|
{ |
| 958 |
103 |
CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC); |
| 959 |
103 |
CHECK_OBJ_NOTNULL(p, VMOD_SHARD_SHARD_PARAM_MAGIC); |
| 960 |
|
|
| 961 |
103 |
if (ctx->method & SHARD_VCL_TASK_REQ) { |
| 962 |
0 |
shard_fail(ctx, p->vcl_name, "%s may only be used " |
| 963 |
|
"in vcl_init and in backend/pipe context", who); |
| 964 |
0 |
return (NULL); |
| 965 |
103 |
} else if (ctx->method & SHARD_VCL_TASK_BEREQ) |
| 966 |
88 |
p = shard_param_task_l(ctx, p, p->vcl_name, p); |
| 967 |
|
else |
| 968 |
15 |
assert(ctx->method & VCL_MET_TASK_H); |
| 969 |
|
|
| 970 |
103 |
return (p); |
| 971 |
103 |
} |
| 972 |
|
|
| 973 |
|
VCL_VOID v_matchproto_(td_directors_shard_param_set) |
| 974 |
98 |
vmod_shard_param_set(VRT_CTX, struct vmod_directors_shard_param *p, |
| 975 |
|
struct VARGS(shard_param_set) *a) |
| 976 |
|
{ |
| 977 |
98 |
uint32_t args = shard_param_set_mask(a); |
| 978 |
|
|
| 979 |
98 |
assert((args & ~arg_mask_set_) == 0); |
| 980 |
|
|
| 981 |
98 |
p = shard_param_prep(ctx, p, "shard_param.set()"); |
| 982 |
98 |
if (p == NULL) |
| 983 |
0 |
return; |
| 984 |
196 |
(void) shard_param_args(ctx, p, "shard_param.set()", args, |
| 985 |
98 |
a->by, a->key, a->key_blob, a->alt, a->warmup, |
| 986 |
98 |
a->rampup, a->healthy); |
| 987 |
98 |
} |
| 988 |
|
|
| 989 |
|
VCL_VOID v_matchproto_(td_directors_shard_param_clear) |
| 990 |
5 |
vmod_shard_param_clear(VRT_CTX, |
| 991 |
|
struct vmod_directors_shard_param *p) |
| 992 |
|
{ |
| 993 |
5 |
p = shard_param_prep(ctx, p, "shard_param.clear()"); |
| 994 |
5 |
if (p == NULL) |
| 995 |
0 |
return; |
| 996 |
5 |
p->mask = 0; |
| 997 |
5 |
} |
| 998 |
|
|
| 999 |
|
static const struct vmod_directors_shard_param * |
| 1000 |
165 |
vmod_shard_param_read(VRT_CTX, const void *id, const char *who, |
| 1001 |
|
const struct vmod_directors_shard_param *p, |
| 1002 |
|
struct vmod_directors_shard_param *pstk) |
| 1003 |
|
{ |
| 1004 |
|
struct vmod_directors_shard_param *pp; |
| 1005 |
|
|
| 1006 |
165 |
CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC); |
| 1007 |
165 |
CHECK_OBJ_NOTNULL(p, VMOD_SHARD_SHARD_PARAM_MAGIC); |
| 1008 |
|
|
| 1009 |
165 |
if (ctx->method == 0 || (ctx->method & SHARD_VCL_TASK_BEREQ)) |
| 1010 |
135 |
p = shard_param_task_r(ctx, id, who, p); |
| 1011 |
|
|
| 1012 |
165 |
CHECK_OBJ_NOTNULL(p, VMOD_SHARD_SHARD_PARAM_MAGIC); |
| 1013 |
165 |
pp = shard_param_stack(pstk, p, p->vcl_name); |
| 1014 |
165 |
shard_param_merge(pp, p); |
| 1015 |
165 |
return (pp); |
| 1016 |
|
} |
| 1017 |
|
|
| 1018 |
|
VCL_STRING v_matchproto_(td_directors_shard_param_get_by) |
| 1019 |
25 |
vmod_shard_param_get_by(VRT_CTX, |
| 1020 |
|
struct vmod_directors_shard_param *p) |
| 1021 |
|
{ |
| 1022 |
|
struct vmod_directors_shard_param pstk; |
| 1023 |
|
const struct vmod_directors_shard_param *pp; |
| 1024 |
|
|
| 1025 |
25 |
pp = vmod_shard_param_read(ctx, p, p->vcl_name, p, &pstk); |
| 1026 |
25 |
CHECK_OBJ_NOTNULL(pp, VMOD_SHARD_SHARD_PARAM_MAGIC); |
| 1027 |
25 |
return (default_by(pp->by)); |
| 1028 |
|
} |
| 1029 |
|
|
| 1030 |
|
VCL_INT v_matchproto_(td_directors_shard_param_get_key) |
| 1031 |
25 |
vmod_shard_param_get_key(VRT_CTX, |
| 1032 |
|
struct vmod_directors_shard_param *p) |
| 1033 |
|
{ |
| 1034 |
|
struct vmod_directors_shard_param pstk; |
| 1035 |
|
const struct vmod_directors_shard_param *pp; |
| 1036 |
|
|
| 1037 |
25 |
pp = vmod_shard_param_read(ctx, p, p->vcl_name, p, &pstk); |
| 1038 |
25 |
CHECK_OBJ_NOTNULL(pp, VMOD_SHARD_SHARD_PARAM_MAGIC); |
| 1039 |
25 |
return ((VCL_INT)shard_get_key(ctx, pp)); |
| 1040 |
|
} |
| 1041 |
|
VCL_INT v_matchproto_(td_directors_shard_param_get_alt) |
| 1042 |
25 |
vmod_shard_param_get_alt(VRT_CTX, |
| 1043 |
|
struct vmod_directors_shard_param *p) |
| 1044 |
|
{ |
| 1045 |
|
struct vmod_directors_shard_param pstk; |
| 1046 |
|
const struct vmod_directors_shard_param *pp; |
| 1047 |
|
|
| 1048 |
25 |
pp = vmod_shard_param_read(ctx, p, p->vcl_name, p, &pstk); |
| 1049 |
25 |
CHECK_OBJ_NOTNULL(pp, VMOD_SHARD_SHARD_PARAM_MAGIC); |
| 1050 |
25 |
return (pp->alt); |
| 1051 |
|
} |
| 1052 |
|
|
| 1053 |
|
VCL_REAL v_matchproto_(td_directors_shard_param_get_warmup) |
| 1054 |
25 |
vmod_shard_param_get_warmup(VRT_CTX, |
| 1055 |
|
struct vmod_directors_shard_param *p) |
| 1056 |
|
{ |
| 1057 |
|
struct vmod_directors_shard_param pstk; |
| 1058 |
|
const struct vmod_directors_shard_param *pp; |
| 1059 |
|
|
| 1060 |
25 |
pp = vmod_shard_param_read(ctx, p, p->vcl_name, p, &pstk); |
| 1061 |
25 |
CHECK_OBJ_NOTNULL(pp, VMOD_SHARD_SHARD_PARAM_MAGIC); |
| 1062 |
25 |
return (pp->warmup); |
| 1063 |
|
} |
| 1064 |
|
|
| 1065 |
|
VCL_BOOL v_matchproto_(td_directors_shard_param_get_rampup) |
| 1066 |
25 |
vmod_shard_param_get_rampup(VRT_CTX, |
| 1067 |
|
struct vmod_directors_shard_param *p) |
| 1068 |
|
{ |
| 1069 |
|
struct vmod_directors_shard_param pstk; |
| 1070 |
|
const struct vmod_directors_shard_param *pp; |
| 1071 |
|
|
| 1072 |
25 |
pp = vmod_shard_param_read(ctx, p, p->vcl_name, p, &pstk); |
| 1073 |
25 |
CHECK_OBJ_NOTNULL(pp, VMOD_SHARD_SHARD_PARAM_MAGIC); |
| 1074 |
25 |
return (pp->rampup); |
| 1075 |
|
} |
| 1076 |
|
|
| 1077 |
|
VCL_STRING v_matchproto_(td_directors_shard_param_get_healthy) |
| 1078 |
25 |
vmod_shard_param_get_healthy(VRT_CTX, |
| 1079 |
|
struct vmod_directors_shard_param *p) |
| 1080 |
|
{ |
| 1081 |
|
struct vmod_directors_shard_param pstk; |
| 1082 |
|
const struct vmod_directors_shard_param *pp; |
| 1083 |
|
|
| 1084 |
25 |
pp = vmod_shard_param_read(ctx, p, p->vcl_name, p, &pstk); |
| 1085 |
25 |
CHECK_OBJ_NOTNULL(pp, VMOD_SHARD_SHARD_PARAM_MAGIC); |
| 1086 |
25 |
return (default_healthy(pp->healthy)); |
| 1087 |
|
} |
| 1088 |
|
|
| 1089 |
|
static const struct vmod_directors_shard_param * |
| 1090 |
6 |
shard_param_blob(VCL_BLOB blob) |
| 1091 |
|
{ |
| 1092 |
|
const struct vmod_directors_shard_param *p; |
| 1093 |
|
|
| 1094 |
10 |
if (blob && blob->type == VMOD_SHARD_SHARD_PARAM_BLOB && |
| 1095 |
4 |
blob->blob != NULL && |
| 1096 |
4 |
blob->len == sizeof(struct vmod_directors_shard_param)) { |
| 1097 |
4 |
CAST_OBJ_NOTNULL(p, blob->blob, VMOD_SHARD_SHARD_PARAM_MAGIC); |
| 1098 |
4 |
return (p); |
| 1099 |
|
} |
| 1100 |
|
|
| 1101 |
2 |
return (NULL); |
| 1102 |
6 |
} |
| 1103 |
|
|
| 1104 |
|
VCL_BLOB v_matchproto_(td_directors_shard_param_use) |
| 1105 |
4 |
vmod_shard_param_use(VRT_CTX, |
| 1106 |
|
struct vmod_directors_shard_param *p) |
| 1107 |
|
{ |
| 1108 |
4 |
CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC); |
| 1109 |
4 |
CHECK_OBJ_NOTNULL(p, VMOD_SHARD_SHARD_PARAM_MAGIC); |
| 1110 |
|
|
| 1111 |
4 |
return (VRT_blob(ctx, "xshard_param.use()", p, sizeof *p, |
| 1112 |
|
VMOD_SHARD_SHARD_PARAM_BLOB)); |
| 1113 |
|
} |