be3c7ee2cbfd90c85dd7e7ead4126e65bd2935f8
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 uint16_t blobmsg_namelen(const struct blobmsg_hdr
*hdr
)
74 return be16_to_cpu(hdr
->namelen
);
77 static inline void *blobmsg_data(const struct blob_attr
*attr
)
79 struct blobmsg_hdr
*hdr
;
85 hdr
= (struct blobmsg_hdr
*) blob_data(attr
);
86 data
= (char *) blob_data(attr
);
88 if (blob_is_extended(attr
))
89 data
+= blobmsg_hdrlen(blobmsg_namelen(hdr
));
94 static inline size_t blobmsg_data_len(const struct blob_attr
*attr
)
101 start
= (uint8_t *) blob_data(attr
);
102 end
= (uint8_t *) blobmsg_data(attr
);
104 return blob_len(attr
) - (end
- start
);
107 static inline size_t blobmsg_len(const struct blob_attr
*attr
)
109 return blobmsg_data_len(attr
);
113 * blobmsg_check_attr: validate a list of attributes
115 * This method may be used with trusted data only. Providing
116 * malformed blobs will cause out of bounds memory access.
118 bool blobmsg_check_attr(const struct blob_attr
*attr
, bool name
);
121 * blobmsg_check_attr_len: validate a list of attributes
123 * This method should be safer implementation of blobmsg_check_attr.
124 * It will limit all memory access performed on the blob to the
125 * range [attr, attr + len] (upper bound non inclusive) and is
126 * thus suited for checking of untrusted blob attributes.
128 bool blobmsg_check_attr_len(const struct blob_attr
*attr
, bool name
, size_t len
);
131 * blobmsg_check_attr_list: validate a list of attributes
133 * This method may be used with trusted data only. Providing
134 * malformed blobs will cause out of bounds memory access.
136 bool blobmsg_check_attr_list(const struct blob_attr
*attr
, int type
);
139 * blobmsg_check_attr_list_len: validate a list of untrusted attributes
141 * This method should be safer implementation of blobmsg_check_attr_list.
142 * It will limit all memory access performed on the blob to the
143 * range [attr, attr + len] (upper bound non inclusive) and is
144 * thus suited for checking of untrusted blob attributes.
146 bool blobmsg_check_attr_list_len(const struct blob_attr
*attr
, int type
, size_t len
);
149 * blobmsg_check_array: validate array/table and return size
151 * Checks if all elements of an array or table are valid and have
152 * the specified type. Returns the number of elements in the array
154 * This method may be used with trusted data only. Providing
155 * malformed blobs will cause out of bounds memory access.
157 int blobmsg_check_array(const struct blob_attr
*attr
, int type
);
160 * blobmsg_check_array_len: validate untrusted array/table and return size
162 * Checks if all elements of an array or table are valid and have
163 * the specified type. Returns the number of elements in the array.
165 * This method should be safer implementation of blobmsg_check_array.
166 * It will limit all memory access performed on the blob to the
167 * range [attr, attr + len] (upper bound non inclusive) and is
168 * thus suited for checking of untrusted blob attributes.
170 int blobmsg_check_array_len(const struct blob_attr
*attr
, int type
, size_t len
);
172 int blobmsg_parse(const struct blobmsg_policy
*policy
, int policy_len
,
173 struct blob_attr
**tb
, void *data
, unsigned int len
);
174 int blobmsg_parse_array(const struct blobmsg_policy
*policy
, int policy_len
,
175 struct blob_attr
**tb
, void *data
, unsigned int len
);
177 int blobmsg_add_field(struct blob_buf
*buf
, int type
, const char *name
,
178 const void *data
, unsigned int len
);
181 blobmsg_add_double(struct blob_buf
*buf
, const char *name
, double val
)
188 v
.u64
= cpu_to_be64(v
.u64
);
189 return blobmsg_add_field(buf
, BLOBMSG_TYPE_DOUBLE
, name
, &v
.u64
, 8);
193 blobmsg_add_u8(struct blob_buf
*buf
, const char *name
, uint8_t val
)
195 return blobmsg_add_field(buf
, BLOBMSG_TYPE_INT8
, name
, &val
, 1);
199 blobmsg_add_u16(struct blob_buf
*buf
, const char *name
, uint16_t val
)
201 val
= cpu_to_be16(val
);
202 return blobmsg_add_field(buf
, BLOBMSG_TYPE_INT16
, name
, &val
, 2);
206 blobmsg_add_u32(struct blob_buf
*buf
, const char *name
, uint32_t val
)
208 val
= cpu_to_be32(val
);
209 return blobmsg_add_field(buf
, BLOBMSG_TYPE_INT32
, name
, &val
, 4);
213 blobmsg_add_u64(struct blob_buf
*buf
, const char *name
, uint64_t val
)
215 val
= cpu_to_be64(val
);
216 return blobmsg_add_field(buf
, BLOBMSG_TYPE_INT64
, name
, &val
, 8);
220 blobmsg_add_string(struct blob_buf
*buf
, const char *name
, const char *string
)
222 return blobmsg_add_field(buf
, BLOBMSG_TYPE_STRING
, name
, string
, strlen(string
) + 1);
226 blobmsg_add_blob(struct blob_buf
*buf
, struct blob_attr
*attr
)
228 return blobmsg_add_field(buf
, blobmsg_type(attr
), blobmsg_name(attr
),
229 blobmsg_data(attr
), blobmsg_data_len(attr
));
232 void *blobmsg_open_nested(struct blob_buf
*buf
, const char *name
, bool array
);
235 blobmsg_open_array(struct blob_buf
*buf
, const char *name
)
237 return blobmsg_open_nested(buf
, name
, true);
241 blobmsg_open_table(struct blob_buf
*buf
, const char *name
)
243 return blobmsg_open_nested(buf
, name
, false);
247 blobmsg_close_array(struct blob_buf
*buf
, void *cookie
)
249 blob_nest_end(buf
, cookie
);
253 blobmsg_close_table(struct blob_buf
*buf
, void *cookie
)
255 blob_nest_end(buf
, cookie
);
258 static inline int blobmsg_buf_init(struct blob_buf
*buf
)
260 return blob_buf_init(buf
, BLOBMSG_TYPE_TABLE
);
263 static inline uint8_t blobmsg_get_u8(struct blob_attr
*attr
)
265 return *(uint8_t *) blobmsg_data(attr
);
268 static inline bool blobmsg_get_bool(struct blob_attr
*attr
)
270 return *(uint8_t *) blobmsg_data(attr
);
273 static inline uint16_t blobmsg_get_u16(struct blob_attr
*attr
)
275 return be16_to_cpu(*(uint16_t *) blobmsg_data(attr
));
278 static inline uint32_t blobmsg_get_u32(struct blob_attr
*attr
)
280 return be32_to_cpu(*(uint32_t *) blobmsg_data(attr
));
283 static inline uint64_t blobmsg_get_u64(struct blob_attr
*attr
)
285 uint32_t *ptr
= (uint32_t *) blobmsg_data(attr
);
286 uint64_t tmp
= ((uint64_t) be32_to_cpu(ptr
[0])) << 32;
287 tmp
|= be32_to_cpu(ptr
[1]);
291 static inline double blobmsg_get_double(struct blob_attr
*attr
)
297 v
.u64
= blobmsg_get_u64(attr
);
301 static inline char *blobmsg_get_string(struct blob_attr
*attr
)
306 return (char *) blobmsg_data(attr
);
309 void *blobmsg_alloc_string_buffer(struct blob_buf
*buf
, const char *name
, unsigned int maxlen
);
310 void *blobmsg_realloc_string_buffer(struct blob_buf
*buf
, unsigned int maxlen
);
311 void blobmsg_add_string_buffer(struct blob_buf
*buf
);
313 int blobmsg_vprintf(struct blob_buf
*buf
, const char *name
, const char *format
, va_list arg
);
314 int blobmsg_printf(struct blob_buf
*buf
, const char *name
, const char *format
, ...)
315 __attribute__((format(printf
, 3, 4)));
318 /* blobmsg to json formatting */
320 #define blobmsg_for_each_attr(pos, attr, rem) \
321 for (rem = attr ? blobmsg_data_len(attr) : 0, \
322 pos = (struct blob_attr *) (attr ? blobmsg_data(attr) : NULL); \
323 rem >= sizeof(struct blob_attr) && (blob_pad_len(pos) <= rem) && \
324 (blob_pad_len(pos) >= sizeof(struct blob_attr)); \
325 rem -= blob_pad_len(pos), pos = blob_next(pos))
327 #define __blobmsg_for_each_attr(pos, attr, rem) \
328 for (pos = (struct blob_attr *) (attr ? blobmsg_data(attr) : NULL); \
329 rem >= sizeof(struct blob_attr) && (blob_pad_len(pos) <= rem) && \
330 (blob_pad_len(pos) >= sizeof(struct blob_attr)); \
331 rem -= blob_pad_len(pos), pos = blob_next(pos))