GCOV - Varnish Cache


/*-
 * Copyright (c) 2006 Verdens Gang AS
 * Copyright (c) 2006-2015 Varnish Software AS
 * All rights reserved.
 *
 * Author: Poul-Henning Kamp <phk@phk.freebsd.dk>
 * Author: Martin Blix Grydeland <martin@varnish-software.com>
 *
 * 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 <sys/stat.h>

#include <fnmatch.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>

#include "vdef.h"
#include "vas.h"
#include "miniobj.h"
#include "vqueue.h"
#include "vjsn.h"
#include "vsb.h"
#include "vsc_priv.h"

#include "vapi/vsc.h"
#include "vapi/vsm.h"

struct vsc_sf_mode {
        const char              *name;
        unsigned                include;
        unsigned                fail;
        unsigned                append;
};

static const struct vsc_sf_mode VSC_SF_INCLUDE[1] = {{"include", 1, 1, 1}};
static const struct vsc_sf_mode VSC_SF_EXCLUDE[1] = {{"exclude", 0, 0, 1}};
static const struct vsc_sf_mode VSC_SF_REQUIRE[1] = {{"require", 1, 0, 0}};

struct vsc_sf {
        unsigned                        magic;
#define VSC_SF_MAGIC                    0x558478dd
        VTAILQ_ENTRY(vsc_sf)            list;
        char                            *pattern;
        const struct vsc_sf_mode        *mode;
};

VTAILQ_HEAD(vsc_sf_head, vsc_sf);

struct vsc_pt {
        struct VSC_point        point;
        char                    *name;
};

enum vsc_seg_type {
        VSC_SEG_COUNTERS = 1,
        VSC_SEG_DOCS,
};

struct vsc_seg {
        unsigned                magic;
#define VSC_SEG_MAGIC           0x801177d4
        enum vsc_seg_type       type;
        VTAILQ_ENTRY(vsc_seg)   list;
        VTAILQ_ENTRY(vsc_seg)   doc_list;
        struct vsm_fantom       fantom[1];
        const struct vsc_head   *head;
        const char              *body;

        struct vjsn             *vj;

        unsigned                npoints;
        struct vsc_pt           *points;

        int                     mapped;
        int                     exposed;
};
VTAILQ_HEAD(vsc_seg_head, vsc_seg);

struct vsc {
        unsigned                magic;
#define VSC_MAGIC               0x3373554a

        unsigned                raw;
        struct vsc_sf_head      sf_list;
        struct vsc_seg_head     segs;
        struct vsc_seg_head     docs;

        VSC_new_f               *fnew;
        VSC_destroy_f           *fdestroy;
        void                    *priv;
};

/*--------------------------------------------------------------------
 * Build the static level, type and point descriptions
 */

enum vsc_levels {
#define VSC_LEVEL_F(v,l,e,d) v,
#include "tbl/vsc_levels.h"
};

static const struct VSC_level_desc levels[] = {
#define VSC_LEVEL_F(v,l,e,d) [v] = {#v, l, e, d},
#include "tbl/vsc_levels.h"
};

static const ssize_t nlevels = sizeof(levels)/sizeof(*levels);

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

struct vsc *
VSC_New(void)
{
        struct vsc *vsc;

        ALLOC_OBJ(vsc, VSC_MAGIC);
        if (vsc == NULL)
                return (vsc);
        VTAILQ_INIT(&vsc->sf_list);
        VTAILQ_INIT(&vsc->segs);
        VTAILQ_INIT(&vsc->docs);
        return (vsc);
}

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

static int
vsc_sf_arg(struct vsc *vsc, const char *glob, const struct vsc_sf_mode *mode)
{
        struct vsc_sf *sf;

        CHECK_OBJ_NOTNULL(vsc, VSC_MAGIC);
        AN(glob);
        AN(mode);

        ALLOC_OBJ(sf, VSC_SF_MAGIC);
        AN(sf);
        REPLACE(sf->pattern, glob);
        sf->mode = mode;
        AN(mode->name);
        if (mode->append)
                VTAILQ_INSERT_TAIL(&vsc->sf_list, sf, list);
        else
                VTAILQ_INSERT_HEAD(&vsc->sf_list, sf, list);
        return (1);
}

static int
vsc_f_arg(struct vsc *vsc, const char *opt)
{

        CHECK_OBJ_NOTNULL(vsc, VSC_MAGIC);
        AN(opt);

        if (opt[0] == '^')
                return (vsc_sf_arg(vsc, opt + 1, VSC_SF_EXCLUDE));
        return (vsc_sf_arg(vsc, opt, VSC_SF_INCLUDE));
}

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

int
VSC_Arg(struct vsc *vsc, char arg, const char *opt)
{

        CHECK_OBJ_NOTNULL(vsc, VSC_MAGIC);

        switch (arg) {
        case 'I': return (vsc_sf_arg(vsc, opt, VSC_SF_INCLUDE));
        case 'X': return (vsc_sf_arg(vsc, opt, VSC_SF_EXCLUDE));
        case 'R': return (vsc_sf_arg(vsc, opt, VSC_SF_REQUIRE));
        case 'f': return (vsc_f_arg(vsc, opt));
        case 'r': vsc->raw = !vsc->raw; return (1);
        default: return (0);
        }
}

