2 * blobmsg - library for generating/parsing structured blob messages
4 * Copyright (C) 2010 Felix Fietkau <nbd@openwrt.org>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU Lesser General Public License version 2.1
8 * as published by the Free Software Foundation
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
21 #define BLOBMSG_ALIGN 2
22 #define BLOBMSG_PADDING(len) (((len) + (1 << BLOBMSG_ALIGN) - 1) & ~((1 << BLOBMSG_ALIGN) - 1))
34 BLOBMSG_TYPE_LAST = __BLOBMSG_TYPE_LAST - 1,
35 BLOBMSG_TYPE_BOOL = BLOBMSG_TYPE_INT8,
43 struct blobmsg_policy {
45 enum blobmsg_type type;
48 static inline int blobmsg_hdrlen(int namelen)
50 return BLOBMSG_PADDING(sizeof(struct blobmsg_hdr) + namelen + 1);
53 static inline const char *blobmsg_name(const struct blob_attr *attr)
55 struct blobmsg_hdr *hdr = (struct blobmsg_hdr *) blob_data(attr);
56 return (const char *) hdr->name;
59 static inline int blobmsg_type(const struct blob_attr *attr)
64 static inline void *blobmsg_data(const struct blob_attr *attr)
66 struct blobmsg_hdr *hdr = (struct blobmsg_hdr *) blob_data(attr);
67 return (char *) hdr + blobmsg_hdrlen(be16_to_cpu(hdr->namelen));
70 static inline int blobmsg_data_len(const struct blob_attr *attr)
74 start = (uint8_t *) blob_data(attr);
75 end = (uint8_t *) blobmsg_data(attr);
77 return blob_len(attr) - (end - start);
80 bool blobmsg_check_attr(const struct blob_attr *attr, bool name);
81 int blobmsg_parse(const struct blobmsg_policy *policy, int policy_len,
82 struct blob_attr **tb, void *data, int len);
84 int blobmsg_add_field(struct blob_buf *buf, int type, const char *name,
85 const void *data, int len);
88 blobmsg_add_u8(struct blob_buf *buf, const char *name, uint8_t val)
90 return blobmsg_add_field(buf, BLOBMSG_TYPE_INT8, name, &val, 1);
94 blobmsg_add_u16(struct blob_buf *buf, const char *name, uint16_t val)
96 val = cpu_to_be16(val);
97 return blobmsg_add_field(buf, BLOBMSG_TYPE_INT16, name, &val, 2);
101 blobmsg_add_u32(struct blob_buf *buf, const char *name, uint32_t val)
103 val = cpu_to_be32(val);
104 return blobmsg_add_field(buf, BLOBMSG_TYPE_INT32, name, &val, 4);
108 blobmsg_add_u64(struct blob_buf *buf, const char *name, uint64_t val)
110 val = cpu_to_be64(val);
111 return blobmsg_add_field(buf, BLOBMSG_TYPE_INT64, name, &val, 8);
115 blobmsg_add_string(struct blob_buf *buf, const char *name, const char *string)
117 return blobmsg_add_field(buf, BLOBMSG_TYPE_STRING, name, string, strlen(string) + 1);
120 void *blobmsg_open_nested(struct blob_buf *buf, const char *name, bool array);
123 blobmsg_open_array(struct blob_buf *buf, const char *name)
125 return blobmsg_open_nested(buf, name, true);
129 blobmsg_open_table(struct blob_buf *buf, const char *name)
131 return blobmsg_open_nested(buf, name, false);
135 blobmsg_close_array(struct blob_buf *buf, void *cookie)
137 blob_nest_end(buf, cookie);
141 blobmsg_close_table(struct blob_buf *buf, void *cookie)
143 blob_nest_end(buf, cookie);
146 static inline int blobmsg_buf_init(struct blob_buf *buf)
148 return blob_buf_init(buf, BLOBMSG_TYPE_TABLE);
151 static inline uint8_t blobmsg_get_u8(struct blob_attr *attr)
153 return *(uint8_t *) blobmsg_data(attr);
156 static inline bool blobmsg_get_bool(struct blob_attr *attr)
158 return *(uint8_t *) blobmsg_data(attr);
161 static inline uint16_t blobmsg_get_u16(struct blob_attr *attr)
163 return be16_to_cpu(*(uint16_t *) blobmsg_data(attr));
166 static inline uint32_t blobmsg_get_u32(struct blob_attr *attr)
168 return be32_to_cpu(*(uint32_t *) blobmsg_data(attr));
171 static inline uint64_t blobmsg_get_u64(struct blob_attr *attr)
173 return be64_to_cpu(*(uint64_t *) blobmsg_data(attr));
176 void *blobmsg_alloc_string_buffer(struct blob_buf *buf, const char *name, int maxlen);
177 void blobmsg_add_string_buffer(struct blob_buf *buf);
179 /* blobmsg to json formatting */
181 #define blobmsg_for_each_attr(pos, attr, rem) \
182 for (rem = blobmsg_data_len(attr), pos = blobmsg_data(attr); \
183 rem > 0 && (blob_pad_len(pos) <= rem) && \
184 (blob_pad_len(pos) >= sizeof(struct blob_attr)); \
185 rem -= blob_pad_len(pos), pos = blob_next(pos))