2 * UCW Library -- Reading of configuration files
4 * (c) 2001--2006 Robert Spalek <robert@ucw.cz>
5 * (c) 2003--2006 Martin Mares <mj@ucw.cz>
7 * This software may be freely distributed and used according to the terms
8 * of the GNU Lesser General Public License.
12 #include "lib/conf2.h"
13 #include "lib/mempool.h"
14 #include "lib/clists.h"
15 #include "lib/fastbuf.h"
16 #include "lib/chartype.h"
18 #include "lib/stkstring.h"
19 #include "lib/binsearch.h"
28 #define TRY(f) do { byte *_msg = f; if (_msg) return _msg; } while (0)
30 /* Memory allocation */
32 struct mempool *cf_pool; // current pool for loading new configuration
33 static struct old_pools {
34 struct old_pools *prev;
36 } *pools; // link-list of older cf_pool's
41 return mp_alloc(cf_pool, size);
45 cf_malloc_zero(uns size)
47 return mp_alloc_zero(cf_pool, size);
53 return mp_strdup(cf_pool, s);
57 cf_printf(char *fmt, ...)
61 byte *res = mp_vprintf(cf_pool, fmt, args);
68 uns cf_need_journal = 1; // some programs do not need journal
69 static struct cf_journal_item {
70 struct cf_journal_item *prev;
77 cf_journal_block(void *ptr, uns len)
81 struct cf_journal_item *ji = cf_malloc(sizeof(struct cf_journal_item) + len);
85 memcpy(ji->copy, ptr, len);
91 // swaps the contents of the memory and the journal, and reverses the list
93 struct cf_journal_item *curr, *prev, *next;
94 for (next=NULL, curr=journal; curr; next=curr, curr=prev)
98 for (uns i=0; i<curr->len; i++)
100 byte x = curr->copy[i];
101 curr->copy[i] = curr->ptr[i];
108 struct cf_journal_item *
109 cf_journal_new_transaction(uns new_pool)
112 cf_pool = mp_new(1<<10);
113 struct cf_journal_item *oldj = journal;
119 cf_journal_commit_transaction(uns new_pool, struct cf_journal_item *oldj)
123 struct old_pools *p = cf_malloc(sizeof(struct old_pools));
130 struct cf_journal_item **j = &journal;
138 cf_journal_rollback_transaction(uns new_pool, struct cf_journal_item *oldj)
140 if (!cf_need_journal)
141 die("Cannot rollback the configuration, because the journal is disabled.");
147 cf_pool = pools ? pools->pool : NULL;
153 struct dirty_section {
154 struct cf_section *sec;
157 #define GBUF_TYPE struct dirty_section
158 #define GBUF_PREFIX(x) dirtsec_##x
159 #include "lib/gbuf.h"
160 static dirtsec_t dirty;
162 static uns everything_committed; // after the 1st load, this flag is set on
165 add_dirty(struct cf_section *sec, void *ptr)
167 dirtsec_grow(&dirty, dirties+1);
168 struct dirty_section *dest = dirty.ptr + dirties;
169 if (dirties && dest[-1].sec == sec && dest[-1].ptr == ptr)
176 #define ASORT_PREFIX(x) dirtsec_##x
177 #define ASORT_KEY_TYPE struct dirty_section
178 #define ASORT_ELT(i) dirty.ptr[i]
179 #define ASORT_LT(x,y) x.sec < y.sec || x.sec == y.sec && x.ptr < y.ptr
180 #include "lib/arraysort.h"
187 dirtsec_sort(dirties);
188 struct dirty_section *read = dirty.ptr + 1, *write = dirty.ptr + 1, *limit = dirty.ptr + dirties;
189 while (read < limit) {
190 if (read->sec != read[-1].sec || read->ptr != read[-1].ptr) {
197 dirties = write - dirty.ptr;
202 #define SEC_FLAG_DYNAMIC 0x80000000 // contains a dynamic attribute
203 #define SEC_FLAG_UNKNOWN 0x40000000 // ignore unknown entriies
204 #define SEC_FLAG_NUMBER 0x0fffffff // number of entries
206 static struct cf_section sections; // root section
208 static struct cf_item *
209 find_subitem(struct cf_section *sec, byte *name)
211 struct cf_item *ci = sec->cfg;
212 for (; ci->cls; ci++)
213 if (!strcasecmp(ci->name, name))
219 inspect_section(struct cf_section *sec)
223 for (ci=sec->cfg; ci->cls; ci++)
224 if (ci->cls == CC_SECTION) {
225 inspect_section(ci->u.sec);
226 sec->flags |= ci->u.sec->flags & SEC_FLAG_DYNAMIC;
227 } else if (ci->cls == CC_LIST) {
228 inspect_section(ci->u.sec);
229 sec->flags |= SEC_FLAG_DYNAMIC;
230 } else if (ci->cls == CC_DYNAMIC || ci->cls == CC_PARSER && ci->number < 0)
231 sec->flags |= SEC_FLAG_DYNAMIC;
232 sec->flags |= ci - sec->cfg; // record the number of entries
236 cf_declare_section(byte *name, struct cf_section *sec, uns allow_unknown)
241 sections.cfg = xmalloc_zero(sections.size * sizeof(struct cf_item));
243 struct cf_item *ci = find_subitem(§ions, name);
245 die("Cannot register section %s twice", name);
246 ci->cls = CC_SECTION;
251 inspect_section(sec);
253 sec->flags |= SEC_FLAG_UNKNOWN;
255 if (ci - sections.cfg >= (int) sections.size)
257 sections.cfg = xrealloc(sections.cfg, 2*sections.size * sizeof(struct cf_item));
258 bzero(sections.cfg + sections.size, sections.size * sizeof(struct cf_item));
264 cf_init_section(byte *name, struct cf_section *sec, void *ptr, uns do_bzero)
268 bzero(ptr, sec->size);
270 for (uns i=0; sec->cfg[i].cls; i++)
271 if (sec->cfg[i].cls == CC_SECTION)
272 cf_init_section(sec->cfg[i].name, sec->cfg[i].u.sec, ptr + (addr_int_t) sec->cfg[i].ptr, 0);
273 else if (sec->cfg[i].cls == CC_LIST)
274 clist_init(ptr + (addr_int_t) sec->cfg[i].ptr);
276 byte *msg = sec->init(ptr);
278 die("Cannot initialize section %s: %s", name, msg);
285 static uns initialized = 0;
288 sections.flags |= SEC_FLAG_UNKNOWN;
289 sections.size = 0; // size of allocated array used to be stored here
290 cf_init_section("top-level", §ions, NULL, 0);
294 commit_section(byte *name, struct cf_section *sec, void *ptr, uns commit_all)
297 for (ci=sec->cfg; ci->cls; ci++)
298 if (ci->cls == CC_SECTION) {
299 if (commit_section(ci->name, ci->u.sec, ptr + (addr_int_t) ci->ptr, commit_all)) {
300 log(L_ERROR, "It happened in section %s", ci->name);
303 } else if (ci->cls == CC_LIST) {
306 CLIST_WALK(n, * (clist*) (ptr + (addr_int_t) ci->ptr))
307 if (idx++, commit_section(ci->name, ci->u.sec, n, commit_all)) {
308 log(L_ERROR, "It happened in node #%d of list %s", idx, ci->name);
313 /* We have to process the whole tree of sections even if just a few changes
314 * have been made, because there are dependencies between commit-hooks and
315 * hence we need to call them in a fixed order. */
316 #define ARY_LT_X(ary,i,x) ary[i].sec < x.sec || ary[i].sec == x.sec && ary[i].ptr < x.ptr
317 struct dirty_section comp = { sec, ptr };
318 uns pos = BIN_SEARCH_FIRST_GE_CMP(dirty.ptr, dirties, comp, ARY_LT_X);
321 || (pos < dirties && dirty.ptr[pos].sec == sec && dirty.ptr[pos].ptr == ptr)) {
322 byte *msg = sec->commit(ptr);
324 log(L_ERROR, "Cannot commit section %s: %s", name, msg);
332 static struct cf_item *
333 find_item(struct cf_section *curr_sec, byte *name, byte **msg, void **ptr)
336 if (name[0] == '^') // absolute name instead of relative
337 name++, curr_sec = §ions, *ptr = NULL;
338 if (!curr_sec) // don't even search in an unknown section
342 if (curr_sec != §ions)
343 add_dirty(curr_sec, *ptr);
344 byte *c = strchr(name, '.');
347 struct cf_item *ci = find_subitem(curr_sec, name);
350 if (!(curr_sec->flags & SEC_FLAG_UNKNOWN)) // ignore silently unknown top-level sections and unknown attributes in flagged sections
351 *msg = cf_printf("Unknown item %s", name);
354 *ptr += (addr_int_t) ci->ptr;
357 if (ci->cls != CC_SECTION)
359 *msg = cf_printf("Item %s is not a section", name);
362 curr_sec = ci->u.sec;
368 cf_find_item(byte *name, struct cf_item *item)
372 struct cf_item *ci = find_item(§ions, name, &msg, &ptr);
379 bzero(item, sizeof(struct cf_item));
383 /* Safe loading and reloading */
385 static int load_file(byte *file);
386 static int load_string(byte *string);
389 cf_reload(byte *file)
392 struct cf_journal_item *oldj = cf_journal_new_transaction(1);
393 uns ec = everything_committed;
394 everything_committed = 0;
395 int err = load_file(file);
398 for (struct old_pools *p=pools; p; p=pools)
403 cf_journal_commit_transaction(1, NULL);
407 everything_committed = ec;
408 cf_journal_rollback_transaction(1, oldj);
417 struct cf_journal_item *oldj = cf_journal_new_transaction(1);
418 int err = load_file(file);
420 cf_journal_commit_transaction(1, oldj);
422 cf_journal_rollback_transaction(1, oldj);
429 struct cf_journal_item *oldj = cf_journal_new_transaction(0);
430 int err = load_string(string);
432 cf_journal_commit_transaction(0, oldj);
434 cf_journal_rollback_transaction(0, oldj);
438 /* Parsers for standard types */
441 uns name; // one-letter name of the unit
442 uns num, den; // fraction
445 static const struct unit units[] = {
450 { 'g', 1000000000, 1 },
453 { 'G', 1073741824, 1 },
458 static const struct unit *
459 lookup_unit(byte *value, byte *end, byte **msg)
462 if (end == value || end[1] || *end >= '0' && *end <= '9')
463 *msg = "Invalid number";
465 for (const struct unit *u=units; u->name; u++)
468 *msg = "Invalid unit";
474 static char cf_rngerr[] = "Number out of range";
477 cf_parse_int(byte *str, int *ptr)
481 msg = "Missing number";
483 const struct unit *u;
486 uns x = strtoul(str, &end, 0);
489 else if (u = lookup_unit(str, end, &msg)) {
490 u64 y = (u64)x * u->num;
492 msg = "Number is not an integer";
506 cf_parse_u64(byte *str, u64 *ptr)
510 msg = "Missing number";
512 const struct unit *u;
515 u64 x = strtoull(str, &end, 0);
518 else if (u = lookup_unit(str, end, &msg)) {
519 if (x > ~(u64)0 / u->num)
520 msg = "Number out of range";
524 msg = "Number is not an integer";
535 cf_parse_double(byte *str, double *ptr)
539 msg = "Missing number";
541 const struct unit *u;
544 if (sscanf(str, "%lf%n", &x, &read_chars) != 1)
545 msg = "Invalid number";
546 else if (u = lookup_unit(str, str + read_chars, &msg))
547 *ptr = x * u->num / u->den;
555 cf_parse_ip(byte *p, u32 *varp)
558 return "Missing IP address";
561 if (*p == '0' && (p[1] | 32) == 'x' && Cxdigit(p[2])) {
563 x = strtoul(p, &p2, 16);
564 if (errno == ERANGE || x > 0xffffffff)
569 for (uns i = 0; i < 4; i++) {
577 uns y = strtoul(p, &p2, 10);
578 if (errno == ERANGE || p2 == (char*) p || y > 255)
584 return *p ? "Trailing characters" : NULL;
586 return "Invalid IP address";
590 cf_parse_string(byte *str, byte **ptr)
592 *ptr = cf_strdup(str);
597 cf_parse_lookup(byte *str, int *ptr, byte **t)
601 while (*n && strcasecmp(*n, str)) {
602 total_len += strlen(*n) + 2;
609 byte *err = cf_malloc(total_len + strlen(str) + 60), *c = err;
610 c += sprintf(err, "Invalid value %s, possible values are: ", str);
612 c+= sprintf(c, "%s, ", *n);
619 /* Register size of and parser for each basic type */
621 typedef byte *cf_basic_parser(byte *str, void *ptr);
626 { sizeof(int), cf_parse_int },
627 { sizeof(u64), cf_parse_u64 },
628 { sizeof(double), cf_parse_double },
629 { sizeof(u32), cf_parse_ip },
630 { sizeof(byte*), cf_parse_string },
631 { sizeof(int), NULL }, // lookups are parsed extra
632 { 0, NULL }, // user-defined types are parsed extra
636 type_size(enum cf_type type, struct cf_user_type *utype)
639 return parsers[type].size;
645 cf_parse_ary(uns number, byte **pars, void *ptr, enum cf_type type, union cf_union *u)
647 for (uns i=0; i<number; i++)
650 uns size = type_size(type, u->utype);
651 if (type < CT_LOOKUP)
652 msg = ((cf_basic_parser*) parsers[type].parser) (pars[i], ptr + i * size);
653 else if (type == CT_LOOKUP)
654 msg = cf_parse_lookup(pars[i], ptr + i * size, u->lookup);
655 else if (type == CT_USER)
656 msg = u->utype->parser(pars[i], ptr + i * size);
660 return cf_printf("Cannot parse item %d: %s", i+1, msg);
668 static byte *op_names[] = { CF_OPERATIONS };
671 #define OP_MASK 0xff // only get the operation
672 #define OP_OPEN 0x100 // here we only get an opening brace instead of parameters
673 #define OP_1ST 0x200 // in the 1st phase selectors are recorded into the mask
674 #define OP_2ND 0x400 // in the 2nd phase real data are entered
677 interpret_set_dynamic(struct cf_item *item, int number, byte **pars, void **ptr)
679 enum cf_type type = item->type;
680 cf_journal_block(ptr, sizeof(void*));
681 // boundary checks done by the caller
682 uns size = type_size(item->type, item->u.utype);
683 ASSERT(size >= sizeof(uns));
684 *ptr = cf_malloc((number+1) * size) + size;
685 * (uns*) (*ptr - size) = number;
686 return cf_parse_ary(number, pars, *ptr, type, &item->u);
690 interpret_add_dynamic(struct cf_item *item, int number, byte **pars, int *processed, void **ptr, enum cf_operation op)
692 enum cf_type type = item->type;
694 uns size = type_size(item->type, item->u.utype);
695 ASSERT(size >= sizeof(uns));
696 int old_nr = * (int*) (old_p - size);
697 int taken = MIN(number, ABS(item->number)-old_nr);
699 // stretch the dynamic array
700 void *new_p = cf_malloc((old_nr + taken + 1) * size) + size;
701 * (uns*) (new_p - size) = old_nr + taken;
702 cf_journal_block(ptr, sizeof(void*));
704 if (op == OP_APPEND) {
705 memcpy(new_p, old_p, old_nr * size);
706 return cf_parse_ary(taken, pars, new_p + old_nr * size, type, &item->u);
707 } else if (op == OP_PREPEND) {
708 memcpy(new_p + taken * size, old_p, old_nr * size);
709 return cf_parse_ary(taken, pars, new_p, type, &item->u);
711 return cf_printf("Dynamic arrays do not support operation %s", op_names[op]);
714 static byte *interpret_set_item(struct cf_item *item, int number, byte **pars, int *processed, void *ptr, uns allow_dynamic);
717 interpret_section(struct cf_section *sec, int number, byte **pars, int *processed, void *ptr, uns allow_dynamic)
721 for (struct cf_item *ci=sec->cfg; ci->cls; ci++)
724 byte *msg = interpret_set_item(ci, number, pars, &taken, ptr + (addr_int_t) ci->ptr, allow_dynamic && !ci[1].cls);
726 return cf_printf("Item %s: %s", ci->name, msg);
730 if (!number) // stop parsing, because many parsers would otherwise complain that number==0
737 add_to_list(struct cnode *where, struct cnode *new_node, enum cf_operation op)
741 case OP_EDIT: // edition has been done in-place
744 cf_journal_block(&where->prev->next, sizeof(void*));
745 cf_journal_block(&where->next->prev, sizeof(void*));
748 case OP_AFTER: // implementation dependend (prepend_head = after(list)), and where==list, see clists.h:74
750 cf_journal_block(&where->next->prev, sizeof(void*));
751 cf_journal_block(&where->next, sizeof(void*));
752 clist_insert_after(new_node, where);
754 case OP_BEFORE: // implementation dependend (append_tail = before(list))
757 cf_journal_block(&where->prev->next, sizeof(void*));
758 cf_journal_block(&where->prev, sizeof(void*));
759 clist_insert_before(new_node, where);
767 interpret_add_list(struct cf_item *item, int number, byte **pars, int *processed, void *ptr, enum cf_operation op)
770 return cf_printf("You have to open a block for operation %s", op_names[op]);
772 return "Nothing to add to the list";
773 struct cf_section *sec = item->u.sec;
777 void *node = cf_malloc(sec->size);
778 cf_init_section(item->name, sec, node, 1);
779 add_to_list(ptr, node, op);
781 /* If the node contains any dynamic attribute at the end, we suppress
782 * auto-repetition here and pass the flag inside instead. */
783 TRY( interpret_section(sec, number, pars, &taken, node, sec->flags & SEC_FLAG_DYNAMIC) );
787 if (sec->flags & SEC_FLAG_DYNAMIC)
794 interpret_set_item(struct cf_item *item, int number, byte **pars, int *processed, void *ptr, uns allow_dynamic)
801 return "Missing value";
802 taken = MIN(number, item->number);
804 uns size = type_size(item->type, item->u.utype);
805 cf_journal_block(ptr, taken * size);
806 return cf_parse_ary(taken, pars, ptr, item->type, &item->u);
809 return "Dynamic array cannot be used here";
810 taken = MIN(number, ABS(item->number));
812 return interpret_set_dynamic(item, taken, pars, ptr);
814 if (item->number < 0 && !allow_dynamic)
815 return "Parsers with variable number of parameters cannot be used here";
816 if (item->number > 0 && number < item->number)
817 return "Not enough parameters available for the parser";
818 taken = MIN(number, ABS(item->number));
820 for (int i=0; i<taken; i++)
821 pars[i] = cf_strdup(pars[i]);
822 return item->u.par(taken, pars, ptr);
824 return interpret_section(item->u.sec, number, pars, processed, ptr, allow_dynamic);
827 return "Lists cannot be used here";
828 return interpret_add_list(item, number, pars, processed, ptr, OP_SET);
835 interpret_clear(struct cf_item *item, void *ptr)
837 if (item->cls == CC_LIST) {
838 cf_journal_block(ptr, sizeof(struct clist));
840 } else if (item->cls == CC_DYNAMIC) {
841 cf_journal_block(ptr, sizeof(void *));
842 * (void**) ptr = NULL;
844 return "The item is not a list or a dynamic array";
849 cmp_items(void *i1, void *i2, struct cf_item *item)
851 ASSERT(item->cls == CC_STATIC);
852 i1 += (addr_int_t) item->ptr;
853 i2 += (addr_int_t) item->ptr;
854 if (item->type == CT_STRING)
855 return strcmp(* (byte**) i1, * (byte**) i2);
856 else // all numeric types
857 return memcmp(i1, i2, type_size(item->type, item->u.utype));
861 find_list_node(struct clist *list, void *query, struct cf_section *sec, u32 mask)
867 for (uns i=0; i<32; i++)
869 if (cmp_items(n, query, sec->cfg+i))
881 record_selector(struct cf_item *item, struct cf_section *sec, u32 *mask)
883 uns nr = sec->flags & SEC_FLAG_NUMBER;
884 if (item >= sec->cfg && item < sec->cfg + nr) // setting an attribute relative to this section
886 uns i = item - sec->cfg;
888 return "Cannot select list nodes by this attribute";
889 if (sec->cfg[i].cls != CC_STATIC)
890 return "Selection can only be done based on basic attributes";
896 #define MAX_STACK_SIZE 100
897 static struct item_stack {
898 struct cf_section *sec; // nested section
899 void *base_ptr; // because original pointers are often relative
900 enum cf_operation op; // it is performed when a closing brace is encountered
901 void *list; // list the operations should be done on
902 u32 mask; // bit array of selectors searching in a list
903 struct cf_item *item; // cf_item of the list
904 } stack[MAX_STACK_SIZE];
908 opening_brace(struct cf_item *item, void *ptr, enum cf_operation op)
910 if (level >= MAX_STACK_SIZE-1)
911 return "Too many nested sections";
912 stack[++level] = (struct item_stack) {
920 if (!item) // unknown is ignored; we just need to trace recursion
922 stack[level].sec = item->u.sec;
923 if (item->cls == CC_SECTION)
925 stack[level].base_ptr = ptr;
926 stack[level].op = OP_EDIT | OP_2ND; // this list operation does nothing
928 else if (item->cls == CC_LIST)
930 stack[level].base_ptr = cf_malloc(item->u.sec->size);
931 cf_init_section(item->name, item->u.sec, stack[level].base_ptr, 1);
932 stack[level].list = ptr;
933 stack[level].item = item;
934 if ((op & OP_MASK) < OP_REMOVE) {
935 add_to_list(ptr, stack[level].base_ptr, op & OP_MASK);
936 stack[level].op |= OP_2ND;
938 stack[level].op |= OP_1ST;
941 return "Opening brace can only be used on sections and lists";
946 closing_brace(struct item_stack *st, enum cf_operation op, int number, byte **pars)
948 if (st->op == OP_CLOSE) // top-level
949 return "Unmatched } parenthesis";
950 if (!st->sec) { // dummy run on unknown section
955 enum cf_operation pure_op = st->op & OP_MASK;
958 st->list = find_list_node(st->list, st->base_ptr, st->sec, st->mask);
960 return "Cannot find a node matching the query";
961 if (pure_op != OP_REMOVE)
963 if (pure_op == OP_EDIT)
964 st->base_ptr = st->list;
965 else if (pure_op == OP_AFTER || pure_op == OP_BEFORE)
966 cf_init_section(st->item->name, st->sec, st->base_ptr, 1);
969 if (op & OP_OPEN) { // stay at the same recursion level
970 st->op = (st->op | OP_2ND) & ~OP_1ST;
971 add_to_list(st->list, st->base_ptr, pure_op);
974 int taken; // parse parameters on 1 line immediately
975 TRY( interpret_section(st->sec, number, pars, &taken, st->base_ptr, 1) );
978 // and fall-thru to the 2nd phase
980 add_to_list(st->list, st->base_ptr, pure_op);
984 return "No parameters expected after the }";
985 else if (op & OP_OPEN)
986 return "No { is expected";
992 interpret_line(byte *name, enum cf_operation op, int number, byte **pars)
995 if ((op & OP_MASK) == OP_CLOSE)
996 return closing_brace(stack+level, op, number, pars);
997 void *ptr = stack[level].base_ptr;
998 struct cf_item *item = find_item(stack[level].sec, name, &msg, &ptr);
1001 if (stack[level].op & OP_1ST)
1002 TRY( record_selector(item, stack[level].sec, &stack[level].mask) );
1003 if (op & OP_OPEN) { // the operation will be performed after the closing brace
1005 return "Cannot open a block after a parameter has been passed on a line";
1006 return opening_brace(item, ptr, op);
1008 if (!item) // ignored item in an unknown section
1012 int taken; // process as many parameters as possible
1014 taken = 0, msg = interpret_clear(item, ptr);
1015 else if (op == OP_SET)
1016 msg = interpret_set_item(item, number, pars, &taken, ptr, 1);
1017 else if (item->cls == CC_DYNAMIC)
1018 msg = interpret_add_dynamic(item, number, pars, &taken, ptr, op);
1019 else if (item->cls == CC_LIST)
1020 msg = interpret_add_list(item, number, pars, &taken, ptr, op);
1022 return cf_printf("Operation %s not supported on attribute %s", op_names[op], name);
1026 return cf_printf("Too many parameters: %d>%d", number, taken);
1032 cf_write_item(struct cf_item *item, enum cf_operation op, int number, byte **pars)
1038 msg = interpret_set_item(item, number, pars, &taken, item->ptr, 1);
1042 msg = interpret_clear(item, item->ptr);
1046 if (item->cls == CC_DYNAMIC)
1047 msg = interpret_add_dynamic(item, number, pars, &taken, item->ptr, op);
1048 else if (item->cls == CC_LIST)
1049 msg = interpret_add_list(item, number, pars, &taken, item->ptr, op);
1051 return "The attribute class does not support append/prepend";
1054 return "Unsupported operation";
1059 return "Too many parameters";
1068 stack[0] = (struct item_stack) {
1082 log(L_ERROR, "Unterminated block");
1086 if (commit_section("top-level", §ions, NULL, !everything_committed))
1088 everything_committed = 1;
1093 /* Text file parser */
1095 static byte *name_parse_fb;
1096 static struct fastbuf *parse_fb;
1097 static uns line_num;
1099 #define MAX_LINE 4096
1100 static byte line_buf[MAX_LINE];
1101 static byte *line = line_buf;
1103 #include "lib/bbuf.h"
1104 static bb_t copy_buf;
1107 #define GBUF_TYPE uns
1108 #define GBUF_PREFIX(x) split_##x
1109 #include "lib/gbuf.h"
1110 static split_t word_buf;
1112 static uns ends_by_brace; // the line is ended by "{"
1117 if (!bgets(parse_fb, line_buf, MAX_LINE))
1121 while (Cblank(*line))
1127 append(byte *start, byte *end)
1129 uns len = end - start;
1130 bb_grow(©_buf, copied + len + 1);
1131 memcpy(copy_buf.ptr + copied, start, len);
1133 copy_buf.ptr[copied-1] = 0;
1136 #define CONTROL_CHAR(x) (x == '{' || x == '}' || x == ';')
1137 // these characters separate words like blanks
1140 get_word(uns is_command_name)
1142 if (*line == '\'') {
1146 while (*line && *line != '\'')
1148 append(start, line);
1151 copy_buf.ptr[copied-1] = '\n';
1153 return "Unterminated apostrophe word at the end";
1157 } else if (*line == '"') {
1159 uns start_copy = copied;
1164 if (*line == '"' && !escape)
1166 else if (*line == '\\')
1172 append(start, line);
1176 copy_buf.ptr[copied-1] = '\n';
1177 else // merge two lines
1180 return "Unterminated quoted word at the end";
1184 byte *tmp = stk_str_unesc(copy_buf.ptr + start_copy);
1185 uns l = strlen(tmp);
1186 bb_grow(©_buf, start_copy + l + 1);
1187 strcpy(copy_buf.ptr + start_copy, tmp);
1188 copied = start_copy + l + 1;
1191 // promised that *line is non-null and non-blank
1193 while (*line && !Cblank(*line) && !CONTROL_CHAR(*line)
1194 && (*line != '=' || !is_command_name))
1196 if (*line == '=') { // nice for setting from a command-line
1198 return "Assignment without a variable";
1201 if (line == start) // already the first char is control
1203 append(start, line);
1205 while (Cblank(*line))
1211 get_token(uns is_command_name, byte **msg)
1215 if (!*line || *line == '#') {
1216 if (!is_command_name || !get_line())
1218 } else if (*line == ';') {
1220 if (!is_command_name || *msg)
1222 } else if (*line == '\\' && !line[1]) {
1224 *msg = "Last line ends by a backslash";
1227 if (!*line || *line == '#')
1228 log(L_WARN, "The line %s:%d following a backslash is empty", name_parse_fb, line_num);
1230 split_grow(&word_buf, words+1);
1232 word_buf.ptr[words++] = copied;
1233 *msg = get_word(is_command_name);
1234 return *msg ? NULL : copy_buf.ptr + start;
1242 words = copied = ends_by_brace = 0;
1243 byte *msg, *start_word;
1244 if (!(start_word = get_token(1, &msg)))
1246 if (*start_word == '{') // only one opening brace
1247 return "Unexpected opening brace";
1248 while (*line != '}') // stays for the next time
1250 if (!(start_word = get_token(0, &msg)))
1252 if (*start_word == '{') {
1253 words--; // discard the brace
1261 /* Parsing multiple files */
1264 parse_fastbuf(byte *name_fb, struct fastbuf *fb, uns depth)
1267 name_parse_fb = name_fb;
1274 msg = split_command();
1279 byte *name = copy_buf.ptr + word_buf.ptr[0];
1280 byte *pars[words-1];
1281 for (uns i=1; i<words; i++)
1282 pars[i-1] = copy_buf.ptr + word_buf.ptr[i];
1283 if (!strcasecmp(name, "include"))
1286 msg = "Expecting one filename";
1288 msg = "Too many nested files";
1289 else if (*line && *line != '#') // because the contents of line_buf is not re-entrant and will be cleared
1290 msg = "The input command must be the last one on a line";
1293 struct fastbuf *new_fb = bopen_try(pars[0], O_RDONLY, 1<<14);
1295 msg = cf_printf("Cannot open file %s: %m", pars[0]);
1299 msg = parse_fastbuf(pars[0], new_fb, depth+1);
1306 enum cf_operation op;
1307 byte *c = strchr(name, ':');
1309 op = strcmp(name, "}") ? OP_SET : OP_CLOSE;
1312 switch (Clocase(*c)) {
1313 case 's': op = OP_SET; break;
1314 case 'c': op = OP_CLEAR; break;
1315 case 'a': op = Clocase(c[1]) == 'p' ? OP_APPEND : OP_AFTER; break;
1316 case 'p': op = OP_PREPEND; break;
1317 case 'r': op = OP_REMOVE; break;
1318 case 'e': op = OP_EDIT; break;
1319 case 'b': op = OP_BEFORE; break;
1320 default: op = OP_SET; break;
1322 if (strcasecmp(c, op_names[op])) {
1323 msg = cf_printf("Unknown operation %s", c);
1329 msg = interpret_line(name, op, words-1, pars);
1334 log(L_ERROR, "File %s, line %d: %s", name_fb, line_num, msg);
1335 return "included from here";
1338 #undef DEFAULT_CONFIG /* FIXME */
1339 #define DEFAULT_CONFIG "cf/sherlock2"
1341 #ifndef DEFAULT_CONFIG
1342 #define DEFAULT_CONFIG NULL
1344 byte *cf_def_file = DEFAULT_CONFIG;
1347 load_file(byte *file)
1350 struct fastbuf *fb = bopen_try(file, O_RDONLY, 1<<14);
1352 log(L_ERROR, "Cannot open %s: %m", file);
1355 byte *msg = parse_fastbuf(file, fb, 0);
1357 int err = !!msg || done_stack();
1364 load_string(byte *string)
1368 fbbuf_init_read(&fb, string, strlen(string), 0);
1369 byte *msg = parse_fastbuf("memory string", &fb, 0);
1370 return !!msg || done_stack();
1373 /* Command-line parser */
1379 if (cf_load(cf_def_file))
1380 die("Cannot load default config %s", cf_def_file);
1384 cf_get_opt(int argc, char * const argv[], const char *short_opts, const struct option *long_opts, int *long_index)
1386 static int other_options = 0;
1388 int res = getopt_long (argc, argv, short_opts, long_opts, long_index);
1389 if (res == 'S' || res == 'C' || res == 0x64436667)
1392 die("The -S and -C options must precede all other arguments");
1396 die("Cannot set %s", optarg);
1397 } else if (res == 'C') {
1398 if (cf_load(optarg))
1399 die("Cannot load config file %s", optarg);
1402 else { /* --dumpconfig */
1404 struct fastbuf *b = bfdopen(1, 4096);
1405 cf_dump_sections(b);
1410 /* unhandled option or end of options */
1411 if (res != ':' && res != '?')
1422 spaces(struct fastbuf *fb, uns nr)
1424 for (uns i=0; i<nr; i++)
1429 dump_basic(struct fastbuf *fb, void *ptr, enum cf_type type, union cf_union *u)
1432 case CT_INT: bprintf(fb, "%d ", *(uns*)ptr); break;
1433 case CT_U64: bprintf(fb, "%llu ", *(u64*)ptr); break;
1434 case CT_DOUBLE: bprintf(fb, "%lg ", *(double*)ptr); break;
1435 case CT_IP: bprintf(fb, "%08x ", *(uns*)ptr); break;
1438 bprintf(fb, "'%s' ", *(byte**)ptr);
1440 bprintf(fb, "NULL ");
1442 case CT_LOOKUP: bprintf(fb, "%s ", *(int*)ptr >= 0 ? u->lookup[ *(int*)ptr ] : (byte*) "???"); break;
1444 if (u->utype->dumper)
1445 u->utype->dumper(fb, ptr);
1447 bprintf(fb, "??? ");
1452 static void dump_section(struct fastbuf *fb, struct cf_section *sec, int level, void *ptr);
1454 static byte *class_names[] = { "end", "static", "dynamic", "parser", "section", "list" };
1455 static byte *type_names[] = { "int", "u64", "double", "ip", "string", "lookup", "user" };
1458 dump_item(struct fastbuf *fb, struct cf_item *item, int level, void *ptr)
1460 ptr += (addr_int_t) item->ptr;
1461 enum cf_type type = item->type;
1462 uns size = type_size(item->type, item->u.utype);
1465 bprintf(fb, "%s: C%s #", item->name, class_names[item->cls]);
1466 if (item->number == CF_ANY_NUM)
1469 bprintf(fb, "%d ", item->number);
1470 if (item->cls == CC_STATIC || item->cls == CC_DYNAMIC) {
1471 bprintf(fb, "T%s ", type_names[type]);
1472 if (item->type == CT_USER)
1473 bprintf(fb, "U%s S%d ", item->u.utype->name, size);
1475 if (item->cls == CC_STATIC) {
1476 for (i=0; i<item->number; i++)
1477 dump_basic(fb, ptr + i * size, type, &item->u);
1478 } else if (item->cls == CC_DYNAMIC) {
1479 ptr = * (void**) ptr;
1481 int real_nr = * (int*) (ptr - size);
1482 bprintf(fb, "N%d ", real_nr);
1483 for (i=0; i<real_nr; i++)
1484 dump_basic(fb, ptr + i * size, type, &item->u);
1486 bprintf(fb, "NULL ");
1489 if (item->cls == CC_SECTION)
1490 dump_section(fb, item->u.sec, level+1, ptr);
1491 else if (item->cls == CC_LIST) {
1494 CLIST_WALK(n, * (clist*) ptr) {
1495 spaces(fb, level+1);
1496 bprintf(fb, "item %d\n", ++idx);
1497 dump_section(fb, item->u.sec, level+2, n);
1503 dump_section(struct fastbuf *fb, struct cf_section *sec, int level, void *ptr)
1506 bprintf(fb, "S%d F%x:\n", sec->size, sec->flags);
1507 for (struct cf_item *item=sec->cfg; item->cls; item++)
1508 dump_item(fb, item, level, ptr);
1512 cf_dump_sections(struct fastbuf *fb)
1514 dump_section(fb, §ions, 0, NULL);
1518 * - more space efficient journal