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 #include "uci_config.h"
  19
  20 /*
  21  * you can use these defines to enable debugging behavior for
  22  * apps compiled against libuci:
  23  *
  24  * #define UCI_DEBUG_TYPECAST:
  25  *   enable uci_element typecast checking at run time
  26  *
  27  */
  28
  29 #include <stdbool.h>
  30 #include <setjmp.h>
  31 #include <stdio.h>
  32
  33 #define UCI_CONFDIR "/etc/config"
  34 #define UCI_SAVEDIR "/tmp/.uci"
  35 #define UCI_DIRMODE 0700
  36 #define UCI_FILEMODE 0600
  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_DUPLICATE,
  47         UCI_ERR_UNKNOWN,
  48         UCI_ERR_LAST
  49 };
  50
  51 struct uci_list;
  52 struct uci_list
  53 {
  54         struct uci_list *next;
  55         struct uci_list *prev;
  56 };
  57
  58 struct uci_ptr;
  59 struct uci_plugin;
  60 struct uci_hook_ops;
  61 struct uci_element;
  62 struct uci_package;
  63 struct uci_section;
  64 struct uci_option;
  65 struct uci_history;
  66 struct uci_context;
  67 struct uci_backend;
  68 struct uci_parse_context;
  69
  70
  71 /**
  72  * uci_alloc_context: Allocate a new uci context
  73  */
  74 extern struct uci_context *uci_alloc_context(void);
  75
  76 /**
  77  * uci_free_context: Free the uci context including all of its data
  78  */
  79 extern void uci_free_context(struct uci_context *ctx);
  80
  81 /**
  82  * uci_perror: Print the last uci error that occured
  83  * @ctx: uci context
  84  * @str: string to print before the error message
  85  */
  86 extern void uci_perror(struct uci_context *ctx, const char *str);
  87
  88 /**
  89  * uci_geterror: Get an error string for the last uci error
  90  * @ctx: uci context
  91  * @dest: target pointer for the string
  92  * @str: prefix for the error message
  93  *
  94  * Note: string must be freed by the caller
  95  */
  96 extern void uci_get_errorstr(struct uci_context *ctx, char **dest, const char *str);
  97
  98 /**
  99  * uci_import: Import uci config data from a stream
 100  * @ctx: uci context
 101  * @stream: file stream to import from
 102  * @name: (optional) assume the config has the given name
 103  * @package: (optional) store the last parsed config package in this variable
 104  * @single: ignore the 'package' keyword and parse everything into a single package
 105  *
 106  * the name parameter is for config files that don't explicitly use the 'package <...>' keyword
 107  * if 'package' points to a non-null struct pointer, enable history tracking and merge
 108  */
 109 extern int uci_import(struct uci_context *ctx, FILE *stream, const char *name, struct uci_package **package, bool single);
 110
 111 /**
 112  * uci_export: Export one or all uci config packages
 113  * @ctx: uci context
 114  * @stream: output stream
 115  * @package: (optional) uci config package to export
 116  * @header: include the package header
 117  */
 118 extern int uci_export(struct uci_context *ctx, FILE *stream, struct uci_package *package, bool header);
 119
 120 /**
 121  * uci_load: Parse an uci config file and store it in the uci context
 122  *
 123  * @ctx: uci context
 124  * @name: name of the config file (relative to the config directory)
 125  * @package: store the loaded config package in this variable
 126  */
 127 extern int uci_load(struct uci_context *ctx, const char *name, struct uci_package **package);
 128
 129 /**
 130  * uci_unload: Unload a config file from the uci context
 131  *
 132  * @ctx: uci context
 133  * @package: pointer to the uci_package struct
 134  */
 135 extern int uci_unload(struct uci_context *ctx, struct uci_package *p);
 136
 137 /**
 138  * uci_lookup_ptr: Split an uci tuple string and look up an element tree
 139  * @ctx: uci context
 140  * @ptr: lookup result struct
 141  * @str: uci tuple string to look up
 142  * @extended: allow extended syntax lookup
 143  *
 144  * if extended is set to true, uci_lookup_ptr supports the following
 145  * extended syntax:
 146  *
 147  * Examples:
 148  *   network.@interface[0].ifname ('ifname' option of the first interface section)
 149  *   network.@interface[-1]       (last interface section)
 150  * Note: uci_lookup_ptr will automatically load a config package if necessary
 151  * @str must not be constant, as it will be modified and used for the strings inside @ptr,
 152  * thus it must also be available as long as @ptr is in use.
 153  */
 154 extern int uci_lookup_ptr(struct uci_context *ctx, struct uci_ptr *ptr, char *str, bool extended);
 155
 156 /**
 157  * uci_add_section: Add an unnamed section
 158  * @ctx: uci context
 159  * @p: package to add the section to
 160  * @type: section type
 161  * @res: pointer to store a reference to the new section in
 162  */
 163 extern int uci_add_section(struct uci_context *ctx, struct uci_package *p, const char *type, struct uci_section **res);
 164
 165 /**
 166  * uci_set: Set an element's value; create the element if necessary
 167  * @ctx: uci context
 168  * @ptr: uci pointer
 169  *
 170  * The updated/created element is stored in ptr->last
 171  */
 172 extern int uci_set(struct uci_context *ctx, struct uci_ptr *ptr);
 173
 174 /**
 175  * uci_add_list: Append a string to an element list
 176  * @ctx: uci context
 177  * @ptr: uci pointer (with value)
 178  *
 179  * Note: if the given option already contains a string value,
 180  * it will be converted to an 1-element-list before appending the next element
 181  */
 182 extern int uci_add_list(struct uci_context *ctx, struct uci_ptr *ptr);
 183
 184 /**
 185  * uci_reorder: Reposition a section
 186  * @ctx: uci context
 187  * @s: uci section to reposition
 188  * @pos: new position in the section list
 189  */
 190 extern int uci_reorder_section(struct uci_context *ctx, struct uci_section *s, int pos);
 191
 192 /**
 193  * uci_rename: Rename an element
 194  * @ctx: uci context
 195  * @ptr: uci pointer (with value)
 196  */
 197 extern int uci_rename(struct uci_context *ctx, struct uci_ptr *ptr);
 198
 199 /**
 200  * uci_delete: Delete a section or option
 201  * @ctx: uci context
 202  * @ptr: uci pointer
 203  */
 204 extern int uci_delete(struct uci_context *ctx, struct uci_ptr *ptr);
 205
 206 /**
 207  * uci_save: save change history for a package
 208  * @ctx: uci context
 209  * @p: uci_package struct
 210  */
 211 extern int uci_save(struct uci_context *ctx, struct uci_package *p);
 212
 213 /**
 214  * uci_commit: commit changes to a package
 215  * @ctx: uci context
 216  * @p: uci_package struct pointer
 217  * @overwrite: overwrite existing config data and flush history
 218  *
 219  * committing may reload the whole uci_package data,
 220  * the supplied pointer is updated accordingly
 221  */
 222 extern int uci_commit(struct uci_context *ctx, struct uci_package **p, bool overwrite);
 223
 224 /**
 225  * uci_list_configs: List available uci config files
 226  * @ctx: uci context
 227  *
 228  * caller is responsible for freeing the allocated memory behind list
 229  */
 230 extern int uci_list_configs(struct uci_context *ctx, char ***list);
 231
 232 /**
 233  * uci_set_savedir: override the default history save directory
 234  * @ctx: uci context
 235  * @dir: directory name
 236  */
 237 extern int uci_set_savedir(struct uci_context *ctx, const char *dir);
 238
 239 /**
 240  * uci_set_savedir: override the default config storage directory
 241  * @ctx: uci context
 242  * @dir: directory name
 243  */
 244 extern int uci_set_confdir(struct uci_context *ctx, const char *dir);
 245
 246 /**
 247  * uci_add_history_path: add a directory to the search path for change history files
 248  * @ctx: uci context
 249  * @dir: directory name
 250  *
 251  * This function allows you to add directories, which contain 'overlays'
 252  * for the active config, that will never be committed.
 253  */
 254 extern int uci_add_history_path(struct uci_context *ctx, const char *dir);
 255
 256 /**
 257  * uci_revert: revert all changes to a config item
 258  * @ctx: uci context
 259  * @ptr: uci pointer
 260  */
 261 extern int uci_revert(struct uci_context *ctx, struct uci_ptr *ptr);
 262
 263 /**
 264  * uci_parse_argument: parse a shell-style argument, with an arbitrary quoting style
 265  * @ctx: uci context
 266  * @stream: input stream
 267  * @str: pointer to the current line (use NULL for parsing the next line)
 268  * @result: pointer for the result
 269  */
 270 extern int uci_parse_argument(struct uci_context *ctx, FILE *stream, char **str, char **result);
 271
 272 /**
 273  * uci_set_backend: change the default backend
 274  * @ctx: uci context
 275  * @name: name of the backend
 276  *
 277  * The default backend is "file", which uses /etc/config for config storage
 278  */
 279 extern int uci_set_backend(struct uci_context *ctx, const char *name);
 280
 281 /**
 282  * uci_validate_text: validate a value string for uci options
 283  * @str: value
 284  *
 285  * this function checks whether a given string is acceptable as value
 286  * for uci options
 287  */
 288 extern bool uci_validate_text(const char *str);
 289
 290
 291 /**
 292  * uci_add_hook: add a uci hook
 293  * @ctx: uci context
 294  * @ops: uci hook ops
 295  *
 296  * NB: allocated and freed by the caller
 297  */
 298 extern int uci_add_hook(struct uci_context *ctx, const struct uci_hook_ops *ops);
 299
 300 /**
 301  * uci_remove_hook: remove a uci hook
 302  * @ctx: uci context
 303  * @ops: uci hook ops
 304  */
 305 extern int uci_remove_hook(struct uci_context *ctx, const struct uci_hook_ops *ops);
 306
 307 /**
 308  * uci_load_plugin: load an uci plugin
 309  * @ctx: uci context
 310  * @filename: path to the uci plugin
 311  *
 312  * NB: plugin will be unloaded automatically when the context is freed
 313  */
 314 int uci_load_plugin(struct uci_context *ctx, const char *filename);
 315
 316 /**
 317  * uci_load_plugins: load all uci plugins from a directory
 318  * @ctx: uci context
 319  * @pattern: pattern of uci plugin files (optional)
 320  *
 321  * if pattern is NULL, then uci_load_plugins will call uci_load_plugin
 322  * for uci_*.so in <prefix>/lib/
 323  */
 324 int uci_load_plugins(struct uci_context *ctx, const char *pattern);
 325
 326 /**
 327  * uci_parse_ptr: parse a uci string into a uci_ptr
 328  * @ctx: uci context
 329  * @ptr: target data structure
 330  * @str: string to parse
 331  *
 332  * str is modified by this function
 333  */
 334 int uci_parse_ptr(struct uci_context *ctx, struct uci_ptr *ptr, char *str);
 335
 336 /* UCI data structures */
 337 enum uci_type {
 338         UCI_TYPE_UNSPEC = 0,
 339         UCI_TYPE_HISTORY = 1,
 340         UCI_TYPE_PACKAGE = 2,
 341         UCI_TYPE_SECTION = 3,
 342         UCI_TYPE_OPTION = 4,
 343         UCI_TYPE_PATH = 5,
 344         UCI_TYPE_BACKEND = 6,
 345         UCI_TYPE_ITEM = 7,
 346         UCI_TYPE_HOOK = 8,
 347         UCI_TYPE_PLUGIN = 9,
 348 };
 349
 350 enum uci_option_type {
 351         UCI_TYPE_STRING = 0,
 352         UCI_TYPE_LIST = 1,
 353 };
 354
 355 enum uci_flags {
 356         UCI_FLAG_STRICT =        (1 << 0), /* strict mode for the parser */
 357         UCI_FLAG_PERROR =        (1 << 1), /* print parser error messages */
 358         UCI_FLAG_EXPORT_NAME =   (1 << 2), /* when exporting, name unnamed sections */
 359         UCI_FLAG_SAVED_HISTORY = (1 << 3), /* store the saved history in memory as well */
 360 };
 361
 362 struct uci_element
 363 {
 364         struct uci_list list;
 365         enum uci_type type;
 366         char *name;
 367 };
 368
 369 struct uci_backend
 370 {
 371         struct uci_element e;
 372         char **(*list_configs)(struct uci_context *ctx);
 373         struct uci_package *(*load)(struct uci_context *ctx, const char *name);
 374         void (*commit)(struct uci_context *ctx, struct uci_package **p, bool overwrite);
 375
 376         /* private: */
 377         const void *ptr;
 378         void *priv;
 379 };
 380
 381 struct uci_context
 382 {
 383         /* list of config packages */
 384         struct uci_list root;
 385
 386         /* parser context, use for error handling only */
 387         struct uci_parse_context *pctx;
 388
 389         /* backend for import and export */
 390         struct uci_backend *backend;
 391         struct uci_list backends;
 392
 393         /* uci runtime flags */
 394         enum uci_flags flags;
 395
 396         char *confdir;
 397         char *savedir;
 398
 399         /* search path for history files */
 400         struct uci_list history_path;
 401
 402         /* private: */
 403         int err;
 404         const char *func;
 405         jmp_buf trap;
 406         bool internal, nested;
 407         char *buf;
 408         int bufsz;
 409
 410         struct uci_list hooks;
 411         struct uci_list plugins;
 412 };
 413
 414 struct uci_package
 415 {
 416         struct uci_element e;
 417         struct uci_list sections;
 418         struct uci_context *ctx;
 419         bool has_history;
 420         char *path;
 421
 422         /* private: */
 423         struct uci_backend *backend;
 424         void *priv;
 425         int n_section;
 426         struct uci_list history;
 427         struct uci_list saved_history;
 428 };
 429
 430 struct uci_section
 431 {
 432         struct uci_element e;
 433         struct uci_list options;
 434         struct uci_package *package;
 435         bool anonymous;
 436         char *type;
 437 };
 438
 439 struct uci_option
 440 {
 441         struct uci_element e;
 442         struct uci_section *section;
 443         enum uci_option_type type;
 444         union {
 445                 struct uci_list list;
 446                 char *string;
 447         } v;
 448 };
 449
 450 enum uci_command {
 451         UCI_CMD_ADD,
 452         UCI_CMD_REMOVE,
 453         UCI_CMD_CHANGE,
 454         UCI_CMD_RENAME,
 455         UCI_CMD_REORDER,
 456         UCI_CMD_LIST_ADD,
 457 };
 458
 459 struct uci_history
 460 {
 461         struct uci_element e;
 462         enum uci_command cmd;
 463         char *section;
 464         char *value;
 465 };
 466
 467 struct uci_ptr
 468 {
 469         enum uci_type target;
 470         enum {
 471                 UCI_LOOKUP_DONE =     (1 << 0),
 472                 UCI_LOOKUP_COMPLETE = (1 << 1),
 473                 UCI_LOOKUP_EXTENDED = (1 << 2),
 474         } flags;
 475
 476         struct uci_package *p;
 477         struct uci_section *s;
 478         struct uci_option *o;
 479         struct uci_element *last;
 480
 481         const char *package;
 482         const char *section;
 483         const char *option;
 484         const char *value;
 485 };
 486
 487 struct uci_hook_ops
 488 {
 489         void (*load)(const struct uci_hook_ops *ops, struct uci_package *p);
 490         void (*set)(const struct uci_hook_ops *ops, struct uci_package *p, struct uci_history *e);
 491 };
 492
 493 struct uci_hook
 494 {
 495         struct uci_element e;
 496         const struct uci_hook_ops *ops;
 497 };
 498
 499 struct uci_plugin_ops
 500 {
 501         int (*attach)(struct uci_context *ctx);
 502         void (*detach)(struct uci_context *ctx);
 503 };
 504
 505 struct uci_plugin
 506 {
 507         struct uci_element e;
 508         const struct uci_plugin_ops *ops;
 509         void *dlh;
 510 };
 511
 512
 513 /* linked list handling */
 514 #ifndef offsetof
 515 #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
 516 #endif
 517
 518 /**
 519  * container_of - cast a member of a structure out to the containing structure
 520  * @ptr:    the pointer to the member.
 521  * @type:   the type of the container struct this is embedded in.
 522  * @member: the name of the member within the struct.
 523  */
 524 #ifndef container_of
 525 #define container_of(ptr, type, member) \
 526         ((type *) ((char *)ptr - offsetof(type,member)))
 527 #endif
 528
 529
 530 /**
 531  * uci_list_entry: casts an uci_list pointer to the containing struct.
 532  * @_type: config, section or option
 533  * @_ptr: pointer to the uci_list struct
 534  */
 535 #define list_to_element(ptr) \
 536         container_of(ptr, struct uci_element, list)
 537
 538 /**
 539  * uci_foreach_entry: loop through a list of uci elements
 540  * @_list: pointer to the uci_list struct
 541  * @_ptr: iteration variable, struct uci_element
 542  *
 543  * use like a for loop, e.g:
 544  *   uci_foreach(&list, p) {
 545  *      ...
 546  *   }
 547  */
 548 #define uci_foreach_element(_list, _ptr)                \
 549         for(_ptr = list_to_element((_list)->next);      \
 550                 &_ptr->list != (_list);                 \
 551                 _ptr = list_to_element(_ptr->list.next))
 552
 553 /**
 554  * uci_foreach_entry_safe: like uci_foreach_safe, but safe for deletion
 555  * @_list: pointer to the uci_list struct
 556  * @_tmp: temporary variable, struct uci_element *
 557  * @_ptr: iteration variable, struct uci_element *
 558  *
 559  * use like a for loop, e.g:
 560  *   uci_foreach(&list, p) {
 561  *      ...
 562  *   }
 563  */
 564 #define uci_foreach_element_safe(_list, _tmp, _ptr)             \
 565         for(_ptr = list_to_element((_list)->next),              \
 566                 _tmp = list_to_element(_ptr->list.next);        \
 567                 &_ptr->list != (_list);                 \
 568                 _ptr = _tmp, _tmp = list_to_element(_ptr->list.next))
 569
 570 /**
 571  * uci_list_empty: returns true if a list is empty
 572  * @list: list head
 573  */
 574 #define uci_list_empty(list) ((list)->next == (list))
 575
 576 /* wrappers for dynamic type handling */
 577 #define uci_type_backend UCI_TYPE_BACKEND
 578 #define uci_type_history UCI_TYPE_HISTORY
 579 #define uci_type_package UCI_TYPE_PACKAGE
 580 #define uci_type_section UCI_TYPE_SECTION
 581 #define uci_type_option UCI_TYPE_OPTION
 582 #define uci_type_hook UCI_TYPE_HOOK
 583 #define uci_type_plugin UCI_TYPE_PLUGIN
 584
 585 /* element typecasting */
 586 #ifdef UCI_DEBUG_TYPECAST
 587 static const char *uci_typestr[] = {
 588         [uci_type_backend] = "backend",
 589         [uci_type_history] = "history",
 590         [uci_type_package] = "package",
 591         [uci_type_section] = "section",
 592         [uci_type_option] = "option",
 593         [uci_type_hook] = "hook",
 594         [uci_type_plugin] = "plugin",
 595 };
 596
 597 static void uci_typecast_error(int from, int to)
 598 {
 599         fprintf(stderr, "Invalid typecast from '%s' to '%s'\n", uci_typestr[from], uci_typestr[to]);
 600 }
 601
 602 #define BUILD_CAST(_type) \
 603         static inline struct uci_ ## _type *uci_to_ ## _type (struct uci_element *e) \
 604         { \
 605                 if (e->type != uci_type_ ## _type) { \
 606                         uci_typecast_error(e->type, uci_type_ ## _type); \
 607                 } \
 608                 return (struct uci_ ## _type *) e; \
 609         }
 610
 611 BUILD_CAST(backend)
 612 BUILD_CAST(history)
 613 BUILD_CAST(package)
 614 BUILD_CAST(section)
 615 BUILD_CAST(option)
 616 BUILD_CAST(hook)
 617 BUILD_CAST(plugin)
 618
 619 #else
 620 #define uci_to_backend(ptr) container_of(ptr, struct uci_backend, e)
 621 #define uci_to_history(ptr) container_of(ptr, struct uci_history, e)
 622 #define uci_to_package(ptr) container_of(ptr, struct uci_package, e)
 623 #define uci_to_section(ptr) container_of(ptr, struct uci_section, e)
 624 #define uci_to_option(ptr)  container_of(ptr, struct uci_option, e)
 625 #define uci_to_hook(ptr)    container_of(ptr, struct uci_hook, e)
 626 #define uci_to_plugin(ptr)  container_of(ptr, struct uci_plugin, e)
 627 #endif
 628
 629 /**
 630  * uci_alloc_element: allocate a generic uci_element, reserve a buffer and typecast
 631  * @ctx: uci context
 632  * @type: {package,section,option}
 633  * @name: string containing the name of the element
 634  * @datasize: additional buffer size to reserve at the end of the struct
 635  */
 636 #define uci_alloc_element(ctx, type, name, datasize) \
 637         uci_to_ ## type (uci_alloc_generic(ctx, uci_type_ ## type, name, sizeof(struct uci_ ## type) + datasize))
 638
 639 #define uci_dataptr(ptr) \
 640         (((char *) ptr) + sizeof(*ptr))
 641
 642 #endif