unsigned
VSC_IsRaw(const struct vsc *vsc)
{

        CHECK_OBJ_NOTNULL(vsc, VSC_MAGIC);
        return (vsc->raw);
}

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

static int
vsc_filter(const struct vsc *vsc, const char *nm)
{
        struct vsc_sf *sf;
        unsigned res = 0;

        CHECK_OBJ_NOTNULL(vsc, VSC_MAGIC);
        VTAILQ_FOREACH(sf, &vsc->sf_list, list) {
                if (!fnmatch(sf->pattern, nm, 0))
                        return (!sf->mode->include);
                res |= sf->mode->fail;
        }
        return (res);
}

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

static void
vsc_clean_point(struct vsc_pt *point)
{
        REPLACE(point->name, NULL);
}

static void
vsc_fill_point(const struct vsc *vsc, const struct vsc_seg *seg,
    const struct vjsn_val *vv, struct vsb *vsb, struct vsc_pt *point)
{
        struct vjsn_val *vt;

        CHECK_OBJ_NOTNULL(vsc, VSC_MAGIC);
        memset(point, 0, sizeof *point);

        vt = vjsn_child(vv, "name");
        AN(vt);
        assert(vjsn_is_string(vt));

        VSB_clear(vsb);
        VSB_printf(vsb, "%s.%s", seg->fantom->ident, vt->value);
        AZ(VSB_finish(vsb));

        if (vsc_filter(vsc, VSB_data(vsb)))
                return;

        point->name = strdup(VSB_data(vsb));
        AN(point->name);
        point->point.name = point->name;

#define DOF(n, k)                               \
        vt = vjsn_child(vv, k);                 \
        AN(vt);                                 \
        assert(vjsn_is_string(vt));             \
        point->point.n = vt->value;

        DOF(ctype, "ctype");
        DOF(sdesc, "oneliner");
        DOF(ldesc, "docs");
#undef DOF
        vt = vjsn_child(vv, "type");
        AN(vt);
        assert(vjsn_is_string(vt));

        if (!strcmp(vt->value, "counter")) {
                point->point.semantics = 'c';
        } else if (!strcmp(vt->value, "gauge")) {
                point->point.semantics = 'g';
        } else if (!strcmp(vt->value, "bitmap")) {
                point->point.semantics = 'b';
        } else {
                point->point.semantics = '?';
        }

        vt = vjsn_child(vv, "format");
        AN(vt);
        assert(vjsn_is_string(vt));

        if (!strcmp(vt->value, "integer")) {
                point->point.format = 'i';
        } else if (!strcmp(vt->value, "bytes")) {
                point->point.format = 'B';
        } else if (!strcmp(vt->value, "bitmap")) {
                point->point.format = 'b';
        } else if (!strcmp(vt->value, "duration")) {
                point->point.format = 'd';
        } else {
                point->point.format = '?';
        }

        vt = vjsn_child(vv, "level");
        AN(vt);
        assert(vjsn_is_string(vt));

        if (!strcmp(vt->value, "info"))  {
                point->point.level = &levels[info];
        } else if (!strcmp(vt->value, "diag")) {
                point->point.level = &levels[diag];
        } else if (!strcmp(vt->value, "debug")) {
                point->point.level = &levels[debug];
        } else {
                WRONG("Illegal level");
        }

        vt = vjsn_child(vv, "index");
        AN(vt);

        point->point.ptr = (volatile const void*)(seg->body + atoi(vt->value));
        point->point.raw = vsc->raw;
}

static struct vsc_seg *
vsc_new_seg(const struct vsm_fantom *fp, enum vsc_seg_type type)
{
        struct vsc_seg *sp;

        ALLOC_OBJ(sp, VSC_SEG_MAGIC);
        AN(sp);
        *sp->fantom = *fp;
        sp->type = type;

        return (sp);
}

static void
vsc_unmap_seg(const struct vsc *vsc, struct vsm *vsm, struct vsc_seg *sp)
{
        unsigned u;
        struct vsc_pt *pp;

        CHECK_OBJ_NOTNULL(vsc, VSC_MAGIC);
        AN(vsm);
        CHECK_OBJ_NOTNULL(sp, VSC_SEG_MAGIC);

        AZ(sp->exposed);
        if (!sp->mapped)
                return;

        if (sp->type == VSC_SEG_COUNTERS) {
                pp = sp->points;
                for (u = 0; u < sp->npoints; u++, pp++)
                        vsc_clean_point(pp);
                free(sp->points);
                sp->points = NULL;
                sp->npoints = 0;
                AZ(sp->vj);
        } else if (sp->type == VSC_SEG_DOCS) {
                if (sp->vj != NULL)
                        vjsn_delete(&sp->vj);
                AZ(sp->vj);
                AZ(sp->points);
        } else {
                WRONG("Invalid segment type");
        }

        AZ(VSM_Unmap(vsm, sp->fantom));
        sp->head = NULL;
        sp->body = NULL;
        sp->mapped = 0;
}

