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))
36 BLOBMSG_TYPE_LAST = __BLOBMSG_TYPE_LAST - 1,
37 BLOBMSG_TYPE_BOOL = BLOBMSG_TYPE_INT8,
45 struct blobmsg_policy {
47 enum blobmsg_type type;
50 static inline int blobmsg_hdrlen(unsigned int namelen)
52 return BLOBMSG_PADDING(sizeof(struct blobmsg_hdr) + namelen + 1);
55 static inline void blobmsg_clear_name(struct blob_attr *attr)
57 struct blobmsg_hdr *hdr = (struct blobmsg_hdr *) blob_data(attr);
61 static inline const char *blobmsg_name(const struct blob_attr *attr)
63 struct blobmsg_hdr *hdr = (struct blobmsg_hdr *) blob_data(attr);
64 return (const char *) hdr->name;
67 static inline int blobmsg_type(const struct blob_attr *attr)
72 static inline void *blobmsg_data(const struct blob_attr *attr)
74 struct blobmsg_hdr *hdr;
80 hdr = (struct blobmsg_hdr *) blob_data(attr);
81 data = (char *) blob_data(attr);
83 if (blob_is_extended(attr))
84 data += blobmsg_hdrlen(be16_to_cpu(hdr->namelen));
89 static inline int blobmsg_data_len(const struct blob_attr *attr)
96 start = (uint8_t *) blob_data(attr);
97 end = (uint8_t *) blobmsg_data(attr);
99 return blob_len(attr) - (end - start);
102 static inline int blobmsg_len(const struct blob_attr *attr)
104 return blobmsg_data_len(attr);
107 bool blobmsg_check_attr(const struct blob_attr *attr, bool name);
108 bool blobmsg_check_attr_list(const struct blob_attr *attr, int type);
111 * blobmsg_check_array: validate array/table and return size
113 * Checks if all elements of an array or table are valid and have
114 * the specified type. Returns the number of elements in the array
116 int blobmsg_check_array(const struct blob_attr *attr, int type);
118 int blobmsg_parse(const struct blobmsg_policy *policy, int policy_len,
119 struct blob_attr **tb, void *data, unsigned int len);
120 int blobmsg_parse_array(const struct blobmsg_policy *policy, int policy_len,
121 struct blob_attr **tb, void *data, unsigned int len);
123 int blobmsg_add_field(struct blob_buf *buf, int type, const char *name,
124 const void *data, unsigned int len);
127 blobmsg_add_double(struct blob_buf *buf, const char *name, double val)
134 v.u64 = cpu_to_be64(v.u64);
135 return blobmsg_add_field(buf, BLOBMSG_TYPE_DOUBLE, name, &v.u64, 8);
139 blobmsg_add_u8(struct blob_buf *buf, const char *name, uint8_t val)
141 return blobmsg_add_field(buf, BLOBMSG_TYPE_INT8, name, &val, 1);
145 blobmsg_add_u16(struct blob_buf *buf, const char *name, uint16_t val)
147 val = cpu_to_be16(val);
148 return blobmsg_add_field(buf, BLOBMSG_TYPE_INT16, name, &val, 2);
152 blobmsg_add_u32(struct blob_buf *buf, const char *name, uint32_t val)
154 val = cpu_to_be32(val);
155 return blobmsg_add_field(buf, BLOBMSG_TYPE_INT32, name, &val, 4);
159 blobmsg_add_u64(struct blob_buf *buf, const char *name, uint64_t val)
161 val = cpu_to_be64(val);
162 return blobmsg_add_field(buf, BLOBMSG_TYPE_INT64, name, &val, 8);
166 blobmsg_add_string(struct blob_buf *buf, const char *name, const char *string)
168 return blobmsg_add_field(buf, BLOBMSG_TYPE_STRING, name, string, strlen(string) + 1);
172 blobmsg_add_blob(struct blob_buf *buf, struct blob_attr *attr)
174 return blobmsg_add_field(buf, blobmsg_type(attr), blobmsg_name(attr),
175 blobmsg_data(attr), blobmsg_data_len(attr));
178 void *blobmsg_open_nested(struct blob_buf *buf, const char *name, bool array);
181 blobmsg_open_array(struct blob_buf *buf, const char *name)
183 return blobmsg_open_nested(buf, name, true);
187 blobmsg_open_table(struct blob_buf *buf, const char *name)
189 return blobmsg_open_nested(buf, name, false);
193 blobmsg_close_array(struct blob_buf *buf, void *cookie)
195 blob_nest_end(buf, cookie);
199 blobmsg_close_table(struct blob_buf *buf, void *cookie)
201 blob_nest_end(buf, cookie);
204 static inline int blobmsg_buf_init(struct blob_buf *buf)
206 return blob_buf_init(buf, BLOBMSG_TYPE_TABLE);
209 static inline uint8_t blobmsg_get_u8(struct blob_attr *attr)
211 return *(uint8_t *) blobmsg_data(attr);
214 static inline bool blobmsg_get_bool(struct blob_attr *attr)
216 return *(uint8_t *) blobmsg_data(attr);
219 static inline uint16_t blobmsg_get_u16(struct blob_attr *attr)
221 return be16_to_cpu(*(uint16_t *) blobmsg_data(attr));
224 static inline uint32_t blobmsg_get_u32(struct blob_attr *attr)
226 return be32_to_cpu(*(uint32_t *) blobmsg_data(attr));
229 static inline uint64_t blobmsg_get_u64(struct blob_attr *attr)
231 uint32_t *ptr = (uint32_t *) blobmsg_data(attr);
232 uint64_t tmp = ((uint64_t) be32_to_cpu(ptr[0])) << 32;
233 tmp |= be32_to_cpu(ptr[1]);
237 static inline double blobmsg_get_double(struct blob_attr *attr)
243 v.u64 = blobmsg_get_u64(attr);
247 static inline char *blobmsg_get_string(struct blob_attr *attr)
252 return (char *) blobmsg_data(attr);
255 void *blobmsg_alloc_string_buffer(struct blob_buf *buf, const char *name, unsigned int maxlen);
256 void *blobmsg_realloc_string_buffer(struct blob_buf *buf, unsigned int maxlen);
257 void blobmsg_add_string_buffer(struct blob_buf *buf);
259 int blobmsg_vprintf(struct blob_buf *buf, const char *name, const char *format, va_list arg);
260 int blobmsg_printf(struct blob_buf *buf, const char *name, const char *format, ...)
261 __attribute__((format(printf, 3, 4)));
264 /* blobmsg to json formatting */
266 #define blobmsg_for_each_attr(pos, attr, rem) \
267 for (rem = attr ? blobmsg_data_len(attr) : 0, \
268 pos = (struct blob_attr *) (attr ? blobmsg_data(attr) : NULL); \
269 rem > 0 && (blob_pad_len(pos) <= rem) && \
270 (blob_pad_len(pos) >= sizeof(struct blob_attr)); \
271 rem -= blob_pad_len(pos), pos = blob_next(pos))