sksp2024-mcu/libucw/ucw/conf-intr.c

/*
 *	UCW Library -- Configuration files: interpreter
 *
 *	(c) 2001--2006 Robert Spalek <robert@ucw.cz>
 *	(c) 2003--2014 Martin Mares <mj@ucw.cz>
 *	(c) 2014 Pavel Charvat <pchar@ucw.cz>
 *
 *	This software may be freely distributed and used according to the terms
 *	of the GNU Lesser General Public License.
 */

#include <ucw/lib.h>
#include <ucw/conf.h>
#include <ucw/getopt.h>
#include <ucw/conf-internal.h>
#include <ucw/clists.h>
#include <ucw/gary.h>
#include <ucw/mempool.h>
#include <ucw/xtypes.h>

#include <string.h>
#include <stdio.h>

#define TRY(f)	do { char *_msg = f; if (_msg) return _msg; } while (0)

/* Register size of and parser for each basic type */

static char *
cf_parse_string(char *str, char **ptr)
{
  *ptr = cf_strdup(str);
  return NULL;
}

typedef char *cf_basic_parser(char *str, void *ptr);
static struct {
  uint size;
  void *parser;
} parsers[] = {
  { sizeof(int), cf_parse_int },
  { sizeof(u64), cf_parse_u64 },
  { sizeof(double), cf_parse_double },
  { sizeof(u32), cf_parse_ip },
  { sizeof(char*), cf_parse_string },
  { sizeof(int), NULL },			// lookups are parsed extra
  { 0, NULL },					// user-defined types are parsed extra
};

inline uint
cf_type_size(enum cf_type type, const union cf_union *u)
{
  switch (type)
    {
      case CT_USER:
        return u->utype->size;
      case CT_XTYPE:
	return u->xtype->size;
      default:
	ASSERT(type < ARRAY_SIZE(parsers) - 1);
	return parsers[type].size;
    }
}

static char *
cf_parse_lookup(char *str, int *ptr, const char * const *t)
{
  const char * const *n = t;
  uint total_len = 0;
  while (*n && strcasecmp(*n, str)) {
    total_len += strlen(*n) + 2;
    n++;
  }
  if (*n) {
    *ptr = n - t;
    return NULL;
  }
  char *err = cf_malloc(total_len + strlen(str) + 60), *c = err;
  c += sprintf(err, "Invalid value %s, possible values are: ", str);
  for (n=t; *n; n++)
    c+= sprintf(c, "%s, ", *n);
  if (*t)
    c[-2] = 0;
  *ptr = -1;
  return err;
}

static char *
cf_parse_ary(uint number, char **pars, void *ptr, enum cf_type type, union cf_union *u)
{
  for (uint i=0; i<number; i++)
  {
    char *msg;
    uint size = cf_type_size(type, u);
    if (type < CT_LOOKUP)
      msg = ((cf_basic_parser*) parsers[type].parser) (pars[i], ptr + i * size);
    else if (type == CT_LOOKUP)
      msg = cf_parse_lookup(pars[i], ptr + i * size, u->lookup);
    else if (type == CT_USER)
      msg = u->utype->parser(pars[i], ptr + i * size);
    else if (type == CT_XTYPE)
      msg = (char *)u->xtype->parse(pars[i], ptr + i * size, cf_get_pool());
    else
      ASSERT(0);
    if (msg)
      return number > 1 ? cf_printf("Item %d: %s", i+1, msg) : msg;
  }
  return NULL;
}

/* Interpreter */

#define T(x) #x,
char *cf_op_names[] = { CF_OPERATIONS };
#undef T
char *cf_type_names[] = { "int", "u64", "double", "ip", "string", "lookup", "user", "xtype" };

static char *
interpret_set_dynamic(struct cf_item *item, int number, char **pars, void **ptr)
{
  enum cf_type type = item->type;
  uint size = cf_type_size(type, &item->u);
  cf_journal_block(ptr, sizeof(void*));
  // boundary checks done by the caller
  *ptr = gary_init(size, number, mp_get_allocator(cf_get_pool()));
  return cf_parse_ary(number, pars, *ptr, type, &item->u);
}

