2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
15 #ifndef __included_vat_h__
16 #define __included_vat_h__
21 #include <sys/types.h>
22 #include <sys/socket.h>
24 #include <vppinfra/clib.h>
25 #include <vppinfra/format.h>
26 #include <vppinfra/error.h>
27 #include <vppinfra/elog.h>
28 #include <vppinfra/time.h>
29 #include <vppinfra/macros.h>
30 #include <vppinfra/socket.h>
31 #include <vnet/vnet.h>
32 #include <vlib/vlib.h>
33 #include <vlib/unix/unix.h>
34 #include <vlibapi/api.h>
35 #include <vlibmemory/api.h>
37 #include "vat/json_format.h"
39 #include <vlib/vlib.h>
46 * Subinterface ID. A number 0-N to uniquely identify this
47 * subinterface under the super interface
51 /* 0 = dot1q, 1=dot1ad */
54 /* Number of tags 0-2 */
55 u8 sub_number_of_tags;
56 u16 sub_outer_vlan_id;
57 u16 sub_inner_vlan_id;
60 u8 sub_outer_vlan_id_any;
61 u8 sub_inner_vlan_id_any;
63 /* vlan tag rewrite */
68 } sw_interface_subif_t;
74 } ip_address_details_t;
79 ip_address_details_t *addr;
86 } interface_counter_t;
90 struct in_addr address;
98 struct in6_addr address;
106 struct in_addr address;
114 struct in6_addr address;
122 /* vpe input queue */
123 svm_queue_t *vl_input_queue;
125 /* interface name table */
126 uword *sw_if_index_by_interface_name;
128 /* subinterface table */
129 sw_interface_subif_t *sw_if_subif_table;
131 /* Graph node table */
132 uword *graph_node_index_by_name;
133 vlib_node_t ***graph_nodes;
136 ip_details_t *ip_details_by_sw_if_index[2];
138 /* sw_if_index of currently processed interface */
139 u32 current_sw_if_index;
141 /* remember that we are dumping ipv6 */
145 uword *function_by_name;
151 macro_main_t macro_main;
153 /* Errors by number */
154 uword *error_string_by_error_number;
156 /* Main thread can spin (w/ timeout) here if needed */
159 volatile u32 result_ready;
161 volatile u32 sw_if_index;
162 volatile u8 *shmem_result;
165 /* our client index */
167 int client_index_invalid;
169 /* Time is of the essence... */
170 clib_time_t clib_time;
172 /* Unwind (so we can quit) */
175 volatile int do_exit;
177 /* temporary parse buffer */
178 unformat_input_t *input;
183 /* stdio input / output FILEs */
186 u32 input_line_number;
188 /* exec mode toggle */
191 /* Regenerate the interface table */
192 volatile int regenerate_interface_table;
194 /* flag for JSON output format */
197 /* flag for interface event display */
198 u8 interface_event_display;
200 /* JSON tree used in composing dump api call results */
201 vat_json_node_t json_tree;
204 u64 **simple_interface_counters;
205 interface_counter_t **combined_interface_counters;
206 ip4_fib_counter_t **ip4_fib_counters;
207 u32 *ip4_fib_counters_vrf_id_by_index;
208 ip6_fib_counter_t **ip6_fib_counters;
209 u32 *ip6_fib_counters_vrf_id_by_index;
210 ip4_nbr_counter_t **ip4_nbr_counters;
211 ip6_nbr_counter_t **ip6_nbr_counters;
213 ssvm_private_t stat_segment;
214 clib_spinlock_t *stat_segment_lockp;
216 socket_client_main_t *socket_client_main;
219 #if VPP_API_TEST_BUILTIN == 0
220 elog_main_t elog_main;
224 vlib_main_t *vlib_main;
227 extern vat_main_t vat_main;
229 void vat_suspend (vlib_main_t * vm, f64 interval);
230 f64 vat_time_now (vat_main_t * vam);
231 void errmsg (char *fmt, ...);
232 void vat_api_hookup (vat_main_t * vam);
233 int api_sw_interface_dump (vat_main_t * vam);
234 void do_one_file (vat_main_t * vam);
235 int exec (vat_main_t * vam);
237 /* Plugin API library functions */
238 extern char *vat_plugin_path;
239 extern char *vat_plugin_name_filter;
240 void vat_plugin_api_reference (void);
241 uword unformat_sw_if_index (unformat_input_t * input, va_list * args);
242 uword unformat_ip4_address (unformat_input_t * input, va_list * args);
243 uword unformat_ethernet_address (unformat_input_t * input, va_list * args);
244 uword unformat_ethernet_type_host_byte_order (unformat_input_t * input,
246 uword unformat_ip6_address (unformat_input_t * input, va_list * args);
247 u8 *format_ip4_address (u8 * s, va_list * args);
248 u8 *format_ip6_address (u8 * s, va_list * args);
249 u8 *format_ip46_address (u8 * s, va_list * args);
250 u8 *format_ethernet_address (u8 * s, va_list * args);
252 int vat_socket_connect (vat_main_t * vam);
254 #if VPP_API_TEST_BUILTIN
255 #define print api_cli_output
256 void api_cli_output (void *, const char *fmt, ...);
258 #define print fformat_append_cr
259 void fformat_append_cr (FILE *, const char *fmt, ...);
262 #endif /* __included_vat_h__ */
265 * fd.io coding-style-patch-verification: ON
268 * eval: (c-set-style "gnu")