sh/jshn.sh: add json_for_each_item()
[project/libubox.git] / blobmsg.h
index 7c63dbf..7977298 100644 (file)
--- a/blobmsg.h
+++ b/blobmsg.h
@@ -1,21 +1,22 @@
 /*
- * blobmsg - library for generating/parsing structured blob messages
+ * Copyright (C) 2010-2012 Felix Fietkau <nbd@openwrt.org>
  *
- * Copyright (C) 2010 Felix Fietkau <nbd@openwrt.org>
+ * Permission to use, copy, modify, and/or distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License version 2.1
- * as published by the Free Software Foundation
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
-
 #ifndef __BLOBMSG_H
 #define __BLOBMSG_H
 
+#include <stdarg.h>
 #include "blob.h"
 
 #define BLOBMSG_ALIGN  2
@@ -30,8 +31,10 @@ enum blobmsg_type {
        BLOBMSG_TYPE_INT32,
        BLOBMSG_TYPE_INT16,
        BLOBMSG_TYPE_INT8,
+       BLOBMSG_TYPE_DOUBLE,
        __BLOBMSG_TYPE_LAST,
-       BLOBMSG_TYPE_LAST = __BLOBMSG_TYPE_LAST - 1
+       BLOBMSG_TYPE_LAST = __BLOBMSG_TYPE_LAST - 1,
+       BLOBMSG_TYPE_BOOL = BLOBMSG_TYPE_INT8,
 };
 
 struct blobmsg_hdr {
@@ -44,39 +47,84 @@ struct blobmsg_policy {
        enum blobmsg_type type;
 };
 
-static inline int blobmsg_hdrlen(int namelen)
+static inline int blobmsg_hdrlen(unsigned int namelen)
 {
        return BLOBMSG_PADDING(sizeof(struct blobmsg_hdr) + namelen + 1);
 }
 
-static inline char *blobmsg_name(struct blob_attr *attr)
+static inline void blobmsg_clear_name(struct blob_attr *attr)
 {
-       struct blobmsg_hdr *hdr = blob_data(attr);
-       return (char *) hdr->name;
+       struct blobmsg_hdr *hdr = (struct blobmsg_hdr *) blob_data(attr);
+       hdr->name[0] = 0;
 }
 
-static inline void *blobmsg_data(struct blob_attr *attr)
+static inline const char *blobmsg_name(const struct blob_attr *attr)
 {
-       struct blobmsg_hdr *hdr = blob_data(attr);
-       return (char *) hdr + blobmsg_hdrlen(hdr->namelen);
+       struct blobmsg_hdr *hdr = (struct blobmsg_hdr *) blob_data(attr);
+       return (const char *) hdr->name;
 }
 
-static inline int blobmsg_data_len(struct blob_attr *attr)
+static inline int blobmsg_type(const struct blob_attr *attr)
+{
+       return blob_id(attr);
+}
+
+static inline void *blobmsg_data(const struct blob_attr *attr)
+{
+       struct blobmsg_hdr *hdr = (struct blobmsg_hdr *) blob_data(attr);
+       char *data = (char *) blob_data(attr);
+
+       if (blob_is_extended(attr))
+               data += blobmsg_hdrlen(be16_to_cpu(hdr->namelen));
+
+       return data;
+}
+
+static inline int blobmsg_data_len(const struct blob_attr *attr)
 {
        uint8_t *start, *end;
 
-       start = blob_data(attr);
-       end = blobmsg_data(attr);
+       start = (uint8_t *) blob_data(attr);
+       end = (uint8_t *) blobmsg_data(attr);
 
        return blob_len(attr) - (end - start);
 }
 
+static inline int blobmsg_len(const struct blob_attr *attr)
+{
+       return blobmsg_data_len(attr);
+}
+
 bool blobmsg_check_attr(const struct blob_attr *attr, bool name);
+bool blobmsg_check_attr_list(const struct blob_attr *attr, int type);
+
+/*
+ * blobmsg_check_array: validate array/table and return size
+ *
+ * Checks if all elements of an array or table are valid and have
+ * the specified type. Returns the number of elements in the array
+ */
+int blobmsg_check_array(const struct blob_attr *attr, int type);
+
 int blobmsg_parse(const struct blobmsg_policy *policy, int policy_len,
-                  struct blob_attr **tb, void *data, int len);
+                  struct blob_attr **tb, void *data, unsigned int len);
+int blobmsg_parse_array(const struct blobmsg_policy *policy, int policy_len,
+                       struct blob_attr **tb, void *data, unsigned int len);
 
 int blobmsg_add_field(struct blob_buf *buf, int type, const char *name,
-                      const void *data, int len);
+                      const void *data, unsigned int len);
+
+static inline int
+blobmsg_add_double(struct blob_buf *buf, const char *name, double val)
+{
+       union {
+               double d;
+               uint64_t u64;
+       } v;
+       v.d = val;
+       v.u64 = cpu_to_be64(v.u64);
+       return blobmsg_add_field(buf, BLOBMSG_TYPE_DOUBLE, name, &v.u64, 8);
+}
 
 static inline int
 blobmsg_add_u8(struct blob_buf *buf, const char *name, uint8_t val)
