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.
 */

#include "config.h"

#include <ctype.h>
#include <stdarg.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>

#include "mgt/mgt.h"
#include "common/heritage.h"

#include "mgt/mgt_param.h"
#include "vav.h"
#include "vcli_serve.h"

struct plist {
        unsigned                        magic;
#define PLIST_MAGIC                     0xbfc3ea16
        VTAILQ_ENTRY(plist)             list;
        struct parspec                  *spec;
};

static VTAILQ_HEAD(, plist)             phead = VTAILQ_HEAD_INITIALIZER(phead);

struct params mgt_param;
static const int margin1 = 8;
static int margin2 = 0;
static const int wrap_at = 72;
static const int tab0 = 3;

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

static const char TYPE_TIMEOUT_TEXT[] =
        "\n\n"
        "NB: This parameter can be disabled with the value \"never\".";

static const char OBJ_STICKY_TEXT[] =
        "\n\n"
        "NB: This parameter is evaluated only when objects are created. "
        "To change it for all objects, restart or ban everything.";

static const char DELAYED_EFFECT_TEXT[] =
        "\n\n"
        "NB: This parameter may take quite some time to take (full) effect.";

static const char MUST_RESTART_TEXT[] =
        "\n\n"
        "NB: This parameter will not take any effect until the "
        "child process has been restarted.";

static const char MUST_RELOAD_TEXT[] =
        "\n\n"
        "NB: This parameter will not take any effect until the "
        "VCL programs have been reloaded.";

static const char EXPERIMENTAL_TEXT[] =
        "\n\n"
        "NB: We do not know yet if it is a good idea to change "
        "this parameter, or if the default value is even sensible. "
        "Caution is advised, and feedback is most welcome.";

static const char WIZARD_TEXT[] =
        "\n\n"
        "NB: Do not change this parameter, unless a developer tell "
        "you to do so.";

static const char PROTECTED_TEXT[] =
        "\n\n"
        "NB: This parameter is protected and cannot be changed.";

static const char ONLY_ROOT_TEXT[] =
        "\n\n"
        "NB: This parameter only works if varnishd is run as root.";

static const char NOT_IMPLEMENTED_TEXT[] =
        "\n\n"
        "NB: This parameter depends on a feature which is not available"
        " on this platform.";

static const char PLATFORM_DEPENDENT_TEXT[] =
        "\n\n"
        "NB: This parameter depends on a feature which is not available"
        " on all platforms.";

static const char BUILD_OPTIONS_TEXT[] =
        "\n\n"
        "NB: The actual default value for this parameter depends on the"
        " Varnish build environment and options.";

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

static struct parspec *
mcf_findpar(const char *name)
{
        struct plist *pl;

        AN(name);
        VTAILQ_FOREACH(pl, &phead, list)
                if (!strcmp(pl->spec->name, name))
                        return (pl->spec);
        return (NULL);
}

static void
mcf_addpar(struct parspec *ps)
{
        struct plist *pl, *pl2;
        int i;

        ALLOC_OBJ(pl, PLIST_MAGIC);
        AN(pl);
        pl->spec = ps;
        VTAILQ_FOREACH(pl2, &phead, list) {
                i = strcmp(pl2->spec->name, pl->spec->name);
                if (i == 0) {
                        fprintf(stderr, "Duplicate param: %s\n", ps->name);
                        exit(4);
                } else if (i > 0) {
                        VTAILQ_INSERT_BEFORE(pl2, pl, list);
                        return;
                }
        }
        VTAILQ_INSERT_TAIL(&phead, pl, list);
}

/*--------------------------------------------------------------------
 * Wrap the text nicely.
 * Lines are allowed to contain two TABS and we render that as a table
 * taking the width of the first column into account.
 */

static void
mcf_wrap_line(struct cli *cli, const char *b, const char *e, int tabs, int m0)
{
        int n, hadtabs = 0;
        const char *w;

        n = m0;
        VCLI_Out(cli, "%*s", n, "");

        while (b < e) {
                if (!isspace(*b)) {
                        VCLI_Out(cli, "%c", *b);
                        b++;
                        n++;
                } else if (*b == '\t') {
                        assert(tabs);
                        assert(hadtabs < 2);
                        do {
                                VCLI_Out(cli, " ");
                                n++;
                        } while ((n % tabs) != (m0 + tab0) % tabs);
                        b++;
                        hadtabs++;
                } else {
                        assert (*b == ' ');
                        for (w = b + 1; w < e; w++)
                                if (isspace(*w))
                                        break;
                        if (n + (w - b) < wrap_at) {
                                VCLI_Out(cli, "%.*s", (int)(w - b), b);
                                n += (w - b);
                                b = w;
                        } else {
                                assert(hadtabs == 0 || hadtabs == 2);
                                VCLI_Out(cli, "\n");
                                mcf_wrap_line(cli, b + 1, e, 0,
                                    hadtabs ? m0 + tab0 + tabs : m0);
                                return;
                        }
                }
        }
        assert(b == e);
}

static void
mcf_wrap(struct cli *cli, const char *text)
{
        const char *p, *q, *r;
        int tw = 0;

        if (strchr(text, '\t') != NULL) {
                for (p = text; *p != '\0'; ) {
                        q = strstr(p, "\n\t");
                        if (q == NULL)
                                break;
                        q += 2;
                        r = strchr(q, '\t');
                        if (r == NULL) {
                                fprintf(stderr,
                                    "LINE with just one TAB: <%s>\n", text);
                                exit(4);
                        }
                        if (r - q > tw)
                                tw = r - q;
                        p = q;
                }
                tw += 2;
                if (tw < 20)
                        tw = 20;
        }

        for (p = text; *p != '\0'; ) {
                if (*p == '\n') {
                        VCLI_Out(cli, "\n");
                        p++;
                        continue;
                }
                q = strchr(p, '\n');
                if (q == NULL)
                        q = strchr(p, '\0');
                mcf_wrap_line(cli, p, q, tw, margin1);
                p = q;
        }
}

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

