vinyl-cache/bin/vinyld/mgt/mgt_param_tweak.c
0
/*-
1
 * Copyright (c) 2006 Verdens Gang AS
2
 * Copyright (c) 2006-2011 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
 * Functions for tweaking parameters
31
 *
32
 */
33
34
#include "config.h"
35
36
#include <limits.h>
37
#include <math.h>
38
#include <stdio.h>
39
#include <stdlib.h>
40
#include <string.h>
41
42
#include "mgt/mgt.h"
43
44
#include "mgt/mgt_param.h"
45
#include "storage/storage.h"
46
#include "vav.h"
47
#include "vnum.h"
48
#include "vsl_priv.h"
49
50
const char * const JSON_FMT = (const char *)&JSON_FMT;
51
52
/*--------------------------------------------------------------------
53
 * Generic handling of double typed parameters
54
 */
55
56
typedef double parse_double_f(const char *, const char **);
57
58
static double
59 420948
parse_decimal(const char *p, const char **err)
60
{
61
        double v;
62
63 420948
        v = SF_Parse_Decimal(&p, 0, err);
64 420948
        if (errno == 0 && *p != '\0') {
65 21
                errno = EINVAL;
66 21
                *err = "Invalid number";
67 21
        }
68 420948
        return (v);
69
}
70
71
static int
72 4337344
tweak_generic_double(struct vsb *vsb, const char *arg, const struct parspec *pp,
73
    parse_double_f parse, const char *fmt)