static char *
interpret_add_dynamic(struct cf_item *item, int number, char **pars, int *processed, void **ptr, enum cf_operation op)
{
  enum cf_type type = item->type;
  void *old_p = *ptr;
  uint size = cf_type_size(item->type, &item->u);
  ASSERT(size >= sizeof(uint));
  int old_nr = old_p ? GARY_SIZE(old_p) : 0;
  int taken = MIN(number, ABS(item->number)-old_nr);
  *processed = taken;
  // stretch the dynamic array
  void *new_p = gary_init(size, old_nr + taken, mp_get_allocator(cf_get_pool()));
  cf_journal_block(ptr, sizeof(void*));
  *ptr = new_p;
  if (op == OP_APPEND) {
    memcpy(new_p, old_p, old_nr * size);
    return cf_parse_ary(taken, pars, new_p + old_nr * size, type, &item->u);
  } else if (op == OP_PREPEND) {
    memcpy(new_p + taken * size, old_p, old_nr * size);
    return cf_parse_ary(taken, pars, new_p, type, &item->u);
  } else
    return cf_printf("Dynamic arrays do not support operation %s", cf_op_names[op]);
}

static char *interpret_set_item(struct cf_item *item, int number, char **pars, int *processed, void *ptr, uint allow_dynamic);

static char *
interpret_section(struct cf_section *sec, int number, char **pars, int *processed, void *ptr, uint allow_dynamic)
{
  cf_add_dirty(sec, ptr);
  *processed = 0;
  for (struct cf_item *ci=sec->cfg; ci->cls; ci++)
  {
    int taken = 0;		// assignment only to silence false positive warnings in some compilers about possibly uninitialized variable
    char *msg = interpret_set_item(ci, number, pars, &taken, ptr + (uintptr_t) ci->ptr, allow_dynamic && !ci[1].cls);
    if (msg)
      return cf_printf("Item %s: %s", ci->name, msg);
    *processed += taken;
    number -= taken;
    pars += taken;
    if (!number)		// stop parsing, because many parsers would otherwise complain that number==0
      break;
  }
  return NULL;
}

static void
add_to_list(cnode *where, cnode *new_node, enum cf_operation op)
{
  switch (op)
  {
    case OP_EDIT:		// editation has been done in-place
      break;
    case OP_REMOVE:
      CF_JOURNAL_VAR(where->prev->next);
      CF_JOURNAL_VAR(where->next->prev);
      clist_remove(where);
      break;
    case OP_AFTER:		// implementation dependent (prepend_head = after(list)), and where==list, see clists.h:74
    case OP_PREPEND:
    case OP_COPY:
      CF_JOURNAL_VAR(where->next->prev);
      CF_JOURNAL_VAR(where->next);
      clist_insert_after(new_node, where);
      break;
    case OP_BEFORE:		// implementation dependent (append_tail = before(list))
    case OP_APPEND:
    case OP_SET:
      CF_JOURNAL_VAR(where->prev->next);
      CF_JOURNAL_VAR(where->prev);
      clist_insert_before(new_node, where);
      break;
    default:
      ASSERT(0);
  }
}

static char *
interpret_add_list(struct cf_item *item, int number, char **pars, int *processed, void *ptr, enum cf_operation op)
{
  if (op >= OP_REMOVE)
    return cf_printf("You have to open a block for operation %s", cf_op_names[op]);
  if (!number)
    return "Nothing to add to the list";
  struct cf_section *sec = item->u.sec;
  *processed = 0;
  uint index = 0;
  while (number > 0)
  {
    void *node = cf_malloc(sec->size);
    cf_init_section(item->name, sec, node, 1);
    add_to_list(ptr, node, op);
    int taken;
    /* If the node contains any dynamic attribute at the end, we suppress
     * auto-repetition here and pass the flag inside instead.  */
    index++;
    char *msg = interpret_section(sec, number, pars, &taken, node, sec->flags & SEC_FLAG_DYNAMIC);
    if (msg)
      return sec->flags & SEC_FLAG_DYNAMIC ? msg : cf_printf("Node %d of list %s: %s", index, item->name, msg);
    *processed += taken;
    number -= taken;
    pars += taken;
    if (sec->flags & SEC_FLAG_DYNAMIC)
      break;
  }
  return NULL;
}

