parser.c 54.3 KB
Newer Older
1
/*
Mark Andrews's avatar
Mark Andrews committed
2
 * Copyright (C) 2000-2002  Internet Software Consortium.
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND INTERNET SOFTWARE CONSORTIUM
 * DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
 * INTERNET SOFTWARE CONSORTIUM BE LIABLE FOR ANY SPECIAL, DIRECT,
 * INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
 * FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
 * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
 * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

18
/* $Id: parser.c,v 1.108 2003/06/20 02:50:48 marka Exp $ */
19 20 21 22 23

#include <config.h>

#include <isc/buffer.h>
#include <isc/dir.h>
24
#include <isc/formatcheck.h>
25 26 27 28 29
#include <isc/lex.h>
#include <isc/log.h>
#include <isc/mem.h>
#include <isc/net.h>
#include <isc/netaddr.h>
30
#include <isc/print.h>
31 32
#include <isc/string.h>
#include <isc/sockaddr.h>
Mark Andrews's avatar
Mark Andrews committed
33
#include <isc/netscope.h>
34 35 36 37
#include <isc/util.h>
#include <isc/symtab.h>

#include <isccfg/cfg.h>
38
#include <isccfg/grammar.h>
39
#include <isccfg/log.h>
40

41
/* Shorthand */
42 43
#define CAT CFG_LOGCATEGORY_CONFIG
#define MOD CFG_LOGMODULE_PARSER
44 45 46

#define MAP_SYM 1 	/* Unique type for isc_symtab */

47 48
#define TOKEN_STRING(pctx) (pctx->token.value.as_textregion.base)

49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
/* Check a return value. */
#define CHECK(op) 						\
     	do { result = (op); 					\
		if (result != ISC_R_SUCCESS) goto cleanup; 	\
	} while (0)

/* Clean up a configuration object if non-NULL. */
#define CLEANUP_OBJ(obj) \
	do { if ((obj) != NULL) cfg_obj_destroy(pctx, &(obj)); } while (0)


/*
 * Forward declarations of static functions.
 */

static void
65
free_tuple(cfg_parser_t *pctx, cfg_obj_t *obj);
66

67
static isc_result_t
68
parse_list(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret);
69 70 71 72 73

static void
print_list(cfg_printer_t *pctx, cfg_obj_t *obj);

static void
74
free_list(cfg_parser_t *pctx, cfg_obj_t *obj);
75

76
static isc_result_t
77
create_listelt(cfg_parser_t *pctx, cfg_listelt_t **eltp);
78 79

static isc_result_t
80 81
create_string(cfg_parser_t *pctx, const char *contents, const cfg_type_t *type,
	      cfg_obj_t **ret);
82 83

static void
84
free_string(cfg_parser_t *pctx, cfg_obj_t *obj);
85

86
static isc_result_t
87
create_map(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **objp);
88 89

static void
90
free_map(cfg_parser_t *pctx, cfg_obj_t *obj);
91 92 93

static isc_result_t
parse_symtab_elt(cfg_parser_t *pctx, const char *name,
94 95
		 cfg_type_t *elttype, isc_symtab_t *symtab,
		 isc_boolean_t callback);
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111

static void
free_noop(cfg_parser_t *pctx, cfg_obj_t *obj);

static isc_result_t
cfg_getstringtoken(cfg_parser_t *pctx);

static void
parser_complain(cfg_parser_t *pctx, isc_boolean_t is_warning,
		unsigned int flags, const char *format, va_list args);

/*
 * Data representations.  These correspond to members of the
 * "value" union in struct cfg_obj (except "void", which does
 * not need a union member).
 */
112

113
cfg_rep_t cfg_rep_uint32 = { "uint32", free_noop };
114
cfg_rep_t cfg_rep_uint64 = { "uint64", free_noop };
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
cfg_rep_t cfg_rep_string = { "string", free_string };
cfg_rep_t cfg_rep_boolean = { "boolean", free_noop };
cfg_rep_t cfg_rep_map = { "map", free_map };
cfg_rep_t cfg_rep_list = { "list", free_list };
cfg_rep_t cfg_rep_tuple = { "tuple", free_tuple };
cfg_rep_t cfg_rep_sockaddr = { "sockaddr", free_noop };
cfg_rep_t cfg_rep_netprefix = { "netprefix", free_noop };
cfg_rep_t cfg_rep_void = { "void", free_noop };

/*
 * Configuration type definitions.
 */

/*
 * An implicit list.  These are formed by clauses that occur multiple times.
 */
static cfg_type_t cfg_type_implicitlist = {
132
	"implicitlist", NULL, print_list, NULL, &cfg_rep_list, NULL };
133 134 135

/* Functions. */

136 137
void
cfg_print_obj(cfg_printer_t *pctx, cfg_obj_t *obj) {
138 139 140
	obj->type->print(pctx, obj);
}

141 142
void
cfg_print_chars(cfg_printer_t *pctx, const char *text, int len) {
143 144 145 146 147
	pctx->f(pctx->closure, text, len);
}

static void
print_open(cfg_printer_t *pctx) {
148
	cfg_print_chars(pctx, "{\n", 2);
149 150 151 152 153 154 155
	pctx->indent++;
}

static void
print_indent(cfg_printer_t *pctx) {
	int indent = pctx->indent;
	while (indent > 0) {
156
		cfg_print_chars(pctx, "\t", 1);
157 158 159 160 161 162 163 164
		indent--;
	}
}

