cf-lex.l 17.6 KB
Newer Older
Martin Mareš's avatar
Martin Mareš committed
1 2 3
/*
 *	BIRD -- Configuration Lexer
 *
4
 *	(c) 1998--2000 Martin Mares <mj@ucw.cz>
Martin Mareš's avatar
Martin Mareš committed
5 6 7 8
 *
 *	Can be freely distributed and used under the terms of the GNU GPL.
 */

Martin Mareš's avatar
Martin Mareš committed
9
/**
10
 * DOC: Lexical analyzer
Martin Mareš's avatar
Martin Mareš committed
11
 *
12
 * The lexical analyzer used for configuration files and CLI commands
Martin Mareš's avatar
Martin Mareš committed
13
 * is generated using the |flex| tool accompanied by a couple of
Martin Mareš's avatar
Martin Mareš committed
14 15 16 17
 * functions maintaining the hash tables containing information about
 * symbols and keywords.
 *
 * Each symbol is represented by a &symbol structure containing name
18 19 20 21
 * of the symbol, its lexical scope, symbol class (%SYM_PROTO for a
 * name of a protocol, %SYM_CONSTANT for a constant etc.) and class
 * dependent data.  When an unknown symbol is encountered, it's
 * automatically added to the symbol table with class %SYM_VOID.
Martin Mareš's avatar
Martin Mareš committed
22 23 24 25 26
 *
 * The keyword tables are generated from the grammar templates
 * using the |gen_keywords.m4| script.
 */

Martin Mareš's avatar
Martin Mareš committed
27
%{
28
#undef REJECT     /* Avoid name clashes */
Martin Mareš's avatar
Martin Mareš committed
29 30 31

#include <errno.h>
#include <stdlib.h>
32
#include <stdarg.h>
33
#include <stdint.h>
34
#include <unistd.h>
35 36 37 38 39 40
#include <libgen.h>
#include <glob.h>
#include <fcntl.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <sys/stat.h>
Martin Mareš's avatar
Martin Mareš committed
41

42 43
#define PARSER 1

Martin Mareš's avatar
Martin Mareš committed
44
#include "nest/bird.h"
Martin Mareš's avatar
Martin Mareš committed
45
#include "nest/route.h"
46
#include "nest/protocol.h"
Martin Mareš's avatar
Martin Mareš committed
47
#include "filter/filter.h"
Martin Mareš's avatar
Martin Mareš committed
48 49
#include "conf/conf.h"
#include "conf/cf-parse.tab.h"
50
#include "lib/string.h"
Martin Mareš's avatar
Martin Mareš committed
51

52
struct keyword {
Martin Mareš's avatar
Martin Mareš committed
53 54 55
  byte *name;
  int value;
  struct keyword *next;
56 57
};

58
#include "conf/keywords.h"
Martin Mareš's avatar
Martin Mareš committed
59 60

#define KW_HASH_SIZE 64
61 62 63
static struct keyword *kw_hash[KW_HASH_SIZE];
static int kw_hash_inited;

Martin Mareš's avatar
Martin Mareš committed
64 65
#define SYM_HASH_SIZE 128

Martin Mareš's avatar
Martin Mareš committed
66 67 68 69 70 71 72
struct sym_scope {
  struct sym_scope *next;		/* Next on scope stack */
  struct symbol *name;			/* Name of this scope */
  int active;				/* Currently entered */
};
static struct sym_scope *conf_this_scope;

Martin Mareš's avatar
Martin Mareš committed
73
static int cf_hash(byte *c);
74
static inline struct symbol * cf_get_sym(byte *c, uint h0);
Martin Mareš's avatar
Martin Mareš committed
75

76
linpool *cfg_mem;
Martin Mareš's avatar
Martin Mareš committed
77

78
int (*cf_read_hook)(byte *buf, unsigned int max, int fd);
Ondřej Zajíček's avatar
Ondřej Zajíček committed
79
struct include_file_stack *ifs;
80 81 82
static struct include_file_stack *ifs_head;

#define MAX_INCLUDE_DEPTH 8
Martin Mareš's avatar
Martin Mareš committed
83

84
#define YY_INPUT(buf,result,max) result = cf_read_hook(buf, max, ifs->fd);
Martin Mareš's avatar
Martin Mareš committed
85 86 87
#define YY_NO_UNPUT
#define YY_FATAL_ERROR(msg) cf_error(msg)

88
static void cf_include(char *arg, int alen);
89 90
static int check_eof(void);

Martin Mareš's avatar
Martin Mareš committed
91 92 93
%}

