uci.h

   1 /*
   2  * libuci - Library for the Unified Configuration Interface
   3  * Copyright (C) 2008 Felix Fietkau <nbd@openwrt.org>
   4  *
   5  * this program is free software; you can redistribute it and/or modify
   6  * it under the terms of the gnu lesser general public license version 2.1
   7  * as published by the free software foundation
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  */
  14
  15 #ifndef __LIBUCI_H
  16 #define __LIBUCI_H
  17
  18 /*
  19  * you can use these defines to enable debugging behavior for
  20  * apps compiled against libuci:
  21  *
  22  * #define UCI_DEBUG_TYPECAST:
  23  *   enable uci_element typecast checking at run time
  24  *
  25  */
  26
  27 #ifdef DEBUG_ALL
  28 #define UCI_DEBUG
  29 #define UCI_DEBUG_TYPECAST
  30 #endif
  31
  32 #include <stdbool.h>
  33 #include <setjmp.h>
  34 #include <stdio.h>
  35
  36 #define UCI_CONFDIR "/etc/config"
  37
  38 enum
  39 {
  40         UCI_OK = 0,
  41         UCI_ERR_MEM,
  42         UCI_ERR_INVAL,
  43         UCI_ERR_NOTFOUND,
  44         UCI_ERR_IO,
  45         UCI_ERR_PARSE,
  46         UCI_ERR_UNKNOWN,
  47         UCI_ERR_LAST
  48 };
  49
  50 struct uci_list;
  51 struct uci_list
  52 {
  53         struct uci_list *next;
  54         struct uci_list *prev;
  55 };
  56
  57 struct uci_element;
  58 struct uci_package;
  59 struct uci_section;
  60 struct uci_option;
  61 struct uci_history;
  62 struct uci_parse_context;
  63
  64
  65 /**
  66  * uci_alloc_context: Allocate a new uci context
  67  */
  68 extern struct uci_context *uci_alloc_context(void);
  69
  70 /**
  71  * uci_free_context: Free the uci context including all of its data
  72  */
  73 extern void uci_free_context(struct uci_context *ctx);
  74
  75 /**
  76  * uci_perror: Print the last uci error that occured
  77  * @ctx: uci context
  78  * @str: string to print before the error message
  79  */
  80 extern void uci_perror(struct uci_context *ctx, const char *str);
  81
  82 /**
  83  * uci_import: Import uci config data from a stream
  84  * @ctx: uci context
  85  * @stream: file stream to import from
  86  * @name: (optional) assume the config has the given name
  87  * @package: (optional) store the last parsed config package in this variable
  88  *
  89  * the name parameter is for config files that don't explicitly use the 'package <...>' keyword
  90  */
  91 extern int uci_import(struct uci_context *ctx, FILE *stream, const char *name, struct uci_package **package);
  92
  93 /**
  94  * uci_export: Export one or all uci config packages
  95  * @ctx: uci context
  96  * @stream: output stream
  97  * @package: (optional) uci config package to export
  98  * @header: include the package header
  99  */
 100 extern int uci_export(struct uci_context *ctx, FILE *stream, struct uci_package *package, bool header);
 101
 102 /**
 103  * uci_load: Parse an uci config file and store it in the uci context
 104  *
 105  * @ctx: uci context
 106  * @name: name of the config file (relative to the config directory)
 107  * @package: store the loaded config package in this variable
 108  */
 109 extern int uci_load(struct uci_context *ctx, const char *name, struct uci_package **package);
 110
 111 /**
 112  * uci_unload: Unload a config file from the uci context
 113  *
 114  * @ctx: uci context
 115  * @package: pointer to the uci_package struct
 116  */
 117 extern int uci_unload(struct uci_context *ctx, struct uci_package *p);
 118
 119 /**
 120  * uci_cleanup: Clean up after an error
 121  *
 122  * @ctx: uci context
 123  */
 124 extern int uci_cleanup(struct uci_context *ctx);
 125
 126 /**
 127  * uci_lookup: Look up an uci element
 128  *
 129  * @ctx: uci context
 130  * @res: where to store the result
 131  * @package: uci_package struct
 132  * @section: config section (optional)
 133  * @option: option to search for (optional)
 134  *
 135  * If section is omitted, then a pointer to the config package is returned
 136  * If option is omitted, then a pointer to the config section is returned
 137  */
 138 extern int uci_lookup(struct uci_context *ctx, struct uci_element **res, struct uci_package *package, char *section, char *option);
 139
 140 /**
 141  * uci_set_element_value: Replace an element's value with a new one
 142  * @ctx: uci context
 143  * @element: pointer to an uci_element struct pointer
 144  * @value: new value
 145  *
 146  * Only valid for uci_option and uci_section. Will replace the type string
 147  * when used with an uci_section
 148  */
 149 extern int uci_set_element_value(struct uci_context *ctx, struct uci_element **element, char *value);
 150
 151 /**
 152  * uci_set: Set an element's value; create the element if necessary
 153  * @ctx: uci context
 154  * @package: package name
 155  * @section: section name
 156  * @option: option name
 157  * @value: value (option) or type (section)
 158  */
 159 extern int uci_set(struct uci_context *ctx, char *package, char *section, char *option, char *value);
 160
 161 /**
 162  * uci_commit: commit changes to a package
 163  * @ctx: uci context
 164  * @p: uci_package struct
 165  */
 166 extern int uci_commit(struct uci_context *ctx, struct uci_package *p);
 167
 168 /**
 169  * uci_list_configs: List available uci config files
 170  *
 171  * @ctx: uci context
 172  */
 173 extern char **uci_list_configs(struct uci_context *ctx);
 174
 175 /* UCI data structures */
 176 enum uci_type {
 177         UCI_TYPE_PACKAGE = 0,
 178         UCI_TYPE_SECTION = 1,
 179         UCI_TYPE_OPTION = 2
 180 };
 181
 182 struct uci_element
 183 {
 184         struct uci_list list;
 185         enum uci_type type;
 186         char *name;
 187 };
 188
 189 struct uci_context
 190 {
 191         /* list of config packages */
 192         struct uci_list root;
 193
 194         /* parser context, use for error handling only */
 195         struct uci_parse_context *pctx;
 196
 197         /* private: */
 198         int errno;
 199         const char *func;
 200         jmp_buf trap;
 201         char *buf;
 202         int bufsz;
 203 };
 204
 205 struct uci_parse_context
 206 {
 207         /* error context */
 208         const char *reason;
 209         int line;
 210         int byte;
 211
 212         /* private: */
 213         struct uci_package *package;
 214         struct uci_section *section;
 215         FILE *file;
 216         const char *name;
 217         char *buf;
 218         int bufsz;
 219 };
 220
 221 struct uci_package
 222 {
 223         struct uci_element e;
 224         struct uci_list sections;
 225         struct uci_context *ctx;
 226         bool confdir;
 227         char *path;
 228
 229         /* private: */
 230         int n_section;
 231         struct uci_list history;
 232 };
 233
 234 struct uci_section
 235 {
 236         struct uci_element e;
 237         struct uci_list options;
 238         struct uci_package *package;
 239         char *type;
 240 };
 241
 242 struct uci_option
 243 {
 244         struct uci_element e;
 245         struct uci_section *section;
 246         char *value;
 247 };
 248
 249 enum uci_command {
 250         UCI_CMD_ADD,
 251         UCI_CMD_REMOVE,
 252         UCI_CMD_CHANGE
 253 };
 254
 255 struct uci_history
 256 {
 257         struct uci_list list;
 258         enum uci_command cmd;
 259         char *section;
 260         char *option;
 261         char *value;
 262 };
 263
 264 /* linked list handling */
 265 #ifndef offsetof
 266 #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
 267 #endif
 268
 269 /**
 270  * container_of - cast a member of a structure out to the containing structure
 271  * @ptr:    the pointer to the member.
 272  * @type:   the type of the container struct this is embedded in.
 273  * @member: the name of the member within the struct.
 274  */
 275 #define container_of(ptr, type, member) \
 276         ((type *) ((char *)ptr - offsetof(type,member)))
 277
 278
 279 /**
 280  * uci_list_entry: casts an uci_list pointer to the containing struct.
 281  * @_type: config, section or option
 282  * @_ptr: pointer to the uci_list struct
 283  */
 284 #define element_to(type, ptr) \
 285         container_of(ptr, struct uci_ ## type, e)
 286
 287 #define list_to_element(ptr) \
 288         container_of(ptr, struct uci_element, list)
 289
 290 /**
 291  * uci_foreach_entry: loop through a list of uci elements
 292  * @_list: pointer to the uci_list struct
 293  * @_ptr: iteration variable, struct uci_element
 294  *
 295  * use like a for loop, e.g:
 296  *   uci_foreach(&list, p) {
 297  *      ...
 298  *   }
 299  */
 300 #define uci_foreach_element(_list, _ptr)                \
 301         for(_ptr = list_to_element((_list)->next);      \
 302                 &_ptr->list != (_list);                 \
 303                 _ptr = list_to_element(_ptr->list.next))
 304
 305 /**
 306  * uci_foreach_entry_safe: like uci_foreach_safe, but safe for deletion
 307  * @_list: pointer to the uci_list struct
 308  * @_tmp: temporary variable, struct uci_element *
 309  * @_ptr: iteration variable, struct uci_element *
 310  *
 311  * use like a for loop, e.g:
 312  *   uci_foreach(&list, p) {
 313  *      ...
 314  *   }
 315  */
 316 #define uci_foreach_element_safe(_list, _tmp, _ptr)             \
 317         for(_ptr = list_to_element((_list)->next),              \
 318                 _tmp = list_to_element(_ptr->list.next);        \
 319                 &_ptr->list != (_list);                 \
 320                 _ptr = _tmp, _tmp = list_to_element(_ptr->list.next))
 321
 322 /**
 323  * uci_list_empty: returns true if a list is empty
 324  * @list: list head
 325  */
 326 #define uci_list_empty(list) ((list)->next == (list))
 327
 328 /* wrappers for dynamic type handling */
 329 #define uci_type_package UCI_TYPE_PACKAGE
 330 #define uci_type_section UCI_TYPE_SECTION
 331 #define uci_type_option UCI_TYPE_OPTION
 332
 333 /* element typecasting */
 334 #ifdef UCI_DEBUG_TYPECAST
 335 static const char *uci_typestr[] = {
 336         [uci_type_package] = "package",
 337         [uci_type_section] = "section",
 338         [uci_type_option] = "option"
 339 };
 340
 341 static void uci_typecast_error(int from, int to)
 342 {
 343         fprintf(stderr, "Invalid typecast from '%s' to '%s'\n", uci_typestr[from], uci_typestr[to]);
 344 }
 345
 346 #define BUILD_CAST(_type) \
 347         static inline struct uci_ ## _type *uci_to_ ## _type (struct uci_element *e) \
 348         { \
 349                 if (e->type != uci_type_ ## _type) { \
 350                         uci_typecast_error(e->type, uci_type_ ## _type); \
 351                 } \
 352                 return (struct uci_ ## _type *) e; \
 353         }
 354
 355 BUILD_CAST(package)
 356 BUILD_CAST(section)
 357 BUILD_CAST(option)
 358
 359 #else
 360 #define uci_to_package(ptr) container_of(ptr, struct uci_package, e)
 361 #define uci_to_section(ptr) container_of(ptr, struct uci_section, e)
 362 #define uci_to_option(ptr)  container_of(ptr, struct uci_option, e)
 363 #endif
 364
 365 /**
 366  * uci_alloc_element: allocate a generic uci_element, reserve a buffer and typecast
 367  * @ctx: uci context
 368  * @type: {package,section,option}
 369  * @name: string containing the name of the element
 370  * @datasize: additional buffer size to reserve at the end of the struct
 371  */
 372 #define uci_alloc_element(ctx, type, name, datasize) \
 373         uci_to_ ## type (uci_alloc_generic(ctx, uci_type_ ## type, name, sizeof(struct uci_ ## type) + datasize))
 374
 375 #define uci_dataptr(ptr) \
 376         (((char *) ptr) + sizeof(*ptr))
 377
 378 #endif