static int
vsc_map_seg(const struct vsc *vsc, struct vsm *vsm, struct vsc_seg *sp)
{
        const struct vsc_head *head;
        struct vsc_seg *spd;
        const char *e;
        struct vjsn_val *vv, *vve;
        struct vsb *vsb;
        struct vsc_pt *pp;
        int retry;

        CHECK_OBJ_NOTNULL(vsc, VSC_MAGIC);
        AN(vsm);
        CHECK_OBJ_NOTNULL(sp, VSC_SEG_MAGIC);

        if (sp->mapped)
                return (0);

        AZ(sp->exposed);

        if (VSM_Map(vsm, sp->fantom))
                return (-1);
        head = sp->fantom->b;

        /* It isn't ready yet. Sleep and try again. If it still
         * isn't ready, fail the mapping. The transitions inside
         * varnishd that we are waiting for are just some memcpy()
         * operations, so there is no reason to allow a long retry
         * time. */
        for (retry = 10; retry > 0 && head->ready == 0; retry--)
                usleep(10000);

        if (head->ready == 0) {
                AZ(VSM_Unmap(vsm, sp->fantom));
                return (-1);
        }

        sp->head = head;
        sp->body = (char*)sp->fantom->b + sp->head->body_offset;
        sp->mapped = 1;

        if (sp->type == VSC_SEG_DOCS) {
                /* Parse the DOCS json */
                sp->vj = vjsn_parse(sp->body, &e);
                XXXAZ(e);
                AN(sp->vj);
                return (0);
        }

        assert(sp->type == VSC_SEG_COUNTERS);

        /* Find the corresponding DOCS seg. We are not able to
         * read and match on the doc_id until the DOCS section is
         * mapped. Iterate over all the DOCS sections, attempt to
         * map if needed, and then check the doc_id. */
        VTAILQ_FOREACH(spd, &vsc->docs, doc_list) {
                CHECK_OBJ_NOTNULL(spd, VSC_SEG_MAGIC);
                assert(spd->type == VSC_SEG_DOCS);
                if (!spd->mapped && vsc_map_seg(vsc, vsm, spd))
                        continue; /* Failed to map it */
                AN(spd->mapped);
                if (spd->head->doc_id == sp->head->doc_id)
                        break; /* We have a match */
        }
        if (spd == NULL) {
                /* Could not find the right DOCS seg. Leave this
                 * seg as unmapped. */
                vsc_unmap_seg(vsc, vsm, sp);
                return (-1);
        }

        /* Create the VSC points list */
        vve = vjsn_child(spd->vj->value, "elements");
        AN(vve);
        sp->npoints = strtoul(vve->value, NULL, 0);
        sp->points = calloc(sp->npoints, sizeof *sp->points);
        AN(sp->points);
        vsb = VSB_new_auto();
        AN(vsb);
        vve = vjsn_child(spd->vj->value, "elem");
        AN(vve);
        pp = sp->points;
        VTAILQ_FOREACH(vv, &vve->children, list) {
                vsc_fill_point(vsc, sp, vv, vsb, pp);
                pp++;
        }
        VSB_destroy(&vsb);
        return (0);
}

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

static void
vsc_expose(const struct vsc *vsc, struct vsc_seg *sp, int del)
{
        struct vsc_pt *pp;
        unsigned u;
        int expose;

        if (!sp->mapped) {
                AZ(sp->exposed);
                return;
        }

        if (vsc->fnew != NULL && !sp->exposed &&
            !del && sp->head->ready == 1)
                expose = 1;
        else if (vsc->fdestroy != NULL && sp->exposed &&
            (del || sp->head->ready == 2))
                expose = 0;
        else
                return;

        pp = sp->points;
        for (u = 0; u < sp->npoints; u++, pp++) {
                if (pp->name == NULL)
                        continue;
                if (expose)
                        pp->point.priv = vsc->fnew(vsc->priv, &pp->point);
                else
                        vsc->fdestroy(vsc->priv, &pp->point);
        }
        sp->exposed = expose;
}

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

static void
vsc_del_segs(struct vsc *vsc, struct vsm *vsm, struct vsc_seg_head *head)
{
        struct vsc_seg *sp, *sp2;

        VTAILQ_FOREACH_SAFE(sp, head, list, sp2) {
                CHECK_OBJ(sp, VSC_SEG_MAGIC);
                VTAILQ_REMOVE(head, sp, list);
                if (sp->type == VSC_SEG_DOCS)
                        VTAILQ_REMOVE(&vsc->docs, sp, doc_list);
                vsc_expose(vsc, sp, 1);
                vsc_unmap_seg(vsc, vsm, sp);
                FREE_OBJ(sp);
        }
}

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

