lib/conf2.c

   1 /*
   2  *      UCW Library -- Reading of configuration files
   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/conf2.h"
  13 #include "lib/mempool.h"
  14 #include "lib/clists.h"
  15
  16 #include <stdlib.h>
  17 #include <string.h>
  18 #include <errno.h>
  19
  20 /* Memory allocation */
  21
  22 struct mempool *cf_pool;        // current pool for loading new configuration
  23 static struct old_pools {
  24   struct old_pools *prev;
  25   struct mempool *pool;
  26 } *pools;                       // link-list of older cf_pool's
  27
  28 void *
  29 cf_malloc(uns size)
  30 {
  31   return mp_alloc(cf_pool, size);
  32 }
  33
  34 void *
  35 cf_malloc_zero(uns size)
  36 {
  37   return mp_alloc_zero(cf_pool, size);
  38 }
  39
  40 byte *
  41 cf_strdup(byte *s)
  42 {
  43   return mp_strdup(cf_pool, s);
  44 }
  45
  46 byte *
  47 cf_printf(char *fmt, ...)
  48 {
  49   va_list args;
  50   va_start(args, fmt);
  51   byte *res = mp_vprintf(cf_pool, fmt, args);
  52   va_end(args);
  53   return res;
  54 }
  55
  56 /* Undo journal */
  57
  58 uns cf_need_journal;            // some programs do not need journal
  59 static struct journal_item {
  60   struct journal_item *prev;
  61   byte *ptr;
  62   uns len;
  63   byte copy[0];
  64 } *journal;
  65
  66 void
  67 cf_journal_block(void *ptr, uns len)
  68 {
  69   if (!cf_need_journal)
  70     return;
  71   struct journal_item *ji = cf_malloc(sizeof(struct journal_item) + len);
  72   ji->prev = journal;
  73   ji->ptr = ptr;
  74   ji->len = len;
  75   memcpy(ji->copy, ptr, len);
  76   journal = ji;
  77 }
  78
  79 static void
  80 journal_swap(void)
  81   // swaps the contents of the memory and the journal, and reverses the list
  82 {
  83   struct journal_item *curr, *prev, *next;
  84   for (next=NULL, curr=journal; curr; next=curr, curr=prev)
  85   {
  86     prev = curr->prev;
  87     curr->prev = next;
  88     for (uns i=0; i<curr->len; i++)
  89     {
  90       byte x = curr->copy[i];
  91       curr->copy[i] = curr->ptr[i];
  92       curr->ptr[i] = x;
  93     }
  94   }
  95   journal = next;
  96 }
  97
  98 static struct journal_item *
  99 journal_new_section(uns new_pool)
 100 {
 101   if (new_pool)
 102     cf_pool = mp_new(1<<14);
 103   struct journal_item *oldj = journal;
 104   journal = NULL;
 105   return oldj;
 106 }
 107
 108 static void
 109 journal_commit_section(uns new_pool, struct journal_item *oldj)
 110 {
 111   if (new_pool)
 112   {
 113     struct old_pools *p = cf_malloc(sizeof(struct old_pools));
 114     p->prev = pools;
 115     p->pool = cf_pool;
 116     pools = p;
 117   }
 118   if (oldj)
 119   {
 120     struct journal_item **j = &journal;
 121     while (*j)
 122       j = &(*j)->prev;
 123     *j = oldj;
 124   }
 125 }
 126
 127 static void
 128 journal_rollback_section(uns new_pool, struct journal_item *oldj, byte *msg)
 129 {
 130   if (!cf_need_journal)
 131     die("Cannot rollback the configuration, because the journal is disabled.  Error: %s", msg);
 132   journal_swap();
 133   journal = oldj;
 134   if (new_pool)
 135   {
 136     mp_delete(cf_pool);
 137     cf_pool = pools ? pools->pool : NULL;
 138   }
 139 }
 140
 141 /* Initialization */
 142
 143 #define SEC_FLAG_DYNAMIC 0x80000000     // contains a dynamic attribute
 144 #define SEC_FLAG_NUMBER 0x7fffffff      // number of entries
 145
 146 static struct cf_section sections;      // root section
 147
 148 static struct cf_item *
 149 find_subitem(struct cf_section *sec, byte *name)
 150 {
 151   struct cf_item *ci = sec->cfg;
 152   for (; ci->cls; ci++)
 153     if (!strcasecmp(ci->name, name))
 154       return ci;
 155   return ci;
 156 }
 157
 158 static void
 159 inspect_section(struct cf_section *sec)
 160 {
 161   sec->flags = 0;
 162   struct cf_item *ci;
 163   for (ci=sec->cfg; ci->cls; ci++)
 164     if (ci->cls == CC_SECTION) {
 165       inspect_section(ci->u.sec);
 166       sec->flags |= ci->u.sec->flags & SEC_FLAG_DYNAMIC;
 167     } else if (ci->cls == CC_LIST) {
 168       inspect_section(ci->u.sec);
 169       sec->flags |= SEC_FLAG_DYNAMIC;
 170     } else if (ci->cls == CC_DYNAMIC || ci->cls == CC_PARSER && ci->number < 0)
 171       sec->flags |= SEC_FLAG_DYNAMIC;
 172   sec->flags |= ci - sec->cfg;
 173 }
 174
 175 void
 176 cf_declare_section(byte *name, struct cf_section *sec)
 177 {
 178   if (!sections.cfg)
 179   {
 180     sections.size = 50;
 181     sections.cfg = xmalloc_zero(sections.size * sizeof(struct cf_item));
 182   }
 183   struct cf_item *ci = find_subitem(&sections, name);
 184   if (ci->cls)
 185     die("Cannot register section %s twice", name);
 186   ci->cls = CC_SECTION;
 187   ci->name = name;
 188   ci->number = 1;
 189   ci->ptr = NULL;
 190   ci->u.sec = sec;
 191   inspect_section(sec);
 192   ci++;
 193   if (ci - sections.cfg >= (int) sections.size)
 194   {
 195     sections.cfg = xrealloc(sections.cfg, 2*sections.size * sizeof(struct cf_item));
 196     bzero(sections.cfg + sections.size, sections.size * sizeof(struct cf_item));
 197     sections.size *= 2;
 198   }
 199 }
 200
 201 void
 202 cf_init_section(byte *name, struct cf_section *sec, void *ptr)
 203 {
 204   if (sec->size)
 205     bzero(ptr, sec->size);
 206   for (uns i=0; sec->cfg[i].cls; i++)
 207     if (sec->cfg[i].cls == CC_SECTION)
 208       cf_init_section(sec->cfg[i].name, sec->cfg[i].u.sec, ptr + (addr_int_t) sec->cfg[i].ptr);
 209     else if (sec->cfg[i].cls == CC_LIST)
 210       clist_init(sec->cfg[i].ptr);
 211   byte *msg = sec->init(ptr);
 212   if (msg)
 213     die("Cannot initialize section %s: %s", name, msg);
 214 }
 215
 216 static void
 217 global_init(void)
 218 {
 219   for (struct cf_item *ci=sections.cfg; ci->cls; ci++)
 220     cf_init_section(ci->name, ci->u.sec, NULL);
 221 }
 222
 223 static struct cf_item *
 224 find_item(struct cf_section *curr_sec, byte *name, byte **msg)
 225 {
 226   *msg = NULL;
 227   if (name[0] == '^')                           // absolute name instead of relative
 228     name++, curr_sec = &sections;
 229   if (!curr_sec)                                // don't even search in an unknown section
 230     return NULL;
 231   while (1)
 232   {
 233     byte *c = strchr(name, '.');
 234     if (c)
 235       *c++ = 0;
 236     struct cf_item *ci = find_subitem(curr_sec, name);
 237     if (!ci->cls)
 238     {
 239       if (curr_sec != &sections)                // ignore silently unknown top-level sections
 240         *msg = cf_printf("Unknown item %s", name);
 241       return NULL;
 242     }
 243     if (!c)
 244       return ci;
 245     if (ci->cls != CC_SECTION)
 246     {
 247       *msg = cf_printf("Item %s is not a section", name);
 248       return NULL;
 249     }
 250     curr_sec = ci->u.sec;
 251     name = c;
 252   }
 253 }
 254
 255 /* Safe loading and reloading */
 256
 257 byte *cf_def_file = DEFAULT_CONFIG;
 258
 259 #ifndef DEFAULT_CONFIG
 260 #define DEFAULT_CONFIG NULL
 261 #endif
 262
 263 byte *cfdeffile = DEFAULT_CONFIG;
 264
 265 static byte *load_file(byte *file);
 266 static byte *load_string(byte *string);
 267
 268 byte *
 269 cf_reload(byte *file)
 270 {
 271   journal_swap();
 272   struct journal_item *oldj = journal_new_section(1);
 273   byte *msg = load_file(file);
 274   if (!msg)
 275   {
 276     for (struct old_pools *p=pools; p; p=pools)
 277     {
 278       pools = p->prev;
 279       mp_delete(p->pool);
 280     }
 281     journal_commit_section(1, NULL);
 282   }
 283   else
 284   {
 285     journal_rollback_section(1, oldj, msg);
 286     journal_swap();
 287   }
 288   return msg;
 289 }
 290
 291 byte *
 292 cf_load(byte *file)
 293 {
 294   struct journal_item *oldj = journal_new_section(1);
 295   byte *msg = load_file(file);
 296   if (!msg)
 297     journal_commit_section(1, oldj);
 298   else
 299     journal_rollback_section(1, oldj, msg);
 300   return msg;
 301 }
 302
 303 byte *
 304 cf_set(byte *string)
 305 {
 306   struct journal_item *oldj = journal_new_section(0);
 307   byte *msg = load_string(string);
 308   if (!msg)
 309     journal_commit_section(0, oldj);
 310   else
 311     journal_rollback_section(0, oldj, msg);
 312   return msg;
 313 }
 314
 315 /* Parsers for standard types */
 316
 317 struct unit {
 318   uns name;                     // one-letter name of the unit
 319   uns num, den;                 // fraction
 320 };
 321
 322 static const struct unit units[] = {
 323   { 'd', 86400, 1 },
 324   { 'h', 3600, 1 },
 325   { 'k', 1000, 1 },
 326   { 'm', 1000000, 1 },
 327   { 'g', 1000000000, 1 },
 328   { 'K', 1024, 1 },
 329   { 'M', 1048576, 1 },
 330   { 'G', 1073741824, 1 },
 331   { '%', 1, 100 },
 332   { 0, 0, 0 }
 333 };
 334
 335 static const struct unit *
 336 lookup_unit(byte *value, byte *end, byte **msg)
 337 {
 338   if (end && *end) {
 339     if (end == value || end[1] || *end >= '0' && *end <= '9')
 340       *msg = "Invalid number";
 341     else {
 342       for (const struct unit *u=units; u->name; u++)
 343         if (u->name == *end)
 344           return u;
 345       *msg = "Invalid unit";
 346     }
 347   }
 348   return NULL;
 349 }
 350
 351 static char cf_rngerr[] = "Number out of range";
 352
 353 byte *
 354 cf_parse_int(byte *str, int *ptr)
 355 {
 356   byte *msg = NULL;
 357   if (!*str)
 358     msg = "Missing number";
 359   else {
 360     const struct unit *u;
 361     char *end;
 362     errno = 0;
 363     uns x = strtoul(str, &end, 0);
 364     if (errno == ERANGE)
 365       msg = cf_rngerr;
 366     else if (u = lookup_unit(str, end, &msg)) {
 367       u64 y = (u64)x * u->num;
 368       if (y % u->den)
 369         msg = "Number is not an integer";
 370       else {
 371         y /= u->den;
 372         if (y > 0xffffffff)
 373           msg = cf_rngerr;
 374         *ptr = y;
 375       }
 376     } else
 377       *ptr = x;
 378   }
 379   return msg;
 380 }
 381
 382 byte *
 383 cf_parse_u64(byte *str, u64 *ptr)
 384 {
 385   byte *msg = NULL;
 386   if (!*str)
 387     msg = "Missing number";
 388   else {
 389     const struct unit *u;
 390     char *end;
 391     errno = 0;
 392     u64 x = strtoull(str, &end, 0);
 393     if (errno == ERANGE)
 394       msg = cf_rngerr;
 395     else if (u = lookup_unit(str, end, &msg)) {
 396       if (x > ~(u64)0 / u->num)
 397         msg = "Number out of range";
 398       else {
 399         x *= u->num;
 400         if (x % u->den)
 401           msg = "Number is not an integer";
 402         else
 403           *ptr = x / u->den;
 404       }
 405     } else
 406       *ptr = x;
 407   }
 408   return msg;
 409 }
 410
 411 byte *
 412 cf_parse_double(byte *str, double *ptr)
 413 {
 414   byte *msg = NULL;
 415   if (!*str)
 416     msg = "Missing number";
 417   else {
 418     const struct unit *u;
 419     char *end;
 420     errno = 0;
 421     double x = strtoul(str, &end, 0);
 422     if (errno == ERANGE)
 423       msg = cf_rngerr;
 424     else if (u = lookup_unit(str, end, &msg))
 425       *ptr = x * u->num / u->den;
 426     else
 427       *ptr = x;
 428   }
 429   return msg;
 430 }
 431
 432 static byte *
 433 cf_parse_string(byte *str, byte **ptr)
 434 {
 435   *ptr = cf_strdup(str);
 436   return NULL;
 437 }
 438
 439 /* Register size of and parser for each basic type */
 440
 441 typedef byte *cf_basic_parser(byte *str, void *ptr);
 442 static struct {
 443   uns size;
 444   void *parser;
 445 } parsers[] = {
 446   { sizeof(int), cf_parse_int },
 447   { sizeof(u64), cf_parse_u64 },
 448   { sizeof(double), cf_parse_double },
 449   { sizeof(byte*), cf_parse_string }
 450 };
 451
 452 static byte *
 453 cf_parse_ary(uns number, byte **pars, void *ptr, enum cf_type type)
 454 {
 455   for (uns i=0; i<number; i++)
 456   {
 457     byte *msg = ((cf_basic_parser*) parsers[type].parser) (pars[i], ptr + i * parsers[type].size);
 458     if (msg)
 459       return cf_printf("Cannot parse item %d: %s", i+1, msg);
 460   }
 461   return NULL;
 462 }
 463
 464 /* Interpreter */
 465
 466 enum operation {
 467   OP_CLEAR,                     // list
 468   OP_SET,                       // basic attribute (static, dynamic, parsed), section, list
 469   OP_APPEND,                    // dynamic array, list
 470   OP_PREPEND,                   // dynamic array, list
 471   OP_REMOVE,                    // list
 472 };
 473 #define OP_MASK 0x3f            // only get the operation
 474 #define OP_OPEN 0x40            // here we only get an opening brace
 475 #define OP_RECORD 0x80          // record selectors into the mask
 476
 477 #define MAX_STACK_SIZE  100
 478 static struct item_stack {
 479   struct cf_section *sec;       // nested section
 480   void *base_ptr;               // because original pointers are often relative
 481   enum operation op;            // it is performed when a closing brace is encountered
 482   u32 mask;                     // bit array of selectors searching in a list
 483 } stack[MAX_STACK_SIZE];
 484 static uns level;
 485
 486 static byte *
 487 interpret_set_dynamic(struct cf_item *item, int number, byte **pars, void **ptr)
 488 {
 489   enum cf_type type = item->u.type;
 490   cf_journal_block(ptr, sizeof(void*));
 491   // boundary checks done by the caller
 492   *ptr = cf_malloc((number+1) * parsers[type].size) + parsers[type].size;
 493   * (uns*) (*ptr - parsers[type].size) = number;
 494   return cf_parse_ary(number, pars, *ptr, type);
 495 }
 496
 497 static byte *
 498 interpret_add_dynamic(struct cf_item *item, int number, byte **pars, int *processed, void **ptr, enum operation op)
 499 {
 500   enum cf_type type = item->u.type;
 501   void *old_p = *ptr;
 502   int old_nr = * (int*) (old_p - parsers[type].size);
 503   int taken = MIN(number, item->number-old_nr);
 504   *processed = taken;
 505   // stretch the dynamic array
 506   void *new_p = cf_malloc((old_nr + taken + 1) * parsers[type].size) + parsers[type].size;
 507   * (uns*) (new_p - parsers[type].size) = old_nr + taken;
 508   cf_journal_block(ptr, sizeof(void*));
 509   *ptr = new_p;
 510   if (op == OP_APPEND)
 511   {
 512     memcpy(new_p, old_p, old_nr * parsers[type].size);
 513     return cf_parse_ary(taken, pars, new_p + old_nr * parsers[type].size, type);
 514   }
 515   else if (op == OP_PREPEND)
 516   {
 517     memcpy(new_p + taken * parsers[type].size, old_p, old_nr * parsers[type].size);
 518     return cf_parse_ary(taken, pars, new_p, type);
 519   }
 520   else
 521     ASSERT(0);
 522 }
 523
 524 static byte *interpret_set_item(struct cf_item *item, int number, byte **pars, int *processed, void *ptr, uns allow_dynamic);
 525
 526 static byte *
 527 interpret_section(struct cf_section *sec, int number, byte **pars, int *processed, void *ptr, uns allow_dynamic)
 528 {
 529   *processed = 0;
 530   for (struct cf_item *ci=sec->cfg; ci->cls; ci++)
 531   {
 532     int taken;
 533     byte *msg = interpret_set_item(ci, number, pars, &taken, ptr + (addr_int_t) ci->ptr, allow_dynamic && !ci[1].cls);
 534     if (msg)
 535       return cf_printf("Item %s: %s", ci->name, msg);
 536     *processed += taken;
 537     number -= taken;
 538     pars += taken;
 539     if (!number)                // stop parsing, because many parsers would complain that number==0
 540       break;
 541   }
 542   return NULL;
 543 }
 544
 545 static void
 546 add_to_list(struct clist *list, struct cnode *node, enum operation op)
 547 {
 548   cf_journal_block(list, sizeof(struct clist));
 549   if (op == OP_APPEND)
 550     clist_add_tail(list, node);
 551   else if (op == OP_PREPEND)
 552     clist_add_head(list, node);
 553   else
 554     ASSERT(0);
 555 }
 556
 557 static byte *
 558 interpret_add_list(struct cf_item *item, int number, byte **pars, int *processed, void *ptr, enum operation op)
 559 {
 560   /* If the node contains any dynamic attribute at the end, we suppress
 561    * repetition here and pass it inside instead.  */
 562   struct cf_section *sec = item->u.sec;
 563   *processed = 0;
 564   while (number > 0)
 565   {
 566     void *node = cf_malloc(sec->size);
 567     cf_init_section(item->name, sec, node);
 568     add_to_list(ptr, node, op);
 569     int taken;
 570     byte *msg = interpret_section(sec, number, pars, &taken, node, sec->flags & SEC_FLAG_DYNAMIC);
 571     if (msg)
 572       return msg;
 573     *processed += taken;
 574     number -= taken;
 575     pars += taken;
 576     if (sec->flags & SEC_FLAG_DYNAMIC)
 577       break;
 578   }
 579   return NULL;
 580 }
 581
 582 static byte *
 583 interpret_set_item(struct cf_item *item, int number, byte **pars, int *processed, void *ptr, uns allow_dynamic)
 584 {
 585   int taken;
 586   switch (item->cls)
 587   {
 588     case CC_STATIC:
 589       taken = MIN(number, item->number);
 590       *processed = taken;
 591       cf_journal_block(ptr, taken * parsers[item->u.type].size);
 592       return cf_parse_ary(taken, pars, ptr, item->u.type);
 593     case CC_DYNAMIC:
 594       if (!allow_dynamic)
 595         return "Dynamic array cannot be used here";
 596       taken = MIN(number, item->number);
 597       *processed = taken;
 598       return interpret_set_dynamic(item, taken, pars, ptr);
 599     case CC_PARSER:
 600       if (item->number < 0 && !allow_dynamic)
 601         return "Parsers with variable number of parameters cannot be used here";
 602       if (item->number > 0 && number < item->number)
 603         return "Not enough parameters available for the parser";
 604       taken = MIN(number, ABS(item->number));
 605       *processed = taken;
 606       for (int i=0; i<taken; i++)
 607         pars[i] = cf_strdup(pars[i]);
 608       return item->u.par(taken, pars, ptr);
 609     case CC_SECTION:
 610       return interpret_section(item->u.sec, number, pars, processed, ptr, allow_dynamic);
 611     case CC_LIST:
 612       if (!allow_dynamic)
 613         return "Lists cannot be used here";
 614       return interpret_add_list(item, number, pars, ptr, processed, OP_APPEND);
 615     default:
 616       ASSERT(0);
 617   }
 618 }
 619
 620 static byte *
 621 interpret_clear(struct cf_item *item, void *ptr)
 622 {
 623   if (item->cls == CC_LIST) {
 624     cf_journal_block(ptr, sizeof(struct clist));
 625     clist_init(ptr);
 626   } else if (item->cls == CC_DYNAMIC) {
 627     cf_journal_block(ptr, sizeof(void *));
 628     * (void**) ptr = NULL;
 629   } else
 630     return "The item is not a list or a dynamic array";
 631   return NULL;
 632 }
 633
 634 static byte *
 635 record_selector(struct cf_item *item)
 636 {
 637   struct cf_section *sec = stack[level].sec;
 638   uns nr = sec->flags & SEC_FLAG_NUMBER;
 639   if (item >= sec->cfg && item < sec->cfg + nr) // setting an attribute relative to this section
 640   {
 641     uns i = item - sec->cfg;
 642     if (i >= 32)
 643       return "Cannot select list nodes by this attribute";
 644     stack[level].mask |= 1 << i;
 645   }
 646   return NULL;
 647 }
 648
 649 static byte *
 650 increase_stack(struct cf_item *item, enum operation op)
 651 {
 652   if (level >= MAX_STACK_SIZE-1)
 653     return "Too many nested sections";
 654   ++level;
 655   if (item)                     // fill in the base pointer
 656   {
 657     if (item->cls == CC_SECTION)
 658       stack[level].base_ptr = stack[level].base_ptr + (addr_int_t) item->ptr;
 659     else if (item->cls != CC_LIST)
 660     {
 661       stack[level].base_ptr = cf_malloc(item->u.sec->size);
 662       cf_init_section(item->name, item->u.sec, stack[level].base_ptr);
 663     }
 664     else
 665       return "Opening brace can only be used on sections and lists";
 666     stack[level].sec = item->u.sec;
 667   }
 668   else                          // unknown is also handled here, since we need to trace recursion
 669   {
 670     stack[level].base_ptr = NULL;
 671     stack[level].sec = NULL;
 672   }
 673   stack[level].op = op;
 674   stack[level].mask = 0;
 675   return NULL;
 676 }
 677
 678 static byte *
 679 interpret_line(byte *name, enum operation op, int number, byte **pars)
 680 {
 681   byte *msg;
 682   struct cf_item *item = find_item(stack[level].sec, name, &msg);
 683   if (msg)
 684     return msg;
 685   if (stack[level].op & OP_RECORD) {
 686     msg = record_selector(item);
 687     if (msg)
 688       return msg;
 689   }
 690   if (op & OP_OPEN)             // the operation will be performed after the closing brace
 691     return increase_stack(item, op);
 692   if (!item)                    // ignored item in an unknown section
 693     return NULL;
 694
 695   void *ptr = stack[level].base_ptr + (addr_int_t) item->ptr;
 696   int taken;                    // process as many parameters as possible
 697   op &= OP_MASK;
 698   if (op == OP_CLEAR)
 699     taken = 0, msg = interpret_clear(item, ptr);
 700   else if (op == OP_SET)
 701     msg = interpret_set_item(item, number, pars, &taken, ptr, 1);
 702   else if (item->cls == CC_DYNAMIC)
 703     msg = interpret_add_dynamic(item, number, pars, &taken, ptr, op);
 704   else if (item->cls == CC_LIST)
 705     msg = interpret_add_list(item, number, pars, &taken, ptr, op);
 706   else
 707     return cf_printf("Operation %d not supported for class %d", op, item->cls);
 708   if (msg)
 709     return msg;
 710   if (taken < number)
 711     return cf_printf("Too many parameters: %d>%d", number, taken);
 712   return NULL;
 713 }
 714