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 3
VPFX(lookup)(VRT_CTX, VCL_STRING name)
49
{
50 3
        AN(ctx->method & VCL_MET_TASK_H);
51 3
        return (VRT_LookupDirector(ctx, name));
52
}
53
54
static void
55 99
vdir_expand(struct vdir *vd, unsigned n)
56
{
57 99
        CHECK_OBJ_NOTNULL(vd, VDIR_MAGIC);
58
59 99
        vd->backend = realloc(vd->backend, n * sizeof *vd->backend);
60 99
        AN(vd->backend);
61 99
        vd->weight = realloc(vd->weight, n * sizeof *vd->weight);
62 99
        AN(vd->weight);
63 99
        if (n > vd->healthy->nbits)
64 0
                vbit_expand(vd->healthy, n);
65 99
        AN(vd->healthy);
66 99
        vd->l_backend = n;
67 99
}
68
69
void
70 108
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 108
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
76 108
        CHECK_OBJ_NOTNULL(m, VDI_METHODS_MAGIC);
77 108
        AN(vcl_name);
78 108
        AN(vdp);
79 108
        AZ(*vdp);
80 108
        ALLOC_OBJ(vd, VDIR_MAGIC);
81 108
        AN(vd);
82 108
        *vdp = vd;
83 108
        PTOK(pthread_rwlock_init(&vd->mtx, NULL));
84 108
        vd->dir = VRT_AddDirector(ctx, m, priv, "%s", vcl_name);
85 108
        vd->healthy = vbit_new(8);
86 108
        AN(vd->healthy);
87 108
}
88
89
void
90 24
vdir_release(struct vdir *vd)
91
{
92
        unsigned u;
93
94 24
        CHECK_OBJ_NOTNULL(vd, VDIR_MAGIC);
95
96 24
        vdir_wrlock(vd);
97 60
        for (u = 0; u < vd->n_backend; u++)
98 36
                VRT_Assign_Backend(&vd->backend[u], NULL);
99 24
        vd->n_backend = 0;
100 24
        vdir_unlock(vd);
101 24
}
102
103
void
104 24
vdir_delete(struct vdir **vdp)
105
{
106
        struct vdir *vd;
107
108 24
        TAKE_OBJ_NOTNULL(vd, vdp, VDIR_MAGIC);
109
110 24
        AZ(vd->dir);
111 24
        AZ(vd->n_backend);
112 24
        free(vd->backend);
113 24
        free(vd->weight);
114 24
        PTOK(pthread_rwlock_destroy(&vd->mtx));
115 24
        vbit_destroy(vd->healthy);
116 24
        FREE_OBJ(vd);
117 24
}
118
119
void
120 471
vdir_rdlock(struct vdir *vd)
121
{
122 471
        CHECK_OBJ_NOTNULL(vd, VDIR_MAGIC);
123 471
        PTOK(pthread_rwlock_rdlock(&vd->mtx));
124 471
}
125
126
void
127 543
vdir_wrlock(struct vdir *vd)
128
{
129 543
        CHECK_OBJ_NOTNULL(vd, VDIR_MAGIC);
130 543
        PTOK(pthread_rwlock_wrlock(&vd->mtx));
131 543
}
132
133
void
134 1014
vdir_unlock(struct vdir *vd)
135
{
136 1014
        CHECK_OBJ_NOTNULL(vd, VDIR_MAGIC);
137 1014
        PTOK(pthread_rwlock_unlock(&vd->mtx));
138 1014
}
139
140
141
void
142 270
vdir_add_backend(VRT_CTX, struct vdir *vd, VCL_BACKEND be, double weight)
143
{
144
        unsigned u;
145
146 270
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
147 270
        CHECK_OBJ_NOTNULL(vd, VDIR_MAGIC);
148 270
        if (be == NULL) {
149 18
                VRT_fail(ctx, "%s: None backend cannot be added",
150 9
                    VRT_BACKEND_string(vd->dir));
151 9
                return;
152
        }
153 261
        AN(be);
154 261
        vdir_wrlock(vd);
155 261
        if (vd->n_backend >= vd->l_backend)
156 99
                vdir_expand(vd, vd->l_backend + 16);
157 261
        assert(vd->n_backend < vd->l_backend);
158 261
        u = vd->n_backend++;
159 261
        vd->backend[u] = NULL;
160 261
        VRT_Assign_Backend(&vd->backend[u], be);
161 261
        vd->weight[u] = weight;
162 261
        vdir_unlock(vd);
163 270
}
164
165
void
166 36
vdir_remove_backend(VRT_CTX, struct vdir *vd, VCL_BACKEND be, unsigned *cur)
167
{
168
        unsigned u, n;
169
170 36
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
171 36
        CHECK_OBJ_NOTNULL(vd, VDIR_MAGIC);
172 36
        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 36
        CHECK_OBJ(be, DIRECTOR_MAGIC);
178 36
        vdir_wrlock(vd);
179 51
        for (u = 0; u < vd->n_backend; u++)
180 51
                if (vd->backend[u] == be)
181 36
                        break;
182 36
        if (u == vd->n_backend) {
183 0
                vdir_unlock(vd);
184 0
                return;
185
        }
186 36
        VRT_Assign_Backend(&vd->backend[u], NULL);
187 36
        n = (vd->n_backend - u) - 1;
188 36
        memmove(&vd->backend[u], &vd->backend[u+1], n * sizeof(vd->backend[0]));
189 36
        memmove(&vd->weight[u], &vd->weight[u+1], n * sizeof(vd->weight[0]));
190 36
        vd->n_backend--;
191
192 36
        if (cur) {
193 12
                assert(*cur <= vd->n_backend);
194 12
                if (u < *cur)
195 3
                        (*cur)--;
196 9
                else if (*cur == vd->n_backend)
197 3
                        *cur = 0;
198 12
        }
199 36
        vdir_unlock(vd);
200 36
}
201
202
VCL_BOOL
203 147
vdir_any_healthy(VRT_CTX, struct vdir *vd, VCL_TIME *changed)
204
{
205 147
        unsigned retval = 0;
206
        VCL_BACKEND be;
207
        unsigned u;
208
        vtim_real c;
209
210 147
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
211 147
        CHECK_OBJ_NOTNULL(vd, VDIR_MAGIC);
212 147
        vdir_rdlock(vd);
213 147
        if (changed != NULL)
214 30
                *changed = 0;
215 210
        for (u = 0; u < vd->n_backend; u++) {
216 189
                be = vd->backend[u];
217 189
                CHECK_OBJ_NOTNULL(be, DIRECTOR_MAGIC);
218 189
                retval = VRT_Healthy(ctx, be, &c);
219 189
                if (changed != NULL && c > *changed)
220 39
                        *changed = c;
221 189
                if (retval)
222 126
                        break;
223 63
        }
224 147
        vdir_unlock(vd);
225 147
        return (retval);
226
}
227
228
void
229 156
vdir_list(VRT_CTX, struct vdir *vd, struct vsb *vsb, int pflag, int jflag,
230
    int weight)
