GCOV - Varnish Cache


/*-
 * Copyright (c) 2006 Verdens Gang AS
 * Copyright (c) 2006-2011 Varnish Software AS
 * All rights reserved.
 *
 * Author: Poul-Henning Kamp <phk@phk.freebsd.dk>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * Functions for tweaking parameters
 *
 */

#include "config.h"

#include <limits.h>
#include <math.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

#include "mgt/mgt.h"

#include "mgt/mgt_param.h"
#include "storage/storage.h"
#include "vav.h"
#include "vnum.h"
#include "vsl_priv.h"

const char * const JSON_FMT = (const char *)&JSON_FMT;

/*--------------------------------------------------------------------
 * Generic handling of double typed parameters
 */

typedef double parse_double_f(const char *, const char **);

static double
parse_decimal(const char *p, const char **err)
{
        double v;

        v = SF_Parse_Decimal(&p, 0, err);
        if (errno == 0 && *p != '\0') {
                errno = EINVAL;
                *err = "Invalid number";
        }
        return (v);
}

static int
tweak_generic_double(struct vsb *vsb, const char *arg, const struct parspec *pp,
    parse_double_f parse, const char *fmt)
{
        volatile double u, minv = VRT_DECIMAL_MIN, maxv = VRT_DECIMAL_MAX;
        volatile double *dest = pp->priv;
        const char *err;

        if (arg != NULL && arg != JSON_FMT) {
                if (pp->min != NULL) {
                        minv = parse(pp->min, &err);
                        if (errno) {
                                VSB_printf(vsb, "Min: %s (%s)\n", err, pp->min);
                                return (-1);
                        }
                }
                if (pp->max != NULL) {
                        maxv = parse(pp->max, &err);
                        if (errno) {
                                VSB_printf(vsb, "Max: %s (%s)\n", err, pp->max);
                                return (-1);
                        }
                }

                u = parse(arg, &err);
                if (errno) {
                        VSB_printf(vsb, "%s (%s)\n", err, arg);
                        return (-1);
                }
                if (u < minv) {
                        VSB_printf(vsb,
                            "Must be greater or equal to %s\n", pp->min);
                        return (-1);
                }
                if (u > maxv) {
                        VSB_printf(vsb,
                            "Must be less than or equal to %s\n", pp->max);
                        return (-1);
                }
                *dest = u;
        } else {
                VSB_printf(vsb, fmt, *dest);
        }
        return (0);
}

/*--------------------------------------------------------------------*/

static double
parse_duration(const char *p, const char **err)
{
        double v, r;

        v = SF_Parse_Decimal(&p, 0, err);
        if (*p == '\0')
                return (v);

        r = VNUM_duration_unit(v, p, NULL);
        if (isnan(r)) {
                errno = EINVAL;
                *err = "Invalid duration unit";
        }

        return (r);
}

int v_matchproto_(tweak_t)
tweak_timeout(struct vsb *vsb, const struct parspec *par, const char *arg)
{

        return (tweak_generic_double(vsb, arg, par, parse_duration, "%.3f"));
}

/*--------------------------------------------------------------------*/

int v_matchproto_(tweak_t)
tweak_double(struct vsb *vsb, const struct parspec *par, const char *arg)
{

        return (tweak_generic_double(vsb, arg, par, parse_decimal, "%g"));
}

/*--------------------------------------------------------------------*/

static int
parse_boolean(struct vsb *vsb, const char *arg)
{

        if (!strcasecmp(arg, "off"))
                return (0);
        if (!strcasecmp(arg, "disable"))
                return (0);
        if (!strcasecmp(arg, "no"))
                return (0);
        if (!strcasecmp(arg, "false"))
                return (0);
        if (!strcasecmp(arg, "on"))
                return (1);
        if (!strcasecmp(arg, "enable"))
                return (1);
        if (!strcasecmp(arg, "yes"))
                return (1);
        if (!strcasecmp(arg, "true"))
                return (1);

        VSB_cat(vsb, "use \"on\" or \"off\"\n");
        return (-1);
}

int v_matchproto_(tweak_t)
tweak_boolean(struct vsb *vsb, const struct parspec *par, const char *arg)
{
        volatile unsigned *dest;
        int val;

        dest = par->priv;
        if (arg != NULL && arg != JSON_FMT) {
                val = parse_boolean(vsb, arg);
                if (val < 0)
                        return (-1);
                *dest = val;
        } else if (arg == JSON_FMT) {
                VSB_printf(vsb, "%s", *dest ? "true" : "false");
        } else {
                VSB_printf(vsb, "%s", *dest ? "on" : "off");
        }
        return (0);
}

/*--------------------------------------------------------------------*/

