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-2003 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[];
69 // work around visual studio name manling preventing external linkage since res_all
70 // is declared as a different type when instantiated.
71 extern "C" CURES res_all;
72 extern "C" int res_all_size;
75 extern int res_all_size;
79 static brwlock_t res_lock; /* resource lock */
80 static int res_locked = 0; /* set when resource chains locked -- for debug */
82 /* Forward referenced subroutines */
83 static void scan_types(LEX *lc, MSGS *msg, int dest, char *where, char *cmd);
86 /* Common Resource definitions */
88 /* Message resource directives
89 * name handler value code flags default_value
91 RES_ITEM msgs_items[] = {
92 {"name", store_name, ITEM(res_msgs.hdr.name), 0, 0, 0},
93 {"description", store_str, ITEM(res_msgs.hdr.desc), 0, 0, 0},
94 {"mailcommand", store_str, ITEM(res_msgs.mail_cmd), 0, 0, 0},
95 {"operatorcommand", store_str, ITEM(res_msgs.operator_cmd), 0, 0, 0},
96 {"syslog", store_msgs, ITEM(res_msgs), MD_SYSLOG, 0, 0},
97 {"mail", store_msgs, ITEM(res_msgs), MD_MAIL, 0, 0},
98 {"mailonerror", store_msgs, ITEM(res_msgs), MD_MAIL_ON_ERROR, 0, 0},
99 {"file", store_msgs, ITEM(res_msgs), MD_FILE, 0, 0},
100 {"append", store_msgs, ITEM(res_msgs), MD_APPEND, 0, 0},
101 {"stdout", store_msgs, ITEM(res_msgs), MD_STDOUT, 0, 0},
102 {"stderr", store_msgs, ITEM(res_msgs), MD_STDERR, 0, 0},
103 {"director", store_msgs, ITEM(res_msgs), MD_DIRECTOR, 0, 0},
104 {"console", store_msgs, ITEM(res_msgs), MD_CONSOLE, 0, 0},
105 {"operator", store_msgs, ITEM(res_msgs), MD_OPERATOR, 0, 0},
106 {NULL, NULL, NULL, 0}
113 /* Various message types */
114 static struct s_mtypes msg_types[] = {
119 {"warning", M_WARNING},
122 {"notsaved", M_NOTSAVED},
123 {"skipped", M_SKIPPED},
125 {"terminate", M_TERM},
126 {"restored", M_RESTORED},
132 /* Simply print a message */
133 static void prtmsg(void *sock, char *fmt, ...)
137 va_start(arg_ptr, fmt);
138 vfprintf(stdout, fmt, arg_ptr);
142 const char *res_to_str(int rcode)
144 if (rcode < r_first || rcode > r_last) {
145 return _("***UNKNOWN***");
147 return resources[rcode-r_first].name;
153 * Initialize the static structure to zeros, then
154 * apply all the default values.
156 void init_resource(int type, RES_ITEM *items)
159 int rindex = type - r_first;
160 static bool first = true;
163 if (first && (errstat=rwl_init(&res_lock)) != 0) {
164 Emsg1(M_ABORT, 0, _("Unable to initialize resource lock. ERR=%s\n"),
169 memset(&res_all, 0, res_all_size);
170 res_all.hdr.rcode = type;
171 res_all.hdr.refcnt = 1;
173 for (i=0; items[i].name; i++) {
174 Dmsg3(300, "Item=%s def=%s defval=%d\n", items[i].name,
175 (items[i].flags & ITEM_DEFAULT) ? "yes" : "no",
176 items[i].default_value);
177 if (items[i].flags & ITEM_DEFAULT && items[i].default_value != 0) {
178 if (items[i].handler == store_yesno) {
179 *(int *)(items[i].value) |= items[i].code;
180 } else if (items[i].handler == store_pint ||
181 items[i].handler == store_int) {
182 *(int *)(items[i].value) = items[i].default_value;
183 } else if (items[i].handler == store_int64) {
184 *(int64_t *)(items[i].value) = items[i].default_value;
185 } else if (items[i].handler == store_size) {
186 *(uint64_t *)(items[i].value) = (uint64_t)items[i].default_value;
187 } else if (items[i].handler == store_time) {
188 *(utime_t *)(items[i].value) = (utime_t)items[i].default_value;
191 /* If this triggers, take a look at lib/parse_conf.h */
192 if (i >= MAX_RES_ITEMS) {
193 Emsg1(M_ERROR_TERM, 0, _("Too many items in %s resource\n"), resources[rindex]);
199 /* Store Messages Destination information */
200 void store_msgs(LEX *lc, RES_ITEM *item, int index, int pass)
207 Dmsg2(200, "store_msgs pass=%d code=%d\n", pass, item->code);
209 switch (item->code) {
212 case MD_SYSLOG: /* syslog */
214 scan_types(lc, (MSGS *)(item->value), item->code, NULL, NULL);
216 case MD_OPERATOR: /* send to operator */
217 case MD_DIRECTOR: /* send to Director */
218 case MD_MAIL: /* mail */
219 case MD_MAIL_ON_ERROR: /* mail if Job errors */
220 if (item->code == MD_OPERATOR) {
221 cmd = res_all.res_msgs.operator_cmd;
223 cmd = res_all.res_msgs.mail_cmd;
225 dest = get_pool_memory(PM_MESSAGE);
228 /* Pick up comma separated list of destinations */
230 token = lex_get_token(lc, T_NAME); /* scan destination */
231 dest = check_pool_memory_size(dest, dest_len + lc->str_len + 2);
233 pm_strcat(&dest, " "); /* separate multiple destinations with space */
236 pm_strcat(&dest, lc->str);
237 dest_len += lc->str_len;
238 Dmsg2(100, "store_msgs newdest=%s: dest=%s:\n", lc->str, NPRT(dest));
239 token = lex_get_token(lc, T_ALL);
240 if (token == T_COMMA) {
241 continue; /* get another destination */
243 if (token != T_EQUALS) {
244 scan_err1(lc, _("expected an =, got: %s"), lc->str);
248 Dmsg1(200, "mail_cmd=%s\n", NPRT(cmd));
249 scan_types(lc, (MSGS *)(item->value), item->code, dest, cmd);
250 free_pool_memory(dest);
251 Dmsg0(200, "done with dest codes\n");
253 case MD_FILE: /* file */
254 case MD_APPEND: /* append */
255 dest = get_pool_memory(PM_MESSAGE);
256 /* Pick up a single destination */
257 token = lex_get_token(lc, T_NAME); /* scan destination */
258 pm_strcpy(&dest, lc->str);
259 dest_len = lc->str_len;
260 token = lex_get_token(lc, T_ALL);
261 Dmsg1(200, "store_msgs dest=%s:\n", NPRT(dest));
262 if (token != T_EQUALS) {
263 scan_err1(lc, _("expected an =, got: %s"), lc->str);
265 scan_types(lc, (MSGS *)(item->value), item->code, dest, NULL);
266 free_pool_memory(dest);
267 Dmsg0(200, "done with dest codes\n");
271 scan_err1(lc, _("Unknown item code: %d\n"), item->code);
276 set_bit(index, res_all.hdr.item_present);
277 Dmsg0(200, "Done store_msgs\n");
281 * Scan for message types and add them to the message
282 * destination. The basic job here is to connect message types
283 * (WARNING, ERROR, FATAL, INFO, ...) with an appropriate
284 * destination (MAIL, FILE, OPERATOR, ...)
286 static void scan_types(LEX *lc, MSGS *msg, int dest_code, char *where, char *cmd)
288 int i, found, quit, is_not;
292 for (quit=0; !quit;) {
293 lex_get_token(lc, T_NAME); /* expect at least one type */
295 if (lc->str[0] == '!') {
302 for (i=0; msg_types[i].name; i++) {
303 if (strcasecmp(str, msg_types[i].name) == 0) {
304 msg_type = msg_types[i].token;
310 scan_err1(lc, _("message type: %s not found"), str);
314 if (msg_type == M_MAX+1) { /* all? */
315 for (i=1; i<=M_MAX; i++) { /* yes set all types */
316 add_msg_dest(msg, dest_code, i, where, cmd);
320 rem_msg_dest(msg, dest_code, msg_type, where);
322 add_msg_dest(msg, dest_code, msg_type, where, cmd);
328 Dmsg0(200, "call lex_get_token() to eat comma\n");
329 lex_get_token(lc, T_ALL); /* eat comma */
331 Dmsg0(200, "Done scan_types()\n");
336 * This routine is ONLY for resource names
337 * Store a name at specified address.
339 void store_name(LEX *lc, RES_ITEM *item, int index, int pass)
341 POOLMEM *msg = get_pool_memory(PM_EMSG);
342 lex_get_token(lc, T_NAME);
343 if (!is_name_valid(lc->str, &msg)) {
344 scan_err1(lc, "%s\n", msg);
346 free_pool_memory(msg);
347 /* Store the name both pass 1 and pass 2 */
348 if (*(item->value)) {
349 scan_err2(lc, _("Attempt to redefine name \"%s\" to \"%s\"."),
350 *(item->value), lc->str);
352 *(item->value) = bstrdup(lc->str);
354 set_bit(index, res_all.hdr.item_present);
359 * Store a name string at specified address
360 * A name string is limited to MAX_RES_NAME_LENGTH
362 void store_strname(LEX *lc, RES_ITEM *item, int index, int pass)
364 lex_get_token(lc, T_NAME);
367 *(item->value) = bstrdup(lc->str);
370 set_bit(index, res_all.hdr.item_present);
373 /* Store a string at specified address */
374 void store_str(LEX *lc, RES_ITEM *item, int index, int pass)
376 lex_get_token(lc, T_STRING);
378 *(item->value) = bstrdup(lc->str);
381 set_bit(index, res_all.hdr.item_present);
385 * Store a directory name at specified address. Note, we do
386 * shell expansion except if the string begins with a vertical
387 * bar (i.e. it will likely be passed to the shell later).
389 void store_dir(LEX *lc, RES_ITEM *item, int index, int pass)
391 lex_get_token(lc, T_STRING);
393 if (lc->str[0] != '|') {
394 do_shell_expansion(lc->str, sizeof(lc->str));
396 *(item->value) = bstrdup(lc->str);
399 set_bit(index, res_all.hdr.item_present);
403 /* Store a password specified address in MD5 coding */
404 void store_password(LEX *lc, RES_ITEM *item, int index, int pass)
407 struct MD5Context md5c;
408 unsigned char signature[16];
412 lex_get_token(lc, T_STRING);
415 MD5Update(&md5c, (unsigned char *) (lc->str), lc->str_len);
416 MD5Final(signature, &md5c);
417 for (i = j = 0; i < sizeof(signature); i++) {
418 sprintf(&sig[j], "%02x", signature[i]);
421 *(item->value) = bstrdup(sig);
424 set_bit(index, res_all.hdr.item_present);
428 /* Store a resource at specified address.
429 * If we are in pass 2, do a lookup of the
432 void store_res(LEX *lc, RES_ITEM *item, int index, int pass)
436 lex_get_token(lc, T_NAME);
438 res = GetResWithName(item->code, lc->str);
440 scan_err3(lc, _("Could not find config Resource %s referenced on line %d : %s\n"),
441 lc->str, lc->line_no, lc->line);
443 *(item->value) = (char *)res;
446 set_bit(index, res_all.hdr.item_present);
450 * Store default values for Resource from xxxDefs
451 * If we are in pass 2, do a lookup of the
452 * resource and store everything not explicitly set
455 * Note, here item points to the main resource (e.g. Job, not
456 * the jobdefs, which we look up).
458 void store_defs(LEX *lc, RES_ITEM *item, int index, int pass)
462 lex_get_token(lc, T_NAME);
464 Dmsg2(200, "Code=%d name=%s\n", item->code, lc->str);
465 res = GetResWithName(item->code, lc->str);
467 scan_err3(lc, _("Missing config Resource \"%s\" referenced on line %d : %s\n"),
468 lc->str, lc->line_no, lc->line);
470 /* for each item not set, we copy the field from res */
472 for (int i=0; item->name;; i++, item++) {
473 if (bit_is_set(i, res->item_present)) {
474 Dmsg2(000, "Item %d is present in %s\n", i, res->name);
476 Dmsg2(000, "Item %d is not present in %s\n", i, res->name);
479 /* ***FIXME **** add code */
487 /* Store an integer at specified address */
488 void store_int(LEX *lc, RES_ITEM *item, int index, int pass)
490 lex_get_token(lc, T_INT32);
491 *(int *)(item->value) = lc->int32_val;
493 set_bit(index, res_all.hdr.item_present);
496 /* Store a positive integer at specified address */
497 void store_pint(LEX *lc, RES_ITEM *item, int index, int pass)
499 lex_get_token(lc, T_PINT32);
500 *(int *)(item->value) = lc->pint32_val;
502 set_bit(index, res_all.hdr.item_present);
506 /* Store an 64 bit integer at specified address */
507 void store_int64(LEX *lc, RES_ITEM *item, int index, int pass)
509 lex_get_token(lc, T_INT64);
510 *(int64_t *)(item->value) = lc->int64_val;
512 set_bit(index, res_all.hdr.item_present);
515 /* Store a size in bytes */
516 void store_size(LEX *lc, RES_ITEM *item, int index, int pass)
521 Dmsg0(400, "Enter store_size\n");
522 token = lex_get_token(lc, T_ALL);
527 case T_UNQUOTED_STRING:
528 if (!size_to_uint64(lc->str, lc->str_len, &uvalue)) {
529 scan_err1(lc, _("expected a size number, got: %s"), lc->str);
531 *(uint64_t *)(item->value) = uvalue;
534 scan_err1(lc, _("expected a size, got: %s"), lc->str);
538 set_bit(index, res_all.hdr.item_present);
539 Dmsg0(400, "Leave store_size\n");
543 /* Store a time period in seconds */
544 void store_time(LEX *lc, RES_ITEM *item, int index, int pass)
550 token = lex_get_token(lc, T_ALL);
555 case T_UNQUOTED_STRING:
556 bstrncpy(period, lc->str, sizeof(period));
558 token = lex_get_token(lc, T_ALL);
561 case T_UNQUOTED_STRING:
562 bstrncat(period, lc->str, sizeof(period));
566 if (!duration_to_utime(period, &utime)) {
567 scan_err1(lc, _("expected a time period, got: %s"), period);
569 *(utime_t *)(item->value) = utime;
572 scan_err1(lc, _("expected a time period, got: %s"), lc->str);
575 if (token != T_EOL) {
578 set_bit(index, res_all.hdr.item_present);
582 /* Store a yes/no in a bit field */
583 void store_yesno(LEX *lc, RES_ITEM *item, int index, int pass)
585 lex_get_token(lc, T_NAME);
586 if (strcasecmp(lc->str, "yes") == 0) {
587 *(int *)(item->value) |= item->code;
588 } else if (strcasecmp(lc->str, "no") == 0) {
589 *(int *)(item->value) &= ~(item->code);
591 scan_err1(lc, _("Expect a YES or NO, got: %s"), lc->str);
594 set_bit(index, res_all.hdr.item_present);
598 /* #define TRACE_RES */
600 void b_LockRes(const char *file, int line)
604 Dmsg4(000, "LockRes %d,%d at %s:%d\n", res_locked, res_lock.w_active,
607 if ((errstat=rwl_writelock(&res_lock)) != 0) {
608 Emsg3(M_ABORT, 0, "rwl_writelock failure at %s:%d: ERR=%s\n",
609 file, line, strerror(errstat));
614 void b_UnlockRes(const char *file, int line)
619 Dmsg4(000, "UnLockRes %d,%d at %s:%d\n", res_locked, res_lock.w_active,
622 if ((errstat=rwl_writeunlock(&res_lock)) != 0) {
623 Emsg3(M_ABORT, 0, "rwl_writeunlock failure at %s:%d:. ERR=%s\n",
624 file, line, strerror(errstat));
629 * Return resource of type rcode that matches name
632 GetResWithName(int rcode, char *name)
635 int rindex = rcode - r_first;
638 res = resources[rindex].res_head;
640 if (strcmp(res->name, name) == 0) {
651 * Return next resource of type rcode. On first
652 * call second arg (res) is NULL, on subsequent
653 * calls, it is called with previous value.
656 GetNextRes(int rcode, RES *res)
659 int rindex = rcode - r_first;
663 Emsg0(M_ABORT, 0, "Resource chain not locked.\n");
666 nres = resources[rindex].res_head;
680 /*********************************************************************
682 * Parse configuration file
686 parse_config(char *cf)
691 enum parse_state state = p_none;
692 RES_ITEM *items = NULL;
695 /* Make two passes. The first builds the name symbol table,
696 * and the second picks up the items.
698 Dmsg0(200, "Enter parse_config()\n");
699 for (pass=1; pass <= 2; pass++) {
700 Dmsg1(200, "parse_config pass %d\n", pass);
701 lc = lex_open_file(lc, cf, NULL);
702 while ((token=lex_get_token(lc, T_ALL)) != T_EOF) {
703 Dmsg1(150, "parse got token=%s\n", lex_tok_to_str(token));
706 if (token == T_EOL) {
709 if (token != T_IDENTIFIER) {
710 scan_err1(lc, _("Expected a Resource name identifier, got: %s"), lc->str);
713 for (i=0; resources[i].name; i++)
714 if (strcasecmp(resources[i].name, lc->str) == 0) {
716 items = resources[i].items;
717 res_type = resources[i].rcode;
718 init_resource(res_type, items);
721 if (state == p_none) {
722 scan_err1(lc, _("expected resource name, got: %s"), lc->str);
733 scan_err1(lc, _("not in resource definition: %s"), lc->str);
736 for (i=0; items[i].name; i++) {
737 if (strcasecmp(items[i].name, lc->str) == 0) {
738 /* If the ITEM_NO_EQUALS flag is set we do NOT
739 * scan for = after the keyword */
740 if (!(items[i].flags & ITEM_NO_EQUALS)) {
741 token = lex_get_token(lc, T_ALL);
742 Dmsg1 (150, "in T_IDENT got token=%s\n", lex_tok_to_str(token));
743 if (token != T_EQUALS) {
744 scan_err1(lc, _("expected an equals, got: %s"), lc->str);
748 Dmsg1(150, "calling handler for %s\n", items[i].name);
749 /* Call item handler */
750 items[i].handler(lc, &items[i], i, pass);
756 Dmsg2(150, "level=%d id=%s\n", level, lc->str);
757 Dmsg1(150, "Keyword = %s\n", lc->str);
758 scan_err1(lc, _("Keyword \"%s\" not permitted in this resource.\n"
759 "Perhaps you left the trailing brace off of the previous resource."), lc->str);
767 Dmsg0(150, "T_EOB => define new resource\n");
768 save_resource(res_type, items, pass); /* save resource */
775 scan_err2(lc, _("unexpected token %d %s in resource definition"),
776 token, lex_tok_to_str(token));
781 scan_err1(lc, _("Unknown parser state %d\n"), state);
785 if (state != p_none) {
786 scan_err0(lc, _("End of conf file reached with unclosed resource."));
788 if (debug_level > 50 && pass == 2) {
790 for (i=r_first; i<=r_last; i++) {
791 dump_resource(i, resources[i-r_first].res_head, prtmsg, NULL);
794 lc = lex_close_file(lc);
796 Dmsg0(200, "Leave parse_config()\n");
799 /*********************************************************************
801 * Free configuration resources
804 void free_config_resources()
806 for (int i=r_first; i<=r_last; i++) {
807 free_resource(resources[i-r_first].res_head, i);
808 resources[i-r_first].res_head = NULL;
812 RES **save_config_resources()
814 int num = r_last - r_first + 1;
815 RES **res = (RES **)malloc(num*sizeof(RES *));
816 for (int i=0; i<num; i++) {
817 res[i] = resources[i].res_head;
818 resources[i].res_head = NULL;