231
{
232
        VCL_BACKEND be;
233
        VCL_BOOL h;
234
        unsigned u, nh;
235
        double w;
236
237 156
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
238 156
        CHECK_OBJ_NOTNULL(vd, VDIR_MAGIC);
239
240 156
        if (pflag) {
241 24
                if (jflag) {
242 12
                        VSB_cat(vsb, "{\n");
243 12
                        VSB_indent(vsb, 2);
244 12
                        if (weight)
245 6
                                VSB_printf(vsb, "\"total_weight\": %f,\n",
246 3
                                    vd->total_weight);
247 12
                        VSB_cat(vsb, "\"backends\": {\n");
248 12
                        VSB_indent(vsb, 2);
249 12
                } else {
250 12
                        VSB_cat(vsb, "\n\n\tBackend\tWeight\tHealth\n");
251
                }
252 24
        }
253
254 156
        vdir_rdlock(vd);
255 156
        vdir_update_health(ctx, vd);
256 222
        for (u = 0; pflag && u < vd->n_backend; u++) {
257 66
                be = vd->backend[u];
258 66
                CHECK_OBJ_NOTNULL(be, DIRECTOR_MAGIC);
259
260 66
                h = vbit_test(vd->healthy, u);
261
262 66
                w = h ? vd->weight[u] : 0.0;
263
264 66
                if (jflag) {
265 33
                        if (u)
266 21
                                VSB_cat(vsb, ",\n");
267 33
                        VSB_printf(vsb, "\"%s\": {\n", be->vcl_name);
268 33
                        VSB_indent(vsb, 2);
269
270 33
                        if (weight)
271 12
                                VSB_printf(vsb, "\"weight\": %f,\n", w);
272
273 33
                        if (h)
274 24
                                VSB_cat(vsb, "\"health\": \"healthy\"\n");
275
                        else
276 9
                                VSB_cat(vsb, "\"health\": \"sick\"\n");
277
278 33
                        VSB_indent(vsb, -2);
279 33
                        VSB_cat(vsb, "}");
280 33
                } else {
281 33
                        VSB_cat(vsb, "\t");
282 33
                        VSB_cat(vsb, be->vcl_name);
283 33
                        if (weight)
284 24
                                VSB_printf(vsb, "\t%6.2f%%\t",
285 12
                                    100 * w / vd->total_weight);
286
                        else
287 21
                                VSB_cat(vsb, "\t-\t");
288 33
                        VSB_cat(vsb, h ? "healthy" : "sick");
289 33
                        VSB_cat(vsb, "\n");
290
                }
291 66
        }
292 156
        nh = vd->n_healthy;
293 156
        u = vd->n_backend;
294 156
        vdir_unlock(vd);
295
296 156
        if (jflag && (pflag)) {
297 12
                VSB_cat(vsb, "\n");
298 12
                VSB_indent(vsb, -2);
299 12
                VSB_cat(vsb, "}\n");
300 12
                VSB_indent(vsb, -2);
301 12
                VSB_cat(vsb, "},\n");
302 12
        }
303
304 156
        if (pflag)
305 24
                return;
306
307 132
        if (jflag)
308 60
                VSB_printf(vsb, "[%u, %u, \"%s\"]", nh, u,
309 30
                    nh ? "healthy" : "sick");
310
        else
311 102
                VSB_printf(vsb, "%u/%u\t%s", nh, u, nh ? "healthy" : "sick");
312 156
}
313
314
/*
315
 * iterate backends and update
316
 * - healthy bitmap
317
 * - number of healthy backends
318
 * - total_weight
319
 * - last change time of the VCL_BACKEND
320
 *
321
 * must be called under the vdir lock (read or write).
322
 *
323
 * A write lock is required if consistency between the individual attributes is
324
 * a must, e.g. when total_weight is required to be the exact sum of the weights
325
 *
326
 * The read lock is safe because add_backend expands the healthy bitmap and all
327
 * other members are atomic and may be used if consistency is not required.
328
 */