static char *
interpret_add_bitmap(struct cf_item *item, int number, char **pars, int *processed, u32 *ptr, enum cf_operation op)
{
  if (op == OP_PREPEND || op == OP_APPEND)
    op = OP_SET;
  if (op != OP_SET && op != OP_REMOVE)
    return cf_printf("Cannot apply operation %s on a bitmap", cf_op_names[op]);
  else if (item->type != CT_INT && item->type != CT_LOOKUP)
    return cf_printf("Type %s cannot be used with bitmaps", cf_type_names[item->type]);
  cf_journal_block(ptr, sizeof(u32));
  for (int i=0; i<number; i++) {
    uint idx;
    if (item->type == CT_INT)
      TRY( cf_parse_int(pars[i], &idx) );
    else
      TRY( cf_parse_lookup(pars[i], &idx, item->u.lookup) );
    if (idx >= 32)
      return "Bitmaps only have 32 bits";
    if (op == OP_SET)
      *ptr |= 1<<idx;
    else
      *ptr &= ~(1<<idx);
  }
  *processed = number;
  return NULL;
}

static char *
interpret_set_item(struct cf_item *item, int number, char **pars, int *processed, void *ptr, uint allow_dynamic)
{
  int taken;
  switch (item->cls)
  {
    case CC_STATIC:
      if (!number)
	return "Missing value";
      taken = MIN(number, item->number);
      *processed = taken;
      uint size = cf_type_size(item->type, &item->u);
      cf_journal_block(ptr, taken * size);
      return cf_parse_ary(taken, pars, ptr, item->type, &item->u);
    case CC_DYNAMIC:
      if (!allow_dynamic)
	return "Dynamic array cannot be used here";
      taken = MIN(number, ABS(item->number));
      *processed = taken;
      return interpret_set_dynamic(item, taken, pars, ptr);
    case CC_PARSER:
      if (item->number < 0 && !allow_dynamic)
	return "Parsers with variable number of parameters cannot be used here";
      if (item->number > 0 && number < item->number)
	return "Not enough parameters available for the parser";
      taken = MIN(number, ABS(item->number));
      *processed = taken;
      for (int i=0; i<taken; i++)
	pars[i] = cf_strdup(pars[i]);
      return item->u.par(taken, pars, ptr);
    case CC_SECTION:
      return interpret_section(item->u.sec, number, pars, processed, ptr, allow_dynamic);
    case CC_LIST:
      if (!allow_dynamic)
	return "Lists cannot be used here";
      return interpret_add_list(item, number, pars, processed, ptr, OP_SET);
    case CC_BITMAP:
      if (!allow_dynamic)
	return "Bitmaps cannot be used here";
      return interpret_add_bitmap(item, number, pars, processed, ptr, OP_SET);
    default:
      ASSERT(0);
  }
}

static char *
interpret_set_all(struct cf_item *item, void *ptr, enum cf_operation op)
{
  if (item->cls == CC_BITMAP) {
    cf_journal_block(ptr, sizeof(u32));
    if (op == OP_CLEAR)
      * (u32*) ptr = 0;
    else
      if (item->type == CT_INT)
	* (u32*) ptr = ~0u;
      else {
	uint nr = -1;
	while (item->u.lookup[++nr]);
	* (u32*) ptr = ~0u >> (32-nr);
      }
    return NULL;
  } else if (op != OP_CLEAR)
    return "The item is not a bitmap";

  if (item->cls == CC_LIST) {
    cf_journal_block(ptr, sizeof(clist));
    clist_init(ptr);
  } else if (item->cls == CC_DYNAMIC) {
    cf_journal_block(ptr, sizeof(void *));
    * (void**) ptr = GARY_FOREVER_EMPTY;
  } else if (item->cls == CC_STATIC && item->type == CT_STRING) {
    cf_journal_block(ptr, item->number * sizeof(char*));
    bzero(ptr, item->number * sizeof(char*));
  } else
    return "The item is not a list, dynamic array, bitmap, or string";
  return NULL;
}