static int
tweak_generic_uint(struct vsb *vsb, volatile unsigned *dest, const char *arg,
    const char *min, const char *max,
    const char *min_reason, const char *max_reason)
{
        unsigned u, minv = 0, maxv = 0;
        char *p;

        if (arg != NULL && arg != JSON_FMT) {
                if (min != NULL) {
                        p = NULL;
                        minv = strtoul(min, &p, 0);
                        if (*arg == '\0' || *p != '\0') {
                                VSB_printf(vsb, "Illegal Min: %s\n", min);
                                return (-1);
                        }
                }
                if (max != NULL) {
                        p = NULL;
                        maxv = strtoul(max, &p, 0);
                        if (*arg == '\0' || *p != '\0') {
                                VSB_printf(vsb, "Illegal Max: %s\n", max);
                                return (-1);
                        }
                }
                p = NULL;
                if (!strcasecmp(arg, "unlimited"))
                        u = UINT_MAX;
                else {
                        u = strtoul(arg, &p, 0);
                        if (*arg == '\0' || *p != '\0') {
                                VSB_printf(vsb, "Not a number (%s)\n", arg);
                                return (-1);
                        }
                }
                if (min != NULL && u < minv) {
                        VSB_printf(vsb, "Must be at least %s", min);
                        if (min_reason != NULL)
                                VSB_printf(vsb, " (%s)", min_reason);
                        VSB_putc(vsb, '\n');
                        return (-1);
                }
                if (max != NULL && u > maxv) {
                        VSB_printf(vsb, "Must be no more than %s", max);
                        if (max_reason != NULL)
                                VSB_printf(vsb, " (%s)", max_reason);
                        VSB_putc(vsb, '\n');
                        return (-1);
                }
                *dest = u;
        } else if (*dest == UINT_MAX && arg != JSON_FMT) {
                VSB_cat(vsb, "unlimited");
        } else {
                VSB_printf(vsb, "%u", *dest);
        }
        return (0);
}

/*--------------------------------------------------------------------*/

int v_matchproto_(tweak_t)
tweak_uint(struct vsb *vsb, const struct parspec *par, const char *arg)
{
        volatile unsigned *dest;

        dest = par->priv;
        return (tweak_generic_uint(vsb, dest, arg, par->min, par->max,
            par->dyn_min_reason, par->dyn_max_reason));
}

/*--------------------------------------------------------------------*/

static void
fmt_bytes(struct vsb *vsb, uintmax_t t)
{
        const char *p;

        if (t == 0 || t & 0xff) {
                VSB_printf(vsb, "%jub", t);
                return;
        }
        for (p = "kMGTPEZY"; *p; p++) {
                if (t & 0x300) {
                        VSB_printf(vsb, "%.2f%c", t / 1024.0, *p);
                        return;
                }
                t /= 1024;
                if (t & 0x0ff) {
                        VSB_printf(vsb, "%ju%c", t, *p);
                        return;
                }
        }
        VSB_cat(vsb, "(bogus number)");
}

static int
tweak_generic_bytes(struct vsb *vsb, volatile ssize_t *dest, const char *arg,
    const char *min, const char *max)
{
        uintmax_t r, rmin = 0, rmax = 0;
        const char *p;

        if (arg != NULL && arg != JSON_FMT) {
                if (min != NULL) {
                        p = VNUM_2bytes(min, &rmin, 0);
                        if (p != NULL) {
                                VSB_printf(vsb, "Invalid min-val: %s\n", min);
                                return (-1);
                        }
                }
                if (max != NULL) {
                        p = VNUM_2bytes(max, &rmax, 0);
                        if (p != NULL) {
                                VSB_printf(vsb, "Invalid max-val: %s\n", max);
                                return (-1);
                        }
                }
                p = VNUM_2bytes(arg, &r, 0);
                if (p != NULL) {
                        VSB_cat(vsb, "Could not convert to bytes.\n");
                        VSB_printf(vsb, "%s\n", p);
                        VSB_cat(vsb, "  Try something like '80k' or '120M'\n");
                        return (-1);
                }
                if ((uintmax_t)((ssize_t)r) != r) {
                        fmt_bytes(vsb, r);
                        VSB_cat(vsb, " is too large for this architecture.\n");
                        return (-1);
                }
                if (max != NULL && r > rmax) {
                        VSB_printf(vsb, "Must be no more than %s\n", max);
                        VSB_cat(vsb, "\n");
                        return (-1);
                }
                if (min != NULL && r < rmin) {
                        VSB_printf(vsb, "Must be at least %s\n", min);
                        return (-1);
                }
                *dest = r;
        } else if (arg == JSON_FMT) {
                VSB_printf(vsb, "%zd", *dest);
        } else {
                fmt_bytes(vsb, *dest);
        }
        return (0);
}

/*--------------------------------------------------------------------*/

int v_matchproto_(tweak_t)
tweak_bytes(struct vsb *vsb, const struct parspec *par, const char *arg)
{
        volatile ssize_t *dest;

        dest = par->priv;
        return (tweak_generic_bytes(vsb, dest, arg, par->min, par->max));
}

/*--------------------------------------------------------------------*/

int v_matchproto_(tweak_t)
tweak_bytes_u(struct vsb *vsb, const struct parspec *par, const char *arg)
{
        volatile unsigned *d1;
        volatile ssize_t dest;

        d1 = par->priv;
        dest = *d1;
        if (tweak_generic_bytes(vsb, &dest, arg, par->min, par->max))
                return (-1);
        *d1 = dest;
        return (0);
}

