2 * libuci - Library for the Unified Configuration Interface
3 * Copyright (C) 2008 Felix Fietkau <nbd@openwrt.org>
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
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.
19 * you can use these defines to enable debugging behavior for
20 * apps compiled against libuci:
22 * #define UCI_DEBUG_TYPECAST:
23 * enable uci_element typecast checking at run time
29 #define UCI_DEBUG_TYPECAST
36 #define UCI_CONFDIR "/etc/config"
37 #define UCI_SAVEDIR "/tmp/.uci"
38 #define UCI_FILEMODE 0600
56 struct uci_list *next;
57 struct uci_list *prev;
66 struct uci_parse_context;
70 * uci_parse_tuple: Parse an uci tuple
73 * @package: output package pointer
74 * @section: output section pointer
75 * @option: output option pointer
76 * @value: output value pointer
78 * format: <package>[.<section>[.<option>]][=<value>]
80 extern int uci_parse_tuple(struct uci_context *ctx, char *str, char **package, char **section, char **option, char **value);
83 * uci_alloc_context: Allocate a new uci context
85 extern struct uci_context *uci_alloc_context(void);
88 * uci_free_context: Free the uci context including all of its data
90 extern void uci_free_context(struct uci_context *ctx);
93 * uci_perror: Print the last uci error that occured
95 * @str: string to print before the error message
97 extern void uci_perror(struct uci_context *ctx, const char *str);
100 * uci_import: Import uci config data from a stream
102 * @stream: file stream to import from
103 * @name: (optional) assume the config has the given name
104 * @package: (optional) store the last parsed config package in this variable
105 * @single: ignore the 'package' keyword and parse everything into a single package
107 * the name parameter is for config files that don't explicitly use the 'package <...>' keyword
108 * if 'package' points to a non-null struct pointer, enable history tracking and merge
110 extern int uci_import(struct uci_context *ctx, FILE *stream, const char *name, struct uci_package **package, bool single);
113 * uci_export: Export one or all uci config packages
115 * @stream: output stream
116 * @package: (optional) uci config package to export
117 * @header: include the package header
119 extern int uci_export(struct uci_context *ctx, FILE *stream, struct uci_package *package, bool header);
122 * uci_load: Parse an uci config file and store it in the uci context
125 * @name: name of the config file (relative to the config directory)
126 * @package: store the loaded config package in this variable
128 extern int uci_load(struct uci_context *ctx, const char *name, struct uci_package **package);
131 * uci_unload: Unload a config file from the uci context
134 * @package: pointer to the uci_package struct
136 extern int uci_unload(struct uci_context *ctx, struct uci_package *p);
139 * uci_cleanup: Clean up after an error
143 extern int uci_cleanup(struct uci_context *ctx);
146 * uci_lookup: Look up an uci element
149 * @res: where to store the result
150 * @package: uci_package struct
151 * @section: config section (optional)
152 * @option: option to search for (optional)
154 * If section is omitted, then a pointer to the config package is returned
155 * If option is omitted, then a pointer to the config section is returned
157 extern int uci_lookup(struct uci_context *ctx, struct uci_element **res, struct uci_package *package, char *section, char *option);
160 * uci_set_element_value: Replace an element's value with a new one
162 * @element: pointer to an uci_element struct pointer
165 * Only valid for uci_option and uci_section. Will replace the type string
166 * when used with an uci_section
168 extern int uci_set_element_value(struct uci_context *ctx, struct uci_element **element, char *value);
171 * uci_set: Set an element's value; create the element if necessary
173 * @package: package name
174 * @section: section name
175 * @option: option name
176 * @value: value (option) or type (section)
178 extern int uci_set(struct uci_context *ctx, struct uci_package *p, char *section, char *option, char *value);
181 * uci_rename: Rename an element
183 * @package: package name
184 * @section: section name
185 * @option: option name
188 extern int uci_rename(struct uci_context *ctx, struct uci_package *p, char *section, char *option, char *name);
191 * uci_delete_element: Delete a section or option
193 * @e: element (section or option)
195 extern int uci_delete_element(struct uci_context *ctx, struct uci_element *e);
198 * uci_delete: Delete a section or option
201 * @section: section name
202 * @option: option name (optional)
204 extern int uci_delete(struct uci_context *ctx, struct uci_package *p, char *section, char *option);
207 * uci_save: save change history for a package
209 * @p: uci_package struct
211 extern int uci_save(struct uci_context *ctx, struct uci_package *p);
214 * uci_commit: commit changes to a package
216 * @p: uci_package struct pointer
217 * @overwrite: overwrite existing config data and flush history
219 * committing may reload the whole uci_package data,
220 * the supplied pointer is updated accordingly
222 extern int uci_commit(struct uci_context *ctx, struct uci_package **p, bool overwrite);
225 * uci_list_configs: List available uci config files
228 extern int uci_list_configs(struct uci_context *ctx, char ***list);
231 * uci_set_savedir: override the default history save directory
233 * @dir: directory name
235 extern int uci_set_savedir(struct uci_context *ctx, const char *dir);
238 * uci_set_savedir: override the default config storage directory
240 * @dir: directory name
242 extern int uci_set_confdir(struct uci_context *ctx, const char *dir);
245 * uci_add_history_path: add a directory to the search path for change history files
247 * @dir: directory name
249 * This function allows you to add directories, which contain 'overlays'
250 * for the active config, that will never be committed.
252 extern int uci_add_history_path(struct uci_context *ctx, const char *dir);
255 * uci_revert: revert all changes to a config item
257 * @p: pointer to a uci_package struct ptr (will be replaced by the revert)
258 * @section: section name (optional)
259 * @option option name (optional)
261 extern int uci_revert(struct uci_context *ctx, struct uci_package **p, char *section, char *option);
264 * uci_parse_argument: parse a shell-style argument, with an arbitrary quoting style
266 * @stream: input stream
267 * @str: pointer to the current line (use NULL for parsing the next line)
268 * @result: pointer for the result
270 extern int uci_parse_argument(struct uci_context *ctx, FILE *stream, char **str, char **result);
272 /* UCI data structures */
274 UCI_TYPE_HISTORY = 0,
275 UCI_TYPE_PACKAGE = 1,
276 UCI_TYPE_SECTION = 2,
282 UCI_FLAG_STRICT = (1 << 0), /* strict mode for the parser */
283 UCI_FLAG_PERROR = (1 << 1), /* print parser error messages */
284 UCI_FLAG_EXPORT_NAME = (1 << 2), /* when exporting, name unnamed sections */
285 UCI_FLAG_SAVED_HISTORY = (1 << 3), /* store the saved history in memory as well */
290 struct uci_list list;
297 /* list of config packages */
298 struct uci_list root;
300 /* parser context, use for error handling only */
301 struct uci_parse_context *pctx;
303 /* uci runtime flags */
304 enum uci_flags flags;
309 /* search path for history files */
310 struct uci_list history_path;
323 struct uci_element e;
324 struct uci_list sections;
325 struct uci_context *ctx;
331 struct uci_list history;
332 struct uci_list saved_history;
337 struct uci_element e;
338 struct uci_list options;
339 struct uci_package *package;
346 struct uci_element e;
347 struct uci_section *section;
360 struct uci_element e;
361 enum uci_command cmd;
366 /* linked list handling */
368 #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
372 * container_of - cast a member of a structure out to the containing structure
373 * @ptr: the pointer to the member.
374 * @type: the type of the container struct this is embedded in.
375 * @member: the name of the member within the struct.
377 #define container_of(ptr, type, member) \
378 ((type *) ((char *)ptr - offsetof(type,member)))
382 * uci_list_entry: casts an uci_list pointer to the containing struct.
383 * @_type: config, section or option
384 * @_ptr: pointer to the uci_list struct
386 #define element_to(type, ptr) \
387 container_of(ptr, struct uci_ ## type, e)
389 #define list_to_element(ptr) \
390 container_of(ptr, struct uci_element, list)
393 * uci_foreach_entry: loop through a list of uci elements
394 * @_list: pointer to the uci_list struct
395 * @_ptr: iteration variable, struct uci_element
397 * use like a for loop, e.g:
398 * uci_foreach(&list, p) {
402 #define uci_foreach_element(_list, _ptr) \
403 for(_ptr = list_to_element((_list)->next); \
404 &_ptr->list != (_list); \
405 _ptr = list_to_element(_ptr->list.next))
408 * uci_foreach_entry_safe: like uci_foreach_safe, but safe for deletion
409 * @_list: pointer to the uci_list struct
410 * @_tmp: temporary variable, struct uci_element *
411 * @_ptr: iteration variable, struct uci_element *
413 * use like a for loop, e.g:
414 * uci_foreach(&list, p) {
418 #define uci_foreach_element_safe(_list, _tmp, _ptr) \
419 for(_ptr = list_to_element((_list)->next), \
420 _tmp = list_to_element(_ptr->list.next); \
421 &_ptr->list != (_list); \
422 _ptr = _tmp, _tmp = list_to_element(_ptr->list.next))
425 * uci_list_empty: returns true if a list is empty
428 #define uci_list_empty(list) ((list)->next == (list))
430 /* wrappers for dynamic type handling */
431 #define uci_type_history UCI_TYPE_HISTORY
432 #define uci_type_package UCI_TYPE_PACKAGE
433 #define uci_type_section UCI_TYPE_SECTION
434 #define uci_type_option UCI_TYPE_OPTION
436 /* element typecasting */
437 #ifdef UCI_DEBUG_TYPECAST
438 static const char *uci_typestr[] = {
439 [uci_type_history] = "history",
440 [uci_type_package] = "package",
441 [uci_type_section] = "section",
442 [uci_type_option] = "option",
445 static void uci_typecast_error(int from, int to)
447 fprintf(stderr, "Invalid typecast from '%s' to '%s'\n", uci_typestr[from], uci_typestr[to]);
450 #define BUILD_CAST(_type) \
451 static inline struct uci_ ## _type *uci_to_ ## _type (struct uci_element *e) \
453 if (e->type != uci_type_ ## _type) { \
454 uci_typecast_error(e->type, uci_type_ ## _type); \
456 return (struct uci_ ## _type *) e; \
465 #define uci_to_history(ptr) container_of(ptr, struct uci_history, e)
466 #define uci_to_package(ptr) container_of(ptr, struct uci_package, e)
467 #define uci_to_section(ptr) container_of(ptr, struct uci_section, e)
468 #define uci_to_option(ptr) container_of(ptr, struct uci_option, e)
472 * uci_alloc_element: allocate a generic uci_element, reserve a buffer and typecast
474 * @type: {package,section,option}
475 * @name: string containing the name of the element
476 * @datasize: additional buffer size to reserve at the end of the struct
478 #define uci_alloc_element(ctx, type, name, datasize) \
479 uci_to_ ## type (uci_alloc_generic(ctx, uci_type_ ## type, name, sizeof(struct uci_ ## type) + datasize))
481 #define uci_dataptr(ptr) \
482 (((char *) ptr) + sizeof(*ptr))