src/plugins/ioam/lib-vxlan-gpe/vxlan_gpe_ioam.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_vxlan_gpe_ioam_h__
  16 #define __included_vxlan_gpe_ioam_h__
  17
  18 #include <vnet/vxlan-gpe/vxlan_gpe.h>
  19 #include <vnet/vxlan-gpe/vxlan_gpe_packet.h>
  20 #include <ioam/lib-vxlan-gpe/vxlan_gpe_ioam_packet.h>
  21 #include <vnet/ip/ip.h>
  22
  23
  24 typedef struct vxlan_gpe_sw_interface_
  25 {
  26   u32 sw_if_index;
  27 } vxlan_gpe_ioam_sw_interface_t;
  28
  29 typedef struct vxlan_gpe_dest_tunnels_
  30 {
  31   ip46_address_t dst_addr;
  32   u32 fp_proto;
  33   u32 sibling_index;
  34   fib_node_index_t fib_entry_index;
  35   u32 outer_fib_index;
  36 } vxlan_gpe_ioam_dest_tunnels_t;
  37
  38 typedef struct vxlan_gpe_ioam_main_
  39 {
  40   /**
  41    * Linkage into the FIB object graph
  42    */
  43   fib_node_t node;
  44
  45   /* time scale transform. Joy. */
  46   u32 unix_time_0;
  47   f64 vlib_time_0;
  48
  49
  50   /* Trace option */
  51   u8 has_trace_option;
  52
  53   /* Pot option */
  54   u8 has_pot_option;
  55
  56 #define PPC_NONE  0
  57 #define PPC_ENCAP 1
  58 #define PPC_DECAP 2
  59   u8 has_ppc_option;
  60
  61 #define TSP_SECONDS              0
  62 #define TSP_MILLISECONDS         1
  63 #define TSP_MICROSECONDS         2
  64 #define TSP_NANOSECONDS          3
  65
  66   /* Array of function pointers to ADD and POP VxLAN-GPE iOAM option handling routines */
  67   u8 options_size[256];
  68   int (*add_options[256]) (u8 * rewrite_string, u8 * rewrite_size);
  69   int (*pop_options[256]) (ip4_header_t * ip, vxlan_gpe_ioam_option_t * opt);
  70
  71   /* Array of function pointers to iOAM option handling routines */
  72   int (*options[256]) (vlib_buffer_t * b, vxlan_gpe_ioam_option_t * opt,
  73                        u8 is_ipv4, u8 use_adj);
  74   u8 *(*trace[256]) (u8 * s, vxlan_gpe_ioam_option_t * opt);
  75
  76   /* API message ID base */
  77   u16 msg_id_base;
  78
  79   /* Override to export for iOAM */
  80   uword decap_v4_next_override;
  81   uword decap_v6_next_override;
  82
  83   /* sequence of node graph for encap */
  84   uword encap_v4_next_node;
  85   uword encap_v6_next_node;
  86
  87   /* Software interfaces. */
  88   vxlan_gpe_ioam_sw_interface_t *sw_interfaces;
  89
  90   /* hash ip4/ip6 -> list of destinations for doing transit iOAM operation */
  91   vxlan_gpe_ioam_dest_tunnels_t *dst_tunnels;
  92   uword *dst_by_ip4;
  93   uword *dst_by_ip6;
  94
  95   /** per sw_if_index, to maintain bitmap */
  96   u8 *bool_ref_by_sw_if_index;
  97   fib_node_type_t fib_entry_type;
  98
  99   /** State convenience vlib_main_t */
 100   vlib_main_t *vlib_main;
 101   /** State convenience vnet_main_t */
 102   vnet_main_t *vnet_main;
 103
 104
 105 } vxlan_gpe_ioam_main_t;
 106 extern vxlan_gpe_ioam_main_t vxlan_gpe_ioam_main;
 107
 108 /*
 109  * Primary h-b-h handler trace support
 110  */
 111 typedef struct
 112 {
 113   u32 next_index;
 114   u32 trace_len;
 115   u8 option_data[256];
 116 } ioam_trace_t;
 117
 118
 119 extern vlib_node_registration_t vxlan_gpe_encap_ioam_v4_node;
 120 extern vlib_node_registration_t vxlan_gpe_decap_ioam_v4_node;
 121 extern vlib_node_registration_t vxlan_gpe_transit_ioam_v4_node;
 122
 123 clib_error_t *vxlan_gpe_ioam_enable (int has_trace_option, int has_pot_option,
 124                                      int has_ppc_option);
 125
 126 clib_error_t *vxlan_gpe_ioam_disable (int has_trace_option,
 127                                       int has_pot_option, int has_ppc_option);
 128
 129 clib_error_t *vxlan_gpe_ioam_set (vxlan_gpe_tunnel_t * t,
 130                                   int has_trace_option,
 131                                   int has_pot_option,
 132                                   int has_ppc_option, u8 ipv6_set);
 133 clib_error_t *vxlan_gpe_ioam_clear (vxlan_gpe_tunnel_t * t,
 134                                     int has_trace_option, int has_pot_option,
 135                                     int has_ppc_option, u8 ipv6_set);
 136
 137 int vxlan_gpe_ioam_add_register_option (u8 option,
 138                                         u8 size,
 139                                         int rewrite_options (u8 *
 140                                                              rewrite_string,
 141                                                              u8 *
 142                                                              rewrite_size));
 143
 144 int vxlan_gpe_add_unregister_option (u8 option);
 145
 146 int vxlan_gpe_ioam_register_option (u8 option,
 147                                     int options (vlib_buffer_t * b,
 148                                                  vxlan_gpe_ioam_option_t *
 149                                                  opt, u8 is_ipv4, u8 use_adj),
 150                                     u8 * trace (u8 * s,
 151                                                 vxlan_gpe_ioam_option_t *
 152                                                 opt));
 153 int vxlan_gpe_ioam_unregister_option (u8 option);
 154
 155 int vxlan_gpe_trace_profile_setup (void);
 156
 157 int vxlan_gpe_trace_profile_cleanup (void);
 158 extern void vxlan_gpe_ioam_interface_init (void);
 159 int
 160 vxlan_gpe_enable_disable_ioam_for_dest (vlib_main_t * vm,
 161                                         ip46_address_t dst_addr,
 162                                         u32 outer_fib_index,
 163                                         u8 is_ipv4, u8 is_add);
 164 int vxlan_gpe_ioam_disable_for_dest
 165   (vlib_main_t * vm, ip46_address_t dst_addr, u32 outer_fib_index,
 166    u8 ipv4_set);
 167
 168 typedef enum
 169 {
 170   VXLAN_GPE_DECAP_IOAM_V4_NEXT_POP,
 171   VXLAN_GPE_DECAP_IOAM_V4_NEXT_DROP,
 172   VXLAN_GPE_DECAP_IOAM_V4_N_NEXT
 173 } vxlan_gpe_decap_ioam_v4_next_t;
 174
 175 #endif
 176
 177 /*
 178  * fd.io coding-style-patch-verification: ON
 179  *
 180  * Local Variables:
 181  * eval: (c-set-style "gnu")
 182  * End:
 183  */