/*--------------------------------------------------------------------
 * vsl_buffer and vsl_reclen have dependencies.
 */

int v_matchproto_(tweak_t)
tweak_vsl_buffer(struct vsb *vsb, const struct parspec *par, const char *arg)
{
        volatile unsigned *d1;
        volatile ssize_t dest;

        d1 = par->priv;
        dest = *d1;
        if (tweak_generic_bytes(vsb, &dest, arg, par->min, par->max))
                return (-1);
        *d1 = dest;
        MCF_ParamConf(MCF_MAXIMUM, "vsl_reclen", "%u", *d1 - 12);
        return (0);
}

int v_matchproto_(tweak_t)
tweak_vsl_reclen(struct vsb *vsb, const struct parspec *par, const char *arg)
{
        volatile unsigned *d1;
        volatile ssize_t dest;

        d1 = par->priv;
        dest = *d1;
        if (tweak_generic_bytes(vsb, &dest, arg, par->min, par->max))
                return (-1);
        *d1 = dest;
        MCF_ParamConf(MCF_MINIMUM, "vsl_buffer", "%u", *d1 + 12);
        return (0);
}

/*--------------------------------------------------------------------*/

int v_matchproto_(tweak_t)
tweak_string(struct vsb *vsb, const struct parspec *par, const char *arg)
{
        char **p = TRUST_ME(par->priv);

        AN(p);
        if (arg == NULL) {
                VSB_quote(vsb, *p, -1, 0);
        } else if (arg == JSON_FMT) {
                VSB_putc(vsb, '"');
                VSB_quote(vsb, *p, -1, VSB_QUOTE_JSON);
                VSB_putc(vsb, '"');
        } else {
                REPLACE(*p, arg);
        }
        return (0);
}

/*--------------------------------------------------------------------*/

int v_matchproto_(tweak_t)
tweak_poolparam(struct vsb *vsb, const struct parspec *par, const char *arg)
{
        volatile struct poolparam *pp, px;
        struct parspec pt;
        char **av;
        int retval = 0;

        pp = par->priv;
        if (arg == JSON_FMT) {
                VSB_cat(vsb, "{\n");
                VSB_indent(vsb, 8);
                VSB_printf(vsb, "\"min_pool\": %u,\n", pp->min_pool);
                VSB_printf(vsb, "\"max_pool\": %u,\n", pp->max_pool);
                VSB_printf(vsb, "\"max_age\": %g\n", pp->max_age);
                VSB_indent(vsb, -4);
                VSB_cat(vsb, "}");
        } else if (arg == NULL) {
                VSB_printf(vsb, "%u,%u,%g",
                    pp->min_pool, pp->max_pool, pp->max_age);
        } else {
                av = VAV_Parse(arg, NULL, ARGV_COMMA);
                do {
                        if (av[0] != NULL) {
                                VSB_printf(vsb, "Parse error: %s", av[0]);
                                retval = -1;
                                break;
                        }
                        if (av[1] == NULL || av[2] == NULL || av[3] == NULL) {
                                VSB_cat(vsb,
                                    "Three fields required:"
                                    " min_pool, max_pool and max_age\n");
                                retval = -1;
                                break;
                        }
                        px = *pp;
                        retval = tweak_generic_uint(vsb, &px.min_pool, av[1],
                            par->min, par->max, par->dyn_min_reason,
                            par->dyn_max_reason);
                        if (retval)
                                break;
                        retval = tweak_generic_uint(vsb, &px.max_pool, av[2],
                            par->min, par->max, par->dyn_min_reason,
                            par->dyn_max_reason);
                        if (retval)
                                break;
                        pt.priv = &px.max_age;
                        pt.min = "0";
                        pt.max = "1000000";
                        retval = tweak_generic_double(vsb, av[3], &pt,
                            parse_decimal, "%.0f");
                        if (retval)
                                break;
                        if (px.min_pool > px.max_pool) {
                                VSB_cat(vsb,
                                    "min_pool cannot be larger"
                                    " than max_pool\n");
                                retval = -1;
                                break;
                        }
                        *pp = px;
                } while (0);
                VAV_Free(av);
        }
        return (retval);
}

/*--------------------------------------------------------------------
 * Thread pool tweaks.
 *
 * The min/max values automatically update the opposites appropriate
 * limit, so they don't end up crossing.
 */

int v_matchproto_(tweak_t)
tweak_thread_pool_min(struct vsb *vsb, const struct parspec *par,
    const char *arg)
{
        if (tweak_uint(vsb, par, arg))
                return (-1);

        MCF_ParamConf(MCF_MINIMUM, "thread_pool_max",
            "%u", mgt_param.wthread_min);
        MCF_ParamConf(MCF_MAXIMUM, "thread_pool_reserve",
            "%u", mgt_param.wthread_min * 950 / 1000);
        return (0);
}

