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.
29 #if defined(__linux__) || defined(__CYGWIN__)
33 #elif defined(__APPLE__)
34 #include <machine/endian.h>
35 #include <machine/byte_order.h>
36 #define bswap_16(x) OSSwapInt16(x)
37 #define bswap_32(x) OSSwapInt32(x)
38 #define bswap_64(x) OSSwapInt64(x)
39 #elif defined(__FreeBSD__)
40 #include <sys/endian.h>
41 #define bswap_16(x) bswap16(x)
42 #define bswap_32(x) bswap32(x)
43 #define bswap_64(x) bswap64(x)
45 #include <machine/endian.h>
46 #define bswap_16(x) swap16(x)
47 #define bswap_32(x) swap32(x)
48 #define bswap_64(x) swap64(x)
52 #define __BYTE_ORDER BYTE_ORDER
55 #define __BIG_ENDIAN BIG_ENDIAN
57 #ifndef __LITTLE_ENDIAN
58 #define __LITTLE_ENDIAN LITTLE_ENDIAN
61 #if __BYTE_ORDER == __LITTLE_ENDIAN
63 #define cpu_to_be64(x) bswap_64(x)
64 #define cpu_to_be32(x) bswap_32(x)
65 #define cpu_to_be16(x) bswap_16(x)
67 #define be64_to_cpu(x) bswap_64(x)
68 #define be32_to_cpu(x) bswap_32(x)
69 #define be16_to_cpu(x) bswap_16(x)
73 #define cpu_to_be64(x) (x)
74 #define cpu_to_be32(x) (x)
75 #define cpu_to_be16(x) (x)
77 #define be64_to_cpu(x) (x)
78 #define be32_to_cpu(x) (x)
79 #define be16_to_cpu(x) (x)
95 #define BLOB_ATTR_ID_MASK 0xff000000
96 #define BLOB_ATTR_ID_SHIFT 24
97 #define BLOB_ATTR_LEN_MASK 0x00ffffff
98 #define BLOB_ATTR_ALIGN 4
101 #define __packed __attribute__((packed))
109 struct blob_attr_info
{
113 bool (*validate
)(const struct blob_attr_info
*, struct blob_attr
*);
117 struct blob_attr
*head
;
118 bool (*grow
)(struct blob_buf
*buf
, int minlen
);
124 * blob_data: returns the data pointer for an attribute
127 blob_data(const struct blob_attr
*attr
)
129 return (void *) attr
->data
;
133 * blob_id: returns the id of an attribute
135 static inline unsigned int
136 blob_id(const struct blob_attr
*attr
)
138 int id
= (be32_to_cpu(attr
->id_len
) & BLOB_ATTR_ID_MASK
) >> BLOB_ATTR_ID_SHIFT
;
143 * blob_len: returns the length of the attribute's payload
145 static inline unsigned int
146 blob_len(const struct blob_attr
*attr
)
148 return (be32_to_cpu(attr
->id_len
) & BLOB_ATTR_LEN_MASK
) - sizeof(struct blob_attr
);
152 * blob_raw_len: returns the complete length of an attribute (including the header)
154 static inline unsigned int
155 blob_raw_len(const struct blob_attr
*attr
)
157 return blob_len(attr
) + sizeof(struct blob_attr
);
161 * blob_pad_len: returns the padded length of an attribute (including the header)
163 static inline unsigned int
164 blob_pad_len(const struct blob_attr
*attr
)
166 int len
= blob_raw_len(attr
);
167 len
= (len
+ BLOB_ATTR_ALIGN
- 1) & ~(BLOB_ATTR_ALIGN
- 1);
171 static inline uint8_t
172 blob_get_u8(const struct blob_attr
*attr
)
174 return *((uint8_t *) attr
->data
);
177 static inline uint16_t
178 blob_get_u16(const struct blob_attr
*attr
)
180 uint16_t *tmp
= (uint16_t*)attr
->data
;
181 return be16_to_cpu(*tmp
);
184 static inline uint32_t
185 blob_get_u32(const struct blob_attr
*attr
)
187 uint32_t *tmp
= (uint32_t*)attr
->data
;
188 return be32_to_cpu(*tmp
);
191 static inline uint64_t
192 blob_get_u64(const struct blob_attr
*attr
)
194 uint32_t *ptr
= blob_data(attr
);
195 uint64_t tmp
= ((uint64_t) be32_to_cpu(ptr
[0])) << 32;
196 tmp
|= be32_to_cpu(ptr
[1]);
201 blob_get_int8(const struct blob_attr
*attr
)
203 return blob_get_u8(attr
);
206 static inline int16_t
207 blob_get_int16(const struct blob_attr
*attr
)
209 return blob_get_u16(attr
);
212 static inline int32_t
213 blob_get_int32(const struct blob_attr
*attr
)
215 return blob_get_u32(attr
);
218 static inline int64_t
219 blob_get_int64(const struct blob_attr
*attr
)
221 return blob_get_u64(attr
);
224 static inline const char *
225 blob_get_string(const struct blob_attr
*attr
)
230 static inline struct blob_attr
*
231 blob_next(const struct blob_attr
*attr
)
233 return (struct blob_attr
*) ((char *) attr
+ blob_pad_len(attr
));
236 extern void blob_fill_pad(struct blob_attr
*attr
);
237 extern void blob_set_raw_len(struct blob_attr
*attr
, unsigned int len
);
238 extern bool blob_attr_equal(const struct blob_attr
*a1
, const struct blob_attr
*a2
);
239 extern int blob_buf_init(struct blob_buf
*buf
, int id
);
240 extern void blob_buf_free(struct blob_buf
*buf
);
241 extern void blob_buf_grow(struct blob_buf
*buf
, int required
);
242 extern struct blob_attr
*blob_new(struct blob_buf
*buf
, int id
, int payload
);
243 extern void *blob_nest_start(struct blob_buf
*buf
, int id
);
244 extern void blob_nest_end(struct blob_buf
*buf
, void *cookie
);
245 extern struct blob_attr
*blob_put(struct blob_buf
*buf
, int id
, const void *ptr
, int len
);
246 extern bool blob_check_type(const void *ptr
, int len
, int type
);
247 extern int blob_parse(struct blob_attr
*attr
, struct blob_attr
**data
, const struct blob_attr_info
*info
, int max
);
248 extern struct blob_attr
*blob_memdup(struct blob_attr
*attr
);
250 static inline struct blob_attr
*
251 blob_put_string(struct blob_buf
*buf
, int id
, const char *str
)
253 return blob_put(buf
, id
, str
, strlen(str
) + 1);
256 static inline struct blob_attr
*
257 blob_put_u8(struct blob_buf
*buf
, int id
, uint8_t val
)
259 return blob_put(buf
, id
, &val
, sizeof(val
));
262 static inline struct blob_attr
*
263 blob_put_u16(struct blob_buf
*buf
, int id
, uint16_t val
)
265 val
= cpu_to_be16(val
);
266 return blob_put(buf
, id
, &val
, sizeof(val
));
269 static inline struct blob_attr
*
270 blob_put_u32(struct blob_buf
*buf
, int id
, uint32_t val
)
272 val
= cpu_to_be32(val
);
273 return blob_put(buf
, id
, &val
, sizeof(val
));
276 static inline struct blob_attr
*
277 blob_put_u64(struct blob_buf
*buf
, int id
, uint64_t val
)
279 val
= cpu_to_be64(val
);
280 return blob_put(buf
, id
, &val
, sizeof(val
));
283 #define blob_put_int8 blob_put_u8
284 #define blob_put_int16 blob_put_u16
285 #define blob_put_int32 blob_put_u32
286 #define blob_put_int64 blob_put_u64
288 #define __blob_for_each_attr(pos, attr, rem) \
289 for (pos = (void *) attr; \
290 rem > 0 && (blob_pad_len(pos) <= rem) && \
291 (blob_pad_len(pos) >= sizeof(struct blob_attr)); \
292 rem -= blob_pad_len(pos), pos = blob_next(pos))
295 #define blob_for_each_attr(pos, attr, rem) \
296 for (rem = blob_len(attr), pos = blob_data(attr); \
297 rem > 0 && (blob_pad_len(pos) <= rem) && \
298 (blob_pad_len(pos) >= sizeof(struct blob_attr)); \
299 rem -= blob_pad_len(pos), pos = blob_next(pos))