varnish-cache/bin/varnishd/cache/cache_ban.c
0
/*-
1
 * Copyright (c) 2006 Verdens Gang AS
2
 * Copyright (c) 2006-2015 Varnish Software AS
3
 * All rights reserved.
4
 *
5
 * Author: Poul-Henning Kamp <phk@phk.freebsd.dk>
6
 *
7
 * SPDX-License-Identifier: BSD-2-Clause
8
 *
9
 * Redistribution and use in source and binary forms, with or without
10
 * modification, are permitted provided that the following conditions
11
 * are met:
12
 * 1. Redistributions of source code must retain the above copyright
13
 *    notice, this list of conditions and the following disclaimer.
14
 * 2. Redistributions in binary form must reproduce the above copyright
15
 *    notice, this list of conditions and the following disclaimer in the
16
 *    documentation and/or other materials provided with the distribution.
17
 *
18
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21
 * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
22
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28
 * SUCH DAMAGE.
29
 *
30
 */
31
32
#include "config.h"
33
34
#include <stdlib.h>
35
#include <stdio.h>
36
37
#include "cache_varnishd.h"
38
#include "cache_ban.h"
39
#include "cache_objhead.h"
40
41
#include "vcli_serve.h"
42
#include "vend.h"
43
#include "vmb.h"
44
45
/* cache_ban_build.c */
46
void BAN_Build_Init(void);
47
void BAN_Build_Fini(void);
48
49
struct lock ban_mtx;
50
int ban_shutdown;
51
struct banhead_s ban_head = VTAILQ_HEAD_INITIALIZER(ban_head);
52
struct ban * volatile ban_start;
53
54
static pthread_t ban_thread;
55
static int ban_holds;
56
uint64_t bans_persisted_bytes;
57
uint64_t bans_persisted_fragmentation;
58
59
struct ban_test {
60
        uint8_t                 oper;
61
        uint8_t                 arg1;
62
        const char              *arg1_spec;
63
        const char              *arg2;
64
        double                  arg2_double;
65
        const void              *arg2_spec;
66
};
67
68
static const char * const arg_name[BAN_ARGARRSZ + 1] = {
69
#define PVAR(a, b, c) [BAN_ARGIDX(c)] = (a),
70
#include "tbl/ban_vars.h"
71
        [BAN_ARGARRSZ] = NULL
72
};
73
74
/*--------------------------------------------------------------------
75
 * Storage handling of bans
76
 */
77
78
static struct ban *
79 650
ban_alloc(void)
80
{
81
        struct ban *b;
82
83 650
        ALLOC_OBJ(b, BAN_MAGIC);
84 650
        if (b != NULL)
85 650
                VTAILQ_INIT(&b->objcore);
86 650
        return (b);
87
}
88
89
void
90 1750
BAN_Free(struct ban *b)
91
{
92
93 1750
        CHECK_OBJ_NOTNULL(b, BAN_MAGIC);
94 1750
        AZ(b->refcount);
95 1750
        assert(VTAILQ_EMPTY(&b->objcore));
96
97 1750
        if (b->spec != NULL)
98 1750
                free(b->spec);
99 1750
        FREE_OBJ(b);
100 1750
}
101
102
/*--------------------------------------------------------------------
103
 * Get/release holds which prevent the ban_lurker from starting.
104
 * Holds are held while stevedores load zombie objects.
105
 */
106
107
void
108 950
BAN_Hold(void)
109
{
110
111 950
        Lck_Lock(&ban_mtx);
112
        /* Once holds are released, we allow no more */
113 950
        assert(ban_holds > 0);
114 950
        ban_holds++;
115 950
        Lck_Unlock(&ban_mtx);
116 950
}
117
118
void
119 23094
BAN_Release(void)
120
{
121
122 23094
        Lck_Lock(&ban_mtx);
123 23094
        assert(ban_holds > 0);
124 23094
        ban_holds--;
125 23094
        Lck_Unlock(&ban_mtx);
126 23094
        if (ban_holds == 0)
127 22144
                WRK_BgThread(&ban_thread, "ban-lurker", ban_lurker, NULL);
128 23094
}
129
130
/*--------------------------------------------------------------------
131
 * Extract time and length from ban-spec
132
 */
