varnish-cache/lib/libvcc/vcc_parse.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
 *
7
 * SPDX-License-Identifier: BSD-2-Clause
8
 *
9
 * Redistribution and use in source and binary forms, with or without
10
 * modification, are permitted provided that the following conditions
11
 * are met:
12
 * 1. Redistributions of source code must retain the above copyright
13
 *    notice, this list of conditions and the following disclaimer.
14
 * 2. Redistributions in binary form must reproduce the above copyright
15
 *    notice, this list of conditions and the following disclaimer in the
16
 *    documentation and/or other materials provided with the distribution.
17
 *
18
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21
 * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
22
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28
 * SUCH DAMAGE.
29
 */
30
31
#include "config.h"
32
33
#include <string.h>
34
35
#include "vcc_compile.h"
36
37
/*--------------------------------------------------------------------*/
38
39
static void vcc_Compound(struct vcc *tl);
40
41
/*--------------------------------------------------------------------*/
42
43
#define L(tl, foo)      do {    \
44
        tl->indent += INDENT;   \
45
        foo;                    \
46
        tl->indent -= INDENT;   \
47
} while (0)
48
49
#define C(tl, sep)      do {                                            \
50
        Fb(tl, 1, "VPI_count(ctx, VGC_NREFS, %u)%s\n", ++tl->cnt, sep); \
51
        Fb(tl, 1, "if (UNLIKELY(ctx->vpi->trace)) VPI_trace(ctx, %u)%s\n", \
52
           tl->cnt, sep);                                               \
53
        tl->t->cnt = tl->cnt;                                           \
54
} while (0)
55
56
/*--------------------------------------------------------------------
57
 * SYNTAX:
58
 *    Conditional:
59
 *      '(' Cond_0 ')'
60
 */
61
62
static void
63 43099
vcc_Conditional(struct vcc *tl)
64
{
65
66 43099
        SkipToken(tl, '(');
67 43099
        Fb(tl, 0, "(\n");
68 43099
        L(tl, vcc_Expr(tl, BOOL));
69 43099
        ERRCHK(tl);
70 43067
        Fb(tl, 1, ")\n");
71 43067
        SkipToken(tl, ')');
72 43099
}
73
74
/*--------------------------------------------------------------------
75
 * SYNTAX:
76
 *    IfStmt:
77
 *      'if' Conditional  Compound Branch1* Branch2
78
 *    Branch1:
79
 *      'elseif' Conditional Compound
80
 *    Branch2:
81
 *      'else' Compound
82
 *      null
83
 */
84
85
void v_matchproto_(sym_act_f)
86 42967
vcc_Act_If(struct vcc *tl, struct token *t, struct symbol *sym)
87
{
88
89 42967
        (void)t;
90 42967
        (void)sym;
91 42967
        Fb(tl, 1, "if ");
92 42967
        vcc_Conditional(tl);
93 42967
        ERRCHK(tl);
94 42934
        L(tl, vcc_Compound(tl));
95 42934
        ERRCHK(tl);
96 43066
        while (tl->t->tok == ID) {
97 14587
                if (vcc_IdIs(tl->t, "else")) {
98 2964
                        vcc_NextToken(tl);
99 2964
                        if (tl->t->tok == '{') {
100 2888
                                Fb(tl, 1, "else\n");
101 2888
                                L(tl, vcc_Compound(tl));
102 2888
                                ERRCHK(tl);
103 2888
                                return;
104
                        }
105 76
                        if (tl->t->tok != ID || !vcc_IdIs(tl->t, "if")) {
106 0
                                VSB_printf(tl->sb,
107
                                    "'else' must be followed by 'if' or '{'\n");
108 0
                                vcc_ErrWhere(tl, tl->t);
109 0
                                return;
110
                        }
111 76
                        Fb(tl, 1, "else if ");
112 76
                        vcc_NextToken(tl);
113 76
                        vcc_Conditional(tl);
114 76
                        ERRCHK(tl);
115 76
                        L(tl, vcc_Compound(tl));
116 76
                        ERRCHK(tl);
117 23269
                } else if (vcc_IdIs(tl->t, "elseif") ||
118 11621
                     vcc_IdIs(tl->t, "elsif") ||
119 11570
                     vcc_IdIs(tl->t, "elif")) {
120 56
                        Fb(tl, 1, "else if ");
121 56
                        vcc_NextToken(tl);
122 56
                        vcc_Conditional(tl);
123 56
                        ERRCHK(tl);
124 56
                        L(tl, vcc_Compound(tl));
125 56
                        ERRCHK(tl);
126 56
                } else {
127 11567
                        break;
128
                }
129
        }
130 40046
        C(tl, ";");
131 42967
}
132
133
/*--------------------------------------------------------------------
134
 * SYNTAX:
135
 *    Compound:
136
 *      '{' Stmt* '}'
137
 *
138
 *    Stmt:
139
 *      Compound
140
 *      IfStmt
141
 *      CSRC
142
 *      Id(Action) (XXX)
143
 */