static void v_matchproto_(cli_func_t)
mcf_param_show(struct cli *cli, const char * const *av, void *priv)
{
        struct plist *pl;
        const struct parspec *pp, *pa;
        int n, lfmt = 0, chg = 0;
        struct vsb *vsb;
        const char *show = NULL;

        (void)priv;

        for (n = 2; av[n] != NULL; n++) {
                if (strcmp(av[n], "-l") == 0) {
                        lfmt = 1;
                        continue;
                }
                if (strcmp(av[n], "changed") == 0) {
                        chg = 1;
                        continue;
                }
                if (show != NULL) {
                        VCLI_SetResult(cli, CLIS_TOOMANY);
                        VCLI_Out(cli, "Too many parameters");
                        return;
                }
                show = av[n];
                lfmt = 1;
        }

        vsb = VSB_new_auto();
        AN(vsb);

        n = 0;
        VTAILQ_FOREACH(pl, &phead, list) {
                pp = pl->spec;
                if (lfmt && show != NULL && strcmp(pp->name, show))
                        continue;
                if (pp->func == tweak_alias &&
                    (show == NULL || strcmp(pp->name, show)))
                        continue;
                n++;

                VSB_clear(vsb);
                if (pp->func(vsb, pp, NULL))
                        VCLI_SetResult(cli, CLIS_PARAM);
                AZ(VSB_finish(vsb));
                if (chg && pp->def != NULL && !strcmp(pp->def, VSB_data(vsb)))
                        continue;

                if (pp->flags & NOT_IMPLEMENTED) {
                        if (lfmt) {
                                VCLI_Out(cli, "%s\n", pp->name);
                                VCLI_Out(cli, "%-*sNot available", margin1, " ");
                        } else {
                                VCLI_Out(cli, "%-*s-", margin2, pp->name);
                        }
                } else {
                        if (lfmt) {
                                VCLI_Out(cli, "%s\n", pp->name);
                                VCLI_Out(cli, "%-*sValue is: ", margin1, " ");
                        } else {
                                VCLI_Out(cli, "%-*s", margin2, pp->name);
                        }

                        VCLI_Out(cli, "%s", VSB_data(vsb));
                        if (pp->units != NULL && *pp->units != '\0')
                                VCLI_Out(cli, " [%s]", pp->units);
                        if (pp->def != NULL && !strcmp(pp->def, VSB_data(vsb)))
                                VCLI_Out(cli, " (default)");
                }
                VCLI_Out(cli, "\n");

                if (lfmt && pp->func == tweak_alias) {
                        pa = TRUST_ME(pp->priv);
                        VCLI_Out(cli, "%-*sAlias of: %s\n",
                            margin1, " ", pa->name);
                }
                if (lfmt && pp->flags & NOT_IMPLEMENTED) {
                        VCLI_Out(cli, "\n");
                        mcf_wrap(cli, NOT_IMPLEMENTED_TEXT);
                        VCLI_Out(cli, "\n\n");
                } else if (lfmt) {
                        if (pp->def != NULL && strcmp(pp->def, VSB_data(vsb)))
                                VCLI_Out(cli, "%-*sDefault is: %s\n",
                                    margin1, "", pp->def);
                        if (pp->min != NULL)
                                VCLI_Out(cli, "%-*sMinimum is: %s\n",
                                    margin1, "", pp->min);
                        if (pp->max != NULL)
                                VCLI_Out(cli, "%-*sMaximum is: %s\n",
                                    margin1, "", pp->max);
                        VCLI_Out(cli, "\n");
                        mcf_wrap(cli, pp->descr);
                        if (pp->func == tweak_timeout)
                                mcf_wrap(cli, TYPE_TIMEOUT_TEXT);
                        if (pp->flags & OBJ_STICKY)
                                mcf_wrap(cli, OBJ_STICKY_TEXT);
                        if (pp->flags & DELAYED_EFFECT)
                                mcf_wrap(cli, DELAYED_EFFECT_TEXT);
                        if (pp->flags & EXPERIMENTAL)
                                mcf_wrap(cli, EXPERIMENTAL_TEXT);
                        if (pp->flags & MUST_RELOAD)
                                mcf_wrap(cli, MUST_RELOAD_TEXT);
                        if (pp->flags & MUST_RESTART)
                                mcf_wrap(cli, MUST_RESTART_TEXT);
                        if (pp->flags & WIZARD)
                                mcf_wrap(cli, WIZARD_TEXT);
                        if (pp->flags & PROTECTED)
                                mcf_wrap(cli, PROTECTED_TEXT);
                        if (pp->flags & ONLY_ROOT)
                                mcf_wrap(cli, ONLY_ROOT_TEXT);
                        if (pp->flags & BUILD_OPTIONS)
                                mcf_wrap(cli, BUILD_OPTIONS_TEXT);
                        VCLI_Out(cli, "\n\n");
                }
        }
        if (show != NULL && n == 0) {
                VCLI_SetResult(cli, CLIS_PARAM);
                VCLI_Out(cli, "Unknown parameter \"%s\".", show);
        }
        VSB_destroy(&vsb);
}

static inline void
mcf_json_key_valstr(struct cli *cli, const char *key, const char *val)
{
        VCLI_Out(cli, "\"%s\": ", key);
        VCLI_JSON_str(cli, val);
        VCLI_Out(cli, ",\n");
}

