parser.c 64.9 KB
Newer Older
1
/*
2
 * Copyright (C) 2004-2015  Internet Systems Consortium, Inc. ("ISC")
Mark Andrews's avatar
Mark Andrews committed
3
 * Copyright (C) 2000-2003  Internet Software Consortium.
4
 *
Automatic Updater's avatar
Automatic Updater committed
5
 * Permission to use, copy, modify, and/or distribute this software for any
6 7 8
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
Mark Andrews's avatar
Mark Andrews committed
9 10 11 12 13 14 15
 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
 * REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS.  IN NO EVENT SHALL ISC 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.
16 17
 */

Mark Andrews's avatar
Mark Andrews committed
18
/* $Id$ */
19 20

/*! \file */
21 22 23 24 25

#include <config.h>

#include <isc/buffer.h>
#include <isc/dir.h>
26
#include <isc/formatcheck.h>
27 28 29 30 31
#include <isc/lex.h>
#include <isc/log.h>
#include <isc/mem.h>
#include <isc/net.h>
#include <isc/netaddr.h>
32
#include <isc/netscope.h>
33
#include <isc/print.h>
34 35 36
#include <isc/string.h>
#include <isc/sockaddr.h>
#include <isc/symtab.h>
37
#include <isc/util.h>
38 39

#include <isccfg/cfg.h>
40
#include <isccfg/grammar.h>
41
#include <isccfg/log.h>
42

43
/* Shorthand */
44 45
#define CAT CFG_LOGCATEGORY_CONFIG
#define MOD CFG_LOGMODULE_PARSER
46 47 48

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

49 50
#define TOKEN_STRING(pctx) (pctx->token.value.as_textregion.base)

51 52
/* Check a return value. */
#define CHECK(op) 						\
Automatic Updater's avatar
Automatic Updater committed
53
	do { result = (op); 					\
54 55 56 57 58 59 60 61 62 63 64 65 66
		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
67
free_tuple(cfg_parser_t *pctx, cfg_obj_t *obj);
68

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

static void
73
print_list(cfg_printer_t *pctx, const cfg_obj_t *obj);
74 75

static void
76
free_list(cfg_parser_t *pctx, cfg_obj_t *obj);
77

78
static isc_result_t
79
create_listelt(cfg_parser_t *pctx, cfg_listelt_t **eltp);
80 81

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

static void
86
free_string(cfg_parser_t *pctx, cfg_obj_t *obj);
87

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

static void
92
free_map(cfg_parser_t *pctx, cfg_obj_t *obj);
93 94 95

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

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).
 */
114

115
cfg_rep_t cfg_rep_uint32 = { "uint32", free_noop };
116
cfg_rep_t cfg_rep_uint64 = { "uint64", free_noop };
117 118 119 120 121 122 123 124 125 126 127 128 129
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.
 */

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

/* Functions. */

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

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

static void
print_open(cfg_printer_t *pctx) {
150 151 152 153 154 155
	if ((pctx->flags & CFG_PRINTER_ONELINE) != 0)
		cfg_print_cstr(pctx, "{ ");
	else {
		cfg_print_cstr(pctx, "{\n");
		pctx->indent++;
	}
156 157 158 159 160
}

static void
print_indent(cfg_printer_t *pctx) {
	int indent = pctx->indent;
161 162 163 164
	if ((pctx->flags & CFG_PRINTER_ONELINE) != 0) {
		cfg_print_cstr(pctx, " ");
		return;
	}
165
	while (indent > 0) {
166
		cfg_print_cstr(pctx, "\t");
167 168 169 170 171 172
		indent--;
	}
}

static void
print_close(cfg_printer_t *pctx) {
173 174 175 176 177
	if ((pctx->flags & CFG_PRINTER_ONELINE) == 0) {
		pctx->indent--;
		print_indent(pctx);
	}
	cfg_print_cstr(pctx, "}");
178 179
}

180 181
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
182 183 184 185 186 187 188
	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);
189 190 191
}

void
192
cfg_print(const cfg_obj_t *obj,
193 194
	  void (*f)(void *closure, const char *text, int textlen),
	  void *closure)
195 196 197 198 199 200 201 202
{
	cfg_printx(obj, 0, f, closure);
}

void
cfg_printx(const cfg_obj_t *obj, unsigned int flags,
	     void (*f)(void *closure, const char *text, int textlen),
	     void *closure)
