lib/conf-intr.c

   1 /*
   2  *      UCW Library -- Configuration files: interpreter
   3  *
   4  *      (c) 2001--2006 Robert Spalek <robert@ucw.cz>
   5  *      (c) 2003--2006 Martin Mares <mj@ucw.cz>
   6  *
   7  *      This software may be freely distributed and used according to the terms
   8  *      of the GNU Lesser General Public License.
   9  */
  10
  11 #include "lib/lib.h"
  12 #include "lib/conf.h"
  13 #include "lib/getopt.h"
  14 #include "lib/conf-internal.h"
  15 #include "lib/clists.h"
  16
  17 #include <string.h>
  18 #include <stdio.h>
  19
  20 #define TRY(f)  do { byte *_msg = f; if (_msg) return _msg; } while (0)
  21
  22 /* Register size of and parser for each basic type */
  23
  24 static byte *
  25 cf_parse_string(byte *str, byte **ptr)
  26 {
  27   *ptr = cf_strdup(str);
  28   return NULL;
  29 }
  30
  31 typedef byte *cf_basic_parser(byte *str, void *ptr);
  32 static struct {
  33   uns size;
  34   void *parser;
  35 } parsers[] = {
  36   { sizeof(int), cf_parse_int },
  37   { sizeof(u64), cf_parse_u64 },
  38   { sizeof(double), cf_parse_double },
  39   { sizeof(u32), cf_parse_ip },
  40   { sizeof(byte*), cf_parse_string },
  41   { sizeof(int), NULL },                        // lookups are parsed extra
  42   { 0, NULL },                                  // user-defined types are parsed extra
  43 };
  44
  45 inline uns
  46 cf_type_size(enum cf_type type, struct cf_user_type *utype)
  47 {
  48   if (type < CT_USER)
  49     return parsers[type].size;
  50   else
  51     return utype->size;
  52 }
  53
  54 static byte *
  55 cf_parse_lookup(byte *str, int *ptr, byte **t)
  56 {
  57   byte **n = t;
  58   uns total_len = 0;
  59   while (*n && strcasecmp(*n, str)) {
  60     total_len += strlen(*n) + 2;
  61     n++;
  62   }
  63   if (*n) {
  64     *ptr = n - t;
  65     return NULL;
  66   }
  67   byte *err = cf_malloc(total_len + strlen(str) + 60), *c = err;
  68   c += sprintf(err, "Invalid value %s, possible values are: ", str);
  69   for (n=t; *n; n++)
  70     c+= sprintf(c, "%s, ", *n);
  71   if (*t)
  72     c[-2] = 0;
  73   *ptr = -1;
  74   return err;
  75 }
  76
  77 static byte *
  78 cf_parse_ary(uns number, byte **pars, void *ptr, enum cf_type type, union cf_union *u)
  79 {
  80   for (uns i=0; i<number; i++)
  81   {
  82     byte *msg;
  83     uns size = cf_type_size(type, u->utype);
  84     if (type < CT_LOOKUP)
  85       msg = ((cf_basic_parser*) parsers[type].parser) (pars[i], ptr + i * size);
  86     else if (type == CT_LOOKUP)
  87       msg = cf_parse_lookup(pars[i], ptr + i * size, u->lookup);
  88     else if (type == CT_USER)
  89       msg = u->utype->parser(pars[i], ptr + i * size);
  90     else
  91       ASSERT(0);
  92     if (msg)
  93       return number > 1 ? cf_printf("Item %d: %s", i+1, msg) : msg;
  94   }
  95   return NULL;
  96 }
  97
  98 /* Interpreter */
  99
 100 #define T(x) #x,
 101 byte *cf_op_names[] = { CF_OPERATIONS };
 102 #undef T
 103
 104 static byte *
 105 interpret_set_dynamic(struct cf_item *item, int number, byte **pars, void **ptr)
 106 {
 107   enum cf_type type = item->type;
 108   cf_journal_block(ptr, sizeof(void*));
 109   // boundary checks done by the caller
 110   uns size = cf_type_size(item->type, item->u.utype);
 111   ASSERT(size >= sizeof(uns));
 112   *ptr = cf_malloc(sizeof(uns) + number * size) + sizeof(uns);
 113   DARY_LEN(*ptr) = number;
 114   return cf_parse_ary(number, pars, *ptr, type, &item->u);
 115 }
 116
 117 static byte *
 118 interpret_add_dynamic(struct cf_item *item, int number, byte **pars, int *processed, void **ptr, enum cf_operation op)
 119 {
 120   enum cf_type type = item->type;
 121   void *old_p = *ptr;
 122   uns size = cf_type_size(item->type, item->u.utype);
 123   ASSERT(size >= sizeof(uns));
 124   int old_nr = old_p ? DARY_LEN(old_p) : 0;
 125   int taken = MIN(number, ABS(item->number)-old_nr);
 126   *processed = taken;
 127   // stretch the dynamic array
 128   void *new_p = cf_malloc(sizeof(uns) + (old_nr + taken) * size) + sizeof(uns);
 129   DARY_LEN(new_p) = old_nr + taken;
 130   cf_journal_block(ptr, sizeof(void*));
 131   *ptr = new_p;
 132   if (op == OP_APPEND) {
 133     memcpy(new_p, old_p, old_nr * size);
 134     return cf_parse_ary(taken, pars, new_p + old_nr * size, type, &item->u);
 135   } else if (op == OP_PREPEND) {
 136     memcpy(new_p + taken * size, old_p, old_nr * size);
 137     return cf_parse_ary(taken, pars, new_p, type, &item->u);
 138   } else
 139     return cf_printf("Dynamic arrays do not support operation %s", cf_op_names[op]);
 140 }
 141
 142 static byte *interpret_set_item(struct cf_item *item, int number, byte **pars, int *processed, void *ptr, uns allow_dynamic);
 143
 144 static byte *
 145 interpret_section(struct cf_section *sec, int number, byte **pars, int *processed, void *ptr, uns allow_dynamic)
 146 {
 147   cf_add_dirty(sec, ptr);
 148   *processed = 0;
 149   for (struct cf_item *ci=sec->cfg; ci->cls; ci++)
 150   {
 151     int taken;
 152     byte *msg = interpret_set_item(ci, number, pars, &taken, ptr + (addr_int_t) ci->ptr, allow_dynamic && !ci[1].cls);
 153     if (msg)
 154       return cf_printf("Item %s: %s", ci->name, msg);
 155     *processed += taken;
 156     number -= taken;
 157     pars += taken;
 158     if (!number)                // stop parsing, because many parsers would otherwise complain that number==0
 159       break;
 160   }
 161   return NULL;
 162 }
 163
 164 static void
 165 add_to_list(cnode *where, cnode *new_node, enum cf_operation op)
 166 {
 167   switch (op)
 168   {
 169     case OP_EDIT:               // edition has been done in-place
 170       break;
 171     case OP_REMOVE:
 172       CF_JOURNAL_VAR(where->prev->next);
 173       CF_JOURNAL_VAR(where->next->prev);
 174       clist_remove(where);
 175       break;
 176     case OP_AFTER:              // implementation dependend (prepend_head = after(list)), and where==list, see clists.h:74
 177     case OP_PREPEND:
 178     case OP_COPY:
 179       CF_JOURNAL_VAR(where->next->prev);
 180       CF_JOURNAL_VAR(where->next);
 181       clist_insert_after(new_node, where);
 182       break;
 183     case OP_BEFORE:             // implementation dependend (append_tail = before(list))
 184     case OP_APPEND:
 185     case OP_SET:
 186       CF_JOURNAL_VAR(where->prev->next);
 187       CF_JOURNAL_VAR(where->prev);
 188       clist_insert_before(new_node, where);
 189       break;
 190     default:
 191       ASSERT(0);
 192   }
 193 }
 194
 195 static byte *
 196 interpret_add_list(struct cf_item *item, int number, byte **pars, int *processed, void *ptr, enum cf_operation op)
 197 {
 198   if (op >= OP_REMOVE)
 199     return cf_printf("You have to open a block for operation %s", cf_op_names[op]);
 200   if (!number)
 201     return "Nothing to add to the list";
 202   struct cf_section *sec = item->u.sec;
 203   *processed = 0;
 204   uns index = 0;
 205   while (number > 0)
 206   {
 207     void *node = cf_malloc(sec->size);
 208     cf_init_section(item->name, sec, node, 1);
 209     add_to_list(ptr, node, op);
 210     int taken;
 211     /* If the node contains any dynamic attribute at the end, we suppress
 212      * auto-repetition here and pass the flag inside instead.  */
 213     index++;
 214     byte *msg = interpret_section(sec, number, pars, &taken, node, sec->flags & SEC_FLAG_DYNAMIC);
 215     if (msg)
 216       return sec->flags & SEC_FLAG_DYNAMIC ? msg : cf_printf("Node %d of list %s: %s", index, item->name, msg);
 217     *processed += taken;
 218     number -= taken;
 219     pars += taken;
 220     if (sec->flags & SEC_FLAG_DYNAMIC)
 221       break;
 222   }
 223   return NULL;
 224 }
 225
 226 static byte *
 227 interpret_set_item(struct cf_item *item, int number, byte **pars, int *processed, void *ptr, uns allow_dynamic)
 228 {
 229   int taken;
 230   switch (item->cls)
 231   {
 232     case CC_STATIC:
 233       if (!number)
 234         return "Missing value";
 235       taken = MIN(number, item->number);
 236       *processed = taken;
 237       uns size = cf_type_size(item->type, item->u.utype);
 238       cf_journal_block(ptr, taken * size);
 239       return cf_parse_ary(taken, pars, ptr, item->type, &item->u);
 240     case CC_DYNAMIC:
 241       if (!allow_dynamic)
 242         return "Dynamic array cannot be used here";
 243       taken = MIN(number, ABS(item->number));
 244       *processed = taken;
 245       return interpret_set_dynamic(item, taken, pars, ptr);
 246     case CC_PARSER:
 247       if (item->number < 0 && !allow_dynamic)
 248         return "Parsers with variable number of parameters cannot be used here";
 249       if (item->number > 0 && number < item->number)
 250         return "Not enough parameters available for the parser";
 251       taken = MIN(number, ABS(item->number));
 252       *processed = taken;
 253       for (int i=0; i<taken; i++)
 254         pars[i] = cf_strdup(pars[i]);
 255       return item->u.par(taken, pars, ptr);
 256     case CC_SECTION:
 257       return interpret_section(item->u.sec, number, pars, processed, ptr, allow_dynamic);
 258     case CC_LIST:
 259       if (!allow_dynamic)
 260         return "Lists cannot be used here";
 261       return interpret_add_list(item, number, pars, processed, ptr, OP_SET);
 262     default:
 263       ASSERT(0);
 264   }
 265 }
 266
 267 static byte *
 268 interpret_clear(struct cf_item *item, void *ptr)
 269 {
 270   if (item->cls == CC_LIST) {
 271     cf_journal_block(ptr, sizeof(clist));
 272     clist_init(ptr);
 273   } else if (item->cls == CC_DYNAMIC) {
 274     cf_journal_block(ptr, sizeof(void *));
 275     static uns zero = 0;
 276     * (void**) ptr = (&zero) + 1;
 277   } else if (item->cls == CC_STATIC && item->type == CT_STRING) {
 278     cf_journal_block(ptr, item->number * sizeof(byte*));
 279     bzero(ptr, item->number * sizeof(byte*));
 280   } else
 281     return "The item is not a list, dynamic array, or string";
 282   return NULL;
 283 }
 284
 285 static int
 286 cmp_items(void *i1, void *i2, struct cf_item *item)
 287 {
 288   ASSERT(item->cls == CC_STATIC);
 289   i1 += (addr_int_t) item->ptr;
 290   i2 += (addr_int_t) item->ptr;
 291   if (item->type == CT_STRING)
 292     return strcmp(* (byte**) i1, * (byte**) i2);
 293   else                          // all numeric types
 294     return memcmp(i1, i2, cf_type_size(item->type, item->u.utype));
 295 }
 296
 297 static void *
 298 find_list_node(clist *list, void *query, struct cf_section *sec, u32 mask)
 299 {
 300   CLIST_FOR_EACH(cnode *, n, *list)
 301   {
 302     uns found = 1;
 303     for (uns i=0; i<32; i++)
 304       if (mask & (1<<i))
 305         if (cmp_items(n, query, sec->cfg+i))
 306         {
 307           found = 0;
 308           break;
 309         }
 310     if (found)
 311       return n;
 312   }
 313   return NULL;
 314 }
 315
 316 static byte *
 317 record_selector(struct cf_item *item, struct cf_section *sec, u32 *mask)
 318 {
 319   uns nr = sec->flags & SEC_FLAG_NUMBER;
 320   if (item >= sec->cfg && item < sec->cfg + nr) // setting an attribute relative to this section
 321   {
 322     uns i = item - sec->cfg;
 323     if (i >= 32)
 324       return "Cannot select list nodes by this attribute";
 325     if (sec->cfg[i].cls != CC_STATIC)
 326       return "Selection can only be done based on basic attributes";
 327     *mask |= 1 << i;
 328   }
 329   return NULL;
 330 }
 331
 332 #define MAX_STACK_SIZE  10
 333 static struct item_stack {
 334   struct cf_section *sec;       // nested section
 335   void *base_ptr;               // because original pointers are often relative
 336   enum cf_operation op;         // it is performed when a closing brace is encountered
 337   void *list;                   // list the operations should be done on
 338   u32 mask;                     // bit array of selectors searching in a list
 339   struct cf_item *item;         // cf_item of the list
 340 } stack[MAX_STACK_SIZE];
 341 static uns level;
 342
 343 static byte *
 344 opening_brace(struct cf_item *item, void *ptr, enum cf_operation op)
 345 {
 346   if (level >= MAX_STACK_SIZE-1)
 347     return "Too many nested sections";
 348   stack[++level] = (struct item_stack) {
 349     .sec = NULL,
 350     .base_ptr = NULL,
 351     .op = op & OP_MASK,
 352     .list = NULL,
 353     .mask = 0,
 354     .item = NULL,
 355   };
 356   if (!item)                    // unknown is ignored; we just need to trace recursion
 357     return NULL;
 358   stack[level].sec = item->u.sec;
 359   if (item->cls == CC_SECTION)
 360   {
 361     stack[level].base_ptr = ptr;
 362     stack[level].op = OP_EDIT | OP_2ND; // this list operation does nothing
 363   }
 364   else if (item->cls == CC_LIST)
 365   {
 366     stack[level].base_ptr = cf_malloc(item->u.sec->size);
 367     cf_init_section(item->name, item->u.sec, stack[level].base_ptr, 1);
 368     stack[level].list = ptr;
 369     stack[level].item = item;
 370     if ((op & OP_MASK) < OP_REMOVE) {
 371       add_to_list(ptr, stack[level].base_ptr, op & OP_MASK);
 372       stack[level].op |= OP_2ND;
 373     } else
 374       stack[level].op |= OP_1ST;
 375   }
 376   else
 377     return "Opening brace can only be used on sections and lists";
 378   return NULL;
 379 }
 380
 381 static byte *
 382 closing_brace(struct item_stack *st, enum cf_operation op, int number, byte **pars)
 383 {
 384   if (st->op == OP_CLOSE)       // top-level
 385     return "Unmatched } parenthesis";
 386   if (!st->sec) {               // dummy run on unknown section
 387     if (!(op & OP_OPEN))
 388       level--;
 389     return NULL;
 390   }
 391   enum cf_operation pure_op = st->op & OP_MASK;
 392   if (st->op & OP_1ST)
 393   {
 394     st->list = find_list_node(st->list, st->base_ptr, st->sec, st->mask);
 395     if (!st->list)
 396       return "Cannot find a node matching the query";
 397     if (pure_op != OP_REMOVE)
 398     {
 399       if (pure_op == OP_EDIT)
 400         st->base_ptr = st->list;
 401       else if (pure_op == OP_AFTER || pure_op == OP_BEFORE)
 402         cf_init_section(st->item->name, st->sec, st->base_ptr, 1);
 403       else if (pure_op == OP_COPY) {
 404         if (st->sec->flags & SEC_FLAG_CANT_COPY)
 405           return cf_printf("Item %s cannot be copied", st->item->name);
 406         memcpy(st->base_ptr, st->list, st->sec->size);  // strings and dynamic arrays are shared
 407         if (st->sec->copy)
 408           TRY( st->sec->copy(st->base_ptr, st->list) );
 409       } else
 410         ASSERT(0);
 411       if (op & OP_OPEN) {       // stay at the same recursion level
 412         st->op = (st->op | OP_2ND) & ~OP_1ST;
 413         add_to_list(st->list, st->base_ptr, pure_op);
 414         return NULL;
 415       }
 416       int taken;                // parse parameters on 1 line immediately
 417       TRY( interpret_section(st->sec, number, pars, &taken, st->base_ptr, 1) );
 418       number -= taken;
 419       pars += taken;
 420       // and fall-thru to the 2nd phase
 421     }
 422     add_to_list(st->list, st->base_ptr, pure_op);
 423   }
 424   level--;
 425   if (number)
 426     return "No parameters expected after the }";
 427   else if (op & OP_OPEN)
 428     return "No { is expected";
 429   else
 430     return NULL;
 431 }
 432
 433 static struct cf_item *
 434 find_item(struct cf_section *curr_sec, byte *name, byte **msg, void **ptr)
 435 {
 436   *msg = NULL;
 437   if (name[0] == '^')                           // absolute name instead of relative
 438     name++, curr_sec = &cf_sections, *ptr = NULL;
 439   if (!curr_sec)                                // don't even search in an unknown section
 440     return NULL;
 441   while (1)
 442   {
 443     if (curr_sec != &cf_sections)
 444       cf_add_dirty(curr_sec, *ptr);
 445     byte *c = strchr(name, '.');
 446     if (c)
 447       *c++ = 0;
 448     struct cf_item *ci = cf_find_subitem(curr_sec, name);
 449     if (!ci->cls)
 450     {
 451       if (!(curr_sec->flags & SEC_FLAG_UNKNOWN))        // ignore silently unknown top-level sections and unknown attributes in flagged sections
 452         *msg = cf_printf("Unknown item %s", name);
 453       return NULL;
 454     }
 455     *ptr += (addr_int_t) ci->ptr;
 456     if (!c)
 457       return ci;
 458     if (ci->cls != CC_SECTION)
 459     {
 460       *msg = cf_printf("Item %s is not a section", name);
 461       return NULL;
 462     }
 463     curr_sec = ci->u.sec;
 464     name = c;
 465   }
 466 }
 467
 468 byte *
 469 cf_interpret_line(byte *name, enum cf_operation op, int number, byte **pars)
 470 {
 471   byte *msg;
 472   if ((op & OP_MASK) == OP_CLOSE)
 473     return closing_brace(stack+level, op, number, pars);
 474   void *ptr = stack[level].base_ptr;
 475   struct cf_item *item = find_item(stack[level].sec, name, &msg, &ptr);
 476   if (msg)
 477     return msg;
 478   if (stack[level].op & OP_1ST)
 479     TRY( record_selector(item, stack[level].sec, &stack[level].mask) );
 480   if (op & OP_OPEN) {           // the operation will be performed after the closing brace
 481     if (number)
 482       return "Cannot open a block after a parameter has been passed on a line";
 483     return opening_brace(item, ptr, op);
 484   }
 485   if (!item)                    // ignored item in an unknown section
 486     return NULL;
 487   op &= OP_MASK;
 488
 489   int taken;                    // process as many parameters as possible
 490   if (op == OP_CLEAR)
 491     taken = 0, msg = interpret_clear(item, ptr);
 492   else if (op == OP_SET)
 493     msg = interpret_set_item(item, number, pars, &taken, ptr, 1);
 494   else if (item->cls == CC_DYNAMIC)
 495     msg = interpret_add_dynamic(item, number, pars, &taken, ptr, op);
 496   else if (item->cls == CC_LIST)
 497     msg = interpret_add_list(item, number, pars, &taken, ptr, op);
 498   else
 499     return cf_printf("Operation %s not supported on attribute %s", cf_op_names[op], name);
 500   if (msg)
 501     return msg;
 502   if (taken < number)
 503     return cf_printf("Too many parameters: %d>%d", number, taken);
 504
 505   return NULL;
 506 }
 507
 508 byte *
 509 cf_find_item(byte *name, struct cf_item *item)
 510 {
 511   byte *msg;
 512   void *ptr;
 513   struct cf_item *ci = find_item(&cf_sections, name, &msg, &ptr);
 514   if (msg)
 515     return msg;
 516   if (ci) {
 517     *item = *ci;
 518     item->ptr = ptr;
 519   } else
 520     bzero(item, sizeof(struct cf_item));
 521   return NULL;
 522 }
 523
 524 byte *
 525 cf_write_item(struct cf_item *item, enum cf_operation op, int number, byte **pars)
 526 {
 527   byte *msg;
 528   int taken;
 529   switch (op) {
 530     case OP_SET:
 531       msg = interpret_set_item(item, number, pars, &taken, item->ptr, 1);
 532       break;
 533     case OP_CLEAR:
 534       taken = 0;
 535       msg = interpret_clear(item, item->ptr);
 536       break;
 537     case OP_APPEND:
 538     case OP_PREPEND:
 539       if (item->cls == CC_DYNAMIC)
 540         msg = interpret_add_dynamic(item, number, pars, &taken, item->ptr, op);
 541       else if (item->cls == CC_LIST)
 542         msg = interpret_add_list(item, number, pars, &taken, item->ptr, op);
 543       else
 544         return "The attribute class does not support append/prepend";
 545       break;
 546     default:
 547       return "Unsupported operation";
 548   }
 549   if (msg)
 550     return msg;
 551   if (taken < number)
 552     return "Too many parameters";
 553   return NULL;
 554 }
 555
 556 void
 557 cf_init_stack(void)
 558 {
 559   static uns initialized = 0;
 560   if (!initialized++) {
 561     cf_sections.flags |= SEC_FLAG_UNKNOWN;
 562     cf_sections.size = 0;                       // size of allocated array used to be stored here
 563     cf_init_section(NULL, &cf_sections, NULL, 0);
 564   }
 565   level = 0;
 566   stack[0] = (struct item_stack) {
 567     .sec = &cf_sections,
 568     .base_ptr = NULL,
 569     .op = OP_CLOSE,
 570     .list = NULL,
 571     .mask = 0,
 572     .item = NULL
 573   };
 574 }
 575
 576 int
 577 cf_check_stack(void)
 578 {
 579   if (level > 0) {
 580     log(L_ERROR, "Unterminated block");
 581     return 1;
 582   }
 583   return 0;
 584 }
 585