static void
print_close(cfg_printer_t *pctx) {
	pctx->indent--;
	print_indent(pctx);
165
	cfg_print_chars(pctx, "}", 1);
166 167
}

168 169
isc_result_t
cfg_parse_obj(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret) {
Andreas Gustafsson's avatar
Andreas Gustafsson committed
170 171 172 173 174 175 176
	isc_result_t result;
	INSIST(ret != NULL && *ret == NULL);
	result = type->parse(pctx, type, ret);
	if (result != ISC_R_SUCCESS)
		return (result);
	INSIST(*ret != NULL);
	return (ISC_R_SUCCESS);
177 178 179 180 181 182 183 184 185 186 187 188 189 190
}

void
cfg_print(cfg_obj_t *obj,
	  void (*f)(void *closure, const char *text, int textlen),
	  void *closure)
{
	cfg_printer_t pctx;
	pctx.f = f;
	pctx.closure = closure;
	pctx.indent = 0;
	obj->type->print(&pctx, obj);
}

191 192 193

/* Tuples. */
  
194 195
isc_result_t
cfg_create_tuple(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret) {
196
	isc_result_t result;
197 198
	const cfg_tuplefielddef_t *fields = type->of;
	const cfg_tuplefielddef_t *f;
199 200 201
	cfg_obj_t *obj = NULL;
	unsigned int nfields = 0;
	int i;
202

203
	for (f = fields; f->name != NULL; f++)
204 205
		nfields++;

206
	CHECK(cfg_create_obj(pctx, type, &obj));
207 208
	obj->value.tuple = isc_mem_get(pctx->mctx,
				       nfields * sizeof(cfg_obj_t *));
209 210 211 212
	if (obj->value.tuple == NULL) {
		result = ISC_R_NOMEMORY;
		goto cleanup;
	}
213
	for (f = fields, i = 0; f->name != NULL; f++, i++)
214
		obj->value.tuple[i] = NULL;
215 216 217 218 219 220 221 222
	*ret = obj;
	return (ISC_R_SUCCESS);

 cleanup:
	CLEANUP_OBJ(obj);
	return (result);
}

223 224
isc_result_t
cfg_parse_tuple(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret)
225 226
{
	isc_result_t result;
227 228
	const cfg_tuplefielddef_t *fields = type->of;
	const cfg_tuplefielddef_t *f;
229 230
	cfg_obj_t *obj = NULL;
	unsigned int i;
231

232
	CHECK(cfg_create_tuple(pctx, type, &obj));
233
	for (f = fields, i = 0; f->name != NULL; f++, i++)
234
		CHECK(cfg_parse_obj(pctx, f->type, &obj->value.tuple[i]));
235 236 237 238 239 240 241 242 243

	*ret = obj;
	return (ISC_R_SUCCESS);

 cleanup:
	CLEANUP_OBJ(obj);
	return (result);
}

244 245
void
cfg_print_tuple(cfg_printer_t *pctx, cfg_obj_t *obj) {
246
	unsigned int i;
247 248
	const cfg_tuplefielddef_t *fields = obj->type->of;
	const cfg_tuplefielddef_t *f;
249
	isc_boolean_t need_space = ISC_FALSE;
250

251
	for (f = fields, i = 0; f->name != NULL; f++, i++) {
252 253
		cfg_obj_t *fieldobj = obj->value.tuple[i];
		if (need_space)
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
			cfg_print_chars(pctx, " ", 1);
		cfg_print_obj(pctx, fieldobj);
		need_space = ISC_TF(fieldobj->type->print != cfg_print_void);
	}
}

void
cfg_doc_tuple(cfg_printer_t *pctx, const cfg_type_t *type) {
	const cfg_tuplefielddef_t *fields = type->of;
	const cfg_tuplefielddef_t *f;
	isc_boolean_t need_space = ISC_FALSE;

	for (f = fields; f->name != NULL; f++) {
		if (need_space)
			cfg_print_chars(pctx, " ", 1);
		cfg_doc_obj(pctx, f->type);
		need_space = ISC_TF(f->type->print != cfg_print_void);
271 272 273 274 275 276
	}
}

static void
free_tuple(cfg_parser_t *pctx, cfg_obj_t *obj) {
	unsigned int i;
277 278
	const cfg_tuplefielddef_t *fields = obj->type->of;
	const cfg_tuplefielddef_t *f;
279 280
	unsigned int nfields = 0;

281 282 283
	if (obj->value.tuple == NULL)
		return;

284
	for (f = fields, i = 0; f->name != NULL; f++, i++) {
285 286 287 288 289 290 291
		CLEANUP_OBJ(obj->value.tuple[i]);
		nfields++;
	}
	isc_mem_put(pctx->mctx, obj->value.tuple,
		    nfields * sizeof(cfg_obj_t *));
}

292 293 294 295 296 297
isc_boolean_t
cfg_obj_istuple(cfg_obj_t *obj) {
	REQUIRE(obj != NULL);
	return (ISC_TF(obj->type->rep == &cfg_rep_tuple));
}

