src/plugins/lisp/lisp-gpe/lisp_gpe.h

   1 /*
   2  * Copyright (c) 2016 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 /**
  16  * @file
  17  * @brief LISP-GPE definitions.
  18  */
  19
  20 #ifndef included_vnet_lisp_gpe_h
  21 #define included_vnet_lisp_gpe_h
  22
  23 #include <vppinfra/error.h>
  24 #include <vppinfra/mhash.h>
  25 #include <vnet/vnet.h>
  26 #include <vnet/ip/ip.h>
  27 #include <vnet/l2/l2_input.h>
  28 #include <vnet/ethernet/ethernet.h>
  29 #include <vnet/ip/ip4_packet.h>
  30 #include <vnet/udp/udp.h>
  31 #include <lisp/lisp-cp/lisp_types.h>
  32 #include <lisp/lisp-gpe/lisp_gpe_packet.h>
  33 #include <vnet/adj/adj_types.h>
  34 #include <vppinfra/bihash_24_8.h>
  35 #include <vppinfra/bihash_template.h>
  36
  37 /** IP4-UDP-LISP encap header */
  38 /* *INDENT-OFF* */
  39 typedef CLIB_PACKED (struct {
  40   ip4_header_t ip4;             /* 20 bytes */
  41   udp_header_t udp;             /* 8 bytes */
  42   lisp_gpe_header_t lisp;       /* 8 bytes */
  43 }) ip4_udp_lisp_gpe_header_t;
  44 /* *INDENT-ON* */
  45
  46 /** IP6-UDP-LISP encap header */
  47 /* *INDENT-OFF* */
  48 typedef CLIB_PACKED (struct {
  49   ip6_header_t ip6;             /* 40 bytes */
  50   udp_header_t udp;             /* 8 bytes */
  51   lisp_gpe_header_t lisp;       /* 8 bytes */
  52 }) ip6_udp_lisp_gpe_header_t;
  53 /* *INDENT-ON* */
  54
  55 #define foreach_lisp_gpe_ip_input_next          \
  56 _(DROP, "error-drop")                           \
  57 _(IP4_INPUT, "ip4-input")                       \
  58 _(IP6_INPUT, "ip6-input")                       \
  59 _(L2_INPUT, "l2-input")
  60
  61 /** Enum of possible next nodes post LISP-GPE decap */
  62 typedef enum
  63 {
  64 #define _(s,n) LISP_GPE_INPUT_NEXT_##s,
  65   foreach_lisp_gpe_ip_input_next
  66 #undef _
  67     LISP_GPE_INPUT_N_NEXT,
  68 } lisp_gpe_input_next_t;
  69
  70 /* Arc to nsh-input added only if nsh-input exists */
  71 #define LISP_GPE_INPUT_NEXT_NSH_INPUT 4
  72
  73 typedef enum
  74 {
  75 #define lisp_gpe_error(n,s) LISP_GPE_ERROR_##n,
  76 #include <lisp/lisp-gpe/lisp_gpe_error.def>
  77 #undef lisp_gpe_error
  78   LISP_GPE_N_ERROR,
  79 } lisp_gpe_error_t;
  80
  81 typedef struct tunnel_lookup
  82 {
  83   /** Lookup lisp-gpe interfaces by dp table (eg. vrf/bridge index) */
  84   uword *hw_if_index_by_dp_table;
  85
  86   /** lookup decap tunnel termination sw_if_index by vni and vice versa */
  87   uword *sw_if_index_by_vni;
  88
  89   // FIXME - Need this?
  90   uword *vni_by_sw_if_index;
  91 } tunnel_lookup_t;
  92
  93 typedef struct
  94 {
  95   u32 fwd_entry_index;
  96   u32 tunnel_index;
  97 } lisp_stats_key_t;
  98
  99 typedef struct
 100 {
 101   u32 vni;
 102   dp_address_t deid;
 103   dp_address_t seid;
 104   ip_address_t loc_rloc;
 105   ip_address_t rmt_rloc;
 106
 107   vlib_counter_t counters;
 108 } lisp_api_stats_t;
 109
 110 typedef enum gpe_encap_mode_e
 111 {
 112   GPE_ENCAP_LISP,
 113   GPE_ENCAP_VXLAN,
 114   GPE_ENCAP_COUNT
 115 } gpe_encap_mode_t;
 116
 117 /** LISP-GPE global state*/
 118 typedef struct lisp_gpe_main
 119 {
 120   /**
 121    * @brief DB of all forwarding entries. The Key is:{l-EID,r-EID,vni}
 122    * where the EID encodes L2 or L3
 123    */
 124   uword *lisp_gpe_fwd_entries;
 125
 126   /**
 127    * @brief A Pool of all LISP forwarding entries
 128    */
 129   struct lisp_gpe_fwd_entry_t_ *lisp_fwd_entry_pool;
 130
 131   /** Free vlib hw_if_indices */
 132   u32 *free_tunnel_hw_if_indices;
 133
 134   u8 is_en;
 135
 136   /* L3 data structures
 137    * ================== */
 138   tunnel_lookup_t l3_ifaces;
 139
 140   /* L2 data structures
 141    * ================== */
 142
 143   /** L2 LISP FIB */
 144     BVT (clib_bihash) l2_fib;
 145
 146   tunnel_lookup_t l2_ifaces;
 147
 148   /** Load-balance for a miss in the table */
 149   dpo_id_t l2_lb_cp_lkup;
 150
 151   /* NSH data structures
 152    * ================== */
 153
 154     BVT (clib_bihash) nsh_fib;
 155
 156   tunnel_lookup_t nsh_ifaces;
 157
 158   const dpo_id_t *nsh_cp_lkup;
 159
 160   gpe_encap_mode_t encap_mode;
 161
 162   u8 *placeholder_stats_pool;
 163   uword *lisp_stats_index_by_key;
 164   vlib_combined_counter_main_t counters;
 165
 166   /** Native fwd data structures */
 167   fib_route_path_t *native_fwd_rpath[2];
 168   u32 *native_fwd_lfes[2];
 169
 170   /** convenience */
 171   vlib_main_t *vlib_main;
 172   vnet_main_t *vnet_main;
 173   ip4_main_t *im4;
 174   ip6_main_t *im6;
 175   ip_lookup_main_t *lm4;
 176   ip_lookup_main_t *lm6;
 177 } lisp_gpe_main_t;
 178
 179 /** LISP-GPE global state*/
 180 extern lisp_gpe_main_t lisp_gpe_main;
 181
 182 always_inline lisp_gpe_main_t *
 183 vnet_lisp_gpe_get_main ()
 184 {
 185   return &lisp_gpe_main;
 186 }
 187
 188
 189 extern vlib_node_registration_t lisp_gpe_ip4_input_node;
 190 extern vlib_node_registration_t lisp_gpe_ip6_input_node;
 191 extern vnet_hw_interface_class_t lisp_gpe_hw_class;
 192
 193 u8 *format_lisp_gpe_header_with_length (u8 * s, va_list * args);
 194
 195 /** Read LISP-GPE status */
 196 u8 vnet_lisp_gpe_enable_disable_status (void);
 197
 198 u32
 199 lisp_gpe_l3_iface_find_or_create (lisp_gpe_main_t * lgm,
 200                                   u32 overlay_table_id, u32 vni);
 201
 202 /** Add/del LISP-GPE interface. */
 203 extern void lisp_gpe_del_l2_iface (lisp_gpe_main_t * lgm, u32 vni, u32 bd_id);
 204 extern u32 lisp_gpe_add_l2_iface (lisp_gpe_main_t * lgm, u32 vni, u32 bd_id);
 205 extern void lisp_gpe_del_l3_iface (lisp_gpe_main_t * lgm, u32 vni, u32 bd_id);
 206 extern u32 lisp_gpe_add_l3_iface (lisp_gpe_main_t * lgm, u32 vni, u32 bd_id,
 207                                   u8 with_default_route);
 208
 209
 210 typedef struct
 211 {
 212   u8 is_en;
 213 } vnet_lisp_gpe_enable_disable_args_t;
 214
 215 clib_error_t
 216   * vnet_lisp_gpe_enable_disable (vnet_lisp_gpe_enable_disable_args_t * a);
 217
 218 typedef enum
 219 {
 220   NO_ACTION,
 221   FORWARD_NATIVE,
 222   SEND_MAP_REQUEST,
 223   DROP
 224 } negative_fwd_actions_e;
 225
 226 /** */
 227 typedef struct
 228 {
 229   /** forwarding entry index of */
 230   u32 fwd_entry_index;
 231
 232   u8 is_src_dst;
 233
 234   u8 is_add;
 235
 236   /** type of mapping */
 237   u8 is_negative;
 238
 239   /** action for negative mappings */
 240   negative_fwd_actions_e action;
 241
 242   /** local eid */
 243   gid_address_t lcl_eid;
 244
 245   /** remote eid */
 246   gid_address_t rmt_eid;
 247
 248   /** vector of locator pairs */
 249   locator_pair_t *locator_pairs;
 250
 251   /** FIB index to lookup remote locator at encap */
 252   u32 encap_fib_index;
 253
 254   /** FIB index to lookup inner IP at decap */
 255   u32 decap_fib_index;
 256
 257   /* TODO remove */
 258   u32 decap_next_index;
 259
 260   /** VNI/tenant id in HOST byte order */
 261   u32 vni;
 262
 263   /** vrf or bd where fwd entry should be inserted */
 264   union
 265   {
 266     /** table (vrf) id */
 267     u32 table_id;
 268
 269     /** bridge domain id */
 270     u32 bd_id;
 271
 272     /** generic access */
 273     u32 dp_table;
 274   };
 275 } vnet_lisp_gpe_add_del_fwd_entry_args_t;
 276
 277 typedef struct
 278 {
 279   fib_route_path_t rpath;
 280   u8 is_add;
 281 } vnet_gpe_native_fwd_rpath_args_t;
 282
 283 typedef struct
 284 {
 285   u32 fwd_entry_index;
 286   u32 dp_table;
 287   u32 vni;
 288   u8 action;
 289   dp_address_t leid;
 290   dp_address_t reid;
 291 } lisp_api_gpe_fwd_entry_t;
 292
 293 #define foreach_lgpe_ip4_lookup_next    \
 294   _(DROP, "error-drop")                 \
 295   _(LISP_CP_LOOKUP, "lisp-cp-lookup")
 296
 297 typedef enum lgpe_ip4_lookup_next
 298 {
 299 #define _(sym,str) LGPE_IP4_LOOKUP_NEXT_##sym,
 300   foreach_lgpe_ip4_lookup_next
 301 #undef _
 302     LGPE_IP4_LOOKUP_N_NEXT,
 303 } lgpe_ip4_lookup_next_t;
 304
 305 #define foreach_lgpe_ip6_lookup_next    \
 306   _(DROP, "error-drop")                 \
 307   _(LISP_CP_LOOKUP, "lisp-cp-lookup")
 308
 309 typedef enum lgpe_ip6_lookup_next
 310 {
 311 #define _(sym,str) LGPE_IP6_LOOKUP_NEXT_##sym,
 312   foreach_lgpe_ip6_lookup_next
 313 #undef _
 314     LGPE_IP6_LOOKUP_N_NEXT,
 315 } lgpe_ip6_lookup_next_t;
 316
 317 u8 *format_vnet_lisp_gpe_status (u8 * s, va_list * args);
 318
 319 lisp_api_gpe_fwd_entry_t *vnet_lisp_gpe_fwd_entries_get_by_vni (u32 vni);
 320 gpe_encap_mode_t vnet_gpe_get_encap_mode (void);
 321 int vnet_gpe_set_encap_mode (gpe_encap_mode_t mode);
 322
 323 u8 vnet_lisp_stats_enable_disable_state (void);
 324 vnet_api_error_t vnet_lisp_stats_enable_disable (u8 enable);
 325 lisp_api_stats_t *vnet_lisp_get_stats (void);
 326 int vnet_lisp_flush_stats (void);
 327 int vnet_gpe_add_del_native_fwd_rpath (vnet_gpe_native_fwd_rpath_args_t * a);
 328 u32 vnet_lisp_gpe_add_nsh_iface (lisp_gpe_main_t * lgm);
 329 void vnet_lisp_gpe_del_nsh_iface (lisp_gpe_main_t * lgm);
 330
 331 #endif /* included_vnet_lisp_gpe_h */
 332
 333 /*
 334  * fd.io coding-style-patch-verification: ON
 335  *
 336  * Local Variables:
 337  * eval: (c-set-style "gnu")
 338  * End:
 339  */