static void v_matchproto_(cli_func_t)
mcf_param_show_json(struct cli *cli, const char * const *av, void *priv)
{
        int n, comma = 0, chg = 0;
        struct plist *pl;
        const struct parspec *pp, *pa;
        struct vsb *vsb, *def;
        const char *show = NULL, *sep;

        (void)priv;

        for (int i = 2; av[i] != NULL; i++) {
                if (strcmp(av[i], "-l") == 0) {
                        VCLI_SetResult(cli, CLIS_PARAM);
                        VCLI_Out(cli, "-l not permitted with param.show -j");
                        return;
                }
                if (strcmp(av[i], "changed") == 0) {
                        chg = 1;
                        continue;
                }
                if (strcmp(av[i], "-j") == 0)
                        continue;
                if (show != NULL) {
                        VCLI_SetResult(cli, CLIS_TOOMANY);
                        VCLI_Out(cli, "Too many parameters");
                        return;
                }
                show = av[i];
        }

        vsb = VSB_new_auto();
        AN(vsb);
        def = VSB_new_auto();
        AN(def);

        n = 0;
        VCLI_JSON_begin(cli, 2, av);
        VCLI_Out(cli, ",\n");
        VTAILQ_FOREACH(pl, &phead, list) {
                pp = pl->spec;
                if (show != NULL && strcmp(pp->name, show) != 0)
                        continue;
                if (pp->func == tweak_alias &&
                    (show == NULL || strcmp(pp->name, show)))
                        continue;
                n++;

                VSB_clear(vsb);
                if (pp->func(vsb, pp, JSON_FMT))
                        VCLI_SetResult(cli, CLIS_PARAM);
                AZ(VSB_finish(vsb));
                VSB_clear(def);
                if (pp->func(def, pp, NULL))
                        VCLI_SetResult(cli, CLIS_PARAM);
                AZ(VSB_finish(def));
                if (chg && pp->def != NULL && !strcmp(pp->def, VSB_data(def)))
                        continue;

                VCLI_Out(cli, "%s", comma ? ",\n" : "");
                comma++;
                VCLI_Out(cli, "{\n");
                VSB_indent(cli->sb, 2);
                mcf_json_key_valstr(cli, "name", pp->name);
                if (pp->func == tweak_alias) {
                        pa = TRUST_ME(pp->priv);
                        mcf_json_key_valstr(cli, "alias", pa->name);
                }
                if (pp->flags & NOT_IMPLEMENTED) {
                        VCLI_Out(cli, "\"implemented\": false\n");
                        VSB_indent(cli->sb, -2);
                        VCLI_Out(cli, "}");
                        continue;
                }
                VCLI_Out(cli, "\"implemented\": true,\n");
                VCLI_Out(cli, "\"value\": %s,\n", VSB_data(vsb));
                if (pp->units != NULL && *pp->units != '\0')
                        mcf_json_key_valstr(cli, "units", pp->units);

                if (pp->def != NULL)
                        mcf_json_key_valstr(cli, "default", pp->def);
                if (pp->min != NULL)
                        mcf_json_key_valstr(cli, "minimum", pp->min);
                if (pp->max != NULL)
                        mcf_json_key_valstr(cli, "maximum", pp->max);
                mcf_json_key_valstr(cli, "description", pp->descr);

                VCLI_Out(cli, "\"flags\": [");
                VSB_indent(cli->sb, 2);
                sep = "";

#define flag_out(flag, string) do {                                     \
                        if (pp->flags & flag) {                         \
                                VCLI_Out(cli, "%s\n", sep);             \
                                VCLI_Out(cli, "\"%s\"", #string);       \
                                sep = ",";                              \
                        }                                               \
                } while(0)

                flag_out(OBJ_STICKY, obj_sticky);
                flag_out(DELAYED_EFFECT, delayed_effect);
                flag_out(EXPERIMENTAL, experimental);
                flag_out(MUST_RELOAD, must_reload);
                flag_out(MUST_RESTART, must_restart);
                flag_out(WIZARD, wizard);
                flag_out(PROTECTED, protected);
                flag_out(ONLY_ROOT, only_root);
                flag_out(BUILD_OPTIONS, build_options);

#undef flag_out

                if (pp->flags)
                        VCLI_Out(cli, "\n");
                VSB_indent(cli->sb, -2);
                VCLI_Out(cli, "]\n");
                VSB_indent(cli->sb, -2);
                VCLI_Out(cli, "}");
        }
        VCLI_JSON_end(cli);
        if (show != NULL && n == 0) {
                VSB_clear(cli->sb);
                VCLI_SetResult(cli, CLIS_PARAM);
                VCLI_Out(cli, "Unknown parameter \"%s\".", show);
        }
        VSB_destroy(&vsb);
        VSB_destroy(&def);
}

/*--------------------------------------------------------------------
 * Mark parameters as protected
 */

void
MCF_ParamProtect(struct cli *cli, const char *args)
{
        char **av;
        struct parspec *pp;
        int i;

        av = VAV_Parse(args, NULL, ARGV_COMMA);
        if (av[0] != NULL) {
                VCLI_Out(cli, "Parse error: %s", av[0]);
                VCLI_SetResult(cli, CLIS_PARAM);
                VAV_Free(av);
                return;
        }
        for (i = 1; av[i] != NULL; i++) {
                pp = mcf_findpar(av[i]);
                if (pp == NULL) {
                        VCLI_Out(cli, "Unknown parameter %s", av[i]);
                        VCLI_SetResult(cli, CLIS_PARAM);
                        VAV_Free(av);
                        return;
                }
                pp->flags |= PROTECTED;
        }
        VAV_Free(av);
}

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

void
MCF_ParamSet(struct cli *cli, const char *param, const char *val)
{
        const struct parspec *pp;

        pp = mcf_findpar(param);
        if (pp == NULL) {
                VCLI_SetResult(cli, CLIS_PARAM);
                VCLI_Out(cli, "Unknown parameter \"%s\".", param);
                return;
        }
        if (pp->flags & NOT_IMPLEMENTED) {
                VCLI_SetResult(cli, CLIS_CANT);
                VCLI_Out(cli,
                    "parameter \"%s\" is not available on this platform.",
                    param
                );
                return;
        }
        if (pp->flags & PROTECTED) {
                VCLI_SetResult(cli, CLIS_AUTH);
                VCLI_Out(cli, "parameter \"%s\" is protected.", param);
                return;
        }
        if (!val)
                val = pp->def;
        if (pp->func(cli->sb, pp, val))
                VCLI_SetResult(cli, CLIS_PARAM);

        if (cli->result == CLIS_OK && heritage.param != NULL)
                *heritage.param = mgt_param;

        if (cli->result != CLIS_OK) {
                VCLI_Out(cli, "\n(attempting to set param '%s' to '%s')",
                    pp->name, val);
        } else if (MCH_Running() && pp->flags & MUST_RESTART) {
                VCLI_Out(cli,
                    "\nChange will take effect when child is restarted");
        } else if (pp->flags & MUST_RELOAD) {
                VCLI_Out(cli,
                    "\nChange will take effect when VCL script is reloaded");
        }
}


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