static int
cmp_items(void *i1, void *i2, struct cf_item *item)
{
  ASSERT(item->cls == CC_STATIC);
  i1 += (uintptr_t) item->ptr;
  i2 += (uintptr_t) item->ptr;
  if (item->type == CT_STRING)
    return strcmp(* (char**) i1, * (char**) i2);
  else				// all numeric types
    return memcmp(i1, i2, cf_type_size(item->type, &item->u));
}

static void *
find_list_node(clist *list, void *query, struct cf_section *sec, u32 mask)
{
  CLIST_FOR_EACH(cnode *, n, *list)
  {
    uint found = 1;
    for (uint i=0; i<32; i++)
      if (mask & (1<<i))
	if (cmp_items(n, query, sec->cfg+i))
	{
	  found = 0;
	  break;
	}
    if (found)
      return n;
  }
  return NULL;
}

static char *
record_selector(struct cf_item *item, struct cf_section *sec, u32 *mask)
{
  uint nr = sec->flags & SEC_FLAG_NUMBER;
  if (item >= sec->cfg && item < sec->cfg + nr)	// setting an attribute relative to this section
  {
    uint i = item - sec->cfg;
    if (i >= 32)
      return "Cannot select list nodes by this attribute";
    if (sec->cfg[i].cls != CC_STATIC)
      return "Selection can only be done based on basic attributes";
    *mask |= 1 << i;
  }
  return NULL;
}

static char *
opening_brace(struct cf_context *cc, struct cf_item *item, void *ptr, enum cf_operation op)
{
  if (cc->stack_level >= MAX_STACK_SIZE-1)
    return "Too many nested sections";
  enum cf_operation pure_op = op & OP_MASK;
  cc->stack[++cc->stack_level] = (struct item_stack) {
    .sec = NULL,
    .base_ptr = NULL,
    .op = pure_op,
    .list = NULL,
    .mask = 0,
    .item = NULL,
  };
  if (!item)			// unknown is ignored; we just need to trace recursion
    return NULL;
  cc->stack[cc->stack_level].sec = item->u.sec;
  if (item->cls == CC_SECTION)
  {
    if (pure_op != OP_SET)
      return "Only SET operation can be used with a section";
    cc->stack[cc->stack_level].base_ptr = ptr;
    cc->stack[cc->stack_level].op = OP_EDIT | OP_2ND;	// this list operation does nothing
  }
  else if (item->cls == CC_LIST)
  {
    cc->stack[cc->stack_level].base_ptr = cf_malloc(item->u.sec->size);
    cf_init_section(item->name, item->u.sec, cc->stack[cc->stack_level].base_ptr, 1);
    cc->stack[cc->stack_level].list = ptr;
    cc->stack[cc->stack_level].item = item;
    if (pure_op == OP_ALL)
      return "Operation ALL cannot be applied on lists";
    else if (pure_op < OP_REMOVE) {
      add_to_list(ptr, cc->stack[cc->stack_level].base_ptr, pure_op);
      cc->stack[cc->stack_level].op |= OP_2ND;
    } else
      cc->stack[cc->stack_level].op |= OP_1ST;
  }
  else
    return "Opening brace can only be used on sections and lists";
  return NULL;
}