203 204 205 206 207
{
	cfg_printer_t pctx;
	pctx.f = f;
	pctx.closure = closure;
	pctx.indent = 0;
208
	pctx.flags = flags;
209 210 211
	obj->type->print(&pctx, obj);
}

212
/* Tuples. */
Automatic Updater's avatar
Automatic Updater committed
213

214 215
isc_result_t
cfg_create_tuple(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret) {
216
	isc_result_t result;
217 218
	const cfg_tuplefielddef_t *fields = type->of;
	const cfg_tuplefielddef_t *f;
219 220 221
	cfg_obj_t *obj = NULL;
	unsigned int nfields = 0;
	int i;
222

223
	for (f = fields; f->name != NULL; f++)
224 225
		nfields++;

226
	CHECK(cfg_create_obj(pctx, type, &obj));
227 228
	obj->value.tuple = isc_mem_get(pctx->mctx,
				       nfields * sizeof(cfg_obj_t *));
229 230 231 232
	if (obj->value.tuple == NULL) {
		result = ISC_R_NOMEMORY;
		goto cleanup;
	}
233
	for (f = fields, i = 0; f->name != NULL; f++, i++)
234
		obj->value.tuple[i] = NULL;
235 236 237 238
	*ret = obj;
	return (ISC_R_SUCCESS);

 cleanup:
239 240
	if (obj != NULL)
		isc_mem_put(pctx->mctx, obj, sizeof(*obj));
241 242 243
	return (result);
}

244 245
isc_result_t
cfg_parse_tuple(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret)
246 247
{
	isc_result_t result;
248 249
	const cfg_tuplefielddef_t *fields = type->of;
	const cfg_tuplefielddef_t *f;
250 251
	cfg_obj_t *obj = NULL;
	unsigned int i;
252

253
	CHECK(cfg_create_tuple(pctx, type, &obj));
254
	for (f = fields, i = 0; f->name != NULL; f++, i++)
255
		CHECK(cfg_parse_obj(pctx, f->type, &obj->value.tuple[i]));
256 257 258 259 260 261 262 263 264

	*ret = obj;
	return (ISC_R_SUCCESS);

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

265
void
266
cfg_print_tuple(cfg_printer_t *pctx, const cfg_obj_t *obj) {
267
	unsigned int i;
268 269
	const cfg_tuplefielddef_t *fields = obj->type->of;
	const cfg_tuplefielddef_t *f;
270
	isc_boolean_t need_space = ISC_FALSE;
271

272
	for (f = fields, i = 0; f->name != NULL; f++, i++) {
273
		const cfg_obj_t *fieldobj = obj->value.tuple[i];
274
		if (need_space)
275
			cfg_print_cstr(pctx, " ");
276 277 278 279 280 281 282 283 284 285 286 287 288
		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)
289
			cfg_print_cstr(pctx, " ");
290 291
		cfg_doc_obj(pctx, f->type);
		need_space = ISC_TF(f->type->print != cfg_print_void);
292 293 294 295 296 297
	}
}

static void
free_tuple(cfg_parser_t *pctx, cfg_obj_t *obj) {
	unsigned int i;
298 299
	const cfg_tuplefielddef_t *fields = obj->type->of;
	const cfg_tuplefielddef_t *f;
300 301
	unsigned int nfields = 0;

302 303 304
	if (obj->value.tuple == NULL)
		return;

305
	for (f = fields, i = 0; f->name != NULL; f++, i++) {
306 307 308 309 310 311 312
		CLEANUP_OBJ(obj->value.tuple[i]);
		nfields++;
	}
	isc_mem_put(pctx->mctx, obj->value.tuple,
		    nfields * sizeof(cfg_obj_t *));
}

313
isc_boolean_t
314
cfg_obj_istuple(const cfg_obj_t *obj) {
315 316 317 318
	REQUIRE(obj != NULL);
	return (ISC_TF(obj->type->rep == &cfg_rep_tuple));
}

319 320
const cfg_obj_t *
cfg_tuple_get(const cfg_obj_t *tupleobj, const char* name) {
321
	unsigned int i;
322 323
	const cfg_tuplefielddef_t *fields;
	const cfg_tuplefielddef_t *f;
Automatic Updater's avatar
Automatic Updater committed
324

325 326 327 328 329 330 331 332 333 334 335
	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);
}

