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))
34 BLOBMSG_TYPE_BOOL
= BLOBMSG_TYPE_INT8
,
37 BLOBMSG_TYPE_LAST
= __BLOBMSG_TYPE_LAST
- 1,
38 BLOBMSG_CAST_INT64
= __BLOBMSG_TYPE_LAST
,
46 struct blobmsg_policy
{
48 enum blobmsg_type type
;
51 static inline int blobmsg_hdrlen(unsigned int namelen
)
53 return BLOBMSG_PADDING(sizeof(struct blobmsg_hdr
) + namelen
+ 1);
56 static inline void blobmsg_clear_name(struct blob_attr
*attr
)
58 struct blobmsg_hdr
*hdr
= (struct blobmsg_hdr
*) blob_data(attr
);
62 static inline const char *blobmsg_name(const struct blob_attr
*attr
)
64 struct blobmsg_hdr
*hdr
= (struct blobmsg_hdr
*) blob_data(attr
);
65 return (const char *)(hdr
+ 1);
68 static inline int blobmsg_type(const struct blob_attr
*attr
)
73 static uint16_t blobmsg_namelen(const struct blobmsg_hdr
*hdr
)
75 return be16_to_cpu(hdr
->namelen
);
78 static inline void *blobmsg_data(const struct blob_attr
*attr
)
80 struct blobmsg_hdr
*hdr
;
86 hdr
= (struct blobmsg_hdr
*) blob_data(attr
);
87 data
= (char *) blob_data(attr
);
89 if (blob_is_extended(attr
))
90 data
+= blobmsg_hdrlen(blobmsg_namelen(hdr
));
95 static inline size_t blobmsg_data_len(const struct blob_attr
*attr
)
102 start
= (uint8_t *) blob_data(attr
);
103 end
= (uint8_t *) blobmsg_data(attr
);
105 return blob_len(attr
) - (end
- start
);
108 static inline size_t blobmsg_len(const struct blob_attr
*attr
)
110 return blobmsg_data_len(attr
);
114 * blobmsg_check_attr: validate a list of attributes
116 * This method may be used with trusted data only. Providing
117 * malformed blobs will cause out of bounds memory access.
119 bool blobmsg_check_attr(const struct blob_attr
*attr
, bool name
);
122 * blobmsg_check_attr_len: validate a list of attributes
124 * This method should be safer implementation of blobmsg_check_attr.
125 * It will limit all memory access performed on the blob to the
126 * range [attr, attr + len] (upper bound non inclusive) and is
127 * thus suited for checking of untrusted blob attributes.
129 bool blobmsg_check_attr_len(const struct blob_attr
*attr
, bool name
, size_t len
);
132 * blobmsg_check_attr_list: validate a list of attributes
134 * This method may be used with trusted data only. Providing
135 * malformed blobs will cause out of bounds memory access.
137 bool blobmsg_check_attr_list(const struct blob_attr
*attr
, int type
);
140 * blobmsg_check_attr_list_len: validate a list of untrusted attributes
142 * This method should be safer implementation of blobmsg_check_attr_list.
143 * It will limit all memory access performed on the blob to the
144 * range [attr, attr + len] (upper bound non inclusive) and is
145 * thus suited for checking of untrusted blob attributes.
147 bool blobmsg_check_attr_list_len(const struct blob_attr
*attr
, int type
, size_t len
);
150 * blobmsg_check_array: validate array/table and return size
152 * Checks if all elements of an array or table are valid and have
153 * the specified type. Returns the number of elements in the array
155 * This method may be used with trusted data only. Providing
156 * malformed blobs will cause out of bounds memory access.
158 int blobmsg_check_array(const struct blob_attr
*attr
, int type
);
161 * blobmsg_check_array_len: validate untrusted array/table and return size
163 * Checks if all elements of an array or table are valid and have
164 * the specified type. Returns the number of elements in the array.
166 * This method should be safer implementation of blobmsg_check_array.
167 * It will limit all memory access performed on the blob to the
168 * range [attr, attr + len] (upper bound non inclusive) and is
169 * thus suited for checking of untrusted blob attributes.
171 int blobmsg_check_array_len(const struct blob_attr
*attr
, int type
, size_t len
);
173 int blobmsg_parse(const struct blobmsg_policy
*policy
, int policy_len
,
174 struct blob_attr
**tb
, void *data
, unsigned int len
);
175 int blobmsg_parse_array(const struct blobmsg_policy
*policy
, int policy_len
,
176 struct blob_attr
**tb
, void *data
, unsigned int len
);
178 int blobmsg_add_field(struct blob_buf
*buf
, int type
, const char *name
,
179 const void *data
, unsigned int len
);
182 blobmsg_parse_attr(const struct blobmsg_policy
*policy
, int policy_len
,
183 struct blob_attr
**tb
, struct blob_attr
*data
)
185 return blobmsg_parse(policy
, policy_len
, tb
, blobmsg_data(data
), blobmsg_len(data
));
189 blobmsg_parse_array_attr(const struct blobmsg_policy
*policy
, int policy_len
,
190 struct blob_attr
**tb
, struct blob_attr
*data
)
192 return blobmsg_parse_array(policy
, policy_len
, tb
, blobmsg_data(data
), blobmsg_len(data
));
196 blobmsg_add_double(struct blob_buf
*buf
, const char *name
, double val
)
203 v
.u64
= cpu_to_be64(v
.u64
);
204 return blobmsg_add_field(buf
, BLOBMSG_TYPE_DOUBLE
, name
, &v
.u64
, 8);
208 blobmsg_add_u8(struct blob_buf
*buf
, const char *name
, uint8_t val
)
210 return blobmsg_add_field(buf
, BLOBMSG_TYPE_INT8
, name
, &val
, 1);
214 blobmsg_add_u16(struct blob_buf
*buf
, const char *name
, uint16_t val
)
216 val
= cpu_to_be16(val
);
217 return blobmsg_add_field(buf
, BLOBMSG_TYPE_INT16
, name
, &val
, 2);
221 blobmsg_add_u32(struct blob_buf
*buf
, const char *name
, uint32_t val
)
223 val
= cpu_to_be32(val
);
224 return blobmsg_add_field(buf
, BLOBMSG_TYPE_INT32
, name
, &val
, 4);
228 blobmsg_add_u64(struct blob_buf
*buf
, const char *name
, uint64_t val
)
230 val
= cpu_to_be64(val
);
231 return blobmsg_add_field(buf
, BLOBMSG_TYPE_INT64
, name
, &val
, 8);
235 blobmsg_add_string(struct blob_buf
*buf
, const char *name
, const char *string
)
237 return blobmsg_add_field(buf
, BLOBMSG_TYPE_STRING
, name
, string
, strlen(string
) + 1);
241 blobmsg_add_blob(struct blob_buf
*buf
, struct blob_attr
*attr
)
243 return blobmsg_add_field(buf
, blobmsg_type(attr
), blobmsg_name(attr
),
244 blobmsg_data(attr
), blobmsg_data_len(attr
));
247 void *blobmsg_open_nested(struct blob_buf
*buf
, const char *name
, bool array
);
250 blobmsg_open_array(struct blob_buf
*buf
, const char *name
)
252 return blobmsg_open_nested(buf
, name
, true);
256 blobmsg_open_table(struct blob_buf
*buf
, const char *name
)
258 return blobmsg_open_nested(buf
, name
, false);
262 blobmsg_close_array(struct blob_buf
*buf
, void *cookie
)
264 blob_nest_end(buf
, cookie
);
268 blobmsg_close_table(struct blob_buf
*buf
, void *cookie
)
270 blob_nest_end(buf
, cookie
);
273 static inline int blobmsg_buf_init(struct blob_buf
*buf
)
275 return blob_buf_init(buf
, BLOBMSG_TYPE_TABLE
);
278 static inline uint8_t blobmsg_get_u8(struct blob_attr
*attr
)
280 return *(uint8_t *) blobmsg_data(attr
);
283 static inline bool blobmsg_get_bool(struct blob_attr
*attr
)
285 return *(uint8_t *) blobmsg_data(attr
);
288 static inline uint16_t blobmsg_get_u16(struct blob_attr
*attr
)
290 return be16_to_cpu(*(uint16_t *) blobmsg_data(attr
));
293 static inline uint32_t blobmsg_get_u32(struct blob_attr
*attr
)
295 return be32_to_cpu(*(uint32_t *) blobmsg_data(attr
));
298 static inline uint64_t blobmsg_get_u64(struct blob_attr
*attr
)
300 uint32_t *ptr
= (uint32_t *) blobmsg_data(attr
);
301 uint64_t tmp
= ((uint64_t) be32_to_cpu(ptr
[0])) << 32;
302 tmp
|= be32_to_cpu(ptr
[1]);
306 static inline uint64_t blobmsg_cast_u64(struct blob_attr
*attr
)
310 if (blobmsg_type(attr
) == BLOBMSG_TYPE_INT64
)
311 tmp
= blobmsg_get_u64(attr
);
312 else if (blobmsg_type(attr
) == BLOBMSG_TYPE_INT32
)
313 tmp
= blobmsg_get_u32(attr
);
314 else if (blobmsg_type(attr
) == BLOBMSG_TYPE_INT16
)
315 tmp
= blobmsg_get_u16(attr
);
316 else if (blobmsg_type(attr
) == BLOBMSG_TYPE_INT8
)
317 tmp
= blobmsg_get_u8(attr
);
322 static inline int64_t blobmsg_cast_s64(struct blob_attr
*attr
)
326 if (blobmsg_type(attr
) == BLOBMSG_TYPE_INT64
)
327 tmp
= blobmsg_get_u64(attr
);
328 else if (blobmsg_type(attr
) == BLOBMSG_TYPE_INT32
)
329 tmp
= (int32_t)blobmsg_get_u32(attr
);
330 else if (blobmsg_type(attr
) == BLOBMSG_TYPE_INT16
)
331 tmp
= (int16_t)blobmsg_get_u16(attr
);
332 else if (blobmsg_type(attr
) == BLOBMSG_TYPE_INT8
)
333 tmp
= (int8_t)blobmsg_get_u8(attr
);
338 static inline double blobmsg_get_double(struct blob_attr
*attr
)
344 v
.u64
= blobmsg_get_u64(attr
);
348 static inline char *blobmsg_get_string(struct blob_attr
*attr
)
353 return (char *) blobmsg_data(attr
);
356 void *blobmsg_alloc_string_buffer(struct blob_buf
*buf
, const char *name
, unsigned int maxlen
);
357 void *blobmsg_realloc_string_buffer(struct blob_buf
*buf
, unsigned int maxlen
);
358 void blobmsg_add_string_buffer(struct blob_buf
*buf
);
360 int blobmsg_vprintf(struct blob_buf
*buf
, const char *name
, const char *format
, va_list arg
);
361 int blobmsg_printf(struct blob_buf
*buf
, const char *name
, const char *format
, ...)
362 __attribute__((format(printf
, 3, 4)));
364 #define blobmsg_for_each_attr(pos, attr, rem) \
365 for (rem = attr ? blobmsg_data_len(attr) : 0, \
366 pos = (struct blob_attr *) (attr ? blobmsg_data(attr) : NULL); \
367 rem >= sizeof(struct blob_attr) && (blob_pad_len(pos) <= rem) && \
368 (blob_pad_len(pos) >= sizeof(struct blob_attr)); \
369 rem -= blob_pad_len(pos), pos = blob_next(pos))
371 #define __blobmsg_for_each_attr(pos, attr, rem) \
372 for (pos = (struct blob_attr *) (attr ? blobmsg_data(attr) : NULL); \
373 rem >= sizeof(struct blob_attr) && (blob_pad_len(pos) <= rem) && \
374 (blob_pad_len(pos) >= sizeof(struct blob_attr)); \
375 rem -= blob_pad_len(pos), pos = blob_next(pos))