133
134
vtim_real
135 20650
ban_time(const uint8_t *banspec)
136
{
137
        vtim_real t;
138
        uint64_t u;
139
140 20650
        assert(sizeof t == sizeof u);
141 20650
        assert(sizeof t == (BANS_LENGTH - BANS_TIMESTAMP));
142 20650
        u = vbe64dec(banspec + BANS_TIMESTAMP);
143 20650
        memcpy(&t, &u, sizeof t);
144 20650
        return (t);
145
}
146
147
unsigned
148 140226
ban_len(const uint8_t *banspec)
149
{
150
        unsigned u;
151
152 140226
        u = vbe32dec(banspec + BANS_LENGTH);
153 140226
        return (u);
154
}
155
156
int
157 5525
ban_equal(const uint8_t *bs1, const uint8_t *bs2)
158
{
159
        unsigned u;
160
161
        /*
162
         * Compare two ban-strings.
163
         */
164 5525
        u = ban_len(bs1);
165 5525
        if (u != ban_len(bs2))
166 1225
                return (0);
167 4300
        if (bs1[BANS_FLAGS] & BANS_FLAG_NODEDUP)
168 125
                return (0);
169
170 4175
        return (!memcmp(bs1 + BANS_LENGTH, bs2 + BANS_LENGTH, u - BANS_LENGTH));
171 5525
}
172
173
void
174 23369
ban_mark_completed(struct ban *b)
175
{
176
        unsigned ln;
177
178 23369
        CHECK_OBJ_NOTNULL(b, BAN_MAGIC);
179 23369
        Lck_AssertHeld(&ban_mtx);
180
181 23369
        AN(b->spec);
182 23369
        if (!(b->flags & BANS_FLAG_COMPLETED)) {
183 23369
                ln = ban_len(b->spec);
184 23369
                b->flags |= BANS_FLAG_COMPLETED;
185 23369
                b->spec[BANS_FLAGS] |= BANS_FLAG_COMPLETED;
186 23369
                VWMB();
187 23369
                vbe32enc(b->spec + BANS_LENGTH, BANS_HEAD_LEN);
188 23369
                VSC_C_main->bans_completed++;
189 23369
                bans_persisted_fragmentation += ln - ban_len(b->spec);
190 23369
                VSC_C_main->bans_persisted_fragmentation =
191 23369
                    bans_persisted_fragmentation;
192 23369
        }
193 23369
}
194
195
/*--------------------------------------------------------------------
196
 * Access a lump of bytes in a ban test spec
197
 */
198
199
static const void *
200 8875
ban_get_lump(const uint8_t **bs)
201
{
202
        const void *r;
203
        unsigned ln;
204
205 53925
        while (**bs == 0xff)
206 45050
                *bs += 1;
207 8875
        ln = vbe32dec(*bs);
208 8875
        *bs += PRNDUP(sizeof(uint32_t));
209 8875
        assert(PAOK(*bs));
210 8875
        r = (const void*)*bs;
211 8875
        *bs += ln;
212 8875
        return (r);
213
}
214
215
/*--------------------------------------------------------------------
216
 * Pick a test apart from a spec string
217
 */
218
219
static void
220 7625
ban_iter(const uint8_t **bs, struct ban_test *bt)
221
{
222
        uint64_t dtmp;
223
224 7625
        memset(bt, 0, sizeof *bt);
225 7625
        bt->arg2_double = nan("");
226 7625
        bt->arg1 = *(*bs)++;
227 7625
        if (BANS_HAS_ARG1_SPEC(bt->arg1)) {
228 2425
                bt->arg1_spec = (const char *)*bs;
229 2425
                (*bs) += (*bs)[0] + 2;
230 2425
        }
231 7625
        if (BANS_HAS_ARG2_DOUBLE(bt->arg1)) {
232 3175
                dtmp = vbe64dec(ban_get_lump(bs));
233 3175
                bt->oper = *(*bs)++;
234
235 3175
                memcpy(&bt->arg2_double, &dtmp, sizeof dtmp);
236 3175
                return;
237
        }
238 4450
        bt->arg2 = ban_get_lump(bs);
239 4450
        bt->oper = *(*bs)++;
240 4450
        if (BANS_HAS_ARG2_SPEC(bt->oper))
241 1250
                bt->arg2_spec = ban_get_lump(bs);
242 7625
}
243
244
/*--------------------------------------------------------------------
245
 * A new object is created, grab a reference to the newest ban
246
 */
247
248
void
249 34124
BAN_NewObjCore(struct objcore *oc)
250
{
251
252 34124
        CHECK_OBJ_NOTNULL(oc, OBJCORE_MAGIC);
253 34124
        AZ(oc->ban);
254 34124
        AN(oc->objhead);
255 34124
        Lck_Lock(&ban_mtx);
256 34124
        oc->ban = ban_start;
257 34124
        ban_start->refcount++;
258 34124
        VTAILQ_INSERT_TAIL(&ban_start->objcore, oc, ban_list);
259 34124
        Lck_Unlock(&ban_mtx);
260 34124
}
261
262
/*--------------------------------------------------------------------
263
 * An object is destroyed, release its ban reference
264
 */
265
266
void
267 42277
BAN_DestroyObj(struct objcore *oc)
268
{
269
270 42277
        CHECK_OBJ_NOTNULL(oc, OBJCORE_MAGIC);
271 42277
        if (oc->ban == NULL)
272 33338
                return;
273 8939
        Lck_Lock(&ban_mtx);
274 8939
        CHECK_OBJ_ORNULL(oc->ban, BAN_MAGIC);
275 8939
        if (oc->ban != NULL) {
276 8939
                assert(oc->ban->refcount > 0);
277 8939
                oc->ban->refcount--;
278 8939
                VTAILQ_REMOVE(&oc->ban->objcore, oc, ban_list);
279 8939
                oc->ban = NULL;
280 8939
        }
281 8939
        Lck_Unlock(&ban_mtx);
282 42277
}
283
284
/*--------------------------------------------------------------------
285
 * Find a ban based on a timestamp.
286
 * Assume we have a BAN_Hold, so list traversal is safe.
287
 */