298 299 300
cfg_obj_t *
cfg_tuple_get(cfg_obj_t *tupleobj, const char* name) {
	unsigned int i;
301 302
	const cfg_tuplefielddef_t *fields;
	const cfg_tuplefielddef_t *f;
303 304 305 306 307 308 309 310 311 312 313 314
	
	REQUIRE(tupleobj != NULL && tupleobj->type->rep == &cfg_rep_tuple);

	fields = tupleobj->type->of;
	for (f = fields, i = 0; f->name != NULL; f++, i++) {
		if (strcmp(f->name, name) == 0)
			return (tupleobj->value.tuple[i]);
	}
	INSIST(0);
	return (NULL);
}

315 316
isc_result_t
cfg_parse_special(cfg_parser_t *pctx, int special) {
317 318 319 320 321 322
        isc_result_t result;
	CHECK(cfg_gettoken(pctx, 0));
	if (pctx->token.type == isc_tokentype_special &&
	    pctx->token.value.as_char == special)
		return (ISC_R_SUCCESS);

323
	cfg_parser_error(pctx, CFG_LOG_NEAR, "'%c' expected", special);
324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
	return (ISC_R_UNEXPECTEDTOKEN);
 cleanup:
	return (result);
}

/*
 * Parse a required semicolon.  If it is not there, log
 * an error and increment the error count but continue
 * parsing.  Since the next token is pushed back,
 * care must be taken to make sure it is eventually
 * consumed or an infinite loop may result.
 */
static isc_result_t
parse_semicolon(cfg_parser_t *pctx) {
        isc_result_t result;
	CHECK(cfg_gettoken(pctx, 0));
	if (pctx->token.type == isc_tokentype_special &&
	    pctx->token.value.as_char == ';')
		return (ISC_R_SUCCESS);

344
	cfg_parser_error(pctx, CFG_LOG_BEFORE, "missing ';'");
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
	cfg_ungettoken(pctx);
 cleanup:
	return (result);
}

/*
 * Parse EOF, logging and returning an error if not there.
 */
static isc_result_t
parse_eof(cfg_parser_t *pctx) {
        isc_result_t result;
	CHECK(cfg_gettoken(pctx, 0));

	if (pctx->token.type == isc_tokentype_eof)
		return (ISC_R_SUCCESS);

361
	cfg_parser_error(pctx, CFG_LOG_NEAR, "syntax error");
362 363
	return (ISC_R_UNEXPECTEDTOKEN);
 cleanup:
Andreas Gustafsson's avatar
spacing  
Andreas Gustafsson committed
364
	return (result);
365 366 367
}

/* A list of files, used internally for pctx->files. */
368

369
static cfg_type_t cfg_type_filelist = {
370
	"filelist", NULL, print_list, NULL, &cfg_rep_list,
371 372 373 374
	&cfg_type_qstring
};

isc_result_t
375
cfg_parser_create(isc_mem_t *mctx, isc_log_t *lctx, cfg_parser_t **ret) {
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
	isc_result_t result;
	cfg_parser_t *pctx;
	isc_lexspecials_t specials;

	REQUIRE(mctx != NULL);
	REQUIRE(ret != NULL && *ret == NULL);

	pctx = isc_mem_get(mctx, sizeof(*pctx));
	if (pctx == NULL)
		return (ISC_R_NOMEMORY);

	pctx->mctx = mctx;
	pctx->lctx = lctx;
	pctx->lexer = NULL;
	pctx->seen_eof = ISC_FALSE;
	pctx->ungotten = ISC_FALSE;
	pctx->errors = 0;
Mark Andrews's avatar
Mark Andrews committed
393
	pctx->warnings = 0;
394 395
	pctx->open_files = NULL;
	pctx->closed_files = NULL;
396
	pctx->line = 0;
397 398
	pctx->callback = NULL;
	pctx->callbackarg = NULL;
Mark Andrews's avatar
Mark Andrews committed
399
	pctx->token.type = isc_tokentype_unknown;
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415

	memset(specials, 0, sizeof(specials));
	specials['{'] = 1;
	specials['}'] = 1;
	specials[';'] = 1;
	specials['/'] = 1;
	specials['"'] = 1;
	specials['!'] = 1;

	CHECK(isc_lex_create(pctx->mctx, 1024, &pctx->lexer));

	isc_lex_setspecials(pctx->lexer, specials);
	isc_lex_setcomments(pctx->lexer, (ISC_LEXCOMMENT_C |
					 ISC_LEXCOMMENT_CPLUSPLUS |
					 ISC_LEXCOMMENT_SHELL));

416 417
	CHECK(cfg_create_list(pctx, &cfg_type_filelist, &pctx->open_files));
	CHECK(cfg_create_list(pctx, &cfg_type_filelist, &pctx->closed_files));
418 419 420 421 422 423 424

	*ret = pctx;
	return (ISC_R_SUCCESS);

 cleanup:
	if (pctx->lexer != NULL)
		isc_lex_destroy(&pctx->lexer);
425 426
	CLEANUP_OBJ(pctx->open_files);
	CLEANUP_OBJ(pctx->closed_files);
427 428 429 430 431
	isc_mem_put(mctx, pctx, sizeof(*pctx));
	return (result);
}