144
145
static void
146 148976
vcc_Compound(struct vcc *tl)
147
{
148
        struct symbol *sym;
149
        struct token *t;
150
151 148976
        SkipToken(tl, '{');
152 148976
        Fb(tl, 1, "{\n");
153 148976
        tl->indent += INDENT;
154 148976
        C(tl, ";");
155 148976
        Fb(tl, 1, "END_;\n");
156 368334
        while (1) {
157 368334
                ERRCHK(tl);
158 368220
                t = tl->t;
159 368220
                switch (tl->t->tok) {
160
                case '{':
161 2
                        vcc_Compound(tl);
162 2
                        break;
163
                case '}':
164 148857
                        vcc_NextToken(tl);
165 148857
                        tl->indent -= INDENT;
166 148857
                        Fb(tl, 1, "}\n");
167 148857
                        return;
168
                case CSRC:
169 15
                        if (tl->allow_inline_c) {
170 28
                                Fb(tl, 1, "%.*s\n",
171 14
                                    (int) (tl->t->e - (tl->t->b + 2)),
172 14
                                    tl->t->b + 1);
173 14
                                vcc_NextToken(tl);
174 14
                        } else {
175 1
                                VSB_printf(tl->sb,
176
                                    "Inline-C not allowed\n");
177 1
                                vcc_ErrWhere(tl, tl->t);
178
                        }
179 15
                        break;
180
                case EOI:
181 0
                        VSB_printf(tl->sb,
182
                            "End of input while in compound statement\n");
183 0
                        tl->err = 1;
184 0
                        return;
185
                case ID:
186 219346
                        sym = VCC_SymbolGet(tl, SYM_MAIN, SYM_NONE,
187
                            SYMTAB_PARTIAL, XREF_NONE);
188 219346
                        if (sym == NULL) {
189 4
                                VSB_printf(tl->sb, "Symbol not found.\n");
190 4
                                vcc_ErrWhere(tl, tl->t);
191 4
                                return;
192
                        }
193 219342
                        if (sym->action == NULL) {
194 1
                                VSB_printf(tl->sb,
195
                                    "Symbol cannot be used here.\n");
196 1
                                vcc_ErrWhere(tl, tl->t);
197 1
                                return;
198
                        }
199 219341
                        if (sym->action_mask != 0)
200 8671
                                vcc_AddUses(tl, t, NULL, sym, XREF_ACTION);
201 219341
                        sym->action(tl, t, sym);
202 219341
                        break;
203
                default:
204
                        /* We deliberately do not mention inline C */
205 0
                        VSB_printf(tl->sb,
206
                            "Expected an action, 'if', '{' or '}'\n");
207 0
                        vcc_ErrWhere(tl, tl->t);
208 0
                        return;
209
                }
210 219358
                Fb(tl, 1, "END_;\n");
211
        }
212 148976
}
213
214
/*--------------------------------------------------------------------
215
 * SYNTAX:
216
 *    Function:
217
 *      'sub' ID(name) Compound
218
 */