74
{
75 4337344
        volatile double u, minv = VRT_DECIMAL_MIN, maxv = VRT_DECIMAL_MAX;
76 4337344
        volatile double *dest = pp->priv;
77
        const char *err;
78
79 4337344
        if (arg != NULL && arg != JSON_FMT) {
80 2198417
                if (pp->min != NULL) {
81 2198417
                        minv = parse(pp->min, &err);
82 2198417
                        if (errno) {
83 0
                                VSB_printf(vsb, "Min: %s (%s)\n", err, pp->min);
84 0
                                return (-1);
85
                        }
86 2198417
                }
87 2198417
                if (pp->max != NULL) {
88 701223
                        maxv = parse(pp->max, &err);
89 701223
                        if (errno) {
90 0
                                VSB_printf(vsb, "Max: %s (%s)\n", err, pp->max);
91 0
                                return (-1);
92
                        }
93 701223
                }
94
95 2198417
                u = parse(arg, &err);
96 2198417
                if (errno) {
97 84
                        VSB_printf(vsb, "%s (%s)\n", err, arg);
98 84
                        return (-1);
99
                }
100 2198333
                if (u < minv) {
101 42
                        VSB_printf(vsb,
102 21
                            "Must be greater or equal to %s\n", pp->min);
103 21
                        return (-1);
104
                }
105 2198312
                if (u > maxv) {
106 42
                        VSB_printf(vsb,
107 21
                            "Must be less than or equal to %s\n", pp->max);
108 21
                        return (-1);
109
                }
110 2198291
                *dest = u;
111 2198291
        } else {
112 2138927
                VSB_printf(vsb, fmt, *dest);
113
        }
114 4337218
        return (0);
115 4337344
}
116
117
/*--------------------------------------------------------------------*/
118
119
static double
120 4677109
parse_duration(const char *p, const char **err)
121
{
122
        double v, r;
123
124 4677109
        v = SF_Parse_Decimal(&p, 0, err);
125 4677109
        if (*p == '\0')
126 4279470
                return (v);
127
128 397639
        r = VNUM_duration_unit(v, p, NULL);
129 397639
        if (isnan(r)) {
130 42
                errno = EINVAL;
131 42
                *err = "Invalid duration unit";
132 42
        }
133
134 397639
        return (r);
135 4677109
}
136
137
int v_matchproto_(tweak_t)
138 1079228
tweak_timeout(struct vsb *vsb, const struct parspec *par, const char *arg)
139
{
140 1079228
        volatile double *dest = par->priv;
141
142 1079228
        if (arg != NULL && !vstrcmp(arg, "never")) {
143 21
                *dest = INFINITY;
144 21
                return (0);
145
        }
146
147 1079207
        if (*dest == INFINITY && arg == NULL) {
148 0
                VSB_cat(vsb, "never");
149 0
                return (0);
150
        }
151
152 1079207
        if (*dest == INFINITY && arg == JSON_FMT) {
153 0
                VSB_cat(vsb, "\"never\"");
154 0
                return (0);
155
        }
156
157 1079207
        return (tweak_generic_double(vsb, arg, par, parse_duration, "%.3f"));
158 1079228
}
159
160
int v_matchproto_(tweak_t)
161 3047432
tweak_duration(struct vsb *vsb, const struct parspec *par, const char *arg)
162
{
163
164 3047432
        return (tweak_generic_double(vsb, arg, par, parse_duration, "%.3f"));
165
}
166
167
/*--------------------------------------------------------------------*/
168
169
int v_matchproto_(tweak_t)
170 140463
tweak_double(struct vsb *vsb, const struct parspec *par, const char *arg)
171
{
172
173 140463
        return (tweak_generic_double(vsb, arg, par, parse_decimal, "%g"));
174
}
175
176
/*--------------------------------------------------------------------*/
177
178
static int
179 276810
parse_boolean(struct vsb *vsb, const char *arg)
180
{
181
182 276810
        if (!strcasecmp(arg, "off"))
183 89456
                return (0);
184 187354
        if (!strcasecmp(arg, "disable"))
185 21
                return (0);
186 187333
        if (!strcasecmp(arg, "no"))
187 21
                return (0);
188 187312
        if (!strcasecmp(arg, "false"))
189 84
                return (0);
190 187228
        if (!strcasecmp(arg, "on"))
191 186934
                return (1);
192 294
        if (!strcasecmp(arg, "enable"))
193 21
                return (1);
194 273
        if (!strcasecmp(arg, "yes"))
195 21
                return (1);
196 252
        if (!strcasecmp(arg, "true"))
197 231
                return (1);
198
199 21
        VSB_cat(vsb, "use \"on\" or \"off\"\n");
200 21
        return (-1);
201 276810
}
202
203
int v_matchproto_(tweak_t)
204 513680
tweak_boolean(struct vsb *vsb, const struct parspec *par, const char *arg)
205
{
206
        volatile unsigned *dest;
207
        int val;
208
209 513680
        dest = par->priv;
210 513680
        if (arg != NULL && arg != JSON_FMT) {
211 276810
                val = parse_boolean(vsb, arg);
212 276810
                if (val < 0)
213 21
                        return (-1);
214 276789
                *dest = val;
215 513659
        } else if (arg == JSON_FMT) {
216 630
                VSB_printf(vsb, "%s", *dest ? "true" : "false");
217 630
        } else {
218 236240
                VSB_printf(vsb, "%s", *dest ? "on" : "off");
219
        }
220 513659
        return (0);
221 513680
}
222
223
/*--------------------------------------------------------------------*/
224
225
static int
226 3608528
tweak_generic_uint(struct vsb *vsb, volatile unsigned *dest, const char *arg,
227
    const char *min, const char *max,
228
    const char *min_reason, const char *max_reason)
