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 550847
vcc_Conditional(struct vcc *tl)
64
{
65
66 550847
        SkipToken(tl, '(');
67 550847
        Fb(tl, 0, "(\n");
68 550847
        L(tl, vcc_Expr(tl, BOOL));
69 550847
        ERRCHK(tl);
70 550495
        Fb(tl, 1, ")\n");
71 550495
        SkipToken(tl, ')');
72 550847
}
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 549362
vcc_Act_If(struct vcc *tl, struct token *t, struct symbol *sym)
87
{
88
89 549362
        (void)t;
90 549362
        (void)sym;
91 549362
        Fb(tl, 1, "if ");
92 549362
        vcc_Conditional(tl);
93 549362
        ERRCHK(tl);
94 548999
        L(tl, vcc_Compound(tl));
95 548999
        ERRCHK(tl);
96 550484
        while (tl->t->tok == ID) {
97 133122
                if (vcc_IdIs(tl->t, "else")) {
98 33506
                        vcc_NextToken(tl);
99 33506
                        if (tl->t->tok == '{') {
100 32637
                                Fb(tl, 1, "else\n");
101 32637
                                L(tl, vcc_Compound(tl));
102 32637
                                ERRCHK(tl);
103 32637
                                return;
104
                        }
105 869
                        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 869
                        Fb(tl, 1, "else if ");
112 869
                        vcc_NextToken(tl);
113 869
                        vcc_Conditional(tl);
114 869
                        ERRCHK(tl);
115 869
                        L(tl, vcc_Compound(tl));
116 869
                        ERRCHK(tl);
117 199518
                } else if (vcc_IdIs(tl->t, "elseif") ||
118 99594
                     vcc_IdIs(tl->t, "elsif") ||
119 99033
                     vcc_IdIs(tl->t, "elif")) {
120 616
                        Fb(tl, 1, "else if ");
121 616
                        vcc_NextToken(tl);
122 616
                        vcc_Conditional(tl);
123 616
                        ERRCHK(tl);
124 616
                        L(tl, vcc_Compound(tl));
125 616
                        ERRCHK(tl);
126 616
                } else {
127 99000
                        break;
128
                }
129
        }
130 516362
        C(tl, ";");
131 549362
}
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 1906718
vcc_Compound(struct vcc *tl)
147
{
148
        struct symbol *sym;
149
        struct token *t;
150
151 1906718
        SkipToken(tl, '{');
152 1906718
        Fb(tl, 1, "{\n");
153 1906718
        tl->indent += INDENT;
154 1906718
        C(tl, ";");
155 1906718
        Fb(tl, 1, "END_;\n");
156 4704183
        while (1) {
157 4704183
                ERRCHK(tl);
158 4702929
                t = tl->t;
159 4702929
                switch (tl->t->tok) {
160
                case '{':
161 22
                        vcc_Compound(tl);
162 22
                        break;
163
                case '}':
164 1905409
                        vcc_NextToken(tl);
165 1905409
                        tl->indent -= INDENT;
166 1905409
                        Fb(tl, 1, "}\n");
167 1905409
                        return;
168
                case CSRC:
169 165
                        if (tl->allow_inline_c) {
170 308
                                Fb(tl, 1, "%.*s\n",
171 154
                                    (int) (tl->t->e - (tl->t->b + 2)),
172 154
                                    tl->t->b + 1);
173 154
                                vcc_NextToken(tl);
174 154
                        } else {
175 11
                                VSB_printf(tl->sb,
176
                                    "Inline-C not allowed\n");
177 11
                                vcc_ErrWhere(tl, tl->t);
178
                        }
179 165
                        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 2797333
                        sym = VCC_SymbolGet(tl, SYM_MAIN, SYM_NONE,
187
                            SYMTAB_PARTIAL, XREF_NONE);
188 2797333
                        if (sym == NULL) {
189 44
                                VSB_printf(tl->sb, "Symbol not found.\n");
190 44
                                vcc_ErrWhere(tl, t);
191 44
                                return;
192
                        }
193 2797289
                        if (sym->action == NULL) {
194 11
                                VSB_printf(tl->sb,
195
                                    "Symbol cannot be used here.\n");
196 11
                                vcc_ErrWhere(tl, t);
197 11
                                return;
198
                        }
199 2797278
                        if (sym->action_mask != 0)
200 97944
                                vcc_AddUses(tl, t, NULL, sym, XREF_ACTION);
201 2797278
                        sym->action(tl, t, sym);
202 2797278
                        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 2797465
                Fb(tl, 1, "END_;\n");
211
        }
212 1906718
}
213
214
/*--------------------------------------------------------------------
215
 */
216
217
static void
218 88
vcc_ParseUnused(struct vcc *tl)
219
{
220
        struct symbol *sym;
221
        struct token *t;
222
        struct inifin *ifp;
223
224 88
        vcc_NextToken(tl);
225 88
        ExpectErr(tl, ID);
226 77
        t = tl->t;
227 77
        sym = VCC_SymbolGet(tl, SYM_MAIN, SYM_NONE, SYMTAB_EXISTING, XREF_REF);
228 77
        ERRCHK(tl);
229 66
        AN(sym);
230 99
        if (sym->kind != SYM_BACKEND && sym->kind != SYM_PROBE &&
231 44
            sym->kind != SYM_ACL && sym->kind != SYM_SUB) {
232 22
                vcc_ErrWhere2(tl, t, tl->t);
233 44
                VSB_printf(tl->sb, "Symbol '%s' cannot follow 'unused'.\n",
234 22
                    sym->name);
235 22
                return;
236
        }
237 44
        AN(sym->rname);
238 44
        ifp = New_IniFin(tl);
239 44
        VSB_printf(ifp->ini, "\t(void)%s;\n", sym->rname);
240 44
        ifp->ignore_errors = 1;
241 44
        SkipToken(tl, ';');
242 88
}
243
244
/*--------------------------------------------------------------------
245
 * SYNTAX:
246
 *    Function:
247
 *      'sub' ID(name) Compound
248
 */
249
250
static void
251 1323619
vcc_ParseFunction(struct vcc *tl)
252
{
253
        struct symbol *sym, *bsym;
254
        struct token *t;
255
        struct proc *p;
256
257 1323619
        vcc_NextToken(tl);
258 1323619
        vcc_ExpectVid(tl, "subroutine");
259 1323619
        ERRCHK(tl);
260
261 1323608
        t = tl->t;
262 1323608
        sym = VCC_SymbolGet(tl, SYM_MAIN, SYM_SUB, SYMTAB_CREATE, XREF_DEF);
263 1323608
        ERRCHK(tl);
264 1323597
        AN(sym);
265
266 1323597
        if (vcc_builtin != NULL) {
267 616429
                vcc_builtin->t = t;
268 616429
                bsym = VCC_SymbolGet(vcc_builtin, SYM_MAIN, SYM_SUB,
269
                    SYMTAB_NOERR, XREF_NONE);
270 616429
                AZ(vcc_builtin->err);
271 616429
        }
272
        else
273 707168
                bsym = NULL;
274
275 1323597
        p = sym->proc;
276 1323597
        if (p == NULL) {
277 828014
                if (vcc_builtin != NULL && bsym == NULL &&
278 902
                    vcc_Has_vcl_prefix(t->b)) {
279 11
                        VSB_printf(tl->sb,"The names 'vcl_*'"
280
                            " are reserved for subroutines.\n");
281 11
                        vcc_ErrWhere(tl, t);
282 11
                        VSB_printf(tl->sb, "Valid vcl_* subroutines are:\n");
283 462
                        VTAILQ_FOREACH(p, &vcc_builtin->procs, list) {
284 451
                                t = p->name;
285 902
                                VSB_printf(tl->sb, "\t%.*s\n",
286 451
                                    (int)pdiff(t->b, t->e), t->b);
287 451
                        }
288 11
                        return;
289
                }
290 828003
                VCC_GlobalSymbol(sym, SUB);
291 828003
                p = vcc_NewProc(tl, sym);
292 828003
                p->name = t;
293 828003
                VSB_printf(p->cname, "%s", sym->lname);
294 1323586
        } else if (p->method == NULL && bsym == NULL) {
295 11
                VSB_printf(tl->sb, "Subroutine '%s' redefined\n", sym->name);
296 11
                vcc_ErrWhere(tl, t);
297 11
                VSB_printf(tl->sb, "Previously defined here:\n");
298 11
                vcc_ErrWhere(tl, p->name);
299 11
                return;
300
        } else {
301
                /* Add to VCL sub */
302 495572
                if (p->name == NULL)
303 478522
                        p->name = t;
304
        }
305 1323575
        CHECK_OBJ_NOTNULL(p, PROC_MAGIC);
306 1323575
        tl->fb = p->body;
307 1323575
        Fb(tl, 1, "  /* ... from ");
308 1323575
        vcc_Coord(tl, p->body, NULL);
309 1323575
        Fb(tl, 0, " */\n");
310 1323575
        tl->curproc = p;
311 1323575
        tl->indent += INDENT;
312 1323575
        Fb(tl, 1, "{\n");
313 1323575
        L(tl, vcc_Compound(tl));
314 1323575
        Fb(tl, 1, "}\n");
315 1323575
        tl->indent -= INDENT;
316 1323575
        tl->fb = NULL;
317 1323575
        tl->curproc = NULL;
318 1323619
}
319
320
/*--------------------------------------------------------------------
321
 */
322
323
static void
324 48730
vcc_ParseVcl(struct vcc *tl)
325
{
326
        struct token *tok0;
327
        int syntax;
328
329 48730
        assert(vcc_IdIs(tl->t, "vcl"));
330 48730
        tok0 = tl->t;
331 48730
        vcc_NextToken(tl);
332
333 48730
        Expect(tl, FNUM);
334 48730
        if (tl->t->e - tl->t->b != 3 || tl->t->b[1] != '.') {
335 33
                VSB_cat(tl->sb,
336
                    "Don't play silly buggers with VCL version numbers\n");
337 33
                vcc_ErrWhere(tl, tl->t);
338 33
                ERRCHK(tl);
339 0
        }
340 48697
        syntax = (tl->t->b[0] - '0') * 10 + (tl->t->b[2] - '0');
341 48697
        vcc_NextToken(tl);
342
343 48697
        if (syntax < VCL_LOW || syntax > VCL_HIGH) {
344 44
                VSB_printf(tl->sb, "VCL version %.1f not supported.\n",
345 22
                    .1 * syntax);
346 22
                vcc_ErrWhere2(tl, tok0, tl->t);
347 22
                ERRCHK(tl);
348 0
        }
349
350 48675
        if (tl->t->tok != ';') {
351
                /* Special handling, because next token might be 'vcl'
352
                 * in the built-in VCL, and that would give a very
353
                 * confusing error message
354
                 */
355 11
                VSB_cat(tl->sb, "Expected 'vcl N.N;' found no semi-colon\n");
356 11
                vcc_ErrWhere2(tl, tok0, tl->t);
357 11
                ERRCHK(tl);
358 0
        }
359 48664
        vcc_NextToken(tl);
360 48664
        if (tl->syntax == 0)
361 34056
                tl->syntax = syntax;
362 48664
        if (syntax > tl->syntax) {
363 0
                VSB_printf(tl->sb,
364
                    "VCL version %.1f higher than"
365
                    " the top level version %.1f\n",
366 0
                    .1 * syntax, .1 * tl->syntax);
367 0
                vcc_ErrWhere2(tl, tok0, tl->t);
368 0
                ERRCHK(tl);
369 0
        }
370 48730
}
371
372
/*--------------------------------------------------------------------
373
 * Top level of parser, recognize:
374
 *      Inline C-code
375
 *      ACL definitions
376
 *      Function definitions
377
 *      Backend definitions
378
 *      VMOD import directives
379
 *      VCL version declarations
380
 *      Unused symbols declarations
381
 *      End of input
382
 */
383
384
typedef void parse_f(struct vcc *tl);
385
386
static struct toplev {
387
        const char      *name;
388
        parse_f         *func;
389
        unsigned        vcllo;
390
        unsigned        vclhi;
391
} toplev[] = {
392
        { "acl",                vcc_ParseAcl,           VCL_41, VCL_HIGH },
393
        { "sub",                vcc_ParseFunction,      VCL_41, VCL_HIGH },
394
        { "backend",            vcc_ParseBackend,       VCL_41, VCL_HIGH },
395
        { "probe",              vcc_ParseProbe,         VCL_41, VCL_HIGH },
396
        { "import",             vcc_ParseImport,        VCL_41, VCL_HIGH },
397
        { "vcl",                vcc_ParseVcl,           VCL_41, VCL_HIGH },
398
        { "unused",             vcc_ParseUnused,        VCL_41, VCL_HIGH},
399
        { NULL, NULL }
400
};
401
402
void
403 34111
vcc_Parse(struct vcc *tl)
404
{
405
        struct toplev *tp;
406
407 34111
        AZ(tl->indent);
408 34111
        if (tl->t->tok != ID || !vcc_IdIs(tl->t, "vcl")) {
409 11
                VSB_cat(tl->sb,
410
                    "VCL version declaration missing\n"
411
                    "Update your VCL to Version 4 syntax, and add\n"
412
                    "\tvcl 4.1;\n"
413
                    "on the first line of the VCL files.\n"
414
                );
415 11
                vcc_ErrWhere(tl, tl->t);
416 11
                ERRCHK(tl);
417 0
        }
418 34100
        vcc_ParseVcl(tl);
419 34100
        ERRCHK(tl);
420 34056
        AN(tl->syntax);
421 1398672
        while (tl->t->tok != EOI) {
422 1366860
                ERRCHK(tl);
423 1364638
                switch (tl->t->tok) {
424
                case CSRC:
425 99
                        if (tl->allow_inline_c) {
426 176
                                Fc(tl, 0, "%.*s\n",
427 88
                                    (int) (tl->t->e - (tl->t->b + 4)),
428 88
                                    tl->t->b + 2);
429 88
                                vcc_NextToken(tl);
430 88
                        } else {
431 11
                                VSB_cat(tl->sb, "Inline-C not allowed\n");
432 11
                                vcc_ErrWhere(tl, tl->t);
433
                        }
434 99
                        break;
435
                case EOI:
436 0
                        break;
437
                case ID:
438 2826857
                        for (tp = toplev; tp->name != NULL; tp++) {
439 2826846
                                if (tp->func == NULL)
440 0
                                        continue;
441 2826846
                                if (!vcc_IdIs(tl->t, tp->name))
442 1462329
                                        continue;
443 1364517
                                tp->func(tl);
444 1364517
                                break;
445
                        }
446 1364528
                        if (tp->name != NULL)
447 1364517
                                break;
448
                        /* FALLTHROUGH */
449
                default:
450
                        /* We deliberately do not mention inline-C */
451 22
                        VSB_cat(tl->sb, "Expected one of\n\t");
452 176
                        for (tp = toplev; tp->name != NULL; tp++) {
453 154
                                if (tp[1].name == NULL)
454 22
                                        VSB_cat(tl->sb, " or ");
455 154
                                VSB_printf(tl->sb, "'%s'", tp->name);
456 154
                                if (tp[1].name != NULL)
457 132
                                        VSB_cat(tl->sb, ", ");
458 154
                        }
459 22
                        VSB_cat(tl->sb, "\nFound: ");
460 22
                        vcc_ErrToken(tl, tl->t);
461 22
                        VSB_cat(tl->sb, " at\n");
462 22
                        vcc_ErrWhere(tl, tl->t);
463 22
                        return;
464
                }
465
        }
466 31812
        AZ(tl->indent);
467 34111
}
468
469
void
470 34485
vcc_Parse_Init(struct vcc *tl)
471
{
472
        struct toplev *tp;
473
474 275880
        for (tp = toplev; tp->name != NULL; tp++)
475 241395
                AN(VCC_MkSym(tl, tp->name, SYM_MAIN, SYM_RESERVED,
476
                    tp->vcllo, tp->vclhi));
477 34485
}