aboutsummaryrefslogtreecommitdiffstats
path: root/src/vat/json_format.h
blob: 154fb3df04b574436ffaf5688f61ad7057f05418 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
/*
 *------------------------------------------------------------------
 * json_format.h
 *
 * Copyright (c) 2015 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *------------------------------------------------------------------
 */

#ifndef __JSON_FORMAT_H__
#define __JSON_FORMAT_H__

#include <vppinfra/clib.h>
#include <vppinfra/format.h>
#include <netinet/ip.h>

/* JSON value type */
typedef enum
{
  VAT_JSON_NONE,
  VAT_JSON_OBJECT,
  VAT_JSON_ARRAY,
  VAT_JSON_STRING,
  VAT_JSON_REAL,
  VAT_JSON_UINT,
  VAT_JSON_INT,
  VAT_JSON_IPV4,
  VAT_JSON_IPV6,
  VAT_JSON_MAX
} vat_json_val_type_t;

typedef struct vat_json_node_s vat_json_node_t;
typedef struct vat_json_pair_s vat_json_pair_t;

/* JSON object structure */
struct vat_json_node_s
{
  vat_json_val_type_t type;
  union
  {
    vat_json_pair_t *pairs;
    vat_json_node_t *array;
    u8 *string;
    struct in_addr ip4;
    struct in6_addr ip6;
    u64 uint;
    i64 sint;
    f64 real;
  };
};

struct vat_json_pair_s
{
  const char *name;
  vat_json_node_t value;
};

void vat_json_print (FILE * ofp, vat_json_node_t * node);
void vat_json_free (vat_json_node_t * node);

static_always_inline void
vat_json_init_object (vat_json_node_t * json)
{
  json->type = VAT_JSON_OBJECT;
  json->pairs = NULL;
}

static_always_inline void
vat_json_init_array (vat_json_node_t * json)
{
  json->type = VAT_JSON_ARRAY;
  json->array = NULL;
}

static_always_inline void
vat_json_set_string (vat_json_node_t * json, u8 * str)
{
  json->type = VAT_JSON_STRING;
  json->string = str;
}

static_always_inline void
vat_json_set_string_copy (vat_json_node_t * json, const u8 * str)
{
  u8 *ns = NULL;
  vec_validate (ns, strlen ((const char *) str));
  strcpy ((char *) ns, (const char *) str);
  vec_add1 (ns, '\0');
  vat_json_set_string (json, ns);
}

static_always_inline void
vat_json_set_int (vat_json_node_t * json, i64 num)
{
  json->type = VAT_JSON_INT;
  json->sint = num;
}

static_always_inline void
vat_json_set_uint (vat_json_node_t * json, u64 num)
{
  json->type = VAT_JSON_UINT;
  json->uint = num;
}

static_always_inline void
vat_json_set_real (vat_json_node_t * json, f64 real)
{
  json->type = VAT_JSON_REAL;
  json->real = real;
}

static_always_inline void
vat_json_set_ip4 (vat_json_node_t * json, struct in_addr ip4)
{
  json->type = VAT_JSON_IPV4;
  json->ip4 = ip4;
}

static_always_inline void
vat_json_set_ip6 (vat_json_node_t * json, struct in6_addr ip6)
{
  json->type = VAT_JSON_IPV6;
  json->ip6 = ip6;
}

static_always_inline vat_json_node_t *
vat_json_object_add (vat_json_node_t * json, const char *name)
{
  ASSERT (VAT_JSON_OBJECT == json->type);
  uword pos = vec_len (json->pairs);
  vec_validate (json->pairs, pos);
  json->pairs[pos].name = name;
  return &json->pairs[pos].value;
}

static_always_inline vat_json_node_t *
vat_json_array_add (vat_json_node_t * json)
{
  ASSERT (VAT_JSON_ARRAY == json->type);
  uword pos = vec_len (json->array);
  vec_validate (json->array, pos);
  return &json->array[pos];
}

static_always_inline vat_json_node_t *
vat_json_object_add_list (vat_json_node_t * json, const char *name)
{
  vat_json_node_t *array_node = vat_json_object_add (json, name);
  vat_json_init_array (array_node);
  return array_node;
}

static_always_inline void
vat_json_object_add_string_copy (vat_json_node_t * json,
				 const char *name, u8 * str)
{
  vat_json_set_string_copy (vat_json_object_add (json, name), str);
}