229
{
230 3608528
        unsigned u, minv = 0, maxv = 0;
231
        char *p;
232
233 3608528
        if (arg != NULL && arg != JSON_FMT) {
234 1869802
                if (min != NULL) {
235 1659013
                        p = NULL;
236 1659013
                        minv = strtoul(min, &p, 0);
237 1659013
                        if (*arg == '\0' || *p != '\0') {
238 0
                                VSB_printf(vsb, "Illegal Min: %s\n", min);
239 0
                                return (-1);
240
                        }
241 1659013
                }
242 1869802
                if (max != NULL) {
243 817516
                        p = NULL;
244 817516
                        maxv = strtoul(max, &p, 0);
245 817516
                        if (*arg == '\0' || *p != '\0') {
246 0
                                VSB_printf(vsb, "Illegal Max: %s\n", max);
247 0
                                return (-1);
248
                        }
249 817516
                }
250 1869802
                p = NULL;
251 1869802
                if (!strcasecmp(arg, "unlimited"))
252 21
                        u = UINT_MAX;
253
                else {
254 1869781
                        u = strtoul(arg, &p, 0);
255 1869781
                        if (*arg == '\0' || *p != '\0') {
256 42
                                VSB_printf(vsb, "Not a number (%s)\n", arg);
257 42
                                return (-1);
258
                        }
259
                }
260 1869760
                if (min != NULL && u < minv) {
261 84
                        VSB_printf(vsb, "Must be at least %s", min);
262 84
                        if (min_reason != NULL)
263 42
                                VSB_printf(vsb, " (%s)", min_reason);
264 84
                        VSB_putc(vsb, '\n');
265 84
                        return (-1);
266
                }
267 1869676
                if (max != NULL && u > maxv) {
268 126
                        VSB_printf(vsb, "Must be no more than %s", max);
269 126
                        if (max_reason != NULL)
270 105
                                VSB_printf(vsb, " (%s)", max_reason);
271 126
                        VSB_putc(vsb, '\n');
272 126
                        return (-1);
273
                }
274 1869550
                *dest = u;
275 3608276
        } else if (*dest == UINT_MAX && arg != JSON_FMT) {
276 105
                VSB_cat(vsb, "unlimited");
277 105
        } else {
278 1738621
                VSB_printf(vsb, "%u", *dest);
279
        }
280 3608276
        return (0);
281 3608528
}
282
283
/*--------------------------------------------------------------------*/
284
285
int v_matchproto_(tweak_t)
286 3350848
tweak_uint(struct vsb *vsb, const struct parspec *par, const char *arg)
287
{
288
        volatile unsigned *dest;
289
290 3350848
        dest = par->priv;
291 6701696
        return (tweak_generic_uint(vsb, dest, arg, par->min, par->max,
292 3350848
            par->dyn_min_reason, par->dyn_max_reason));
293
}
294
295
int v_matchproto_(tweak_t)
296 140484
tweak_uint_orzero(struct vsb *vsb, const struct parspec *par, const char *arg)
297
{
298
        volatile unsigned *dest;
299
300 140484
        dest = par->priv;
301 140484
        if (arg != NULL && arg != JSON_FMT && ! vstrcmp(arg, "0")) {
302 23351
                VSB_cat(vsb, "0");
303 23351
                *dest = 0;
304 23351
                return (0);
305
        }
306 234266
        return (tweak_generic_uint(vsb, dest, arg, par->min, par->max,
307 117133
            par->dyn_min_reason, par->dyn_max_reason));
308 140484
}
309
310
/*--------------------------------------------------------------------*/
311
312
static void
313 1360910
fmt_bytes(struct vsb *vsb, uintmax_t t)
314
{
315
        const char *p;
316
317 1360910
        if (t == 0 || t & 0xff) {
318 467881
                VSB_printf(vsb, "%jub", t);
319 467881
                return;
320
        }
321 1221308
        for (p = "kMGTPEZY"; *p; p++) {
322 1221308
                if (t & 0x300) {
323 117301
                        VSB_printf(vsb, "%.2f%c", t / 1024.0, *p);
324 117301
                        return;
325
                }
326 1104007
                t /= 1024;
327 1104007
                if (t & 0x0ff) {
328 775728
                        VSB_printf(vsb, "%ju%c", t, *p);
329 775728
                        return;
330
                }
331 328279
        }
332 0
        VSB_cat(vsb, "(bogus number)");
333 1360910
}
334
335
static int
336 2782549
tweak_generic_bytes(struct vsb *vsb, volatile ssize_t *dest, const char *arg,
337
    const char *min, const char *max)
