2 * Copyright (C) 2010-2012 Felix Fietkau <nbd@openwrt.org>
4 * Permission to use, copy, modify, and/or distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
22 #define BLOBMSG_ALIGN 2
23 #define BLOBMSG_PADDING(len) (((len) + (1 << BLOBMSG_ALIGN) - 1) & ~((1 << BLOBMSG_ALIGN) - 1))
35 BLOBMSG_TYPE_LAST = __BLOBMSG_TYPE_LAST - 1,
36 BLOBMSG_TYPE_BOOL = BLOBMSG_TYPE_INT8,
44 struct blobmsg_policy {
46 enum blobmsg_type type;
49 static inline int blobmsg_hdrlen(unsigned int namelen)
51 return BLOBMSG_PADDING(sizeof(struct blobmsg_hdr) + namelen + 1);
54 static inline const char *blobmsg_name(const struct blob_attr *attr)
56 struct blobmsg_hdr *hdr = (struct blobmsg_hdr *) blob_data(attr);
57 return (const char *) hdr->name;
60 static inline int blobmsg_type(const struct blob_attr *attr)
65 static inline void *blobmsg_data(const struct blob_attr *attr)
67 struct blobmsg_hdr *hdr = (struct blobmsg_hdr *) blob_data(attr);
68 char *data = (char *) blob_data(attr);
70 if (blob_is_extended(attr))
71 data += blobmsg_hdrlen(be16_to_cpu(hdr->namelen));
76 static inline int blobmsg_data_len(const struct blob_attr *attr)
80 start = (uint8_t *) blob_data(attr);
81 end = (uint8_t *) blobmsg_data(attr);
83 return blob_len(attr) - (end - start);
86 static inline int blobmsg_len(const struct blob_attr *attr)
88 return blobmsg_data_len(attr);
91 bool blobmsg_check_attr(const struct blob_attr *attr, bool name);
92 bool blobmsg_check_attr_list(const struct blob_attr *attr, int type);
95 * blobmsg_check_array: validate array/table and return size
97 * Checks if all elements of an array or table are valid and have
98 * the specified type. Returns the number of elements in the array
100 int blobmsg_check_array(const struct blob_attr *attr, int type);
102 int blobmsg_parse(const struct blobmsg_policy *policy, int policy_len,
103 struct blob_attr **tb, void *data, unsigned int len);
104 int blobmsg_parse_array(const struct blobmsg_policy *policy, int policy_len,
105 struct blob_attr **tb, void *data, unsigned int len);
107 int blobmsg_add_field(struct blob_buf *buf, int type, const char *name,
108 const void *data, unsigned int len);
111 blobmsg_add_u8(struct blob_buf *buf, const char *name, uint8_t val)
113 return blobmsg_add_field(buf, BLOBMSG_TYPE_INT8, name, &val, 1);
117 blobmsg_add_u16(struct blob_buf *buf, const char *name, uint16_t val)
119 val = cpu_to_be16(val);
120 return blobmsg_add_field(buf, BLOBMSG_TYPE_INT16, name, &val, 2);
124 blobmsg_add_u32(struct blob_buf *buf, const char *name, uint32_t val)
126 val = cpu_to_be32(val);
127 return blobmsg_add_field(buf, BLOBMSG_TYPE_INT32, name, &val, 4);
131 blobmsg_add_u64(struct blob_buf *buf, const char *name, uint64_t val)
133 val = cpu_to_be64(val);
134 return blobmsg_add_field(buf, BLOBMSG_TYPE_INT64, name, &val, 8);
138 blobmsg_add_string(struct blob_buf *buf, const char *name, const char *string)
140 return blobmsg_add_field(buf, BLOBMSG_TYPE_STRING, name, string, strlen(string) + 1);
144 blobmsg_add_blob(struct blob_buf *buf, struct blob_attr *attr)
146 return blobmsg_add_field(buf, blobmsg_type(attr), blobmsg_name(attr),
147 blobmsg_data(attr), blobmsg_data_len(attr));
150 void *blobmsg_open_nested(struct blob_buf *buf, const char *name, bool array);
153 blobmsg_open_array(struct blob_buf *buf, const char *name)
155 return blobmsg_open_nested(buf, name, true);
159 blobmsg_open_table(struct blob_buf *buf, const char *name)
161 return blobmsg_open_nested(buf, name, false);
165 blobmsg_close_array(struct blob_buf *buf, void *cookie)
167 blob_nest_end(buf, cookie);
171 blobmsg_close_table(struct blob_buf *buf, void *cookie)
173 blob_nest_end(buf, cookie);
176 static inline int blobmsg_buf_init(struct blob_buf *buf)
178 return blob_buf_init(buf, BLOBMSG_TYPE_TABLE);
181 static inline uint8_t blobmsg_get_u8(struct blob_attr *attr)
183 return *(uint8_t *) blobmsg_data(attr);
186 static inline bool blobmsg_get_bool(struct blob_attr *attr)
188 return *(uint8_t *) blobmsg_data(attr);
191 static inline uint16_t blobmsg_get_u16(struct blob_attr *attr)
193 return be16_to_cpu(*(uint16_t *) blobmsg_data(attr));
196 static inline uint32_t blobmsg_get_u32(struct blob_attr *attr)
198 return be32_to_cpu(*(uint32_t *) blobmsg_data(attr));
201 static inline uint64_t blobmsg_get_u64(struct blob_attr *attr)
203 uint32_t *ptr = (uint32_t *) blobmsg_data(attr);
204 uint64_t tmp = ((uint64_t) be32_to_cpu(ptr[0])) << 32;
205 tmp |= be32_to_cpu(ptr[1]);
209 static inline char *blobmsg_get_string(struct blob_attr *attr)
211 return (char *) blobmsg_data(attr);
214 void *blobmsg_alloc_string_buffer(struct blob_buf *buf, const char *name, unsigned int maxlen);
215 void *blobmsg_realloc_string_buffer(struct blob_buf *buf, unsigned int maxlen);
216 void blobmsg_add_string_buffer(struct blob_buf *buf);
218 void blobmsg_vprintf(struct blob_buf *buf, const char *name, const char *format, va_list arg);
219 void blobmsg_printf(struct blob_buf *buf, const char *name, const char *format, ...)
220 __attribute__((format(printf, 3, 4)));
223 /* blobmsg to json formatting */
225 #define blobmsg_for_each_attr(pos, attr, rem) \
226 for (rem = attr ? blobmsg_data_len(attr) : 0, \
227 pos = attr ? blobmsg_data(attr) : 0; \
228 rem > 0 && (blob_pad_len(pos) <= rem) && \
229 (blob_pad_len(pos) >= sizeof(struct blob_attr)); \
230 rem -= blob_pad_len(pos), pos = blob_next(pos))