static int
vsc_iter_seg(const struct vsc *vsc, const struct vsc_seg *sp,
    VSC_iter_f *fiter, void *priv)
{
        unsigned u;
        int i = 0;
        struct vsc_pt *pp;

        CHECK_OBJ_NOTNULL(vsc, VSC_MAGIC);
        CHECK_OBJ_NOTNULL(sp, VSC_SEG_MAGIC);
        AN(fiter);
        pp = sp->points;
        for (u = 0; u < sp->npoints && i == 0; u++, pp++) {
                if (pp->name != NULL)
                        i = fiter(priv, &pp->point);
        }
        return (i);
}

int
VSC_Iter(struct vsc *vsc, struct vsm *vsm, VSC_iter_f *fiter, void *priv)
{
        enum vsc_seg_type type;
        struct vsm_fantom ifantom;
        struct vsc_seg *sp, *sp2;
        struct vsc_seg_head removed;
        int i = 0;

        CHECK_OBJ_NOTNULL(vsc, VSC_MAGIC);
        AN(vsm);

        /* First walk the VSM segment list and consolidate with the shadow
         * VSC seg list. We avoid calling any of the callback functions
         * while iterating the VSMs. This removes any headaches wrt to
         * callbacks calling VSM_Status(). */
        VTAILQ_INIT(&removed);
        sp = VTAILQ_FIRST(&vsc->segs);
        VSM_FOREACH(&ifantom, vsm) {
                AN(ifantom.category);
                if (!strcmp(ifantom.category, VSC_CLASS))
                        type = VSC_SEG_COUNTERS;
                else if (!strcmp(ifantom.category, VSC_DOC_CLASS))
                        type = VSC_SEG_DOCS;
                else {
                        /* Not one of the categories we care about */
                        continue;
                }

                while (sp != NULL) {
                        CHECK_OBJ_NOTNULL(sp, VSC_SEG_MAGIC);
                        if (VSM_StillValid(vsm, sp->fantom) == VSM_valid &&
                            !strcmp(ifantom.ident, sp->fantom->ident)) {
                                /* sp matches the expected value */
                                break;
                        }

                        /* sp is no longer in the VSM list. Remove it from
                         * our list. */
                        sp2 = sp;
                        sp = VTAILQ_NEXT(sp, list);
                        VTAILQ_REMOVE(&vsc->segs, sp2, list);
                        VTAILQ_INSERT_TAIL(&removed, sp2, list);
                }

                if (sp == NULL) {
                        /* New entries are always appended last in the VSM
                         * list. Since we have iterated past all the
                         * entries in our shadow list, the VSM entry is a
                         * new entry we have not seen before. */
                        sp = vsc_new_seg(&ifantom, type);
                        AN(sp);
                        VTAILQ_INSERT_TAIL(&vsc->segs, sp, list);
                        if (type == VSC_SEG_DOCS)
                                VTAILQ_INSERT_TAIL(&vsc->docs, sp, doc_list);
                }

                assert(sp->type == type);
                sp = VTAILQ_NEXT(sp, list);
        }
        while (sp != NULL) {
                /* Clean up the tail end of the shadow list. */
                CHECK_OBJ_NOTNULL(sp, VSC_SEG_MAGIC);
                sp2 = sp;
                sp = VTAILQ_NEXT(sp, list);

                VTAILQ_REMOVE(&vsc->segs, sp2, list);
                VTAILQ_INSERT_TAIL(&removed, sp2, list);
        }

        vsc_del_segs(vsc, vsm, &removed);

        /* Iterate our shadow list, reporting on each pointer value */
        VTAILQ_FOREACH(sp, &vsc->segs, list) {
                CHECK_OBJ_NOTNULL(sp, VSC_SEG_MAGIC);

                if (sp->type != VSC_SEG_COUNTERS)
                        continue;

                /* Attempt to map the VSM. This is a noop if it was
                 * already mapped. If we fail we skip this seg on this
                 * call to VSC_Iter(), but will attempt again the next
                 * time VSC_Iter() is called. */
                if (vsc_map_seg(vsc, vsm, sp))
                        continue;

                /* Expose the counters if necessary */
                vsc_expose(vsc, sp, 0);

                if (fiter != NULL && sp->head->ready == 1)
                        i = vsc_iter_seg(vsc, sp, fiter, priv);
                if (i)
                        break;
        }

        return (i);
}

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

void
VSC_State(struct vsc *vsc, VSC_new_f *fn, VSC_destroy_f *fd, void *priv)
{
        struct vsc_seg *sp;

        CHECK_OBJ_NOTNULL(vsc, VSC_MAGIC);
        assert((fn == NULL && fd == NULL) || (fn != NULL && fd != NULL));
        if (fd == NULL) {
                VTAILQ_FOREACH(sp, &vsc->segs, list)
                        vsc_expose(vsc, sp, 1);
        }
        vsc->fnew = fn;
        vsc->fdestroy = fd;
        vsc->priv = priv;
}

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

