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,
15 * string, time, int64, size, ...).
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},
129 {"security", M_SECURITY},
136 /* Simply print a message */
137 static void prtmsg(void *sock, const char *fmt, ...)
141 va_start(arg_ptr, fmt);
142 vfprintf(stdout, fmt, arg_ptr);
146 const char *res_to_str(int rcode)
148 if (rcode < r_first || rcode > r_last) {
149 return _("***UNKNOWN***");
151 return resources[rcode-r_first].name;
157 * Initialize the static structure to zeros, then
158 * apply all the default values.
160 void init_resource(int type, RES_ITEM *items, int pass)
163 int rindex = type - r_first;
164 static bool first = true;
167 if (first && (errstat=rwl_init(&res_lock)) != 0) {
168 Emsg1(M_ABORT, 0, _("Unable to initialize resource lock. ERR=%s\n"),
173 memset(&res_all, 0, res_all_size);
174 res_all.hdr.rcode = type;
175 res_all.hdr.refcnt = 1;
177 for (i=0; items[i].name; i++) {
178 Dmsg3(900, "Item=%s def=%s defval=%d\n", items[i].name,
179 (items[i].flags & ITEM_DEFAULT) ? "yes" : "no",
180 items[i].default_value);
181 if (items[i].flags & ITEM_DEFAULT && items[i].default_value != 0) {
182 if (items[i].handler == store_yesno) {
183 *(int *)(items[i].value) |= items[i].code;
184 } else if (items[i].handler == store_pint ||
185 items[i].handler == store_int) {
186 *(int *)(items[i].value) = items[i].default_value;
187 } else if (items[i].handler == store_int64) {
188 *(int64_t *)(items[i].value) = items[i].default_value;
189 } else if (items[i].handler == store_size) {
190 *(uint64_t *)(items[i].value) = (uint64_t)items[i].default_value;
191 } else if (items[i].handler == store_time) {
192 *(utime_t *)(items[i].value) = (utime_t)items[i].default_value;
193 } else if (pass == 1 && items[i].handler == store_addresses) {
194 init_default_addresses((dlist**)items[i].value, items[i].default_value);
197 /* If this triggers, take a look at lib/parse_conf.h */
198 if (i >= MAX_RES_ITEMS) {
199 Emsg1(M_ERROR_TERM, 0, _("Too many items in %s resource\n"), resources[rindex]);
205 /* Store Messages Destination information */
206 void store_msgs(LEX *lc, RES_ITEM *item, int index, int pass)
213 Dmsg2(900, "store_msgs pass=%d code=%d\n", pass, item->code);
215 switch (item->code) {
218 case MD_SYSLOG: /* syslog */
220 scan_types(lc, (MSGS *)(item->value), item->code, NULL, NULL);
222 case MD_OPERATOR: /* send to operator */
223 case MD_DIRECTOR: /* send to Director */
224 case MD_MAIL: /* mail */
225 case MD_MAIL_ON_ERROR: /* mail if Job errors */
226 if (item->code == MD_OPERATOR) {
227 cmd = res_all.res_msgs.operator_cmd;
229 cmd = res_all.res_msgs.mail_cmd;
231 dest = get_pool_memory(PM_MESSAGE);
234 /* Pick up comma separated list of destinations */
236 token = lex_get_token(lc, T_NAME); /* scan destination */
237 dest = check_pool_memory_size(dest, dest_len + lc->str_len + 2);
239 pm_strcat(dest, " "); /* separate multiple destinations with space */
242 pm_strcat(dest, lc->str);
243 dest_len += lc->str_len;
244 Dmsg2(900, "store_msgs newdest=%s: dest=%s:\n", lc->str, NPRT(dest));
245 token = lex_get_token(lc, T_SKIP_EOL);
246 if (token == T_COMMA) {
247 continue; /* get another destination */
249 if (token != T_EQUALS) {
250 scan_err1(lc, _("expected an =, got: %s"), lc->str);
254 Dmsg1(900, "mail_cmd=%s\n", NPRT(cmd));
255 scan_types(lc, (MSGS *)(item->value), item->code, dest, cmd);
256 free_pool_memory(dest);
257 Dmsg0(900, "done with dest codes\n");
259 case MD_FILE: /* file */
260 case MD_APPEND: /* append */
261 dest = get_pool_memory(PM_MESSAGE);
262 /* Pick up a single destination */
263 token = lex_get_token(lc, T_NAME); /* scan destination */
264 pm_strcpy(dest, lc->str);
265 dest_len = lc->str_len;
266 token = lex_get_token(lc, T_SKIP_EOL);
267 Dmsg1(900, "store_msgs dest=%s:\n", NPRT(dest));
268 if (token != T_EQUALS) {
269 scan_err1(lc, _("expected an =, got: %s"), lc->str);
271 scan_types(lc, (MSGS *)(item->value), item->code, dest, NULL);
272 free_pool_memory(dest);
273 Dmsg0(900, "done with dest codes\n");
277 scan_err1(lc, _("Unknown item code: %d\n"), item->code);
282 set_bit(index, res_all.hdr.item_present);
283 Dmsg0(900, "Done store_msgs\n");
287 * Scan for message types and add them to the message
288 * destination. The basic job here is to connect message types
289 * (WARNING, ERROR, FATAL, INFO, ...) with an appropriate
290 * destination (MAIL, FILE, OPERATOR, ...)
292 static void scan_types(LEX *lc, MSGS *msg, int dest_code, char *where, char *cmd)
294 int i, found, quit, is_not;
298 for (quit=0; !quit;) {
299 lex_get_token(lc, T_NAME); /* expect at least one type */
301 if (lc->str[0] == '!') {
308 for (i=0; msg_types[i].name; i++) {
309 if (strcasecmp(str, msg_types[i].name) == 0) {
310 msg_type = msg_types[i].token;
316 scan_err1(lc, _("message type: %s not found"), str);
320 if (msg_type == M_MAX+1) { /* all? */
321 for (i=1; i<=M_MAX; i++) { /* yes set all types */
322 add_msg_dest(msg, dest_code, i, where, cmd);
326 rem_msg_dest(msg, dest_code, msg_type, where);
328 add_msg_dest(msg, dest_code, msg_type, where, cmd);
334 Dmsg0(900, "call lex_get_token() to eat comma\n");
335 lex_get_token(lc, T_ALL); /* eat comma */
337 Dmsg0(900, "Done scan_types()\n");
342 * This routine is ONLY for resource names
343 * Store a name at specified address.
345 void store_name(LEX *lc, RES_ITEM *item, int index, int pass)
347 POOLMEM *msg = get_pool_memory(PM_EMSG);
348 lex_get_token(lc, T_NAME);
349 if (!is_name_valid(lc->str, &msg)) {
350 scan_err1(lc, "%s\n", msg);
352 free_pool_memory(msg);
353 /* Store the name both pass 1 and pass 2 */
354 if (*(item->value)) {
355 scan_err2(lc, _("Attempt to redefine name \"%s\" to \"%s\"."),
356 *(item->value), lc->str);
358 *(item->value) = bstrdup(lc->str);
360 set_bit(index, res_all.hdr.item_present);
365 * Store a name string at specified address
366 * A name string is limited to MAX_RES_NAME_LENGTH
368 void store_strname(LEX *lc, RES_ITEM *item, int index, int pass)
370 lex_get_token(lc, T_NAME);
373 *(item->value) = bstrdup(lc->str);
376 set_bit(index, res_all.hdr.item_present);
379 /* Store a string at specified address */
380 void store_str(LEX *lc, RES_ITEM *item, int index, int pass)
382 lex_get_token(lc, T_STRING);
384 *(item->value) = bstrdup(lc->str);
387 set_bit(index, res_all.hdr.item_present);
391 * Store a directory name at specified address. Note, we do
392 * shell expansion except if the string begins with a vertical
393 * bar (i.e. it will likely be passed to the shell later).
395 void store_dir(LEX *lc, RES_ITEM *item, int index, int pass)
397 lex_get_token(lc, T_STRING);
399 if (lc->str[0] != '|') {
400 do_shell_expansion(lc->str, sizeof(lc->str));
402 *(item->value) = bstrdup(lc->str);
405 set_bit(index, res_all.hdr.item_present);
409 /* Store a password specified address in MD5 coding */
410 void store_password(LEX *lc, RES_ITEM *item, int index, int pass)
413 struct MD5Context md5c;
414 unsigned char signature[16];
418 lex_get_token(lc, T_STRING);
421 MD5Update(&md5c, (unsigned char *) (lc->str), lc->str_len);
422 MD5Final(signature, &md5c);
423 for (i = j = 0; i < sizeof(signature); i++) {
424 sprintf(&sig[j], "%02x", signature[i]);
427 *(item->value) = bstrdup(sig);
430 set_bit(index, res_all.hdr.item_present);
434 /* Store a resource at specified address.
435 * If we are in pass 2, do a lookup of the
438 void store_res(LEX *lc, RES_ITEM *item, int index, int pass)
442 lex_get_token(lc, T_NAME);
444 res = GetResWithName(item->code, lc->str);
446 scan_err3(lc, _("Could not find config Resource %s referenced on line %d : %s\n"),
447 lc->str, lc->line_no, lc->line);
449 if (*(item->value)) {
450 scan_err3(lc, _("Attempt to redefine resource \"%s\" referenced on line %d : %s\n"),
451 item->name, lc->line_no, lc->line);
453 *(item->value) = (char *)res;
456 set_bit(index, res_all.hdr.item_present);
460 * Store a resource in an alist. default_value indicates how many
461 * times this routine can be called -- i.e. how many alists
463 * If we are in pass 2, do a lookup of the
466 void store_alist_res(LEX *lc, RES_ITEM *item, int index, int pass)
469 int count = item->default_value;
474 /* Find empty place to store this directive */
475 while ((item->value)[i] != NULL && i++ < count) { }
477 scan_err3(lc, _("Too many Storage directives. Max. is %d. line %d: %s\n"),
478 count, lc->line_no, lc->line);
480 list = New(alist(10, not_owned_by_alist));
483 lex_get_token(lc, T_NAME); /* scan next item */
484 res = GetResWithName(item->code, lc->str);
486 scan_err3(lc, _("Could not find config Resource \"%s\" referenced on line %d : %s\n"),
487 lc->str, lc->line_no, lc->line);
490 (item->value)[i] = (char *)list;
491 if (lc->ch != ',') { /* if no other item follows */
494 lex_get_token(lc, T_ALL); /* eat comma */
498 set_bit(index, res_all.hdr.item_present);
503 * Store default values for Resource from xxxDefs
504 * If we are in pass 2, do a lookup of the
505 * resource and store everything not explicitly set
508 * Note, here item points to the main resource (e.g. Job, not
509 * the jobdefs, which we look up).
511 void store_defs(LEX *lc, RES_ITEM *item, int index, int pass)
515 lex_get_token(lc, T_NAME);
517 Dmsg2(900, "Code=%d name=%s\n", item->code, lc->str);
518 res = GetResWithName(item->code, lc->str);
520 scan_err3(lc, _("Missing config Resource \"%s\" referenced on line %d : %s\n"),
521 lc->str, lc->line_no, lc->line);
523 /* for each item not set, we copy the field from res */
525 for (int i=0; item->name;; i++, item++) {
526 if (bit_is_set(i, res->item_present)) {
527 Dmsg2(900, "Item %d is present in %s\n", i, res->name);
529 Dmsg2(900, "Item %d is not present in %s\n", i, res->name);
532 /* ***FIXME **** add code */
540 /* Store an integer at specified address */
541 void store_int(LEX *lc, RES_ITEM *item, int index, int pass)
543 lex_get_token(lc, T_INT32);
544 *(int *)(item->value) = lc->int32_val;
546 set_bit(index, res_all.hdr.item_present);
549 /* Store a positive integer at specified address */
550 void store_pint(LEX *lc, RES_ITEM *item, int index, int pass)
552 lex_get_token(lc, T_PINT32);
553 *(int *)(item->value) = lc->pint32_val;
555 set_bit(index, res_all.hdr.item_present);
559 /* Store an 64 bit integer at specified address */
560 void store_int64(LEX *lc, RES_ITEM *item, int index, int pass)
562 lex_get_token(lc, T_INT64);
563 *(int64_t *)(item->value) = lc->int64_val;
565 set_bit(index, res_all.hdr.item_present);
568 /* Store a size in bytes */
569 void store_size(LEX *lc, RES_ITEM *item, int index, int pass)
574 Dmsg0(900, "Enter store_size\n");
575 token = lex_get_token(lc, T_SKIP_EOL);
580 case T_UNQUOTED_STRING:
581 if (!size_to_uint64(lc->str, lc->str_len, &uvalue)) {
582 scan_err1(lc, _("expected a size number, got: %s"), lc->str);
584 *(uint64_t *)(item->value) = uvalue;
587 scan_err1(lc, _("expected a size, got: %s"), lc->str);
591 set_bit(index, res_all.hdr.item_present);
592 Dmsg0(900, "Leave store_size\n");
596 /* Store a time period in seconds */
597 void store_time(LEX *lc, RES_ITEM *item, int index, int pass)
603 token = lex_get_token(lc, T_SKIP_EOL);
608 case T_UNQUOTED_STRING:
609 bstrncpy(period, lc->str, sizeof(period));
611 token = lex_get_token(lc, T_ALL);
614 case T_UNQUOTED_STRING:
615 bstrncat(period, lc->str, sizeof(period));
619 if (!duration_to_utime(period, &utime)) {
620 scan_err1(lc, _("expected a time period, got: %s"), period);
622 *(utime_t *)(item->value) = utime;
625 scan_err1(lc, _("expected a time period, got: %s"), lc->str);
628 if (token != T_EOL) {
631 set_bit(index, res_all.hdr.item_present);
635 /* Store a yes/no in a bit field */
636 void store_yesno(LEX *lc, RES_ITEM *item, int index, int pass)
638 lex_get_token(lc, T_NAME);
639 if (strcasecmp(lc->str, "yes") == 0) {
640 *(int *)(item->value) |= item->code;
641 } else if (strcasecmp(lc->str, "no") == 0) {
642 *(int *)(item->value) &= ~(item->code);
644 scan_err1(lc, _("Expect a YES or NO, got: %s"), lc->str);
647 set_bit(index, res_all.hdr.item_present);
651 /* #define TRACE_RES */
653 void b_LockRes(const char *file, int line)
657 Dmsg4(000, "LockRes %d,%d at %s:%d\n", res_locked, res_lock.w_active,
660 if ((errstat=rwl_writelock(&res_lock)) != 0) {
661 Emsg3(M_ABORT, 0, "rwl_writelock failure at %s:%d: ERR=%s\n",
662 file, line, strerror(errstat));
667 void b_UnlockRes(const char *file, int line)
672 Dmsg4(000, "UnLockRes %d,%d at %s:%d\n", res_locked, res_lock.w_active,
675 if ((errstat=rwl_writeunlock(&res_lock)) != 0) {
676 Emsg3(M_ABORT, 0, "rwl_writeunlock failure at %s:%d:. ERR=%s\n",
677 file, line, strerror(errstat));
682 * Return resource of type rcode that matches name
685 GetResWithName(int rcode, char *name)
688 int rindex = rcode - r_first;
691 res = res_head[rindex];
693 if (strcmp(res->name, name) == 0) {
704 * Return next resource of type rcode. On first
705 * call second arg (res) is NULL, on subsequent
706 * calls, it is called with previous value.
709 GetNextRes(int rcode, RES *res)
712 int rindex = rcode - r_first;
716 Emsg0(M_ABORT, 0, "Resource chain not locked.\n");
719 nres = res_head[rindex];
733 /*********************************************************************
735 * Parse configuration file
737 * Return 0 if reading failed, 1 otherwise
740 parse_config(const char *cf, int exit_on_error)
742 set_exit_on_error(exit_on_error);
746 enum parse_state state = p_none;
747 RES_ITEM *items = NULL;
750 /* Make two passes. The first builds the name symbol table,
751 * and the second picks up the items.
753 Dmsg0(900, "Enter parse_config()\n");
754 for (pass=1; pass <= 2; pass++) {
755 Dmsg1(900, "parse_config pass %d\n", pass);
756 if ((lc = lex_open_file(lc, cf, NULL)) == NULL) {
757 set_exit_on_error(1); /* Never reached if exit_on_error == 1 */
760 while ((token=lex_get_token(lc, T_ALL)) != T_EOF) {
761 Dmsg1(900, "parse got token=%s\n", lex_tok_to_str(token));
764 if (token == T_EOL) {
767 if (token != T_IDENTIFIER) {
768 scan_err1(lc, _("Expected a Resource name identifier, got: %s"), lc->str);
769 set_exit_on_error(1); /* Never reached if exit_on_error == 1 */
772 for (i=0; resources[i].name; i++)
773 if (strcasecmp(resources[i].name, lc->str) == 0) {
775 items = resources[i].items;
776 res_type = resources[i].rcode;
777 init_resource(res_type, items, pass);
780 if (state == p_none) {
781 scan_err1(lc, _("expected resource name, got: %s"), lc->str);
782 set_exit_on_error(1); /* Never reached if exit_on_error == 1 */
793 scan_err1(lc, _("not in resource definition: %s"), lc->str);
794 set_exit_on_error(1); /* Never reached if exit_on_error == 1 */
797 for (i=0; items[i].name; i++) {
798 if (strcasecmp(items[i].name, lc->str) == 0) {
799 /* If the ITEM_NO_EQUALS flag is set we do NOT
800 * scan for = after the keyword */
801 if (!(items[i].flags & ITEM_NO_EQUALS)) {
802 token = lex_get_token(lc, T_SKIP_EOL);
803 Dmsg1 (900, "in T_IDENT got token=%s\n", lex_tok_to_str(token));
804 if (token != T_EQUALS) {
805 scan_err1(lc, _("expected an equals, got: %s"), lc->str);
806 set_exit_on_error(1); /* Never reached if exit_on_error == 1 */
810 Dmsg1(900, "calling handler for %s\n", items[i].name);
811 /* Call item handler */
812 items[i].handler(lc, &items[i], i, pass);
818 Dmsg2(900, "level=%d id=%s\n", level, lc->str);
819 Dmsg1(900, "Keyword = %s\n", lc->str);
820 scan_err1(lc, _("Keyword \"%s\" not permitted in this resource.\n"
821 "Perhaps you left the trailing brace off of the previous resource."), lc->str);
822 set_exit_on_error(1); /* Never reached if exit_on_error == 1 */
830 Dmsg0(900, "T_EOB => define new resource\n");
831 save_resource(res_type, items, pass); /* save resource */
838 scan_err2(lc, _("unexpected token %d %s in resource definition"),
839 token, lex_tok_to_str(token));
840 set_exit_on_error(1); /* Never reached if exit_on_error == 1 */
845 scan_err1(lc, _("Unknown parser state %d\n"), state);
846 set_exit_on_error(1); /* Never reached if exit_on_error == 1 */
850 if (state != p_none) {
851 scan_err0(lc, _("End of conf file reached with unclosed resource."));
852 set_exit_on_error(1); /* Never reached if exit_on_error == 1 */
855 if (debug_level >= 900 && pass == 2) {
857 for (i=r_first; i<=r_last; i++) {
858 dump_resource(i, res_head[i-r_first], prtmsg, NULL);
861 lc = lex_close_file(lc);
863 Dmsg0(900, "Leave parse_config()\n");
864 set_exit_on_error(1);
868 /*********************************************************************
870 * Free configuration resources
873 void free_config_resources()
875 for (int i=r_first; i<=r_last; i++) {
876 free_resource(res_head[i-r_first], i);
877 res_head[i-r_first] = NULL;
881 RES **save_config_resources()
883 int num = r_last - r_first + 1;
884 RES **res = (RES **)malloc(num*sizeof(RES *));
885 for (int i=0; i<num; i++) {
886 res[i] = res_head[i];
894 int size = (r_last - r_first + 1) * sizeof(RES *);
895 RES **res = (RES **)malloc(size);
896 memset(res, 0, size);