blob: d2fab9020b3eaa32c9ea177f932b316d4b7c28de [file] [log] [blame]
Ed Warnickecb9cada2015-12-08 15:45:58 -07001/*
2 *------------------------------------------------------------------
3 * json_format.h
4 *
5 * Copyright (c) 2015 Cisco and/or its affiliates.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at:
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *------------------------------------------------------------------
18 */
19
20#ifndef __JSON_FORMAT_H__
21#define __JSON_FORMAT_H__
22
23#include <vppinfra/clib.h>
24#include <vppinfra/format.h>
25#include <netinet/ip.h>
26
27/* JSON value type */
Dave Barach72d72232016-08-04 10:15:08 -040028typedef enum
29{
30 VAT_JSON_NONE,
31 VAT_JSON_OBJECT,
32 VAT_JSON_ARRAY,
33 VAT_JSON_STRING,
34 VAT_JSON_REAL,
35 VAT_JSON_UINT,
36 VAT_JSON_INT,
37 VAT_JSON_IPV4,
38 VAT_JSON_IPV6,
39 VAT_JSON_MAX
Ed Warnickecb9cada2015-12-08 15:45:58 -070040} vat_json_val_type_t;
41
42typedef struct vat_json_node_s vat_json_node_t;
43typedef struct vat_json_pair_s vat_json_pair_t;
44
45/* JSON object structure */
Dave Barach72d72232016-08-04 10:15:08 -040046struct vat_json_node_s
47{
48 vat_json_val_type_t type;
49 union
50 {
51 vat_json_pair_t *pairs;
52 vat_json_node_t *array;
53 u8 *string;
54 struct in_addr ip4;
55 struct in6_addr ip6;
56 u64 uint;
57 i64 sint;
58 f64 real;
59 };
Ed Warnickecb9cada2015-12-08 15:45:58 -070060};
61
Dave Barach72d72232016-08-04 10:15:08 -040062struct vat_json_pair_s
63{
64 const char *name;
65 vat_json_node_t value;
Ed Warnickecb9cada2015-12-08 15:45:58 -070066};
67
Dave Barach72d72232016-08-04 10:15:08 -040068void vat_json_print (FILE * ofp, vat_json_node_t * node);
69void vat_json_free (vat_json_node_t * node);
Ed Warnickecb9cada2015-12-08 15:45:58 -070070
Dave Barach72d72232016-08-04 10:15:08 -040071static_always_inline void
72vat_json_init_object (vat_json_node_t * json)
Ed Warnickecb9cada2015-12-08 15:45:58 -070073{
Dave Barach72d72232016-08-04 10:15:08 -040074 json->type = VAT_JSON_OBJECT;
75 json->pairs = NULL;
Ed Warnickecb9cada2015-12-08 15:45:58 -070076}
77
Dave Barach72d72232016-08-04 10:15:08 -040078static_always_inline void
79vat_json_init_array (vat_json_node_t * json)
Ed Warnickecb9cada2015-12-08 15:45:58 -070080{
Dave Barach72d72232016-08-04 10:15:08 -040081 json->type = VAT_JSON_ARRAY;
82 json->array = NULL;
Ed Warnickecb9cada2015-12-08 15:45:58 -070083}
84
Dave Barach72d72232016-08-04 10:15:08 -040085static_always_inline void
86vat_json_set_string (vat_json_node_t * json, u8 * str)
Ed Warnickecb9cada2015-12-08 15:45:58 -070087{
Dave Barach72d72232016-08-04 10:15:08 -040088 json->type = VAT_JSON_STRING;
89 json->string = str;
Ed Warnickecb9cada2015-12-08 15:45:58 -070090}
91
Dave Barach72d72232016-08-04 10:15:08 -040092static_always_inline void
93vat_json_set_string_copy (vat_json_node_t * json, const u8 * str)
Ed Warnickecb9cada2015-12-08 15:45:58 -070094{
Dave Barach72d72232016-08-04 10:15:08 -040095 u8 *ns = NULL;
Dave Barach032a5e32020-04-06 10:19:18 -040096 int len = strlen ((const char *) str);
97 vec_validate (ns, len);
98 strncpy ((char *) ns, (const char *) str, len + 1);
Dave Barach72d72232016-08-04 10:15:08 -040099 vec_add1 (ns, '\0');
100 vat_json_set_string (json, ns);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700101}
102
Dave Barach72d72232016-08-04 10:15:08 -0400103static_always_inline void
104vat_json_set_int (vat_json_node_t * json, i64 num)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700105{
Dave Barach72d72232016-08-04 10:15:08 -0400106 json->type = VAT_JSON_INT;
107 json->sint = num;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700108}
109
Dave Barach72d72232016-08-04 10:15:08 -0400110static_always_inline void
111vat_json_set_uint (vat_json_node_t * json, u64 num)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700112{
Dave Barach72d72232016-08-04 10:15:08 -0400113 json->type = VAT_JSON_UINT;
114 json->uint = num;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700115}
116
Dave Barach72d72232016-08-04 10:15:08 -0400117static_always_inline void
118vat_json_set_real (vat_json_node_t * json, f64 real)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700119{
Dave Barach72d72232016-08-04 10:15:08 -0400120 json->type = VAT_JSON_REAL;
121 json->real = real;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700122}
123
Dave Barach72d72232016-08-04 10:15:08 -0400124static_always_inline void
125vat_json_set_ip4 (vat_json_node_t * json, struct in_addr ip4)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700126{
Dave Barach72d72232016-08-04 10:15:08 -0400127 json->type = VAT_JSON_IPV4;
128 json->ip4 = ip4;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700129}
130
Dave Barach72d72232016-08-04 10:15:08 -0400131static_always_inline void
132vat_json_set_ip6 (vat_json_node_t * json, struct in6_addr ip6)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700133{
Dave Barach72d72232016-08-04 10:15:08 -0400134 json->type = VAT_JSON_IPV6;
135 json->ip6 = ip6;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700136}
137
Dave Barach72d72232016-08-04 10:15:08 -0400138static_always_inline vat_json_node_t *
139vat_json_object_add (vat_json_node_t * json, const char *name)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700140{
Dave Barach72d72232016-08-04 10:15:08 -0400141 ASSERT (VAT_JSON_OBJECT == json->type);
142 uword pos = vec_len (json->pairs);
143 vec_validate (json->pairs, pos);
144 json->pairs[pos].name = name;
145 return &json->pairs[pos].value;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700146}
147
Dave Barach72d72232016-08-04 10:15:08 -0400148static_always_inline vat_json_node_t *
149vat_json_array_add (vat_json_node_t * json)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700150{
Dave Barach72d72232016-08-04 10:15:08 -0400151 ASSERT (VAT_JSON_ARRAY == json->type);
152 uword pos = vec_len (json->array);
153 vec_validate (json->array, pos);
154 return &json->array[pos];
Ed Warnickecb9cada2015-12-08 15:45:58 -0700155}
156
Dave Barach72d72232016-08-04 10:15:08 -0400157static_always_inline vat_json_node_t *
158vat_json_object_add_list (vat_json_node_t * json, const char *name)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700159{
Dave Barach72d72232016-08-04 10:15:08 -0400160 vat_json_node_t *array_node = vat_json_object_add (json, name);
161 vat_json_init_array (array_node);
162 return array_node;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700163}
164
Dave Barach72d72232016-08-04 10:15:08 -0400165static_always_inline void
166vat_json_object_add_string_copy (vat_json_node_t * json,
167 const char *name, u8 * str)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700168{
Dave Barach72d72232016-08-04 10:15:08 -0400169 vat_json_set_string_copy (vat_json_object_add (json, name), str);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700170}
171
Dave Barach72d72232016-08-04 10:15:08 -0400172static_always_inline void
173vat_json_object_add_uint (vat_json_node_t * json,
174 const char *name, u64 number)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700175{
Dave Barach72d72232016-08-04 10:15:08 -0400176 vat_json_set_uint (vat_json_object_add (json, name), number);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700177}
178
Dave Barach72d72232016-08-04 10:15:08 -0400179static_always_inline void
180vat_json_object_add_int (vat_json_node_t * json, const char *name, i64 number)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700181{
Dave Barach72d72232016-08-04 10:15:08 -0400182 vat_json_set_int (vat_json_object_add (json, name), number);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700183}
184
Dave Barach72d72232016-08-04 10:15:08 -0400185static_always_inline void
186vat_json_object_add_real (vat_json_node_t * json, const char *name, f64 real)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700187{
Dave Barach72d72232016-08-04 10:15:08 -0400188 vat_json_set_real (vat_json_object_add (json, name), real);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700189}
190
Dave Barach72d72232016-08-04 10:15:08 -0400191static_always_inline void
192vat_json_object_add_ip4 (vat_json_node_t * json,
193 const char *name, struct in_addr ip4)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700194{
Dave Barach72d72232016-08-04 10:15:08 -0400195 vat_json_set_ip4 (vat_json_object_add (json, name), ip4);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700196}
197
Dave Barach72d72232016-08-04 10:15:08 -0400198static_always_inline void
199vat_json_object_add_ip6 (vat_json_node_t * json,
200 const char *name, struct in6_addr ip6)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700201{
Dave Barach72d72232016-08-04 10:15:08 -0400202 vat_json_set_ip6 (vat_json_object_add (json, name), ip6);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700203}
204
Dave Barach72d72232016-08-04 10:15:08 -0400205static_always_inline void
206vat_json_array_add_int (vat_json_node_t * json, i64 number)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700207{
Dave Barach72d72232016-08-04 10:15:08 -0400208 vat_json_set_int (vat_json_array_add (json), number);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700209}
210
Dave Barach72d72232016-08-04 10:15:08 -0400211static_always_inline void
212vat_json_array_add_uint (vat_json_node_t * json, u64 number)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700213{
Dave Barach72d72232016-08-04 10:15:08 -0400214 vat_json_set_uint (vat_json_array_add (json), number);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700215}
216
Dave Barach72d72232016-08-04 10:15:08 -0400217static_always_inline void
218vat_json_object_add_bytes (vat_json_node_t * json,
219 const char *name, u8 * array, uword size)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700220{
Dave Barach72d72232016-08-04 10:15:08 -0400221 ASSERT (VAT_JSON_OBJECT == json->type);
222 vat_json_node_t *json_array = vat_json_object_add (json, name);
223 vat_json_init_array (json_array);
224 int i;
225 for (i = 0; i < size; i++)
226 {
227 vat_json_array_add_uint (json_array, array[i]);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700228 }
229}
230
Dave Barach72d72232016-08-04 10:15:08 -0400231static_always_inline vat_json_node_t *
232vat_json_object_get_element (vat_json_node_t * json, const char *name)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700233{
Dave Barach72d72232016-08-04 10:15:08 -0400234 int i = 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700235
Dave Barach72d72232016-08-04 10:15:08 -0400236 ASSERT (VAT_JSON_OBJECT == json->type);
237 for (i = 0; i < vec_len (json->pairs); i++)
238 {
239 if (0 == strcmp (json->pairs[i].name, name))
240 {
241 return &json->pairs[i].value;
242 }
Ed Warnickecb9cada2015-12-08 15:45:58 -0700243 }
Dave Barach72d72232016-08-04 10:15:08 -0400244 return NULL;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700245}
246
247#endif /* __JSON_FORMAT_H__ */
Dave Barach72d72232016-08-04 10:15:08 -0400248
249/*
250 * fd.io coding-style-patch-verification: ON
251 *
252 * Local Variables:
253 * eval: (c-set-style "gnu")
254 * End:
255 */