blobmsg_example: fix output
[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 const char *blobmsg_name(const struct blob_attr *attr)
55 {
56 struct blobmsg_hdr *hdr = (struct blobmsg_hdr *) blob_data(attr);
57 return (const char *) hdr->name;
58 }
59
60 static inline int blobmsg_type(const struct blob_attr *attr)
61 {
62 return blob_id(attr);
63 }
64
65 static inline void *blobmsg_data(const struct blob_attr *attr)
66 {
67 struct blobmsg_hdr *hdr = (struct blobmsg_hdr *) blob_data(attr);
68 char *data = (char *) blob_data(attr);
69
70 if (blob_is_extended(attr))
71 data += blobmsg_hdrlen(be16_to_cpu(hdr->namelen));
72
73 return data;
74 }
75
76 static inline int blobmsg_data_len(const struct blob_attr *attr)
77 {
78 uint8_t *start, *end;
79
80 start = (uint8_t *) blob_data(attr);
81 end = (uint8_t *) blobmsg_data(attr);
82
83 return blob_len(attr) - (end - start);
84 }
85
86 static inline int blobmsg_len(const struct blob_attr *attr)
87 {
88 return blobmsg_data_len(attr);
89 }
90
91 bool blobmsg_check_attr(const struct blob_attr *attr, bool name);
92 bool blobmsg_check_attr_list(const struct blob_attr *attr, int type);
93 int blobmsg_parse(const struct blobmsg_policy *policy, int policy_len,
94 struct blob_attr **tb, void *data, unsigned int len);
95 int blobmsg_parse_array(const struct blobmsg_policy *policy, int policy_len,
96 struct blob_attr **tb, void *data, unsigned int len);
97
98 int blobmsg_add_field(struct blob_buf *buf, int type, const char *name,
99 const void *data, unsigned int len);
100
101 static inline int
102 blobmsg_add_u8(struct blob_buf *buf, const char *name, uint8_t val)
103 {
104 return blobmsg_add_field(buf, BLOBMSG_TYPE_INT8, name, &val, 1);
105 }
106
107 static inline int
108 blobmsg_add_u16(struct blob_buf *buf, const char *name, uint16_t val)
109 {
110 val = cpu_to_be16(val);
111 return blobmsg_add_field(buf, BLOBMSG_TYPE_INT16, name, &val, 2);
112 }
113
114 static inline int
115 blobmsg_add_u32(struct blob_buf *buf, const char *name, uint32_t val)
116 {
117 val = cpu_to_be32(val);
118 return blobmsg_add_field(buf, BLOBMSG_TYPE_INT32, name, &val, 4);
119 }
120
121 static inline int
122 blobmsg_add_u64(struct blob_buf *buf, const char *name, uint64_t val)
123 {
124 val = cpu_to_be64(val);
125 return blobmsg_add_field(buf, BLOBMSG_TYPE_INT64, name, &val, 8);
126 }
127
128 static inline int
129 blobmsg_add_string(struct blob_buf *buf, const char *name, const char *string)
130 {
131 return blobmsg_add_field(buf, BLOBMSG_TYPE_STRING, name, string, strlen(string) + 1);
132 }
133
134 static inline int
135 blobmsg_add_blob(struct blob_buf *buf, struct blob_attr *attr)
136 {
137 return blobmsg_add_field(buf, blobmsg_type(attr), blobmsg_name(attr),
138 blobmsg_data(attr), blobmsg_data_len(attr));
139 }
140
141 void *blobmsg_open_nested(struct blob_buf *buf, const char *name, bool array);
142
143 static inline void *
144 blobmsg_open_array(struct blob_buf *buf, const char *name)
145 {
146 return blobmsg_open_nested(buf, name, true);
147 }
148
149 static inline void *
150 blobmsg_open_table(struct blob_buf *buf, const char *name)
151 {
152 return blobmsg_open_nested(buf, name, false);
153 }
154
155 static inline void
156 blobmsg_close_array(struct blob_buf *buf, void *cookie)
157 {
158 blob_nest_end(buf, cookie);
159 }
160
161 static inline void
162 blobmsg_close_table(struct blob_buf *buf, void *cookie)
163 {
164 blob_nest_end(buf, cookie);
165 }
166
167 static inline int blobmsg_buf_init(struct blob_buf *buf)
168 {
169 return blob_buf_init(buf, BLOBMSG_TYPE_TABLE);
170 }
171
172 static inline uint8_t blobmsg_get_u8(struct blob_attr *attr)
173 {
174 return *(uint8_t *) blobmsg_data(attr);
175 }
176
177 static inline bool blobmsg_get_bool(struct blob_attr *attr)
178 {
179 return *(uint8_t *) blobmsg_data(attr);
180 }
181
182 static inline uint16_t blobmsg_get_u16(struct blob_attr *attr)
183 {
184 return be16_to_cpu(*(uint16_t *) blobmsg_data(attr));
185 }
186
187 static inline uint32_t blobmsg_get_u32(struct blob_attr *attr)
188 {
189 return be32_to_cpu(*(uint32_t *) blobmsg_data(attr));
190 }
191
192 static inline uint64_t blobmsg_get_u64(struct blob_attr *attr)
193 {
194 uint32_t *ptr = (uint32_t *) blobmsg_data(attr);
195 uint64_t tmp = ((uint64_t) be32_to_cpu(ptr[0])) << 32;
196 tmp |= be32_to_cpu(ptr[1]);
197 return tmp;
198 }
199
200 static inline char *blobmsg_get_string(struct blob_attr *attr)
201 {
202 return (char *) blobmsg_data(attr);
203 }
204
205 void *blobmsg_alloc_string_buffer(struct blob_buf *buf, const char *name, unsigned int maxlen);
206 void *blobmsg_realloc_string_buffer(struct blob_buf *buf, unsigned int maxlen);
207 void blobmsg_add_string_buffer(struct blob_buf *buf);
208
209 void blobmsg_vprintf(struct blob_buf *buf, const char *name, const char *format, va_list arg);
210 void blobmsg_printf(struct blob_buf *buf, const char *name, const char *format, ...)
211 __attribute__((format(printf, 3, 4)));
212
213
214 /* blobmsg to json formatting */
215
216 #define blobmsg_for_each_attr(pos, attr, rem) \
217 for (rem = attr ? blobmsg_data_len(attr) : 0, \
218 pos = attr ? blobmsg_data(attr) : 0; \
219 rem > 0 && (blob_pad_len(pos) <= rem) && \
220 (blob_pad_len(pos) >= sizeof(struct blob_attr)); \
221 rem -= blob_pad_len(pos), pos = blob_next(pos))
222
223 #endif