%option noyywrap
94 95 96
%option noinput
%option nounput
%option noreject
Martin Mareš's avatar
Martin Mareš committed
97

98
%x COMMENT CCOMM CLI
Martin Mareš's avatar
Martin Mareš committed
99 100 101 102 103 104

ALPHA [a-zA-Z_]
DIGIT [0-9]
XIGIT [0-9a-fA-F]
ALNUM [a-zA-Z_0-9]
WHITE [ \t]
105
include   ^{WHITE}*include{WHITE}*\".*\"{WHITE}*;
Martin Mareš's avatar
Martin Mareš committed
106 107

%%
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
{include} {
  char *start, *end;

  if (!ifs->depth)
    cf_error("Include not allowed in CLI");

  start = strchr(yytext, '"');
  start++;

  end = strchr(start, '"');
  *end = 0;

  if (start == end)
    cf_error("Include with empty argument");

  cf_include(start, end-start);
}
Martin Mareš's avatar
Martin Mareš committed
125

126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
{DIGIT}+:{DIGIT}+ {
  unsigned long int l, len1, len2;
  char *e;

  errno = 0;
  l = strtoul(yytext, &e, 10);
  if (e && (*e != ':') || (errno == ERANGE) || (l >> 32))
    cf_error("ASN out of range");

  if (l >> 16)
  {
    len1 = 32;
    len2 = 16;
    cf_lval.i64 = (2ULL << 48) | (((u64) l) << len2);
  }
  else
  {
    len1 = 16;
    len2 = 32;
    cf_lval.i64 = 0 | (((u64) l) << len2);
  }

  errno = 0;
  l = strtoul(e+1, &e, 10);
  if (e && *e || (errno == ERANGE) || (l >> len2))
    cf_error("Number out of range");
  cf_lval.i64 |= l;

  return VPN_RD;
}

157
[02]:{DIGIT}+:{DIGIT}+ {
Ondřej Zajíček's avatar
Ondřej Zajíček committed
158
  unsigned long int l, len1, len2;
159 160 161
  char *e;

  if (yytext[0] == '0')
Ondřej Zajíček's avatar
Ondřej Zajíček committed
162
  {
163
    cf_lval.i64 = 0;
Ondřej Zajíček's avatar
Ondřej Zajíček committed
164 165 166
    len1 = 16;
    len2 = 32;
  }
167
  else
Ondřej Zajíček's avatar
Ondřej Zajíček committed
168 169 170 171 172
  {
    cf_lval.i64 = 2ULL << 48;
    len1 = 32;
    len2 = 16;
  }
173 174 175

  errno = 0;
  l = strtoul(yytext+2, &e, 10);
Ondřej Zajíček's avatar
Ondřej Zajíček committed
176
  if (e && (*e != ':') || (errno == ERANGE) || (l >> len1))
177
    cf_error("ASN out of range");
Ondřej Zajíček's avatar
Ondřej Zajíček committed
178 179
  cf_lval.i64 |= ((u64) l) << len2;

180 181
  errno = 0;
  l = strtoul(e+1, &e, 10);
Ondřej Zajíček's avatar
Ondřej Zajíček committed
182 183
  if (e && *e || (errno == ERANGE) || (l >> len2))
    cf_error("Number out of range");
184
  cf_lval.i64 |= l;
Ondřej Zajíček's avatar
Ondřej Zajíček committed
185

186 187 188
  return VPN_RD;
}

189
{DIGIT}+\.{DIGIT}+\.{DIGIT}+\.{DIGIT}+:{DIGIT}+ {
190 191
  unsigned long int l;
  ip4_addr ip4;
Ondřej Zajíček's avatar
Ondřej Zajíček committed
192 193 194 195
  char *e;

  cf_lval.i64 = 1ULL << 48;

196
  e = strchr(yytext, ':');
Ondřej Zajíček's avatar
Ondřej Zajíček committed
197
  *e++ = '\0';
198 199
  if (!ip4_pton(yytext, &ip4))
    cf_error("Invalid IPv4 address %s in Route Distinguisher", yytext);
Ondřej Zajíček's avatar
Ondřej Zajíček committed
200 201
  cf_lval.i64 |= ((u64) ip4_to_u32(ip4)) << 16;

202 203
  errno = 0;
  l = strtoul(e, &e, 10);
Ondřej Zajíček's avatar
Ondřej Zajíček committed
204 205 206 207
  if (e && *e || (errno == ERANGE) || (l >> 16))
    cf_error("Number out of range");
  cf_lval.i64 |= l;

208 209 210
  return VPN_RD;
}

