src/vnet/gre/gre.h

   1 /*
   2  * gre.h: types/functions for gre.
   3  *
   4  * Copyright (c) 2012 Cisco and/or its affiliates.
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at:
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 #ifndef included_gre_h
  19 #define included_gre_h
  20
  21 #include <vnet/vnet.h>
  22 #include <vnet/gre/packet.h>
  23 #include <vnet/ip/ip.h>
  24 #include <vnet/pg/pg.h>
  25 #include <vnet/ip/format.h>
  26 #include <vnet/adj/adj_types.h>
  27
  28 extern vnet_hw_interface_class_t gre_hw_interface_class;
  29
  30 typedef enum
  31 {
  32 #define gre_error(n,s) GRE_ERROR_##n,
  33 #include <vnet/gre/error.def>
  34 #undef gre_error
  35   GRE_N_ERROR,
  36 } gre_error_t;
  37
  38 /**
  39  * @brief The GRE tunnel type
  40  */
  41 typedef enum gre_tunnel_type_t_
  42 {
  43   /**
  44    * L3 GRE (i.e. this tunnel is in L3 mode)
  45    */
  46   GRE_TUNNEL_TYPE_L3 = 0,
  47   /**
  48    * Transparent Ethernet Bridging - the tunnel is in L2 mode
  49    */
  50   GRE_TUNNEL_TYPE_TEB = 1,
  51   /**
  52    * ERSPAN type 2 - the tunnel is for port mirror SPAN output. Each tunnel is
  53    * associated with a session ID and expected to be used for encap and output
  54    * of mirrored packet from a L2 network only. There is no support for
  55    * receiving ERSPAN packets from a GRE ERSPAN tunnel in VPP.
  56    */
  57   GRE_TUNNEL_TYPE_ERSPAN = 2,
  58
  59   GRE_TUNNEL_TYPE_N
  60 } gre_tunnel_type_t;
  61
  62 #define GRE_TUNNEL_TYPE_NAMES {    \
  63     [GRE_TUNNEL_TYPE_L3] = "L3",   \
  64     [GRE_TUNNEL_TYPE_TEB] = "TEB", \
  65     [GRE_TUNNEL_TYPE_ERSPAN] = "ERSPAN", \
  66 }
  67
  68 /**
  69  * A GRE payload protocol registration
  70  */
  71 typedef struct
  72 {
  73   /** Name (a c string). */
  74   char *name;
  75
  76   /** GRE protocol type in host byte order. */
  77   gre_protocol_t protocol;
  78
  79   /** GRE tunnel type */
  80   gre_tunnel_type_t tunnel_type;
  81
  82   /** Node which handles this type. */
  83   u32 node_index;
  84
  85   /** Next index for this type. */
  86   u32 next_index;
  87 } gre_protocol_info_t;
  88
  89 /**
  90  * @brief Key for a IPv4 GRE Tunnel
  91  */
  92 typedef struct gre_tunnel_key4_t_
  93 {
  94   /**
  95    * Source and destination IP addresses
  96    */
  97   union
  98   {
  99     struct
 100     {
 101       ip4_address_t gtk_src;
 102       ip4_address_t gtk_dst;
 103     };
 104     u64 gtk_as_u64;
 105   };
 106
 107   /**
 108    * FIB table index, ERSPAN session ID and tunnel type in u32 bit fields:
 109    * - The FIB table index the src,dst addresses are in, top 20 bits
 110    * - The Session ID for ERSPAN tunnel type and 0 otherwise, next 10 bits
 111    * - Tunnel type, bottom 2 bits
 112    */
 113   u32 gtk_fidx_ssid_type;
 114 } __attribute__ ((packed)) gre_tunnel_key4_t;
 115
 116 /**
 117  * @brief Key for a IPv6 GRE Tunnel
 118  * We use a different type so that the V4 key hash is as small as possible
 119  */
 120 typedef struct gre_tunnel_key6_t_
 121 {
 122   /**
 123    * Source and destination IP addresses
 124    */
 125   ip6_address_t gtk_src;
 126   ip6_address_t gtk_dst;
 127
 128   /**
 129    * FIB table index, ERSPAN session ID and tunnel type in u32 bit fields:
 130    * - The FIB table index the src,dst addresses are in, top 20 bits
 131    * - The Session ID for ERSPAN tunnel type and 0 otherwise, next 10 bits
 132    * - Tunnel type, bottom 2 bits
 133    */
 134   u32 gtk_fidx_ssid_type;
 135 } __attribute__ ((packed)) gre_tunnel_key6_t;
 136
 137 #define GTK_FIB_INDEX_SHIFT     12
 138 #define GTK_FIB_INDEX_MASK      0xfffff000
 139 #define GTK_TYPE_SHIFT          0
 140 #define GTK_TYPE_MASK           0x3
 141 #define GTK_SESSION_ID_SHIFT    2
 142 #define GTK_SESSION_ID_MASK     0xffc
 143 #define GTK_SESSION_ID_MAX      (GTK_SESSION_ID_MASK >> GTK_SESSION_ID_SHIFT)
 144
 145 /**
 146  * Union of the two possible key types
 147  */
 148 typedef union gre_tunnel_key_t_
 149 {
 150   gre_tunnel_key4_t gtk_v4;
 151   gre_tunnel_key6_t gtk_v6;
 152 } gre_tunnel_key_t;
 153
 154 /**
 155  * Used for GRE header seq number generation for ERSPAN encap
 156  */
 157 typedef struct
 158 {
 159   u32 seq_num;
 160   u32 ref_count;
 161 } gre_sn_t;
 162
 163 /**
 164  * Hash key for GRE header seq number generation for ERSPAN encap
 165  */
 166 typedef struct
 167 {
 168   ip46_address_t src;
 169   ip46_address_t dst;
 170   u32 fib_index;
 171 } gre_sn_key_t;
 172
 173 /**
 174  * @brief A representation of a GRE tunnel
 175  */
 176 typedef struct
 177 {
 178   /**
 179    * Linkage into the FIB object graph
 180    */
 181   fib_node_t node;
 182
 183   /**
 184    * The hash table's key stored in separate memory since the tunnel_t
 185    * memory can realloc.
 186    */
 187   gre_tunnel_key_t *key;
 188
 189   /**
 190    * The tunnel's source/local address
 191    */
 192   ip46_address_t tunnel_src;
 193   /**
 194    * The tunnel's destination/remote address
 195    */
 196   fib_prefix_t tunnel_dst;
 197   /**
 198    * The FIB in which the src.dst address are present
 199    */
 200   u32 outer_fib_index;
 201   u32 hw_if_index;
 202   u32 sw_if_index;
 203   gre_tunnel_type_t type;
 204
 205   /**
 206    * The FIB entry sourced by the tunnel for its destination prefix
 207    */
 208   fib_node_index_t fib_entry_index;
 209
 210   /**
 211    * The tunnel is a child of the FIB entry for its desintion. This is
 212    * so it receives updates when the forwarding information for that entry
 213    * changes.
 214    * The tunnels sibling index on the FIB entry's dependency list.
 215    */
 216   u32 sibling_index;
 217
 218   /**
 219    * an L2 tunnel always rquires an L2 midchain. cache here for DP.
 220    */
 221   adj_index_t l2_adj_index;
 222
 223   /**
 224    * ERSPAN type 2 session ID, least significant 10 bits of u16
 225    */
 226   u16 session_id;
 227
 228   /**
 229    * GRE header sequence number (SN) used for ERSPAN type 2 header, must be
 230    * bumped automically to be thread safe. As multiple GRE tunnels are created
 231    * for the same fib-idx/DIP/SIP with different ERSPAN session number, they all
 232    * share the same SN which is kept per FIB/DIP/SIP, as specified by RFC2890.
 233    */
 234   gre_sn_t *gre_sn;
 235
 236
 237   u32 dev_instance;             /* Real device instance in tunnel vector */
 238   u32 user_instance;            /* Instance name being shown to user */
 239 } gre_tunnel_t;
 240
 241 typedef struct
 242 {
 243   u8 next_index;
 244   u8 tunnel_type;
 245 } next_info_t;
 246
 247 /**
 248  * @brief GRE related global data
 249  */
 250 typedef struct
 251 {
 252   /**
 253    * pool of tunnel instances
 254    */
 255   gre_tunnel_t *tunnels;
 256
 257   /**
 258    * GRE payload protocol registrations
 259    */
 260   gre_protocol_info_t *protocol_infos;
 261
 262   /**
 263    *  Hash tables mapping name/protocol to protocol info index.
 264    */
 265   uword *protocol_info_by_name, *protocol_info_by_protocol;
 266
 267   /**
 268    * Hash mapping to tunnels with ipv4 src/dst addr
 269    */
 270   uword *tunnel_by_key4;
 271
 272   /**
 273    * Hash mapping to tunnels with ipv6 src/dst addr
 274    */
 275   uword *tunnel_by_key6;
 276
 277   /**
 278    * Hash mapping tunnel src/dst addr and fib-idx to sequence number
 279    */
 280   uword *seq_num_by_key;
 281
 282   /**
 283    * Mapping from sw_if_index to tunnel index
 284    */
 285   u32 *tunnel_index_by_sw_if_index;
 286
 287   /* Sparse vector mapping gre protocol in network byte order
 288      to next index. */
 289   next_info_t *next_by_protocol;
 290
 291   /* convenience */
 292   vlib_main_t *vlib_main;
 293   vnet_main_t *vnet_main;
 294
 295   /* Record used instances */
 296   uword *instance_used;
 297 } gre_main_t;
 298
 299 /**
 300  * @brief IPv4 and GRE header.
 301  */
 302 /* *INDENT-OFF* */
 303 typedef CLIB_PACKED (struct {
 304   ip4_header_t ip4;
 305   gre_header_t gre;
 306 }) ip4_and_gre_header_t;
 307 /* *INDENT-ON* */
 308
 309 /**
 310  * @brief IPv6 and GRE header.
 311  */
 312 /* *INDENT-OFF* */
 313 typedef CLIB_PACKED (struct {
 314   ip6_header_t ip6;
 315   gre_header_t gre;
 316 }) ip6_and_gre_header_t;
 317 /* *INDENT-ON* */
 318
 319 always_inline gre_protocol_info_t *
 320 gre_get_protocol_info (gre_main_t * em, gre_protocol_t protocol)
 321 {
 322   uword *p = hash_get (em->protocol_info_by_protocol, protocol);
 323   return p ? vec_elt_at_index (em->protocol_infos, p[0]) : 0;
 324 }
 325
 326 extern gre_main_t gre_main;
 327
 328 extern clib_error_t *gre_interface_admin_up_down (vnet_main_t * vnm,
 329                                                   u32 hw_if_index, u32 flags);
 330
 331 extern void gre_tunnel_stack (adj_index_t ai);
 332 extern void gre_update_adj (vnet_main_t * vnm,
 333                             u32 sw_if_index, adj_index_t ai);
 334
 335 format_function_t format_gre_protocol;
 336 format_function_t format_gre_header;
 337 format_function_t format_gre_header_with_length;
 338
 339 extern vlib_node_registration_t gre4_input_node;
 340 extern vlib_node_registration_t gre6_input_node;
 341 extern vlib_node_registration_t gre_encap_node;
 342 extern vnet_device_class_t gre_device_class;
 343
 344 /* Parse gre protocol as 0xXXXX or protocol name.
 345    In either host or network byte order. */
 346 unformat_function_t unformat_gre_protocol_host_byte_order;
 347 unformat_function_t unformat_gre_protocol_net_byte_order;
 348
 349 /* Parse gre header. */
 350 unformat_function_t unformat_gre_header;
 351 unformat_function_t unformat_pg_gre_header;
 352
 353 void
 354 gre_register_input_protocol (vlib_main_t * vm, gre_protocol_t protocol,
 355                              u32 node_index, gre_tunnel_type_t tunnel_type);
 356
 357 /* manually added to the interface output node in gre.c */
 358 #define GRE_OUTPUT_NEXT_LOOKUP  1
 359
 360 typedef struct
 361 {
 362   u8 is_add;
 363   u8 tunnel_type;
 364   u8 is_ipv6;
 365   u32 instance;
 366   ip46_address_t src, dst;
 367   u32 outer_fib_id;
 368   u16 session_id;
 369 } vnet_gre_add_del_tunnel_args_t;
 370
 371 int vnet_gre_add_del_tunnel
 372   (vnet_gre_add_del_tunnel_args_t * a, u32 * sw_if_indexp);
 373
 374 static inline void
 375 gre_mk_key4 (ip4_address_t src,
 376              ip4_address_t dst,
 377              u32 fib_index, u8 ttype, u16 session_id, gre_tunnel_key4_t * key)
 378 {
 379   key->gtk_src = src;
 380   key->gtk_dst = dst;
 381   key->gtk_fidx_ssid_type = ttype |
 382     (fib_index << GTK_FIB_INDEX_SHIFT) | (session_id << GTK_SESSION_ID_SHIFT);
 383 }
 384
 385 static inline int
 386 gre_match_key4 (const gre_tunnel_key4_t * key1,
 387                 const gre_tunnel_key4_t * key2)
 388 {
 389   return ((key1->gtk_as_u64 == key2->gtk_as_u64) &&
 390           (key1->gtk_fidx_ssid_type == key2->gtk_fidx_ssid_type));
 391 }
 392
 393 static inline void
 394 gre_mk_key6 (const ip6_address_t * src,
 395              const ip6_address_t * dst,
 396              u32 fib_index, u8 ttype, u16 session_id, gre_tunnel_key6_t * key)
 397 {
 398   key->gtk_src = *src;
 399   key->gtk_dst = *dst;
 400   key->gtk_fidx_ssid_type = ttype |
 401     (fib_index << GTK_FIB_INDEX_SHIFT) | (session_id << GTK_SESSION_ID_SHIFT);
 402 }
 403
 404 static inline int
 405 gre_match_key6 (const gre_tunnel_key6_t * key1,
 406                 const gre_tunnel_key6_t * key2)
 407 {
 408   return ((key1->gtk_src.as_u64[0] == key2->gtk_src.as_u64[0]) &&
 409           (key1->gtk_src.as_u64[1] == key2->gtk_src.as_u64[1]) &&
 410           (key1->gtk_dst.as_u64[0] == key2->gtk_dst.as_u64[0]) &&
 411           (key1->gtk_dst.as_u64[1] == key2->gtk_dst.as_u64[1]) &&
 412           (key1->gtk_fidx_ssid_type == key2->gtk_fidx_ssid_type));
 413 }
 414
 415 static inline void
 416 gre_mk_sn_key (const gre_tunnel_t * gt, gre_sn_key_t * key)
 417 {
 418   key->src = gt->tunnel_src;
 419   key->dst = gt->tunnel_dst.fp_addr;
 420   key->fib_index = gt->outer_fib_index;
 421 }
 422
 423 #endif /* included_gre_h */
 424
 425 /*
 426  * fd.io coding-style-patch-verification: ON
 427  *
 428  * Local Variables:
 429  * eval: (c-set-style "gnu")
 430  * End:
 431  */