338
{
339 2782549
        uintmax_t r, rmin = 0, rmax = 0;
340
        const char *p;
341
342 2782549
        if (arg != NULL && arg != JSON_FMT) {
343 1420127
                if (min != NULL) {
344 1420127
                        p = VNUM_2bytes(min, &rmin, 0);
345 1420127
                        if (p != NULL) {
346 0
                                VSB_printf(vsb, "Invalid min-val: %s\n", min);
347 0
                                return (-1);
348
                        }
349 1420127
                }
350 1420127
                if (max != NULL) {
351 765039
                        p = VNUM_2bytes(max, &rmax, 0);
352 765039
                        if (p != NULL) {
353 0
                                VSB_printf(vsb, "Invalid max-val: %s\n", max);
354 0
                                return (-1);
355
                        }
356 765039
                }
357 1420127
                p = VNUM_2bytes(arg, &r, 0);
358 1420127
                if (p != NULL) {
359 42
                        VSB_cat(vsb, "Could not convert to bytes.\n");
360 42
                        VSB_printf(vsb, "%s\n", p);
361 42
                        VSB_cat(vsb, "  Try something like '80k' or '120M'\n");
362 42
                        return (-1);
363
                }
364 1420085
                if ((uintmax_t)((ssize_t)r) != r) {
365 0
                        fmt_bytes(vsb, r);
366 0
                        VSB_cat(vsb, " is too large for this architecture.\n");
367 0
                        return (-1);
368
                }
369 1420085
                if (max != NULL && r > rmax) {
370 21
                        VSB_printf(vsb, "Must be no more than %s\n", max);
371 21
                        VSB_cat(vsb, "\n");
372 21
                        return (-1);
373
                }
374 1420064
                if (min != NULL && r < rmin) {
375 21
                        VSB_printf(vsb, "Must be at least %s\n", min);
376 21
                        return (-1);
377
                }
378 1420043
                *dest = r;
379 2782465
        } else if (arg == JSON_FMT) {
380 1512
                VSB_printf(vsb, "%zd", *dest);
381 1512
        } else {
382 1360910
                fmt_bytes(vsb, *dest);
383
        }
384 2782465
        return (0);
385 2782549
}
386
387
/*--------------------------------------------------------------------*/
388
389
int v_matchproto_(tweak_t)
390 537325
tweak_bytes(struct vsb *vsb, const struct parspec *par, const char *arg)
391
{
392
        volatile ssize_t *dest;
393
394 537325
        dest = par->priv;
395 537325
        return (tweak_generic_bytes(vsb, dest, arg, par->min, par->max));
396
}
397
398
/*--------------------------------------------------------------------*/
399
400
int v_matchproto_(tweak_t)
401 2010916
tweak_bytes_u(struct vsb *vsb, const struct parspec *par, const char *arg)
402
{
403
        volatile unsigned *d1;
404
        volatile ssize_t dest;
405
406 2010916
        d1 = par->priv;
407 2010916
        dest = *d1;
408 2010916
        if (tweak_generic_bytes(vsb, &dest, arg, par->min, par->max))
409 84
                return (-1);
410 2010832
        *d1 = dest;
411 2010832
        return (0);
412 2010916
}
413
414
/*--------------------------------------------------------------------
415
 * vsl_buffer and vsl_reclen have dependencies.
416
 */