static void v_matchproto_(cli_func_t)
mcf_param_set(struct cli *cli, const char * const *av, void *priv)
{

        (void)priv;
        MCF_ParamSet(cli, av[2], av[3]);
}

static void v_matchproto_(cli_func_t)
mcf_param_set_json(struct cli *cli, const char * const *av, void *priv)
{
        const char *const avs[] = { av[0], av[1], av[2], av[3], NULL };

        MCF_ParamSet(cli, av[3], av[4]);
        if (cli->result == CLIS_OK)
                mcf_param_show_json(cli, avs, priv);
}

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

static void v_matchproto_(cli_func_t)
mcf_param_reset(struct cli *cli, const char * const *av, void *priv)
{

        (void)priv;
        MCF_ParamSet(cli, av[2], NULL);
}

/*--------------------------------------------------------------------
 * Initialize parameters and sort by name.
 */

static struct parspec mgt_parspec[] = {
#define PARAM_ALL
#define PARAM_PRE {
#define PARAM(typ, fld, nm, ...) #nm, __VA_ARGS__
#define PARAM_POST },
#include "tbl/params.h"
        { NULL, NULL, NULL }
};

static void
mcf_init_params(void)
{
        struct parspec *pp;
        const char *s;

        for (pp = mgt_parspec; pp->name != NULL; pp++) {
                AN(pp->func);
                s = strchr(pp->descr, '\0');
                if (isspace(s[-1])) {
                        fprintf(stderr,
                            "Param->descr has trailing space: %s\n", pp->name);
                        exit(4);
                }
                mcf_addpar(pp);
                margin2 = vmax_t(int, margin2, strlen(pp->name) + 1);
        }
}

/*--------------------------------------------------------------------
 * Wash a min/max/default value
 */

static void
mcf_dyn_vsb(enum mcf_which_e which, struct parspec *pp, struct vsb *vsb)
{

        switch (which) {
        case MCF_DEFAULT:
                REPLACE(pp->dyn_def, VSB_data(vsb));
                pp->def = pp->dyn_def;
                break;
        case MCF_MINIMUM:
                REPLACE(pp->dyn_min, VSB_data(vsb));
                pp->min = pp->dyn_min;
                break;
        case MCF_MAXIMUM:
                REPLACE(pp->dyn_max, VSB_data(vsb));
                pp->max = pp->dyn_max;
                break;
        default:
                WRONG("bad 'which'");
        }
}

static void
mcf_wash_param(struct cli *cli, struct parspec *pp, enum mcf_which_e which,
    const char *name, struct vsb *vsb)
{
        const char *val;
        int err;

        switch (which) {
        case MCF_DEFAULT: val = pp->def; break;
        case MCF_MINIMUM: val = pp->min; break;
        case MCF_MAXIMUM: val = pp->max; break;
        default:
                WRONG("bad 'which'");
        }
        AN(val);

        if (pp->func == tweak_alias) {
                assert(which == MCF_DEFAULT);
                pp->priv = mcf_findpar(pp->def);
                pp->def = NULL;
                return;
        }

        VSB_clear(vsb);
        VSB_printf(vsb, "FAILED to set %s for param %s: %s\n",
            name, pp->name, val);
        err = pp->func(vsb, pp, val);
        AZ(VSB_finish(vsb));
        if (err) {
                VCLI_Out(cli, "%s\n", VSB_data(vsb));
                VCLI_SetResult(cli, CLIS_CANT);
                return;
        }
        VSB_clear(vsb);
        err = pp->func(vsb, pp, NULL);
        AZ(err);
        AZ(VSB_finish(vsb));
        if (strcmp(val, VSB_data(vsb)))
                mcf_dyn_vsb(which, pp, vsb);
}

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

static struct cli_proto cli_params[] = {
        { CLICMD_PARAM_SHOW,    "", mcf_param_show, mcf_param_show_json },
        { CLICMD_PARAM_SET,     "", mcf_param_set, mcf_param_set_json },
        { CLICMD_PARAM_RESET,   "", mcf_param_reset, mcf_param_set_json },
        { NULL }
};

/*--------------------------------------------------------------------
 * Configure the parameters
 */

void
MCF_InitParams(struct cli *cli)
{
        struct plist *pl;
        struct parspec *pp;
        struct vsb *vsb;
        ssize_t def, low;

        mcf_init_params();
        MCF_TcpParams();

        def = 80 * 1024;

        if (sizeof(void *) < 8) {               /*lint !e506 !e774  */
                /*
                 * Adjust default parameters for 32 bit systems to conserve
                 * VM space.
                 *
                 * Reflect changes in doc/sphinx/reference/varnishd.rst !
                 */
                MCF_ParamConf(MCF_DEFAULT, "workspace_client", "24k");
                MCF_ParamConf(MCF_DEFAULT, "workspace_backend", "20k");
                MCF_ParamConf(MCF_DEFAULT, "http_resp_size", "8k");
                MCF_ParamConf(MCF_DEFAULT, "http_req_size", "12k");
                MCF_ParamConf(MCF_DEFAULT, "gzip_buffer", "4k");
                MCF_ParamConf(MCF_DEFAULT, "vsl_buffer", "4k");
                MCF_ParamConf(MCF_MAXIMUM, "vsl_space", "1G");
                def = 64 * 1024;
        }

        low = sysconf(_SC_THREAD_STACK_MIN);
        MCF_ParamConf(MCF_MINIMUM, "thread_pool_stack", "%jdb", (intmax_t)low);

#if defined(ENABLE_SANITIZER) || defined(ENABLE_COVERAGE)
        def = 192 * 1024;
#endif

        if (def < low)
                def = low;
        MCF_ParamConf(MCF_DEFAULT, "thread_pool_stack", "%jdb", (intmax_t)def);

#if !defined(MAX_THREAD_POOLS)
#  define MAX_THREAD_POOLS 32
#endif

        MCF_ParamConf(MCF_MAXIMUM, "thread_pools", "%d", MAX_THREAD_POOLS);

#if !defined(HAVE_ACCEPT_FILTERS) || defined(__linux)
        MCF_ParamConf(MCF_DEFAULT, "accept_filter", "off");
#endif

        VCLS_AddFunc(mgt_cls, MCF_AUTH, cli_params);

        vsb = VSB_new_auto();
        AN(vsb);

        VTAILQ_FOREACH(pl, &phead, list) {
                pp = pl->spec;

                if (pp->flags & NOT_IMPLEMENTED)
                        continue;
                if (pp->min != NULL)
                        mcf_wash_param(cli, pp, MCF_MINIMUM, "minimum", vsb);
                if (pp->max != NULL)
                        mcf_wash_param(cli, pp, MCF_MAXIMUM, "maximum", vsb);
                AN(pp->def);
                mcf_wash_param(cli, pp, MCF_DEFAULT, "default", vsb);
        }
        VSB_destroy(&vsb);

        AN(mgt_cc_cmd);
        REPLACE(mgt_cc_cmd_def, mgt_cc_cmd);
}

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