int v_matchproto_(tweak_t)
tweak_thread_pool_max(struct vsb *vsb, const struct parspec *par,
    const char *arg)
{

        if (tweak_uint(vsb, par, arg))
                return (-1);

        MCF_ParamConf(MCF_MAXIMUM, "thread_pool_min",
            "%u", mgt_param.wthread_max);
        return (0);
}

/*--------------------------------------------------------------------
 * Tweak storage
 */

int v_matchproto_(tweak_t)
tweak_storage(struct vsb *vsb, const struct parspec *par, const char *arg)
{
        struct stevedore *stv;

        /* XXX: If we want to remove the MUST_RESTART flag from the
         * h2_rxbuf_storage parameter, we could have a mechanism here
         * that when the child is running calls out through CLI to change
         * the stevedore being used. */

        if (arg == NULL || arg == JSON_FMT)
                return (tweak_string(vsb, par, arg));

        if (!strcmp(arg, "Transient")) {
                /* Always allow setting to the special name
                 * "Transient". There will always be a stevedore with this
                 * name, but it may not have been configured at the time
                 * this is called. */
        } else {
                /* Only allow setting the value to a known configured
                 * stevedore */
                STV_Foreach(stv) {
                        CHECK_OBJ_NOTNULL(stv, STEVEDORE_MAGIC);
                        if (!strcmp(stv->ident, arg))
                                break;
                }
                if (stv == NULL) {
                        VSB_printf(vsb, "unknown storage backend '%s'", arg);
                        return (-1);
                }
        }
        return (tweak_string(vsb, par, arg));
}

/*--------------------------------------------------------------------
 * Tweak alias
 */

int v_matchproto_(tweak_t)
tweak_alias(struct vsb *vsb, const struct parspec *par, const char *arg)
{
        const struct parspec *orig;
        struct parspec alias[1];

        orig = TRUST_ME(par->priv);
        AN(orig);
        memcpy(alias, orig, sizeof *orig);
        alias->name = par->name;
        alias->priv = TRUST_ME(orig);
        return (alias->func(vsb, alias, arg));
}

/*--------------------------------------------------------------------
 * Tweak bits
 */

enum bit_do {BSET, BCLR, BTST};

static int
bit(uint8_t *p, unsigned no, enum bit_do act)
{
        uint8_t b;

        p += (no >> 3);
        b = (0x80 >> (no & 7));
        if (act == BSET)
                *p |= b;
        else if (act == BCLR)
                *p &= ~b;
        return (*p & b);
}

static inline void
bit_clear(uint8_t *p, unsigned l)
{

        memset(p, 0, ((size_t)l + 7) >> 3);
}

/*--------------------------------------------------------------------
 */

static int
bit_tweak(struct vsb *vsb, uint8_t *p, unsigned l, const char *arg,
    const char * const *tags, const char *desc, char sign)
{
        int i, n;
        unsigned j;
        char **av;
        const char *s;

        av = VAV_Parse(arg, &n, ARGV_COMMA);
        if (av[0] != NULL) {
                VSB_printf(vsb, "Cannot parse: %s\n", av[0]);
                VAV_Free(av);
                return (-1);
        }
        for (i = 1; av[i] != NULL; i++) {
                s = av[i];
                if (sign == '+' && !strcmp(s, "none")) {
                        bit_clear(p, l);
                        continue;
                }
                if (sign == '-' && !strcmp(s, "all")) {
                        bit_clear(p, l);
                        continue;
                }
                if (*s != '-' && *s != '+') {
                        VSB_printf(vsb, "Missing '+' or '-' (%s)\n", s);
                        VAV_Free(av);
                        return (-1);
                }
                for (j = 0; j < l; j++) {
                        if (tags[j] != NULL && !strcasecmp(s + 1, tags[j]))
                                break;
                }
                if (tags[j] == NULL) {
                        VSB_printf(vsb, "Unknown %s (%s)\n", desc, s);
                        VAV_Free(av);
                        return (-1);
                }
                assert(j < l);
                if (s[0] == sign)
                        (void)bit(p, j, BSET);
                else
                        (void)bit(p, j, BCLR);
        }
        VAV_Free(av);
        return (0);
}


/*--------------------------------------------------------------------
 */

static int
tweak_generic_bits(struct vsb *vsb, const struct parspec *par, const char *arg,
    uint8_t *p, unsigned l, const char * const *tags, const char *desc,
    char sign)
{
        unsigned j;

        if (arg != NULL && !strcmp(arg, "default")) {
                /* XXX: deprecated in favor of param.reset */
                return (tweak_generic_bits(vsb, par, par->def, p, l, tags,
                    desc, sign));
        }

        if (arg != NULL && arg != JSON_FMT)
                return (bit_tweak(vsb, p, l, arg, tags, desc, sign));

        if (arg == JSON_FMT)
                VSB_putc(vsb, '"');
        VSB_cat(vsb, sign == '+' ? "none" : "all");
        for (j = 0; j < l; j++) {
                if (bit(p, j, BTST))
                        VSB_printf(vsb, ",%c%s", sign, tags[j]);
        }
        if (arg == JSON_FMT)
                VSB_putc(vsb, '"');
        return (0);
}