static isc_result_t
432
parser_openfile(cfg_parser_t *pctx, const char *filename) {
433 434 435 436 437 438
	isc_result_t result;
	cfg_listelt_t *elt = NULL;
	cfg_obj_t *stringobj = NULL;

	result = isc_lex_openfile(pctx->lexer, filename);
	if (result != ISC_R_SUCCESS) {
439
		cfg_parser_error(pctx, 0, "open: %s: %s",
440 441 442 443 444 445 446
			     filename, isc_result_totext(result));
		goto cleanup;
	}

	CHECK(create_string(pctx, filename, &cfg_type_qstring, &stringobj));
	CHECK(create_listelt(pctx, &elt));
	elt->obj = stringobj;
447
	ISC_LIST_APPEND(pctx->open_files->value.list, elt, link);
448 449 450 451 452 453 454

	return (ISC_R_SUCCESS);
 cleanup:
	CLEANUP_OBJ(stringobj);
	return (result);
}

455 456 457 458 459 460 461 462 463
void
cfg_parser_setcallback(cfg_parser_t *pctx,
		       cfg_parsecallback_t callback,
		       void *arg)
{
	pctx->callback = callback;
	pctx->callbackarg = arg;
}

464 465 466 467 468
/*
 * Parse a configuration using a pctx where a lexer has already
 * been set up with a source.
 */
static isc_result_t
469
parse2(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret) {
470 471 472
	isc_result_t result;
	cfg_obj_t *obj = NULL;

473
	result = cfg_parse_obj(pctx, type, &obj);
474 475 476 477 478 479 480 481 482 483

	if (pctx->errors != 0) {
		/* Errors have been logged. */
		if (result == ISC_R_SUCCESS)
			result = ISC_R_FAILURE;
		goto cleanup;
	}

	if (result != ISC_R_SUCCESS) {
		/* Parsing failed but no errors have been logged. */
484
		cfg_parser_error(pctx, 0, "parsing failed");
485 486 487 488 489 490 491 492 493 494 495 496 497
		goto cleanup;
	}

	CHECK(parse_eof(pctx));

	*ret = obj;
	return (ISC_R_SUCCESS);

 cleanup:
	CLEANUP_OBJ(obj);
	return (result);
}

498 499
isc_result_t
cfg_parse_file(cfg_parser_t *pctx, const char *filename,
500
	       const cfg_type_t *type, cfg_obj_t **ret)
501 502 503 504 505 506 507 508 509 510 511 512 513 514
{
	isc_result_t result;

	REQUIRE(filename != NULL);

	CHECK(parser_openfile(pctx, filename));
	CHECK(parse2(pctx, type, ret));
 cleanup:
	return (result);
}


isc_result_t
cfg_parse_buffer(cfg_parser_t *pctx, isc_buffer_t *buffer,
515
	const cfg_type_t *type, cfg_obj_t **ret)
516 517 518 519 520 521 522 523 524
{
	isc_result_t result;
	REQUIRE(buffer != NULL);
	CHECK(isc_lex_openbuffer(pctx->lexer, buffer));	
	CHECK(parse2(pctx, type, ret));
 cleanup:
	return (result);
}

525 526 527 528
void
cfg_parser_destroy(cfg_parser_t **pctxp) {
	cfg_parser_t *pctx = *pctxp;
	isc_lex_destroy(&pctx->lexer);
529 530 531 532 533 534 535
	/*
	 * Cleaning up open_files does not
	 * close the files; that was already done
	 * by closing the lexer.
	 */
	CLEANUP_OBJ(pctx->open_files);
	CLEANUP_OBJ(pctx->closed_files);
536 537 538 539 540 541 542
	isc_mem_put(pctx->mctx, pctx, sizeof(*pctx));
	*pctxp = NULL;
}

/*
 * void
 */
543 544
isc_result_t
cfg_parse_void(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret) {
545
	UNUSED(type);
546
	return (cfg_create_obj(pctx, &cfg_type_void, ret));
547 548
}

549 550
void
cfg_print_void(cfg_printer_t *pctx, cfg_obj_t *obj) {
551 552 553
	UNUSED(pctx);
	UNUSED(obj);
}
554

555 556 557 558 559 560
void
cfg_doc_void(cfg_printer_t *pctx, const cfg_type_t *type) {
	UNUSED(pctx);
	UNUSED(type);
}

561 562 563 564 565 566
isc_boolean_t
cfg_obj_isvoid(cfg_obj_t *obj) {
	REQUIRE(obj != NULL);
	return (ISC_TF(obj->type->rep == &cfg_rep_void));
}

567 568 569
cfg_type_t cfg_type_void = {
	"void", cfg_parse_void, cfg_print_void, cfg_doc_void, &cfg_rep_void,
	NULL };
570 571 572 573 574


/*
 * uint32
 */
575 576
isc_result_t
cfg_parse_uint32(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret) {
577 578 579 580
        isc_result_t result;
	cfg_obj_t *obj = NULL;
	UNUSED(type);

581
	CHECK(cfg_gettoken(pctx, ISC_LEXOPT_NUMBER | ISC_LEXOPT_CNUMBER));
582
	if (pctx->token.type != isc_tokentype_number) {
583
		cfg_parser_error(pctx, CFG_LOG_NEAR, "expected number");
584 585 586
		return (ISC_R_UNEXPECTEDTOKEN);
	}

587
	CHECK(cfg_create_obj(pctx, &cfg_type_uint32, &obj));
588 589 590 591 592 593 594

	obj->value.uint32 = pctx->token.value.as_ulong;
	*ret = obj;
 cleanup:
	return (result);
}

595 596 597
void
cfg_print_cstr(cfg_printer_t *pctx, const char *s) {
	cfg_print_chars(pctx, s, strlen(s));
598 599
}