Martin Mareš's avatar
Martin Mareš committed
211
{DIGIT}+\.{DIGIT}+\.{DIGIT}+\.{DIGIT}+ {
212
  if (!ip4_pton(yytext, &cf_lval.ip4))
213
    cf_error("Invalid IPv4 address %s", yytext);
214
  return IP4;
215 216 217
}

({XIGIT}*::|({XIGIT}*:){3,})({XIGIT}*|{DIGIT}+\.{DIGIT}+\.{DIGIT}+\.{DIGIT}+) {
218 219 220
  if (!ip6_pton(yytext, &cf_lval.ip6))
    cf_error("Invalid IPv6 address %s", yytext);
  return IP6;
Martin Mareš's avatar
Martin Mareš committed
221 222
}

223
0x{XIGIT}+ {
Martin Mareš's avatar
Martin Mareš committed
224
  char *e;
225
  unsigned long int l;
Martin Mareš's avatar
Martin Mareš committed
226 227
  errno = 0;
  l = strtoul(yytext+2, &e, 16);
228
  if (e && *e || errno == ERANGE || (unsigned long int)(unsigned int) l != l)
Martin Mareš's avatar
Martin Mareš committed
229 230 231 232 233 234 235
    cf_error("Number out of range");
  cf_lval.i = l;
  return NUM;
}

{DIGIT}+ {
  char *e;
236
  unsigned long int l;
Martin Mareš's avatar
Martin Mareš committed
237 238
  errno = 0;
  l = strtoul(yytext, &e, 10);
239
  if (e && *e || errno == ERANGE || (unsigned long int)(unsigned int) l != l)
Martin Mareš's avatar
Martin Mareš committed
240 241 242 243 244
    cf_error("Number out of range");
  cf_lval.i = l;
  return NUM;
}

245 246 247 248 249
else: {
  /* Hack to distinguish if..else from else: in case */
  return ELSECOL;
}

250
({ALPHA}{ALNUM}*|[']({ALNUM}|[-]|[\.]|[:])*[']) {
251 252 253 254
  if(*yytext == '\'') {
    yytext[yyleng-1] = 0;
    yytext++;
  }
Martin Mareš's avatar
Martin Mareš committed
255 256 257 258 259
  unsigned int h = cf_hash(yytext);
  struct keyword *k = kw_hash[h & (KW_HASH_SIZE-1)];
  while (k)
    {
      if (!strcmp(k->name, yytext))
Martin Mareš's avatar
Martin Mareš committed
260 261 262 263 264 265 266 267 268
	{
	  if (k->value > 0)
	    return k->value;
	  else
	    {
	      cf_lval.i = -k->value;
	      return ENUM;
	    }
	}
Martin Mareš's avatar
Martin Mareš committed
269 270
      k=k->next;
    }
271
  cf_lval.s = cf_get_sym(yytext, h);
Martin Mareš's avatar
Martin Mareš committed
272 273 274
  return SYM;
}

275
<CLI>(.|\n) {
276 277 278 279
  BEGIN(INITIAL);
  return CLI_MARKER;
}

280 281 282 283
\.\. {
  return DDOT;
}

284
[={}:;,.()+*/%<>~\[\]?!\|-] {
Martin Mareš's avatar
Martin Mareš committed
285 286 287 288
  return yytext[0];
}

["][^"\n]*["] {
289
  yytext[yyleng-1] = 0;
290
  cf_lval.t = cfg_strdup(yytext+1);
291
  yytext[yyleng-1] = '"';
Martin Mareš's avatar
Martin Mareš committed
292 293 294 295 296
  return TEXT;
}

["][^"\n]*\n	cf_error("Unterminated string");

297
<INITIAL,COMMENT><<EOF>>	{ if (check_eof()) return END; }
Martin Mareš's avatar
Martin Mareš committed
298 299 300

{WHITE}+

301
\n	ifs->lino++;
Martin Mareš's avatar
Martin Mareš committed
302

303
#	BEGIN(COMMENT);
Martin Mareš's avatar
Martin Mareš committed
304

