123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239 |
- /*
- * ucimap - library for mapping uci sections into data structures
- * Copyright (C) 2008 Felix Fietkau <nbd@openwrt.org>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License version 2
- * as published by the Free Software Foundation
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- */
- #ifndef __UCIMAP_H
- #define __UCIMAP_H
- #include <stdbool.h>
- #include "uci_list.h"
- #include "uci.h"
- #ifndef ARRAY_SIZE
- #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
- #endif
- #define BITFIELD_SIZE(_fields) (((_fields) / 8) + 1)
- #define CLR_BIT(_name, _bit) do { \
- _name[(_bit) / 8] &= ~(1 << ((_bit) % 8)); \
- } while (0)
- #define SET_BIT(_name, _bit) do { \
- _name[(_bit) / 8] |= (1 << ((_bit) % 8)); \
- } while (0)
- #define TEST_BIT(_name, _bit) \
- (_name[(_bit) / 8] & (1 << ((_bit) % 8)))
- #ifndef __GNUC__
- #define __optmap_gen_type(_type, _field) -1
- #ifndef likely
- #define likely(_expr) !!(_expr)
- #endif
- #ifndef unlikely
- #define unlikely(_expr) !!(_expr)
- #endif
- #else /* __GNUC__ */
- #define __compatible(_type, _field, _newtype) \
- __builtin_types_compatible_p(typeof(&(((_type *)0)->_field)), _newtype *)
- #define __list_compatible(_type, _field, __val, __else) \
- __builtin_choose_expr(__compatible(_type, _field, struct ucimap_list *), __val, __else)
- #define __int_compatible(_type, _field, __val, __else) \
- __builtin_choose_expr(__compatible(_type, _field, int), __val, \
- __builtin_choose_expr(__compatible(_type, _field, unsigned int), __val, \
- __else))
- #define __string_compatible(_type, _field, __val, __else) \
- __builtin_choose_expr(__compatible(_type, _field, char *), __val, \
- __builtin_choose_expr(__compatible(_type, _field, unsigned char *), __val, \
- __builtin_choose_expr(__compatible(_type, _field, const char *), __val, \
- __builtin_choose_expr(__compatible(_type, _field, const unsigned char *), __val, \
- __else))))
- #define __bool_compatible(_type, _field, __val, __else) \
- __builtin_choose_expr(__compatible(_type, _field, bool), __val, __else)
- #define __optmap_gen_type(_type, _field) \
- __list_compatible(_type, _field, UCIMAP_LIST, \
- __int_compatible(_type, _field, UCIMAP_INT, \
- __string_compatible(_type, _field, UCIMAP_STRING, \
- __bool_compatible(_type, _field, UCIMAP_BOOL, \
- -1))))
- #ifndef likely
- #define likely(x) __builtin_expect(!!(x), 1)
- #endif
- #ifndef unlikely
- #define unlikely(x) __builtin_expect(!!(x), 0)
- #endif
- #endif /* __GNUC__ */
- #define UCIMAP_OPTION(_type, _field) \
- .type = UCIMAP_CUSTOM, \
- .name = #_field, \
- .offset = offsetof(_type, _field), \
- .detected_type = __optmap_gen_type(_type, _field), \
- .type_name = #_type
- #define UCIMAP_SECTION(_name, _field) \
- .alloc_len = sizeof(_name), \
- .smap_offset = offsetof(_name, _field), \
- .type_name = #_name
- struct uci_sectionmap;
- struct uci_optmap;
- struct ucimap_list;
- struct uci_alloc;
- struct uci_alloc_custom;
- struct uci_map {
- struct uci_sectionmap **sections;
- unsigned int n_sections;
- struct list_head sdata;
- struct list_head fixup;
- struct list_head pending;
- bool parsed;
- void *priv; /* user data */
- };
- enum ucimap_type {
- /* types */
- UCIMAP_SIMPLE = 0x00,
- UCIMAP_LIST = 0x10,
- UCIMAP_TYPE = 0xf0, /* type mask */
- /* subtypes */
- UCIMAP_STRING = 0x0,
- UCIMAP_BOOL = 0x1,
- UCIMAP_INT = 0x2,
- UCIMAP_SECTION = 0x3,
- UCIMAP_CUSTOM = 0x4,
- UCIMAP_SUBTYPE = 0xf, /* subtype mask */
- /* automatically create lists from
- * options with space-separated items */
- UCIMAP_LIST_AUTO = 0x0100,
- UCIMAP_FLAGS = 0xff00, /* flags mask */
- };
- union ucimap_data {
- int i;
- bool b;
- char *s;
- void *ptr;
- void **data;
- struct ucimap_list *list;
- };
- struct ucimap_section_data {
- struct list_head list;
- struct uci_map *map;
- struct uci_sectionmap *sm;
- const char *section_name;
- /* list of allocations done by ucimap */
- struct uci_alloc *allocmap;
- struct uci_alloc_custom *alloc_custom;
- unsigned int allocmap_len;
- unsigned int alloc_custom_len;
- /* map for changed fields */
- unsigned char *cmap;
- bool done;
- };
- struct uci_sectionmap {
- /* type string for the uci section */
- const char *type;
- /* length of the struct to map into, filled in by macro */
- unsigned int alloc_len;
- /* sectionmap offset, filled in by macro */
- unsigned int smap_offset;
- /* return a pointer to the section map data (allocate if necessary) */
- struct ucimap_section_data *(*alloc)(struct uci_map *map,
- struct uci_sectionmap *sm, struct uci_section *s);
- /* give the caller time to initialize the preallocated struct */
- int (*init)(struct uci_map *map, void *section, struct uci_section *s);
- /* pass the fully processed struct to the callback after the section end */
- int (*add)(struct uci_map *map, void *section);
- /* let the callback clean up its own stuff in the section */
- int (*free)(struct uci_map *map, void *section);
- /* list of option mappings for this section */
- struct uci_optmap *options;
- unsigned int n_options;
- unsigned int options_size;
- /* internal */
- const char *type_name;
- };
- struct uci_optmap {
- unsigned int offset;
- const char *name;
- enum ucimap_type type;
- int (*parse)(void *section, struct uci_optmap *om, union ucimap_data *data, const char *string);
- int (*format)(void *section, struct uci_optmap *om, union ucimap_data *data, char **string);
- void (*free)(void *section, struct uci_optmap *om, void *ptr);
- union {
- struct {
- int base;
- int min;
- int max;
- } i;
- struct {
- int maxlen;
- } s;
- struct uci_sectionmap *sm;
- } data;
- /* internal */
- int detected_type;
- const char *type_name;
- };
- struct ucimap_list {
- int n_items;
- int size;
- union ucimap_data item[];
- };
- extern int ucimap_init(struct uci_map *map);
- extern void ucimap_cleanup(struct uci_map *map);
- extern void ucimap_set_changed(struct ucimap_section_data *sd, void *field);
- extern int ucimap_store_section(struct uci_map *map, struct uci_package *p, struct ucimap_section_data *sd);
- extern void ucimap_parse(struct uci_map *map, struct uci_package *pkg);
- extern int ucimap_parse_section(struct uci_map *map, struct uci_sectionmap *sm, struct ucimap_section_data *sd, struct uci_section *s);
- extern void ucimap_free_section(struct uci_map *map, struct ucimap_section_data *sd);
- extern int ucimap_resize_list(struct ucimap_section_data *sd, struct ucimap_list **list, int items);
- extern void ucimap_free_item(struct ucimap_section_data *sd, void *item);
- #endif
|