vpp-api-test/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 #include <stdio.h>
  19 #include <setjmp.h>
  20 #include <vppinfra/clib.h>
  21 #include <vppinfra/format.h>
  22 #include <vppinfra/error.h>
  23 #include <vppinfra/time.h>
  24 #include <vppinfra/macros.h>
  25 #include <vnet/vnet.h>
  26 #include <vlib/vlib.h>
  27 #include <vlib/unix/unix.h>
  28 #include <vlibapi/api.h>
  29 #include <vlibmemory/api.h>
  30
  31 #include "vat/json_format.h"
  32
  33 typedef struct {
  34     u8 * interface_name;
  35     u32 sw_if_index;
  36     /* Subinterface ID. A number 0-N to uniquely identify this subinterface under the super interface*/
  37     u32 sub_id;
  38
  39     /* 0 = dot1q, 1=dot1ad */
  40     u8 sub_dot1ad;
  41
  42     /* Number of tags 0-2 */
  43     u8 sub_number_of_tags;
  44     u16 sub_outer_vlan_id;
  45     u16 sub_inner_vlan_id;
  46     u8 sub_exact_match;
  47     u8 sub_default;
  48     u8 sub_outer_vlan_id_any;
  49     u8 sub_inner_vlan_id_any;
  50
  51     /* vlan tag rewrite */
  52     u32 vtr_op;
  53     u32 vtr_push_dot1q;
  54     u32 vtr_tag1;
  55     u32 vtr_tag2;
  56 } sw_interface_subif_t;
  57
  58 typedef struct {
  59     u8 ip[16];
  60     u8 prefix_length;
  61 } ip_address_details_t;
  62
  63 typedef struct {
  64     u8 present;
  65     ip_address_details_t * addr;
  66 } ip_details_t;
  67
  68 typedef struct {
  69     u64 packets;
  70     u64 bytes;
  71 } interface_counter_t;
  72
  73 typedef struct {
  74     struct in_addr address;
  75     u8 address_length;
  76     u64 packets;
  77     u64 bytes;
  78 } ip4_fib_counter_t;
  79
  80 typedef struct {
  81     struct in6_addr address;
  82     u8 address_length;
  83     u64 packets;
  84     u64 bytes;
  85 } ip6_fib_counter_t;
  86
  87 typedef struct {
  88     /* vpe input queue */
  89     unix_shared_memory_queue_t * vl_input_queue;
  90
  91     /* interface name table */
  92     uword * sw_if_index_by_interface_name;
  93
  94     /* subinterface table */
  95     sw_interface_subif_t * sw_if_subif_table;
  96
  97     /* ip tables */
  98     ip_details_t * ip_details_by_sw_if_index[2];
  99
 100     /* sw_if_index of currently processed interface */
 101     u32 current_sw_if_index;
 102
 103     /* remember that we are dumping ipv6 */
 104     u8 is_ipv6;
 105
 106     /* function table */
 107     uword * function_by_name;
 108
 109     /* help strings */
 110     uword * help_by_name;
 111
 112     /* macro table */
 113     macro_main_t macro_main;
 114
 115     /* Errors by number */
 116     uword * error_string_by_error_number;
 117
 118     /* Main thread can spin (w/ timeout) here if needed */
 119     u32 async_mode;
 120     u32 async_errors;
 121     volatile u32 result_ready;
 122     volatile i32 retval;
 123     volatile u8 *shmem_result;
 124
 125     /* our client index */
 126     u32 my_client_index;
 127
 128     /* Time is of the essence... */
 129     clib_time_t clib_time;
 130
 131     /* Unwind (so we can quit) */
 132     jmp_buf jump_buf;
 133
 134     /* temporary parse buffer */
 135     unformat_input_t *input;
 136
 137     /* input buffer */
 138     u8 * inbuf;
 139
 140     /* stdio input / output FILEs */
 141     FILE *ifp, *ofp;
 142     u8 * current_file;
 143     u32 input_line_number;
 144
 145     /* exec mode toggle */
 146     int exec_mode;
 147
 148     /* Regenerate the interface table */
 149     volatile int regenerate_interface_table;
 150
 151     /* flag for JSON output format */
 152     u8 json_output;
 153
 154     /* flag for interface event display */
 155     u8 interface_event_display;
 156
 157     /* JSON tree used in composing dump api call results */
 158     vat_json_node_t json_tree;
 159
 160     /* counters */
 161     u64 **simple_interface_counters;
 162     interface_counter_t **combined_interface_counters;
 163     ip4_fib_counter_t **ip4_fib_counters;
 164     u32 *ip4_fib_counters_vrf_id_by_index;
 165     ip6_fib_counter_t **ip6_fib_counters;
 166     u32 *ip6_fib_counters_vrf_id_by_index;
 167
 168 } vat_main_t;
 169
 170 vat_main_t vat_main;
 171
 172 static inline f64 vat_time_now (vat_main_t *vam)
 173 {
 174     return clib_time_now (&vam->clib_time);
 175 }
 176
 177 #define errmsg(fmt,args...)                             \
 178 do {                                                    \
 179     if(vam->ifp != stdin)                               \
 180         fformat(vam->ofp,"%s(%d): ", vam->current_file, \
 181                 vam->input_line_number);                \
 182     fformat(vam->ofp, fmt, ##args);                     \
 183     fflush(vam->ofp);                                   \
 184 } while(0);
 185
 186 void vat_api_hookup (vat_main_t *vam);
 187 int api_sw_interface_dump (vat_main_t * vam);
 188 void do_one_file (vat_main_t * vam);
 189 int exec (vat_main_t * vam);
 190
 191 /* Plugin API library functions */
 192 char *vat_plugin_path;
 193 char *vat_plugin_name_filter;
 194 void vat_plugin_api_reference(void);
 195 uword unformat_sw_if_index (unformat_input_t * input, va_list * args);
 196 uword unformat_ip4_address (unformat_input_t * input, va_list * args);
 197 uword unformat_ethernet_address (unformat_input_t * input, va_list * args);
 198 uword unformat_ethernet_type_host_byte_order (unformat_input_t * input,
 199                                               va_list * args);
 200 uword unformat_ip6_address (unformat_input_t * input, va_list * args);
 201 u8 * format_ip4_address (u8 * s, va_list * args);
 202 u8 * format_ethernet_address (u8 * s, va_list * args);
 203
 204
 205 #endif /* __included_vat_h__ */