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);
        if (vim->vmod_syntax != 2.0)
                return ("Syntax != 2.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	24080	vcc_Extract_JSON(struct vmod_import vim, const char filename)
81		{
82	24080	const char magic = "VMOD_JSON_SPEC\x02", p;
83		int c;
84		FILE *f;
85
86	24080	CHECK_OBJ_NOTNULL(vim, VMOD_IMPORT_MAGIC);
87	24080	AN(filename);
88
89	24080	f = fopen(filename, "rb");
90	24080	if (f == NULL) {
91	40	vim->err = strerror(errno);
92	40	return (-1);
93		}
94
95	24040	p = magic;
96	24040	vim->err = "No VMOD JSON found";
97	1945520	while (1) {
98	486818400	c = getc(f);
99	486818400	if (c == EOF) {
100	40	AZ(fclose(f));
101	40	vim->err = "No VMOD JSON found";
102	40	return (-1);
103		}
104	486818360	if (c != *p) {
105	484872880	p = magic;
106	484872880	continue;
107		}
108	1945480	p++;
109	1945480	if (*p == '\0')
110	24000	break;
111		}
112
113	24000	vim->json = VSB_new_auto();
114	24000	AN(vim->json);
115
116	481722520	while (1) {
117	481722520	c = getc(f);
118	481722520	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	481722480	if (c == '\x03')
125	23960	break;
126	481698520	VSB_putc(vim->json, c);
127		}
128	23960	AZ(fclose(f));
129	23960	AZ(VSB_finish(vim->json));
130	23960	return (0);
131	24080	}
132
133		static const char *
134	23960	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	23960	vim->vj = vjsn_parse(jsn, &err);
141	23960	if (err != NULL)
142	40	return (err);
143	23920	AN(vim->vj);
144
145	23920	vv = vim->vj->value;
146	23920	if (!vjsn_is_array(vv))
147	40	return ("Not array[0]");
148
149	23880	vv2 = VTAILQ_FIRST(&vv->children);
150	23880	AN(vv2);
151	23880	if (!vjsn_is_array(vv2))
152	40	return ("Not array[1]");
153	23840	vv3 = VTAILQ_FIRST(&vv2->children);
154	23840	AN(vv3);
155	23840	if (!vjsn_is_string(vv3))
156	40	return ("Not string[2]");
157	23800	if (strcmp(vv3->value, "$VMOD"))
158	40	return ("Not $VMOD[3]");
159
160	23760	vv3 = VTAILQ_NEXT(vv3, list);
161	23760	AN(vv3);
162	23760	assert(vjsn_is_string(vv3));
163	23760	vim->vmod_syntax = strtod(vv3->value, NULL);
164	23760	if (vim->vmod_syntax != 2.0)
165	40	return ("Syntax != 2.0");
166
167	23720	vv3 = VTAILQ_NEXT(vv3, list);
168	23720	AN(vv3);
169	23720	assert(vjsn_is_string(vv3));
170	23720	vim->name = vv3->value;
171
172	23720	vv3 = VTAILQ_NEXT(vv3, list);
173	23720	AN(vv3);
174	23720	assert(vjsn_is_string(vv3));
175	23720	vim->func_name = vv3->value;
176
177	23720	vv3 = VTAILQ_NEXT(vv3, list);
178	23720	AN(vv3);
179	23720	assert(vjsn_is_string(vv3));
180	23720	vim->file_id = vv3->value;
181
182	23720	vv3 = VTAILQ_NEXT(vv3, list);
183	23720	AN(vv3);
184	23720	assert(vjsn_is_string(vv3));
185	23720	vim->abi = vv3->value;
186
187	23720	vv3 = VTAILQ_NEXT(vv3, list);
188	23720	AN(vv3);
189	23720	assert(vjsn_is_string(vv3));
190	23720	vim->major = strtoul(vv3->value, &p, 10);
191	23720	assert(p == NULL \|\| p == '\0' \|\| p == 'U');
192
193	23720	vv3 = VTAILQ_NEXT(vv3, list);
194	23720	AN(vv3);
195	23720	assert(vjsn_is_string(vv3));
196	23720	vim->minor = strtoul(vv3->value, &p, 10);
197	23720	assert(p == NULL \|\| p == '\0' \|\| p == 'U');
198
199
200	23720	if (vim->major == 0 && vim->minor == 0 &&
201	18240	strcmp(vim->abi, VMOD_ABI_Version)) {
202	40	VSB_printf(tl->sb, "Incompatible VMOD %.*s\n", PF(vim->t_mod));
203	40	VSB_printf(tl->sb, "\tFile name: %s\n", vim->path);
204	80	VSB_printf(tl->sb, "\tABI mismatch, expected <%s>, got <%s>\n",
205	40	VMOD_ABI_Version, vim->abi);
206	40	return ("");
207		}
208	29120	if (vim->major != 0 &&
209	5480	(vim->major != VRT_MAJOR_VERSION \|\|
210	5440	vim->minor > VRT_MINOR_VERSION)) {
211	40	VSB_printf(tl->sb, "Incompatible VMOD %.*s\n", PF(vim->t_mod));
212	40	VSB_printf(tl->sb, "\tFile name: %s\n", vim->path);
213	80	VSB_printf(tl->sb, "\tVMOD wants ABI version %u.%u\n",
214	40	vim->major, vim->minor);
215	40	VSB_printf(tl->sb, "\tvarnishd provides ABI version %u.%u\n",
216		VRT_MAJOR_VERSION, VRT_MINOR_VERSION);
217	40	return ("");
218		}
219
220
221	869600	VTAILQ_FOREACH(vv2, &vv->children, list) {
222	846000	assert (vjsn_is_array(vv2));
223	846000	vv3 = VTAILQ_FIRST(&vv2->children);
224	846000	assert(vjsn_is_string(vv3));
225	846000	assert(vv3->value[0] == '$');
226		#define STANZA(UU, ll, ss) \
227		if (!strcmp(vv3->value, "$" #UU)) {vim->n_##ll++; continue;}
228	846000	STANZA_TBL
229		#undef STANZA
230	40	return ("Unknown metadata stanza.");
231		}
232	23600	if (vim->n_cproto != 1)
233	40	return ("Bad cproto stanza(s)");
234	23560	if (vim->n_vmod != 1)
235	40	return ("Bad vmod stanza(s)");
236	23520	return (NULL);
237	23960	}
238
239		/*
240		* Load and check the metadata from the objectfile containing the vmod
241		*/
242
243		static int
244	23960	vcc_VmodLoad(struct vcc tl, struct vmod_import vim)
245		{
246		static const char *err;
247		struct vmod_import *vim2;
248
249	23960	CHECK_OBJ_NOTNULL(vim, VMOD_IMPORT_MAGIC);
250
251	23960	err = vcc_ParseJSON(tl, VSB_data(vim->json), vim);
252	23960	if (err != NULL && *err != '\0') {
253	720	VSB_printf(tl->sb,
254	360	"VMOD %.*s: bad metadata\n", PF(vim->t_mod));
255	360	VSB_printf(tl->sb, "\t(%s)\n", err);
256	360	VSB_printf(tl->sb, "\tFile name: %s\n", vim->path);
257	360	}
258
259	23960	if (err != NULL)
260	440	return (-1);
261
262	29360	VTAILQ_FOREACH(vim2, &imports, list) {
263	6000	if (strcmp(vim->name, vim2->name))
264	5840	continue;
265	160	if (!strcmp(vim->file_id, vim2->file_id)) {
266		// (Truly) duplicate imports are OK
267	120	return (0);
268		}
269	80	VSB_printf(tl->sb,
270		"Different version of VMOD %.*s already loaded\n",
271	40	PF(vim->t_mod));
272	40	vcc_ErrWhere(tl, vim->t_mod);
273	40	VSB_cat(tl->sb, "Previous import at:\n");
274	40	vcc_ErrWhere(tl, vim2->t_mod);
275	40	vcc_Warn(tl);
276	40	break;
277		}
278	23400	VTAILQ_INSERT_TAIL(&imports, vim, list);
279
280	23400	return (0);
281	23960	}
282
283		static void v_matchproto_(vcc_do_stanza_f)
284	5040	vcc_do_event(struct vcc tl, const struct vmod_import vim,
285		const struct vjsn_val *vv)
286		{
287		struct inifin *ifp;
288
289	5040	ifp = New_IniFin(tl);
290	10080	VSB_printf(ifp->ini,
291		"\tif (%s(ctx, &vmod_priv_%s, VCL_EVENT_LOAD))\n"
292		"\t\treturn(1);",
293	5040	vv->value, vim->sym->vmod_name);
294	10080	VSB_printf(ifp->fin,
295		"\t\t(void)%s(ctx, &vmod_priv_%s,\n"
296		"\t\t\t VCL_EVENT_DISCARD);",
297	5040	vv->value, vim->sym->vmod_name);
298	10080	VSB_printf(ifp->event, "%s(ctx, &vmod_priv_%s, ev)",
299	5040	vv->value, vim->sym->vmod_name);
300	5040	}
301
302		static void v_matchproto_(vcc_do_stanza_f)
303	23240	vcc_do_cproto(struct vcc tl, const struct vmod_import vim,
304		const struct vjsn_val *vv)
305		{
306	23240	(void)vim;
307	23240	do {
308	4550960	assert (vjsn_is_string(vv));
309	4550960	Fh(tl, 0, "%s\n", vv->value);
310	4550960	vv = VTAILQ_NEXT(vv, list);
311	4550960	} while(vv != NULL);
312	23240	}
313
314		static void
315	46480	vcc_vj_foreach(struct vcc tl, const struct vmod_import vim,
316		const char stanza, vcc_do_stanza_f func)
317		{
318		const struct vjsn_val vv, vv2, *vv3;
319
320	46480	vv = vim->vj->value;
321	46480	assert (vjsn_is_array(vv));
322	1705680	VTAILQ_FOREACH(vv2, &vv->children, list) {
323	1659200	assert (vjsn_is_array(vv2));
324	1659200	vv3 = VTAILQ_FIRST(&vv2->children);
325	1659200	assert (vjsn_is_string(vv3));
326	1659200	if (!strcmp(vv3->value, stanza))
327	28280	func(tl, vim, VTAILQ_NEXT(vv3, list));
328	1659200	}
329	46480	}
330
331		static void
332	23240	vcc_emit_setup(struct vcc tl, const struct vmod_import vim)
333		{
334		struct inifin *ifp;
335	23240	const struct token *mod = vim->t_mod;
336
337	23240	ifp = New_IniFin(tl);
338
339	23240	VSB_cat(ifp->ini, "\tif (VPI_Vmod_Init(ctx,\n");
340	23240	VSB_printf(ifp->ini, "\t &VGC_vmod_%.*s,\n", PF(mod));
341	23240	VSB_printf(ifp->ini, "\t %u,\n", tl->vmod_count++);
342	23240	VSB_printf(ifp->ini, "\t &%s,\n", vim->func_name);
343	23240	VSB_printf(ifp->ini, "\t sizeof(%s),\n", vim->func_name);
344	23240	VSB_printf(ifp->ini, "\t \"%.*s\",\n", PF(mod));
345	23240	VSB_cat(ifp->ini, "\t ");
346	23240	VSB_quote(ifp->ini, vim->path, -1, VSB_QUOTE_CSTR);
347	23240	VSB_cat(ifp->ini, ",\n");
348	23240	AN(vim->file_id);
349	23240	VSB_printf(ifp->ini, "\t \"%s\",\n", vim->file_id);
350	23240	if (vim->from_vext) {
351	40	VSB_cat(ifp->ini, "\t ");
352	40	VSB_quote(ifp->ini, vim->path, -1, VSB_QUOTE_CSTR);
353	40	VSB_cat(ifp->ini, "\n");
354	40	} else {
355	46400	VSB_printf(ifp->ini, "\t \"./vmod_cache/_vmod_%.*s.%s\"\n",
356	23200	PF(mod), vim->file_id);
357		}
358	23240	VSB_cat(ifp->ini, "\t ))\n");
359	23240	VSB_cat(ifp->ini, "\t\treturn(1);");
360
361	23240	VSB_cat(tl->symtab, ",\n {\n");
362	23240	VSB_cat(tl->symtab, "\t\"dir\": \"import\",\n");
363	23240	VSB_cat(tl->symtab, "\t\"type\": \"$VMOD\",\n");
364	23240	VSB_printf(tl->symtab, "\t\"name\": \"%.*s\",\n", PF(mod));
365	23240	if (vim->from_vext)
366	40	VSB_cat(tl->symtab, "\t\"vext\": true,\n");
367		else
368	23200	VSB_cat(tl->symtab, "\t\"vext\": false,\n");
369	23240	VSB_printf(tl->symtab, "\t\"file\": \"%s\",\n", vim->path);
370	46480	VSB_printf(tl->symtab, "\t\"dst\": \"./vmod_cache/_vmod_%.*s.%s\"\n",
371	23240	PF(mod), vim->file_id);
372	23240	VSB_cat(tl->symtab, " }");
373
374		/* XXX: zero the function pointer structure ?*/
375	46480	VSB_printf(ifp->fin, "\t\tVRT_priv_fini(ctx, &vmod_priv_%.*s);",
376	23240	PF(mod));
377	46480	VSB_printf(ifp->final, "\t\tVPI_Vmod_Unload(ctx, &VGC_vmod_%.*s);",
378	23240	PF(mod));
379
380	23240	vcc_vj_foreach(tl, vim, "$EVENT", vcc_do_event);
381
382	23240	Fh(tl, 0, "\n/* --- BEGIN VMOD %.s --- /\n\n", PF(mod));
383	23240	Fh(tl, 0, "static struct vmod VGC_vmod_%.s;\n", PF(mod));
384	23240	Fh(tl, 0, "static struct vmod_priv vmod_priv_%.*s;\n", PF(mod));
385
386	23240	vcc_vj_foreach(tl, vim, "$CPROTO", vcc_do_cproto);
387
388	23240	Fh(tl, 0, "\n/* --- END VMOD %.s --- /\n\n", PF(mod));
389	23240	}
390
391		static void
392	840	vcc_vim_destroy(struct vmod_import **vimp)
393		{
394		struct vmod_import *vim;
395
396	840	TAKE_OBJ_NOTNULL(vim, vimp, VMOD_IMPORT_MAGIC);
397	840	if (vim->path)
398	800	free(vim->path);
399	840	if (vim->vj)
400	640	vjsn_delete(&vim->vj);
401	840	if (vim->json)
402	680	VSB_destroy(&vim->json);
403	840	FREE_OBJ(vim);
404	840	}
405
406		static int
407	24040	vcc_path_open(void priv, const char fn)
408		{
409		struct vmod_import *vim;
410
411	24040	CAST_OBJ_NOTNULL(vim, priv, VMOD_IMPORT_MAGIC);
412	24040	AN(fn);
413
414	24040	return (vcc_Extract_JSON(vim, fn));
415		}
416
417		void
418	24240	vcc_ParseImport(struct vcc *tl)
419		{
420		char fn[1024];
421		const char *p;
422		struct token mod, tmod, *t1;
423		struct symbol msym, vsym;
424	24240	struct vmod_import *vim = NULL;
425		const struct vmod_import *vimold;
426
427	24240	t1 = tl->t;
428	24240	SkipToken(tl, ID); /* "import" */
429
430	24240	ExpectErr(tl, ID); /* "vmod_name" */
431	24240	mod = tl->t;
432	24240	tmod = vcc_PeekTokenFrom(tl, mod);
433	24240	AN(tmod);
434	24240	if (tmod->tok == ID && vcc_IdIs(tmod, "as")) {
435	200	vcc_NextToken(tl); /* "vmod_name" */
436	200	vcc_NextToken(tl); /* "as" */
437	200	ExpectErr(tl, ID); /* "vcl_name" */
438	200	}
439	24240	tmod = tl->t;
440
441	24240	msym = VCC_SymbolGet(tl, SYM_MAIN, SYM_VMOD, SYMTAB_CREATE, XREF_NONE);
442	24240	ERRCHK(tl);
443	24200	AN(msym);
444
445	24200	bprintf(fn, "libvmod_%.*s.so", PF(mod));
446	24200	if (tl->t->tok == ID) {
447	200	if (!vcc_IdIs(tl->t, "from")) {
448	40	VSB_cat(tl->sb, "Expected 'from path ...'\n");
449	40	vcc_ErrWhere(tl, tl->t);
450	40	return;
451		}
452	160	vcc_NextToken(tl);
453	160	if (!tl->unsafe_path && strchr(tl->t->dec, '/')) {
454	40	VSB_cat(tl->sb,
455		"'import ... from path ...' is unsafe.\nAt:");
456	40	vcc_ErrToken(tl, tl->t);
457	40	vcc_ErrWhere(tl, tl->t);
458	40	return;
459		}
460	120	ExpectErr(tl, CSTR);
461	120	p = strrchr(tl->t->dec, '/');
462	120	if (p != NULL && p[1] == '\0')
463	40	bprintf(fn, "%slibvmod_%.*s.so", tl->t->dec, PF(mod));
464		else
465	80	bprintf(fn, "%s", tl->t->dec);
466	120	vcc_NextToken(tl);
467	120	} else {
468	30080	VTAILQ_FOREACH(vim, &imports, list) {
469	6120	if (!vcc_IdIs(mod, vim->name))
470	5960	continue;
471	160	if (!vim->unimported_vext)
472	120	continue;
473	40	fprintf(stderr, "IMPORT %s from VEXT\n", vim->name);
474	40	vim->unimported_vext = 0;
475	40	vim->t_mod = mod;
476	40	vim->sym = msym;
477	40	break;
478		}
479		}
480
481	24120	SkipToken(tl, ';');
482
483	24120	if (vim == NULL) {
484	24080	ALLOC_OBJ(vim, VMOD_IMPORT_MAGIC);
485	24080	AN(vim);
486	24080	vim->t_mod = mod;
487	24080	vim->sym = msym;
488
489	24080	if (VFIL_searchpath(tl->vmod_path, vcc_path_open, vim, fn, &vim->path)) {
490	160	if (vim->err == NULL) {
491	80	VSB_printf(tl->sb,
492	40	"Could not find VMOD %.*s\n", PF(mod));
493	40	} else {
494	240	VSB_printf(tl->sb,
495	120	"Could not open VMOD %.*s\n", PF(mod));
496	240	VSB_printf(tl->sb, "\tFile name: %s\n",
497	120	vim->path != NULL ? vim->path : fn);
498	120	VSB_printf(tl->sb, "\tError: %s\n", vim->err);
499		}