305
\/\*	BEGIN(CCOMM);
Martin Mareš's avatar
Martin Mareš committed
306 307 308 309

.	cf_error("Unknown character");

<COMMENT>\n {
310
  ifs->lino++;
Martin Mareš's avatar
Martin Mareš committed
311 312 313 314 315 316
  BEGIN(INITIAL);
}

<COMMENT>.

<CCOMM>\*\/	BEGIN(INITIAL);
317
<CCOMM>\n	ifs->lino++;
Martin Mareš's avatar
Martin Mareš committed
318 319 320 321
<CCOMM>\/\*	cf_error("Comment nesting not supported");
<CCOMM><<EOF>>	cf_error("Unterminated comment");
<CCOMM>.

Pavel Machek's avatar
Pavel Machek committed
322
\!\= return NEQ;
323
\!\~ return NMA;
Pavel Machek's avatar
Pavel Machek committed
324 325
\<\= return LEQ;
\>\= return GEQ;
Pavel Machek's avatar
Pavel Machek committed
326 327
\&\& return AND;
\|\| return OR;
Pavel Machek's avatar
Pavel Machek committed
328

329 330 331
\[\= return PO;
\=\] return PC;

Martin Mareš's avatar
Martin Mareš committed
332 333 334 335 336 337 338 339 340 341 342 343
%%

static int
cf_hash(byte *c)
{
  unsigned int h = 13;

  while (*c)
    h = (h * 37) + *c++;
  return h;
}

344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374

/*
 * IFS stack - it contains structures needed for recursive processing
 * of include in config files. On the top of the stack is a structure
 * for currently processed file. Other structures are either for
 * active files interrupted because of include directive (these have
 * fd and flex buffer) or for inactive files scheduled to be processed
 * later (when parent requested including of several files by wildcard
 * match - these do not have fd and flex buffer yet).
 *
 * FIXME: Most of these ifs and include functions are really sysdep/unix.
 */

static struct include_file_stack *
push_ifs(struct include_file_stack *old)
{
  struct include_file_stack *ret;
  ret = cfg_allocz(sizeof(struct include_file_stack));
  ret->lino = 1;
  ret->prev = old;
  return ret;
}

static struct include_file_stack *
pop_ifs(struct include_file_stack *old)
{
 yy_delete_buffer(old->buffer);
 close(old->fd);
 return old->prev;
}

375
static void
376
enter_ifs(struct include_file_stack *new)
377
{
378 379 380 381 382 383 384 385 386 387 388
  if (!new->buffer)
    {
      new->fd = open(new->file_name, O_RDONLY);
      if (new->fd < 0)
        {
          ifs = ifs->up;
	  cf_error("Unable to open included file %s: %m", new->file_name);
        }

      new->buffer = yy_create_buffer(NULL, YY_BUF_SIZE);
    }
389

390 391
  yy_switch_to_buffer(new->buffer);
}
392

393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
/**
 * cf_lex_unwind - unwind lexer state during error
 *
 * cf_lex_unwind() frees the internal state on IFS stack when the lexical
 * analyzer is terminated by cf_error().
 */
void
cf_lex_unwind(void)
{
  struct include_file_stack *n;

  for (n = ifs; n != ifs_head; n = n->prev)
    {
      /* Memory is freed automatically */
      if (n->buffer)
	yy_delete_buffer(n->buffer);
      if (n->fd)
        close(n->fd);
    }

  ifs = ifs_head;
}