288
289
struct ban *
290 425
BAN_FindBan(vtim_real t0)
291
{
292
        struct ban *b;
293
        vtim_real t1;
294
295 425
        assert(ban_holds > 0);
296 1150
        VTAILQ_FOREACH(b, &ban_head, list) {
297 1150
                t1 = ban_time(b->spec);
298 1150
                if (t1 == t0)
299 425
                        return (b);
300 725
                if (t1 < t0)
301 0
                        break;
302 725
        }
303 0
        return (NULL);
304 425
}
305
306
/*--------------------------------------------------------------------
307
 * Grab a reference to a ban and associate the objcore with that ban.
308
 * Assume we have a BAN_Hold, so list traversal is safe.
309
 */
310
311
void
312 425
BAN_RefBan(struct objcore *oc, struct ban *b)
313
{
314
315 425
        Lck_Lock(&ban_mtx);
316 425
        CHECK_OBJ_NOTNULL(oc, OBJCORE_MAGIC);
317 425
        AZ(oc->ban);
318 425
        CHECK_OBJ_NOTNULL(b, BAN_MAGIC);
319 425
        assert(ban_holds > 0);
320 425
        b->refcount++;
321 425
        VTAILQ_INSERT_TAIL(&b->objcore, oc, ban_list);
322 425
        oc->ban = b;
323 425
        Lck_Unlock(&ban_mtx);
324 425
}
325
326
/*--------------------------------------------------------------------
327
 * Compile a full ban list and export this area to the stevedores for
328
 * persistence.
329
 */
330
331
static void
332 44044
ban_export(void)
333
{
334
        struct ban *b;
335
        struct vsb *vsb;
336
        unsigned ln;
337
338 44044
        Lck_AssertHeld(&ban_mtx);
339 44044
        ln = bans_persisted_bytes - bans_persisted_fragmentation;
340 44044
        vsb = VSB_new_auto();
341 44044
        AN(vsb);
342 90013
        VTAILQ_FOREACH_REVERSE(b, &ban_head, banhead_s, list)
343 45969
                AZ(VSB_bcat(vsb, b->spec, ban_len(b->spec)));
344 44044
        AZ(VSB_finish(vsb));
345 44044
        assert(VSB_len(vsb) == ln);
346 44044
        STV_BanExport((const uint8_t *)VSB_data(vsb), VSB_len(vsb));
347 44044
        VSB_destroy(&vsb);
348 44044
        VSC_C_main->bans_persisted_bytes =
349 44044
            bans_persisted_bytes = ln;
350 44044
        VSC_C_main->bans_persisted_fragmentation =
351 44044
            bans_persisted_fragmentation = 0;
352 44044
}
353
354
/*
355
 * For both of these we do a full export on info failure to remove
356
 * holes in the exported list.
357
 * XXX: we should keep track of the size of holes in the last exported list
358
 * XXX: check if the ban_export should be batched in ban_cleantail
359
 */
360
void
361 24519
ban_info_new(const uint8_t *ban, unsigned len)
362
{
363
        /* XXX martin pls review if ban_mtx needs to be held */
364 24519
        Lck_AssertHeld(&ban_mtx);
365 24519
        if (STV_BanInfoNew(ban, len))
366 0
                ban_export();
367 24519
}
368
369
void
370 1750
ban_info_drop(const uint8_t *ban, unsigned len)
371
{
372
        /* XXX martin pls review if ban_mtx needs to be held */
373 1750
        Lck_AssertHeld(&ban_mtx);
374 1750
        if (STV_BanInfoDrop(ban, len))
375 0
                ban_export();
376 1750
}
377
378
/*--------------------------------------------------------------------
379
 * Put a skeleton ban in the list, unless there is an identical,
380
 * time & condition, ban already in place.
381
 *
382
 * If a newer ban has same condition, mark the inserted ban COMPLETED,
383
 * also mark any older bans, with the same condition COMPLETED.
384
 */