const struct VSC_level_desc *
VSC_ChangeLevel(const struct VSC_level_desc *old, int chg)
{
        int i;

        if (old == NULL)
                old = &levels[0];
        for (i = 0; i < nlevels; i++)
                if (old == &levels[i])
                        break;
        if (i == nlevels)
                i = 0;

        i += chg;
        if (i >= nlevels)
                i = nlevels - 1;
        if (i < 0)
                i = 0;
        return (&levels[i]);
}

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

void
VSC_Destroy(struct vsc **vscp, struct vsm *vsm)
{
        struct vsc *vsc;
        struct vsc_sf *sf, *sf2;

        TAKE_OBJ_NOTNULL(vsc, vscp, VSC_MAGIC);

        VTAILQ_FOREACH_SAFE(sf, &vsc->sf_list, list, sf2) {
                CHECK_OBJ_NOTNULL(sf, VSC_SF_MAGIC);
                VTAILQ_REMOVE(&vsc->sf_list, sf, list);
                free(sf->pattern);
                FREE_OBJ(sf);
        }

        vsc_del_segs(vsc, vsm, &vsc->segs);
        assert(VTAILQ_EMPTY(&vsc->docs));
        FREE_OBJ(vsc);
}

		varnish-cache/lib/libvarnishapi/vsc.c