600 601
void
cfg_print_rawuint(cfg_printer_t *pctx, unsigned int u) {
602
	char buf[32];
603
	snprintf(buf, sizeof(buf), "%u", u);
604
	cfg_print_cstr(pctx, buf);
605 606
}

607 608 609
void
cfg_print_uint32(cfg_printer_t *pctx, cfg_obj_t *obj) {
	cfg_print_rawuint(pctx, obj->value.uint32);
610 611
}

612 613 614 615 616 617
isc_boolean_t
cfg_obj_isuint32(cfg_obj_t *obj) {
	REQUIRE(obj != NULL);
	return (ISC_TF(obj->type->rep == &cfg_rep_uint32));
}

618 619 620 621 622 623
isc_uint32_t
cfg_obj_asuint32(cfg_obj_t *obj) {
	REQUIRE(obj != NULL && obj->type->rep == &cfg_rep_uint32);
	return (obj->value.uint32);
}

624 625 626 627
cfg_type_t cfg_type_uint32 = {
	"integer", cfg_parse_uint32, cfg_print_uint32, cfg_doc_terminal,
	&cfg_rep_uint32, NULL
};
628 629


630 631 632 633 634 635 636 637 638 639 640 641 642 643 644
/*
 * uint64
 */
isc_boolean_t
cfg_obj_isuint64(cfg_obj_t *obj) {
	REQUIRE(obj != NULL);
	return (ISC_TF(obj->type->rep == &cfg_rep_uint64));
}

isc_uint64_t
cfg_obj_asuint64(cfg_obj_t *obj) {
	REQUIRE(obj != NULL && obj->type->rep == &cfg_rep_uint64);
	return (obj->value.uint64);
}

645 646
void
cfg_print_uint64(cfg_printer_t *pctx, cfg_obj_t *obj) {
647
	char buf[32];
648 649
	snprintf(buf, sizeof(buf), "%" ISC_PRINT_QUADFORMAT "u",
		 obj->value.uint64);
650
	cfg_print_cstr(pctx, buf);
651 652
}

653 654 655
cfg_type_t cfg_type_uint64 = {
	"64_bit_integer", NULL, cfg_print_uint64, cfg_doc_terminal,
	&cfg_rep_uint64, NULL
656 657
};

658
/*
659 660
 * qstring (quoted string), ustring (unquoted string), astring
 * (any string)
661 662 663 664
 */

/* Create a string object from a null-terminated C string. */
static isc_result_t
665
create_string(cfg_parser_t *pctx, const char *contents, const cfg_type_t *type,
666 667 668 669 670 671
	      cfg_obj_t **ret)
{
	isc_result_t result;
	cfg_obj_t *obj = NULL;
	int len;

672
	CHECK(cfg_create_obj(pctx, type, &obj));
673 674 675 676 677 678 679 680 681 682 683 684 685 686 687
	len = strlen(contents);
	obj->value.string.length = len;
	obj->value.string.base = isc_mem_get(pctx->mctx, len + 1);
	if (obj->value.string.base == 0) {
		CLEANUP_OBJ(obj);
		return (ISC_R_NOMEMORY);
	}
	memcpy(obj->value.string.base, contents, len);
	obj->value.string.base[len] = '\0';

	*ret = obj;
 cleanup:
	return (result);
}

688 689
isc_result_t
cfg_parse_qstring(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret) {
690 691 692
        isc_result_t result;
	UNUSED(type);

693
	CHECK(cfg_gettoken(pctx, CFG_LEXOPT_QSTRING));
694
	if (pctx->token.type != isc_tokentype_qstring) {
695
		cfg_parser_error(pctx, CFG_LOG_NEAR, "expected quoted string");
696 697 698
		return (ISC_R_UNEXPECTEDTOKEN);
	}
	return (create_string(pctx,
699
			      TOKEN_STRING(pctx),
700 701 702 703 704 705 706
			      &cfg_type_qstring,
			      ret));
 cleanup:
	return (result);
}

static isc_result_t
707
parse_ustring(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret) {
708 709 710 711 712
        isc_result_t result;
	UNUSED(type);

	CHECK(cfg_gettoken(pctx, 0));
	if (pctx->token.type != isc_tokentype_string) {
713
		cfg_parser_error(pctx, CFG_LOG_NEAR, "expected unquoted string");
714 715 716
		return (ISC_R_UNEXPECTEDTOKEN);
	}
	return (create_string(pctx,
717
			      TOKEN_STRING(pctx),
718 719 720 721 722 723
			      &cfg_type_ustring,
			      ret));
 cleanup:
	return (result);
}

724 725
isc_result_t
cfg_parse_astring(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret) {
726 727 728 729 730
        isc_result_t result;
	UNUSED(type);

	CHECK(cfg_getstringtoken(pctx));
	return (create_string(pctx,
731
			      TOKEN_STRING(pctx),
732 733 734 735 736 737
			      &cfg_type_qstring,
			      ret));
 cleanup:
	return (result);
}

738 739
isc_boolean_t
cfg_is_enum(const char *s, const char *const *enums) {
740
	const char * const *p;
Andreas Gustafsson's avatar
Andreas Gustafsson committed
741 742
	for (p = enums; *p != NULL; p++) {
		if (strcasecmp(*p, s) == 0)
743
			return (ISC_TRUE);
Andreas Gustafsson's avatar
Andreas Gustafsson committed
744
	}
745 746 747 748
	return (ISC_FALSE);
}