416 417 418 419 420 421
static void
cf_include(char *arg, int alen)
{
  struct include_file_stack *base_ifs = ifs;
  int new_depth, rv, i;
  char *patt;
422
  glob_t g = {};
423 424 425 426

  new_depth = ifs->depth + 1;
  if (new_depth > MAX_INCLUDE_DEPTH)
    cf_error("Max include depth reached");
427

428 429 430 431 432 433 434 435 436 437 438
  /* expand arg to properly handle relative filenames */
  if (*arg != '/')
    {
      int dlen = strlen(ifs->file_name);
      char *dir = alloca(dlen + 1);
      patt = alloca(dlen + alen + 2);
      memcpy(dir, ifs->file_name, dlen + 1);
      sprintf(patt, "%s/%s", dirname(dir), arg);
    }
  else
    patt = arg;
439

440 441 442 443 444 445 446 447 448 449 450
  /* Skip globbing if there are no wildcards, mainly to get proper
     response when the included config file is missing */
  if (!strpbrk(arg, "?*["))
    {
      ifs = push_ifs(ifs);
      ifs->file_name = cfg_strdup(patt);
      ifs->depth = new_depth;
      ifs->up = base_ifs;
      enter_ifs(ifs);
      return;
    }
451

452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
  /* Expand the pattern */
  rv = glob(patt, GLOB_ERR | GLOB_NOESCAPE, NULL, &g);
  if (rv == GLOB_ABORTED)
    cf_error("Unable to match pattern %s: %m", patt);
  if ((rv != 0) || (g.gl_pathc <= 0))
    return;

  /*
   * Now we put all found files to ifs stack in reverse order, they
   * will be activated and processed in order as ifs stack is popped
   * by pop_ifs() and enter_ifs() in check_eof().
   */
  for(i = g.gl_pathc - 1; i >= 0; i--)
    {
      char *fname = g.gl_pathv[i];
      struct stat fs;

      if (stat(fname, &fs) < 0)
470 471 472 473
	{
	  globfree(&g);
	  cf_error("Unable to stat included file %s: %m", fname);
	}
474 475 476 477 478 479 480 481 482 483 484 485 486

      if (fs.st_mode & S_IFDIR)
        continue;

      /* Prepare new stack item */
      ifs = push_ifs(ifs);
      ifs->file_name = cfg_strdup(fname);
      ifs->depth = new_depth;
      ifs->up = base_ifs;
    }

  globfree(&g);
  enter_ifs(ifs);
487 488 489 490 491
}

static int
check_eof(void)
{
492 493 494 495 496 497
  if (ifs == ifs_head)
    {
      /* EOF in main config file */
      ifs->lino = 1; /* Why this? */
      return 1;
    }
498

499 500 501
  ifs = pop_ifs(ifs);
  enter_ifs(ifs);
  return 0;
502 503
}

504
static struct symbol *
505
cf_new_sym(byte *c, uint h0)
506
{
507
  uint h = h0 & (SYM_HASH_SIZE-1);
508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527
  struct symbol *s, **ht;
  int l;

  if (!new_config->sym_hash)
    new_config->sym_hash = cfg_allocz(SYM_HASH_SIZE * sizeof(struct keyword *));
  ht = new_config->sym_hash;
  l = strlen(c);
  if (l > SYM_MAX_LEN)
    cf_error("Symbol too long");
  s = cfg_alloc(sizeof(struct symbol) + l);
  s->next = ht[h];
  ht[h] = s;
  s->scope = conf_this_scope;
  s->class = SYM_VOID;
  s->def = NULL;
  s->aux = 0;
  strcpy(s->name, c);
  return s;
}

Martin Mareš's avatar
Martin Mareš committed
528
static struct symbol *
529
cf_find_sym(struct config *cfg, byte *c, uint h0)
Martin Mareš's avatar
Martin Mareš committed
530
{
531
  uint h = h0 & (SYM_HASH_SIZE-1);
532
  struct symbol *s, **ht;
Martin Mareš's avatar
Martin Mareš committed
533

534
  if (ht = cfg->sym_hash)
535 536 537 538 539
    {
      for(s = ht[h]; s; s=s->next)
	if (!strcmp(s->name, c) && s->scope->active)
	  return s;
    }
540
  if (ht = cfg->sym_fallback)
541 542
    {
      /* We know only top-level scope is active */
543
      for(s = ht[h]; s; s=s->next)
Martin Mareš's avatar
Martin Mareš committed
544
	if (!strcmp(s->name, c) && s->scope->active)
545
	  return s;
546
    }
547 548 549 550 551 552 553 554

  return NULL;
}

static inline struct symbol *
cf_get_sym(byte *c, uint h0)
{
  return cf_find_sym(new_config, c, h0) ?: cf_new_sym(c, h0);
Martin Mareš's avatar
Martin Mareš committed
555 556
}

Martin Mareš's avatar
Martin Mareš committed
557 558
/**
 * cf_find_symbol - find a symbol by name
559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
 * @cfg: specificed config
 * @c: symbol name
 *
 * This functions searches the symbol table in the config @cfg for a symbol of
 * given name. First it examines the current scope, then the second recent one
 * and so on until it either finds the symbol and returns a pointer to its
 * &symbol structure or reaches the end of the scope chain and returns %NULL to
 * signify no match.
 */