219
220
static void
221 103024
vcc_ParseFunction(struct vcc *tl)
222
{
223
        struct symbol *sym, *bsym;
224
        struct token *t;
225
        struct proc *p;
226
227 103024
        vcc_NextToken(tl);
228 103024
        vcc_ExpectVid(tl, "subroutine");
229 103024
        ERRCHK(tl);
230
231 103023
        t = tl->t;
232 103023
        sym = VCC_SymbolGet(tl, SYM_MAIN, SYM_SUB, SYMTAB_CREATE, XREF_DEF);
233 103023
        ERRCHK(tl);
234 103022
        AN(sym);
235
236 103022
        if (vcc_builtin != NULL) {
237 48086
                vcc_builtin->t = t;
238 48086
                bsym = VCC_SymbolGet(vcc_builtin, SYM_MAIN, SYM_SUB,
239
                    SYMTAB_NOERR, XREF_NONE);
240 48086
                AZ(vcc_builtin->err);
241 48086
        }
242
        else
243 54936
                bsym = NULL;
244
245 103022
        p = sym->proc;
246 103022
        if (p == NULL) {
247 62007
                if (vcc_builtin != NULL && bsym == NULL &&
248 77
                    vcc_Has_vcl_prefix(t->b)) {
249 1
                        VSB_printf(tl->sb,"The names 'vcl_*'"
250
                            " are reserved for subroutines.\n");
251 1
                        vcc_ErrWhere(tl, t);
252 1
                        VSB_printf(tl->sb, "Valid vcl_* subroutines are:\n");
253 37
                        VTAILQ_FOREACH(p, &vcc_builtin->procs, list) {
254 36
                                t = p->name;
255 72
                                VSB_printf(tl->sb, "\t%.*s\n",
256 36
                                    (int)pdiff(t->b, t->e), t->b);
257 36
                        }
258 1
                        return;
259
                }
260 62006
                VCC_GlobalSymbol(sym, SUB);
261 62006
                p = vcc_NewProc(tl, sym);
262 62006
                p->name = t;
263 62006
                VSB_printf(p->cname, "%s", sym->lname);
264 103021
        } else if (p->method == NULL && bsym == NULL) {
265 1
                VSB_printf(tl->sb, "Subroutine '%s' redefined\n", sym->name);
266 1
                vcc_ErrWhere(tl, t);
267 1
                VSB_printf(tl->sb, "Previously defined here:\n");
268 1
                vcc_ErrWhere(tl, p->name);
269 1
                return;
270
        } else {
271
                /* Add to VCL sub */
272 41014
                if (p->name == NULL)
273 39532
                        p->name = t;
274
        }
275 103020
        CHECK_OBJ_NOTNULL(p, PROC_MAGIC);
276 103020
        tl->fb = p->body;
277 103020
        Fb(tl, 1, "  /* ... from ");
278 103020
        vcc_Coord(tl, p->body, NULL);
279 103020
        Fb(tl, 0, " */\n");
280 103020
        tl->curproc = p;
281 103020
        tl->indent += INDENT;
282 103020
        Fb(tl, 1, "{\n");
283 103020
        L(tl, vcc_Compound(tl));
284 103020
        Fb(tl, 1, "}\n");
285 103020
        tl->indent -= INDENT;
286 103020
        tl->fb = NULL;
287 103020
        tl->curproc = NULL;
288 103024
}
289
290
/*--------------------------------------------------------------------
291
 */
292
293
static void
294 4311
vcc_ParseVcl(struct vcc *tl)
295
{
296
        struct token *tok0;
297
        int syntax;
298
299 4311
        assert(vcc_IdIs(tl->t, "vcl"));
300 4311
        tok0 = tl->t;
301 4311
        vcc_NextToken(tl);
302
303 4311
        Expect(tl, FNUM);
304 4311
        if (tl->t->e - tl->t->b != 3 || tl->t->b[1] != '.') {
305 3
                VSB_cat(tl->sb,
306
                    "Don't play silly buggers with VCL version numbers\n");
307 3
                vcc_ErrWhere(tl, tl->t);
308 3
                ERRCHK(tl);
309 0
        }
310 4308
        syntax = (tl->t->b[0] - '0') * 10 + (tl->t->b[2] - '0');
311 4308
        vcc_NextToken(tl);
312
313 4308
        if (syntax < VCL_LOW || syntax > VCL_HIGH) {
314 4
                VSB_printf(tl->sb, "VCL version %.1f not supported.\n",
315 2
                    .1 * syntax);
316 2
                vcc_ErrWhere2(tl, tok0, tl->t);
317 2
                ERRCHK(tl);
318 0
        }
319
320 4306
        if (tl->t->tok != ';') {
321
                /* Special handling, because next token might be 'vcl'
322
                 * in the built-in VCL, and that would give a very
323
                 * confusing error message
324
                 */
325 1
                VSB_cat(tl->sb, "Expected 'vcl N.N;' found no semi-colon\n");
326 1
                vcc_ErrWhere2(tl, tok0, tl->t);
327 1
                ERRCHK(tl);
328 0
        }
329 4305
        vcc_NextToken(tl);
330 4305
        if (tl->syntax == 0)
331 3013
                tl->syntax = syntax;
332 4305
        if (syntax > tl->syntax) {
333 0
                VSB_printf(tl->sb,
334
                    "VCL version %.1f higher than"
335
                    " the top level version %.1f\n",
336 0
                    .1 * syntax, .1 * tl->syntax);
337 0
                vcc_ErrWhere2(tl, tok0, tl->t);
338 0
                ERRCHK(tl);
339 0
        }
340 4311
}
341
342
/*--------------------------------------------------------------------
343
 * Top level of parser, recognize:
344
 *      Inline C-code
345
 *      ACL definitions
346
 *      Function definitions
347
 *      Backend definitions
348
 *      VMOD import directives
349
 *      VCL version declarations
350
 *      End of input
351
 */
