blob.c

   1 /*
   2  * blob - library for generating/parsing tagged binary data
   3  *
   4  * Copyright (C) 2010 Felix Fietkau <nbd@openwrt.org>
   5  *
   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.
   9  *
  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.
  17  */
  18
  19 #include "blob.h"
  20
  21 static bool
  22 blob_buffer_grow(struct blob_buf *buf, int minlen)
  23 {
  24         int delta = ((minlen / 256) + 1) * 256;
  25         buf->buflen += delta;
  26         buf->buf = realloc(buf->buf, buf->buflen);
  27         if (buf->buf)
  28                 memset(buf->buf + buf->buflen - delta, 0, delta);
  29         return !!buf->buf;
  30 }
  31
  32 static void
  33 blob_init(struct blob_attr *attr, int id, unsigned int len)
  34 {
  35         len &= BLOB_ATTR_LEN_MASK;
  36         len |= (id << BLOB_ATTR_ID_SHIFT) & BLOB_ATTR_ID_MASK;
  37         attr->id_len = cpu_to_be32(len);
  38 }
  39
  40 static inline struct blob_attr *
  41 offset_to_attr(struct blob_buf *buf, int offset)
  42 {
  43         void *ptr = (char *)buf->buf + offset - BLOB_COOKIE;
  44         return ptr;
  45 }
  46
  47 static inline int
  48 attr_to_offset(struct blob_buf *buf, struct blob_attr *attr)
  49 {
  50         return (char *)attr - (char *) buf->buf + BLOB_COOKIE;
  51 }
  52
  53 void
  54 blob_buf_grow(struct blob_buf *buf, int required)
  55 {
  56         int offset_head = attr_to_offset(buf, buf->head);
  57
  58         if (!buf->grow || !buf->grow(buf, required))
  59                 return;
  60
  61         buf->head = offset_to_attr(buf, offset_head);
  62 }
  63
  64 static struct blob_attr *
  65 blob_add(struct blob_buf *buf, struct blob_attr *pos, int id, int payload)
  66 {
  67         int offset = attr_to_offset(buf, pos);
  68         int required = (offset - BLOB_COOKIE + sizeof(struct blob_attr) + payload) - buf->buflen;
  69         struct blob_attr *attr;
  70
  71         if (required > 0) {
  72                 blob_buf_grow(buf, required);
  73                 attr = offset_to_attr(buf, offset);
  74         } else {
  75                 attr = pos;
  76         }
  77
  78         blob_init(attr, id, payload + sizeof(struct blob_attr));
  79         blob_fill_pad(attr);
  80         return attr;
  81 }
  82
  83 int
  84 blob_buf_init(struct blob_buf *buf, int id)
  85 {
  86         if (!buf->grow)
  87                 buf->grow = blob_buffer_grow;
  88
  89         buf->head = buf->buf;
  90         if (blob_add(buf, buf->buf, id, 0) == NULL)
  91                 return -ENOMEM;
  92
  93         return 0;
  94 }
  95
  96 void
  97 blob_buf_free(struct blob_buf *buf)
  98 {
  99         free(buf->buf);
 100         buf->buf = NULL;
 101         buf->buflen = 0;
 102 }
 103
 104 void
 105 blob_fill_pad(struct blob_attr *attr)
 106 {
 107         char *buf = (char *) attr;
 108         int len = blob_pad_len(attr);
 109         int delta = len - blob_raw_len(attr);
 110
 111         if (delta > 0)
 112                 memset(buf + len - delta, 0, delta);
 113 }
 114
 115 void
 116 blob_set_raw_len(struct blob_attr *attr, unsigned int len)
 117 {
 118         len &= BLOB_ATTR_LEN_MASK;
 119         attr->id_len &= ~cpu_to_be32(BLOB_ATTR_LEN_MASK);
 120         attr->id_len |= cpu_to_be32(len);
 121 }
 122
 123 struct blob_attr *
 124 blob_new(struct blob_buf *buf, int id, int payload)
 125 {
 126         struct blob_attr *attr;
 127
 128         attr = blob_add(buf, blob_next(buf->head), id, payload);
 129         if (!attr)
 130                 return NULL;
 131
 132         blob_set_raw_len(buf->head, blob_pad_len(buf->head) + blob_pad_len(attr));
 133         return attr;
 134 }
 135
 136 struct blob_attr *
 137 blob_put_raw(struct blob_buf *buf, const void *ptr, unsigned int len)
 138 {
 139         struct blob_attr *attr;
 140
 141         if (len < sizeof(struct blob_attr) || !ptr)
 142                 return NULL;
 143
 144         attr = blob_add(buf, blob_next(buf->head), 0, len - sizeof(struct blob_attr));
 145         blob_set_raw_len(buf->head, blob_pad_len(buf->head) + len);
 146         memcpy(attr, ptr, len);
 147         return attr;
 148 }
 149
 150 struct blob_attr *
 151 blob_put(struct blob_buf *buf, int id, const void *ptr, unsigned int len)
 152 {
 153         struct blob_attr *attr;
 154
 155         attr = blob_new(buf, id, len);
 156         if (!attr)
 157                 return NULL;
 158
 159         if (ptr)
 160                 memcpy(blob_data(attr), ptr, len);
 161         return attr;
 162 }
 163
 164 void *
 165 blob_nest_start(struct blob_buf *buf, int id)
 166 {
 167         unsigned long offset = attr_to_offset(buf, buf->head);
 168         buf->head = blob_new(buf, id, 0);
 169         return (void *) offset;
 170 }
 171
 172 void
 173 blob_nest_end(struct blob_buf *buf, void *cookie)
 174 {
 175         struct blob_attr *attr = offset_to_attr(buf, (unsigned long) cookie);
 176         blob_set_raw_len(attr, blob_pad_len(attr) + blob_len(buf->head));
 177         buf->head = attr;
 178 }
 179
 180 static const int blob_type_minlen[BLOB_ATTR_LAST] = {
 181         [BLOB_ATTR_STRING] = 1,
 182         [BLOB_ATTR_INT8] = sizeof(uint8_t),
 183         [BLOB_ATTR_INT16] = sizeof(uint16_t),
 184         [BLOB_ATTR_INT32] = sizeof(uint32_t),
 185         [BLOB_ATTR_INT64] = sizeof(uint64_t),
 186 };
 187
 188 bool
 189 blob_check_type(const void *ptr, unsigned int len, int type)
 190 {
 191         const char *data = ptr;
 192
 193         if (type >= BLOB_ATTR_LAST)
 194                 return false;
 195
 196         if (type >= BLOB_ATTR_INT8 && type <= BLOB_ATTR_INT64) {
 197                 if (len != blob_type_minlen[type])
 198                         return false;
 199         } else {
 200                 if (len < blob_type_minlen[type])
 201                         return false;
 202         }
 203
 204         if (type == BLOB_ATTR_STRING && data[len - 1] != 0)
 205                 return false;
 206
 207         return true;
 208 }
 209
 210 int
 211 blob_parse(struct blob_attr *attr, struct blob_attr **data, const struct blob_attr_info *info, int max)
 212 {
 213         struct blob_attr *pos;
 214         int found = 0;
 215         int rem;
 216
 217         memset(data, 0, sizeof(struct blob_attr *) * max);
 218         blob_for_each_attr(pos, attr, rem) {
 219                 int id = blob_id(pos);
 220                 int len = blob_len(pos);
 221
 222                 if (id >= max)
 223                         continue;
 224
 225                 if (info) {
 226                         int type = info[id].type;
 227
 228                         if (type < BLOB_ATTR_LAST) {
 229                                 if (!blob_check_type(blob_data(pos), len, type))
 230                                         continue;
 231                         }
 232
 233                         if (info[id].minlen && len < info[id].minlen)
 234                                 continue;
 235
 236                         if (info[id].maxlen && len > info[id].maxlen)
 237                                 continue;
 238
 239                         if (info[id].validate && !info[id].validate(&info[id], pos))
 240                                 continue;
 241                 }
 242
 243                 if (!data[id])
 244                         found++;
 245
 246                 data[id] = pos;
 247         }
 248         return found;
 249 }
 250
 251 bool
 252 blob_attr_equal(const struct blob_attr *a1, const struct blob_attr *a2)
 253 {
 254         if (!a1 && !a2)
 255                 return true;
 256
 257         if (!a1 || !a2)
 258                 return false;
 259
 260         if (blob_pad_len(a1) != blob_pad_len(a2))
 261                 return false;
 262
 263         return !memcmp(a1, a2, blob_pad_len(a1));
 264 }
 265
 266 struct blob_attr *
 267 blob_memdup(struct blob_attr *attr)
 268 {
 269         struct blob_attr *ret;
 270         int size = blob_pad_len(attr);
 271
 272         ret = malloc(size);
 273         if (!ret)
 274                 return NULL;
 275
 276         memcpy(ret, attr, size);
 277         return ret;
 278 }