vinyl-cache/vmod/vmod_directors.c
0
/*-
1
 * Copyright (c) 2013-2015 Varnish Software AS
2
 * Copyright 2019 UPLEX - Nils Goroll Systemoptimierung
3
 * All rights reserved.
4
 *
5
 * Author: Poul-Henning Kamp <phk@FreeBSD.org>
6
 * Author: Nils Goroll <nils.goroll@uplex.de>
7
 *
8
 * SPDX-License-Identifier: BSD-2-Clause
9
 *
10
 * Redistribution and use in source and binary forms, with or without
11
 * modification, are permitted provided that the following conditions
12
 * are met:
13
 * 1. Redistributions of source code must retain the above copyright
14
 *    notice, this list of conditions and the following disclaimer.
15
 * 2. Redistributions in binary form must reproduce the above copyright
16
 *    notice, this list of conditions and the following disclaimer in the
17
 *    documentation and/or other materials provided with the distribution.
18
 *
19
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22
 * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
23
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29
 * SUCH DAMAGE.
30
 */
31
32
#include "config.h"
33
34
#include <stdlib.h>
35
#include <stdio.h>
36
37
#include "cache/cache.h"
38
39
#include "vbm.h"
40
#include "vcl.h"
41
#include "vsb.h"
42
43
#include "vcc_directors_if.h"
44
45
#include "vmod_directors.h"
46
47
VCL_BACKEND
48 21
VPFX(lookup)(VRT_CTX, VCL_STRING name)
49
{
50 21
        AN(ctx->method & VCL_MET_TASK_H);
51 21
        return (VRT_LookupDirector(ctx, name));
52
}
53
54
static void
55 693
vdir_expand(struct vdir *vd, unsigned n)
56
{
57 693
        CHECK_OBJ_NOTNULL(vd, VDIR_MAGIC);
58
59 693
        vd->backend = realloc(vd->backend, n * sizeof *vd->backend);
60 693
        AN(vd->backend);
61 693
        vd->weight = realloc(vd->weight, n * sizeof *vd->weight);
62 693
        AN(vd->weight);
63 693
        if (n > vd->healthy->nbits)
64 0
                vbit_expand(vd->healthy, n);
65 693
        AN(vd->healthy);
66 693
        vd->l_backend = n;
67 693
}
68
69
void
70 756
vdir_new(VRT_CTX, struct vdir **vdp, const char *vcl_name,
71
    const struct vdi_methods *m, void *priv)