417
418
int v_matchproto_(tweak_t)
419 93866
tweak_vsl_buffer(struct vsb *vsb, const struct parspec *par, const char *arg)
420
{
421
        volatile unsigned *d1;
422
        volatile ssize_t dest;
423
424 93866
        d1 = par->priv;
425 93866
        dest = *d1;
426 93866
        if (tweak_generic_bytes(vsb, &dest, arg, par->min, par->max))
427 0
                return (-1);
428 93866
        *d1 = dest;
429 93866
        MCF_ParamConf(MCF_MAXIMUM, "vsl_reclen", "%u", *d1 - 12);
430 93866
        return (0);
431 93866
}
432
433
int v_matchproto_(tweak_t)
434 140442
tweak_vsl_reclen(struct vsb *vsb, const struct parspec *par, const char *arg)
435
{
436
        volatile unsigned *d1;
437
        volatile ssize_t dest;
438
439 140442
        d1 = par->priv;
440 140442
        dest = *d1;
441 140442
        if (tweak_generic_bytes(vsb, &dest, arg, par->min, par->max))
442 0
                return (-1);
443 140442
        *d1 = dest;
444 140442
        MCF_ParamConf(MCF_MINIMUM, "vsl_buffer", "%u", *d1 + 12);
445 140442
        return (0);
446 140442
}
447
448
/*--------------------------------------------------------------------*/
449
450
int v_matchproto_(tweak_t)
451 256861
tweak_string(struct vsb *vsb, const struct parspec *par, const char *arg)
452
{
453 256861
        char **p = TRUST_ME(par->priv);
454
455 256861
        AN(p);
456 256861
        if (arg == NULL) {
457 118141
                VSB_quote(vsb, *p, -1, 0);
458 256861
        } else if (arg == JSON_FMT) {
459 315
                VSB_putc(vsb, '"');
460 315
                VSB_quote(vsb, *p, -1, VSB_QUOTE_JSON);
461 315
                VSB_putc(vsb, '"');
462 315
        } else {
463 138405
                REPLACE(*p, arg);
464
        }
465 256861
        return (0);
466
}
467
468
/*--------------------------------------------------------------------*/
469
470
int v_matchproto_(tweak_t)
471 141471
tweak_poolparam(struct vsb *vsb, const struct parspec *par, const char *arg)
472
{
473
        volatile struct poolparam *pp, px;
474
        struct parspec pt;
475
        char **av;
476 141471
        int retval = 0;
477
478 141471
        pp = par->priv;
479 141471
        if (arg == JSON_FMT) {
480 231
                VSB_cat(vsb, "{\n");
481 231
                VSB_indent(vsb, 8);
482 231
                VSB_printf(vsb, "\"min_pool\": %u,\n", pp->min_pool);
483 231
                VSB_printf(vsb, "\"max_pool\": %u,\n", pp->max_pool);
484 231
                VSB_printf(vsb, "\"max_age\": %g\n", pp->max_age);
485 231
                VSB_indent(vsb, -4);
486 231
                VSB_cat(vsb, "}");
487 141471
        } else if (arg == NULL) {
488 141828
                VSB_printf(vsb, "%u,%u,%g",
489 70914
                    pp->min_pool, pp->max_pool, pp->max_age);
490 70914
        } else {
491 70326
                av = VAV_Parse(arg, NULL, ARGV_COMMA);
492 70326
                do {
493 70326
                        if (av[0] != NULL) {
494 21
                                VSB_printf(vsb, "Parse error: %s", av[0]);
495 21
                                retval = -1;
496 21
                                break;
497
                        }
498 70305
                        if (av[1] == NULL || av[2] == NULL || av[3] == NULL) {
499 21
                                VSB_cat(vsb,
500
                                    "Three fields required:"
501
                                    " min_pool, max_pool and max_age\n");
502 21
                                retval = -1;
503 21
                                break;
504
                        }
505 70284
                        px = *pp;
506 140568
                        retval = tweak_generic_uint(vsb, &px.min_pool, av[1],
507 70284
                            par->min, par->max, par->dyn_min_reason,
508 70284
                            par->dyn_max_reason);
509 70284
                        if (retval)
510 21
                                break;
511 140526
                        retval = tweak_generic_uint(vsb, &px.max_pool, av[2],
512 70263
                            par->min, par->max, par->dyn_min_reason,
513 70263
                            par->dyn_max_reason);
514 70263
                        if (retval)
515 21
                                break;
516 70242
                        pt.priv = &px.max_age;
517 70242
                        pt.min = "0";
518 70242
                        pt.max = "1000000";
519 70242
                        retval = tweak_generic_double(vsb, av[3], &pt,
520
                            parse_decimal, "%.0f");
521 70242
                        if (retval)
522 21
                                break;
523 70221
                        if (px.min_pool > px.max_pool) {
524 21
                                VSB_cat(vsb,
525
                                    "min_pool cannot be larger"
526
                                    " than max_pool\n");
527 21
                                retval = -1;
528 21
                                break;
529
                        }
530 70200
                        *pp = px;
531 70200
                } while (0);
532 70326
                VAV_Free(av);
533
        }
534 141471
        return (retval);
535
}
536
537
/*--------------------------------------------------------------------
538
 * Thread pool tweaks.
539
 *
540
 * The min/max values automatically update the opposites appropriate
541
 * limit, so they don't end up crossing.
542
 */
