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 #define gre_error(n,s) GRE_ERROR_##n,
  32 #include <vnet/gre/error.def>
  33 #undef gre_error
  34   GRE_N_ERROR,
  35 } gre_error_t;
  36
  37 /**
  38  * A GRE payload protocol registration
  39  */
  40 typedef struct {
  41   /** Name (a c string). */
  42   char * name;
  43
  44   /** GRE protocol type in host byte order. */
  45   gre_protocol_t protocol;
  46
  47   /** Node which handles this type. */
  48   u32 node_index;
  49
  50   /** Next index for this type. */
  51   u32 next_index;
  52 } gre_protocol_info_t;
  53
  54 /**
  55  * @brief The GRE tunnel type
  56  */
  57 typedef enum gre_tunnel_tyoe_t_
  58 {
  59   /**
  60    * L3 GRE (i.e. this tunnel is in L3 mode)
  61    */
  62   GRE_TUNNEL_TYPE_L3,
  63   /**
  64    * Transparent Ethernet Bridging - the tunnel is in L2 mode
  65    */
  66   GRE_TUNNEL_TYPE_TEB,
  67 } gre_tunnel_type_t;
  68
  69 #define GRE_TUNNEL_TYPE_NAMES {    \
  70     [GRE_TUNNEL_TYPE_L3] = "L3",   \
  71     [GRE_TUNNEL_TYPE_TEB] = "TEB", \
  72 }
  73
  74 #define GRE_TUNNEL_N_TYPES ((gre_tunnel_type_t)GRE_TUNNEL_TYPE_TEB+1)
  75
  76 /**
  77  * @brief A representation of a GRE tunnel
  78  */
  79 typedef struct {
  80   /**
  81    * Linkage into the FIB object graph
  82    */
  83   fib_node_t node;
  84
  85   /**
  86    * The tunnel's source/local address
  87    */
  88   ip46_address_t tunnel_src;
  89   /**
  90    * The tunnel's destination/remote address
  91    */
  92   fib_prefix_t tunnel_dst;
  93   /**
  94    * The FIB in which the src.dst address are present
  95    */
  96   u32 outer_fib_index;
  97   u32 hw_if_index;
  98   u32 sw_if_index;
  99   gre_tunnel_type_t type;
 100
 101   /**
 102    * The FIB entry sourced by the tunnel for its destination prefix
 103    */
 104   fib_node_index_t fib_entry_index;
 105
 106   /**
 107    * The tunnel is a child of the FIB entry for its desintion. This is
 108    * so it receives updates when the forwarding information for that entry
 109    * changes.
 110    * The tunnels sibling index on the FIB entry's dependency list.
 111    */
 112   u32 sibling_index;
 113
 114   /**
 115    * on a L2 tunnel this is the VLIB arc from the L2-tx to the l2-midchain
 116    */
 117   u32 l2_tx_arc;
 118
 119   /**
 120    * an L2 tunnel always rquires an L2 midchain. cache here for DP.
 121    */
 122   adj_index_t l2_adj_index;
 123 } gre_tunnel_t;
 124
 125 /**
 126  * @brief GRE related global data
 127  */
 128 typedef struct {
 129   /**
 130    * pool of tunnel instances
 131    */
 132   gre_tunnel_t *tunnels;
 133
 134   /**
 135    * GRE payload protocol registrations
 136    */
 137   gre_protocol_info_t * protocol_infos;
 138
 139   /**
 140    *  Hash tables mapping name/protocol to protocol info index.
 141    */
 142   uword * protocol_info_by_name, * protocol_info_by_protocol;
 143
 144   /**
 145    * Hash mapping ipv4 src/dst addr pair to tunnel
 146    */
 147   uword * tunnel_by_key4;
 148
 149   /**
 150      * Hash mapping ipv6 src/dst addr pair to tunnel
 151      */
 152     uword * tunnel_by_key6;
 153
 154   /**
 155    * Free vlib hw_if_indices.
 156    * A free list per-tunnel type since the interfaces ctreated are fo different
 157    * types and we cannot change the type.
 158    */
 159   u32 * free_gre_tunnel_hw_if_indices[GRE_TUNNEL_N_TYPES];
 160
 161   /**
 162    * Mapping from sw_if_index to tunnel index
 163    */
 164   u32 * tunnel_index_by_sw_if_index;
 165
 166   /* Sparse vector mapping gre protocol in network byte order
 167      to next index. */
 168   u16 * next_by_protocol;
 169
 170   /* convenience */
 171   vlib_main_t * vlib_main;
 172   vnet_main_t * vnet_main;
 173 } gre_main_t;
 174
 175 /**
 176  * @brief IPv4 and GRE header.
 177  */
 178 typedef CLIB_PACKED (struct {
 179   ip4_header_t ip4;
 180   gre_header_t gre;
 181 }) ip4_and_gre_header_t;
 182
 183 /**
 184  * @brief IPv6 and GRE header.
 185  */
 186 typedef CLIB_PACKED (struct {
 187   ip6_header_t ip6;
 188   gre_header_t gre;
 189 }) ip6_and_gre_header_t;
 190
 191 always_inline gre_protocol_info_t *
 192 gre_get_protocol_info (gre_main_t * em, gre_protocol_t protocol)
 193 {
 194   uword * p = hash_get (em->protocol_info_by_protocol, protocol);
 195   return p ? vec_elt_at_index (em->protocol_infos, p[0]) : 0;
 196 }
 197
 198 extern gre_main_t gre_main;
 199
 200 /* Register given node index to take input for given gre type. */
 201 void
 202 gre_register_input_type (vlib_main_t * vm,
 203                          gre_protocol_t protocol,
 204                          u32 node_index);
 205
 206 extern  clib_error_t * gre_interface_admin_up_down (vnet_main_t * vnm,
 207                                                     u32 hw_if_index,
 208                                                     u32 flags);
 209
 210 extern void gre_tunnel_stack (adj_index_t ai);
 211 extern void gre_update_adj (vnet_main_t * vnm,
 212                             u32 sw_if_index,
 213                             adj_index_t ai);
 214
 215 format_function_t format_gre_protocol;
 216 format_function_t format_gre_header;
 217 format_function_t format_gre_header_with_length;
 218
 219 extern vlib_node_registration_t gre4_input_node;
 220 extern vlib_node_registration_t gre6_input_node;
 221 extern vnet_device_class_t gre_device_class;
 222 extern vnet_device_class_t gre_device_teb_class;
 223
 224 /* Parse gre protocol as 0xXXXX or protocol name.
 225    In either host or network byte order. */
 226 unformat_function_t unformat_gre_protocol_host_byte_order;
 227 unformat_function_t unformat_gre_protocol_net_byte_order;
 228
 229 /* Parse gre header. */
 230 unformat_function_t unformat_gre_header;
 231 unformat_function_t unformat_pg_gre_header;
 232
 233 void
 234 gre_register_input_protocol (vlib_main_t * vm,
 235                              gre_protocol_t protocol,
 236                              u32 node_index);
 237
 238 /* manually added to the interface output node in gre.c */
 239 #define GRE_OUTPUT_NEXT_LOOKUP  1
 240
 241 typedef struct {
 242   u8 is_add;
 243
 244   ip46_address_t src, dst;
 245   u8 is_ipv6;
 246   u32 outer_fib_id;
 247   u8 teb;
 248 } vnet_gre_add_del_tunnel_args_t;
 249
 250 int vnet_gre_add_del_tunnel
 251   (vnet_gre_add_del_tunnel_args_t *a, u32 * sw_if_indexp);
 252
 253 #endif /* included_gre_h */