static char *
closing_brace(struct cf_context *cc, struct item_stack *st, enum cf_operation op, int number, char **pars)
{
  if (st->op == OP_CLOSE)	// top-level
    return "Unmatched } parenthesis";
  if (!st->sec) {		// dummy run on unknown section
    if (!(op & OP_OPEN))
      cc->stack_level--;
    return NULL;
  }
  enum cf_operation pure_op = st->op & OP_MASK;
  if (st->op & OP_1ST)
  {
    st->list = find_list_node(st->list, st->base_ptr, st->sec, st->mask);
    if (!st->list)
      return "Cannot find a node matching the query";
    if (pure_op != OP_REMOVE)
    {
      if (pure_op == OP_EDIT)
	st->base_ptr = st->list;
      else if (pure_op == OP_AFTER || pure_op == OP_BEFORE)
	cf_init_section(st->item->name, st->sec, st->base_ptr, 1);
      else if (pure_op == OP_COPY) {
	if (st->sec->flags & SEC_FLAG_CANT_COPY)
	  return cf_printf("Item %s cannot be copied", st->item->name);
	memcpy(st->base_ptr, st->list, st->sec->size);	// strings and dynamic arrays are shared
	if (st->sec->copy)
	  TRY( st->sec->copy(st->base_ptr, st->list) );
      } else
	ASSERT(0);
      if (op & OP_OPEN) {	// stay at the same recursion level
	st->op = (st->op | OP_2ND) & ~OP_1ST;
	add_to_list(st->list, st->base_ptr, pure_op);
	return NULL;
      }
      int taken;		// parse parameters on 1 line immediately
      TRY( interpret_section(st->sec, number, pars, &taken, st->base_ptr, 1) );
      number -= taken;
      pars += taken;
      // and fall-thru to the 2nd phase
    }
    add_to_list(st->list, st->base_ptr, pure_op);
  }
  cc->stack_level--;
  if (number)
    return "No parameters expected after the }";
  else if (op & OP_OPEN)
    return "No { is expected";
  else
    return NULL;
}

static struct cf_item *
find_item(struct cf_section *curr_sec, const char *name, char **msg, void **ptr)
{
  struct cf_context *cc = cf_get_context();
  *msg = NULL;
  if (name[0] == '^')				// absolute name instead of relative
    name++, curr_sec = &cc->sections, *ptr = NULL;
  if (!curr_sec)				// don't even search in an unknown section
    return NULL;
  while (1)
  {
    if (curr_sec != &cc->sections)
      cf_add_dirty(curr_sec, *ptr);
    char *c = strchr(name, '.');
    if (c)
      *c++ = 0;
    struct cf_item *ci = cf_find_subitem(curr_sec, name);
    if (!ci->cls)
    {
      if (!(curr_sec->flags & SEC_FLAG_UNKNOWN))	// ignore silently unknown top-level sections and unknown attributes in flagged sections
	*msg = cf_printf("Unknown item %s", name);
      return NULL;
    }
    *ptr += (uintptr_t) ci->ptr;
    if (!c)
      return ci;
    if (ci->cls != CC_SECTION)
    {
      *msg = cf_printf("Item %s is not a section", name);
      return NULL;
    }
    curr_sec = ci->u.sec;
    name = c;
  }
}

static char *
interpret_add(char *name, struct cf_item *item, int number, char **pars, int *takenp, void *ptr, enum cf_operation op)
{
  switch (item->cls) {
    case CC_DYNAMIC:
      return interpret_add_dynamic(item, number, pars, takenp, ptr, op);
    case CC_LIST:
      return interpret_add_list(item, number, pars, takenp, ptr, op);
    case CC_BITMAP:
      return interpret_add_bitmap(item, number, pars, takenp, ptr, op);
    default:
      return cf_printf("Operation %s not supported on attribute %s", cf_op_names[op], name);
  }
}