72
{
73
        struct vdir *vd;
74
75 756
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
76 756
        CHECK_OBJ_NOTNULL(m, VDI_METHODS_MAGIC);
77 756
        AN(vcl_name);
78 756
        AN(vdp);
79 756
        AZ(*vdp);
80 756
        ALLOC_OBJ(vd, VDIR_MAGIC);
81 756
        AN(vd);
82 756
        *vdp = vd;
83 756
        PTOK(pthread_rwlock_init(&vd->mtx, NULL));
84 756
        vd->dir = VRT_AddDirector(ctx, m, priv, "%s", vcl_name);
85 756
        vd->healthy = vbit_new(8);
86 756
        AN(vd->healthy);
87 756
}
88
89
void
90 168
vdir_release(struct vdir *vd)
91
{
92
        unsigned u;
93
94 168
        CHECK_OBJ_NOTNULL(vd, VDIR_MAGIC);
95
96 168
        vdir_wrlock(vd);
97 420
        for (u = 0; u < vd->n_backend; u++)
98 252
                VRT_Assign_Backend(&vd->backend[u], NULL);
99 168
        vd->n_backend = 0;
100 168
        vdir_unlock(vd);
101 168
}
102
103
void
104 168
vdir_delete(struct vdir **vdp)
105
{
106
        struct vdir *vd;
107
108 168
        TAKE_OBJ_NOTNULL(vd, vdp, VDIR_MAGIC);
109
110 168
        AZ(vd->dir);
111 168
        AZ(vd->n_backend);
112 168
        free(vd->backend);
113 168
        free(vd->weight);
114 168
        PTOK(pthread_rwlock_destroy(&vd->mtx));
115 168
        vbit_destroy(vd->healthy);
116 168
        FREE_OBJ(vd);
117 168
}
118
119
void
120 3297
vdir_rdlock(struct vdir *vd)
121
{
122 3297
        CHECK_OBJ_NOTNULL(vd, VDIR_MAGIC);
123 3297
        PTOK(pthread_rwlock_rdlock(&vd->mtx));
124 3297
}
125
126
void
127 3801
vdir_wrlock(struct vdir *vd)
128
{
129 3801
        CHECK_OBJ_NOTNULL(vd, VDIR_MAGIC);
130 3801
        PTOK(pthread_rwlock_wrlock(&vd->mtx));
131 3801
}
132
133
void
134 7098
vdir_unlock(struct vdir *vd)
135
{
136 7098
        CHECK_OBJ_NOTNULL(vd, VDIR_MAGIC);
137 7098
        PTOK(pthread_rwlock_unlock(&vd->mtx));
138 7098
}
139
140
141
void
142 1890
vdir_add_backend(VRT_CTX, struct vdir *vd, VCL_BACKEND be, double weight)
143
{
144
        unsigned u;
145
146 1890
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
147 1890
        CHECK_OBJ_NOTNULL(vd, VDIR_MAGIC);
148 1890
        if (be == NULL) {
149 126
                VRT_fail(ctx, "%s: None backend cannot be added",
150 63
                    VRT_BACKEND_string(vd->dir));
151 63
                return;
152
        }
153 1827
        AN(be);
154 1827
        vdir_wrlock(vd);
155 1827
        if (vd->n_backend >= vd->l_backend)
156 693
                vdir_expand(vd, vd->l_backend + 16);
157 1827
        assert(vd->n_backend < vd->l_backend);
158 1827
        u = vd->n_backend++;
159 1827
        vd->backend[u] = NULL;
160 1827
        VRT_Assign_Backend(&vd->backend[u], be);
161 1827
        vd->weight[u] = weight;
162 1827
        vdir_unlock(vd);
163 1890
}
164
165
void
166 252
vdir_remove_backend(VRT_CTX, struct vdir *vd, VCL_BACKEND be, unsigned *cur)
167
{
168
        unsigned u, n;
169
170 252
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
171 252
        CHECK_OBJ_NOTNULL(vd, VDIR_MAGIC);
172 252
        if (be == NULL) {
173 0
                VRT_fail(ctx, "%s: None backend cannot be removed",
174 0
                    VRT_BACKEND_string(vd->dir));
175 0
                return;
176
        }
177 252
        CHECK_OBJ(be, DIRECTOR_MAGIC);
178 252
        vdir_wrlock(vd);
179 357
        for (u = 0; u < vd->n_backend; u++)
180 357
                if (vd->backend[u] == be)
181 252
                        break;
182 252
        if (u == vd->n_backend) {
183 0
                vdir_unlock(vd);
184 0
                return;
185
        }
186 252
        VRT_Assign_Backend(&vd->backend[u], NULL);
187 252
        n = (vd->n_backend - u) - 1;
188 252
        vmemmove(&vd->backend[u], &vd->backend[u + 1],
189
                 n * sizeof(vd->backend[0]));
190 252
        vmemmove(&vd->weight[u], &vd->weight[u + 1],
191
                 n * sizeof(vd->weight[0]));
192 252
        vd->n_backend--;
193
194 252
        if (cur) {
195 84
                assert(*cur <= vd->n_backend);
196 84
                if (u < *cur)
197 21
                        (*cur)--;
198 63
                else if (*cur == vd->n_backend)
199 21
                        *cur = 0;
200 84
        }
201 252
        vdir_unlock(vd);
202 252
}
203
204
VCL_BOOL
205 1029
vdir_any_healthy(VRT_CTX, struct vdir *vd, VCL_TIME *changed)
206
{
207 1029
        unsigned retval = 0;
208
        VCL_BACKEND be;
209
        unsigned u;
210
        vtim_real c;
211
212 1029
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
213 1029
        CHECK_OBJ_NOTNULL(vd, VDIR_MAGIC);
214 1029
        vdir_rdlock(vd);
215 1029
        if (changed != NULL)
216 210
                *changed = 0;
217 1470
        for (u = 0; u < vd->n_backend; u++) {
218 1323
                be = vd->backend[u];
219 1323
                CHECK_OBJ_NOTNULL(be, DIRECTOR_MAGIC);
220 1323
                retval = VRT_Healthy(ctx, be, &c);
221 1323
                if (changed != NULL && c > *changed)
222 273
                        *changed = c;
223 1323
                if (retval)
224 882
                        break;
225 441
        }
226 1029
        vdir_unlock(vd);
227 1029
        return (retval);
228
}
229
230
void
231 1092
vdir_list(VRT_CTX, struct vdir *vd, struct vsb *vsb, int pflag, int jflag,
232
    int weight)