static_always_inline void
vat_json_object_add_uint (vat_json_node_t * json,
			  const char *name, u64 number)
{
  vat_json_set_uint (vat_json_object_add (json, name), number);
}

static_always_inline void
vat_json_object_add_int (vat_json_node_t * json, const char *name, i64 number)
{
  vat_json_set_int (vat_json_object_add (json, name), number);
}

static_always_inline void
vat_json_object_add_real (vat_json_node_t * json, const char *name, f64 real)
{
  vat_json_set_real (vat_json_object_add (json, name), real);
}

static_always_inline void
vat_json_object_add_ip4 (vat_json_node_t * json,
			 const char *name, struct in_addr ip4)
{
  vat_json_set_ip4 (vat_json_object_add (json, name), ip4);
}

static_always_inline void
vat_json_object_add_ip6 (vat_json_node_t * json,
			 const char *name, struct in6_addr ip6)
{
  vat_json_set_ip6 (vat_json_object_add (json, name), ip6);
}

static_always_inline void
vat_json_array_add_int (vat_json_node_t * json, i64 number)
{
  vat_json_set_int (vat_json_array_add (json), number);
}

static_always_inline void
vat_json_array_add_uint (vat_json_node_t * json, u64 number)
{
  vat_json_set_uint (vat_json_array_add (json), number);
}

static_always_inline void
vat_json_object_add_bytes (vat_json_node_t * json,
			   const char *name, u8 * array, uword size)
{
  ASSERT (VAT_JSON_OBJECT == json->type);
  vat_json_node_t *json_array = vat_json_object_add (json, name);
  vat_json_init_array (json_array);
  int i;
  for (i = 0; i < size; i++)
    {
      vat_json_array_add_uint (json_array, array[i]);
    }
}

static_always_inline vat_json_node_t *
vat_json_object_get_element (vat_json_node_t * json, const char *name)
{
  int i = 0;

  ASSERT (VAT_JSON_OBJECT == json->type);
  for (i = 0; i < vec_len (json->pairs); i++)
    {
      if (0 == strcmp (json->pairs[i].name, name))
	{
	  return &json->pairs[i].value;
	}
    }
  return NULL;
}

#endif /* __JSON_FORMAT_H__ */

/*
 * fd.io coding-style-patch-verification: ON
 *
 * Local Variables:
 * eval: (c-set-style "gnu")
 * End:
 */
