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-2004 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 RES_TABLE resources[];
68 extern RES **res_head;
71 // work around visual studio name manling preventing external linkage since res_all
72 // is declared as a different type when instantiated.
73 extern "C" CURES res_all;
74 extern "C" int res_all_size;
77 extern int res_all_size;
81 static brwlock_t res_lock; /* resource lock */
82 static int res_locked = 0; /* set when resource chains locked -- for debug */
84 /* Forward referenced subroutines */
85 static void scan_types(LEX *lc, MSGS *msg, int dest, char *where, char *cmd);
88 /* Common Resource definitions */
90 /* Message resource directives
91 * name handler value code flags default_value
93 RES_ITEM msgs_items[] = {
94 {"name", store_name, ITEM(res_msgs.hdr.name), 0, 0, 0},
95 {"description", store_str, ITEM(res_msgs.hdr.desc), 0, 0, 0},
96 {"mailcommand", store_str, ITEM(res_msgs.mail_cmd), 0, 0, 0},
97 {"operatorcommand", store_str, ITEM(res_msgs.operator_cmd), 0, 0, 0},
98 {"syslog", store_msgs, ITEM(res_msgs), MD_SYSLOG, 0, 0},
99 {"mail", store_msgs, ITEM(res_msgs), MD_MAIL, 0, 0},
100 {"mailonerror", store_msgs, ITEM(res_msgs), MD_MAIL_ON_ERROR, 0, 0},
101 {"file", store_msgs, ITEM(res_msgs), MD_FILE, 0, 0},
102 {"append", store_msgs, ITEM(res_msgs), MD_APPEND, 0, 0},
103 {"stdout", store_msgs, ITEM(res_msgs), MD_STDOUT, 0, 0},
104 {"stderr", store_msgs, ITEM(res_msgs), MD_STDERR, 0, 0},
105 {"director", store_msgs, ITEM(res_msgs), MD_DIRECTOR, 0, 0},
106 {"console", store_msgs, ITEM(res_msgs), MD_CONSOLE, 0, 0},
107 {"operator", store_msgs, ITEM(res_msgs), MD_OPERATOR, 0, 0},
108 {NULL, NULL, NULL, 0, 0}
115 /* Various message types */
116 static struct s_mtypes msg_types[] = {
121 {"warning", M_WARNING},
124 {"notsaved", M_NOTSAVED},
125 {"skipped", M_SKIPPED},
127 {"terminate", M_TERM},
128 {"restored", M_RESTORED},
134 /* Simply print a message */
135 static void prtmsg(void *sock, const char *fmt, ...)
139 va_start(arg_ptr, fmt);
140 vfprintf(stdout, fmt, arg_ptr);
144 const char *res_to_str(int rcode)
146 if (rcode < r_first || rcode > r_last) {
147 return _("***UNKNOWN***");
149 return resources[rcode-r_first].name;
155 * Initialize the static structure to zeros, then
156 * apply all the default values.
158 void init_resource(int type, RES_ITEM *items)
161 int rindex = type - r_first;
162 static bool first = true;
165 if (first && (errstat=rwl_init(&res_lock)) != 0) {
166 Emsg1(M_ABORT, 0, _("Unable to initialize resource lock. ERR=%s\n"),
171 memset(&res_all, 0, res_all_size);
172 res_all.hdr.rcode = type;
173 res_all.hdr.refcnt = 1;
175 for (i=0; items[i].name; i++) {
176 Dmsg3(900, "Item=%s def=%s defval=%d\n", items[i].name,
177 (items[i].flags & ITEM_DEFAULT) ? "yes" : "no",
178 items[i].default_value);
179 if (items[i].flags & ITEM_DEFAULT && items[i].default_value != 0) {
180 if (items[i].handler == store_yesno) {
181 *(int *)(items[i].value) |= items[i].code;
182 } else if (items[i].handler == store_pint ||
183 items[i].handler == store_int) {
184 *(int *)(items[i].value) = items[i].default_value;
185 } else if (items[i].handler == store_int64) {
186 *(int64_t *)(items[i].value) = items[i].default_value;
187 } else if (items[i].handler == store_size) {
188 *(uint64_t *)(items[i].value) = (uint64_t)items[i].default_value;
189 } else if (items[i].handler == store_time) {
190 *(utime_t *)(items[i].value) = (utime_t)items[i].default_value;
193 /* If this triggers, take a look at lib/parse_conf.h */
194 if (i >= MAX_RES_ITEMS) {
195 Emsg1(M_ERROR_TERM, 0, _("Too many items in %s resource\n"), resources[rindex]);
201 /* Store Messages Destination information */
202 void store_msgs(LEX *lc, RES_ITEM *item, int index, int pass)
209 Dmsg2(900, "store_msgs pass=%d code=%d\n", pass, item->code);
211 switch (item->code) {
214 case MD_SYSLOG: /* syslog */
216 scan_types(lc, (MSGS *)(item->value), item->code, NULL, NULL);
218 case MD_OPERATOR: /* send to operator */
219 case MD_DIRECTOR: /* send to Director */
220 case MD_MAIL: /* mail */
221 case MD_MAIL_ON_ERROR: /* mail if Job errors */
222 if (item->code == MD_OPERATOR) {
223 cmd = res_all.res_msgs.operator_cmd;
225 cmd = res_all.res_msgs.mail_cmd;
227 dest = get_pool_memory(PM_MESSAGE);
230 /* Pick up comma separated list of destinations */
232 token = lex_get_token(lc, T_NAME); /* scan destination */
233 dest = check_pool_memory_size(dest, dest_len + lc->str_len + 2);
235 pm_strcat(&dest, " "); /* separate multiple destinations with space */
238 pm_strcat(&dest, lc->str);
239 dest_len += lc->str_len;
240 Dmsg2(900, "store_msgs newdest=%s: dest=%s:\n", lc->str, NPRT(dest));
241 token = lex_get_token(lc, T_ALL);
242 if (token == T_COMMA) {
243 continue; /* get another destination */
245 if (token != T_EQUALS) {
246 scan_err1(lc, _("expected an =, got: %s"), lc->str);
250 Dmsg1(900, "mail_cmd=%s\n", NPRT(cmd));
251 scan_types(lc, (MSGS *)(item->value), item->code, dest, cmd);
252 free_pool_memory(dest);
253 Dmsg0(900, "done with dest codes\n");
255 case MD_FILE: /* file */
256 case MD_APPEND: /* append */
257 dest = get_pool_memory(PM_MESSAGE);
258 /* Pick up a single destination */
259 token = lex_get_token(lc, T_NAME); /* scan destination */
260 pm_strcpy(&dest, lc->str);
261 dest_len = lc->str_len;
262 token = lex_get_token(lc, T_ALL);
263 Dmsg1(900, "store_msgs dest=%s:\n", NPRT(dest));
264 if (token != T_EQUALS) {
265 scan_err1(lc, _("expected an =, got: %s"), lc->str);
267 scan_types(lc, (MSGS *)(item->value), item->code, dest, NULL);
268 free_pool_memory(dest);
269 Dmsg0(900, "done with dest codes\n");
273 scan_err1(lc, _("Unknown item code: %d\n"), item->code);
278 set_bit(index, res_all.hdr.item_present);
279 Dmsg0(900, "Done store_msgs\n");
283 * Scan for message types and add them to the message
284 * destination. The basic job here is to connect message types
285 * (WARNING, ERROR, FATAL, INFO, ...) with an appropriate
286 * destination (MAIL, FILE, OPERATOR, ...)
288 static void scan_types(LEX *lc, MSGS *msg, int dest_code, char *where, char *cmd)
290 int i, found, quit, is_not;
294 for (quit=0; !quit;) {
295 lex_get_token(lc, T_NAME); /* expect at least one type */
297 if (lc->str[0] == '!') {
304 for (i=0; msg_types[i].name; i++) {
305 if (strcasecmp(str, msg_types[i].name) == 0) {
306 msg_type = msg_types[i].token;
312 scan_err1(lc, _("message type: %s not found"), str);
316 if (msg_type == M_MAX+1) { /* all? */
317 for (i=1; i<=M_MAX; i++) { /* yes set all types */
318 add_msg_dest(msg, dest_code, i, where, cmd);
322 rem_msg_dest(msg, dest_code, msg_type, where);
324 add_msg_dest(msg, dest_code, msg_type, where, cmd);
330 Dmsg0(900, "call lex_get_token() to eat comma\n");
331 lex_get_token(lc, T_ALL); /* eat comma */
333 Dmsg0(900, "Done scan_types()\n");
338 * This routine is ONLY for resource names
339 * Store a name at specified address.
341 void store_name(LEX *lc, RES_ITEM *item, int index, int pass)
343 POOLMEM *msg = get_pool_memory(PM_EMSG);
344 lex_get_token(lc, T_NAME);
345 if (!is_name_valid(lc->str, &msg)) {
346 scan_err1(lc, "%s\n", msg);
348 free_pool_memory(msg);
349 /* Store the name both pass 1 and pass 2 */
350 if (*(item->value)) {
351 scan_err2(lc, _("Attempt to redefine name \"%s\" to \"%s\"."),
352 *(item->value), lc->str);
354 *(item->value) = bstrdup(lc->str);
356 set_bit(index, res_all.hdr.item_present);
361 * Store a name string at specified address
362 * A name string is limited to MAX_RES_NAME_LENGTH
364 void store_strname(LEX *lc, RES_ITEM *item, int index, int pass)
366 lex_get_token(lc, T_NAME);
369 *(item->value) = bstrdup(lc->str);
372 set_bit(index, res_all.hdr.item_present);
375 /* Store a string at specified address */
376 void store_str(LEX *lc, RES_ITEM *item, int index, int pass)
378 lex_get_token(lc, T_STRING);
380 *(item->value) = bstrdup(lc->str);
383 set_bit(index, res_all.hdr.item_present);
387 * Store a directory name at specified address. Note, we do
388 * shell expansion except if the string begins with a vertical
389 * bar (i.e. it will likely be passed to the shell later).
391 void store_dir(LEX *lc, RES_ITEM *item, int index, int pass)
393 lex_get_token(lc, T_STRING);
395 if (lc->str[0] != '|') {
396 do_shell_expansion(lc->str, sizeof(lc->str));
398 *(item->value) = bstrdup(lc->str);
401 set_bit(index, res_all.hdr.item_present);
405 /* Store a password specified address in MD5 coding */
406 void store_password(LEX *lc, RES_ITEM *item, int index, int pass)
409 struct MD5Context md5c;
410 unsigned char signature[16];
414 lex_get_token(lc, T_STRING);
417 MD5Update(&md5c, (unsigned char *) (lc->str), lc->str_len);
418 MD5Final(signature, &md5c);
419 for (i = j = 0; i < sizeof(signature); i++) {
420 sprintf(&sig[j], "%02x", signature[i]);
423 *(item->value) = bstrdup(sig);
426 set_bit(index, res_all.hdr.item_present);
430 /* Store a resource at specified address.
431 * If we are in pass 2, do a lookup of the
434 void store_res(LEX *lc, RES_ITEM *item, int index, int pass)
438 lex_get_token(lc, T_NAME);
440 res = GetResWithName(item->code, lc->str);
442 scan_err3(lc, _("Could not find config Resource %s referenced on line %d : %s\n"),
443 lc->str, lc->line_no, lc->line);
445 *(item->value) = (char *)res;
448 set_bit(index, res_all.hdr.item_present);
452 * Store default values for Resource from xxxDefs
453 * If we are in pass 2, do a lookup of the
454 * resource and store everything not explicitly set
457 * Note, here item points to the main resource (e.g. Job, not
458 * the jobdefs, which we look up).
460 void store_defs(LEX *lc, RES_ITEM *item, int index, int pass)
464 lex_get_token(lc, T_NAME);
466 Dmsg2(900, "Code=%d name=%s\n", item->code, lc->str);
467 res = GetResWithName(item->code, lc->str);
469 scan_err3(lc, _("Missing config Resource \"%s\" referenced on line %d : %s\n"),
470 lc->str, lc->line_no, lc->line);
472 /* for each item not set, we copy the field from res */
474 for (int i=0; item->name;; i++, item++) {
475 if (bit_is_set(i, res->item_present)) {
476 Dmsg2(900, "Item %d is present in %s\n", i, res->name);
478 Dmsg2(900, "Item %d is not present in %s\n", i, res->name);
481 /* ***FIXME **** add code */
489 /* Store an integer at specified address */
490 void store_int(LEX *lc, RES_ITEM *item, int index, int pass)
492 lex_get_token(lc, T_INT32);
493 *(int *)(item->value) = lc->int32_val;
495 set_bit(index, res_all.hdr.item_present);
498 /* Store a positive integer at specified address */
499 void store_pint(LEX *lc, RES_ITEM *item, int index, int pass)
501 lex_get_token(lc, T_PINT32);
502 *(int *)(item->value) = lc->pint32_val;
504 set_bit(index, res_all.hdr.item_present);
508 /* Store an 64 bit integer at specified address */
509 void store_int64(LEX *lc, RES_ITEM *item, int index, int pass)
511 lex_get_token(lc, T_INT64);
512 *(int64_t *)(item->value) = lc->int64_val;
514 set_bit(index, res_all.hdr.item_present);
517 /* Store a size in bytes */
518 void store_size(LEX *lc, RES_ITEM *item, int index, int pass)
523 Dmsg0(900, "Enter store_size\n");
524 token = lex_get_token(lc, T_ALL);
529 case T_UNQUOTED_STRING:
530 if (!size_to_uint64(lc->str, lc->str_len, &uvalue)) {
531 scan_err1(lc, _("expected a size number, got: %s"), lc->str);
533 *(uint64_t *)(item->value) = uvalue;
536 scan_err1(lc, _("expected a size, got: %s"), lc->str);
540 set_bit(index, res_all.hdr.item_present);
541 Dmsg0(900, "Leave store_size\n");
545 /* Store a time period in seconds */
546 void store_time(LEX *lc, RES_ITEM *item, int index, int pass)
552 token = lex_get_token(lc, T_ALL);
557 case T_UNQUOTED_STRING:
558 bstrncpy(period, lc->str, sizeof(period));
560 token = lex_get_token(lc, T_ALL);
563 case T_UNQUOTED_STRING:
564 bstrncat(period, lc->str, sizeof(period));
568 if (!duration_to_utime(period, &utime)) {
569 scan_err1(lc, _("expected a time period, got: %s"), period);
571 *(utime_t *)(item->value) = utime;
574 scan_err1(lc, _("expected a time period, got: %s"), lc->str);
577 if (token != T_EOL) {
580 set_bit(index, res_all.hdr.item_present);
584 /* Store a yes/no in a bit field */
585 void store_yesno(LEX *lc, RES_ITEM *item, int index, int pass)
587 lex_get_token(lc, T_NAME);
588 if (strcasecmp(lc->str, "yes") == 0) {
589 *(int *)(item->value) |= item->code;
590 } else if (strcasecmp(lc->str, "no") == 0) {
591 *(int *)(item->value) &= ~(item->code);
593 scan_err1(lc, _("Expect a YES or NO, got: %s"), lc->str);
596 set_bit(index, res_all.hdr.item_present);
600 /* #define TRACE_RES */
602 void b_LockRes(const char *file, int line)
606 Dmsg4(000, "LockRes %d,%d at %s:%d\n", res_locked, res_lock.w_active,
609 if ((errstat=rwl_writelock(&res_lock)) != 0) {
610 Emsg3(M_ABORT, 0, "rwl_writelock failure at %s:%d: ERR=%s\n",
611 file, line, strerror(errstat));
616 void b_UnlockRes(const char *file, int line)
621 Dmsg4(000, "UnLockRes %d,%d at %s:%d\n", res_locked, res_lock.w_active,
624 if ((errstat=rwl_writeunlock(&res_lock)) != 0) {
625 Emsg3(M_ABORT, 0, "rwl_writeunlock failure at %s:%d:. ERR=%s\n",
626 file, line, strerror(errstat));
631 * Return resource of type rcode that matches name
634 GetResWithName(int rcode, char *name)
637 int rindex = rcode - r_first;
640 res = res_head[rindex];
642 if (strcmp(res->name, name) == 0) {
653 * Return next resource of type rcode. On first
654 * call second arg (res) is NULL, on subsequent
655 * calls, it is called with previous value.
658 GetNextRes(int rcode, RES *res)
661 int rindex = rcode - r_first;
665 Emsg0(M_ABORT, 0, "Resource chain not locked.\n");
668 nres = res_head[rindex];
682 /*********************************************************************
684 * Parse configuration file
686 * Return 0 if reading failed, 1 otherwise
689 parse_config(const char *cf, int exit_on_error)
691 set_exit_on_error(exit_on_error);
695 enum parse_state state = p_none;
696 RES_ITEM *items = NULL;
699 /* Make two passes. The first builds the name symbol table,
700 * and the second picks up the items.
702 Dmsg0(900, "Enter parse_config()\n");
703 for (pass=1; pass <= 2; pass++) {
704 Dmsg1(900, "parse_config pass %d\n", pass);
705 if ((lc = lex_open_file(lc, cf, NULL)) == NULL) {
706 set_exit_on_error(1); /* Never reached if exit_on_error == 1 */
709 while ((token=lex_get_token(lc, T_ALL)) != T_EOF) {
710 Dmsg1(900, "parse got token=%s\n", lex_tok_to_str(token));
713 if (token == T_EOL) {
716 if (token != T_IDENTIFIER) {
717 scan_err1(lc, _("Expected a Resource name identifier, got: %s"), lc->str);
718 set_exit_on_error(1); /* Never reached if exit_on_error == 1 */
721 for (i=0; resources[i].name; i++)
722 if (strcasecmp(resources[i].name, lc->str) == 0) {
724 items = resources[i].items;
725 res_type = resources[i].rcode;
726 init_resource(res_type, items);
729 if (state == p_none) {
730 scan_err1(lc, _("expected resource name, got: %s"), lc->str);
731 set_exit_on_error(1); /* Never reached if exit_on_error == 1 */
742 scan_err1(lc, _("not in resource definition: %s"), lc->str);
743 set_exit_on_error(1); /* Never reached if exit_on_error == 1 */
746 for (i=0; items[i].name; i++) {
747 if (strcasecmp(items[i].name, lc->str) == 0) {
748 /* If the ITEM_NO_EQUALS flag is set we do NOT
749 * scan for = after the keyword */
750 if (!(items[i].flags & ITEM_NO_EQUALS)) {
751 token = lex_get_token(lc, T_ALL);
752 Dmsg1 (900, "in T_IDENT got token=%s\n", lex_tok_to_str(token));
753 if (token != T_EQUALS) {
754 scan_err1(lc, _("expected an equals, got: %s"), lc->str);
755 set_exit_on_error(1); /* Never reached if exit_on_error == 1 */
759 Dmsg1(900, "calling handler for %s\n", items[i].name);
760 /* Call item handler */
761 items[i].handler(lc, &items[i], i, pass);
767 Dmsg2(900, "level=%d id=%s\n", level, lc->str);
768 Dmsg1(900, "Keyword = %s\n", lc->str);
769 scan_err1(lc, _("Keyword \"%s\" not permitted in this resource.\n"
770 "Perhaps you left the trailing brace off of the previous resource."), lc->str);
771 set_exit_on_error(1); /* Never reached if exit_on_error == 1 */
779 Dmsg0(900, "T_EOB => define new resource\n");
780 save_resource(res_type, items, pass); /* save resource */
787 scan_err2(lc, _("unexpected token %d %s in resource definition"),
788 token, lex_tok_to_str(token));
789 set_exit_on_error(1); /* Never reached if exit_on_error == 1 */
794 scan_err1(lc, _("Unknown parser state %d\n"), state);
795 set_exit_on_error(1); /* Never reached if exit_on_error == 1 */
799 if (state != p_none) {
800 scan_err0(lc, _("End of conf file reached with unclosed resource."));
801 set_exit_on_error(1); /* Never reached if exit_on_error == 1 */
804 if (debug_level >= 900 && pass == 2) {
806 for (i=r_first; i<=r_last; i++) {
807 dump_resource(i, res_head[i-r_first], prtmsg, NULL);
810 lc = lex_close_file(lc);
812 Dmsg0(900, "Leave parse_config()\n");
813 set_exit_on_error(1);
817 /*********************************************************************
819 * Free configuration resources
822 void free_config_resources()
824 for (int i=r_first; i<=r_last; i++) {
825 free_resource(res_head[i-r_first], i);
826 res_head[i-r_first] = NULL;
830 RES **save_config_resources()
832 int num = r_last - r_first + 1;
833 RES **res = (RES **)malloc(num*sizeof(RES *));
834 for (int i=0; i<num; i++) {
835 res[i] = res_head[i];
843 int size = (r_last - r_first + 1) * sizeof(RES *);
844 RES **res = (RES **)malloc(size);
845 memset(res, 0, size);