336 337
isc_result_t
cfg_parse_special(cfg_parser_t *pctx, int special) {
Automatic Updater's avatar
Automatic Updater committed
338
	isc_result_t result;
339 340 341 342 343
	CHECK(cfg_gettoken(pctx, 0));
	if (pctx->token.type == isc_tokentype_special &&
	    pctx->token.value.as_char == special)
		return (ISC_R_SUCCESS);

344
	cfg_parser_error(pctx, CFG_LOG_NEAR, "'%c' expected", special);
345 346 347 348 349 350 351 352 353 354 355 356 357 358
	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) {
Automatic Updater's avatar
Automatic Updater committed
359
	isc_result_t result;
360 361 362 363 364
	CHECK(cfg_gettoken(pctx, 0));
	if (pctx->token.type == isc_tokentype_special &&
	    pctx->token.value.as_char == ';')
		return (ISC_R_SUCCESS);

365
	cfg_parser_error(pctx, CFG_LOG_BEFORE, "missing ';'");
366 367 368 369 370 371 372 373 374 375
	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) {
Automatic Updater's avatar
Automatic Updater committed
376
	isc_result_t result;
377 378 379 380 381
	CHECK(cfg_gettoken(pctx, 0));

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

382
	cfg_parser_error(pctx, CFG_LOG_NEAR, "syntax error");
383 384
	return (ISC_R_UNEXPECTEDTOKEN);
 cleanup:
Andreas Gustafsson's avatar
spacing  
Andreas Gustafsson committed
385
	return (result);
386 387 388
}

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

390
static cfg_type_t cfg_type_filelist = {
391
	"filelist", NULL, print_list, NULL, &cfg_rep_list,
392 393 394 395
	&cfg_type_qstring
};

isc_result_t
396
cfg_parser_create(isc_mem_t *mctx, isc_log_t *lctx, cfg_parser_t **ret) {
397 398 399 400 401 402 403 404 405 406 407
	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);

408 409 410
	pctx->mctx = NULL;
	isc_mem_attach(mctx, &pctx->mctx);

411 412
	result = isc_refcount_init(&pctx->references, 1);
	if (result != ISC_R_SUCCESS) {
413
		isc_mem_putanddetach(&pctx->mctx, pctx, sizeof(*pctx));
414 415 416
		return (result);
	}

417 418 419 420 421
	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
422
	pctx->warnings = 0;
423 424
	pctx->open_files = NULL;
	pctx->closed_files = NULL;
425
	pctx->line = 0;
426 427
	pctx->callback = NULL;
	pctx->callbackarg = NULL;
Mark Andrews's avatar
Mark Andrews committed
428
	pctx->token.type = isc_tokentype_unknown;
Automatic Updater's avatar
Automatic Updater committed
429
	pctx->flags = 0;
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445

	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));

446 447
	CHECK(cfg_create_list(pctx, &cfg_type_filelist, &pctx->open_files));
	CHECK(cfg_create_list(pctx, &cfg_type_filelist, &pctx->closed_files));
448 449 450 451 452 453 454

	*ret = pctx;
	return (ISC_R_SUCCESS);

 cleanup:
	if (pctx->lexer != NULL)
		isc_lex_destroy(&pctx->lexer);
455 456
	CLEANUP_OBJ(pctx->open_files);
	CLEANUP_OBJ(pctx->closed_files);
457
	isc_mem_putanddetach(&pctx->mctx, pctx, sizeof(*pctx));
458 459 460 461
	return (result);
}

static isc_result_t
462
parser_openfile(cfg_parser_t *pctx, const char *filename) {
463 464 465 466 467 468
	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) {
469
		cfg_parser_error(pctx, 0, "open: %s: %s",
470 471 472 473 474 475 476
			     filename, isc_result_totext(result));
		goto cleanup;
	}

	CHECK(create_string(pctx, filename, &cfg_type_qstring, &stringobj));
	CHECK(create_listelt(pctx, &elt));
	elt->obj = stringobj;
477
	ISC_LIST_APPEND(pctx->open_files->value.list, elt, link);
478 479 480 481 482 483 484

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