385
386
static void
387 850
ban_reload(const uint8_t *ban, unsigned len)
388
{
389
        struct ban *b, *b2;
390 850
        int duplicate = 0;
391 850
        vtim_real t0, t1, t2 = 9e99;
392 850
        ASSERT_CLI();
393 850
        Lck_AssertHeld(&ban_mtx);
394
395 850
        t0 = ban_time(ban);
396 850
        assert(len == ban_len(ban));
397
398 1850
        VTAILQ_FOREACH(b, &ban_head, list) {
399 1450
                t1 = ban_time(b->spec);
400 1450
                assert(t1 < t2);
401 1450
                t2 = t1;
402 1450
                if (t1 == t0)
403 200
                        return;
404 1250
                if (t1 < t0)
405 250
                        break;
406 1000
                if (ban_equal(b->spec, ban))
407 600
                        duplicate = 1;
408 1000
        }
409
410 650
        VSC_C_main->bans++;
411 650
        VSC_C_main->bans_added++;
412
413 650
        b2 = ban_alloc();
414 650
        AN(b2);
415 650
        b2->spec = malloc(len);
416 650
        AN(b2->spec);
417 650
        memcpy(b2->spec, ban, len);
418 650
        if (ban[BANS_FLAGS] & BANS_FLAG_REQ) {
419 125
                VSC_C_main->bans_req++;
420 125
                b2->flags |= BANS_FLAG_REQ;
421 125
        }
422 650
        if (duplicate)
423 450
                VSC_C_main->bans_dups++;
424 650
        if (duplicate || (ban[BANS_FLAGS] & BANS_FLAG_COMPLETED))
425 475
                ban_mark_completed(b2);
426 650
        if (b == NULL)
427 400
                VTAILQ_INSERT_TAIL(&ban_head, b2, list);
428
        else
429 250
                VTAILQ_INSERT_BEFORE(b, b2, list);
430 650
        bans_persisted_bytes += len;
431 650
        VSC_C_main->bans_persisted_bytes = bans_persisted_bytes;
432
433
        /* Hunt down older duplicates */
434 1025
        for (b = VTAILQ_NEXT(b2, list); b != NULL; b = VTAILQ_NEXT(b, list)) {
435 375
                if (b->flags & BANS_FLAG_COMPLETED)
436 350
                        continue;
437 25
                if (ban_equal(b->spec, ban)) {
438 0
                        ban_mark_completed(b);
439 0
                        VSC_C_main->bans_dups++;
440 0
                }
441 25
        }
442 850
}
443
444
/*--------------------------------------------------------------------
445
 * Reload a series of persisted ban specs
446
 */
447
448
void
449 950
BAN_Reload(const uint8_t *ptr, unsigned len)
450
{
451
        const uint8_t *pe;
452
        unsigned l;
453
454 950
        AZ(ban_shutdown);
455 950
        pe = ptr + len;
456 950
        Lck_Lock(&ban_mtx);
457 1800
        while (ptr < pe) {
458
                /* XXX: This can be optimized by traversing the live
459
                 * ban list together with the reload list (combining
460
                 * the loops in BAN_Reload and ban_reload). */
461 850
                l = ban_len(ptr);
462 850
                assert(ptr + l <= pe);
463 850
                ban_reload(ptr, l);
464 850
                ptr += l;
465
        }
466 950
        Lck_Unlock(&ban_mtx);
467 950
}
468
469
/*--------------------------------------------------------------------
470
 * Get a bans timestamp
471
 */
472
473
vtim_real
474 1750
BAN_Time(const struct ban *b)
475
{
476
477 1750
        if (b == NULL)
478 550
                return (0.0);
479
480 1200
        CHECK_OBJ_NOTNULL(b, BAN_MAGIC);
481 1200
        return (ban_time(b->spec));
482 1750
}
483
484
/*--------------------------------------------------------------------
485
 * Evaluate ban-spec
486
 */
487
488
int
489 1775
ban_evaluate(struct worker *wrk, const uint8_t *bsarg, struct objcore *oc,
490
    const struct http *reqhttp, unsigned *tests)