void
MCF_ParamConf(enum mcf_which_e which, const char * const param,
    const char *fmt, ...)
{
        struct parspec *pp;
        struct vsb *vsb;
        va_list ap;

        pp = mcf_findpar(param);
        AN(pp);
        vsb = VSB_new_auto();
        AN(vsb);
        va_start(ap, fmt);
        VSB_vprintf(vsb, fmt, ap);
        va_end(ap);
        AZ(VSB_finish(vsb));
        mcf_dyn_vsb(which, pp, vsb);
        VSB_destroy(&vsb);
}

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

void
MCF_DumpRstParam(void)
{
        struct plist *pl;
        const struct parspec *pp;
        const char *p, *q, *t1, *t2;
        unsigned flags;
        size_t z;

        printf("\n.. The following is the autogenerated "
            "output from varnishd -x parameter\n\n");
        VTAILQ_FOREACH(pl, &phead, list) {
                pp = pl->spec;
                if (!strcmp("deprecated_dummy", pp->name))
                    continue;
                printf(".. _ref_param_%s:\n\n", pp->name);
                printf("%s\n", pp->name);
                for (z = 0; z < strlen(pp->name); z++)
                        printf("~");
                printf("\n");

                if (pp->flags && pp->flags & PLATFORM_DEPENDENT)
                        printf("\n%s\n\n", PLATFORM_DEPENDENT_TEXT);

                if (pp->flags && pp->flags & BUILD_OPTIONS)
                        printf("\n%s\n\n", BUILD_OPTIONS_TEXT);

                if (pp->units != NULL && *pp->units != '\0')
                        printf("\t* Units: %s\n", pp->units);
#define MCF_DYN_REASON(lbl, nm)                                 \
                if (pp->dyn_ ## nm ## _reason != NULL)          \
                        printf("\t* " #lbl ": %s\n",            \
                            pp->dyn_ ## nm ## _reason);         \
                else if (pp->nm != NULL)                        \
                        printf("\t* " #lbl ": %s\n", pp->nm);
                MCF_DYN_REASON(Default, def);
                MCF_DYN_REASON(Minimum, min);
                MCF_DYN_REASON(Maximum, max);
#undef MCF_DYN_REASON
                flags = pp->flags & ~DOCS_FLAGS;
                if (pp->func == tweak_timeout)
                        flags |= TYPE_TIMEOUT;
                if (flags) {
                        printf("\t* Flags: ");
                        q = "";

                        if (flags & TYPE_TIMEOUT) {
                                printf("%stimeout", q);
                                q = ", ";
                        }
                        if (flags & DELAYED_EFFECT) {
                                printf("%sdelayed", q);
                                q = ", ";
                        }
                        if (flags & MUST_RESTART) {
                                printf("%smust_restart", q);
                                q = ", ";
                        }
                        if (flags & MUST_RELOAD) {
                                printf("%smust_reload", q);
                                q = ", ";
                        }
                        if (flags & EXPERIMENTAL) {
                                printf("%sexperimental", q);
                                q = ", ";
                        }
                        if (flags & WIZARD) {
                                printf("%swizard", q);
                                q = ", ";
                        }
                        if (flags & ONLY_ROOT) {
                                printf("%sonly_root", q);
                                q = ", ";
                        }
                        if (flags & OBJ_STICKY) {
                                printf("%sobj_sticky", q);
                                q = ", ";
                        }
                        printf("\n");
                }
                printf("\n");
                p = pp->descr;
                while (*p != '\0') {
                        q = strchr(p, '\n');
                        if (q == NULL)
                                q = strchr(p, '\0');
                        t1 = strchr(p, '\t');
                        if (t1 != NULL && t1 < q) {
                                t2 = strchr(t1 + 1, '\t');
                                AN(t2);
                                printf("\n\t*");
                                (void)fwrite(t1 + 1, (t2 - 1) - t1, 1, stdout);
                                printf("*\n\t\t");
                                p = t2 + 1;
                        }
                        (void)fwrite(p, q - p, 1, stdout);
                        p = q;
                        if (*p == '\n') {
                                printf("\n");
                                p++;
                        }
                        continue;
                }
                printf("\n\n");
        }
}

		varnish-cache/bin/varnishd/mgt/mgt_param.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
31		#include "config.h"
32
33		#include <ctype.h>
34		#include <stdarg.h>
35		#include <stdio.h>
36		#include <stdlib.h>
37		#include <string.h>
38		#include <unistd.h>
39
40		#include "mgt/mgt.h"
41		#include "common/heritage.h"
42
43		#include "mgt/mgt_param.h"
44		#include "vav.h"
45		#include "vcli_serve.h"
46
47		struct plist {
48		unsigned magic;
49		#define PLIST_MAGIC 0xbfc3ea16
50		VTAILQ_ENTRY(plist) list;
51		struct parspec *spec;
52		};
53
54		static VTAILQ_HEAD(, plist) phead = VTAILQ_HEAD_INITIALIZER(phead);
55
56		struct params mgt_param;
57		static const int margin1 = 8;
58		static int margin2 = 0;
59		static const int wrap_at = 72;
60		static const int tab0 = 3;
61
62		/--------------------------------------------------------------------/
63
64		static const char TYPE_TIMEOUT_TEXT[] =
65		"\n\n"
66		"NB: This parameter can be disabled with the value \"never\".";
67
68		static const char OBJ_STICKY_TEXT[] =
69		"\n\n"
70		"NB: This parameter is evaluated only when objects are created. "
71		"To change it for all objects, restart or ban everything.";
72
73		static const char DELAYED_EFFECT_TEXT[] =
74		"\n\n"
75		"NB: This parameter may take quite some time to take (full) effect.";
76
77		static const char MUST_RESTART_TEXT[] =
78		"\n\n"
79		"NB: This parameter will not take any effect until the "
80		"child process has been restarted.";
81
82		static const char MUST_RELOAD_TEXT[] =
83		"\n\n"
84		"NB: This parameter will not take any effect until the "
85		"VCL programs have been reloaded.";
86
87		static const char EXPERIMENTAL_TEXT[] =
88		"\n\n"
89		"NB: We do not know yet if it is a good idea to change "
90		"this parameter, or if the default value is even sensible. "
91		"Caution is advised, and feedback is most welcome.";
92
93		static const char WIZARD_TEXT[] =
94		"\n\n"
95		"NB: Do not change this parameter, unless a developer tell "
96		"you to do so.";
97
98		static const char PROTECTED_TEXT[] =
99		"\n\n"
100		"NB: This parameter is protected and cannot be changed.";
101
102		static const char ONLY_ROOT_TEXT[] =
103		"\n\n"
104		"NB: This parameter only works if varnishd is run as root.";
105
106		static const char NOT_IMPLEMENTED_TEXT[] =
107		"\n\n"
108		"NB: This parameter depends on a feature which is not available"
109		" on this platform.";
110
111		static const char PLATFORM_DEPENDENT_TEXT[] =
112		"\n\n"
113		"NB: This parameter depends on a feature which is not available"
114		" on all platforms.";
115
116		static const char BUILD_OPTIONS_TEXT[] =
117		"\n\n"
118		"NB: The actual default value for this parameter depends on the"
119		" Varnish build environment and options.";
120
121		/--------------------------------------------------------------------/
122
123		static struct parspec *
124	367896	mcf_findpar(const char *name)
125		{
126		struct plist *pl;
127
128	367896	AN(name);
129	34855672	VTAILQ_FOREACH(pl, &phead, list)
130	34855640	if (!strcmp(pl->spec->name, name))
131	367864	return (pl->spec);
132	32	return (NULL);
133	367896	}
134
135		static void
136	1007616	mcf_addpar(struct parspec *ps)
137		{
138		struct plist pl, pl2;
139		int i;
140
141	1007616	ALLOC_OBJ(pl, PLIST_MAGIC);
142	1007616	AN(pl);
143	1007616	pl->spec = ps;
144	48111616	VTAILQ_FOREACH(pl2, &phead, list) {
145	47898624	i = strcmp(pl2->spec->name, pl->spec->name);
146	47898624	if (i == 0) {
147	0	fprintf(stderr, "Duplicate param: %s\n", ps->name);
148	0	exit(4);
149	47898624	} else if (i > 0) {
150	794624	VTAILQ_INSERT_BEFORE(pl2, pl, list);
151	794624	return;
152		}
153	47104000	}
154	212992	VTAILQ_INSERT_TAIL(&phead, pl, list);
155	1007616	}
156
157		/*--------------------------------------------------------------------
158		* Wrap the text nicely.
159		* Lines are allowed to contain two TABS and we render that as a table
160		* taking the width of the first column into account.
161		*/
162
163		static void
164	20320	mcf_wrap_line(struct cli cli, const char b, const char *e, int tabs, int m0)
165		{
166	20320	int n, hadtabs = 0;
167		const char *w;
168
169	20320	n = m0;
170	20320	VCLI_Out(cli, "%*s", n, "");
171
172	299792	while (b < e) {
173	289720	if (!isspace(*b)) {
174	139408	VCLI_Out(cli, "%c", *b);
175	139408	b++;
176	139408	n++;
177	289720	} else if (*b == '\t') {
178	3952	assert(tabs);
179	3952	assert(hadtabs < 2);
180	3952	do {
181	31216	VCLI_Out(cli, " ");
182	31216	n++;
183	31216	} while ((n % tabs) != (m0 + tab0) % tabs);
184	3952	b++;
185	3952	hadtabs++;
186	3952	} else {
187	146360	assert (*b == ' ');
188	877288	for (w = b + 1; w < e; w++)
189	867216	if (isspace(*w))
190	136288	break;
191	146360	if (n + (w - b) < wrap_at) {
192	136112	VCLI_Out(cli, "%.*s", (int)(w - b), b);
193	136112	n += (w - b);
194	136112	b = w;
195	136112	} else {
196	10248	assert(hadtabs == 0 \|\| hadtabs == 2);
197	10248	VCLI_Out(cli, "\n");
198	20496	mcf_wrap_line(cli, b + 1, e, 0,
199	10248	hadtabs ? m0 + tab0 + tabs : m0);
200	10248	return;
201		}
202		}
203		}
204	10072	assert(b == e);
205	20320	}
206
207		static void
208	5032	mcf_wrap(struct cli cli, const char text)
209		{
210		const char p, q, *r;
211	5032	int tw = 0;
212
213	5032	if (strchr(text, '\t') != NULL) {
214	2232	for (p = text; *p != '\0'; ) {
215	2232	q = strstr(p, "\n\t");
216	2232	if (q == NULL)
217	256	break;
218	1976	q += 2;
219	1976	r = strchr(q, '\t');
220	1976	if (r == NULL) {
221	0	fprintf(stderr,
222	0	"LINE with just one TAB: <%s>\n", text);
223	0	exit(4);
224		}
225	1976	if (r - q > tw)
226	704	tw = r - q;
227	1976	p = q;
228		}
229	256	tw += 2;
230	256	if (tw < 20)
231	216	tw = 20;
232	256	}
233
234	25784	for (p = text; *p != '\0'; ) {
235	20752	if (*p == '\n') {
236	10680	VCLI_Out(cli, "\n");
237	10680	p++;
238	10680	continue;
239		}
240	10072	q = strchr(p, '\n');
241	10072	if (q == NULL)
242	5032	q = strchr(p, '\0');
243	10072	mcf_wrap_line(cli, p, q, tw, margin1);
244	10072	p = q;
245		}
246	5032	}
247
248		/--------------------------------------------------------------------/
249
250		static void v_matchproto_(cli_func_t)
251	264	mcf_param_show(struct cli cli, const char const av, void priv)
252		{
253		struct plist *pl;
254		const struct parspec pp, pa;
255	264	int n, lfmt = 0, chg = 0;
256		struct vsb *vsb;
257	264	const char *show = NULL;
258
259	264	(void)priv;
260
261	480	for (n = 2; av[n] != NULL; n++) {
262	224	if (strcmp(av[n], "-l") == 0) {
263	24	lfmt = 1;
264	24	continue;
265		}
266	200	if (strcmp(av[n], "changed") == 0) {
267	8	chg = 1;
268	8	continue;
269		}
270	192	if (show != NULL) {
271	8	VCLI_SetResult(cli, CLIS_TOOMANY);
272	8	VCLI_Out(cli, "Too many parameters");
273	8	return;
274		}
275	184	show = av[n];
276	184	lfmt = 1;
277	184	}
278
279	256	vsb = VSB_new_auto();
280	256	AN(vsb);
281
282	256	n = 0;
283	31744	VTAILQ_FOREACH(pl, &phead, list) {
284	31488	pp = pl->spec;
285	31488	if (lfmt && show != NULL && strcmp(pp->name, show))
286	21480	continue;
287	10040	if (pp->func == tweak_alias &&
288	352	(show == NULL \|\| strcmp(pp->name, show)))
289	320	continue;
290	9688	n++;
291
292	9688	VSB_clear(vsb);
293	9688	if (pp->func(vsb, pp, NULL))
294	0	VCLI_SetResult(cli, CLIS_PARAM);
295	9688	AZ(VSB_finish(vsb));
296	9688	if (chg && pp->def != NULL && !strcmp(pp->def, VSB_data(vsb)))
297	856	continue;
298
299	8832	if (pp->flags & NOT_IMPLEMENTED) {
300	0	if (lfmt) {
301	0	VCLI_Out(cli, "%s\n", pp->name);
302	0	VCLI_Out(cli, "%-*sNot available", margin1, " ");
303	0	} else {
304	0	VCLI_Out(cli, "%-*s-", margin2, pp->name);
305		}
306	0	} else {
307	8832	if (lfmt) {
308	3024	VCLI_Out(cli, "%s\n", pp->name);
309	3024	VCLI_Out(cli, "%-*sValue is: ", margin1, " ");
310	3024	} else {
311	5808	VCLI_Out(cli, "%-*s", margin2, pp->name);
312		}
313
314	8832	VCLI_Out(cli, "%s", VSB_data(vsb));
315	8832	if (pp->units != NULL && *pp->units != '\0')
316	7048	VCLI_Out(cli, " [%s]", pp->units);
317	8832	if (pp->def != NULL && !strcmp(pp->def, VSB_data(vsb)))
318	7896	VCLI_Out(cli, " (default)");
319		}
320	8832	VCLI_Out(cli, "\n");
321
322	8832	if (lfmt && pp->func == tweak_alias) {
323	32	pa = TRUST_ME(pp->priv);
324	64	VCLI_Out(cli, "%-*sAlias of: %s\n",
325	32	margin1, " ", pa->name);
326	32	}
327	8832	if (lfmt && pp->flags & NOT_IMPLEMENTED) {
328	0	VCLI_Out(cli, "\n");
329	0	mcf_wrap(cli, NOT_IMPLEMENTED_TEXT);
330	0	VCLI_Out(cli, "\n\n");
331	8832	} else if (lfmt) {
332	3024	if (pp->def != NULL && strcmp(pp->def, VSB_data(vsb)))
333	672	VCLI_Out(cli, "%-*sDefault is: %s\n",
334	336	margin1, "", pp->def);
335	3024	if (pp->min != NULL)
336	4688	VCLI_Out(cli, "%-*sMinimum is: %s\n",
337	2344	margin1, "", pp->min);
338	3024	if (pp->max != NULL)
339	1392	VCLI_Out(cli, "%-*sMaximum is: %s\n",
340	696	margin1, "", pp->max);
341	3024	VCLI_Out(cli, "\n");
342	3024	mcf_wrap(cli, pp->descr);
343	3024	if (pp->func == tweak_timeout)
344	320	mcf_wrap(cli, TYPE_TIMEOUT_TEXT);
345	3024	if (pp->flags & OBJ_STICKY)
346	80	mcf_wrap(cli, OBJ_STICKY_TEXT);
347	3024	if (pp->flags & DELAYED_EFFECT)
348	384	mcf_wrap(cli, DELAYED_EFFECT_TEXT);
349	3024	if (pp->flags & EXPERIMENTAL)
350	720	mcf_wrap(cli, EXPERIMENTAL_TEXT);
351	3024	if (pp->flags & MUST_RELOAD)
352	56	mcf_wrap(cli, MUST_RELOAD_TEXT);
353	3024	if (pp->flags & MUST_RESTART)
354	192	mcf_wrap(cli, MUST_RESTART_TEXT);
355	3024	if (pp->flags & WIZARD)
356	144	mcf_wrap(cli, WIZARD_TEXT);
357	3024	if (pp->flags & PROTECTED)
358	8	mcf_wrap(cli, PROTECTED_TEXT);
359	3024	if (pp->flags & ONLY_ROOT)
360	0	mcf_wrap(cli, ONLY_ROOT_TEXT);
361	3024	if (pp->flags & BUILD_OPTIONS)
362	104	mcf_wrap(cli, BUILD_OPTIONS_TEXT);
363	3024	VCLI_Out(cli, "\n\n");
364	3024	}
365	8832	}
366	256	if (show != NULL && n == 0) {
367	8	VCLI_SetResult(cli, CLIS_PARAM);
368	8	VCLI_Out(cli, "Unknown parameter \"%s\".", show);
369	8	}
370	256	VSB_destroy(&vsb);
371	264	}
372
373		static inline void
374	9904	mcf_json_key_valstr(struct cli cli, const char key, const char *val)
375		{
376	9904	VCLI_Out(cli, "\"%s\": ", key);
377	9904	VCLI_JSON_str(cli, val);
378	9904	VCLI_Out(cli, ",\n");
379	9904	}
380
381		static void v_matchproto_(cli_func_t)
382	120	mcf_param_show_json(struct cli cli, const char const av, void priv)
383		{
384	120	int n, comma = 0, chg = 0;
385		struct plist *pl;
386		const struct parspec pp, pa;
387		struct vsb vsb, def;
388	120	const char show = NULL, sep;
389
390	120	(void)priv;
391
392	336	for (int i = 2; av[i] != NULL; i++) {
393	232	if (strcmp(av[i], "-l") == 0) {
394	8	VCLI_SetResult(cli, CLIS_PARAM);
395	8	VCLI_Out(cli, "-l not permitted with param.show -j");
396	8	return;
397		}
398	224	if (strcmp(av[i], "changed") == 0) {
399	8	chg = 1;
400	8	continue;
401		}
402	216	if (strcmp(av[i], "-j") == 0)
403	120	continue;
404	96	if (show != NULL) {
405	8	VCLI_SetResult(cli, CLIS_TOOMANY);
406	8	VCLI_Out(cli, "Too many parameters");
407	8	return;
408		}
409	88	show = av[i];
410	88	}
411
412	104	vsb = VSB_new_auto();
413	104	AN(vsb);
414	104	def = VSB_new_auto();
415	104	AN(def);
416
417	104	n = 0;
418	104	VCLI_JSON_begin(cli, 2, av);
419	104	VCLI_Out(cli, ",\n");
420	12896	VTAILQ_FOREACH(pl, &phead, list) {
421	12792	pp = pl->spec;
422	12792	if (show != NULL && strcmp(pp->name, show) != 0)
423	9768	continue;
424	3032	if (pp->func == tweak_alias &&
425	104	(show == NULL \|\| strcmp(pp->name, show)))
426	96	continue;
427	2928	n++;
428
429	2928	VSB_clear(vsb);
430	2928	if (pp->func(vsb, pp, JSON_FMT))
431	0	VCLI_SetResult(cli, CLIS_PARAM);
432	2928	AZ(VSB_finish(vsb));
433	2928	VSB_clear(def);
434	2928	if (pp->func(def, pp, NULL))
435	0	VCLI_SetResult(cli, CLIS_PARAM);
436	2928	AZ(VSB_finish(def));
437	2928	if (chg && pp->def != NULL && !strcmp(pp->def, VSB_data(def)))
438	856	continue;
439
440	2072	VCLI_Out(cli, "%s", comma ? ",\n" : "");
441	2072	comma++;
442	2072	VCLI_Out(cli, "{\n");
443	2072	VSB_indent(cli->sb, 2);
444	2072	mcf_json_key_valstr(cli, "name", pp->name);
445	2072	if (pp->func == tweak_alias) {
446	8	pa = TRUST_ME(pp->priv);
447	8	mcf_json_key_valstr(cli, "alias", pa->name);
448	8	}
449	2072	if (pp->flags & NOT_IMPLEMENTED) {
450	0	VCLI_Out(cli, "\"implemented\": false\n");
451	0	VSB_indent(cli->sb, -2);
452	0	VCLI_Out(cli, "}");
453	0	continue;
454		}
455	2072	VCLI_Out(cli, "\"implemented\": true,\n");
456	2072	VCLI_Out(cli, "\"value\": %s,\n", VSB_data(vsb));
457	2072	if (pp->units != NULL && *pp->units != '\0')
458	1616	mcf_json_key_valstr(cli, "units", pp->units);
459
460	2072	if (pp->def != NULL)
461	2064	mcf_json_key_valstr(cli, "default", pp->def);
462	2072	if (pp->min != NULL)
463	1576	mcf_json_key_valstr(cli, "minimum", pp->min);
464	2072	if (pp->max != NULL)
465	496	mcf_json_key_valstr(cli, "maximum", pp->max);
466	2072	mcf_json_key_valstr(cli, "description", pp->descr);
467
468	2072	VCLI_Out(cli, "\"flags\": [");
469	2072	VSB_indent(cli->sb, 2);
470	2072	sep = "";
471
472		#define flag_out(flag, string) do { \
473		if (pp->flags & flag) { \
474		VCLI_Out(cli, "%s\n", sep); \
475		VCLI_Out(cli, "\"%s\"", #string); \
476		sep = ","; \
477		} \
478		} while(0)
479
480	2072	flag_out(OBJ_STICKY, obj_sticky);
481	2072	flag_out(DELAYED_EFFECT, delayed_effect);
482	2072	flag_out(EXPERIMENTAL, experimental);
483	2072	flag_out(MUST_RELOAD, must_reload);
484	2072	flag_out(MUST_RESTART, must_restart);
485	2072	flag_out(WIZARD, wizard);
486	2072	flag_out(PROTECTED, protected);
487	2072	flag_out(ONLY_ROOT, only_root);
488	2072	flag_out(BUILD_OPTIONS, build_options);
489
490		#undef flag_out
491
492	2072	if (pp->flags)
493	1016	VCLI_Out(cli, "\n");
494	2072	VSB_indent(cli->sb, -2);
495	2072	VCLI_Out(cli, "]\n");
496	2072	VSB_indent(cli->sb, -2);
497	2072	VCLI_Out(cli, "}");
498	2072	}
499	104	VCLI_JSON_end(cli);