543
544
int v_matchproto_(tweak_t)
545 162197
tweak_thread_pool_min(struct vsb *vsb, const struct parspec *par,
546
    const char *arg)
547
{
548 162197
        if (tweak_uint(vsb, par, arg))
549 42
                return (-1);
550
551 162155
        MCF_ParamConf(MCF_MINIMUM, "thread_pool_max",
552 162155
            "%u", mgt_param.wthread_min);
553 162155
        MCF_ParamConf(MCF_MAXIMUM, "thread_pool_reserve",
554 162155
            "%u", mgt_param.wthread_min * 950 / 1000);
555 162155
        return (0);
556 162197
}
557
558
int v_matchproto_(tweak_t)
559 47395
tweak_thread_pool_max(struct vsb *vsb, const struct parspec *par,
560
    const char *arg)
561
{
562
563 47395
        if (tweak_uint(vsb, par, arg))
564 42
                return (-1);
565
566 47353
        MCF_ParamConf(MCF_MAXIMUM, "thread_pool_min",
567 47353
            "%u", mgt_param.wthread_max);
568 47353
        return (0);
569 47395
}
570
571
/*--------------------------------------------------------------------
572
 * Tweak storage
573
 */
574
575
int v_matchproto_(tweak_t)
576 47059
tweak_storage(struct vsb *vsb, const struct parspec *par, const char *arg)
577
{
578
        struct stevedore *stv;
579
580
        /* XXX: If we want to remove the MUST_RESTART flag from the
581
         * h2_rxbuf_storage parameter, we could have a mechanism here
582
         * that when the child is running calls out through CLI to change
583
         * the stevedore being used. */
584
585 47059
        if (arg == NULL || arg == JSON_FMT)
586 23687
                return (tweak_string(vsb, par, arg));
587
588 23372
        if (!vstrcmp(arg, "Transient") ||
589 21
            !vstrcmp(arg, "Synth")) {
590
                /* Always allow setting the special names
591
                 *
592
                 * There will always be a stevedore with each of these names,
593
                 * but they may not have been configured at the time
594
                 * this is called. */
595 23351
        } else {
596
                /* Only allow setting the value to a known configured
597
                 * stevedore */
598 21
                STV_Foreach(stv) {
599 21
                        CHECK_OBJ_NOTNULL(stv, STEVEDORE_MAGIC);
600 21
                        if (!vstrcmp(stv->ident, arg))
601 21
                                break;
602
                }
603 21
                if (stv == NULL) {
604 0
                        VSB_printf(vsb, "unknown storage backend '%s'", arg);
605 0
                        return (-1);
606
                }
607
        }
608 23372
        return (tweak_string(vsb, par, arg));
609 47059
}
610
611
/*--------------------------------------------------------------------
612
 * Tweak alias
613
 */
614
615
int v_matchproto_(tweak_t)
616 0
tweak_alias(struct vsb *vsb, const struct parspec *par, const char *arg)
617
{
618
619 0
        (void)vsb;
620 0
        (void)par;
621 0
        (void)arg;
622 0
        WRONG("param tweak never called directly");
623 0
}
624
625
/*--------------------------------------------------------------------
626
 * Tweak bits
627
 */
628
629
enum bit_do {BSET, BCLR, BTST};
630
631
static int
632 3899704
bit(uint8_t *p, unsigned no, enum bit_do act)
633
{
634
        uint8_t b;
635
636 3899704
        p += (no >> 3);
637 3899704
        b = (0x80 >> (no & 7));
638 3899704
        if (act == BSET)
639 494613
                *p |= b;
640 3405091
        else if (act == BCLR)
641 64845
                *p &= ~b;
642 3899704
        return (*p & b);
643
}
644
645
static inline void
646 116818
bit_clear(uint8_t *p, unsigned l)
647
{
648
649 116818
        memset(p, 0, ((size_t)l + 7) >> 3);
650 116818
}
651
652
static inline void
653 42
bit_set(uint8_t *p, unsigned l)
654
{
655
656 42
        memset(p, 255, ((size_t)l + 7) >> 3);
657 42
}
658
659
/*--------------------------------------------------------------------
660
 */
