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 extern vnet_hw_interface_class_t mgre_hw_interface_class;
  30
  31 typedef enum
  32 {
  33 #define gre_error(n,s) GRE_ERROR_##n,
  34 #include <vnet/gre/error.def>
  35 #undef gre_error
  36   GRE_N_ERROR,
  37 } gre_error_t;
  38
  39 /**
  40  * L3: GRE (i.e. this tunnel is in L3 mode)
  41  * TEB: Transparent Ethernet Bridging - the tunnel is in L2 mode
  42  * ERSPAN: type 2 - the tunnel is for port mirror SPAN output. Each tunnel is
  43  *         associated with a session ID and expected to be used for encap
  44  *         and output of mirrored packet from a L2 network only. There is
  45  *         no support for receiving ERSPAN packets from a GRE ERSPAN tunnel
  46  */
  47 #define foreach_gre_tunnel_type \
  48   _(L3, "L3")                   \
  49   _(TEB, "TEB")                 \
  50   _(ERSPAN, "ERSPAN")           \
  51
  52 /**
  53  * @brief The GRE tunnel type
  54  */
  55 typedef enum gre_tunnel_type_t_
  56 {
  57 #define _(n, s) GRE_TUNNEL_TYPE_##n,
  58   foreach_gre_tunnel_type
  59 #undef _
  60 } __clib_packed gre_tunnel_type_t;
  61
  62 extern u8 *format_gre_tunnel_type (u8 * s, va_list * args);
  63
  64 #define foreach_gre_tunnel_mode \
  65   _(P2P, "point-to-point")      \
  66   _(MP, "multi-point")          \
  67
  68 typedef enum gre_tunnel_mode_t_
  69 {
  70 #define _(n, s) GRE_TUNNEL_MODE_##n,
  71   foreach_gre_tunnel_mode
  72 #undef _
  73 } __clib_packed gre_tunnel_mode_t;
  74
  75 extern u8 *format_gre_tunnel_mode (u8 * s, va_list * args);
  76
  77 /**
  78  * A GRE payload protocol registration
  79  */
  80 typedef struct
  81 {
  82   /** Name (a c string). */
  83   char *name;
  84
  85   /** GRE protocol type in host byte order. */
  86   gre_protocol_t protocol;
  87
  88   /** GRE tunnel type */
  89   gre_tunnel_type_t tunnel_type;
  90
  91   /** Node which handles this type. */
  92   u32 node_index;
  93
  94   /** Next index for this type. */
  95   u32 next_index;
  96 } gre_protocol_info_t;
  97
  98 /**
  99  * Elements of the GRE key that are common for v6 and v6 addresses
 100  */
 101 typedef struct gre_tunnel_key_common_t_
 102 {
 103   union
 104   {
 105     struct
 106     {
 107       u32 fib_index;
 108       u16 session_id;
 109       gre_tunnel_type_t type;
 110       gre_tunnel_mode_t mode;
 111     };
 112     u64 as_u64;
 113   };
 114 } gre_tunnel_key_common_t;
 115
 116 STATIC_ASSERT_SIZEOF (gre_tunnel_key_common_t, sizeof (u64));
 117
 118 /**
 119  * @brief Key for a IPv4 GRE Tunnel
 120  */
 121 typedef struct gre_tunnel_key4_t_
 122 {
 123   /**
 124    * Source and destination IP addresses
 125    */
 126   union
 127   {
 128     struct
 129     {
 130       ip4_address_t gtk_src;
 131       ip4_address_t gtk_dst;
 132     };
 133     u64 gtk_as_u64;
 134   };
 135
 136   /** address independent attributes */
 137   gre_tunnel_key_common_t gtk_common;
 138 } __attribute__ ((packed)) gre_tunnel_key4_t;
 139
 140 STATIC_ASSERT_SIZEOF (gre_tunnel_key4_t, 2 * sizeof (u64));
 141
 142 /**
 143  * @brief Key for a IPv6 GRE Tunnel
 144  * We use a different type so that the V4 key hash is as small as possible
 145  */
 146 typedef struct gre_tunnel_key6_t_
 147 {
 148   /**
 149    * Source and destination IP addresses
 150    */
 151   ip6_address_t gtk_src;
 152   ip6_address_t gtk_dst;
 153
 154   /** address independent attributes */
 155   gre_tunnel_key_common_t gtk_common;
 156 } __attribute__ ((packed)) gre_tunnel_key6_t;
 157
 158 STATIC_ASSERT_SIZEOF (gre_tunnel_key6_t, 5 * sizeof (u64));
 159
 160 /**
 161  * Union of the two possible key types
 162  */
 163 typedef union gre_tunnel_key_t_
 164 {
 165   gre_tunnel_key4_t gtk_v4;
 166   gre_tunnel_key6_t gtk_v6;
 167 } gre_tunnel_key_t;
 168
 169 /**
 170  * The session ID is only a 10 bit value
 171  */
 172 #define GTK_SESSION_ID_MAX (0x3ff)
 173
 174 /**
 175  * Used for GRE header seq number generation for ERSPAN encap
 176  */
 177 typedef struct
 178 {
 179   u32 seq_num;
 180   u32 ref_count;
 181 } gre_sn_t;
 182
 183 /**
 184  * Hash key for GRE header seq number generation for ERSPAN encap
 185  */
 186 typedef struct
 187 {
 188   ip46_address_t src;
 189   ip46_address_t dst;
 190   u32 fib_index;
 191 } gre_sn_key_t;
 192
 193 /**
 194  * @brief A representation of a GRE tunnel
 195  */
 196 typedef struct
 197 {
 198   /**
 199    * Required for pool_get_aligned
 200    */
 201   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 202
 203   /**
 204    * The tunnel's source/local address
 205    */
 206   ip46_address_t tunnel_src;
 207   /**
 208    * The tunnel's destination/remote address
 209    */
 210   fib_prefix_t tunnel_dst;
 211   /**
 212    * The FIB in which the src.dst address are present
 213    */
 214   u32 outer_fib_index;
 215   u32 hw_if_index;
 216   u32 sw_if_index;
 217   gre_tunnel_type_t type;
 218   gre_tunnel_mode_t mode;
 219
 220   /**
 221    * an L2 tunnel always rquires an L2 midchain. cache here for DP.
 222    */
 223   adj_index_t l2_adj_index;
 224
 225   /**
 226    * ERSPAN type 2 session ID, least significant 10 bits of u16
 227    */
 228   u16 session_id;
 229
 230   /**
 231    * GRE header sequence number (SN) used for ERSPAN type 2 header, must be
 232    * bumped automically to be thread safe. As multiple GRE tunnels are created
 233    * for the same fib-idx/DIP/SIP with different ERSPAN session number, they all
 234    * share the same SN which is kept per FIB/DIP/SIP, as specified by RFC2890.
 235    */
 236   gre_sn_t *gre_sn;
 237
 238
 239   u32 dev_instance;             /* Real device instance in tunnel vector */
 240   u32 user_instance;            /* Instance name being shown to user */
 241 } gre_tunnel_t;
 242
 243 typedef struct
 244 {
 245   u8 next_index;
 246   u8 tunnel_type;
 247 } next_info_t;
 248
 249 /**
 250  * @brief GRE related global data
 251  */
 252 typedef struct
 253 {
 254   /**
 255    * pool of tunnel instances
 256    */
 257   gre_tunnel_t *tunnels;
 258
 259   /**
 260    * GRE payload protocol registrations
 261    */
 262   gre_protocol_info_t *protocol_infos;
 263
 264   /**
 265    *  Hash tables mapping name/protocol to protocol info index.
 266    */
 267   uword *protocol_info_by_name, *protocol_info_by_protocol;
 268
 269   /**
 270    * Hash mapping to tunnels with ipv4 src/dst addr
 271    */
 272   uword *tunnel_by_key4;
 273
 274   /**
 275    * Hash mapping to tunnels with ipv6 src/dst addr
 276    */
 277   uword *tunnel_by_key6;
 278
 279   /**
 280    * Hash mapping tunnel src/dst addr and fib-idx to sequence number
 281    */
 282   uword *seq_num_by_key;
 283
 284   /**
 285    * Mapping from sw_if_index to tunnel index
 286    */
 287   u32 *tunnel_index_by_sw_if_index;
 288
 289   /* Sparse vector mapping gre protocol in network byte order
 290      to next index. */
 291   next_info_t *next_by_protocol;
 292
 293   /* convenience */
 294   vlib_main_t *vlib_main;
 295   vnet_main_t *vnet_main;
 296
 297   /* Record used instances */
 298   uword *instance_used;
 299 } gre_main_t;
 300
 301 /**
 302  * @brief IPv4 and GRE header.
 303  */
 304 /* *INDENT-OFF* */
 305 typedef CLIB_PACKED (struct {
 306   ip4_header_t ip4;
 307   gre_header_t gre;
 308 }) ip4_and_gre_header_t;
 309 /* *INDENT-ON* */
 310
 311 /**
 312  * @brief IPv6 and GRE header.
 313  */
 314 /* *INDENT-OFF* */
 315 typedef CLIB_PACKED (struct {
 316   ip6_header_t ip6;
 317   gre_header_t gre;
 318 }) ip6_and_gre_header_t;
 319 /* *INDENT-ON* */
 320
 321 always_inline gre_protocol_info_t *
 322 gre_get_protocol_info (gre_main_t * em, gre_protocol_t protocol)
 323 {
 324   uword *p = hash_get (em->protocol_info_by_protocol, protocol);
 325   return p ? vec_elt_at_index (em->protocol_infos, p[0]) : 0;
 326 }
 327
 328 extern gre_main_t gre_main;
 329
 330 extern clib_error_t *gre_interface_admin_up_down (vnet_main_t * vnm,
 331                                                   u32 hw_if_index, u32 flags);
 332
 333 extern void gre_tunnel_stack (adj_index_t ai);
 334 extern void gre_update_adj (vnet_main_t * vnm,
 335                             u32 sw_if_index, adj_index_t ai);
 336
 337 format_function_t format_gre_protocol;
 338 format_function_t format_gre_header;
 339 format_function_t format_gre_header_with_length;
 340
 341 extern vlib_node_registration_t gre4_input_node;
 342 extern vlib_node_registration_t gre6_input_node;
 343 extern vlib_node_registration_t gre_encap_node;
 344 extern vnet_device_class_t gre_device_class;
 345
 346 /* Parse gre protocol as 0xXXXX or protocol name.
 347    In either host or network byte order. */
 348 unformat_function_t unformat_gre_protocol_host_byte_order;
 349 unformat_function_t unformat_gre_protocol_net_byte_order;
 350
 351 /* Parse gre header. */
 352 unformat_function_t unformat_gre_header;
 353 unformat_function_t unformat_pg_gre_header;
 354
 355 void
 356 gre_register_input_protocol (vlib_main_t * vm, gre_protocol_t protocol,
 357                              u32 node_index, gre_tunnel_type_t tunnel_type);
 358
 359 /* manually added to the interface output node in gre.c */
 360 #define GRE_OUTPUT_NEXT_LOOKUP  1
 361
 362 typedef struct
 363 {
 364   u8 is_add;
 365   gre_tunnel_type_t type;
 366   gre_tunnel_mode_t mode;
 367   u8 is_ipv6;
 368   u32 instance;
 369   ip46_address_t src, dst;
 370   u32 outer_table_id;
 371   u16 session_id;
 372 } vnet_gre_tunnel_add_del_args_t;
 373
 374 extern int vnet_gre_tunnel_add_del (vnet_gre_tunnel_add_del_args_t * a,
 375                                     u32 * sw_if_indexp);
 376
 377 static inline void
 378 gre_mk_key4 (ip4_address_t src,
 379              ip4_address_t dst,
 380              u32 fib_index,
 381              gre_tunnel_type_t ttype,
 382              gre_tunnel_mode_t tmode, u16 session_id, gre_tunnel_key4_t * key)
 383 {
 384   key->gtk_src = src;
 385   key->gtk_dst = dst;
 386   key->gtk_common.type = ttype;
 387   key->gtk_common.mode = tmode;
 388   key->gtk_common.fib_index = fib_index;
 389   key->gtk_common.session_id = session_id;
 390 }
 391
 392 static inline int
 393 gre_match_key4 (const gre_tunnel_key4_t * key1,
 394                 const gre_tunnel_key4_t * key2)
 395 {
 396   return ((key1->gtk_as_u64 == key2->gtk_as_u64) &&
 397           (key1->gtk_common.as_u64 == key2->gtk_common.as_u64));
 398 }
 399
 400 static inline void
 401 gre_mk_key6 (const ip6_address_t * src,
 402              const ip6_address_t * dst,
 403              u32 fib_index,
 404              gre_tunnel_type_t ttype,
 405              gre_tunnel_mode_t tmode, u16 session_id, gre_tunnel_key6_t * key)
 406 {
 407   key->gtk_src = *src;
 408   key->gtk_dst = *dst;
 409   key->gtk_common.type = ttype;
 410   key->gtk_common.mode = tmode;
 411   key->gtk_common.fib_index = fib_index;
 412   key->gtk_common.session_id = session_id;
 413 }
 414
 415 static inline int
 416 gre_match_key6 (const gre_tunnel_key6_t * key1,
 417                 const gre_tunnel_key6_t * key2)
 418 {
 419   return (ip6_address_is_equal (&key1->gtk_src, &key2->gtk_src) &&
 420           ip6_address_is_equal (&key1->gtk_dst, &key2->gtk_dst) &&
 421           (key1->gtk_common.as_u64 == key2->gtk_common.as_u64));
 422 }
 423
 424 static inline void
 425 gre_mk_sn_key (const gre_tunnel_t * gt, gre_sn_key_t * key)
 426 {
 427   key->src = gt->tunnel_src;
 428   key->dst = gt->tunnel_dst.fp_addr;
 429   key->fib_index = gt->outer_fib_index;
 430 }
 431
 432 #endif /* included_gre_h */
 433
 434 /*
 435  * fd.io coding-style-patch-verification: ON
 436  *
 437  * Local Variables:
 438  * eval: (c-set-style "gnu")
 439  * End:
 440  */