struct symbol *
cf_find_symbol(struct config *cfg, byte *c)
{
  return cf_find_sym(cfg, c, cf_hash(c));
}

/**
 * cf_get_symbol - get a symbol by name
Martin Mareš's avatar
Martin Mareš committed
576 577
 * @c: symbol name
 *
578 579 580 581
 * This functions searches the symbol table of the currently parsed config
 * (@new_config) for a symbol of given name. It returns either the already
 * existing symbol or a newly allocated undefined (%SYM_VOID) symbol if no
 * existing symbol is found.
Martin Mareš's avatar
Martin Mareš committed
582
 */
583
struct symbol *
584
cf_get_symbol(byte *c)
585
{
586
  return cf_get_sym(c, cf_hash(c));
587 588
}

589
struct symbol *
590
cf_default_name(char *template, int *counter)
591
{
592
  char buf[SYM_MAX_LEN];
593
  struct symbol *s;
594
  char *perc = strchr(template, '%');
595

596
  for(;;)
597
    {
598
      bsprintf(buf, template, ++(*counter));
599
      s = cf_get_sym(buf, cf_hash(buf));
600 601 602 603
      if (s->class == SYM_VOID)
	return s;
      if (!perc)
	break;
604
    }
605
  cf_error("Unable to generate default name");
606 607
}

Martin Mareš's avatar
Martin Mareš committed
608 609 610 611 612 613
/**
 * cf_define_symbol - define meaning of a symbol
 * @sym: symbol to be defined
 * @type: symbol class to assign
 * @def: class dependent data
 *
614 615 616 617 618 619 620 621
 * Defines new meaning of a symbol. If the symbol is an undefined
 * one (%SYM_VOID), it's just re-defined to the new type. If it's defined
 * in different scope, a new symbol in current scope is created and the
 * meaning is assigned to it. If it's already defined in the current scope,
 * an error is reported via cf_error().
 *
 * Result: Pointer to the newly defined symbol. If we are in the top-level
 * scope, it's the same @sym as passed to the function.
Martin Mareš's avatar
Martin Mareš committed
622
 */
623
struct symbol *
624 625 626
cf_define_symbol(struct symbol *sym, int type, void *def)
{
  if (sym->class)
627 628 629
    {
      if (sym->scope == conf_this_scope)
	cf_error("Symbol already defined");
630
      sym = cf_new_sym(sym->name, cf_hash(sym->name));
631
    }
632 633
  sym->class = type;
  sym->def = def;
634
  return sym;
635 636
}

637 638 639 640 641 642 643 644 645 646 647 648 649 650
static void
cf_lex_init_kh(void)
{
  struct keyword *k;

  for(k=keyword_list; k->name; k++)
    {
      unsigned h = cf_hash(k->name) & (KW_HASH_SIZE-1);
      k->next = kw_hash[h];
      kw_hash[h] = k;
    }
  kw_hash_inited = 1;
}

Martin Mareš's avatar
Martin Mareš committed
651 652 653
/**
 * cf_lex_init - initialize the lexer
 * @is_cli: true if we're going to parse CLI command, false for configuration
654
 * @c: configuration structure
Martin Mareš's avatar
Martin Mareš committed
655
 *
656
 * cf_lex_init() initializes the lexical analyzer and prepares it for
Martin Mareš's avatar
Martin Mareš committed
657 658
 * parsing of a new input.
 */
Martin Mareš's avatar
Martin Mareš committed
659
void
660
cf_lex_init(int is_cli, struct config *c)
Martin Mareš's avatar
Martin Mareš committed
661
{
662 663
  if (!kw_hash_inited)
    cf_lex_init_kh();
664 665

  ifs_head = ifs = push_ifs(NULL);
Ondřej Zajíček's avatar
Ondřej Zajíček committed
666
  if (!is_cli)
667 668 669 670 671 672
    {
      ifs->file_name = c->file_name;
      ifs->fd = c->file_fd;
      ifs->depth = 1;
    }

673
  yyrestart(NULL);
674 675
  ifs->buffer = YY_CURRENT_BUFFER;

676 677 678 679
  if (is_cli)
    BEGIN(CLI);
  else
    BEGIN(INITIAL);
680

Martin Mareš's avatar
Martin Mareš committed
681 682
  conf_this_scope = cfg_allocz(sizeof(struct sym_scope));
  conf_this_scope->active = 1;
Martin Mareš's avatar
Martin Mareš committed
683 684
}

