GCOV - Varnish Cache


/*-
 * Copyright (c) 2010-2015 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.
 *
 * Parse `import`, check metadata and versioning.
 *
 */

#include "config.h"

#include <stdlib.h>
#include <string.h>

#include "vcc_compile.h"

#include "libvcc.h"
#include "vfil.h"
#include "vjsn.h"
#include "vmod_abi.h"

#include "vcc_vmod.h"

struct vmod_import {
        unsigned                        magic;
#define VMOD_IMPORT_MAGIC               0x31803a5d
        const char                      *err;
        struct vsb                      *json;
        char                            *path;
        VTAILQ_ENTRY(vmod_import)       list;
        int                             from_vext;
        int                             unimported_vext;

        // From $VMOD
        double                          vmod_syntax;
        char                            *name;
        char                            *func_name;
        char                            *file_id;
        char                            *abi;
        unsigned                        major;
        unsigned                        minor;

        struct symbol                   *sym;
        const struct token              *t_mod;
        struct vjsn                     *vj;
#define STANZA(UU, ll, ss)              int n_##ll;
        STANZA_TBL
#undef STANZA
};

static VTAILQ_HEAD(,vmod_import) imports = VTAILQ_HEAD_INITIALIZER(imports);

typedef void vcc_do_stanza_f(struct vcc *tl, const struct vmod_import *vim,
    const struct vjsn_val *vv);

static int
vcc_Extract_JSON(struct vmod_import *vim, const char *filename)
{
        const char *magic = "VMOD_JSON_SPEC\x02", *p;
        int c;
        FILE *f;

        CHECK_OBJ_NOTNULL(vim, VMOD_IMPORT_MAGIC);
        AN(filename);

        f = fopen(filename, "rb");
        if (f == NULL) {
                vim->err = strerror(errno);
                return (-1);
        }

        p = magic;
        vim->err = "No VMOD JSON found";
        while (1) {
                c = getc(f);
                if (c == EOF) {
                        AZ(fclose(f));
                        vim->err = "No VMOD JSON found";
                        return (-1);
                }
                if (c != *p) {
                        p = magic;
                        continue;
                }
                p++;
                if (*p == '\0')
                        break;
        }

        vim->json = VSB_new_auto();
        AN(vim->json);

        while (1) {
                c = getc(f);
                if (c == EOF) {
                        AZ(fclose(f));
                        vim->err = "Truncated VMOD JSON";
                        VSB_destroy(&vim->json);
                        return (-1);
                }
                if (c == '\x03')
                        break;
                VSB_putc(vim->json, c);
        }
        AZ(fclose(f));
        AZ(VSB_finish(vim->json));
        return (0);
}

