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/time.h>
28 #include <vppinfra/macros.h>
29 #include <vppinfra/socket.h>
30 #include <vnet/vnet.h>
31 #include <vlib/vlib.h>
32 #include <vlib/unix/unix.h>
33 #include <vlibapi/api.h>
34 #include <vlibmemory/api.h>
36 #include "vat/json_format.h"
38 #include <vlib/vlib.h>
45 * Subinterface ID. A number 0-N to uniquely identify this
46 * subinterface under the super interface
50 /* 0 = dot1q, 1=dot1ad */
53 /* Number of tags 0-2 */
54 u8 sub_number_of_tags;
55 u16 sub_outer_vlan_id;
56 u16 sub_inner_vlan_id;
59 u8 sub_outer_vlan_id_any;
60 u8 sub_inner_vlan_id_any;
62 /* vlan tag rewrite */
67 } sw_interface_subif_t;
73 } ip_address_details_t;
78 ip_address_details_t *addr;
85 } interface_counter_t;
89 struct in_addr address;
97 struct in6_addr address;
105 struct in_addr address;
113 struct in6_addr address;
121 /* vpe input queue */
122 svm_queue_t *vl_input_queue;
124 /* interface name table */
125 uword *sw_if_index_by_interface_name;
127 /* subinterface table */
128 sw_interface_subif_t *sw_if_subif_table;
130 /* Graph node table */
131 uword *graph_node_index_by_name;
132 vlib_node_t ***graph_nodes;
135 ip_details_t *ip_details_by_sw_if_index[2];
137 /* sw_if_index of currently processed interface */
138 u32 current_sw_if_index;
140 /* remember that we are dumping ipv6 */
144 uword *function_by_name;
150 macro_main_t macro_main;
152 /* Errors by number */
153 uword *error_string_by_error_number;
155 /* Main thread can spin (w/ timeout) here if needed */
158 volatile u32 result_ready;
160 volatile u32 sw_if_index;
161 volatile u8 *shmem_result;
164 /* our client index */
166 int client_index_invalid;
168 /* Time is of the essence... */
169 clib_time_t clib_time;
171 /* Unwind (so we can quit) */
174 volatile int do_exit;
176 /* temporary parse buffer */
177 unformat_input_t *input;
182 /* stdio input / output FILEs */
185 u32 input_line_number;
187 /* exec mode toggle */
190 /* Regenerate the interface table */
191 volatile int regenerate_interface_table;
193 /* flag for JSON output format */
196 /* flag for interface event display */
197 u8 interface_event_display;
199 /* JSON tree used in composing dump api call results */
200 vat_json_node_t json_tree;
203 u64 **simple_interface_counters;
204 interface_counter_t **combined_interface_counters;
205 ip4_fib_counter_t **ip4_fib_counters;
206 u32 *ip4_fib_counters_vrf_id_by_index;
207 ip6_fib_counter_t **ip6_fib_counters;
208 u32 *ip6_fib_counters_vrf_id_by_index;
209 ip4_nbr_counter_t **ip4_nbr_counters;
210 ip6_nbr_counter_t **ip6_nbr_counters;
212 ssvm_private_t stat_segment;
213 clib_spinlock_t *stat_segment_lockp;
215 socket_client_main_t *socket_client_main;
219 vlib_main_t *vlib_main;
222 extern vat_main_t vat_main;
224 void vat_suspend (vlib_main_t * vm, f64 interval);
225 f64 vat_time_now (vat_main_t * vam);
226 void errmsg (char *fmt, ...);
227 void vat_api_hookup (vat_main_t * vam);
228 int api_sw_interface_dump (vat_main_t * vam);
229 void do_one_file (vat_main_t * vam);
230 int exec (vat_main_t * vam);
232 /* Plugin API library functions */
233 char *vat_plugin_path;
234 char *vat_plugin_name_filter;
235 void vat_plugin_api_reference (void);
236 uword unformat_sw_if_index (unformat_input_t * input, va_list * args);
237 uword unformat_ip4_address (unformat_input_t * input, va_list * args);
238 uword unformat_ethernet_address (unformat_input_t * input, va_list * args);
239 uword unformat_ethernet_type_host_byte_order (unformat_input_t * input,
241 uword unformat_ip6_address (unformat_input_t * input, va_list * args);
242 u8 *format_ip4_address (u8 * s, va_list * args);
243 u8 *format_ip6_address (u8 * s, va_list * args);
244 u8 *format_ip46_address (u8 * s, va_list * args);
245 u8 *format_ethernet_address (u8 * s, va_list * args);
247 int vat_socket_connect (vat_main_t * vam);
249 #if VPP_API_TEST_BUILTIN
250 #define print api_cli_output
251 void api_cli_output (void *, const char *fmt, ...);
253 #define print fformat_append_cr
254 void fformat_append_cr (FILE *, const char *fmt, ...);
257 #endif /* __included_vat_h__ */
260 * fd.io coding-style-patch-verification: ON
263 * eval: (c-set-style "gnu")