485 486 487 488 489 490 491 492 493
void
cfg_parser_setcallback(cfg_parser_t *pctx,
		       cfg_parsecallback_t callback,
		       void *arg)
{
	pctx->callback = callback;
	pctx->callbackarg = arg;
}

494 495 496 497 498 499 500 501 502 503 504 505 506 507
void
cfg_parser_reset(cfg_parser_t *pctx) {
	REQUIRE(pctx != NULL);

	if (pctx->lexer != NULL)
		isc_lex_close(pctx->lexer);

	pctx->seen_eof = ISC_FALSE;
	pctx->ungotten = ISC_FALSE;
	pctx->errors = 0;
	pctx->warnings = 0;
	pctx->line = 0;
}

508 509 510 511 512
/*
 * Parse a configuration using a pctx where a lexer has already
 * been set up with a source.
 */
static isc_result_t
513
parse2(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret) {
514 515 516
	isc_result_t result;
	cfg_obj_t *obj = NULL;

517
	result = cfg_parse_obj(pctx, type, &obj);
518 519 520 521 522 523 524 525 526 527

	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. */
528
		cfg_parser_error(pctx, 0, "parsing failed");
529 530 531 532 533 534 535 536 537 538 539 540 541
		goto cleanup;
	}

	CHECK(parse_eof(pctx));

	*ret = obj;
	return (ISC_R_SUCCESS);

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

542 543
isc_result_t
cfg_parse_file(cfg_parser_t *pctx, const char *filename,
544
	       const cfg_type_t *type, cfg_obj_t **ret)
545 546 547 548 549 550 551 552 553 554 555 556 557 558
{
	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,
559
	const cfg_type_t *type, cfg_obj_t **ret)
560 561
{
	isc_result_t result;
562

563
	REQUIRE(buffer != NULL);
564

Automatic Updater's avatar
Automatic Updater committed
565
	CHECK(isc_lex_openbuffer(pctx->lexer, buffer));
566
	CHECK(parse2(pctx, type, ret));
567

568 569 570 571
 cleanup:
	return (result);
}

572 573 574 575 576 577 578 579
void
cfg_parser_attach(cfg_parser_t *src, cfg_parser_t **dest) {
	REQUIRE(src != NULL);
	REQUIRE(dest != NULL && *dest == NULL);
	isc_refcount_increment(&src->references, NULL);
	*dest = src;
}