static const char *
vcc_ParseJSON(const struct vcc *tl, const char *jsn, struct vmod_import *vim)
{
        const struct vjsn_val *vv, *vv2, *vv3;
        const char *err;
        char *p;

        vim->vj = vjsn_parse(jsn, &err);
        if (err != NULL)
                return (err);
        AN(vim->vj);

        vv = vim->vj->value;
        if (!vjsn_is_array(vv))
                return ("Not array[0]");

        vv2 = VTAILQ_FIRST(&vv->children);
        AN(vv2);
        if (!vjsn_is_array(vv2))
                return ("Not array[1]");
        vv3 = VTAILQ_FIRST(&vv2->children);
        AN(vv3);
        if (!vjsn_is_string(vv3))
                return ("Not string[2]");
        if (strcmp(vv3->value, "$VMOD"))
                return ("Not $VMOD[3]");

        vv3 = VTAILQ_NEXT(vv3, list);
        AN(vv3);
        assert(vjsn_is_string(vv3));
        vim->vmod_syntax = strtod(vv3->value, NULL);
        assert (vim->vmod_syntax == 1.0);

        vv3 = VTAILQ_NEXT(vv3, list);
        AN(vv3);
        assert(vjsn_is_string(vv3));
        vim->name = vv3->value;

        vv3 = VTAILQ_NEXT(vv3, list);
        AN(vv3);
        assert(vjsn_is_string(vv3));
        vim->func_name = vv3->value;

        vv3 = VTAILQ_NEXT(vv3, list);
        AN(vv3);
        assert(vjsn_is_string(vv3));
        vim->file_id = vv3->value;

        vv3 = VTAILQ_NEXT(vv3, list);
        AN(vv3);
        assert(vjsn_is_string(vv3));
        vim->abi = vv3->value;

        vv3 = VTAILQ_NEXT(vv3, list);
        AN(vv3);
        assert(vjsn_is_string(vv3));
        vim->major = strtoul(vv3->value, &p, 10);
        assert(p == NULL || *p == '\0' || *p == 'U');

        vv3 = VTAILQ_NEXT(vv3, list);
        AN(vv3);
        assert(vjsn_is_string(vv3));
        vim->minor = strtoul(vv3->value, &p, 10);
        assert(p == NULL || *p == '\0' || *p == 'U');


        if (vim->major == 0 && vim->minor == 0 &&
            strcmp(vim->abi, VMOD_ABI_Version)) {
                VSB_printf(tl->sb, "Incompatible VMOD %.*s\n", PF(vim->t_mod));
                VSB_printf(tl->sb, "\tFile name: %s\n", vim->path);
                VSB_printf(tl->sb, "\tABI mismatch, expected <%s>, got <%s>\n",
                           VMOD_ABI_Version, vim->abi);
                return ("");
        }
        if (vim->major != 0 &&
            (vim->major != VRT_MAJOR_VERSION ||
            vim->minor > VRT_MINOR_VERSION)) {
                VSB_printf(tl->sb, "Incompatible VMOD %.*s\n", PF(vim->t_mod));
                VSB_printf(tl->sb, "\tFile name: %s\n", vim->path);
                VSB_printf(tl->sb, "\tVMOD wants ABI version %u.%u\n",
                    vim->major, vim->minor);
                VSB_printf(tl->sb, "\tvarnishd provides ABI version %u.%u\n",
                    VRT_MAJOR_VERSION, VRT_MINOR_VERSION);
                return ("");
        }


        VTAILQ_FOREACH(vv2, &vv->children, list) {
                assert (vjsn_is_array(vv2));
                vv3 = VTAILQ_FIRST(&vv2->children);
                assert(vjsn_is_string(vv3));
                assert(vv3->value[0] == '$');
#define STANZA(UU, ll, ss) \
    if (!strcmp(vv3->value, "$" #UU)) {vim->n_##ll++; continue;}
                STANZA_TBL
#undef STANZA
                return ("Unknown metadata stanza.");
        }
        if (vim->n_cproto != 1)
                return ("Bad cproto stanza(s)");
        if (vim->n_vmod != 1)
                return ("Bad vmod stanza(s)");
        return (NULL);
}

/*
 * Load and check the metadata from the objectfile containing the vmod
 */

static int
vcc_VmodLoad(struct vcc *tl, struct vmod_import *vim)
{
        static const char *err;
        struct vmod_import *vim2;

        CHECK_OBJ_NOTNULL(vim, VMOD_IMPORT_MAGIC);

        err = vcc_ParseJSON(tl, VSB_data(vim->json), vim);
        if (err != NULL && *err != '\0') {
                VSB_printf(tl->sb,
                    "VMOD %.*s: bad metadata\n", PF(vim->t_mod));
                VSB_printf(tl->sb, "\t(%s)\n", err);
                VSB_printf(tl->sb, "\tFile name: %s\n", vim->path);
        }

        if (err != NULL)
                return (-1);

        VTAILQ_FOREACH(vim2, &imports, list) {
                if (strcmp(vim->name, vim2->name))
                        continue;
                if (!strcmp(vim->file_id, vim2->file_id)) {
                        // (Truly) duplicate imports are OK
                        return (0);
                }
                VSB_printf(tl->sb,
                    "Different version of VMOD %.*s already loaded\n",
                    PF(vim->t_mod));
                vcc_ErrWhere(tl, vim->t_mod);
                VSB_cat(tl->sb, "Previous import at:\n");
                vcc_ErrWhere(tl, vim2->t_mod);
                vcc_Warn(tl);
                break;
        }
        VTAILQ_INSERT_TAIL(&imports, vim, list);

        return (0);
}

static void v_matchproto_(vcc_do_stanza_f)
vcc_do_event(struct vcc *tl, const struct vmod_import *vim,
    const struct vjsn_val *vv)
{
        struct inifin *ifp;

        ifp = New_IniFin(tl);
        VSB_printf(ifp->ini,
            "\tif (%s(ctx, &vmod_priv_%s, VCL_EVENT_LOAD))\n"
            "\t\treturn(1);",
            vv->value, vim->sym->vmod_name);
        VSB_printf(ifp->fin,
            "\t\t(void)%s(ctx, &vmod_priv_%s,\n"
            "\t\t\t    VCL_EVENT_DISCARD);",
            vv->value, vim->sym->vmod_name);
        VSB_printf(ifp->event, "%s(ctx, &vmod_priv_%s, ev)",
            vv->value, vim->sym->vmod_name);
}

static void v_matchproto_(vcc_do_stanza_f)
vcc_do_cproto(struct vcc *tl, const struct vmod_import *vim,
    const struct vjsn_val *vv)
{
        (void)vim;
        do {
                assert (vjsn_is_string(vv));
                Fh(tl, 0, "%s\n", vv->value);
                vv = VTAILQ_NEXT(vv, list);
        } while(vv != NULL);
}

static void
vcc_vj_foreach(struct vcc *tl, const struct vmod_import *vim,
    const char *stanza, vcc_do_stanza_f *func)
{
        const struct vjsn_val *vv, *vv2, *vv3;

        vv = vim->vj->value;
        assert (vjsn_is_array(vv));
        VTAILQ_FOREACH(vv2, &vv->children, list) {
                assert (vjsn_is_array(vv2));
                vv3 = VTAILQ_FIRST(&vv2->children);
                assert (vjsn_is_string(vv3));
                if (!strcmp(vv3->value, stanza))
                        func(tl, vim, VTAILQ_NEXT(vv3, list));
        }
}

static void
vcc_emit_setup(struct vcc *tl, const struct vmod_import *vim)
{
        struct inifin *ifp;
        const struct token *mod = vim->t_mod;

        ifp = New_IniFin(tl);

        VSB_cat(ifp->ini, "\tif (VPI_Vmod_Init(ctx,\n");
        VSB_printf(ifp->ini, "\t    &VGC_vmod_%.*s,\n", PF(mod));
        VSB_printf(ifp->ini, "\t    %u,\n", tl->vmod_count++);
        VSB_printf(ifp->ini, "\t    &%s,\n", vim->func_name);
        VSB_printf(ifp->ini, "\t    sizeof(%s),\n", vim->func_name);
        VSB_printf(ifp->ini, "\t    \"%.*s\",\n", PF(mod));
        VSB_cat(ifp->ini, "\t    ");
        VSB_quote(ifp->ini, vim->path, -1, VSB_QUOTE_CSTR);
        VSB_cat(ifp->ini, ",\n");
        AN(vim->file_id);
        VSB_printf(ifp->ini, "\t    \"%s\",\n", vim->file_id);
        if (vim->from_vext) {
                VSB_cat(ifp->ini, "\t    ");
                VSB_quote(ifp->ini, vim->path, -1, VSB_QUOTE_CSTR);
                VSB_cat(ifp->ini, "\n");
        } else {
                VSB_printf(ifp->ini, "\t    \"./vmod_cache/_vmod_%.*s.%s\"\n",
                    PF(mod), vim->file_id);
        }
        VSB_cat(ifp->ini, "\t    ))\n");
        VSB_cat(ifp->ini, "\t\treturn(1);");

        VSB_cat(tl->symtab, ",\n    {\n");
        VSB_cat(tl->symtab, "\t\"dir\": \"import\",\n");
        VSB_cat(tl->symtab, "\t\"type\": \"$VMOD\",\n");
        VSB_printf(tl->symtab, "\t\"name\": \"%.*s\",\n", PF(mod));
        if (vim->from_vext)
                VSB_cat(tl->symtab, "\t\"vext\": true,\n");
        else
                VSB_cat(tl->symtab, "\t\"vext\": false,\n");
        VSB_printf(tl->symtab, "\t\"file\": \"%s\",\n", vim->path);
        VSB_printf(tl->symtab, "\t\"dst\": \"./vmod_cache/_vmod_%.*s.%s\"\n",
            PF(mod), vim->file_id);
        VSB_cat(tl->symtab, "    }");

        /* XXX: zero the function pointer structure ?*/
        VSB_printf(ifp->fin, "\t\tVRT_priv_fini(ctx, &vmod_priv_%.*s);",
            PF(mod));
        VSB_printf(ifp->final, "\t\tVPI_Vmod_Unload(ctx, &VGC_vmod_%.*s);",
            PF(mod));

        vcc_vj_foreach(tl, vim, "$EVENT", vcc_do_event);

        Fh(tl, 0, "\n/* --- BEGIN VMOD %.*s --- */\n\n", PF(mod));
        Fh(tl, 0, "static struct vmod *VGC_vmod_%.*s;\n", PF(mod));
        Fh(tl, 0, "static struct vmod_priv vmod_priv_%.*s;\n", PF(mod));

        vcc_vj_foreach(tl, vim, "$CPROTO", vcc_do_cproto);

        Fh(tl, 0, "\n/* --- END VMOD %.*s --- */\n\n", PF(mod));
}

static void
vcc_vim_destroy(struct vmod_import **vimp)
{
        struct vmod_import *vim;

        TAKE_OBJ_NOTNULL(vim, vimp, VMOD_IMPORT_MAGIC);
        if (vim->path)
                free(vim->path);
        if (vim->vj)
                vjsn_delete(&vim->vj);
        if (vim->json)
                VSB_destroy(&vim->json);
        FREE_OBJ(vim);
}

static int
vcc_path_open(void *priv, const char *fn)
{
        struct vmod_import *vim;

        CAST_OBJ_NOTNULL(vim, priv, VMOD_IMPORT_MAGIC);
        AN(fn);

        return (vcc_Extract_JSON(vim, fn));
}

void
vcc_ParseImport(struct vcc *tl)
{
        char fn[1024];
        const char *p;
        struct token *mod, *tmod, *t1;
        struct symbol *msym, *vsym;
        struct vmod_import *vim = NULL;
        const struct vmod_import *vimold;

        t1 = tl->t;
        SkipToken(tl, ID);              /* "import" */

        ExpectErr(tl, ID);              /* "vmod_name" */
        mod = tl->t;
        tmod = vcc_PeekTokenFrom(tl, mod);
        AN(tmod);
        if (tmod->tok == ID && vcc_IdIs(tmod, "as")) {
                vcc_NextToken(tl);              /* "vmod_name" */
                vcc_NextToken(tl);              /* "as" */
                ExpectErr(tl, ID);              /* "vcl_name" */
        }
        tmod = tl->t;

        msym = VCC_SymbolGet(tl, SYM_MAIN, SYM_VMOD, SYMTAB_CREATE, XREF_NONE);
        ERRCHK(tl);
        AN(msym);

        bprintf(fn, "libvmod_%.*s.so", PF(mod));
        if (tl->t->tok == ID) {
                if (!vcc_IdIs(tl->t, "from")) {
                        VSB_cat(tl->sb, "Expected 'from path ...'\n");
                        vcc_ErrWhere(tl, tl->t);
                        return;
                }
                vcc_NextToken(tl);
                if (!tl->unsafe_path && strchr(tl->t->dec, '/')) {
                        VSB_cat(tl->sb,
                            "'import ... from path ...' is unsafe.\nAt:");
                        vcc_ErrToken(tl, tl->t);
                        vcc_ErrWhere(tl, tl->t);
                        return;
                }
                ExpectErr(tl, CSTR);
                p = strrchr(tl->t->dec, '/');
                if (p != NULL && p[1] == '\0')
                        bprintf(fn, "%slibvmod_%.*s.so", tl->t->dec, PF(mod));
                else
                        bprintf(fn, "%s", tl->t->dec);
                vcc_NextToken(tl);
        } else {
                VTAILQ_FOREACH(vim, &imports, list) {
                        if (!vcc_IdIs(mod, vim->name))
                                continue;
                        if (!vim->unimported_vext)
                                continue;
                        fprintf(stderr, "IMPORT %s from VEXT\n", vim->name);
                        vim->unimported_vext = 0;
                        vim->t_mod = mod;
                        vim->sym = msym;
                        break;
                }
        }

        SkipToken(tl, ';');

        if (vim == NULL) {
                ALLOC_OBJ(vim, VMOD_IMPORT_MAGIC);
                AN(vim);
                vim->t_mod = mod;
                vim->sym = msym;

                if (VFIL_searchpath(tl->vmod_path, vcc_path_open, vim, fn, &vim->path)) {
                        if (vim->err == NULL) {
                                VSB_printf(tl->sb,
                                    "Could not find VMOD %.*s\n", PF(mod));
                        } else {
                                VSB_printf(tl->sb,
                                    "Could not open VMOD %.*s\n", PF(mod));
                                VSB_printf(tl->sb, "\tFile name: %s\n",
                                    vim->path != NULL ? vim->path : fn);
                                VSB_printf(tl->sb, "\tError: %s\n", vim->err);
                        }
                        vcc_ErrWhere(tl, mod);
                        vcc_vim_destroy(&vim);
                        return;
                }

                if (vcc_VmodLoad(tl, vim) < 0 || tl->err) {
                        vcc_ErrWhere(tl, vim->t_mod);
                        vcc_vim_destroy(&vim);
                        return;
                }
        }

        if (!vcc_IdIs(vim->t_mod, vim->name)) {
                vcc_ErrWhere(tl, vim->t_mod);
                VSB_printf(tl->sb, "Wrong file for VMOD %.*s\n",
                    PF(vim->t_mod));
                VSB_printf(tl->sb, "\tFile name: %s\n", vim->path);
                VSB_printf(tl->sb, "\tContains vmod \"%s\"\n", vim->name);
                vcc_vim_destroy(&vim);
                return;
        }

        vimold = msym->import;
        if (vimold != NULL) {
                CHECK_OBJ(vimold, VMOD_IMPORT_MAGIC);
                if (!strcmp(vimold->file_id, vim->file_id)) {
                        /* Identical import is OK */
                } else {
                        VSB_printf(tl->sb,
                            "Another module already imported as %.*s.\n",
                            PF(tmod));
                        vcc_ErrWhere2(tl, t1, tl->t);
                }
                vcc_vim_destroy(&vim);
                return;
        }
        msym->def_b = t1;
        msym->def_e = tl->t;

        VTAILQ_FOREACH(vsym, &tl->sym_vmods, sideways) {
                assert(vsym->kind == SYM_VMOD);
                vimold = vsym->import;
                CHECK_OBJ_NOTNULL(vimold, VMOD_IMPORT_MAGIC);
                if (!strcmp(vimold->file_id, vim->file_id)) {
                        /* Already loaded under different name */
                        msym->eval_priv = vsym->eval_priv;
                        msym->import = vsym->import;
                        msym->vmod_name = vsym->vmod_name;
                        vcc_VmodSymbols(tl, msym);
                        AZ(tl->err);
                        // XXX: insert msym in sideways ?
                        vcc_vim_destroy(&vim);
                        return;
                }
        }

        VTAILQ_INSERT_TAIL(&tl->sym_vmods, msym, sideways);

        msym->eval_priv = vim->vj;
        msym->import = vim;
        msym->vmod_name = TlDup(tl, vim->name);
        vcc_VmodSymbols(tl, msym);
        ERRCHK(tl);

        vcc_emit_setup(tl, vim);
}

void
vcc_ImportVext(struct vcc *tl, const char *filename)
{
        struct vmod_import *vim;

        ALLOC_OBJ(vim, VMOD_IMPORT_MAGIC);
        AN(vim);

        if (vcc_Extract_JSON(vim, filename)) {
                FREE_OBJ(vim);
                return;
        }
        fprintf(stderr, "FOUND VMOD in VEXT %s\n", filename);
        if (vcc_VmodLoad(tl, vim) < 0 || tl->err) {
                // vcc_ErrWhere(tl, vim->t_mod);
                vcc_vim_destroy(&vim);
                return;
        }
        vim->from_vext = 1;
        vim->unimported_vext = 1;
        vim->path = strdup(filename);
        vim->path += 1;
        AN(vim->path);
        fprintf(stderr, "GOOD VMOD %s in VEXT %s\n", vim->name, filename);
}

		varnish-cache/lib/libvcc/vcc_vmod.c
0		/*-
1		* Copyright (c) 2010-2015 Varnish Software AS
2		* All rights reserved.
3		*
4		* Author: Poul-Henning Kamp <phk@phk.freebsd.dk>
5		*
6		* SPDX-License-Identifier: BSD-2-Clause
7		*
8		* Redistribution and use in source and binary forms, with or without
9		* modification, are permitted provided that the following conditions
10		* are met:
11		* 1. Redistributions of source code must retain the above copyright
12		* notice, this list of conditions and the following disclaimer.
13		* 2. Redistributions in binary form must reproduce the above copyright
14		* notice, this list of conditions and the following disclaimer in the
15		* documentation and/or other materials provided with the distribution.
16		*
17		* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18		* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19		* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20		* ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
21		* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22		* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23		* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24		* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25		* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26		* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27		* SUCH DAMAGE.
28		*
29		* Parse `import`, check metadata and versioning.
30		*
31		*/
32
33		#include "config.h"
34
35		#include <stdlib.h>
36		#include <string.h>
37
38		#include "vcc_compile.h"
39
40		#include "libvcc.h"
41		#include "vfil.h"
42		#include "vjsn.h"
43		#include "vmod_abi.h"
44
45		#include "vcc_vmod.h"
46
47		struct vmod_import {
48		unsigned magic;
49		#define VMOD_IMPORT_MAGIC 0x31803a5d
50		const char *err;
51		struct vsb *json;
52		char *path;
53		VTAILQ_ENTRY(vmod_import) list;
54		int from_vext;
55		int unimported_vext;
56
57		// From $VMOD
58		double vmod_syntax;
59		char *name;
60		char *func_name;
61		char *file_id;
62		char *abi;
63		unsigned major;
64		unsigned minor;
65
66		struct symbol *sym;
67		const struct token *t_mod;
68		struct vjsn *vj;
69		#define STANZA(UU, ll, ss) int n_##ll;
70		STANZA_TBL
71		#undef STANZA
72		};
73
74		static VTAILQ_HEAD(,vmod_import) imports = VTAILQ_HEAD_INITIALIZER(imports);
75
76		typedef void vcc_do_stanza_f(struct vcc tl, const struct vmod_import vim,
77		const struct vjsn_val *vv);
78
79		static int
80	22960	vcc_Extract_JSON(struct vmod_import vim, const char filename)
81		{
82	22960	const char magic = "VMOD_JSON_SPEC\x02", p;
83		int c;
84		FILE *f;
85
86	22960	CHECK_OBJ_NOTNULL(vim, VMOD_IMPORT_MAGIC);
87	22960	AN(filename);
88
89	22960	f = fopen(filename, "rb");
90	22960	if (f == NULL) {
91	40	vim->err = strerror(errno);
92	40	return (-1);
93		}
94
95	22920	p = magic;
96	22920	vim->err = "No VMOD JSON found";
97	1663200	while (1) {
98	410293440	c = getc(f);
99	410293440	if (c == EOF) {
100	40	AZ(fclose(f));
101	40	vim->err = "No VMOD JSON found";
102	40	return (-1);
103		}
104	410293400	if (c != *p) {
105	408630240	p = magic;
106	408630240	continue;
107		}
108	1663160	p++;
109	1663160	if (*p == '\0')
110	22880	break;
111		}
112
113	22880	vim->json = VSB_new_auto();
114	22880	AN(vim->json);
115
116	405996360	while (1) {
117	405996360	c = getc(f);
118	405996360	if (c == EOF) {
119	40	AZ(fclose(f));
120	40	vim->err = "Truncated VMOD JSON";
121	40	VSB_destroy(&vim->json);
122	40	return (-1);
123		}
124	405996320	if (c == '\x03')
125	22840	break;
126	405973480	VSB_putc(vim->json, c);
127		}
128	22840	AZ(fclose(f));
129	22840	AZ(VSB_finish(vim->json));
130	22840	return (0);
131	22960	}
132
133		static const char *
134	22840	vcc_ParseJSON(const struct vcc tl, const char jsn, struct vmod_import *vim)
135		{
136		const struct vjsn_val vv, vv2, *vv3;
137		const char *err;
138		char *p;
139
140	22840	vim->vj = vjsn_parse(jsn, &err);
141	22840	if (err != NULL)
142	40	return (err);
143	22800	AN(vim->vj);
144
145	22800	vv = vim->vj->value;
146	22800	if (!vjsn_is_array(vv))
147	40	return ("Not array[0]");
148
149	22760	vv2 = VTAILQ_FIRST(&vv->children);
150	22760	AN(vv2);
151	22760	if (!vjsn_is_array(vv2))
152	40	return ("Not array[1]");
153	22720	vv3 = VTAILQ_FIRST(&vv2->children);
154	22720	AN(vv3);
155	22720	if (!vjsn_is_string(vv3))
156	40	return ("Not string[2]");
157	22680	if (strcmp(vv3->value, "$VMOD"))
158	40	return ("Not $VMOD[3]");
159
160	22640	vv3 = VTAILQ_NEXT(vv3, list);
161	22640	AN(vv3);
162	22640	assert(vjsn_is_string(vv3));
163	22640	vim->vmod_syntax = strtod(vv3->value, NULL);
164	22640	assert (vim->vmod_syntax == 1.0);
165
166	22640	vv3 = VTAILQ_NEXT(vv3, list);
167	22640	AN(vv3);
168	22640	assert(vjsn_is_string(vv3));
169	22640	vim->name = vv3->value;
170
171	22640	vv3 = VTAILQ_NEXT(vv3, list);
172	22640	AN(vv3);
173	22640	assert(vjsn_is_string(vv3));
174	22640	vim->func_name = vv3->value;
175
176	22640	vv3 = VTAILQ_NEXT(vv3, list);
177	22640	AN(vv3);
178	22640	assert(vjsn_is_string(vv3));
179	22640	vim->file_id = vv3->value;
180
181	22640	vv3 = VTAILQ_NEXT(vv3, list);
182	22640	AN(vv3);
183	22640	assert(vjsn_is_string(vv3));
184	22640	vim->abi = vv3->value;
185
186	22640	vv3 = VTAILQ_NEXT(vv3, list);
187	22640	AN(vv3);
188	22640	assert(vjsn_is_string(vv3));
189	22640	vim->major = strtoul(vv3->value, &p, 10);
190	22640	assert(p == NULL \|\| p == '\0' \|\| p == 'U');
191
192	22640	vv3 = VTAILQ_NEXT(vv3, list);
193	22640	AN(vv3);
194	22640	assert(vjsn_is_string(vv3));
195	22640	vim->minor = strtoul(vv3->value, &p, 10);
196	22640	assert(p == NULL \|\| p == '\0' \|\| p == 'U');
197
198
199	22640	if (vim->major == 0 && vim->minor == 0 &&
200	17520	strcmp(vim->abi, VMOD_ABI_Version)) {
201	40	VSB_printf(tl->sb, "Incompatible VMOD %.*s\n", PF(vim->t_mod));
202	40	VSB_printf(tl->sb, "\tFile name: %s\n", vim->path);
203	80	VSB_printf(tl->sb, "\tABI mismatch, expected <%s>, got <%s>\n",
204	40	VMOD_ABI_Version, vim->abi);
205	40	return ("");
206		}
207	27680	if (vim->major != 0 &&
208	5120	(vim->major != VRT_MAJOR_VERSION \|\|
209	5080	vim->minor > VRT_MINOR_VERSION)) {
210	40	VSB_printf(tl->sb, "Incompatible VMOD %.*s\n", PF(vim->t_mod));
211	40	VSB_printf(tl->sb, "\tFile name: %s\n", vim->path);
212	80	VSB_printf(tl->sb, "\tVMOD wants ABI version %u.%u\n",
213	40	vim->major, vim->minor);
214	40	VSB_printf(tl->sb, "\tvarnishd provides ABI version %u.%u\n",
215		VRT_MAJOR_VERSION, VRT_MINOR_VERSION);
216	40	return ("");
217		}
218
219
220	794920	VTAILQ_FOREACH(vv2, &vv->children, list) {
221	772400	assert (vjsn_is_array(vv2));
222	772400	vv3 = VTAILQ_FIRST(&vv2->children);
223	772400	assert(vjsn_is_string(vv3));
224	772400	assert(vv3->value[0] == '$');
225		#define STANZA(UU, ll, ss) \
226		if (!strcmp(vv3->value, "$" #UU)) {vim->n_##ll++; continue;}
227	772400	STANZA_TBL
228		#undef STANZA
229	40	return ("Unknown metadata stanza.");
230		}
231	22520	if (vim->n_cproto != 1)
232	40	return ("Bad cproto stanza(s)");
233	22480	if (vim->n_vmod != 1)
234	40	return ("Bad vmod stanza(s)");
235	22440	return (NULL);
236	22840	}
237
238		/*
239		* Load and check the metadata from the objectfile containing the vmod
240		*/
241
242		static int
243	22840	vcc_VmodLoad(struct vcc tl, struct vmod_import vim)
244		{
245		static const char *err;
246		struct vmod_import *vim2;
247
248	22840	CHECK_OBJ_NOTNULL(vim, VMOD_IMPORT_MAGIC);
249
250	22840	err = vcc_ParseJSON(tl, VSB_data(vim->json), vim);
251	22840	if (err != NULL && *err != '\0') {
252	640	VSB_printf(tl->sb,
253	320	"VMOD %.*s: bad metadata\n", PF(vim->t_mod));
254	320	VSB_printf(tl->sb, "\t(%s)\n", err);
255	320	VSB_printf(tl->sb, "\tFile name: %s\n", vim->path);
256	320	}
257
258	22840	if (err != NULL)
259	400	return (-1);
260
261	28000	VTAILQ_FOREACH(vim2, &imports, list) {
262	5720	if (strcmp(vim->name, vim2->name))
263	5560	continue;
264	160	if (!strcmp(vim->file_id, vim2->file_id)) {
265		// (Truly) duplicate imports are OK
266	120	return (0);
267		}
268	80	VSB_printf(tl->sb,
269		"Different version of VMOD %.*s already loaded\n",
270	40	PF(vim->t_mod));
271	40	vcc_ErrWhere(tl, vim->t_mod);
272	40	VSB_cat(tl->sb, "Previous import at:\n");
273	40	vcc_ErrWhere(tl, vim2->t_mod);
274	40	vcc_Warn(tl);
275	40	break;
276		}
277	22320	VTAILQ_INSERT_TAIL(&imports, vim, list);
278
279	22320	return (0);
280	22840	}
281
282		static void v_matchproto_(vcc_do_stanza_f)
283	4680	vcc_do_event(struct vcc tl, const struct vmod_import vim,
284		const struct vjsn_val *vv)
285		{
286		struct inifin *ifp;
287
288	4680	ifp = New_IniFin(tl);
289	9360	VSB_printf(ifp->ini,
290		"\tif (%s(ctx, &vmod_priv_%s, VCL_EVENT_LOAD))\n"
291		"\t\treturn(1);",
292	4680	vv->value, vim->sym->vmod_name);
293	9360	VSB_printf(ifp->fin,
294		"\t\t(void)%s(ctx, &vmod_priv_%s,\n"
295		"\t\t\t VCL_EVENT_DISCARD);",
296	4680	vv->value, vim->sym->vmod_name);
297	9360	VSB_printf(ifp->event, "%s(ctx, &vmod_priv_%s, ev)",
298	4680	vv->value, vim->sym->vmod_name);
299	4680	}
300
301		static void v_matchproto_(vcc_do_stanza_f)
302	22160	vcc_do_cproto(struct vcc tl, const struct vmod_import vim,
303		const struct vjsn_val *vv)
304		{
305	22160	(void)vim;
306	22160	do {
307	4050640	assert (vjsn_is_string(vv));
308	4050640	Fh(tl, 0, "%s\n", vv->value);
309	4050640	vv = VTAILQ_NEXT(vv, list);
310	4050640	} while(vv != NULL);
311	22160	}
312
313		static void
314	44320	vcc_vj_foreach(struct vcc tl, const struct vmod_import vim,
315		const char stanza, vcc_do_stanza_f func)
316		{
317		const struct vjsn_val vv, vv2, *vv3;
318
319	44320	vv = vim->vj->value;
320	44320	assert (vjsn_is_array(vv));
321	1560720	VTAILQ_FOREACH(vv2, &vv->children, list) {
322	1516400	assert (vjsn_is_array(vv2));
323	1516400	vv3 = VTAILQ_FIRST(&vv2->children);
324	1516400	assert (vjsn_is_string(vv3));
325	1516400	if (!strcmp(vv3->value, stanza))
326	26840	func(tl, vim, VTAILQ_NEXT(vv3, list));
327	1516400	}
328	44320	}
329
330		static void
331	22160	vcc_emit_setup(struct vcc tl, const struct vmod_import vim)
332		{
333		struct inifin *ifp;
334	22160	const struct token *mod = vim->t_mod;
335
336	22160	ifp = New_IniFin(tl);
337
338	22160	VSB_cat(ifp->ini, "\tif (VPI_Vmod_Init(ctx,\n");
339	22160	VSB_printf(ifp->ini, "\t &VGC_vmod_%.*s,\n", PF(mod));
340	22160	VSB_printf(ifp->ini, "\t %u,\n", tl->vmod_count++);
341	22160	VSB_printf(ifp->ini, "\t &%s,\n", vim->func_name);
342	22160	VSB_printf(ifp->ini, "\t sizeof(%s),\n", vim->func_name);
343	22160	VSB_printf(ifp->ini, "\t \"%.*s\",\n", PF(mod));
344	22160	VSB_cat(ifp->ini, "\t ");
345	22160	VSB_quote(ifp->ini, vim->path, -1, VSB_QUOTE_CSTR);
346	22160	VSB_cat(ifp->ini, ",\n");
347	22160	AN(vim->file_id);
348	22160	VSB_printf(ifp->ini, "\t \"%s\",\n", vim->file_id);
349	22160	if (vim->from_vext) {
350	40	VSB_cat(ifp->ini, "\t ");
351	40	VSB_quote(ifp->ini, vim->path, -1, VSB_QUOTE_CSTR);
352	40	VSB_cat(ifp->ini, "\n");
353	40	} else {
354	44240	VSB_printf(ifp->ini, "\t \"./vmod_cache/_vmod_%.*s.%s\"\n",
355	22120	PF(mod), vim->file_id);
356		}
357	22160	VSB_cat(ifp->ini, "\t ))\n");
358	22160	VSB_cat(ifp->ini, "\t\treturn(1);");
359
360	22160	VSB_cat(tl->symtab, ",\n {\n");
361	22160	VSB_cat(tl->symtab, "\t\"dir\": \"import\",\n");
362	22160	VSB_cat(tl->symtab, "\t\"type\": \"$VMOD\",\n");
363	22160	VSB_printf(tl->symtab, "\t\"name\": \"%.*s\",\n", PF(mod));
364	22160	if (vim->from_vext)
365	40	VSB_cat(tl->symtab, "\t\"vext\": true,\n");
366		else
367	22120	VSB_cat(tl->symtab, "\t\"vext\": false,\n");
368	22160	VSB_printf(tl->symtab, "\t\"file\": \"%s\",\n", vim->path);
369	44320	VSB_printf(tl->symtab, "\t\"dst\": \"./vmod_cache/_vmod_%.*s.%s\"\n",
370	22160	PF(mod), vim->file_id);
371	22160	VSB_cat(tl->symtab, " }");
372
373		/* XXX: zero the function pointer structure ?*/
374	44320	VSB_printf(ifp->fin, "\t\tVRT_priv_fini(ctx, &vmod_priv_%.*s);",
375	22160	PF(mod));
376	44320	VSB_printf(ifp->final, "\t\tVPI_Vmod_Unload(ctx, &VGC_vmod_%.*s);",
377	22160	PF(mod));
378
379	22160	vcc_vj_foreach(tl, vim, "$EVENT", vcc_do_event);
380
381	22160	Fh(tl, 0, "\n/* --- BEGIN VMOD %.s --- /\n\n", PF(mod));
382	22160	Fh(tl, 0, "static struct vmod VGC_vmod_%.s;\n", PF(mod));
383	22160	Fh(tl, 0, "static struct vmod_priv vmod_priv_%.*s;\n", PF(mod));
384
385	22160	vcc_vj_foreach(tl, vim, "$CPROTO", vcc_do_cproto);
386
387	22160	Fh(tl, 0, "\n/* --- END VMOD %.s --- /\n\n", PF(mod));
388	22160	}
389
390		static void
391	800	vcc_vim_destroy(struct vmod_import **vimp)
392		{
393		struct vmod_import *vim;
394
395	800	TAKE_OBJ_NOTNULL(vim, vimp, VMOD_IMPORT_MAGIC);
396	800	if (vim->path)
397	760	free(vim->path);
398	800	if (vim->vj)
399	600	vjsn_delete(&vim->vj);
400	800	if (vim->json)
401	640	VSB_destroy(&vim->json);
402	800	FREE_OBJ(vim);
403	800	}
404
405		static int
406	22920	vcc_path_open(void priv, const char fn)
407		{
408		struct vmod_import *vim;
409
410	22920	CAST_OBJ_NOTNULL(vim, priv, VMOD_IMPORT_MAGIC);
411	22920	AN(fn);
412
413	22920	return (vcc_Extract_JSON(vim, fn));
414		}
415
416		void
417	23120	vcc_ParseImport(struct vcc *tl)
418		{
419		char fn[1024];
420		const char *p;
421		struct token mod, tmod, *t1;
422		struct symbol msym, vsym;
423	23120	struct vmod_import *vim = NULL;
424		const struct vmod_import *vimold;
425
426	23120	t1 = tl->t;
427	23120	SkipToken(tl, ID); /* "import" */
428
429	23120	ExpectErr(tl, ID); /* "vmod_name" */
430	23120	mod = tl->t;
431	23120	tmod = vcc_PeekTokenFrom(tl, mod);
432	23120	AN(tmod);
433	23120	if (tmod->tok == ID && vcc_IdIs(tmod, "as")) {
434	200	vcc_NextToken(tl); /* "vmod_name" */
435	200	vcc_NextToken(tl); /* "as" */
436	200	ExpectErr(tl, ID); /* "vcl_name" */
437	200	}
438	23120	tmod = tl->t;
439
440	23120	msym = VCC_SymbolGet(tl, SYM_MAIN, SYM_VMOD, SYMTAB_CREATE, XREF_NONE);
441	23120	ERRCHK(tl);
442	23080	AN(msym);
443
444	23080	bprintf(fn, "libvmod_%.*s.so", PF(mod));
445	23080	if (tl->t->tok == ID) {
446	200	if (!vcc_IdIs(tl->t, "from")) {
447	40	VSB_cat(tl->sb, "Expected 'from path ...'\n");
448	40	vcc_ErrWhere(tl, tl->t);
449	40	return;
450		}
451	160	vcc_NextToken(tl);
452	160	if (!tl->unsafe_path && strchr(tl->t->dec, '/')) {
453	40	VSB_cat(tl->sb,
454		"'import ... from path ...' is unsafe.\nAt:");
455	40	vcc_ErrToken(tl, tl->t);
456	40	vcc_ErrWhere(tl, tl->t);
457	40	return;
458		}
459	120	ExpectErr(tl, CSTR);
460	120	p = strrchr(tl->t->dec, '/');
461	120	if (p != NULL && p[1] == '\0')
462	40	bprintf(fn, "%slibvmod_%.*s.so", tl->t->dec, PF(mod));
463		else
464	80	bprintf(fn, "%s", tl->t->dec);
465	120	vcc_NextToken(tl);
466	120	} else {
467	28680	VTAILQ_FOREACH(vim, &imports, list) {
468	5840	if (!vcc_IdIs(mod, vim->name))
469	5680	continue;
470	160	if (!vim->unimported_vext)
471	120	continue;
472	40	fprintf(stderr, "IMPORT %s from VEXT\n", vim->name);
473	40	vim->unimported_vext = 0;
474	40	vim->t_mod = mod;
475	40	vim->sym = msym;
476	40	break;
477		}
478		}
479
480	23000	SkipToken(tl, ';');
481
482	23000	if (vim == NULL) {
483	22960	ALLOC_OBJ(vim, VMOD_IMPORT_MAGIC);
484	22960	AN(vim);
485	22960	vim->t_mod = mod;
486	22960	vim->sym = msym;
487
488	22960	if (VFIL_searchpath(tl->vmod_path, vcc_path_open, vim, fn, &vim->path)) {
489	160	if (vim->err == NULL) {
490	80	VSB_printf(tl->sb,
491	40	"Could not find VMOD %.*s\n", PF(mod));
492	40	} else {
493	240	VSB_printf(tl->sb,
494	120	"Could not open VMOD %.*s\n", PF(mod));
495	240	VSB_printf(tl->sb, "\tFile name: %s\n",
496	120	vim->path != NULL ? vim->path : fn);
497	120	VSB_printf(tl->sb, "\tError: %s\n", vim->err);
498		}
499	160	vcc_ErrWhere(tl, mod);