0		/*-
1		* Copyright (c) 2006 Verdens Gang AS
2		* Copyright (c) 2006-2015 Varnish Software AS
3		* All rights reserved.
4		*
5		* Author: Poul-Henning Kamp <phk@phk.freebsd.dk>
6		* Author: Martin Blix Grydeland <martin@varnish-software.com>
7		*
8		* SPDX-License-Identifier: BSD-2-Clause
9		*
10		* Redistribution and use in source and binary forms, with or without
11		* modification, are permitted provided that the following conditions
12		* are met:
13		* 1. Redistributions of source code must retain the above copyright
14		* notice, this list of conditions and the following disclaimer.
15		* 2. Redistributions in binary form must reproduce the above copyright
16		* notice, this list of conditions and the following disclaimer in the
17		* documentation and/or other materials provided with the distribution.
18		*
19		* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20		* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21		* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22		* ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
23		* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24		* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25		* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26		* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27		* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28		* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29		* SUCH DAMAGE.
30		*/
31
32		#include "config.h"
33
34		#include <sys/stat.h>
35
36		#include <fnmatch.h>
37		#include <stdint.h>
38		#include <stdio.h>
39		#include <stdlib.h>
40		#include <string.h>
41		#include <unistd.h>
42
43		#include "vdef.h"
44		#include "vas.h"
45		#include "miniobj.h"
46		#include "vqueue.h"
47		#include "vjsn.h"
48		#include "vsb.h"
49		#include "vsc_priv.h"
50
51		#include "vapi/vsc.h"
52		#include "vapi/vsm.h"
53
54		struct vsc_sf_mode {
55		const char *name;
56		unsigned include;
57		unsigned fail;
58		unsigned append;
59		};
60
61		static const struct vsc_sf_mode VSC_SF_INCLUDE[1] = {{"include", 1, 1, 1}};
62		static const struct vsc_sf_mode VSC_SF_EXCLUDE[1] = {{"exclude", 0, 0, 1}};
63		static const struct vsc_sf_mode VSC_SF_REQUIRE[1] = {{"require", 1, 0, 0}};
64
65		struct vsc_sf {
66		unsigned magic;
67		#define VSC_SF_MAGIC 0x558478dd
68		VTAILQ_ENTRY(vsc_sf) list;
69		char *pattern;
70		const struct vsc_sf_mode *mode;
71		};
72
73		VTAILQ_HEAD(vsc_sf_head, vsc_sf);
74
75		struct vsc_pt {
76		struct VSC_point point;
77		char *name;
78		};
79
80		enum vsc_seg_type {
81		VSC_SEG_COUNTERS = 1,
82		VSC_SEG_DOCS,
83		};
84
85		struct vsc_seg {
86		unsigned magic;
87		#define VSC_SEG_MAGIC 0x801177d4
88		enum vsc_seg_type type;
89		VTAILQ_ENTRY(vsc_seg) list;
90		VTAILQ_ENTRY(vsc_seg) doc_list;
91		struct vsm_fantom fantom[1];
92		const struct vsc_head *head;
93		const char *body;
94
95		struct vjsn *vj;
96
97		unsigned npoints;
98		struct vsc_pt *points;
99
100		int mapped;
101		int exposed;
102		};
103		VTAILQ_HEAD(vsc_seg_head, vsc_seg);
104
105		struct vsc {
106		unsigned magic;
107		#define VSC_MAGIC 0x3373554a
108
109		unsigned raw;
110		struct vsc_sf_head sf_list;
111		struct vsc_seg_head segs;
112		struct vsc_seg_head docs;
113
114		VSC_new_f *fnew;
115		VSC_destroy_f *fdestroy;
116		void *priv;
117		};
118
119		/*--------------------------------------------------------------------
120		* Build the static level, type and point descriptions
121		*/
122
123		enum vsc_levels {
124		#define VSC_LEVEL_F(v,l,e,d) v,
125		#include "tbl/vsc_levels.h"
126		};
127
128		static const struct VSC_level_desc levels[] = {
129		#define VSC_LEVEL_F(v,l,e,d) [v] = {#v, l, e, d},
130		#include "tbl/vsc_levels.h"
131		};
132
133		static const ssize_t nlevels = sizeof(levels)/sizeof(*levels);
134
135		/--------------------------------------------------------------------/
136
137		struct vsc *
138	38400	VSC_New(void)
139		{
140		struct vsc *vsc;
141
142	38400	ALLOC_OBJ(vsc, VSC_MAGIC);
143	38400	if (vsc == NULL)
144	0	return (vsc);
145	38400	VTAILQ_INIT(&vsc->sf_list);
146	38400	VTAILQ_INIT(&vsc->segs);
147	38400	VTAILQ_INIT(&vsc->docs);
148	38400	return (vsc);
149	38400	}
150
151		/--------------------------------------------------------------------/
152
153		static int
154	1480	vsc_sf_arg(struct vsc vsc, const char glob, const struct vsc_sf_mode *mode)
155		{
156		struct vsc_sf *sf;
157
158	1480	CHECK_OBJ_NOTNULL(vsc, VSC_MAGIC);
159	1480	AN(glob);
160	1480	AN(mode);
161
162	1480	ALLOC_OBJ(sf, VSC_SF_MAGIC);
163	1480	AN(sf);
164	1480	REPLACE(sf->pattern, glob);
165	1480	sf->mode = mode;
166	1480	AN(mode->name);
167	1480	if (mode->append)
168	1160	VTAILQ_INSERT_TAIL(&vsc->sf_list, sf, list);
169		else
170	320	VTAILQ_INSERT_HEAD(&vsc->sf_list, sf, list);
171	1480	return (1);
172		}
173
174		static int
175	840	vsc_f_arg(struct vsc vsc, const char opt)
176		{
177
178	840	CHECK_OBJ_NOTNULL(vsc, VSC_MAGIC);
179	840	AN(opt);
180
181	840	if (opt[0] == '^')
182	200	return (vsc_sf_arg(vsc, opt + 1, VSC_SF_EXCLUDE));
183	640	return (vsc_sf_arg(vsc, opt, VSC_SF_INCLUDE));
184	840	}
185
186		/--------------------------------------------------------------------/
187
188		int
189	1480	VSC_Arg(struct vsc vsc, char arg, const char opt)
190		{
191
192	1480	CHECK_OBJ_NOTNULL(vsc, VSC_MAGIC);
193
194	1480	switch (arg) {
195	280	case 'I': return (vsc_sf_arg(vsc, opt, VSC_SF_INCLUDE));
196	40	case 'X': return (vsc_sf_arg(vsc, opt, VSC_SF_EXCLUDE));
197	320	case 'R': return (vsc_sf_arg(vsc, opt, VSC_SF_REQUIRE));
198	840	case 'f': return (vsc_f_arg(vsc, opt));
199	0	case 'r': vsc->raw = !vsc->raw; return (1);
200	0	default: return (0);
201		}
202	1480	}
203
204		unsigned
205	240	VSC_IsRaw(const struct vsc *vsc)
206		{
207
208	240	CHECK_OBJ_NOTNULL(vsc, VSC_MAGIC);
209	240	return (vsc->raw);
210		}
211
212		/*--------------------------------------------------------------------
213		*/
214
215		static int
216	2094623	vsc_filter(const struct vsc vsc, const char nm)
217		{
218		struct vsc_sf *sf;
219	2094623	unsigned res = 0;
220
221	2094623	CHECK_OBJ_NOTNULL(vsc, VSC_MAGIC);
222	2530663	VTAILQ_FOREACH(sf, &vsc->sf_list, list) {
223	444160	if (!fnmatch(sf->pattern, nm, 0))
224	8120	return (!sf->mode->include);
225	436040	res \|= sf->mode->fail;
226	436040	}
227	2086503	return (res);
228	2094623	}
229
230		/*--------------------------------------------------------------------
231		*/
232
233		static void
234	1786303	vsc_clean_point(struct vsc_pt *point)
235		{
236	1786303	REPLACE(point->name, NULL);
237	1786303	}
238
239		static void
240	2094623	vsc_fill_point(const struct vsc vsc, const struct vsc_seg seg,
241		const struct vjsn_val vv, struct vsb vsb, struct vsc_pt *point)
242		{
243		struct vjsn_val *vt;
244
245	2094623	CHECK_OBJ_NOTNULL(vsc, VSC_MAGIC);
246	2094623	memset(point, 0, sizeof *point);
247
248	2094623	vt = vjsn_child(vv, "name");
249	2094623	AN(vt);
250	2094623	assert(vjsn_is_string(vt));
251
252	2094623	VSB_clear(vsb);
253	2094623	VSB_printf(vsb, "%s.%s", seg->fantom->ident, vt->value);
254	2094623	AZ(VSB_finish(vsb));
255
256	2094623	if (vsc_filter(vsc, VSB_data(vsb)))
257	153040	return;
258
259	1941583	point->name = strdup(VSB_data(vsb));
260	1941583	AN(point->name);
261	1941583	point->point.name = point->name;
262
263		#define DOF(n, k) \
264		vt = vjsn_child(vv, k); \
265		AN(vt); \
266		assert(vjsn_is_string(vt)); \
267		point->point.n = vt->value;
268
269	1941583	DOF(ctype, "ctype");
270	1941583	DOF(sdesc, "oneliner");
271	1941583	DOF(ldesc, "docs");
272		#undef DOF
273	1941583	vt = vjsn_child(vv, "type");
274	1941583	AN(vt);
275	1941583	assert(vjsn_is_string(vt));
276
277	1941583	if (!strcmp(vt->value, "counter")) {
278	1707285	point->point.semantics = 'c';
279	1941583	} else if (!strcmp(vt->value, "gauge")) {
280	228830	point->point.semantics = 'g';
281	234298	} else if (!strcmp(vt->value, "bitmap")) {
282	5468	point->point.semantics = 'b';
283	5468	} else {
284	0	point->point.semantics = '?';
285		}
286
287	1941583	vt = vjsn_child(vv, "format");
288	1941583	AN(vt);
289	1941583	assert(vjsn_is_string(vt));
290
291	1941583	if (!strcmp(vt->value, "integer")) {
292	1752603	point->point.format = 'i';
293	1941583	} else if (!strcmp(vt->value, "bytes")) {
294	165472	point->point.format = 'B';
295	188980	} else if (!strcmp(vt->value, "bitmap")) {
296	5468	point->point.format = 'b';
297	23508	} else if (!strcmp(vt->value, "duration")) {
298	18040	point->point.format = 'd';
299	18040	} else {
300	0	point->point.format = '?';
301		}
302
303	1941583	vt = vjsn_child(vv, "level");
304	1941583	AN(vt);
305	1941583	assert(vjsn_is_string(vt));
306
307	1941583	if (!strcmp(vt->value, "info")) {
308	927174	point->point.level = &levels[info];
309	1941583	} else if (!strcmp(vt->value, "diag")) {
310	600636	point->point.level = &levels[diag];
311	1014409	} else if (!strcmp(vt->value, "debug")) {
312	413773	point->point.level = &levels[debug];
313	413773	} else {
314	0	WRONG("Illegal level");
315		}
316
317	1941583	vt = vjsn_child(vv, "index");
318	1941583	AN(vt);
319
320	1941583	point->point.ptr = (volatile const void*)(seg->body + atoi(vt->value));
321	1941583	point->point.raw = vsc->raw;
322	2094623	}
323
324		static struct vsc_seg *
325	380441	vsc_new_seg(const struct vsm_fantom *fp, enum vsc_seg_type type)
326		{
327		struct vsc_seg *sp;
328
329	380441	ALLOC_OBJ(sp, VSC_SEG_MAGIC);
330	380441	AN(sp);
331	380441	sp->fantom = fp;
332	380441	sp->type = type;
333
334	380441	return (sp);
335		}
336
337		static void
338	352161	vsc_unmap_seg(const struct vsc vsc, struct vsm vsm, struct vsc_seg *sp)
339		{
340		unsigned u;
341		struct vsc_pt *pp;
342
343	352161	CHECK_OBJ_NOTNULL(vsc, VSC_MAGIC);
344	352161	AN(vsm);
345	352161	CHECK_OBJ_NOTNULL(sp, VSC_SEG_MAGIC);
346
347	352161	AZ(sp->exposed);
348	352161	if (!sp->mapped)
349	252507	return;
350
351	99654	if (sp->type == VSC_SEG_COUNTERS) {
352	75071	pp = sp->points;
353	1861374	for (u = 0; u < sp->npoints; u++, pp++)
354	1786303	vsc_clean_point(pp);
355	75071	free(sp->points);
356	75071	sp->points = NULL;
357	75071	sp->npoints = 0;
358	75071	AZ(sp->vj);
359	99654	} else if (sp->type == VSC_SEG_DOCS) {
360	24583	if (sp->vj != NULL)
361	24583	vjsn_delete(&sp->vj);
362	24583	AZ(sp->vj);
363	24583	AZ(sp->points);
364	24583	} else {
365	0	WRONG("Invalid segment type");
366		}
367
368	99654	AZ(VSM_Unmap(vsm, sp->fantom));
369	99654	sp->head = NULL;
370	99654	sp->body = NULL;
371	99654	sp->mapped = 0;
372	352161	}
373
374		static int
375	799903	vsc_map_seg(const struct vsc vsc, struct vsm vsm, struct vsc_seg *sp)
376		{
377		const struct vsc_head *head;
378		struct vsc_seg *spd;
379		const char *e;
380		struct vjsn_val vv, vve;
381		struct vsb *vsb;
382		struct vsc_pt *pp;
383		int retry;
384
385	799903	CHECK_OBJ_NOTNULL(vsc, VSC_MAGIC);
386	799903	AN(vsm);
387	799903	CHECK_OBJ_NOTNULL(sp, VSC_SEG_MAGIC);
388
389	799903	if (sp->mapped)
390	671968	return (0);
391
392	127935	AZ(sp->exposed);
393
394	127935	if (VSM_Map(vsm, sp->fantom))
395	1	return (-1);
396	127934	head = sp->fantom->b;
397
398		/* It isn't ready yet. Sleep and try again. If it still
399		* isn't ready, fail the mapping. The transitions inside
400		* varnishd that we are waiting for are just some memcpy()
401		* operations, so there is no reason to allow a long retry
402		* time. */
403	127934	for (retry = 10; retry > 0 && head->ready == 0; retry--)
404	0	usleep(10000);
405
406	127934	if (head->ready == 0) {
407	0	AZ(VSM_Unmap(vsm, sp->fantom));
408	0	return (-1);
409		}
410
411	127934	sp->head = head;
412	127934	sp->body = (char*)sp->fantom->b + sp->head->body_offset;
413	127934	sp->mapped = 1;
414
415	127934	if (sp->type == VSC_SEG_DOCS) {
416		/* Parse the DOCS json */
417	28423	sp->vj = vjsn_parse(sp->body, &e);
418	28423	XXXAZ(e);
419	28423	AN(sp->vj);
420	28423	return (0);
421		}
422
423	99511	assert(sp->type == VSC_SEG_COUNTERS);
424
425		/* Find the corresponding DOCS seg. We are not able to
426		* read and match on the doc_id until the DOCS section is
427		* mapped. Iterate over all the DOCS sections, attempt to
428		* map if needed, and then check the doc_id. */
429	308535	VTAILQ_FOREACH(spd, &vsc->docs, doc_list) {
430	308535	CHECK_OBJ_NOTNULL(spd, VSC_SEG_MAGIC);
431	308535	assert(spd->type == VSC_SEG_DOCS);
432	308535	if (!spd->mapped && vsc_map_seg(vsc, vsm, spd))
433	0	continue; /* Failed to map it */
434	308535	AN(spd->mapped);
435	308535	if (spd->head->doc_id == sp->head->doc_id)
436	99511	break; /* We have a match */
437	209024	}
438	99511	if (spd == NULL) {
439		/* Could not find the right DOCS seg. Leave this
440		* seg as unmapped. */
441	0	vsc_unmap_seg(vsc, vsm, sp);
442	0	return (-1);
443		}
444
445		/* Create the VSC points list */
446	99511	vve = vjsn_child(spd->vj->value, "elements");
447	99511	AN(vve);
448	99511	sp->npoints = strtoul(vve->value, NULL, 0);
449	99511	sp->points = calloc(sp->npoints, sizeof *sp->points);
450	99511	AN(sp->points);
451	99511	vsb = VSB_new_auto();
452	99511	AN(vsb);
453	99511	vve = vjsn_child(spd->vj->value, "elem");
454	99511	AN(vve);
455	99511	pp = sp->points;
456	2194134	VTAILQ_FOREACH(vv, &vve->children, list) {
457	2094623	vsc_fill_point(vsc, sp, vv, vsb, pp);
458	2094623	pp++;
459	2094623	}
460	99511	VSB_destroy(&vsb);
461	99511	return (0);
462	799903	}
463
464		/*--------------------------------------------------------------------
465		*/
466
467		static void
468	1123640	vsc_expose(const struct vsc vsc, struct vsc_seg sp, int del)
469		{
470		struct vsc_pt *pp;
471		unsigned u;
472		int expose;
473
474	1123640	if (!sp->mapped) {
475	252507	AZ(sp->exposed);
476	252507	return;
477		}
478
479	878733	if (vsc->fnew != NULL && !sp->exposed &&
480	8960	!del && sp->head->ready == 1)
481	7600	expose = 1;
482	916901	else if (vsc->fdestroy != NULL && sp->exposed &&
483	60968	(del \|\| sp->head->ready == 2))
484	7600	expose = 0;
485		else
486	855933	return;
487
488	15200	pp = sp->points;
489	183840	for (u = 0; u < sp->npoints; u++, pp++) {
490	168640	if (pp->name == NULL)
491	26640	continue;
492	142000	if (expose)
493	71000	pp->point.priv = vsc->fnew(vsc->priv, &pp->point);
494		else
495	71000	vsc->fdestroy(vsc->priv, &pp->point);
496	142000	}
497	15200	sp->exposed = expose;
498	1123640	}
499