661
662
static int
663 166124
bit_tweak(struct vsb *vsb, uint8_t *p, unsigned l, const char *arg,
664
    const char * const *tags, const char *desc, char sign)
665
{
666
        int i, n;
667
        unsigned j;
668
        char **av;
669
        const char *s;
670
671 166124
        av = VAV_Parse(arg, &n, ARGV_COMMA);
672 166124
        if (av[0] != NULL) {
673 21
                VSB_printf(vsb, "Cannot parse: %s\n", av[0]);
674 21
                VAV_Free(av);
675 21
                return (-1);
676
        }
677 842421
        for (i = 1; av[i] != NULL; i++) {
678 676360
                s = av[i];
679 676360
                if (sign == '+' && !vstrcmp(s, "none")) {
680 93425
                        bit_clear(p, l);
681 93425
                        continue;
682
                }
683 582935
                if (sign == '+' && !vstrcmp(s, "all")) {
684 21
                        bit_set(p, l);
685 21
                        continue;
686
                }
687 582914
                if (sign == '-' && !vstrcmp(s, "all")) {
688 23393
                        bit_clear(p, l);
689 23393
                        continue;
690
                }
691 559521
                if (sign == '-' && !vstrcmp(s, "none")) {
692 21
                        bit_set(p, l);
693 21
                        continue;
694
                }
695 559500
                if (*s != '-' && *s != '+') {
696 21
                        VSB_printf(vsb, "Missing '+' or '-' (%s)\n", s);
697 21
                        VAV_Free(av);
698 21
                        return (-1);
699
                }
700 28639612
                for (j = 0; j < l; j++) {
701 28639591
                        if (tags[j] != NULL && !strcasecmp(s + 1, tags[j]))
702 559458
                                break;
703 28080133
                }
704 559479
                if (tags[j] == NULL) {
705 21
                        VSB_printf(vsb, "Unknown %s (%s)\n", desc, s);
706 21
                        VAV_Free(av);
707 21
                        return (-1);
708
                }
709 559458
                assert(j < l);
710 559458
                if (s[0] == sign)
711 494613
                        (void)bit(p, j, BSET);
712
                else
713 64845
                        (void)bit(p, j, BCLR);
714 559458
        }
715 166061
        VAV_Free(av);
716 166061
        return (0);
717 166124
}
718
719
720
/*--------------------------------------------------------------------
721
 */
722
723
static int
724 285063
tweak_generic_bits(struct vsb *vsb, const struct parspec *par, const char *arg,
725
    uint8_t *p, unsigned l, const char * const *tags, const char *desc,
726
    char sign)
727
{
728
        unsigned j, all;
729
730 285063
        if (arg != NULL && !vstrcmp(arg, "default")) {
731
                /* XXX: deprecated in favor of param.reset */
732 0
                return (tweak_generic_bits(vsb, par, par->def, p, l, tags,
733 0
                    desc, sign));
734
        }
735
736 285063
        if (arg != NULL && arg != JSON_FMT)
737 166124
                return (bit_tweak(vsb, p, l, arg, tags, desc, sign));
738
739 118939
        all = 1;
740 320678
        for (j = 0; all && j < l; j++) {
741 201739
                if (tags[j] == NULL)
742 30575
                        continue;
743 171164
                if (!bit(p, j, BTST))
744 118813
                        all = 0;
745 171164
        }
746
747 118939
        if (arg == JSON_FMT)
748 441
                VSB_putc(vsb, '"');
749 118939
        if (all)
750 126
                VSB_cat(vsb, sign == '+' ? "all" : "none");
751
        else
752 118813
                VSB_cat(vsb, sign == '+' ? "none" : "all");
753 7104821
        for (j = 0; !all && j < l; j++) {
754 6985882
                if (tags[j] == NULL)
755 3816800
                        continue;
756 3169082
                if (bit(p, j, BTST))
757 475189
                        VSB_printf(vsb, ",%c%s", sign, tags[j]);
758 3169082
        }
759 118939
        if (arg == JSON_FMT)
760 441
                VSB_putc(vsb, '"');
761 118939
        return (0);
762 285063
}
763
764
/*--------------------------------------------------------------------
765
 * The vsl_mask parameter
766
 */
