src/vat/vat.h

   1 /*
   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:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   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.
  14  */
  15 #ifndef __included_vat_h__
  16 #define __included_vat_h__
  17
  18 #define _GNU_SOURCE
  19 #include <stdio.h>
  20 #include <setjmp.h>
  21 #include <sys/types.h>
  22 #include <sys/socket.h>
  23 #include <sys/un.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>
  36
  37 #include "vat/json_format.h"
  38
  39 #include <vlib/vlib.h>
  40
  41 typedef struct
  42 {
  43   u8 *interface_name;
  44   u32 sw_if_index;
  45   /*
  46    * Subinterface ID. A number 0-N to uniquely identify this
  47    * subinterface under the super interface
  48    */
  49   u32 sub_id;
  50
  51   /* 0 = dot1q, 1=dot1ad */
  52   u8 sub_dot1ad;
  53
  54   /* Number of tags 0-2 */
  55   u8 sub_number_of_tags;
  56   u16 sub_outer_vlan_id;
  57   u16 sub_inner_vlan_id;
  58   u8 sub_exact_match;
  59   u8 sub_default;
  60   u8 sub_outer_vlan_id_any;
  61   u8 sub_inner_vlan_id_any;
  62
  63   /* vlan tag rewrite */
  64   u32 vtr_op;
  65   u32 vtr_push_dot1q;
  66   u32 vtr_tag1;
  67   u32 vtr_tag2;
  68 } sw_interface_subif_t;
  69
  70 typedef struct
  71 {
  72   u8 ip[16];
  73   u8 prefix_length;
  74 } ip_address_details_t;
  75
  76 typedef struct
  77 {
  78   u8 present;
  79   ip_address_details_t *addr;
  80 } ip_details_t;
  81
  82 typedef struct
  83 {
  84   u64 packets;
  85   u64 bytes;
  86 } interface_counter_t;
  87
  88 typedef struct
  89 {
  90   struct in_addr address;
  91   u8 address_length;
  92   u64 packets;
  93   u64 bytes;
  94 } ip4_fib_counter_t;
  95
  96 typedef struct
  97 {
  98   struct in6_addr address;
  99   u8 address_length;
 100   u64 packets;
 101   u64 bytes;
 102 } ip6_fib_counter_t;
 103
 104 typedef struct
 105 {
 106   struct in_addr address;
 107   vnet_link_t linkt;
 108   u64 packets;
 109   u64 bytes;
 110 } ip4_nbr_counter_t;
 111
 112 typedef struct
 113 {
 114   struct in6_addr address;
 115   vnet_link_t linkt;
 116   u64 packets;
 117   u64 bytes;
 118 } ip6_nbr_counter_t;
 119
 120 typedef struct
 121 {
 122   /* vpe input queue */
 123   svm_queue_t *vl_input_queue;
 124
 125   /* interface name table */
 126   uword *sw_if_index_by_interface_name;
 127
 128   /* subinterface table */
 129   sw_interface_subif_t *sw_if_subif_table;
 130
 131   /* Graph node table */
 132   uword *graph_node_index_by_name;
 133   vlib_node_t ***graph_nodes;
 134
 135   /* ip tables */
 136   ip_details_t *ip_details_by_sw_if_index[2];
 137
 138   /* sw_if_index of currently processed interface */
 139   u32 current_sw_if_index;
 140
 141   /* remember that we are dumping ipv6 */
 142   u8 is_ipv6;
 143
 144   /* function table */
 145   uword *function_by_name;
 146
 147   /* help strings */
 148   uword *help_by_name;
 149
 150   /* macro table */
 151   macro_main_t macro_main;
 152
 153   /* Errors by number */
 154   uword *error_string_by_error_number;
 155
 156   /* Main thread can spin (w/ timeout) here if needed */
 157   u32 async_mode;
 158   u32 async_errors;
 159   volatile u32 result_ready;
 160   volatile i32 retval;
 161   volatile u32 sw_if_index;
 162   volatile u8 *shmem_result;
 163   u8 *cmd_reply;
 164
 165   /* our client index */
 166   u32 my_client_index;
 167   int client_index_invalid;
 168
 169   /* Time is of the essence... */
 170   clib_time_t clib_time;
 171
 172   /* Unwind (so we can quit) */
 173   jmp_buf jump_buf;
 174   int jump_buf_set;
 175   volatile int do_exit;
 176
 177   /* temporary parse buffer */
 178   unformat_input_t *input;
 179
 180   /* input buffer */
 181   u8 *inbuf;
 182
 183   /* stdio input / output FILEs */
 184   FILE *ifp, *ofp;
 185   u8 *current_file;
 186   u32 input_line_number;
 187
 188   /* exec mode toggle */
 189   int exec_mode;
 190
 191   /* Regenerate the interface table */
 192   volatile int regenerate_interface_table;
 193
 194   /* flag for JSON output format */
 195   u8 json_output;
 196
 197   /* flag for interface event display */
 198   u8 interface_event_display;
 199
 200   /* JSON tree used in composing dump api call results */
 201   vat_json_node_t json_tree;
 202
 203   /* counters */
 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;
 212
 213   ssvm_private_t stat_segment;
 214   clib_spinlock_t *stat_segment_lockp;
 215
 216   socket_client_main_t *socket_client_main;
 217   u8 *socket_name;
 218
 219   elog_main_t elog_main;
 220
 221   /* Convenience */
 222   vlib_main_t *vlib_main;
 223 } vat_main_t;
 224
 225 extern vat_main_t vat_main;
 226
 227 void vat_suspend (vlib_main_t * vm, f64 interval);
 228 f64 vat_time_now (vat_main_t * vam);
 229 void errmsg (char *fmt, ...);
 230 void vat_api_hookup (vat_main_t * vam);
 231 int api_sw_interface_dump (vat_main_t * vam);
 232 void do_one_file (vat_main_t * vam);
 233 int exec (vat_main_t * vam);
 234
 235 /* Plugin API library functions */
 236 extern char *vat_plugin_path;
 237 extern char *vat_plugin_name_filter;
 238 void vat_plugin_api_reference (void);
 239 uword unformat_sw_if_index (unformat_input_t * input, va_list * args);
 240 uword unformat_ip4_address (unformat_input_t * input, va_list * args);
 241 uword unformat_ethernet_address (unformat_input_t * input, va_list * args);
 242 uword unformat_ethernet_type_host_byte_order (unformat_input_t * input,
 243                                               va_list * args);
 244 uword unformat_ip6_address (unformat_input_t * input, va_list * args);
 245 u8 *format_ip4_address (u8 * s, va_list * args);
 246 u8 *format_ip6_address (u8 * s, va_list * args);
 247 u8 *format_ip46_address (u8 * s, va_list * args);
 248 u8 *format_ethernet_address (u8 * s, va_list * args);
 249
 250 int vat_socket_connect (vat_main_t * vam);
 251
 252 #if VPP_API_TEST_BUILTIN
 253 #define print api_cli_output
 254 void api_cli_output (void *, const char *fmt, ...);
 255 #else
 256 #define print fformat_append_cr
 257 void fformat_append_cr (FILE *, const char *fmt, ...);
 258 #endif
 259
 260 #endif /* __included_vat_h__ */
 261
 262 /*
 263  * fd.io coding-style-patch-verification: ON
 264  *
 265  * Local Variables:
 266  * eval: (c-set-style "gnu")
 267  * End:
 268  */