static isc_result_t
749
check_enum(cfg_parser_t *pctx, cfg_obj_t *obj, const char *const *enums) {
750
	const char *s = obj->value.string.base;
751
	if (cfg_is_enum(s, enums))
752
		return (ISC_R_SUCCESS);
753
	cfg_parser_error(pctx, 0, "'%s' unexpected", s);
Andreas Gustafsson's avatar
Andreas Gustafsson committed
754 755 756
	return (ISC_R_UNEXPECTEDTOKEN);
}

757 758
isc_result_t
cfg_parse_enum(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret) {
Andreas Gustafsson's avatar
Andreas Gustafsson committed
759 760 761 762 763 764 765 766 767 768 769
        isc_result_t result;
	cfg_obj_t *obj = NULL;
	CHECK(parse_ustring(pctx, NULL, &obj));
	CHECK(check_enum(pctx, obj, type->of));
	*ret = obj;
	return (ISC_R_SUCCESS);
 cleanup:
	CLEANUP_OBJ(obj);	
	return (result);
}

770 771 772 773 774 775 776 777
void
cfg_doc_enum(cfg_printer_t *pctx, const cfg_type_t *type) {
	const char * const *p;
	cfg_print_chars(pctx, "( ", 2);
	for (p = type->of; *p != NULL; p++) {
		cfg_print_cstr(pctx, *p);
		if (p[1] != NULL)
			cfg_print_chars(pctx, " | ", 3);
778
	}
779
	cfg_print_chars(pctx, " )", 2);
780 781
}

782 783 784
void
cfg_print_ustring(cfg_printer_t *pctx, cfg_obj_t *obj) {
	cfg_print_chars(pctx, obj->value.string.base, obj->value.string.length);
785 786 787 788
}

static void
print_qstring(cfg_printer_t *pctx, cfg_obj_t *obj) {
789 790 791
	cfg_print_chars(pctx, "\"", 1);
	cfg_print_ustring(pctx, obj);
	cfg_print_chars(pctx, "\"", 1);
792 793 794 795
}

static void
free_string(cfg_parser_t *pctx, cfg_obj_t *obj) {
796 797 798
	if (obj->value.string.base != NULL)
		isc_mem_put(pctx->mctx, obj->value.string.base,
			    obj->value.string.length + 1);
799 800
}

801 802 803 804 805 806
isc_boolean_t
cfg_obj_isstring(cfg_obj_t *obj) {
	REQUIRE(obj != NULL);
	return (ISC_TF(obj->type->rep == &cfg_rep_string));
}

807 808 809 810 811 812
char *
cfg_obj_asstring(cfg_obj_t *obj) {
	REQUIRE(obj != NULL && obj->type->rep == &cfg_rep_string);
	return (obj->value.string.base);
}

813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834
/* Quoted string only */
cfg_type_t cfg_type_qstring = {
	"quoted_string", cfg_parse_qstring, print_qstring, cfg_doc_terminal,
	&cfg_rep_string, NULL
};

/* Unquoted string only */
cfg_type_t cfg_type_ustring = {
	"string", parse_ustring, cfg_print_ustring, cfg_doc_terminal,
	&cfg_rep_string, NULL
};

/* Any string (quoted or unquoted); printed with quotes */
cfg_type_t cfg_type_astring = {
	"string", cfg_parse_astring, print_qstring, cfg_doc_terminal,
	&cfg_rep_string, NULL
};

/*
 * Booleans
 */

835 836 837 838 839 840
isc_boolean_t
cfg_obj_isboolean(cfg_obj_t *obj) {
	REQUIRE(obj != NULL);
	return (ISC_TF(obj->type->rep == &cfg_rep_boolean));
}

Brian Wellington's avatar
Brian Wellington committed
841 842 843 844 845 846
isc_boolean_t
cfg_obj_asboolean(cfg_obj_t *obj) {
	REQUIRE(obj != NULL && obj->type->rep == &cfg_rep_boolean);
	return (obj->value.boolean);
}

847
static isc_result_t
848
parse_boolean(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret)
849
{
850 851 852 853 854 855 856 857 858 859
        isc_result_t result;
	isc_boolean_t value;
	cfg_obj_t *obj = NULL;
	UNUSED(type);

	result = cfg_gettoken(pctx, 0);
	if (result != ISC_R_SUCCESS)
		return (result);

	if (pctx->token.type != isc_tokentype_string)
860
		goto bad_boolean;
861

862 863 864
	if ((strcasecmp(TOKEN_STRING(pctx), "true") == 0) ||
	    (strcasecmp(TOKEN_STRING(pctx), "yes") == 0) ||
	    (strcmp(TOKEN_STRING(pctx), "1") == 0)) {
865
		value = ISC_TRUE;
866 867 868
	} else if ((strcasecmp(TOKEN_STRING(pctx), "false") == 0) ||
		   (strcasecmp(TOKEN_STRING(pctx), "no") == 0) ||
		   (strcmp(TOKEN_STRING(pctx), "0") == 0)) {
869 870 871 872 873
		value = ISC_FALSE;
	} else {
		goto bad_boolean;
	}

874
	CHECK(cfg_create_obj(pctx, &cfg_type_boolean, &obj));
875 876 877 878 879
	obj->value.boolean = value;
	*ret = obj;
	return (result);

 bad_boolean:
880
	cfg_parser_error(pctx, CFG_LOG_NEAR, "boolean expected");
881 882 883 884 885 886 887 888 889
	return (ISC_R_UNEXPECTEDTOKEN);

 cleanup:
	return (result);
}