Martin Mareš's avatar
Martin Mareš committed
685 686 687 688 689 690 691 692 693 694
/**
 * cf_push_scope - enter new scope
 * @sym: symbol representing scope name
 *
 * If we want to enter a new scope to process declarations inside
 * a nested block, we can just call cf_push_scope() to push a new
 * scope onto the scope stack which will cause all new symbols to be
 * defined in this scope and all existing symbols to be sought for
 * in all scopes stored on the stack.
 */
Martin Mareš's avatar
Martin Mareš committed
695 696 697 698 699 700 701 702 703 704 705
void
cf_push_scope(struct symbol *sym)
{
  struct sym_scope *s = cfg_alloc(sizeof(struct sym_scope));

  s->next = conf_this_scope;
  conf_this_scope = s;
  s->active = 1;
  s->name = sym;
}

Martin Mareš's avatar
Martin Mareš committed
706 707 708 709 710 711 712
/**
 * cf_pop_scope - leave a scope
 *
 * cf_pop_scope() pops the topmost scope from the scope stack,
 * leaving all its symbols in the symbol table, but making them
 * invisible to the rest of the config.
 */
Martin Mareš's avatar
Martin Mareš committed
713 714 715 716 717 718 719
void
cf_pop_scope(void)
{
  conf_this_scope->active = 0;
  conf_this_scope = conf_this_scope->next;
  ASSERT(conf_this_scope);
}
720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738

struct symbol *
cf_walk_symbols(struct config *cf, struct symbol *sym, int *pos)
{
  for(;;)
    {
      if (!sym)
	{
	  if (*pos >= SYM_HASH_SIZE)
	    return NULL;
	  sym = cf->sym_hash[(*pos)++];
	}
      else
	sym = sym->next;
      if (sym && sym->scope->active)
	return sym;
    }
}

Martin Mareš's avatar
Martin Mareš committed
739 740 741 742 743 744 745
/**
 * cf_symbol_class_name - get name of a symbol class
 * @sym: symbol
 *
 * This function returns a string representing the class
 * of the given symbol.
 */
746 747 748
char *
cf_symbol_class_name(struct symbol *sym)
{
749
  if (cf_symbol_is_constant(sym))
750 751
    return "constant";

752 753 754 755 756 757
  switch (sym->class)
    {
    case SYM_VOID:
      return "undefined";
    case SYM_PROTO:
      return "protocol";
758 759
    case SYM_TEMPLATE:
      return "protocol template";
760 761 762 763 764 765 766 767 768 769
    case SYM_FUNCTION:
      return "function";
    case SYM_FILTER:
      return "filter";
    case SYM_TABLE:
      return "routing table";
    default:
      return "unknown type";
    }
}
770 771 772 773 774


/**
 * DOC: Parser
 *
775
 * Both the configuration and CLI commands are analyzed using a syntax
776 777 778 779 780
 * driven parser generated by the |bison| tool from a grammar which
 * is constructed from information gathered from grammar snippets by
 * the |gen_parser.m4| script.
 *
 * Grammar snippets are files (usually with extension |.Y|) contributed
Martin Mareš's avatar
Martin Mareš committed
781
 * by various BIRD modules in order to provide information about syntax of their
782
 * configuration and their CLI commands. Each snipped consists of several
783
 * sections, each of them starting with a special keyword: |CF_HDR| for
784 785 786
 * a list of |#include| directives needed by the C code, |CF_DEFINES|
 * for a list of C declarations, |CF_DECLS| for |bison| declarations
 * including keyword definitions specified as |CF_KEYWORDS|, |CF_GRAMMAR|
787
 * for the grammar rules, |CF_CODE| for auxiliary C code and finally
788 789 790 791 792 793 794
 * |CF_END| at the end of the snippet.
 *
 * To create references between the snippets, it's possible to define
 * multi-part rules by utilizing the |CF_ADDTO| macro which adds a new
 * alternative to a multi-part rule.
 *
 * CLI commands are defined using a |CF_CLI| macro. Its parameters are:
795
 * the list of keywords determining the command, the list of parameters,
796 797 798 799
 * help text for the parameters and help text for the command.
 *
 * Values of |enum| filter types can be defined using |CF_ENUM| with
 * the following parameters: name of filter type, prefix common for all
800
 * literals of this type and names of all the possible values.
801
 */