2 * Master Configuration routines.
4 * This file contains the common parts of the Bacula
5 * configuration routines.
7 * Note, the configuration file parser consists of three parts
9 * 1. The generic lexical scanner in lib/lex.c and lib/lex.h
11 * 2. The generic config scanner in lib/parse_conf.c and
13 * These files contain the parser code, some utility
14 * routines, and the common store routines (name, int,
17 * 3. The daemon specific file, which contains the Resource
18 * definitions as well as any specific store routines
19 * for the resource records.
21 * N.B. This is a two pass parser, so if you malloc() a string
22 * in a "store" routine, you must ensure to do it during
23 * only one of the two passes, or to free it between.
24 * Also, note that the resource record is malloced and
25 * saved in save_resource() during pass 1. Anything that
26 * you want saved after pass two (e.g. resource pointers)
27 * must explicitly be done in save_resource. Take a look
28 * at the Job resource in src/dird/dird_conf.c to see how
31 * Kern Sibbald, January MM
37 Copyright (C) 2000, 2001, 2002 Kern Sibbald and John Walker
39 This program is free software; you can redistribute it and/or
40 modify it under the terms of the GNU General Public License as
41 published by the Free Software Foundation; either version 2 of
42 the License, or (at your option) any later version.
44 This program is distributed in the hope that it will be useful,
45 but WITHOUT ANY WARRANTY; without even the implied warranty of
46 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
47 General Public License for more details.
49 You should have received a copy of the GNU General Public
50 License along with this program; if not, write to the Free
51 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
59 extern int debug_level;
61 /* Each daemon has a slightly different set of
62 * resources, so it will define the following
67 extern pthread_mutex_t res_mutex;
68 extern struct s_res resources[];
70 extern int res_all_size;
72 static int res_locked = 0; /* set when resource chains locked */
74 /* Forward referenced subroutines */
75 static void scan_types(LEX *lc, MSGS *msg, int dest, char *where, char *cmd);
78 /* Common Resource definitions */
80 /* Message resource directives
81 * name handler value code flags default_value
83 struct res_items msgs_items[] = {
84 {"name", store_name, ITEM(res_msgs.hdr.name), 0, 0, 0},
85 {"description", store_str, ITEM(res_msgs.hdr.desc), 0, 0, 0},
86 {"mailcommand", store_str, ITEM(res_msgs.mail_cmd), 0, 0, 0},
87 {"operatorcommand", store_str, ITEM(res_msgs.operator_cmd), 0, 0, 0},
88 {"syslog", store_msgs, ITEM(res_msgs), MD_SYSLOG, 0, 0},
89 {"mail", store_msgs, ITEM(res_msgs), MD_MAIL, 0, 0},
90 {"mailonerror", store_msgs, ITEM(res_msgs), MD_MAIL_ON_ERROR, 0, 0},
91 {"file", store_msgs, ITEM(res_msgs), MD_FILE, 0, 0},
92 {"append", store_msgs, ITEM(res_msgs), MD_APPEND, 0, 0},
93 {"stdout", store_msgs, ITEM(res_msgs), MD_STDOUT, 0, 0},
94 {"stderr", store_msgs, ITEM(res_msgs), MD_STDERR, 0, 0},
95 {"director", store_msgs, ITEM(res_msgs), MD_DIRECTOR, 0, 0},
96 {"console", store_msgs, ITEM(res_msgs), MD_CONSOLE, 0, 0},
97 {"operator", store_msgs, ITEM(res_msgs), MD_OPERATOR, 0, 0},
105 /* Various message types */
106 static struct s_mtypes msg_types[] = {
111 {"warning", M_WARNING},
114 {"notsaved", M_NOTSAVED},
115 {"skipped", M_SKIPPED},
117 {"terminate", M_TERM},
123 /* Simply print a message */
124 static void prtmsg(void *sock, char *fmt, ...)
128 va_start(arg_ptr, fmt);
129 vfprintf(stdout, fmt, arg_ptr);
134 char *res_to_str(int rcode)
136 if (rcode < r_first || rcode > r_last) {
137 return "***UNKNOWN***";
139 return resources[rcode-r_first].name;
146 * Initialize the static structure to zeros, then
147 * apply all the default values.
149 void init_resource(int type, struct res_items *items)
152 int rindex = type - r_first;
154 memset(&res_all, 0, res_all_size);
155 res_all.hdr.rcode = type;
156 res_all.hdr.refcnt = 1;
158 for (i=0; items[i].name; i++) {
159 Dmsg3(300, "Item=%s def=%s defval=%d\n", items[i].name,
160 (items[i].flags & ITEM_DEFAULT) ? "yes" : "no",
161 items[i].default_value);
162 if (items[i].flags & ITEM_DEFAULT && items[i].default_value != 0) {
163 if (items[i].handler == store_yesno) {
164 *(int *)(items[i].value) |= items[i].code;
165 } else if (items[i].handler == store_pint ||
166 items[i].handler == store_int) {
167 *(int *)(items[i].value) = items[i].default_value;
168 } else if (items[i].handler == store_int64) {
169 *(int64_t *)(items[i].value) = items[i].default_value;
170 } else if (items[i].handler == store_size ||
171 items[i].handler == store_time) {
172 *(uint64_t *)(items[i].value) = items[i].default_value;
175 /* If this triggers, take a look at lib/parse_conf.h */
176 if (i >= MAX_RES_ITEMS) {
177 Emsg1(M_ERROR_TERM, 0, _("Too many items in %s resource\n"), resources[rindex]);
183 /* Store Messages Destination information */
184 void store_msgs(LEX *lc, struct res_items *item, int index, int pass)
191 Dmsg2(200, "store_msgs pass=%d code=%d\n", pass, item->code);
193 switch (item->code) {
196 case MD_SYSLOG: /* syslog */
198 scan_types(lc, (MSGS *)(item->value), item->code, NULL, NULL);
200 case MD_OPERATOR: /* send to operator */
201 case MD_DIRECTOR: /* send to Director */
202 case MD_MAIL: /* mail */
203 case MD_MAIL_ON_ERROR: /* mail if Job errors */
204 if (item->code == MD_OPERATOR) {
205 cmd = res_all.res_msgs.operator_cmd;
207 cmd = res_all.res_msgs.mail_cmd;
209 dest = get_pool_memory(PM_MESSAGE);
212 /* Pick up comma separated list of destinations */
214 token = lex_get_token(lc, T_NAME); /* scan destination */
215 dest = (char *) check_pool_memory_size(dest, dest_len + lc->str_len + 2);
217 strcat(dest, " "); /* separate multiple destinations with space */
220 strcat(dest, lc->str);
221 dest_len += lc->str_len;
222 Dmsg2(100, "store_msgs newdest=%s: dest=%s:\n", lc->str, NPRT(dest));
223 token = lex_get_token(lc, T_ALL);
224 if (token == T_COMMA) {
225 continue; /* get another destination */
227 if (token != T_EQUALS) {
228 scan_err1(lc, "expected an =, got: %s", lc->str);
232 Dmsg1(200, "mail_cmd=%s\n", NPRT(cmd));
233 scan_types(lc, (MSGS *)(item->value), item->code, dest, cmd);
234 free_pool_memory(dest);
235 Dmsg0(200, "done with dest codes\n");
237 case MD_FILE: /* file */
238 case MD_APPEND: /* append */
239 dest = get_pool_memory(PM_MESSAGE);
240 /* Pick up a single destination */
241 token = lex_get_token(lc, T_NAME); /* scan destination */
242 dest = check_pool_memory_size(dest, dest_len + lc->str_len + 2);
243 strcpy(dest, lc->str);
244 dest_len = lc->str_len;
245 token = lex_get_token(lc, T_ALL);
246 Dmsg1(200, "store_msgs dest=%s:\n", NPRT(dest));
247 if (token != T_EQUALS) {
248 scan_err1(lc, "expected an =, got: %s", lc->str);
250 scan_types(lc, (MSGS *)(item->value), item->code, dest, NULL);
251 free_pool_memory(dest);
252 Dmsg0(200, "done with dest codes\n");
256 scan_err1(lc, "Unknown item code: %d\n", item->code);
261 set_bit(index, res_all.hdr.item_present);
262 Dmsg0(200, "Done store_msgs\n");
266 * Scan for message types and add them to the message
267 * destination. The basic job here is to connect message types
268 * (WARNING, ERROR, FATAL, INFO, ...) with an appropriate
269 * destination (MAIL, FILE, OPERATOR, ...)
271 static void scan_types(LEX *lc, MSGS *msg, int dest_code, char *where, char *cmd)
273 int token, i, found, quit, is_not;
277 for (quit=0; !quit;) {
278 token = lex_get_token(lc, T_NAME); /* expect at least one type */
280 if (lc->str[0] == '!') {
287 for (i=0; msg_types[i].name; i++) {
288 if (strcmp(str, msg_types[i].name) == 0) {
289 msg_type = msg_types[i].token;
295 scan_err1(lc, "message type: %s not found", str);
298 if (msg_type == M_MAX+1) { /* all? */
299 for (i=1; i<=M_MAX; i++) { /* yes set all types */
300 add_msg_dest(msg, dest_code, i, where, cmd);
304 rem_msg_dest(msg, dest_code, msg_type, where);
306 add_msg_dest(msg, dest_code, msg_type, where, cmd);
312 Dmsg0(200, "call lex_get_token() to eat comma\n");
313 token = lex_get_token(lc, T_ALL); /* eat comma */
315 Dmsg0(200, "Done scan_types()\n");
320 * This routine is ONLY for resource names
321 * Store a name at specified address.
323 void store_name(LEX *lc, struct res_items *item, int index, int pass)
327 token = lex_get_token(lc, T_NAME);
328 /* Store the name both pass 1 and pass 2 */
329 *(item->value) = bstrdup(lc->str);
331 set_bit(index, res_all.hdr.item_present);
336 * Store a name string at specified address
337 * A name string is limited to MAX_RES_NAME_LENGTH
339 void store_strname(LEX *lc, struct res_items *item, int index, int pass)
343 token = lex_get_token(lc, T_NAME);
346 *(item->value) = bstrdup(lc->str);
349 set_bit(index, res_all.hdr.item_present);
354 /* Store a string at specified address */
355 void store_str(LEX *lc, struct res_items *item, int index, int pass)
359 token = lex_get_token(lc, T_STRING);
361 *(item->value) = bstrdup(lc->str);
364 set_bit(index, res_all.hdr.item_present);
367 /* Store a directory name at specified address */
368 void store_dir(LEX *lc, struct res_items *item, int index, int pass)
372 token = lex_get_token(lc, T_STRING);
374 do_shell_expansion(lc->str);
375 *(item->value) = bstrdup(lc->str);
378 set_bit(index, res_all.hdr.item_present);
382 /* Store a password specified address in MD5 coding */
383 void store_password(LEX *lc, struct res_items *item, int index, int pass)
385 unsigned int token, i, j;
386 struct MD5Context md5c;
387 unsigned char signature[16];
391 token = lex_get_token(lc, T_STRING);
394 MD5Update(&md5c, (unsigned char *) (lc->str), lc->str_len);
395 MD5Final(signature, &md5c);
396 for (i = j = 0; i < sizeof(signature); i++) {
397 sprintf(&sig[j], "%02x", signature[i]);
400 *(item->value) = bstrdup(sig);
403 set_bit(index, res_all.hdr.item_present);
407 /* Store a resource at specified address.
408 * If we are in pass 2, do a lookup of the
411 void store_res(LEX *lc, struct res_items *item, int index, int pass)
416 token = lex_get_token(lc, T_NAME);
418 res = GetResWithName(item->code, lc->str);
420 scan_err3(lc, "Could not find Resource %s referenced on line %d : %s\n",
421 lc->str, lc->line_no, lc->line);
423 *(item->value) = (char *)res;
426 set_bit(index, res_all.hdr.item_present);
430 /* Store an integer at specified address */
431 void store_int(LEX *lc, struct res_items *item, int index, int pass)
435 token = lex_get_token(lc, T_INT32);
436 *(int *)(item->value) = lc->int32_val;
438 set_bit(index, res_all.hdr.item_present);
441 /* Store a positive integer at specified address */
442 void store_pint(LEX *lc, struct res_items *item, int index, int pass)
446 token = lex_get_token(lc, T_PINT32);
447 *(int *)(item->value) = lc->pint32_val;
449 set_bit(index, res_all.hdr.item_present);
453 /* Store an 64 bit integer at specified address */
454 void store_int64(LEX *lc, struct res_items *item, int index, int pass)
458 token = lex_get_token(lc, T_INT64);
459 *(int64_t *)(item->value) = lc->int64_val;
461 set_bit(index, res_all.hdr.item_present);
464 /* Store a size in bytes */
465 void store_size(LEX *lc, struct res_items *item, int index, int pass)
469 int mod[] = {'*', 'k', 'm', 'g', 0}; /* first item * not used */
470 uint64_t mult[] = {1, /* byte */
472 1048576, /* megabyte */
473 1073741824}; /* gigabyte */
475 #ifdef we_have_a_compiler_that_works
476 int mod[] = {'*', 'k', 'm', 'g', 't', 0};
477 uint64_t mult[] = {1, /* byte */
479 1048576, /* megabyte */
480 1073741824, /* gigabyte */
481 1099511627776};/* terabyte */
484 Dmsg0(400, "Enter store_size\n");
485 token = lex_get_token(lc, T_ALL);
489 Dmsg2(400, "size num=:%s: %f\n", lc->str, strtod(lc->str, NULL));
490 value = (uint64_t)strtod(lc->str, NULL);
491 if (errno != 0 || token < 0) {
492 scan_err1(lc, "expected a size number, got: %s", lc->str);
494 *(uint64_t *)(item->value) = value;
497 case T_UNQUOTED_STRING:
498 /* Look for modifier */
499 ch = lc->str[lc->str_len - 1];
505 while (mod[++i] != 0) {
508 lc->str[lc->str_len] = 0; /* strip modifier */
513 if (mod[i] == 0 || !is_a_number(lc->str)) {
514 scan_err1(lc, "expected a size number, got: %s", lc->str);
516 Dmsg3(400, "size str=:%s: %f i=%d\n", lc->str, strtod(lc->str, NULL), i);
518 value = (uint64_t)strtod(lc->str, NULL);
519 Dmsg1(400, "Int value = %d\n", (int)value);
520 if (errno != 0 || value < 0) {
521 scan_err1(lc, "expected a size number, got: %s", lc->str);
523 *(uint64_t *)(item->value) = value * mult[i];
524 Dmsg2(400, "Full value = %f %" lld "\n", strtod(lc->str, NULL) * mult[i],
528 scan_err1(lc, "expected a size, got: %s", lc->str);
532 set_bit(index, res_all.hdr.item_present);
533 Dmsg0(400, "Leave store_size\n");
537 /* Store a time period in seconds */
538 void store_time(LEX *lc, struct res_items *item, int index, int pass)
543 token = lex_get_token(lc, T_ALL);
547 value = (btime_t)strtod(lc->str, NULL);
548 if (errno != 0 || value < 0) {
549 scan_err1(lc, "expected a time period, got: %s", lc->str);
551 *(btime_t *)(item->value) = value;
554 case T_UNQUOTED_STRING:
555 if (!string_to_btime(lc->str, &value)) {
556 scan_err1(lc, "expected a time period, got: %s", lc->str);
558 *(btime_t *)(item->value) = value;
561 scan_err1(lc, "expected a time period, got: %s", lc->str);
565 set_bit(index, res_all.hdr.item_present);
569 /* Store a yes/no in a bit field */
570 void store_yesno(LEX *lc, struct res_items *item, int index, int pass)
574 token = lex_get_token(lc, T_NAME);
575 if (strcasecmp(lc->str, "yes") == 0) {
576 *(int *)(item->value) |= item->code;
577 } else if (strcasecmp(lc->str, "no") == 0) {
578 *(int *)(item->value) &= ~(item->code);
580 scan_err1(lc, "Expect a YES or NO, got: %s", lc->str);
583 set_bit(index, res_all.hdr.item_present);
601 * Return resource of type rcode that matches name
604 GetResWithName(int rcode, char *name)
607 int rindex = rcode - r_first;
610 res = resources[rindex].res_head;
612 if (strcmp(res->name, name) == 0) {
623 * Return next resource of type rcode. On first
624 * call second arg (res) is NULL, on subsequent
625 * calls, it is called with previous value.
628 GetNextRes(int rcode, RES *res)
631 int rindex = rcode - r_first;
635 Emsg0(M_ABORT, 0, "Resource chain not locked.\n");
638 nres = resources[rindex].res_head;
652 /*********************************************************************
654 * Parse configuration file
658 parse_config(char *cf)
661 int token, i, res_type, pass;
662 enum parse_state state = p_none;
663 struct res_items *items;
666 /* Make two passes. The first builds the name symbol table,
667 * and the second picks up the items.
669 Dmsg0(200, "Enter parse_config()\n");
670 for (pass=1; pass <= 2; pass++) {
671 Dmsg1(200, "parse_config pass %d\n", pass);
672 lc = lex_open_file(lc, cf, NULL);
673 while ((token=lex_get_token(lc, T_ALL)) != T_EOF) {
674 Dmsg1(150, "parse got token=%s\n", lex_tok_to_str(token));
677 if (token == T_EOL) {
680 if (token != T_IDENTIFIER) {
681 scan_err1(lc, "Expected a Resource name identifier, got: %s", lc->str);
683 for (i=0; resources[i].name; i++)
684 if (strcasecmp(resources[i].name, lc->str) == 0) {
686 items = resources[i].items;
687 res_type = resources[i].rcode;
688 init_resource(res_type, items);
691 if (state == p_none) {
692 scan_err1(lc, "expected resource name, got: %s", lc->str);
702 scan_err1(lc, "not in resource definition: %s", lc->str);
704 for (i=0; items[i].name; i++) {
705 if (strcasecmp(items[i].name, lc->str) == 0) {
706 token = lex_get_token(lc, T_ALL);
707 Dmsg1 (150, "in T_IDENT got token=%s\n", lex_tok_to_str(token));
708 if (token != T_EQUALS) {
709 scan_err1(lc, "expected an equals, got: %s", lc->str);
711 Dmsg1(150, "calling handler for %s\n", items[i].name);
712 /* Call item handler */
713 items[i].handler(lc, &items[i], i, pass);
719 Dmsg2(150, "level=%d id=%s\n", level, lc->str);
720 Dmsg1(150, "Keyword = %s\n", lc->str);
721 scan_err1(lc, "Keyword %s not permitted in this resource", lc->str);
728 Dmsg0(150, "T_EOB => define new resource\n");
729 save_resource(res_type, items, pass); /* save resource */
736 scan_err2(lc, "unexpected token %d %s in resource definition",
737 token, lex_tok_to_str(token));
741 scan_err1(lc, "Unknown parser state %d\n", state);
744 if (debug_level > 50 && pass == 2) {
746 for (i=r_first; i<=r_last; i++) {
747 dump_resource(i, resources[i-r_first].res_head, prtmsg, NULL);
750 lc = lex_close_file(lc);
752 Dmsg0(200, "Leave parse_config()\n");
755 /*********************************************************************
757 * Free configuration resources
761 free_config_resources()
764 for (i=r_first; i<=r_last; i++) {