@@ -87,18 +135,21 @@ blobmsg_add_u8(struct blob_buf *buf, const char *name, uint8_t val)
 static inline int
 blobmsg_add_u16(struct blob_buf *buf, const char *name, uint16_t val)
 {
+       val = cpu_to_be16(val);
        return blobmsg_add_field(buf, BLOBMSG_TYPE_INT16, name, &val, 2);
 }
 
 static inline int
 blobmsg_add_u32(struct blob_buf *buf, const char *name, uint32_t val)
 {
+       val = cpu_to_be32(val);
        return blobmsg_add_field(buf, BLOBMSG_TYPE_INT32, name, &val, 4);
 }
 
 static inline int
 blobmsg_add_u64(struct blob_buf *buf, const char *name, uint64_t val)
 {
+       val = cpu_to_be64(val);
        return blobmsg_add_field(buf, BLOBMSG_TYPE_INT64, name, &val, 8);
 }
 
@@ -108,6 +159,13 @@ blobmsg_add_string(struct blob_buf *buf, const char *name, const char *string)
        return blobmsg_add_field(buf, BLOBMSG_TYPE_STRING, name, string, strlen(string) + 1);
 }
 
+static inline int
+blobmsg_add_blob(struct blob_buf *buf, struct blob_attr *attr)
+{
+       return blobmsg_add_field(buf, blobmsg_type(attr), blobmsg_name(attr),
+                                blobmsg_data(attr), blobmsg_data_len(attr));
+}
+
 void *blobmsg_open_nested(struct blob_buf *buf, const char *name, bool array);
 
 static inline void *
@@ -139,12 +197,68 @@ static inline int blobmsg_buf_init(struct blob_buf *buf)
        return blob_buf_init(buf, BLOBMSG_TYPE_TABLE);
 }
 
-char *blobmsg_format_json(struct blob_attr *attr, bool list);
+static inline uint8_t blobmsg_get_u8(struct blob_attr *attr)
+{
+       return *(uint8_t *) blobmsg_data(attr);
+}
+
+static inline bool blobmsg_get_bool(struct blob_attr *attr)
+{
+       return *(uint8_t *) blobmsg_data(attr);
+}
+
+static inline uint16_t blobmsg_get_u16(struct blob_attr *attr)
+{
+       return be16_to_cpu(*(uint16_t *) blobmsg_data(attr));
+}
+
+static inline uint32_t blobmsg_get_u32(struct blob_attr *attr)
+{
+       return be32_to_cpu(*(uint32_t *) blobmsg_data(attr));
+}
+
+static inline uint64_t blobmsg_get_u64(struct blob_attr *attr)
+{
+       uint32_t *ptr = (uint32_t *) blobmsg_data(attr);
+       uint64_t tmp = ((uint64_t) be32_to_cpu(ptr[0])) << 32;
+       tmp |= be32_to_cpu(ptr[1]);
+       return tmp;
+}
+
+static inline double blobmsg_get_double(struct blob_attr *attr)
+{
+       union {
+               double d;
+               uint64_t u64;
+       } v;
+       v.u64 = blobmsg_get_u64(attr);
+       return v.d;
+}
+
+static inline char *blobmsg_get_string(struct blob_attr *attr)
+{
+       if (!attr)
+               return NULL;
+
+       return (char *) blobmsg_data(attr);
+}
+
+void *blobmsg_alloc_string_buffer(struct blob_buf *buf, const char *name, unsigned int maxlen);
+void *blobmsg_realloc_string_buffer(struct blob_buf *buf, unsigned int maxlen);
+void blobmsg_add_string_buffer(struct blob_buf *buf);
+
+int blobmsg_vprintf(struct blob_buf *buf, const char *name, const char *format, va_list arg);
+int blobmsg_printf(struct blob_buf *buf, const char *name, const char *format, ...)
+     __attribute__((format(printf, 3, 4)));
+
+
+/* blobmsg to json formatting */
 
 #define blobmsg_for_each_attr(pos, attr, rem) \
-       for (rem = blobmsg_data_len(attr), pos = blobmsg_data(attr); \
-                (blob_pad_len(pos) <= rem) && \
-                (blob_pad_len(pos) >= sizeof(struct blob_attr)); \
-                rem -= blob_pad_len(pos), pos = blob_next(pos))
+       for (rem = attr ? blobmsg_data_len(attr) : 0, \
+            pos = (struct blob_attr *) (attr ? blobmsg_data(attr) : NULL); \
+            rem > 0 && (blob_pad_len(pos) <= rem) && \
+            (blob_pad_len(pos) >= sizeof(struct blob_attr)); \
+            rem -= blob_pad_len(pos), pos = blob_next(pos))
 
 #endif