/*--------------------------------------------------------------------
 * The vsl_mask parameter
 */

static const char * const VSL_tags[256] = {
#  define SLTM(foo,flags,sdesc,ldesc) [SLT_##foo] = #foo,
#  include "tbl/vsl_tags.h"
};

int v_matchproto_(tweak_t)
tweak_vsl_mask(struct vsb *vsb, const struct parspec *par, const char *arg)
{

        return (tweak_generic_bits(vsb, par, arg, mgt_param.vsl_mask,
            SLT__Reserved, VSL_tags, "VSL tag", '-'));
}

/*--------------------------------------------------------------------
 * The debug parameter
 */

static const char * const debug_tags[] = {
#  define DEBUG_BIT(U, l, d) [DBG_##U] = #l,
#  include "tbl/debug_bits.h"
       NULL
};

int v_matchproto_(tweak_t)
tweak_debug(struct vsb *vsb, const struct parspec *par, const char *arg)
{

        return (tweak_generic_bits(vsb, par, arg, mgt_param.debug_bits,
            DBG_Reserved, debug_tags, "debug bit", '+'));
}

/*--------------------------------------------------------------------
 * The experimental parameter
 */

static const char * const experimental_tags[] = {
#  define EXPERIMENTAL_BIT(U, l, d) [EXPERIMENT_##U] = #l,
#  include "tbl/experimental_bits.h"
       NULL
};

int v_matchproto_(tweak_t)
tweak_experimental(struct vsb *vsb, const struct parspec *par, const char *arg)
{

        return (tweak_generic_bits(vsb, par, arg, mgt_param.experimental_bits,
            EXPERIMENT_Reserved, experimental_tags, "experimental bit", '+'));
}

/*--------------------------------------------------------------------
 * The feature parameter
 */

static const char * const feature_tags[] = {
#  define FEATURE_BIT(U, l, d) [FEATURE_##U] = #l,
#  include "tbl/feature_bits.h"
       NULL
};

int v_matchproto_(tweak_t)
tweak_feature(struct vsb *vsb, const struct parspec *par, const char *arg)
{

        return (tweak_generic_bits(vsb, par, arg, mgt_param.feature_bits,
            FEATURE_Reserved, feature_tags, "feature bit", '+'));
}

/*--------------------------------------------------------------------
 * The vcc_feature parameter
 */

static const char * const vcc_feature_tags[] = {
#  define VCC_FEATURE_BIT(U, l, d) [VCC_FEATURE_##U] = #l,
#  include "tbl/vcc_feature_bits.h"
       NULL
};

int v_matchproto_(tweak_t)
tweak_vcc_feature(struct vsb *vsb, const struct parspec *par, const char *arg)
{
        const struct parspec *orig;
        char buf[32];
        int val;

        if (arg != NULL && arg != JSON_FMT &&
            strcmp(par->name, "vcc_feature")) {
                orig = TRUST_ME(par->priv);
                val = parse_boolean(vsb, arg);
                if (val < 0)
                        return (-1);
                bprintf(buf, "%c%s", val ? '+' : '-',
                    par->name + strlen("vcc_"));
                return (tweak_vcc_feature(vsb, orig, buf));
        }
        return (tweak_generic_bits(vsb, par, arg, mgt_param.vcc_feature_bits,
            VCC_FEATURE_Reserved, vcc_feature_tags, "vcc_feature bit", '+'));
}

		varnish-cache/bin/varnishd/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	447150	parse_decimal(const char p, const char *err)
