2 * blob - library for generating/parsing tagged binary data
4 * Copyright (C) 2010 Felix Fietkau <nbd@openwrt.org>
6 * Permission to use, copy, modify, and/or distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
31 #define BLOB_COOKIE 0x01234567
46 #define BLOB_ATTR_ID_MASK 0x7f000000
47 #define BLOB_ATTR_ID_SHIFT 24
48 #define BLOB_ATTR_LEN_MASK 0x00ffffff
49 #define BLOB_ATTR_ALIGN 4
50 #define BLOB_ATTR_EXTENDED 0x80000000
57 struct blob_attr_info
{
61 bool (*validate
)(const struct blob_attr_info
*, struct blob_attr
*);
65 struct blob_attr
*head
;
66 bool (*grow
)(struct blob_buf
*buf
, int minlen
);
72 * blob_data: returns the data pointer for an attribute
75 blob_data(const struct blob_attr
*attr
)
77 return (void *) attr
->data
;
81 * blob_id: returns the id of an attribute
83 static inline unsigned int
84 blob_id(const struct blob_attr
*attr
)
86 int id
= (be32_to_cpu(attr
->id_len
) & BLOB_ATTR_ID_MASK
) >> BLOB_ATTR_ID_SHIFT
;
91 blob_is_extended(const struct blob_attr
*attr
)
93 return !!(attr
->id_len
& cpu_to_be32(BLOB_ATTR_EXTENDED
));
97 * blob_len: returns the length of the attribute's payload
100 blob_len(const struct blob_attr
*attr
)
102 return (be32_to_cpu(attr
->id_len
) & BLOB_ATTR_LEN_MASK
) - sizeof(struct blob_attr
);
106 * blob_raw_len: returns the complete length of an attribute (including the header)
109 blob_raw_len(const struct blob_attr
*attr
)
111 return blob_len(attr
) + sizeof(struct blob_attr
);
115 * blob_pad_len: returns the padded length of an attribute (including the header)
118 blob_pad_len(const struct blob_attr
*attr
)
120 unsigned int len
= blob_raw_len(attr
);
121 len
= (len
+ BLOB_ATTR_ALIGN
- 1) & ~(BLOB_ATTR_ALIGN
- 1);
125 static inline uint8_t
126 blob_get_u8(const struct blob_attr
*attr
)
128 return *((uint8_t *) attr
->data
);
131 static inline uint16_t
132 blob_get_u16(const struct blob_attr
*attr
)
134 uint16_t *tmp
= (uint16_t*)attr
->data
;
135 return be16_to_cpu(*tmp
);
138 static inline uint32_t
139 blob_get_u32(const struct blob_attr
*attr
)
141 uint32_t *tmp
= (uint32_t*)attr
->data
;
142 return be32_to_cpu(*tmp
);
145 static inline uint64_t
146 blob_get_u64(const struct blob_attr
*attr
)
148 uint32_t *ptr
= (uint32_t *) blob_data(attr
);
149 uint64_t tmp
= ((uint64_t) be32_to_cpu(ptr
[0])) << 32;
150 tmp
|= be32_to_cpu(ptr
[1]);
155 blob_get_int8(const struct blob_attr
*attr
)
157 return blob_get_u8(attr
);
160 static inline int16_t
161 blob_get_int16(const struct blob_attr
*attr
)
163 return blob_get_u16(attr
);
166 static inline int32_t
167 blob_get_int32(const struct blob_attr
*attr
)
169 return blob_get_u32(attr
);
172 static inline int64_t
173 blob_get_int64(const struct blob_attr
*attr
)
175 return blob_get_u64(attr
);
178 static inline const char *
179 blob_get_string(const struct blob_attr
*attr
)
184 static inline struct blob_attr
*
185 blob_next(const struct blob_attr
*attr
)
187 return (struct blob_attr
*) ((char *) attr
+ blob_pad_len(attr
));
190 extern void blob_fill_pad(struct blob_attr
*attr
);
191 extern void blob_set_raw_len(struct blob_attr
*attr
, unsigned int len
);
192 extern bool blob_attr_equal(const struct blob_attr
*a1
, const struct blob_attr
*a2
);
193 extern int blob_buf_init(struct blob_buf
*buf
, int id
);
194 extern void blob_buf_free(struct blob_buf
*buf
);
195 extern bool blob_buf_grow(struct blob_buf
*buf
, int required
);
196 extern struct blob_attr
*blob_new(struct blob_buf
*buf
, int id
, int payload
);
197 extern void *blob_nest_start(struct blob_buf
*buf
, int id
);
198 extern void blob_nest_end(struct blob_buf
*buf
, void *cookie
);
199 extern struct blob_attr
*blob_put(struct blob_buf
*buf
, int id
, const void *ptr
, unsigned int len
);
200 extern bool blob_check_type(const void *ptr
, unsigned int len
, int type
);
201 extern int blob_parse(struct blob_attr
*attr
, struct blob_attr
**data
, const struct blob_attr_info
*info
, int max
);
202 extern int blob_parse_untrusted(struct blob_attr
*attr
, size_t attr_len
, struct blob_attr
**data
, const struct blob_attr_info
*info
, int max
);
203 extern struct blob_attr
*blob_memdup(struct blob_attr
*attr
);
204 extern struct blob_attr
*blob_put_raw(struct blob_buf
*buf
, const void *ptr
, unsigned int len
);
206 static inline struct blob_attr
*
207 blob_put_string(struct blob_buf
*buf
, int id
, const char *str
)
209 return blob_put(buf
, id
, str
, strlen(str
) + 1);
212 static inline struct blob_attr
*
213 blob_put_u8(struct blob_buf
*buf
, int id
, uint8_t val
)
215 return blob_put(buf
, id
, &val
, sizeof(val
));
218 static inline struct blob_attr
*
219 blob_put_u16(struct blob_buf
*buf
, int id
, uint16_t val
)
221 val
= cpu_to_be16(val
);
222 return blob_put(buf
, id
, &val
, sizeof(val
));
225 static inline struct blob_attr
*
226 blob_put_u32(struct blob_buf
*buf
, int id
, uint32_t val
)
228 val
= cpu_to_be32(val
);
229 return blob_put(buf
, id
, &val
, sizeof(val
));
232 static inline struct blob_attr
*
233 blob_put_u64(struct blob_buf
*buf
, int id
, uint64_t val
)
235 val
= cpu_to_be64(val
);
236 return blob_put(buf
, id
, &val
, sizeof(val
));
239 #define blob_put_int8 blob_put_u8
240 #define blob_put_int16 blob_put_u16
241 #define blob_put_int32 blob_put_u32
242 #define blob_put_int64 blob_put_u64
244 #define __blob_for_each_attr(pos, attr, rem) \
245 for (pos = (struct blob_attr *) attr; \
246 rem > 0 && (blob_pad_len(pos) <= rem) && \
247 (blob_pad_len(pos) >= sizeof(struct blob_attr)); \
248 rem -= blob_pad_len(pos), pos = blob_next(pos))
251 #define blob_for_each_attr(pos, attr, rem) \
252 for (rem = attr ? blob_len(attr) : 0, \
253 pos = (struct blob_attr *) (attr ? blob_data(attr) : NULL); \
254 rem > 0 && (blob_pad_len(pos) <= rem) && \
255 (blob_pad_len(pos) >= sizeof(struct blob_attr)); \
256 rem -= blob_pad_len(pos), pos = blob_next(pos))
258 #define blob_for_each_attr_len(pos, attr, attr_len, rem) \
259 for (rem = attr ? blob_len(attr) : 0, \
260 pos = (struct blob_attr *) (attr ? blob_data(attr) : NULL); \
261 rem >= sizeof(struct blob_attr) && rem < attr_len && (blob_pad_len(pos) <= rem) && \
262 (blob_pad_len(pos) >= sizeof(struct blob_attr)); \
263 rem -= blob_pad_len(pos), pos = blob_next(pos))