329
void
330 336
vdir_update_health(VRT_CTX, struct vdir *vd)
331
{
332 336
        VCL_TIME c, changed = 0;
333
        VCL_BOOL h;
334
        VCL_BACKEND be;
335 336
        unsigned u, nh = 0;
336 336
        double tw = 0.0;
337
        struct vbitmap *healthy;
338
339 336
        CHECK_OBJ_NOTNULL(vd, VDIR_MAGIC);
340 336
        healthy = vd->healthy;
341 1122
        for (u = 0; u < vd->n_backend; u++) {
342 786
                be = vd->backend[u];
343 786
                CHECK_OBJ_NOTNULL(be, DIRECTOR_MAGIC);
344 786
                c = 0;
345 786
                h = VRT_Healthy(ctx, be, &c);
346 786
                if (h) {
347 609
                        nh++;
348 609
                        tw += vd->weight[u];
349 609
                }
350 786
                if (c > changed)
351 756
                        changed = c;
352 786
                if (h != vbit_test(healthy, u)) {
353 402
                        if (h)
354 396
                                vbit_set(healthy, u);
355
                        else
356 6
                                vbit_clr(healthy, u);
357 402
                }
358 786
        }
359 336
        VRT_SetChanged(vd->dir, changed);
360 336
        vd->total_weight = tw;
361 336
        vd->n_healthy = nh;
362 336
}
363
364
static unsigned
365 138
vdir_pick_by_weight(const struct vdir *vd, double w)
366
{
367 138
        const struct vbitmap *healthy = vd->healthy;
368 138
        double a = 0.0;
369
        unsigned u;
370
371 138
        AN(healthy);
372 212
        for (u = 0; u < vd->n_backend; u++) {
373 212
                if (! vbit_test(healthy, u))
374 12
                        continue;
375 200
                a += vd->weight[u];
376 200
                if (w < a)
377 138
                        return (u);
378 62
        }
379 0
        WRONG("");
380
}
381
382
VCL_BACKEND
383 141
vdir_pick_be(VRT_CTX, struct vdir *vd, double w)
384
{
385
        unsigned u;
386 141
        VCL_BACKEND be = NULL;
387
388 141
        CHECK_OBJ_NOTNULL(ctx, VRT_CTX_MAGIC);
389 141
        CHECK_OBJ_NOTNULL(vd, VDIR_MAGIC);
390 141
        vdir_wrlock(vd);
391 141
        vdir_update_health(ctx, vd);
392 141
        if (vd->total_weight > 0.0) {
393 138
                u = vdir_pick_by_weight(vd, w * vd->total_weight);
394 138
                assert(u < vd->n_backend);
395 138
                be = vd->backend[u];
396 138
                CHECK_OBJ_NOTNULL(be, DIRECTOR_MAGIC);
397 138
        }
398 141
        vdir_unlock(vd);
399 141
        return (be);
400
}