580 581 582
void
cfg_parser_destroy(cfg_parser_t **pctxp) {
	cfg_parser_t *pctx = *pctxp;
583 584 585 586 587 588 589 590 591 592 593 594
	unsigned int refs;

	isc_refcount_decrement(&pctx->references, &refs);
	if (refs == 0) {
		isc_lex_destroy(&pctx->lexer);
		/*
		 * 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);
595
		isc_mem_putanddetach(&pctx->mctx, pctx, sizeof(*pctx));
596
	}
597 598 599 600 601 602
	*pctxp = NULL;
}

/*
 * void
 */
603 604
isc_result_t
cfg_parse_void(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret) {
605
	UNUSED(type);
606
	return (cfg_create_obj(pctx, &cfg_type_void, ret));
607 608
}

609
void
610
cfg_print_void(cfg_printer_t *pctx, const cfg_obj_t *obj) {
611 612 613
	UNUSED(pctx);
	UNUSED(obj);
}
614

615 616 617 618 619 620
void
cfg_doc_void(cfg_printer_t *pctx, const cfg_type_t *type) {
	UNUSED(pctx);
	UNUSED(type);
}

621
isc_boolean_t
622
cfg_obj_isvoid(const cfg_obj_t *obj) {
623 624 625 626
	REQUIRE(obj != NULL);
	return (ISC_TF(obj->type->rep == &cfg_rep_void));
}

627 628 629
cfg_type_t cfg_type_void = {
	"void", cfg_parse_void, cfg_print_void, cfg_doc_void, &cfg_rep_void,
	NULL };
630 631 632 633 634


/*
 * uint32
 */
635 636
isc_result_t
cfg_parse_uint32(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret) {
Automatic Updater's avatar
Automatic Updater committed
637
	isc_result_t result;
638 639 640
	cfg_obj_t *obj = NULL;
	UNUSED(type);

641
	CHECK(cfg_gettoken(pctx, ISC_LEXOPT_NUMBER | ISC_LEXOPT_CNUMBER));
642
	if (pctx->token.type != isc_tokentype_number) {
643
		cfg_parser_error(pctx, CFG_LOG_NEAR, "expected number");
644 645 646
		return (ISC_R_UNEXPECTEDTOKEN);
	}

647
	CHECK(cfg_create_obj(pctx, &cfg_type_uint32, &obj));
648 649 650 651 652 653 654

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

655 656 657
void
cfg_print_cstr(cfg_printer_t *pctx, const char *s) {
	cfg_print_chars(pctx, s, strlen(s));
658 659
}

660 661
void
cfg_print_rawuint(cfg_printer_t *pctx, unsigned int u) {
662
	char buf[32];
663
	snprintf(buf, sizeof(buf), "%u", u);
664
	cfg_print_cstr(pctx, buf);
665 666
}

667
void
668
cfg_print_uint32(cfg_printer_t *pctx, const cfg_obj_t *obj) {
669
	cfg_print_rawuint(pctx, obj->value.uint32);
670 671
}

672
isc_boolean_t
673
cfg_obj_isuint32(const cfg_obj_t *obj) {
674 675 676 677
	REQUIRE(obj != NULL);
	return (ISC_TF(obj->type->rep == &cfg_rep_uint32));
}

678
isc_uint32_t
679
cfg_obj_asuint32(const cfg_obj_t *obj) {
680 681 682 683
	REQUIRE(obj != NULL && obj->type->rep == &cfg_rep_uint32);
	return (obj->value.uint32);
}

684 685 686 687
cfg_type_t cfg_type_uint32 = {
	"integer", cfg_parse_uint32, cfg_print_uint32, cfg_doc_terminal,
	&cfg_rep_uint32, NULL
};
688 689


690 691 692 693
/*
 * uint64
 */
isc_boolean_t
694
cfg_obj_isuint64(const cfg_obj_t *obj) {
695 696 697 698 699
	REQUIRE(obj != NULL);
	return (ISC_TF(obj->type->rep == &cfg_rep_uint64));
}

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

705
void
706
cfg_print_uint64(cfg_printer_t *pctx, const cfg_obj_t *obj) {
707
	char buf[32];
708 709
	snprintf(buf, sizeof(buf), "%" ISC_PRINT_QUADFORMAT "u",
		 obj->value.uint64);
710
	cfg_print_cstr(pctx, buf);
711 712
}

713 714 715
cfg_type_t cfg_type_uint64 = {
	"64_bit_integer", NULL, cfg_print_uint64, cfg_doc_terminal,
	&cfg_rep_uint64, NULL
716 717
};

718
/*
719 720
 * qstring (quoted string), ustring (unquoted string), astring
 * (any string)
721 722 723 724
 */

/* Create a string object from a null-terminated C string. */
static isc_result_t
725
create_string(cfg_parser_t *pctx, const char *contents, const cfg_type_t *type,
726 727 728 729 730 731
	      cfg_obj_t **ret)
{
	isc_result_t result;
	cfg_obj_t *obj = NULL;
	int len;

732
	CHECK(cfg_create_obj(pctx, type, &obj));
733 734 735 736
	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) {
737
		isc_mem_put(pctx->mctx, obj, sizeof(*obj));
738 739
		return (ISC_R_NOMEMORY);
	}
740
	memmove(obj->value.string.base, contents, len);
741 742 743 744 745 746 747
	obj->value.string.base[len] = '\0';

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

748 749
isc_result_t
cfg_parse_qstring(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret) {
Automatic Updater's avatar
Automatic Updater committed
750
	isc_result_t result;
751 752
	UNUSED(type);

753
	CHECK(cfg_gettoken(pctx, CFG_LEXOPT_QSTRING));
754
	if (pctx->token.type != isc_tokentype_qstring) {
755
		cfg_parser_error(pctx, CFG_LOG_NEAR, "expected quoted string");
756 757 758
		return (ISC_R_UNEXPECTEDTOKEN);
	}
	return (create_string(pctx,
759
			      TOKEN_STRING(pctx),
760 761 762 763 764 765 766
			      &cfg_type_qstring,
			      ret));
 cleanup:
	return (result);
}

static isc_result_t
767
parse_ustring(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret) {
Automatic Updater's avatar
Automatic Updater committed
768
	isc_result_t result;
769 770 771 772
	UNUSED(type);

	CHECK(cfg_gettoken(pctx, 0));
	if (pctx->token.type != isc_tokentype_string) {
773
		cfg_parser_error(pctx, CFG_LOG_NEAR, "expected unquoted string");
774 775 776
		return (ISC_R_UNEXPECTEDTOKEN);
	}
	return (create_string(pctx,
777
			      TOKEN_STRING(pctx),
778 779 780 781 782 783
			      &cfg_type_ustring,
			      ret));
 cleanup:
	return (result);
}

784
isc_result_t
785 786 787
cfg_parse_astring(cfg_parser_t *pctx, const cfg_type_t *type,
		  cfg_obj_t **ret)
{
Automatic Updater's avatar
Automatic Updater committed
788
	isc_result_t result;
789 790 791 792
	UNUSED(type);

	CHECK(cfg_getstringtoken(pctx));
	return (create_string(pctx,
793
			      TOKEN_STRING(pctx),
794 795 796 797 798 799
			      &cfg_type_qstring,
			      ret));
 cleanup:
	return (result);
}

800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
isc_result_t
cfg_parse_sstring(cfg_parser_t *pctx, const cfg_type_t *type,
		  cfg_obj_t **ret)
{
	isc_result_t result;
	UNUSED(type);

	CHECK(cfg_getstringtoken(pctx));
	return (create_string(pctx,
			      TOKEN_STRING(pctx),
			      &cfg_type_sstring,
			      ret));
 cleanup:
	return (result);
}

816 817
isc_boolean_t
cfg_is_enum(const char *s, const char *const *enums) {
818
	const char * const *p;
Andreas Gustafsson's avatar
Andreas Gustafsson committed
819 820
	for (p = enums; *p != NULL; p++) {
		if (strcasecmp(*p, s) == 0)
821
			return (ISC_TRUE);
Andreas Gustafsson's avatar
Andreas Gustafsson committed
822
	}
823 824 825 826
	return (ISC_FALSE);
}

static isc_result_t
827
check_enum(cfg_parser_t *pctx, cfg_obj_t *obj, const char *const *enums) {
828
	const char *s = obj->value.string.base;
829
	if (cfg_is_enum(s, enums))
830
		return (ISC_R_SUCCESS);
831
	cfg_parser_error(pctx, 0, "'%s' unexpected", s);
Andreas Gustafsson's avatar
Andreas Gustafsson committed
832 833 834
	return (ISC_R_UNEXPECTEDTOKEN);
}

835 836
isc_result_t
cfg_parse_enum(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret) {
Automatic Updater's avatar
Automatic Updater committed
837
	isc_result_t result;
Andreas Gustafsson's avatar
Andreas Gustafsson committed
838 839 840 841 842 843
	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:
Automatic Updater's avatar
Automatic Updater committed
844
	CLEANUP_OBJ(obj);
Andreas Gustafsson's avatar
Andreas Gustafsson committed
845 846 847
	return (result);
}

848 849 850
void
cfg_doc_enum(cfg_printer_t *pctx, const cfg_type_t *type) {
	const char * const *p;
851
	cfg_print_cstr(pctx, "( ");
852 853 854
	for (p = type->of; *p != NULL; p++) {
		cfg_print_cstr(pctx, *p);
		if (p[1] != NULL)
855
			cfg_print_cstr(pctx, " | ");
856
	}
857
	cfg_print_cstr(pctx, " )");
858 859
}

860
void
861
cfg_print_ustring(cfg_printer_t *pctx, const cfg_obj_t *obj) {
862
	cfg_print_chars(pctx, obj->value.string.base, obj->value.string.length);
863 864 865
}

static void
866
print_qstring(cfg_printer_t *pctx, const cfg_obj_t *obj) {
867
	cfg_print_cstr(pctx, "\"");
868
	cfg_print_ustring(pctx, obj);
869
	cfg_print_cstr(pctx, "\"");
870 871
}

872 873
static void
print_sstring(cfg_printer_t *pctx, const cfg_obj_t *obj) {
874
	cfg_print_cstr(pctx, "\"");
875 876 877
	if ((pctx->flags & CFG_PRINTER_XKEY) != 0) {
		unsigned int len = obj->value.string.length;
		while (len-- > 0)
878
			cfg_print_cstr(pctx, "?");
879 880
	} else
		cfg_print_ustring(pctx, obj);
881
	cfg_print_cstr(pctx, "\"");
882 883
}

884 885
static void
free_string(cfg_parser_t *pctx, cfg_obj_t *obj) {
886 887
	isc_mem_put(pctx->mctx, obj->value.string.base,
		    obj->value.string.length + 1);
888 889
}

890
isc_boolean_t
891
cfg_obj_isstring(const cfg_obj_t *obj) {
892 893 894 895
	REQUIRE(obj != NULL);
	return (ISC_TF(obj->type->rep == &cfg_rep_string));
}

896
const char *
897
cfg_obj_asstring(const cfg_obj_t *obj) {
898 899 900 901
	REQUIRE(obj != NULL && obj->type->rep == &cfg_rep_string);
	return (obj->value.string.base);
}

902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919
/* 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
};

920 921 922 923 924 925 926 927 928
/*
 * Any string (quoted or unquoted); printed with quotes.
 * If CFG_PRINTER_XKEY is set when printing the string will be '?' out.
 */
cfg_type_t cfg_type_sstring = {
	"string", cfg_parse_sstring, print_sstring, cfg_doc_terminal,
	&cfg_rep_string, NULL
};

929 930 931 932
/*
 * Booleans
 */

933
isc_boolean_t
934
cfg_obj_isboolean(const cfg_obj_t *obj) {
935 936 937 938
	REQUIRE(obj != NULL);
	return (ISC_TF(obj->type->rep == &cfg_rep_boolean));
}

Brian Wellington's avatar
Brian Wellington committed
939
isc_boolean_t
940
cfg_obj_asboolean(const cfg_obj_t *obj) {
Brian Wellington's avatar
Brian Wellington committed
941 942 943 944
	REQUIRE(obj != NULL && obj->type->rep == &cfg_rep_boolean);
	return (obj->value.boolean);
}

945 946
isc_result_t
cfg_parse_boolean(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **ret)
947
{
Automatic Updater's avatar
Automatic Updater committed
948
	isc_result_t result;
949 950 951 952 953 954 955 956 957
	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)
958
		goto bad_boolean;
959

960 961 962
	if ((strcasecmp(TOKEN_STRING(pctx), "true") == 0) ||
	    (strcasecmp(TOKEN_STRING(pctx), "yes") == 0) ||
	    (strcmp(TOKEN_STRING(pctx), "1") == 0)) {
963
		value = ISC_TRUE;
964 965 966
	} else if ((strcasecmp(TOKEN_STRING(pctx), "false") == 0) ||
		   (strcasecmp(TOKEN_STRING(pctx), "no") == 0) ||
		   (strcmp(TOKEN_STRING(pctx), "0") == 0)) {
967 968 969 970 971
		value = ISC_FALSE;
	} else {
		goto bad_boolean;
	}

972
	CHECK(cfg_create_obj(pctx, &cfg_type_boolean, &obj));
973 974 975 976 977
	obj->value.boolean = value;
	*ret = obj;
	return (result);

 bad_boolean:
978
	cfg_parser_error(pctx, CFG_LOG_NEAR, "boolean expected");
979 980 981 982 983 984
	return (ISC_R_UNEXPECTEDTOKEN);

 cleanup:
	return (result);
}

985 986
void
cfg_print_boolean(cfg_printer_t *pctx, const cfg_obj_t *obj) {
987
	if (obj->value.boolean)
988
		cfg_print_cstr(pctx, "yes");
989
	else
990
		cfg_print_cstr(pctx, "no");
Andreas Gustafsson's avatar
Andreas Gustafsson committed
991
}
992

993
cfg_type_t cfg_type_boolean = {
994
	"boolean", cfg_parse_boolean, cfg_print_boolean, cfg_doc_terminal,
995
	&cfg_rep_boolean, NULL
996 997
};

998
/*
999
 * Lists.
1000 1001
 */

1002 1003
isc_result_t
cfg_create_list(cfg_parser_t *pctx, const cfg_type_t *type, cfg_obj_t **obj) {
1004
	isc_result_t result;
1005
	CHECK(cfg_create_obj(pctx, type, obj));
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
	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);
}

1023
static void
1024 1025 1026
free_listelt(cfg_parser_t *pctx, cfg_listelt_t *elt) {
	if (