char *
cf_interpret_line(struct cf_context *cc, char *name, enum cf_operation op, int number, char **pars)
{
  char *msg;
  if ((op & OP_MASK) == OP_CLOSE)
    return closing_brace(cc, cc->stack+cc->stack_level, op, number, pars);
  void *ptr = cc->stack[cc->stack_level].base_ptr;
  struct cf_item *item = find_item(cc->stack[cc->stack_level].sec, name, &msg, &ptr);
  if (msg)
    return msg;
  if (cc->stack[cc->stack_level].op & OP_1ST)
    TRY( record_selector(item, cc->stack[cc->stack_level].sec, &cc->stack[cc->stack_level].mask) );
  if (op & OP_OPEN) {		// the operation will be performed after the closing brace
    if (number)
      return "Cannot open a block after a parameter has been passed on a line";
    return opening_brace(cc, item, ptr, op);
  }
  if (!item)			// ignored item in an unknown section
    return NULL;
  op &= OP_MASK;

  int taken = 0;		// process as many parameters as possible
  switch (op) {
    case OP_CLEAR:
    case OP_ALL:
      msg = interpret_set_all(item, ptr, op);
      break;
    case OP_SET:
      msg = interpret_set_item(item, number, pars, &taken, ptr, 1);
      break;
    case OP_RESET:
      msg = interpret_set_all(item, ptr, OP_CLEAR);
      if (!msg)
	msg = interpret_add(name, item, number, pars, &taken, ptr, OP_APPEND);
      break;
    default:
      msg = interpret_add(name, item, number, pars, &taken, ptr, op);
  }
  if (msg)
    return msg;
  if (taken < number)
    return cf_printf("Too many parameters: %d>%d", number, taken);

  return NULL;
}

char *
cf_find_item(const char *name, struct cf_item *item)
{
  struct cf_context *cc = cf_get_context();
  char *msg;
  void *ptr = NULL;
  struct cf_item *ci = find_item(&cc->sections, name, &msg, &ptr);
  if (msg)
    return msg;
  if (ci) {
    *item = *ci;
    item->ptr = ptr;
  } else
    bzero(item, sizeof(struct cf_item));
  return NULL;
}

char *
cf_modify_item(struct cf_item *item, enum cf_operation op, int number, char **pars)
{
  char *msg;
  int taken = 0;
  switch (op) {
    case OP_SET:
      msg = interpret_set_item(item, number, pars, &taken, item->ptr, 1);
      break;
    case OP_CLEAR:
    case OP_ALL:
      msg = interpret_set_all(item, item->ptr, op);
      break;
    case OP_APPEND:
    case OP_PREPEND:
      switch (item->cls) {
	case CC_DYNAMIC:
	  msg = interpret_add_dynamic(item, number, pars, &taken, item->ptr, op);
	  break;
	case CC_LIST:
	  msg = interpret_add_list(item, number, pars, &taken, item->ptr, op);
	  break;
	case CC_BITMAP:
	  msg = interpret_add_bitmap(item, number, pars, &taken, item->ptr, op);
	  break;
	default:
	  return "The attribute does not support append/prepend";
      }
      break;
    case OP_REMOVE:
      if (item->cls == CC_BITMAP)
	msg = interpret_add_bitmap(item, number, pars, &taken, item->ptr, op);
      else
	return "Only applicable on bitmaps";
      break;
    default:
      return "Unsupported operation";
  }
  if (msg)
    return msg;
  if (taken < number)
    return "Too many parameters";
  return NULL;
}

void
cf_init_stack(struct cf_context *cc)
{
  if (!cc->sections_initialized++) {
    cc->sections.flags |= SEC_FLAG_UNKNOWN;
    cc->sections.size = 0;			// size of allocated array used to be stored here
    cf_init_section(NULL, &cc->sections, NULL, 0);
  }
  cc->stack_level = 0;
  cc->stack[0] = (struct item_stack) {
    .sec = &cc->sections,
    .base_ptr = NULL,
    .op = OP_CLOSE,
    .list = NULL,
    .mask = 0,
    .item = NULL
  };
}

int
cf_done_stack(struct cf_context *cc)
{
  return (cc->stack_level > 0);
}