491
{
492
        struct ban_test bt;
493
        const uint8_t *bs, *be;
494
        const char *p;
495
        const char *arg1;
496
        double darg1, darg2;
497
        int rv;
498
499
        /*
500
         * for ttl and age, fix the point in time such that banning refers to
501
         * the same point in time when the ban is evaluated
502
         *
503
         * for grace/keep, we assume that the absolute values are pola and that
504
         * users will most likely also specify a ttl criterion if they want to
505
         * fix a point in time (such as "obj.ttl > 5h && obj.keep > 3h")
506
         */
507
508 1775
        bs = bsarg;
509 1775
        be = bs + ban_len(bs);
510 1775
        bs += BANS_HEAD_LEN;
511 3050
        while (bs < be) {
512 1975
                (*tests)++;
513 1975
                ban_iter(&bs, &bt);
514 1975
                arg1 = NULL;
515 1975
                darg1 = darg2 = nan("");
516 1975
                switch (bt.arg1) {
517
                case BANS_ARG_URL:
518 675
                        AN(reqhttp);
519 675
                        arg1 = reqhttp->hd[HTTP_HDR_URL].b;
520 675
                        break;
521
                case BANS_ARG_REQHTTP:
522 175
                        AN(reqhttp);
523 175
                        (void)http_GetHdr(reqhttp, bt.arg1_spec, &p);
524 175
                        arg1 = p;
525 175
                        break;
526
                case BANS_ARG_OBJHTTP:
527 725
                        arg1 = HTTP_GetHdrPack(wrk, oc, bt.arg1_spec);
528 725
                        break;
529
                case BANS_ARG_OBJSTATUS:
530 100
                        arg1 = HTTP_GetHdrPack(wrk, oc, H__Status);
531 100
                        break;
532
                case BANS_ARG_OBJTTL:
533 75
                        darg1 = oc->ttl + oc->t_origin;
534 75
                        darg2 = bt.arg2_double + ban_time(bsarg);
535 75
                        break;
536
                case BANS_ARG_OBJAGE:
537 75
                        darg1 = 0.0 - oc->t_origin;
538 75
                        darg2 = 0.0 - (ban_time(bsarg) - bt.arg2_double);
539 75
                        break;
540
                case BANS_ARG_OBJGRACE:
541 50
                        darg1 = oc->grace;
542 50
                        darg2 = bt.arg2_double;
543 50
                        break;
544
                case BANS_ARG_OBJKEEP:
545 100
                        darg1 = oc->keep;
546 100
                        darg2 = bt.arg2_double;
547 100
                        break;
548
                default:
549 0
                        WRONG("Wrong BAN_ARG code");
550 0
                }
551
552 1975
                switch (bt.oper) {
553
                case BANS_OPER_EQ:
554 975
                        if (arg1 == NULL) {
555 225
                                if (isnan(darg1) || darg1 != darg2)
556 125
                                        return (0);
557 850
                        } else if (strcmp(arg1, bt.arg2)) {
558 300
                                return (0);
559
                        }
560 550
                        break;
561
                case BANS_OPER_NEQ:
562 250
                        if (arg1 == NULL) {
563 125
                                if (! isnan(darg1) && darg1 == darg2)
564 50
                                        return (0);
565 200
                        } else if (!strcmp(arg1, bt.arg2)) {
566 50
                                return (0);
567
                        }
568 150
                        break;
569
                case BANS_OPER_MATCH:
570 600
                        if (arg1 == NULL)
571 25
                                return (0);
572 575
                        rv = VRE_match(bt.arg2_spec, arg1, 0, 0, NULL);
573 575
                        xxxassert(rv >= -1);
574 575
                        if (rv < 0)
575 50
                                return (0);
576 525
                        break;
577
                case BANS_OPER_NMATCH:
578 0
                        if (arg1 == NULL)
579 0
                                return (0);
580 0
                        rv = VRE_match(bt.arg2_spec, arg1, 0, 0, NULL);
581 0
                        xxxassert(rv >= -1);
582 0
                        if (rv >= 0)
583 0
                                return (0);
584 0
                        break;
585
                case BANS_OPER_GT:
586 100
                        AZ(arg1);
587 100
                        assert(! isnan(darg1));
588 100
                        if (!(darg1 > darg2))
589 100
                                return (0);
590 0
                        break;
591
                case BANS_OPER_GTE:
592 0
                        AZ(arg1);
593 0
                        assert(! isnan(darg1));
594 0
                        if (!(darg1 >= darg2))
595 0
                                return (0);
596 0
                        break;
597
                case BANS_OPER_LT:
598 25
                        AZ(arg1);
599 25
                        assert(! isnan(darg1));
600 25
                        if (!(darg1 < darg2))
601 0
                                return (0);
602 25
                        break;
603
                case BANS_OPER_LTE:
604 25
                        AZ(arg1);
605 25
                        assert(! isnan(darg1));
606 25
                        if (!(darg1 <= darg2))
607 0
                                return (0);
608 25
                        break;
609
                default:
610 0
                        WRONG("Wrong BAN_OPER code");
611 0
                }
612
        }
613 1075
        return (1);
614 1775
}
615
616
/*--------------------------------------------------------------------
617
 * Check an object against all applicable bans
618
 *
619
 * Return:
620
 *      -1 not all bans checked, but none of the checked matched
621
 *              Only if !has_req
622
 *      0 No bans matched, object moved to ban_start.
623
 *      1 Ban matched, object removed from ban list.
624
 */
625
626
int
627 94382
BAN_CheckObject(struct worker *wrk, struct objcore *oc, struct req *req)
628
{
629
        struct ban *b;
630
        struct vsl_log *vsl;
631
        struct ban *b0, *bn;
632
        unsigned tests;
633
634 94382
        CHECK_OBJ_NOTNULL(wrk, WORKER_MAGIC);
635 94382
        CHECK_OBJ_NOTNULL(oc, OBJCORE_MAGIC);
636 94382
        CHECK_OBJ_NOTNULL(req, REQ_MAGIC);
637 94382
        Lck_AssertHeld(&oc->objhead->mtx);
638 94382
        assert(oc->refcnt > 0);
639
640 94382
        vsl = req->vsl;
641
642 94382
        CHECK_OBJ_NOTNULL(oc->ban, BAN_MAGIC);
643
644
        /* First do an optimistic unlocked check */
645 94382
        b0 = ban_start;
646 94382
        CHECK_OBJ_NOTNULL(b0, BAN_MAGIC);
647
648 94382
        if (b0 == oc->ban)
649 92957
                return (0);
650
651
        /* If that fails, make a safe check */
652 1425
        Lck_Lock(&ban_mtx);
653 1425
        b0 = ban_start;
654 1425
        bn = oc->ban;
655 1425
        if (b0 != bn)
656 1425
                bn->refcount++;
657 1425
        Lck_Unlock(&ban_mtx);
658
659 1425
        AN(bn);
660
661 1425
        if (b0 == bn)
662 0
                return (0);
663
664 1425
        AN(b0);
665 1425
        AN(bn);
666
667
        /*
668
         * This loop is safe without locks, because we know we hold
669
         * a refcount on a ban somewhere in the list and we do not
670
         * inspect the list past that ban.
671
         */
672 1425
        tests = 0;
673 2400
        for (b = b0; b != bn; b = VTAILQ_NEXT(b, list)) {
674 1775
                CHECK_OBJ_NOTNULL(b, BAN_MAGIC);
675 1775
                if (b->flags & BANS_FLAG_COMPLETED)
676 500
                        continue;
677 1275
                if (ban_evaluate(wrk, b->spec, oc, req->http, &tests))
678 800
                        break;
679 475
        }
680
681 1425
        Lck_Lock(&ban_mtx);
682 1425
        bn->refcount--;
683 1425
        VSC_C_main->bans_tested++;
684 1425
        VSC_C_main->bans_tests_tested += tests;
685
686 1425
        if (b == bn) {
687
                /* not banned */
688 625
                oc->ban->refcount--;
689 625
                VTAILQ_REMOVE(&oc->ban->objcore, oc, ban_list);
690 625
                VTAILQ_INSERT_TAIL(&b0->objcore, oc, ban_list);
691 625
                b0->refcount++;
692 625
                oc->ban = b0;
693 625
                b = NULL;
694 625
        }
695 1425
        if (b != NULL)
696 800
                VSC_C_main->bans_obj_killed++;
697
698 1425
        if (VTAILQ_LAST(&ban_head, banhead_s)->refcount == 0)
699 650
                ban_kick_lurker();
700
701 1425
        Lck_Unlock(&ban_mtx);
702
703 1425
        if (b == NULL) {
704
                /* not banned */
705 625
                ObjSendEvent(wrk, oc, OEV_BANCHG);
706 625
                return (0);
707
        } else {
708 1600
                VSLb(vsl, SLT_ExpBan,
709 800
                    "%ju banned lookup", VXID(ObjGetXID(wrk, oc)));
710 800
                return (1);
711
        }
712 94382
}
713
714
/*--------------------------------------------------------------------
715
 * CLI functions to add bans
716
 */