767
768
static const char * const VSL_tags[256] = {
769
#  define SLTM(foo,flags,sdesc,ldesc) [SLT_##foo] = #foo,
770
#  include "tbl/vsl_tags.h"
771
};
772
773
int v_matchproto_(tweak_t)
774 69276
tweak_vsl_mask(struct vsb *vsb, const struct parspec *par, const char *arg)
775
{
776
777 69276
        return (tweak_generic_bits(vsb, par, arg, mgt_param.vsl_mask,
778
            SLT__Reserved, VSL_tags, "VSL tag", '-'));
779
}
780
781
/*--------------------------------------------------------------------
782
 * The debug parameter
783
 */
784
785
static const char * const debug_tags[] = {
786
#  define DEBUG_BIT(U, l, d) [DBG_##U] = #l,
787
#  include "tbl/debug_bits.h"
788
       NULL
789
};
790
791
int v_matchproto_(tweak_t)
792 71334
tweak_debug(struct vsb *vsb, const struct parspec *par, const char *arg)
793
{
794
795 71334
        return (tweak_generic_bits(vsb, par, arg, mgt_param.debug_bits,
796
            DBG_Reserved, debug_tags, "debug bit", '+'));
797
}
798
799
/*--------------------------------------------------------------------
800
 * The experimental parameter
801
 */
802
803
//lint --e{766} not used - remove this linter suppression when adding back exp bits
804
805
static const char * const experimental_tags[] = {
806
#  define EXPERIMENTAL_BIT(U, l, d) [EXPERIMENT_##U] = #l,
807
#  include "tbl/experimental_bits.h"
808
       NULL
809
};
810
811
int v_matchproto_(tweak_t)
812 47038
tweak_experimental(struct vsb *vsb, const struct parspec *par, const char *arg)
813
{
814
815 47038
        return (tweak_generic_bits(vsb, par, arg, mgt_param.experimental_bits,
816
            EXPERIMENT_Reserved, experimental_tags, "experimental bit", '+'));
817
}
818
819
/*--------------------------------------------------------------------
820
 * The feature parameter
821
 */
822
823
static const char * const feature_tags[] = {
824
#  define FEATURE_BIT(U, l, d) [FEATURE_##U] = #l,
825
#  include "tbl/feature_bits.h"
826
       NULL
827
};
828
829
int v_matchproto_(tweak_t)
830 49747
tweak_feature(struct vsb *vsb, const struct parspec *par, const char *arg)
831
{
832
833 49747
        return (tweak_generic_bits(vsb, par, arg, mgt_param.feature_bits,
834
            FEATURE_Reserved, feature_tags, "feature bit", '+'));
835
}
836
837
/*--------------------------------------------------------------------
838
 * The vcc_feature parameter
839
 */
840
841
static const char * const vcc_feature_tags[] = {
842
#  define VCC_FEATURE_BIT(U, l, d) [VCC_FEATURE_##U] = #l,
843
#  include "tbl/vcc_feature_bits.h"
844
       NULL
845
};
846
847
int v_matchproto_(tweak_t)
848 47668
tweak_vcc_feature(struct vsb *vsb, const struct parspec *par, const char *arg)
849
{
850
        const struct parspec *orig;
851
        char buf[32];
852
        int val;
853
854 47668
        if (arg != NULL && arg != JSON_FMT &&
855 23918
            vstrcmp(par->name, "vcc_feature")) {
856 0
                orig = TRUST_ME(par->priv);
857 0
                val = parse_boolean(vsb, arg);
858 0
                if (val < 0)
859 0
                        return (-1);
860 0
                bprintf(buf, "%c%s", val ? '+' : '-',
861
                    par->name + vstrlen("vcc_"));
862 0
                return (tweak_vcc_feature(vsb, orig, buf));
863
        }
864 47668
        return (tweak_generic_bits(vsb, par, arg, mgt_param.vcc_feature_bits,
865
            VCC_FEATURE_Reserved, vcc_feature_tags, "vcc_feature bit", '+'));
866 47668
}