static void
print_boolean(cfg_printer_t *pctx, cfg_obj_t *obj) {
	if (obj->value.boolean)
890
		cfg_print_chars(pctx, "yes", 3);
891
	else
892
		cfg_print_chars(pctx, "no", 2);
Andreas Gustafsson's avatar
Andreas Gustafsson committed
893
}
894

895 896 897
cfg_type_t cfg_type_boolean = {
	"boolean", parse_boolean, print_boolean, cfg_doc_terminal,
	&cfg_rep_boolean, NULL
898 899
};

900
/*
901
 * Lists.
902 903
 */

904 905
isc_result_t
cfg_create_list(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **obj) {
906
	isc_result_t result;
907
	CHECK(cfg_create_obj(pctx, type, obj));
908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924
	ISC_LIST_INIT((*obj)->value.list);
 cleanup:
	return (result);
}

static isc_result_t
create_listelt(cfg_parser_t *pctx, cfg_listelt_t **eltp) {
	cfg_listelt_t *elt;
	elt = isc_mem_get(pctx->mctx, sizeof(*elt));
	if (elt == NULL)
		return (ISC_R_NOMEMORY);
	elt->obj = NULL;
	ISC_LINK_INIT(elt, link);
	*eltp = elt;
	return (ISC_R_SUCCESS);
}

925 926 927 928 929 930
static void
free_list_elt(cfg_parser_t *pctx, cfg_listelt_t *elt) {
	cfg_obj_destroy(pctx, &elt->obj);
	isc_mem_put(pctx->mctx, elt, sizeof(*elt));
}

931 932 933 934 935 936 937 938
static void
free_list(cfg_parser_t *pctx, cfg_obj_t *obj) {
	cfg_listelt_t *elt, *next;
	for (elt = ISC_LIST_HEAD(obj->value.list);
	     elt != NULL;
	     elt = next)
	{
		next = ISC_LIST_NEXT(elt, link);
939
		free_list_elt(pctx, elt);
940 941 942
	}
}

943 944 945
isc_result_t
cfg_parse_listelt(cfg_parser_t *pctx, const cfg_type_t *elttype,
		  cfg_listelt_t **ret)
946 947 948 949 950 951 952
{
	isc_result_t result;
	cfg_listelt_t *elt = NULL;
	cfg_obj_t *value = NULL;

	CHECK(create_listelt(pctx, &elt));

953
	result = cfg_parse_obj(pctx, elttype, &value);
954 955 956 957 958 959 960 961 962 963 964 965 966
	if (result != ISC_R_SUCCESS)
		goto cleanup;

	elt->obj = value;

	*ret = elt;
	return (ISC_R_SUCCESS);

 cleanup:
	isc_mem_put(pctx->mctx, elt, sizeof(*elt));
	return (result);
}

967 968 969 970
/*
 * Parse a homogeneous list whose elements are of type 'elttype'
 * and where each element is terminated by a semicolon.
 */
971
static isc_result_t
972
parse_list(cfg_parser_t *pctx, const cfg_type_t *listtype, cfg_obj_t **ret)
973 974
{
	cfg_obj_t *listobj = NULL;
975
	const cfg_type_t *listof = listtype->of;
976 977
	isc_result_t result;

978
	CHECK(cfg_create_list(pctx, listtype, &listobj));
979 980 981 982 983 984 985 986

	for (;;) {
		cfg_listelt_t *elt = NULL;

		CHECK(cfg_peektoken(pctx, 0));
		if (pctx->token.type == isc_tokentype_special &&
		    pctx->token.value.as_char == '}')
			break;
987
		CHECK(cfg_parse_listelt(pctx, listof, &elt));
988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
		CHECK(parse_semicolon(pctx));
		ISC_LIST_APPEND(listobj->value.list, elt, link);
	}
	*ret = listobj;
	return (ISC_R_SUCCESS);

 cleanup:
	CLEANUP_OBJ(listobj);
	return (result);
}

static void
print_list(cfg_printer_t *pctx, cfg_obj_t *obj) {
	cfg_list_t *list = &obj->value.list;
	cfg_listelt_t *elt;

	for (elt = ISC_LIST_HEAD(*list);
	     elt != NULL;
	     elt = ISC_LIST_NEXT(elt, link)) {
		print_indent(pctx);
1008 1009
		cfg_print_obj(pctx, elt->obj);
		cfg_print_chars(pctx, ";\n", 2);
1010 1011 1012
	}
}

1013 1014 1015
isc_result_t
cfg_parse_bracketed_list(cfg_parser_t *pctx, const cfg_type_t *type,
		     cfg_obj_t **ret)
1016 1017
{
	isc_result_t result;
1018
	CHECK(cfg_parse_special(pctx, '{'));
1019
	CHECK(parse_list(pctx, type, ret));
1020
	CHECK(cfg_parse_special(pctx, '}'));
1021 1022 1023 1024
 cleanup:
	return (result);
}

1025 1026
void
cfg_print_bracketed_list(cfg_printer_t *pctx, cfg_obj_t *obj) {
1027 1028 1029 1030 1031
	print_open(pctx);
	print_list(pctx, obj);
	print_close(pctx);
}