717
718
static void v_matchproto_(cli_func_t)
719 2175
ccf_ban(struct cli *cli, const char * const *av, void *priv)
720
{
721
        int narg, i;
722
        struct ban_proto *bp;
723 2175
        const char *err = NULL;
724
725 2175
        (void)priv;
726
727
        /* First do some cheap checks on the arguments */
728 9425
        for (narg = 0; av[narg + 2] != NULL; narg++)
729 7250
                continue;
730 2175
        if ((narg % 4) != 3) {
731 50
                VCLI_Out(cli, "Wrong number of arguments");
732 50
                VCLI_SetResult(cli, CLIS_PARAM);
733 50
                return;
734
        }
735 2250
        for (i = 3; i < narg; i += 4) {
736 150
                if (strcmp(av[i + 2], "&&")) {
737 25
                        VCLI_Out(cli, "Found \"%s\" expected &&", av[i + 2]);
738 25
                        VCLI_SetResult(cli, CLIS_PARAM);
739 25
                        return;
740
                }
741 125
        }
742
743 2100
        bp = BAN_Build();
744 2100
        if (bp == NULL) {
745 0
                VCLI_Out(cli, "Out of Memory");
746 0
                VCLI_SetResult(cli, CLIS_CANT);
747 0
                return;
748
        }
749 4150
        for (i = 0; i < narg; i += 4) {
750 2225
                err = BAN_AddTest(bp, av[i + 2], av[i + 3], av[i + 4]);
751 2225
                if (err)
752 175
                        break;
753 2050
        }
754
755 2100
        if (err == NULL) {
756
                // XXX racy - grab wstat lock?
757 1925
                err = BAN_Commit(bp);
758 1925
        }
759
760 2100
        if (err != NULL) {
761 175
                VCLI_Out(cli, "%s", err);
762 175
                BAN_Abandon(bp);
763 175
                VCLI_SetResult(cli, CLIS_PARAM);
764 175
        }
765 2175
}
766
767
#define Ms 60
768
#define Hs (Ms * 60)
769
#define Ds (Hs * 24)
770
#define Ws (Ds * 7)
771
#define Ys (Ds * 365)
772
773
#define Xfmt(buf, var, s, unit)                                         \
774
        ((var) >= s && (var) % s == 0)                                  \
775
                bprintf((buf), "%ju" unit, (var) / s)
776
777
// XXX move to VTIM?
778
#define vdur_render(buf, dur) do {                                      \
779
        uintmax_t dec = (uintmax_t)floor(dur);                          \
780
        uintmax_t frac = (uintmax_t)floor((dur) * 1e3) % UINTMAX_C(1000); \
781
        if (dec == 0 && frac == 0)                                      \
782
                (void) strncpy(buf, "0s", sizeof(buf));                 \
783
        else if (dec == 0)                                              \
784
                bprintf((buf), "%jums", frac);                          \
785
        else if (frac != 0)                                             \
786
                bprintf((buf), "%ju.%03jus", dec, frac);                \
787
        else if Xfmt(buf, dec, Ys, "y");                                \
788
        else if Xfmt(buf, dec, Ws, "w");                                \
789
        else if Xfmt(buf, dec, Ds, "d");                                \
790
        else if Xfmt(buf, dec, Hs, "h");                                \
791
        else if Xfmt(buf, dec, Ms, "m");                                \