352
353
typedef void parse_f(struct vcc *tl);
354
355
static struct toplev {
356
        const char      *name;
357
        parse_f         *func;
358
        unsigned        vcllo;
359
        unsigned        vclhi;
360
} toplev[] = {
361
        { "acl",                vcc_ParseAcl,           VCL_41, VCL_HIGH },
362
        { "sub",                vcc_ParseFunction,      VCL_41, VCL_HIGH },
363
        { "backend",            vcc_ParseBackend,       VCL_41, VCL_HIGH },
364
        { "probe",              vcc_ParseProbe,         VCL_41, VCL_HIGH },
365
        { "import",             vcc_ParseImport,        VCL_41, VCL_HIGH },
366
        { "vcl",                vcc_ParseVcl,           VCL_41, VCL_HIGH },
367
        { NULL, NULL }
368
};
369
370
void
371 3018
vcc_Parse(struct vcc *tl)
372
{
373
        struct toplev *tp;
374
375 3018
        AZ(tl->indent);
376 3018
        if (tl->t->tok != ID || !vcc_IdIs(tl->t, "vcl")) {
377 1
                VSB_cat(tl->sb,
378
                    "VCL version declaration missing\n"
379
                    "Update your VCL to Version 4 syntax, and add\n"
380
                    "\tvcl 4.1;\n"
381
                    "on the first line of the VCL files.\n"
382
                );
383 1
                vcc_ErrWhere(tl, tl->t);
384 1
                ERRCHK(tl);
385 0
        }
386 3017
        vcc_ParseVcl(tl);
387 3017
        ERRCHK(tl);
388 3013
        AN(tl->syntax);
389 109659
        while (tl->t->tok != EOI) {
390 106844
                ERRCHK(tl);
391 106648
                switch (tl->t->tok) {
392
                case CSRC:
393 9
                        if (tl->allow_inline_c) {
394 16
                                Fc(tl, 0, "%.*s\n",
395 8
                                    (int) (tl->t->e - (tl->t->b + 4)),
396 8
                                    tl->t->b + 2);
397 8
                                vcc_NextToken(tl);
398 8
                        } else {
399 1
                                VSB_cat(tl->sb, "Inline-C not allowed\n");
400 1
                                vcc_ErrWhere(tl, tl->t);
401
                        }
402 9
                        break;
403
                case EOI:
404 0
                        break;
405
                case ID:
406 221900
                        for (tp = toplev; tp->name != NULL; tp++) {
407 221899
                                if (tp->func == NULL)
408 0
                                        continue;
409 221899
                                if (!vcc_IdIs(tl->t, tp->name))
410 115262
                                        continue;
411 106637
                                tp->func(tl);
412 106637
                                break;
413
                        }
414 106638
                        if (tp->name != NULL)
415 106637
                                break;
416
                        /* FALLTHROUGH */
417
                default:
418
                        /* We deliberately do not mention inline-C */
419 2
                        VSB_cat(tl->sb, "Expected one of\n\t");
420 14
                        for (tp = toplev; tp->name != NULL; tp++) {
421 12
                                if (tp[1].name == NULL)
422 2
                                        VSB_cat(tl->sb, " or ");
423 12
                                VSB_printf(tl->sb, "'%s'", tp->name);
424 12
                                if (tp[1].name != NULL)
425 10
                                        VSB_cat(tl->sb, ", ");
426 12
                        }
427 2
                        VSB_cat(tl->sb, "\nFound: ");
428 2
                        vcc_ErrToken(tl, tl->t);
429 2
                        VSB_cat(tl->sb, " at\n");
430 2
                        vcc_ErrWhere(tl, tl->t);
431 2
                        return;
432
                }
433
        }
434 2815
        AZ(tl->indent);
435 3018
}
436
437
void
438 3051
vcc_Parse_Init(struct vcc *tl)
439
{
440
        struct toplev *tp;
441
442 21357
        for (tp = toplev; tp->name != NULL; tp++)
443 18306
                AN(VCC_MkSym(tl, tp->name, SYM_MAIN, SYM_RESERVED,
444
                    tp->vcllo, tp->vclhi));
445 3051
}