>e in entries] @classmethod def garp_req(cls, host): return cls.arp_req(host, host) @classmethod def garp_reqs(cls, entries): return [cls.garp_req(e) for e in entries] def arp_resp_host(self, src_host, arp_resp): ether = arp_resp[Ether] self.assertEqual(ether.dst, src_host.mac) arp = arp_resp[ARP] self.assertEqual(arp.hwtype, 1) self.assertEqual(arp.ptype, 0x800) self.assertEqual(arp.hwlen, 6) self.assertEqual(arp.plen, 4) arp_opts = {"who-has": 1, "is-at": 2} self.assertEqual(arp.op, arp_opts["is-at"]) self.assertEqual(arp.hwdst, src_host.mac) self.assertEqual(arp.pdst, src_host.ip4) return Host(mac=arp.hwsrc, ip4=arp.psrc) def arp_resp_hosts(self, src_host, pkts): return {self.arp_resp_host(src_host, p) for p in pkts} @staticmethod def inttoip4(ip): o1 = int(ip / 16777216) % 256 o2 = int(ip / 65536) % 256 o3 = int(ip / 256) % 256 o4 = int(ip) % 256 return '%s.%s.%s.%s' % (o1, o2, o3, o4) def arp_event_host(self, e): return Host(mac=':'.join(['%02x' % ord(char) for char in e.new_mac]), ip4=self.inttoip4(e.address)) def arp_event_hosts(self, evs): return {self.arp_event_host(e) for e in evs} def nd_event_host(self, e): return Host(mac=':'.join(['%02x' % ord(char) for char in e.new_mac]), ip6=inet_ntop(AF_INET6, e.address)) def nd_event_hosts(self, evs): return {self.nd_event_host(e) for e in evs} @classmethod def ns_req(cls, src_host, host): nsma = in6_getnsma(inet_pton(AF_INET6, "fd10::ffff")) d = inet_ntop(AF_INET6, nsma) return (Ether(dst="ff:ff:ff:ff:ff:ff", src=src_host.mac) / IPv6(dst=d, src=src_host.ip6) / ICMPv6ND_NS(tgt=host.ip6) / ICMPv6NDOptSrcLLAddr(lladdr=src_host.mac)) @classmethod def ns_reqs_dst(cls, entries, dst_host): return [cls.ns_req(e, dst_host) for e in entries] @classmethod def ns_reqs_src(cls, src_host, entries): return [cls.ns_req(src_host, e) for e in entries] def na_resp_host(self, src_host, rx): self.assertEqual(rx[Ether].dst, src_host.mac) self.assertEqual(in6_ptop(rx[IPv6].dst), in6_ptop(src_host.ip6)) self.assertTrue(rx.haslayer(ICMPv6ND_NA)) self.assertTrue(rx.haslayer(ICMPv6NDOptDstLLAddr)) na = rx[ICMPv6ND_NA] return Host(mac=na.lladdr, ip6=na.tgt) def na_resp_hosts(self, src_host, pkts): return {self.na_resp_host(src_host, p) for p in pkts} def set_bd_flags(self, bd_id, **args): """ Enable/disable defined feature(s) of the bridge domain. :param int bd_id: Bridge domain ID. :param list args: List of feature/status pairs. Allowed features: \ learn, forward, flood, uu_flood and arp_term. Status False means \ disable, status True means enable the feature. :raise: ValueError in case of unknown feature in the input. """ for flag in args: if flag == "learn": feature_bitmap = 1 << 0 elif flag == "forward": feature_bitmap = 1 << 1 elif flag == "flood": feature_bitmap = 1 << 2 elif flag == "uu_flood": feature_bitmap = 1 << 3 elif flag == "arp_term": feature_bitmap = 1 << 4 else: raise ValueError("Unknown feature used: %s" % flag) is_set = 1 if args[flag] else 0 self.vapi.bridge_flags(bd_id, is_set, feature_bitmap) self.logger.info("Bridge domain ID %d updated" % bd_id) def verify_arp(self, src_host, req_hosts, resp_hosts, bd_id=1): reqs = self.arp_reqs(src_host, req_hosts) for swif in self.bd_swifs(bd_id): swif.add_stream(reqs) self.pg_enable_capture(self.pg_interfaces) self.pg_start() for swif in self.bd_swifs(bd_id): resp_pkts = swif.get_capture(len(resp_hosts)) resps = self.arp_resp_hosts(src_host, resp_pkts) self.assertEqual(len(resps ^ resp_hosts), 0) def verify_nd(self, src_host, req_hosts, resp_hosts, bd_id=1): reqs = self.ns_reqs_src(src_host, req_hosts) for swif in self.bd_swifs(bd_id): swif.add_stream(reqs) self.pg_enable_capture(self.pg_interfaces) self.pg_start() for swif in self.bd_swifs(bd_id): resp_pkts = swif.get_capture(len(resp_hosts)) resps = self.na_resp_hosts(src_host, resp_pkts) self.assertEqual(len(resps ^ resp_hosts), 0) def test_l2bd_arp_term_01(self): """ L2BD arp term - add 5 hosts, verify arp responses """ src_host = self.ip4_host(50, 50, "00:00:11:22:33:44") self.bd_add_del(1, is_add=1) self.set_bd_flags(1, arp_term=True, flood=False, uu_flood=False, learn=False) macs = self.mac_list(range(1, 5)) hosts = self.ip4_hosts(4, 1, macs) self.add_del_arp_term_hosts(hosts, is_add=1) self.verify_arp(src_host, hosts, hosts) type(self).hosts = hosts def test_l2bd_arp_term_02(self): """ L2BD arp term - delete 3 hosts, verify arp responses """ src_host = self.ip4_host(50, 50, "00:00:11:22:33:44") macs = self.mac_list(range(1, 3)) deleted = self.ip4_hosts(4, 1, macs) self.add_del_arp_term_hosts(deleted, is_add=0) remaining = self.hosts - deleted self.verify_arp(src_host, self.hosts, remaining) type(self).hosts = remaining self.bd_add_del(1, is_add=0) def test_l2bd_arp_term_03(self): """ L2BD arp term - recreate BD1, readd 3 hosts, verify arp responses """ src_host = self.ip4_host(50, 50, "00:00:11:22:33:44") self.bd_add_del(1, is_add=1) self.set_bd_flags(1, arp_term=True, flood=False, uu_flood=False, learn=False) macs = self.mac_list(range(1, 3)) readded = self.ip4_hosts(4, 1, macs) self.add_del_arp_term_hosts(readded, is_add=1) self.verify_arp(src_host, self.hosts | readded, readded) type(self).hosts = readded def test_l2bd_arp_term_04(self): """ L2BD arp term - 2 IP4 addrs per host """ src_host = self.ip4_host(50, 50, "00:00:11:22:33:44") macs = self.mac_list(range(1, 3)) sub5_hosts = self.ip4_hosts(5, 1, macs) self.add_del_arp_term_hosts(sub5_hosts, is_add=1) hosts = self.hosts | sub5_hosts self.verify_arp(src_host, hosts, hosts) type(self).hosts = hosts self.bd_add_del(1, is_add=0) def test_l2bd_arp_term_05(self): """ L2BD arp term - create and update 10 IP4-mac pairs """ src_host = self.ip4_host(50, 50, "00:00:11:22:33:44") self.bd_add_del(1, is_add=1) self.set_bd_flags(1, arp_term=True, flood=False, uu_flood=False, learn=False) macs1 = self.mac_list(range(10, 20)) hosts1 = self.ip4_hosts(5, 1, macs1) self.add_del_arp_term_hosts(hosts1, is_add=1) self.verify_arp(src_host, hosts1, hosts1) macs2 = self.mac_list(range(20, 30)) hosts2 = self.ip4_hosts(5, 1, macs2) self.add_del_arp_term_hosts(hosts2, is_add=1) self.verify_arp(src_host, hosts1, hosts2) self.bd_add_del(1, is_add=0) def test_l2bd_arp_term_06(self): """ L2BD arp/ND term - hosts with both ip4/ip6 """ src_host4 = self.ip4_host(50, 50, "00:00:11:22:33:44") src_host6 = self.ip6_host(50, 50, "00:00:11:22:33:44") self.bd_add_del(1, is_add=1) # enable flood to make sure requests are not flooded self.set_bd_flags(1, arp_term=True, flood=True, uu_flood=False, learn=False) macs = self.mac_list(range(10, 20)) hosts6 = self.ip6_hosts(5, 1, macs) hosts4 = self.ip4_hosts(5, 1, macs) self.add_del_arp_term_hosts(hosts4, is_add=1) self.add_del_arp_term_hosts(hosts6, is_add=1, is_ipv6=1) self.verify_arp(src_host4, hosts4, hosts4) self.verify_nd(src_host6, hosts6, hosts6) self.bd_add_del(1, is_add=0) def test_l2bd_arp_term_07(self): """ L2BD ND term - Add and Del hosts, verify ND replies """ src_host6 = self.ip6_host(50, 50, "00:00:11:22:33:44") self.bd_add_del(1, is_add=1) self.set_bd_flags(1, arp_term=True, flood=False, uu_flood=False, learn=False) macs = self.mac_list(range(10, 20)) hosts6 = self.ip6_hosts(5, 1, macs) self.add_del_arp_term_hosts(hosts6, is_add=1, is_ipv6=1) self.verify_nd(src_host6, hosts6, hosts6) del_macs = self.mac_list(range(10, 15)) deleted = self.ip6_hosts(5, 1, del_macs) self.add_del_arp_term_hosts(deleted, is_add=0, is_ipv6=1) self.verify_nd(src_host6, hosts6, hosts6 - deleted) self.bd_add_del(1, is_add=0) def test_l2bd_arp_term_08(self): """ L2BD ND term - Add and update IP+mac, verify ND replies """ src_host = self.ip6_host(50, 50, "00:00:11:22:33:44") self.bd_add_del(1, is_add=1) self.set_bd_flags(1, arp_term=True, flood=False, uu_flood=False, learn=False) macs1 = self.mac_list(range(10, 20)) hosts = self.ip6_hosts(5, 1, macs1) self.add_del_arp_term_hosts(hosts, is_add=1, is_ipv6=1) self.verify_nd(src_host, hosts, hosts) macs2 = self.mac_list(range(20, 30)) updated = self.ip6_hosts(5, 1, macs2) self.add_del_arp_term_hosts(updated, is_add=1, is_ipv6=1) self.verify_nd(src_host, hosts, updated) self.bd_add_del(1, is_add=0) def test_l2bd_arp_term_09(self): """ L2BD arp term - send garps, verify arp event reports """ self.vapi.want_ip4_arp_events() self.bd_add_del(1, is_add=1) self.set_bd_flags(1, arp_term=True, flood=False, uu_flood=False, learn=False) macs = self.mac_list(range(90, 95)) hosts = self.ip4_hosts(5, 1, macs) garps = self.garp_reqs(hosts) self.bd_swifs(1)[0].add_stream(garps) self.pg_enable_capture(self.pg_interfaces) self.pg_start() evs = [self.vapi.wait_for_event(1, "ip4_arp_event") for i in range(len(hosts))] ev_hosts = self.arp_event_hosts(evs) self.assertEqual(len(ev_hosts ^ hosts), 0) def test_l2bd_arp_term_10(self): """ L2BD arp term - send duplicate garps, verify suppression """ macs = self.mac_list(range(70, 71)) hosts = self.ip4_hosts(6, 1, macs) """ send the packet 5 times expect one event """ garps = self.garp_reqs(hosts) * 5 self.bd_swifs(1)[0].add_stream(garps) self.pg_enable_capture(self.pg_interfaces) self.pg_start() evs = [self.vapi.wait_for_event(1, "ip4_arp_event") for i in range(len(hosts))] ev_hosts = self.arp_event_hosts(evs) self.assertEqual(len(ev_hosts ^ hosts), 0) def test_l2bd_arp_term_11(self): """ L2BD arp term - disable ip4 arp events,send garps, verify no events """ self.vapi.want_ip4_arp_events(enable_disable=0) macs = self.mac_list(range(90, 95)) hosts = self.ip4_hosts(5, 1, macs) garps = self.garp_reqs(hosts) self.bd_swifs(1)[0].add_stream(garps) self.pg_enable_capture(self.pg_interfaces) self.pg_start() self.sleep(1) self.assertEqual(len(self.vapi.collect_events()), 0) self.bd_add_del(1, is_add=0) def test_l2bd_arp_term_12(self): """ L2BD ND term - send NS packets verify reports """ self.vapi.want_ip6_nd_events(address=inet_pton(AF_INET6, "::0")) dst_host = self.ip6_host(50, 50, "00:00:11:22:33:44") self.bd_add_del(1, is_add=1) self.set_bd_flags(1, arp_term=True, flood=False, uu_flood=False, learn=False) macs = self.mac_list(range(10, 15)) hosts = self.ip6_hosts(5, 1, macs) reqs = self.ns_reqs_dst(hosts, dst_host) self.bd_swifs(1)[0].add_stream(reqs) self.pg_enable_capture(self.pg_interfaces) self.pg_start() evs = [self.vapi.wait_for_event(2, "ip6_nd_event") for i in range(len(hosts))] ev_hosts = self.nd_event_hosts(evs) self.assertEqual(len(ev_hosts ^ hosts), 0) def test_l2bd_arp_term_13(self): """ L2BD ND term - send duplicate ns, verify suppression """ dst_host = self.ip6_host(50, 50, "00:00:11:22:33:44") macs = self.mac_list(range(10, 11)) hosts = self.ip6_hosts(5, 1, macs) reqs = self.ns_reqs_dst(hosts, dst_host) * 5 self.bd_swifs(1)[0].add_stream(reqs) self.pg_enable_capture(self.pg_interfaces) self.pg_start() evs = [self.vapi.wait_for_event(2, "ip6_nd_event") for i in range(len(hosts))] ev_hosts = self.nd_event_hosts(evs) self.assertEqual(len(ev_hosts ^ hosts), 0) def test_l2bd_arp_term_14(self): """ L2BD ND term - disable ip4 arp events,send ns, verify no events """ self.vapi.want_ip6_nd_events(enable_disable=0, address=inet_pton(AF_INET6, "::0")) dst_host = self.ip6_host(50, 50, "00:00:11:22:33:44") macs = self.mac_list(range(10, 15)) hosts = self.ip6_hosts(5, 1, macs) reqs = self.ns_reqs_dst(hosts, dst_host) self.bd_swifs(1)[0].add_stream(reqs) self.pg_enable_capture(self.pg_interfaces) self.pg_start() self.sleep(1) self.assertEqual(len(self.vapi.collect_events()), 0) self.bd_add_del(1, is_add=0) if __name__ == '__main__': unittest.main(testRunner=VppTestRunner)