792
        else                                                            \
793
                bprintf((buf), "%jus", dec);                            \
794
        } while (0)
795
796
static void
797 7350
ban_render(struct cli *cli, const uint8_t *bs, int quote)
798
{
799
        struct ban_test bt;
800
        const uint8_t *be;
801
        char buf[64];
802
803 7350
        be = bs + ban_len(bs);
804 7350
        bs += BANS_HEAD_LEN;
805 13000
        while (bs < be) {
806 5650
                ban_iter(&bs, &bt);
807 5650
                ASSERT_BAN_ARG(bt.arg1);
808 5650
                ASSERT_BAN_OPER(bt.oper);
809
810 5650
                if (BANS_HAS_ARG1_SPEC(bt.arg1))
811 3050
                        VCLI_Out(cli, "%s%.*s",
812 1525
                            arg_name[BAN_ARGIDX(bt.arg1)],
813 1525
                            bt.arg1_spec[0] - 1, bt.arg1_spec + 1);
814
                else
815 4125
                        VCLI_Out(cli, "%s", arg_name[BAN_ARGIDX(bt.arg1)]);
816
817 5650
                VCLI_Out(cli, " %s ", ban_oper[BAN_OPERIDX(bt.oper)]);
818
819 5650
                if (BANS_HAS_ARG2_DOUBLE(bt.arg1)) {
820 5350
                        vdur_render(buf, bt.arg2_double);
821 2875
                        VCLI_Out(cli, "%s", buf);
822 5650
                } else if (quote) {
823 325
                        VCLI_Quote(cli, bt.arg2);
824 325
                } else {
825 2450
                        VCLI_Out(cli, "%s", bt.arg2);
826
                }
827
828 5650
                if (bs < be)
829 325
                        VCLI_Out(cli, " && ");
830
        }
831 7350
}
832
833
static void
834 1800
ban_list(struct cli *cli, struct ban *bl)
835
{
836
        struct ban *b;
837
        int64_t o;
838
839 1800
        VCLI_Out(cli, "Present bans:\n");
840 8550
        VTAILQ_FOREACH(b, &ban_head, list) {
841 6750
                o = bl == b ? 1 : 0;
842 13500
                VCLI_Out(cli, "%10.6f %5ju %s", ban_time(b->spec),
843 6750
                    (intmax_t)(b->refcount - o),
844 6750
                    b->flags & BANS_FLAG_COMPLETED ? "C" : "-");
845 6750
                if (DO_DEBUG(DBG_LURKER)) {
846 2350
                        VCLI_Out(cli, "%s%s %p ",
847 1175
                            b->flags & BANS_FLAG_REQ ? "R" : "-",
848 1175
                            b->flags & BANS_FLAG_OBJ ? "O" : "-",
849 1175
                            b);
850 1175
                }
851 6750
                VCLI_Out(cli, "  ");
852 6750
                ban_render(cli, b->spec, 0);
853 6750
                VCLI_Out(cli, "\n");
854 6750
                if (VCLI_Overflow(cli))
855 0
                        break;
856 6750
                if (DO_DEBUG(DBG_LURKER)) {
857 1175
                        Lck_Lock(&ban_mtx);
858
                        struct objcore *oc;
859 1975
                        VTAILQ_FOREACH(oc, &b->objcore, ban_list)
860 800
                                VCLI_Out(cli, "  oc = %p\n", oc);
861 1175
                        Lck_Unlock(&ban_mtx);
862 1175
                }
863 6750
        }
864 1800
}
865
866
static void
867 150
ban_list_json(struct cli *cli, const char * const *av, struct ban *bl)
868
{
869
        struct ban *b;
870
        int64_t o;
871 150
        int n = 0;
872
        int ocs;
873
874 150
        VCLI_JSON_begin(cli, 2, av);
875 150
        VCLI_Out(cli, ",\n");
876 750
        VTAILQ_FOREACH(b, &ban_head, list) {
877 600
                o = bl == b ? 1 : 0;
878 600
                VCLI_Out(cli, "%s", n ? ",\n" : "");
879 600
                n++;
880 600
                VCLI_Out(cli, "{\n");
881 600
                VSB_indent(cli->sb, 2);
882 600
                VCLI_Out(cli, "\"time\": %.6f,\n", ban_time(b->spec));
883 600
                VCLI_Out(cli, "\"refs\": %ju,\n", (intmax_t)(b->refcount - o));
884 1200
                VCLI_Out(cli, "\"completed\": %s,\n",
885 600
                         b->flags & BANS_FLAG_COMPLETED ? "true" : "false");
886 600
                VCLI_Out(cli, "\"spec\": \"");
887 600
                ban_render(cli, b->spec, 1);
888 600
                VCLI_Out(cli, "\"");
889
890 600
                if (DO_DEBUG(DBG_LURKER)) {
891 150
                        VCLI_Out(cli, ",\n");
892 300
                        VCLI_Out(cli, "\"req_tests\": %s,\n",
893 150
                                 b->flags & BANS_FLAG_REQ ? "true" : "false");
894 300
                        VCLI_Out(cli, "\"obj_tests\": %s,\n",
895 150
                                 b->flags & BANS_FLAG_OBJ ? "true" : "false");
896 150
                        VCLI_Out(cli, "\"pointer\": \"%p\",\n", b);
897 150
                        if (VCLI_Overflow(cli))
898 0
                                break;
899
900 150
                        ocs = 0;
901 150
                        VCLI_Out(cli, "\"objcores\": [\n");
902 150
                        VSB_indent(cli->sb, 2);
903 150
                        Lck_Lock(&ban_mtx);
904
                        struct objcore *oc;
905 150
                        VTAILQ_FOREACH(oc, &b->objcore, ban_list) {
906 0
                                if (ocs)
907 0
                                        VCLI_Out(cli, ",\n");
908 0
                                VCLI_Out(cli, "%p", oc);
909 0
                                ocs++;
910 0
                        }
911 150
                        Lck_Unlock(&ban_mtx);
912 150
                        VSB_indent(cli->sb, -2);
913 150
                        VCLI_Out(cli, "\n]");
914 150
                }
915 600
                VSB_indent(cli->sb, -2);
916 600
                VCLI_Out(cli, "\n}");
917 600
        }
918 150
        VCLI_JSON_end(cli);
919 150
}
920
921
static void v_matchproto_(cli_func_t)
922 1950
ccf_ban_list(struct cli *cli, const char * const *av, void *priv)
923
{
924
        struct ban *bl;
925
926 1950
        (void)priv;
927
928
        /* Get a reference so we are safe to traverse the list */
929 1950
        Lck_Lock(&ban_mtx);
930 1950
        bl = VTAILQ_LAST(&ban_head, banhead_s);
931 1950
        bl->refcount++;
932 1950
        Lck_Unlock(&ban_mtx);
933
934 1950
        if (av[2] != NULL && strcmp(av[2], "-j") == 0)
935 150
                ban_list_json(cli, av, bl);
936
        else
937 1800
                ban_list(cli, bl);
938
939 1950
        Lck_Lock(&ban_mtx);
940 1950
        bl->refcount--;
941 1950
        ban_kick_lurker();      // XXX: Mostly for testcase b00009.vtc
942 1950
        Lck_Unlock(&ban_mtx);
943 1950
}
944
945
static struct cli_proto ban_cmds[] = {
946
        { CLICMD_BAN,                           "", ccf_ban },
947
        { CLICMD_BAN_LIST,                      "", ccf_ban_list,
948
          ccf_ban_list },
949
        { NULL }
950
};
951
952
/*--------------------------------------------------------------------
953
 */