233
{
234
        VCL_BACKEND be;
235
        VCL_BOOL h;
236
        unsigned u, nh;
237
        double w;
238
239 1092
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
240 1092
        CHECK_OBJ_NOTNULL(vd, VDIR_MAGIC);
241
242 1092
        if (pflag) {
243 168
                if (jflag) {
244 84
                        VSB_cat(vsb, "{\n");
245 84
                        VSB_indent(vsb, 2);
246 84
                        if (weight)
247 42
                                VSB_printf(vsb, "\"total_weight\": %f,\n",
248 21
                                    vd->total_weight);
249 84
                        VSB_cat(vsb, "\"backends\": {\n");
250 84
                        VSB_indent(vsb, 2);
251 84
                } else {
252 84
                        VSB_cat(vsb, "\n\n\tBackend\tWeight\tHealth\n");
253
                }
254 168
        }
255
256 1092
        vdir_rdlock(vd);
257 1092
        vdir_update_health(ctx, vd);
258 1554
        for (u = 0; pflag && u < vd->n_backend; u++) {
259 462
                be = vd->backend[u];
260 462
                CHECK_OBJ_NOTNULL(be, DIRECTOR_MAGIC);
261
262 462
                h = vbit_test(vd->healthy, u);
263
264 462
                w = h ? vd->weight[u] : 0.0;
265
266 462
                if (jflag) {
267 231
                        if (u)
268 147
                                VSB_cat(vsb, ",\n");
269 231
                        VSB_printf(vsb, "\"%s\": {\n", be->vcl_name);
270 231
                        VSB_indent(vsb, 2);
271
272 231
                        if (weight)
273 84
                                VSB_printf(vsb, "\"weight\": %f,\n", w);
274
275 231
                        if (h)
276 168
                                VSB_cat(vsb, "\"health\": \"healthy\"\n");
277
                        else
278 63
                                VSB_cat(vsb, "\"health\": \"sick\"\n");
279
280 231
                        VSB_indent(vsb, -2);
281 231
                        VSB_cat(vsb, "}");
282 231
                } else {
283 231
                        VSB_cat(vsb, "\t");
284 231
                        VSB_cat(vsb, be->vcl_name);
285 231
                        if (weight)
286 168
                                VSB_printf(vsb, "\t%6.2f%%\t",
287 84
                                    100 * w / vd->total_weight);
288
                        else
289 147
                                VSB_cat(vsb, "\t-\t");
290 231
                        VSB_cat(vsb, h ? "healthy" : "sick");
291 231
                        VSB_cat(vsb, "\n");
292
                }
293 462
        }
294 1092
        nh = vd->n_healthy;
295 1092
        u = vd->n_backend;
296 1092
        vdir_unlock(vd);
297
298 1092
        if (jflag && (pflag)) {
299 84
                VSB_cat(vsb, "\n");
300 84
                VSB_indent(vsb, -2);
301 84
                VSB_cat(vsb, "}\n");
302 84
                VSB_indent(vsb, -2);
303 84
                VSB_cat(vsb, "},\n");
304 84
        }
305
306 1092
        if (pflag)
307 168
                return;
308
309 924
        if (jflag)
310 420
                VSB_printf(vsb, "[%u, %u, \"%s\"]", nh, u,
311 210
                    nh ? "healthy" : "sick");
312
        else
313 714
                VSB_printf(vsb, "%u/%u\t%s", nh, u, nh ? "healthy" : "sick");
314 1092
}
315
316
/*
317
 * iterate backends and update
318
 * - healthy bitmap
319
 * - number of healthy backends
320
 * - total_weight
321
 * - last change time of the VCL_BACKEND
322
 *
323
 * must be called under the vdir lock (read or write).
324
 *
325
 * A write lock is required if consistency between the individual attributes is
326
 * a must, e.g. when total_weight is required to be the exact sum of the weights
327
 *
328
 * The read lock is safe because add_backend expands the healthy bitmap and all
329
 * other members are atomic and may be used if consistency is not required.
330
 */