60		{
61		double v;
62
63	447150	v = SF_Parse_Decimal(&p, 0, err);
64	447150	if (errno == 0 && *p != '\0') {
65	25	errno = EINVAL;
66	25	*err = "Invalid number";
67	25	}
68	447150	return (v);
69		}
70
71		static int
72	4209825	tweak_generic_double(struct vsb vsb, const char arg, const struct parspec *pp,
73		parse_double_f parse, const char *fmt)
74		{
75	4209825	volatile double u, minv = VRT_DECIMAL_MIN, maxv = VRT_DECIMAL_MAX;
76	4209825	volatile double *dest = pp->priv;
77		const char *err;
78
79	4209825	if (arg != NULL && arg != JSON_FMT) {
80	2135975	if (pp->min != NULL) {
81	2135975	minv = parse(pp->min, &err);
82	2135975	if (errno) {
83	0	VSB_printf(vsb, "Min: %s (%s)\n", err, pp->min);
84	0	return (-1);
85		}
86	2135975	}
87	2135975	if (pp->max != NULL) {
88	595475	maxv = parse(pp->max, &err);
89	595475	if (errno) {
90	0	VSB_printf(vsb, "Max: %s (%s)\n", err, pp->max);
91	0	return (-1);
92		}
93	595475	}
94
95	2135975	u = parse(arg, &err);
96	2135975	if (errno) {
97	100	VSB_printf(vsb, "%s (%s)\n", err, arg);
98	100	return (-1);
99		}
100	2135875	if (u < minv) {
101	50	VSB_printf(vsb,
102	25	"Must be greater or equal to %s\n", pp->min);
103	25	return (-1);
104		}
105	2135850	if (u > maxv) {
106	50	VSB_printf(vsb,
107	25	"Must be less than or equal to %s\n", pp->max);
108	25	return (-1);
109		}
110	2135825	*dest = u;
111	2135825	} else {
112	2073850	VSB_printf(vsb, fmt, *dest);
113		}
114	4209675	return (0);
115	4209825	}
116
117		/--------------------------------------------------------------------/
118
119		static double
120	4420275	parse_duration(const char p, const char *err)
121		{
122		double v, r;
123
124	4420275	v = SF_Parse_Decimal(&p, 0, err);
125	4420275	if (*p == '\0')
126	4320525	return (v);
127
128	99750	r = VNUM_duration_unit(v, p, NULL);
129	99750	if (isnan(r)) {
130	50	errno = EINVAL;
131	50	*err = "Invalid duration unit";
132	50	}
133
134	99750	return (r);
135	4420275	}
136
137		int v_matchproto_(tweak_t)
138	3985975	tweak_timeout(struct vsb vsb, const struct parspec par, const char *arg)
139		{
140
141	3985975	return (tweak_generic_double(vsb, arg, par, parse_duration, "%.3f"));
142		}
143
144		/--------------------------------------------------------------------/
145
146		int v_matchproto_(tweak_t)
147	149225	tweak_double(struct vsb vsb, const struct parspec par, const char *arg)
148		{
149
150	149225	return (tweak_generic_double(vsb, arg, par, parse_decimal, "%g"));
151		}
152
153		/--------------------------------------------------------------------/
154
155		static int
156	294125	parse_boolean(struct vsb vsb, const char arg)
157		{
158
159	294125	if (!strcasecmp(arg, "off"))
160	95100	return (0);
161	199025	if (!strcasecmp(arg, "disable"))
162	25	return (0);
163	199000	if (!strcasecmp(arg, "no"))
164	25	return (0);
165	198975	if (!strcasecmp(arg, "false"))
166	100	return (0);
167	198875	if (!strcasecmp(arg, "on"))
168	198525	return (1);
169	350	if (!strcasecmp(arg, "enable"))
170	25	return (1);
171	325	if (!strcasecmp(arg, "yes"))
172	25	return (1);
173	300	if (!strcasecmp(arg, "true"))
174	275	return (1);
175
176	25	VSB_cat(vsb, "use \"on\" or \"off\"\n");
177	25	return (-1);
178	294125	}
179
180		int v_matchproto_(tweak_t)
181	546125	tweak_boolean(struct vsb vsb, const struct parspec par, const char *arg)
182		{
183		volatile unsigned *dest;
184		int val;
185
186	546125	dest = par->priv;
187	546125	if (arg != NULL && arg != JSON_FMT) {
188	294125	val = parse_boolean(vsb, arg);
189	294125	if (val < 0)
190	25	return (-1);
191	294100	*dest = val;
192	546100	} else if (arg == JSON_FMT) {
193	750	VSB_printf(vsb, "%s", *dest ? "true" : "false");
194	750	} else {
195	251250	VSB_printf(vsb, "%s", *dest ? "on" : "off");
196		}
197	546100	return (0);
198	546125	}
199
200		/--------------------------------------------------------------------/
201
202		static int
203	3411150	tweak_generic_uint(struct vsb vsb, volatile unsigned dest, const char *arg,
204		const char min, const char max,
205		const char min_reason, const char max_reason)
206		{
207	3411150	unsigned u, minv = 0, maxv = 0;
208		char *p;
209
210	3411150	if (arg != NULL && arg != JSON_FMT) {
211	1787550	if (min != NULL) {
212	1563600	p = NULL;
213	1563600	minv = strtoul(min, &p, 0);
214	1563600	if (arg == '\0' \|\| p != '\0') {
215	0	VSB_printf(vsb, "Illegal Min: %s\n", min);
216	0	return (-1);
217		}
218	1563600	}
219	1787550	if (max != NULL) {
220	669575	p = NULL;
221	669575	maxv = strtoul(max, &p, 0);
222	669575	if (arg == '\0' \|\| p != '\0') {
223	0	VSB_printf(vsb, "Illegal Max: %s\n", max);
224	0	return (-1);
225		}
226	669575	}
227	1787550	p = NULL;
228	1787550	if (!strcasecmp(arg, "unlimited"))
229	25	u = UINT_MAX;
230		else {
231	1787525	u = strtoul(arg, &p, 0);
232	1787525	if (arg == '\0' \|\| p != '\0') {
233	50	VSB_printf(vsb, "Not a number (%s)\n", arg);
234	50	return (-1);
235		}
236		}
237	1787500	if (min != NULL && u < minv) {
238	75	VSB_printf(vsb, "Must be at least %s", min);
239	75	if (min_reason != NULL)
240	50	VSB_printf(vsb, " (%s)", min_reason);
241	75	VSB_putc(vsb, '\n');
242	75	return (-1);
243		}
244	1787425	if (max != NULL && u > maxv) {
245	150	VSB_printf(vsb, "Must be no more than %s", max);
246	150	if (max_reason != NULL)
247	125	VSB_printf(vsb, " (%s)", max_reason);
248	150	VSB_putc(vsb, '\n');
249	150	return (-1);
250		}
251	1787275	*dest = u;
252	3410875	} else if (*dest == UINT_MAX && arg != JSON_FMT) {
253	125	VSB_cat(vsb, "unlimited");
254	125	} else {
255	1623475	VSB_printf(vsb, "%u", *dest);
256		}
257	3410875	return (0);
258	3411150	}
259
260		/--------------------------------------------------------------------/
261
262		int v_matchproto_(tweak_t)
263	3261825	tweak_uint(struct vsb vsb, const struct parspec par, const char *arg)
264		{
265		volatile unsigned *dest;
266
267	3261825	dest = par->priv;
268	6523650	return (tweak_generic_uint(vsb, dest, arg, par->min, par->max,
269	3261825	par->dyn_min_reason, par->dyn_max_reason));
270		}
271
272		/--------------------------------------------------------------------/
273
274		static void
275	1346675	fmt_bytes(struct vsb *vsb, uintmax_t t)
276		{
277		const char *p;
278
279	1346675	if (t == 0 \|\| t & 0xff) {
280	472225	VSB_printf(vsb, "%jub", t);
281	472225	return;
282		}
283	1198475	for (p = "kMGTPEZY"; *p; p++) {
284	1198475	if (t & 0x300) {
285	124650	VSB_printf(vsb, "%.2f%c", t / 1024.0, *p);
286	124650	return;
287		}
288	1073825	t /= 1024;
289	1073825	if (t & 0x0ff) {
290	749800	VSB_printf(vsb, "%ju%c", t, *p);
291	749800	return;
292		}
293	324025	}
294	0	VSB_cat(vsb, "(bogus number)");
295	1346675	}
296
297		static int
298	2757300	tweak_generic_bytes(struct vsb vsb, volatile ssize_t dest, const char *arg,
299		const char min, const char max)
300		{
301	2757300	uintmax_t r, rmin = 0, rmax = 0;
302		const char *p;
303
304	2757300	if (arg != NULL && arg != JSON_FMT) {
305	1408900	if (min != NULL) {
306	1408900	p = VNUM_2bytes(min, &rmin, 0);
307	1408900	if (p != NULL) {
308	0	VSB_printf(vsb, "Invalid min-val: %s\n", min);
309	0	return (-1);
310		}
311	1408900	}
312	1408900	if (max != NULL) {
313	663800	p = VNUM_2bytes(max, &rmax, 0);
314	663800	if (p != NULL) {
315	0	VSB_printf(vsb, "Invalid max-val: %s\n", max);
316	0	return (-1);
317		}
318	663800	}
319	1408900	p = VNUM_2bytes(arg, &r, 0);
320	1408900	if (p != NULL) {
321	50	VSB_cat(vsb, "Could not convert to bytes.\n");
322	50	VSB_printf(vsb, "%s\n", p);
323	50	VSB_cat(vsb, " Try something like '80k' or '120M'\n");
324	50	return (-1);
325		}
326	1408850	if ((uintmax_t)((ssize_t)r) != r) {
327	0	fmt_bytes(vsb, r);
328	0	VSB_cat(vsb, " is too large for this architecture.\n");
329	0	return (-1);
330		}
331	1408850	if (max != NULL && r > rmax) {
332	25	VSB_printf(vsb, "Must be no more than %s\n", max);
333	25	VSB_cat(vsb, "\n");
334	25	return (-1);
335		}
336	1408825	if (min != NULL && r < rmin) {
337	25	VSB_printf(vsb, "Must be at least %s\n", min);
338	25	return (-1);
339		}
340	1408800	*dest = r;
341	2757200	} else if (arg == JSON_FMT) {
342	1725	VSB_printf(vsb, "%zd", *dest);
343	1725	} else {
344	1346675	fmt_bytes(vsb, *dest);
345		}
346	2757200	return (0);
347	2757300	}
348
349		/--------------------------------------------------------------------/
350
351		int v_matchproto_(tweak_t)
352	570725	tweak_bytes(struct vsb vsb, const struct parspec par, const char *arg)
353		{
354		volatile ssize_t *dest;
355
356	570725	dest = par->priv;
357	570725	return (tweak_generic_bytes(vsb, dest, arg, par->min, par->max));
358		}
359
360		/--------------------------------------------------------------------/
361
362		int v_matchproto_(tweak_t)
363	1937650	tweak_bytes_u(struct vsb vsb, const struct parspec par, const char *arg)
364		{
365		volatile unsigned *d1;
366		volatile ssize_t dest;
367
368	1937650	d1 = par->priv;
369	1937650	dest = *d1;
370	1937650	if (tweak_generic_bytes(vsb, &dest, arg, par->min, par->max))
371	100	return (-1);
372	1937550	*d1 = dest;
373	1937550	return (0);
374	1937650	}
375
376		/*--------------------------------------------------------------------
377		* vsl_buffer and vsl_reclen have dependencies.
378		*/
379
380		int v_matchproto_(tweak_t)
381	99725	tweak_vsl_buffer(struct vsb vsb, const struct parspec par, const char *arg)
382		{
383		volatile unsigned *d1;
384		volatile ssize_t dest;
385
386	99725	d1 = par->priv;
387	99725	dest = *d1;
388	99725	if (tweak_generic_bytes(vsb, &dest, arg, par->min, par->max))
389	0	return (-1);
390	99725	*d1 = dest;
391	99725	MCF_ParamConf(MCF_MAXIMUM, "vsl_reclen", "%u", *d1 - 12);
392	99725	return (0);
393	99725	}
394
395		int v_matchproto_(tweak_t)
396	149200	tweak_vsl_reclen(struct vsb vsb, const struct parspec par, const char *arg)
397		{
398		volatile unsigned *d1;
399		volatile ssize_t dest;
400
401	149200	d1 = par->priv;
402	149200	dest = *d1;
403	149200	if (tweak_generic_bytes(vsb, &dest, arg, par->min, par->max))
404	0	return (-1);
405	149200	*d1 = dest;
406	149200	MCF_ParamConf(MCF_MINIMUM, "vsl_buffer", "%u", *d1 + 12);
407	149200	return (0);
408	149200	}
409
410		/--------------------------------------------------------------------/
411
412		int v_matchproto_(tweak_t)
413	273075	tweak_string(struct vsb vsb, const struct parspec par, const char *arg)
414		{
415	273075	char **p = TRUST_ME(par->priv);
416
417	273075	AN(p);
418	273075	if (arg == NULL) {
419	125650	VSB_quote(vsb, *p, -1, 0);
420	273075	} else if (arg == JSON_FMT) {
421	375	VSB_putc(vsb, '"');
422	375	VSB_quote(vsb, *p, -1, VSB_QUOTE_JSON);
423	375	VSB_putc(vsb, '"');
424	375	} else {
425	147050	REPLACE(*p, arg);
426		}
427	273075	return (0);
428		}
429
430		/--------------------------------------------------------------------/
431
432		int v_matchproto_(tweak_t)
433	150425	tweak_poolparam(struct vsb vsb, const struct parspec par, const char *arg)
434		{
435		volatile struct poolparam *pp, px;
436		struct parspec pt;
437		char **av;
438	150425	int retval = 0;
439
440	150425	pp = par->priv;
441	150425	if (arg == JSON_FMT) {
442	275	VSB_cat(vsb, "{\n");
443	275	VSB_indent(vsb, 8);
444	275	VSB_printf(vsb, "\"min_pool\": %u,\n", pp->min_pool);
445	275	VSB_printf(vsb, "\"max_pool\": %u,\n", pp->max_pool);
446	275	VSB_printf(vsb, "\"max_age\": %g\n", pp->max_age);
447	275	VSB_indent(vsb, -4);
448	275	VSB_cat(vsb, "}");
449	150425	} else if (arg == NULL) {
450	150850	VSB_printf(vsb, "%u,%u,%g",
451	75425	pp->min_pool, pp->max_pool, pp->max_age);
452	75425	} else {
453	74725	av = VAV_Parse(arg, NULL, ARGV_COMMA);
454	74725	do {
455	74725	if (av[0] != NULL) {
456	25	VSB_printf(vsb, "Parse error: %s", av[0]);
457	25	retval = -1;
458	25	break;
459		}
460	74700	if (av[1] == NULL \|\| av[2] == NULL \|\| av[3] == NULL) {
461	25	VSB_cat(vsb,
462		"Three fields required:"
463		" min_pool, max_pool and max_age\n");
464	25	retval = -1;
465	25	break;
466		}
467	74675	px = *pp;
468	149350	retval = tweak_generic_uint(vsb, &px.min_pool, av[1],
469	74675	par->min, par->max, par->dyn_min_reason,
470	74675	par->dyn_max_reason);
471	74675	if (retval)
472	25	break;
473	149300	retval = tweak_generic_uint(vsb, &px.max_pool, av[2],
474	74650	par->min, par->max, par->dyn_min_reason,
475	74650	par->dyn_max_reason);
476	74650	if (retval)
477	25	break;
478	74625	pt.priv = &px.max_age;
479	74625	pt.min = "0";
480	74625	pt.max = "1000000";
481	74625	retval = tweak_generic_double(vsb, av[3], &pt,
482		parse_decimal, "%.0f");
483	74625	if (retval)
484	25	break;
485	74600	if (px.min_pool > px.max_pool) {
486	25	VSB_cat(vsb,
487		"min_pool cannot be larger"
488		" than max_pool\n");
489	25	retval = -1;
490	25	break;
491		}
492	74575	*pp = px;
493	74575	} while (0);
494	74725	VAV_Free(av);
495		}
496	150425	return (retval);
497		}
498
499		/*--------------------------------------------------------------------