1032 1033 1034 1035 1036 1037 1038
void
cfg_doc_bracketed_list(cfg_printer_t *pctx, const cfg_type_t *type) {
	cfg_print_chars(pctx, "{ ", 2);
	cfg_doc_obj(pctx, type->of);
	cfg_print_chars(pctx, "; ... }", 7);
}

1039 1040 1041 1042 1043
/*
 * Parse a homogeneous list whose elements are of type 'elttype'
 * and where elements are separated by space.  The list ends
 * before the first semicolon.
 */
1044 1045 1046
isc_result_t
cfg_parse_spacelist(cfg_parser_t *pctx, const cfg_type_t *listtype,
		    cfg_obj_t **ret)
1047 1048
{
	cfg_obj_t *listobj = NULL;
1049
	const cfg_type_t *listof = listtype->of;
1050 1051
	isc_result_t result;

1052
	CHECK(cfg_create_list(pctx, listtype, &listobj));
1053 1054 1055 1056 1057 1058 1059 1060

	for (;;) {
		cfg_listelt_t *elt = NULL;

		CHECK(cfg_peektoken(pctx, 0));
		if (pctx->token.type == isc_tokentype_special &&
		    pctx->token.value.as_char == ';')
			break;
1061
		CHECK(cfg_parse_listelt(pctx, listof, &elt));
1062 1063 1064 1065 1066 1067 1068 1069 1070 1071
		ISC_LIST_APPEND(listobj->value.list, elt, link);
	}
	*ret = listobj;
	return (ISC_R_SUCCESS);

 cleanup:
	CLEANUP_OBJ(listobj);
	return (result);
}

1072 1073
void
cfg_print_spacelist(cfg_printer_t *pctx, cfg_obj_t *obj) {
1074 1075 1076 1077 1078 1079
	cfg_list_t *list = &obj->value.list;
	cfg_listelt_t *elt;

	for (elt = ISC_LIST_HEAD(*list);
	     elt != NULL;
	     elt = ISC_LIST_NEXT(elt, link)) {
1080
		cfg_print_obj(pctx, elt->obj);
1081
		if (ISC_LIST_NEXT(elt, link) != NULL)
1082
			cfg_print_chars(pctx, " ", 1);
1083 1084 1085
	}
}

1086

1087 1088 1089 1090 1091 1092
isc_boolean_t
cfg_obj_islist(cfg_obj_t *obj) {
	REQUIRE(obj != NULL);
	return (ISC_TF(obj->type->rep == &cfg_rep_list));
}

1093 1094
cfg_listelt_t *
cfg_list_first(cfg_obj_t *obj) {
1095 1096 1097
	REQUIRE(obj == NULL || obj->type->rep == &cfg_rep_list);
	if (obj == NULL)
		return (NULL);
1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116
	return (ISC_LIST_HEAD(obj->value.list));
}

cfg_listelt_t *
cfg_list_next(cfg_listelt_t *elt) {
	REQUIRE(elt != NULL);
	return (ISC_LIST_NEXT(elt, link));
}

cfg_obj_t *
cfg_listelt_value(cfg_listelt_t *elt) {
	REQUIRE(elt != NULL);
	return (elt->obj);
}

/*
 * Maps.
 */

1117 1118 1119 1120 1121 1122 1123 1124 1125 1126
/*
 * Parse a map body.  That's something like
 *
 *   "foo 1; bar { glub; }; zap true; zap false;"
 *
 * i.e., a sequence of option names followed by values and
 * terminated by semicolons.  Used for the top level of
 * the named.conf syntax, as well as for the body of the
 * options, view, zone, and other statements.
 */
1127 1128
isc_result_t
cfg_parse_mapbody(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret)
1129
{
1130
	const cfg_clausedef_t * const *clausesets = type->of;
1131
	isc_result_t result;
1132 1133
	const cfg_clausedef_t * const *clauseset;
	const cfg_clausedef_t *clause;
1134
	cfg_obj_t *value = NULL;
1135
	cfg_obj_t *obj = NULL;
1136 1137 1138 1139
	cfg_obj_t *eltobj = NULL;
	cfg_obj_t *includename = NULL;
	isc_symvalue_t symval;
	cfg_list_t *list = NULL;
1140

1141
	CHECK(create_map(pctx, type, &obj));
1142

1143
	obj->value.map.clausesets = clausesets;
1144

1145 1146
	for (;;) {
		cfg_listelt_t *elt;
1147

1148 1149 1150 1151 1152
	redo:
		/*
		 * Parse the option name and see if it is known.
		 */
		CHECK(cfg_gettoken(pctx, 0));
1153

1154 1155 1156 1157
		if (pctx->token.type != isc_tokentype_string) {
			cfg_ungettoken(pctx);
			break;
		}
1158

1159 1160 1161 1162
		/*
		 * We accept "include" statements wherever a map body
		 * clause can occur.
		 */
1163
		if (strcasecmp(TOKEN_STRING(pctx), "include") == 0) {
1164 1165 1166 1167 1168
			/*
			 * Turn the file name into a temporary configuration
			 * object just so that it is not overwritten by the
			 * semicolon token.
			 */
1169
			CHECK(cfg_parse_obj(pctx, &cfg_type_qstring, &includename));
1170 1171 1172 1173 1174 1175
			CHECK(parse_semicolon(pctx));
			CHECK(parser_openfile(pctx, includename->
					      value.string.base));
			 cfg_obj_destroy(pctx, &includename