331
void
332 2352
vdir_update_health(VRT_CTX, struct vdir *vd)
333
{
334 2352
        VCL_TIME c, changed = 0;
335
        VCL_BOOL h;
336
        VCL_BACKEND be;
337 2352
        unsigned u, nh = 0;
338 2352
        double tw = 0.0;
339
        struct vbitmap *healthy;
340
341 2352
        CHECK_OBJ_NOTNULL(vd, VDIR_MAGIC);
342 2352
        healthy = vd->healthy;
343 7854
        for (u = 0; u < vd->n_backend; u++) {
344 5502
                be = vd->backend[u];
345 5502
                CHECK_OBJ_NOTNULL(be, DIRECTOR_MAGIC);
346 5502
                c = 0;
347 5502
                h = VRT_Healthy(ctx, be, &c);
348 5502
                if (h) {
349 4263
                        nh++;
350 4263
                        tw += vd->weight[u];
351 4263
                }
352 5502
                if (c > changed)
353 5292
                        changed = c;
354 5502
                if (h != vbit_test(healthy, u)) {
355 2814
                        if (h)
356 2772
                                vbit_set(healthy, u);
357
                        else
358 42
                                vbit_clr(healthy, u);
359 2814
                }
360 5502
        }
361 2352
        VRT_SetChanged(vd->dir, changed);
362 2352
        vd->total_weight = tw;
363 2352
        vd->n_healthy = nh;
364 2352
}
365
366
static unsigned
367 966
vdir_pick_by_weight(const struct vdir *vd, double w)
368
{
369 966
        const struct vbitmap *healthy = vd->healthy;
370 966
        double a = 0.0;
371
        unsigned u;
372
373 966
        AN(healthy);
374 1470
        for (u = 0; u < vd->n_backend; u++) {
375 1470
                if (! vbit_test(healthy, u))
376 84
                        continue;
377 1386
                a += vd->weight[u];
378 1386
                if (w < a)
379 966
                        return (u);
380 420
        }
381 0
        WRONG("");
382
}
383
384
VCL_BACKEND
385 987
vdir_pick_be(VRT_CTX, struct vdir *vd, double w)
386
{
387
        unsigned u;
388 987
        VCL_BACKEND be = NULL;
389
390 987
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
391 987
        CHECK_OBJ_NOTNULL(vd, VDIR_MAGIC);
392 987
        vdir_wrlock(vd);
393 987
        vdir_update_health(ctx, vd);
394 987
        if (vd->total_weight > 0.0) {
395 966
                u = vdir_pick_by_weight(vd, w * vd->total_weight);
396 966
                assert(u < vd->n_backend);
397 966
                be = vd->backend[u];
398 966
                CHECK_OBJ_NOTNULL(be, DIRECTOR_MAGIC);
399 966
        }
400 987
        vdir_unlock(vd);
401 987
        return (be);
402
}