usock: implement usock_inet_timeout() with RFC6555 support
[project/libubox.git] / blobmsg.h
1 /*
2  * Copyright (C) 2010-2012 Felix Fietkau <nbd@openwrt.org>
3  *
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.
7  *
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.
15  */
16 #ifndef __BLOBMSG_H
17 #define __BLOBMSG_H
18
19 #include <stdarg.h>
20 #include "blob.h"
21
22 #define BLOBMSG_ALIGN   2
23 #define BLOBMSG_PADDING(len) (((len) + (1 << BLOBMSG_ALIGN) - 1) & ~((1 << BLOBMSG_ALIGN) - 1))
24
25 enum blobmsg_type {
26         BLOBMSG_TYPE_UNSPEC,
27         BLOBMSG_TYPE_ARRAY,
28         BLOBMSG_TYPE_TABLE,
29         BLOBMSG_TYPE_STRING,
30         BLOBMSG_TYPE_INT64,
31         BLOBMSG_TYPE_INT32,
32         BLOBMSG_TYPE_INT16,
33         BLOBMSG_TYPE_INT8,
34         __BLOBMSG_TYPE_LAST,
35         BLOBMSG_TYPE_LAST = __BLOBMSG_TYPE_LAST - 1,
36         BLOBMSG_TYPE_BOOL = BLOBMSG_TYPE_INT8,
37 };
38
39 struct blobmsg_hdr {
40         uint16_t namelen;
41         uint8_t name[];
42 } __packed;
43
44 struct blobmsg_policy {
45         const char *name;
46         enum blobmsg_type type;
47 };
48
49 static inline int blobmsg_hdrlen(unsigned int namelen)
50 {
51         return BLOBMSG_PADDING(sizeof(struct blobmsg_hdr) + namelen + 1);
52 }
53
54 static inline void blobmsg_clear_name(struct blob_attr *attr)
55 {
56         struct blobmsg_hdr *hdr = (struct blobmsg_hdr *) blob_data(attr);
57         hdr->name[0] = 0;
58 }
59
60 static inline const char *blobmsg_name(const struct blob_attr *attr)
61 {
62         struct blobmsg_hdr *hdr = (struct blobmsg_hdr *) blob_data(attr);
63         return (const char *) hdr->name;
64 }
65
66 static inline int blobmsg_type(const struct blob_attr *attr)
67 {
68         return blob_id(attr);
69 }
70
71 static inline void *blobmsg_data(const struct blob_attr *attr)
72 {
73         struct blobmsg_hdr *hdr = (struct blobmsg_hdr *) blob_data(attr);
74         char *data = (char *) blob_data(attr);
75
76         if (blob_is_extended(attr))
77                 data += blobmsg_hdrlen(be16_to_cpu(hdr->namelen));
78
79         return data;
80 }
81
82 static inline int blobmsg_data_len(const struct blob_attr *attr)
83 {
84         uint8_t *start, *end;
85
86         start = (uint8_t *) blob_data(attr);
87         end = (uint8_t *) blobmsg_data(attr);
88
89         return blob_len(attr) - (end - start);
90 }
91
92 static inline int blobmsg_len(const struct blob_attr *attr)
93 {
94         return blobmsg_data_len(attr);
95 }
96
97 bool blobmsg_check_attr(const struct blob_attr *attr, bool name);
98 bool blobmsg_check_attr_list(const struct blob_attr *attr, int type);
99
100 /*
101  * blobmsg_check_array: validate array/table and return size
102  *
103  * Checks if all elements of an array or table are valid and have
104  * the specified type. Returns the number of elements in the array
105  */
106 int blobmsg_check_array(const struct blob_attr *attr, int type);
107
108 int blobmsg_parse(const struct blobmsg_policy *policy, int policy_len,
109                   struct blob_attr **tb, void *data, unsigned int len);
110 int blobmsg_parse_array(const struct blobmsg_policy *policy, int policy_len,
111                         struct blob_attr **tb, void *data, unsigned int len);
112
113 int blobmsg_add_field(struct blob_buf *buf, int type, const char *name,
114                       const void *data, unsigned int len);
115
116 static inline int
117 blobmsg_add_u8(struct blob_buf *buf, const char *name, uint8_t val)
118 {
119         return blobmsg_add_field(buf, BLOBMSG_TYPE_INT8, name, &val, 1);
120 }
121
122 static inline int
123 blobmsg_add_u16(struct blob_buf *buf, const char *name, uint16_t val)
124 {
125         val = cpu_to_be16(val);
126         return blobmsg_add_field(buf, BLOBMSG_TYPE_INT16, name, &val, 2);
127 }
128
129 static inline int
130 blobmsg_add_u32(struct blob_buf *buf, const char *name, uint32_t val)
131 {
132         val = cpu_to_be32(val);
133         return blobmsg_add_field(buf, BLOBMSG_TYPE_INT32, name, &val, 4);
134 }
135
136 static inline int
137 blobmsg_add_u64(struct blob_buf *buf, const char *name, uint64_t val)
138 {
139         val = cpu_to_be64(val);
140         return blobmsg_add_field(buf, BLOBMSG_TYPE_INT64, name, &val, 8);
141 }
142
143 static inline int
144 blobmsg_add_string(struct blob_buf *buf, const char *name, const char *string)
145 {
146         return blobmsg_add_field(buf, BLOBMSG_TYPE_STRING, name, string, strlen(string) + 1);
147 }
148
149 static inline int
150 blobmsg_add_blob(struct blob_buf *buf, struct blob_attr *attr)
151 {
152         return blobmsg_add_field(buf, blobmsg_type(attr), blobmsg_name(attr),
153                                  blobmsg_data(attr), blobmsg_data_len(attr));
154 }
155
156 void *blobmsg_open_nested(struct blob_buf *buf, const char *name, bool array);
157
158 static inline void *
159 blobmsg_open_array(struct blob_buf *buf, const char *name)
160 {
161         return blobmsg_open_nested(buf, name, true);
162 }
163
164 static inline void *
165 blobmsg_open_table(struct blob_buf *buf, const char *name)
166 {
167         return blobmsg_open_nested(buf, name, false);
168 }
169
170 static inline void
171 blobmsg_close_array(struct blob_buf *buf, void *cookie)
172 {
173         blob_nest_end(buf, cookie);
174 }
175
176 static inline void
177 blobmsg_close_table(struct blob_buf *buf, void *cookie)
178 {
179         blob_nest_end(buf, cookie);
180 }
181
182 static inline int blobmsg_buf_init(struct blob_buf *buf)
183 {
184         return blob_buf_init(buf, BLOBMSG_TYPE_TABLE);
185 }
186
187 static inline uint8_t blobmsg_get_u8(struct blob_attr *attr)
188 {
189         return *(uint8_t *) blobmsg_data(attr);
190 }
191
192 static inline bool blobmsg_get_bool(struct blob_attr *attr)
193 {
194         return *(uint8_t *) blobmsg_data(attr);
195 }
196
197 static inline uint16_t blobmsg_get_u16(struct blob_attr *attr)
198 {
199         return be16_to_cpu(*(uint16_t *) blobmsg_data(attr));
200 }
201
202 static inline uint32_t blobmsg_get_u32(struct blob_attr *attr)
203 {
204         return be32_to_cpu(*(uint32_t *) blobmsg_data(attr));
205 }
206
207 static inline uint64_t blobmsg_get_u64(struct blob_attr *attr)
208 {
209         uint32_t *ptr = (uint32_t *) blobmsg_data(attr);
210         uint64_t tmp = ((uint64_t) be32_to_cpu(ptr[0])) << 32;
211         tmp |= be32_to_cpu(ptr[1]);
212         return tmp;
213 }
214
215 static inline char *blobmsg_get_string(struct blob_attr *attr)
216 {
217         if (!attr)
218                 return NULL;
219
220         return (char *) blobmsg_data(attr);
221 }
222
223 void *blobmsg_alloc_string_buffer(struct blob_buf *buf, const char *name, unsigned int maxlen);
224 void *blobmsg_realloc_string_buffer(struct blob_buf *buf, unsigned int maxlen);
225 void blobmsg_add_string_buffer(struct blob_buf *buf);
226
227 void blobmsg_vprintf(struct blob_buf *buf, const char *name, const char *format, va_list arg);
228 void blobmsg_printf(struct blob_buf *buf, const char *name, const char *format, ...)
229      __attribute__((format(printf, 3, 4)));
230
231
232 /* blobmsg to json formatting */
233
234 #define blobmsg_for_each_attr(pos, attr, rem) \
235         for (rem = attr ? blobmsg_data_len(attr) : 0, \
236              pos = attr ? blobmsg_data(attr) : 0; \
237              rem > 0 && (blob_pad_len(pos) <= rem) && \
238              (blob_pad_len(pos) >= sizeof(struct blob_attr)); \
239              rem -= blob_pad_len(pos), pos = blob_next(pos))
240
241 #endif