954
955
void
956 22144
BAN_Compile(void)
957
{
958
        struct ban *b;
959
960
        /*
961
         * All bans have been read from all persistent stevedores. Export
962
         * the compiled list
963
         */
964
965 22144
        ASSERT_CLI();
966 22144
        AZ(ban_shutdown);
967
968 22144
        Lck_Lock(&ban_mtx);
969
970
        /* Report the place-holder ban */
971 22144
        b = VTAILQ_FIRST(&ban_head);
972 22144
        ban_info_new(b->spec, ban_len(b->spec));
973
974 22144
        ban_export();
975
976 22144
        Lck_Unlock(&ban_mtx);
977
978 22144
        ban_start = VTAILQ_FIRST(&ban_head);
979 22144
        BAN_Release();
980 22144
}
981
982
void
983 22194
BAN_Init(void)
984
{
985
        struct ban_proto *bp;
986
987 22194
        BAN_Build_Init();
988 22194
        Lck_New(&ban_mtx, lck_ban);
989 22194
        CLI_AddFuncs(ban_cmds);
990
991 22194
        ban_holds = 1;
992
993
        /* Add a placeholder ban */
994 22194
        bp = BAN_Build();
995 22194
        AN(bp);
996 22194
        PTOK(pthread_cond_init(&ban_lurker_cond, NULL));
997 22194
        AZ(BAN_Commit(bp));
998 22194
        Lck_Lock(&ban_mtx);
999 22194
        ban_mark_completed(VTAILQ_FIRST(&ban_head));
1000 22194
        Lck_Unlock(&ban_mtx);
1001 22194
}
1002
1003
/*--------------------------------------------------------------------
1004
 * Shutdown of the ban system.
1005
 *
1006
 * When this function returns, no new bans will be accepted, and no
1007
 * bans will be dropped (ban lurker thread stopped), so that no
1008
 * STV_BanInfo calls will be executed.
1009
 */
1010
1011
void
1012 21900
BAN_Shutdown(void)
1013
{
1014
        void *status;
1015
1016 21900
        Lck_Lock(&ban_mtx);
1017 21900
        ban_shutdown = 1;
1018 21900
        ban_kick_lurker();
1019 21900
        Lck_Unlock(&ban_mtx);
1020
1021 21900
        PTOK(pthread_join(ban_thread, &status));
1022 21900
        AZ(status);
1023
1024 21900
        Lck_Lock(&ban_mtx);
1025
        /* Export the ban list to compact it */
1026 21900
        ban_export();
1027 21900
        Lck_Unlock(&ban_mtx);
1028
1029 21900
        BAN_Build_Fini();
1030 21900
}