blobmsg.c

   1 /*
   2  * blobmsg - library for generating/parsing structured blob messages
   3  *
   4  * Copyright (C) 2010 Felix Fietkau <nbd@openwrt.org>
   5  *
   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
   9  *
  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.
  14  */
  15
  16 #include "blobmsg.h"
  17
  18 struct strbuf {
  19         int len;
  20         int pos;
  21         char *buf;
  22 };
  23
  24 static bool blobmsg_puts(struct strbuf *s, const char *c, int len)
  25 {
  26         if (len <= 0)
  27                 return true;
  28
  29         if (s->pos + len >= s->len) {
  30                 s->len += 16;
  31                 s->buf = realloc(s->buf, s->len);
  32                 if (!s->buf)
  33                         return false;
  34         }
  35         memcpy(s->buf + s->pos, c, len);
  36         s->pos += len;
  37         return true;
  38 }
  39
  40 static void blobmsg_format_string(struct strbuf *s, const char *str)
  41 {
  42         const char *p, *last = str, *end = str + strlen(str);
  43         char buf[8] = "\\u00";
  44
  45         blobmsg_puts(s, "\"", 1);
  46         for (p = str; *p; p++) {
  47                 char escape = '\0';
  48                 int len;
  49
  50                 switch(*p) {
  51                 case '\b':
  52                         escape = 'b';
  53                         break;
  54                 case '\n':
  55                         escape = 'n';
  56                         break;
  57                 case '\t':
  58                         escape = 't';
  59                         break;
  60                 case '\r':
  61                         escape = 'r';
  62                         break;
  63                 case '"':
  64                 case '\\':
  65                 case '/':
  66                         escape = *p;
  67                         break;
  68                 default:
  69                         if (*p < ' ')
  70                                 escape = 'u';
  71                         break;
  72                 }
  73
  74                 if (!escape)
  75                         continue;
  76
  77                 if (p > last)
  78                         blobmsg_puts(s, last, p - last);
  79                 last = p + 1;
  80                 buf[1] = escape;
  81
  82                 if (escape == 'u') {
  83                         sprintf(buf + 4, "%02x", (unsigned char) *p);
  84                         len = 4;
  85                 } else {
  86                         len = 2;
  87                 }
  88                 blobmsg_puts(s, buf, len);
  89         }
  90
  91         blobmsg_puts(s, last, end - last);
  92         blobmsg_puts(s, "\"", 1);
  93 }
  94
  95 static void blobmsg_format_json_list(struct strbuf *s, struct blob_attr *attr, int len, bool array);
  96
  97 static void blobmsg_format_element(struct strbuf *s, struct blob_attr *attr, bool array, bool head)
  98 {
  99         char buf[32];
 100         void *data;
 101         int len;
 102
 103         if (!array && blobmsg_name(attr)[0]) {
 104                 blobmsg_format_string(s, blobmsg_name(attr));
 105                 blobmsg_puts(s, ":", 1);
 106         }
 107         if (head) {
 108                 data = blob_data(attr);
 109                 len = blob_len(attr);
 110         } else {
 111                 data = blobmsg_data(attr);
 112                 len = blobmsg_data_len(attr);
 113         }
 114
 115         switch(blob_id(attr)) {
 116         case BLOBMSG_TYPE_INT8:
 117                 sprintf(buf, "%d", *(uint8_t *)data);
 118                 break;
 119         case BLOBMSG_TYPE_INT16:
 120                 sprintf(buf, "%d", *(uint16_t *)data);
 121                 break;
 122         case BLOBMSG_TYPE_INT32:
 123                 sprintf(buf, "%d", *(uint32_t *)data);
 124                 break;
 125         case BLOBMSG_TYPE_INT64:
 126                 sprintf(buf, "%lld", *(uint64_t *)data);
 127                 break;
 128         case BLOBMSG_TYPE_STRING:
 129                 blobmsg_format_string(s, data);
 130                 return;
 131         case BLOBMSG_TYPE_ARRAY:
 132                 blobmsg_format_json_list(s, data, len, true);
 133                 return;
 134         case BLOBMSG_TYPE_TABLE:
 135                 blobmsg_format_json_list(s, data, len, false);
 136                 return;
 137         }
 138         blobmsg_puts(s, buf, strlen(buf));
 139 }
 140
 141 static void blobmsg_format_json_list(struct strbuf *s, struct blob_attr *attr, int len, bool array)
 142 {
 143         struct blob_attr *pos;
 144         bool first = true;
 145         int rem = len;
 146
 147         blobmsg_puts(s, (array ? "[ " : "{ "), 2);
 148         __blob_for_each_attr(pos, attr, rem) {
 149                 if (!first)
 150                         blobmsg_puts(s, ", ", 2);
 151
 152                 blobmsg_format_element(s, pos, array, false);
 153                 first = false;
 154         }
 155         blobmsg_puts(s, (array ? " ]" : " }"), 2);
 156 }
 157
 158 char *blobmsg_format_json(struct blob_attr *attr, bool list)
 159 {
 160         struct strbuf s;
 161
 162         s.len = blob_len(attr);
 163         s.buf = malloc(s.len);
 164         s.pos = 0;
 165
 166         if (list)
 167                 blobmsg_format_json_list(&s, blob_data(attr), blob_len(attr), false);
 168         else
 169                 blobmsg_format_element(&s, attr, false, false);
 170
 171         if (!s.len)
 172                 return NULL;
 173
 174         s.buf = realloc(s.buf, s.pos + 1);
 175         return s.buf;
 176 }
 177
 178 static const int blob_type[__BLOBMSG_TYPE_LAST] = {
 179         [BLOBMSG_TYPE_INT8] = BLOB_ATTR_INT8,
 180         [BLOBMSG_TYPE_INT16] = BLOB_ATTR_INT16,
 181         [BLOBMSG_TYPE_INT32] = BLOB_ATTR_INT32,
 182         [BLOBMSG_TYPE_INT64] = BLOB_ATTR_INT64,
 183         [BLOBMSG_TYPE_STRING] = BLOB_ATTR_STRING,
 184 };
 185
 186 bool blobmsg_check_attr(const struct blob_attr *attr, bool name)
 187 {
 188         const struct blobmsg_hdr *hdr;
 189         const char *data;
 190         int id, len;
 191
 192         if (blob_len(attr) < sizeof(struct blobmsg_hdr))
 193                 return false;
 194
 195         hdr = (void *) attr->data;
 196         if (!hdr->namelen && name)
 197                 return false;
 198
 199         if (hdr->namelen > blob_len(attr) - sizeof(struct blobmsg_hdr))
 200                 return false;
 201
 202         if (hdr->name[hdr->namelen] != 0)
 203                 return false;
 204
 205         id = blob_id(attr);
 206         len = blobmsg_data_len(attr);
 207         data = blobmsg_data(attr);
 208
 209         if (!id || id > BLOBMSG_TYPE_LAST)
 210                 return false;
 211
 212         if (!blob_type[id])
 213                 return true;
 214
 215         return blob_check_type(data, len, blob_type[id]);
 216 }
 217
 218 int blobmsg_parse(const struct blobmsg_policy *policy, int policy_len,
 219                   struct blob_attr **tb, void *data, int len)
 220 {
 221         struct blobmsg_hdr *hdr;
 222         struct blob_attr *attr;
 223         uint8_t *pslen;
 224         int i;
 225
 226         memset(tb, 0, policy_len * sizeof(*tb));
 227         pslen = alloca(policy_len);
 228         for (i = 0; i < policy_len; i++) {
 229                 if (!policy[i].name)
 230                         continue;
 231
 232                 pslen[i] = strlen(policy[i].name);
 233         }
 234
 235         __blob_for_each_attr(attr, data, len) {
 236                 hdr = blob_data(attr);
 237                 for (i = 0; i < policy_len; i++) {
 238                         if (!policy[i].name)
 239                                 continue;
 240
 241                         if (policy[i].type != BLOBMSG_TYPE_UNSPEC &&
 242                             blob_id(attr) != policy[i].type)
 243                                 continue;
 244
 245                         if (hdr->namelen != pslen[i])
 246                                 continue;
 247
 248                         if (!blobmsg_check_attr(attr, true))
 249                                 return -1;
 250
 251                         if (tb[i])
 252                                 return -1;
 253
 254                         if (strcmp(policy[i].name, (char *) hdr->name) != 0)
 255                                 continue;
 256
 257                         tb[i] = attr;
 258                 }
 259         }
 260
 261         return 0;
 262 }
 263
 264
 265 static struct blob_attr *
 266 blobmsg_new(struct blob_buf *buf, int type, const char *name, int payload_len, void **data)
 267 {
 268         struct blob_attr *attr;
 269         struct blobmsg_hdr *hdr;
 270         int attrlen, namelen;
 271
 272         if (!name)
 273                 name = "";
 274
 275         namelen = strlen(name);
 276         attrlen = blobmsg_hdrlen(namelen) + payload_len;
 277         attr = blob_new(buf, type, attrlen);
 278         if (!attr)
 279                 return NULL;
 280
 281         hdr = blob_data(attr);
 282         hdr->namelen = namelen;
 283         strcpy((char *) hdr->name, (const char *)name);
 284         *data = blobmsg_data(attr);
 285
 286         return attr;
 287 }
 288
 289 static inline int
 290 attr_to_offset(struct blob_buf *buf, struct blob_attr *attr)
 291 {
 292         return (char *)attr - (char *) buf->buf;
 293 }
 294
 295
 296 void *
 297 blobmsg_open_nested(struct blob_buf *buf, const char *name, bool array)
 298 {
 299         struct blob_attr *head = buf->head;
 300         int type = array ? BLOBMSG_TYPE_ARRAY : BLOBMSG_TYPE_TABLE;
 301         unsigned long offset = attr_to_offset(buf, buf->head);
 302         void *data;
 303
 304         if (!name)
 305                 name = "";
 306
 307         head = blobmsg_new(buf, type, name, 0, &data);
 308         blob_set_raw_len(buf->head, blob_pad_len(buf->head) - blobmsg_hdrlen(strlen(name)));
 309         buf->head = head;
 310         return (void *)offset;
 311 }
 312
 313 int
 314 blobmsg_add_field(struct blob_buf *buf, int type, const char *name,
 315                   const void *data, int len)
 316 {
 317         struct blob_attr *attr;
 318         void *data_dest;
 319
 320         if (type == BLOBMSG_TYPE_ARRAY ||
 321             type == BLOBMSG_TYPE_TABLE)
 322                 return -1;
 323
 324         attr = blobmsg_new(buf, type, name, len, &data_dest);
 325         if (!attr)
 326                 return -1;
 327
 328         if (len > 0)
 329                 memcpy(data_dest, data, len);
 330
 331         return 0;
 332 }