blob: 154fb3df04b574436ffaf5688f61ad7057f05418 [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;
96 vec_validate (ns, strlen ((const char *) str));
97 strcpy ((char *) ns, (const char *) str);
98 vec_add1 (ns, '\0');
99 vat_json_set_string (json, ns);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700100}
101
Dave Barach72d72232016-08-04 10:15:08 -0400102static_always_inline void
103vat_json_set_int (vat_json_node_t * json, i64 num)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700104{
Dave Barach72d72232016-08-04 10:15:08 -0400105 json->type = VAT_JSON_INT;
106 json->sint = num;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700107}
108
Dave Barach72d72232016-08-04 10:15:08 -0400109static_always_inline void
110vat_json_set_uint (vat_json_node_t * json, u64 num)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700111{
Dave Barach72d72232016-08-04 10:15:08 -0400112 json->type = VAT_JSON_UINT;
113 json->uint = num;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700114}
115
Dave Barach72d72232016-08-04 10:15:08 -0400116static_always_inline void
117vat_json_set_real (vat_json_node_t * json, f64 real)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700118{
Dave Barach72d72232016-08-04 10:15:08 -0400119 json->type = VAT_JSON_REAL;
120 json->real = real;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700121}
122
Dave Barach72d72232016-08-04 10:15:08 -0400123static_always_inline void
124vat_json_set_ip4 (vat_json_node_t * json, struct in_addr ip4)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700125{
Dave Barach72d72232016-08-04 10:15:08 -0400126 json->type = VAT_JSON_IPV4;
127 json->ip4 = ip4;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700128}
129
Dave Barach72d72232016-08-04 10:15:08 -0400130static_always_inline void
131vat_json_set_ip6 (vat_json_node_t * json, struct in6_addr ip6)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700132{
Dave Barach72d72232016-08-04 10:15:08 -0400133 json->type = VAT_JSON_IPV6;
134 json->ip6 = ip6;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700135}
136
Dave Barach72d72232016-08-04 10:15:08 -0400137static_always_inline vat_json_node_t *
138vat_json_object_add (vat_json_node_t * json, const char *name)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700139{
Dave Barach72d72232016-08-04 10:15:08 -0400140 ASSERT (VAT_JSON_OBJECT == json->type);
141 uword pos = vec_len (json->pairs);
142 vec_validate (json->pairs, pos);
143 json->pairs[pos].name = name;
144 return &json->pairs[pos].value;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700145}
146
Dave Barach72d72232016-08-04 10:15:08 -0400147static_always_inline vat_json_node_t *
148vat_json_array_add (vat_json_node_t * json)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700149{
Dave Barach72d72232016-08-04 10:15:08 -0400150 ASSERT (VAT_JSON_ARRAY == json->type);
151 uword pos = vec_len (json->array);
152 vec_validate (json->array, pos);
153 return &json->array[pos];
Ed Warnickecb9cada2015-12-08 15:45:58 -0700154}
155
Dave Barach72d72232016-08-04 10:15:08 -0400156static_always_inline vat_json_node_t *
157vat_json_object_add_list (vat_json_node_t * json, const char *name)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700158{
Dave Barach72d72232016-08-04 10:15:08 -0400159 vat_json_node_t *array_node = vat_json_object_add (json, name);
160 vat_json_init_array (array_node);
161 return array_node;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700162}
163
Dave Barach72d72232016-08-04 10:15:08 -0400164static_always_inline void
165vat_json_object_add_string_copy (vat_json_node_t * json,
166 const char *name, u8 * str)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700167{
Dave Barach72d72232016-08-04 10:15:08 -0400168 vat_json_set_string_copy (vat_json_object_add (json, name), str);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700169}
170
Dave Barach72d72232016-08-04 10:15:08 -0400171static_always_inline void
172vat_json_object_add_uint (vat_json_node_t * json,
173 const char *name, u64 number)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700174{
Dave Barach72d72232016-08-04 10:15:08 -0400175 vat_json_set_uint (vat_json_object_add (json, name), number);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700176}
177
Dave Barach72d72232016-08-04 10:15:08 -0400178static_always_inline void
179vat_json_object_add_int (vat_json_node_t * json, const char *name, i64 number)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700180{
Dave Barach72d72232016-08-04 10:15:08 -0400181 vat_json_set_int (vat_json_object_add (json, name), number);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700182}
183
Dave Barach72d72232016-08-04 10:15:08 -0400184static_always_inline void
185vat_json_object_add_real (vat_json_node_t * json, const char *name, f64 real)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700186{
Dave Barach72d72232016-08-04 10:15:08 -0400187 vat_json_set_real (vat_json_object_add (json, name), real);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700188}
189
Dave Barach72d72232016-08-04 10:15:08 -0400190static_always_inline void
191vat_json_object_add_ip4 (vat_json_node_t * json,
192 const char *name, struct in_addr ip4)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700193{
Dave Barach72d72232016-08-04 10:15:08 -0400194 vat_json_set_ip4 (vat_json_object_add (json, name), ip4);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700195}
196
Dave Barach72d72232016-08-04 10:15:08 -0400197static_always_inline void
198vat_json_object_add_ip6 (vat_json_node_t * json,
199 const char *name, struct in6_addr ip6)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700200{
Dave Barach72d72232016-08-04 10:15:08 -0400201 vat_json_set_ip6 (vat_json_object_add (json, name), ip6);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700202}
203
Dave Barach72d72232016-08-04 10:15:08 -0400204static_always_inline void
205vat_json_array_add_int (vat_json_node_t * json, i64 number)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700206{
Dave Barach72d72232016-08-04 10:15:08 -0400207 vat_json_set_int (vat_json_array_add (json), number);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700208}
209
Dave Barach72d72232016-08-04 10:15:08 -0400210static_always_inline void
211vat_json_array_add_uint (vat_json_node_t * json, u64 number)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700212{
Dave Barach72d72232016-08-04 10:15:08 -0400213 vat_json_set_uint (vat_json_array_add (json), number);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700214}
215
Dave Barach72d72232016-08-04 10:15:08 -0400216static_always_inline void
217vat_json_object_add_bytes (vat_json_node_t * json,
218 const char *name, u8 * array, uword size)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700219{
Dave Barach72d72232016-08-04 10:15:08 -0400220 ASSERT (VAT_JSON_OBJECT == json->type);
221 vat_json_node_t *json_array = vat_json_object_add (json, name);
222 vat_json_init_array (json_array);
223 int i;
224 for (i = 0; i < size; i++)
225 {
226 vat_json_array_add_uint (json_array, array[i]);
Ed Warnickecb9cada2015-12-08 15:45:58 -0700227 }
228}
229
Dave Barach72d72232016-08-04 10:15:08 -0400230static_always_inline vat_json_node_t *
231vat_json_object_get_element (vat_json_node_t * json, const char *name)
Ed Warnickecb9cada2015-12-08 15:45:58 -0700232{
Dave Barach72d72232016-08-04 10:15:08 -0400233 int i = 0;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700234
Dave Barach72d72232016-08-04 10:15:08 -0400235 ASSERT (VAT_JSON_OBJECT == json->type);
236 for (i = 0; i < vec_len (json->pairs); i++)
237 {
238 if (0 == strcmp (json->pairs[i].name, name))
239 {
240 return &json->pairs[i].value;
241 }
Ed Warnickecb9cada2015-12-08 15:45:58 -0700242 }
Dave Barach72d72232016-08-04 10:15:08 -0400243 return NULL;
Ed Warnickecb9cada2015-12-08 15:45:58 -0700244}
245
246#endif /* __JSON_FORMAT_H__ */
Dave Barach72d72232016-08-04 10:15:08 -0400247
248/*
249 * fd.io coding-style-patch-verification: ON
250 *
251 * Local Variables:
252 * eval: (c-set-style "gnu")
253 * End:
254 */