src/plugins/gtpu/gtpu.h

   1 /*
   2  *------------------------------------------------------------------
   3  * Copyright (c) 2017 Intel and/or its affiliates.
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *------------------------------------------------------------------
  16  */
  17
  18 #ifndef included_vnet_gtpu_h
  19 #define included_vnet_gtpu_h
  20
  21 #include <vppinfra/lock.h>
  22 #include <vppinfra/error.h>
  23 #include <vppinfra/hash.h>
  24 #include <vnet/vnet.h>
  25 #include <vnet/ip/ip.h>
  26 #include <vnet/l2/l2_input.h>
  27 #include <vnet/l2/l2_output.h>
  28 #include <vnet/l2/l2_bd.h>
  29 #include <vnet/ethernet/ethernet.h>
  30 #include <vnet/ip/ip4_packet.h>
  31 #include <vnet/ip/ip6_packet.h>
  32 #include <vnet/udp/udp.h>
  33 #include <vnet/dpo/dpo.h>
  34 #include <vnet/adj/adj_types.h>
  35 #include <vnet/fib/fib_table.h>
  36
  37 /**
  38  *              Bits
  39  * Octets       8       7       6       5       4       3       2       1
  40  * 1                      Version       PT      (*)     E       S       PN
  41  * 2            Message Type
  42  * 3            Length (1st Octet)
  43  * 4            Length (2nd Octet)
  44  * 5            Tunnel Endpoint Identifier (1st Octet)
  45  * 6            Tunnel Endpoint Identifier (2nd Octet)
  46  * 7            Tunnel Endpoint Identifier (3rd Octet)
  47  * 8            Tunnel Endpoint Identifier (4th Octet)
  48  * 9            Sequence Number (1st Octet)1) 4)
  49  * 10           Sequence Number (2nd Octet)1) 4)
  50  * 11           N-PDU Number2) 4)
  51  * 12           Next Extension Header Type3) 4)
  52 **/
  53
  54 typedef struct
  55 {
  56   u8 ver_flags;
  57   u8 type;
  58   u16 length;                   /* length in octets of the payload */
  59   u32 teid;
  60   u16 sequence;
  61   u8 pdu_number;
  62   u8 next_ext_type;
  63 } gtpu_header_t;
  64
  65 #define GTPU_VER_MASK (7<<5)
  66 #define GTPU_PT_BIT   (1<<4)
  67 #define GTPU_E_BIT    (1<<2)
  68 #define GTPU_S_BIT    (1<<1)
  69 #define GTPU_PN_BIT   (1<<0)
  70 #define GTPU_E_S_PN_BIT  (7<<0)
  71
  72 #define GTPU_V1_VER   (1<<5)
  73
  74 #define GTPU_PT_GTP    (1<<4)
  75 #define GTPU_TYPE_GTPU  255
  76
  77 /* *INDENT-OFF* */
  78 typedef CLIB_PACKED(struct
  79 {
  80   ip4_header_t ip4;            /* 20 bytes */
  81   udp_header_t udp;            /* 8 bytes */
  82   gtpu_header_t gtpu;          /* 8 bytes */
  83 }) ip4_gtpu_header_t;
  84 /* *INDENT-ON* */
  85
  86 /* *INDENT-OFF* */
  87 typedef CLIB_PACKED(struct
  88 {
  89   ip6_header_t ip6;            /* 40 bytes */
  90   udp_header_t udp;            /* 8 bytes */
  91   gtpu_header_t gtpu;     /* 8 bytes */
  92 }) ip6_gtpu_header_t;
  93 /* *INDENT-ON* */
  94
  95 /* *INDENT-OFF* */
  96 typedef CLIB_PACKED
  97 (struct {
  98   /*
  99    * Key fields: ip src and gtpu teid on incoming gtpu packet
 100    * all fields in NET byte order
 101    */
 102   union {
 103     struct {
 104       u32 src;
 105       u32 teid;
 106     };
 107     u64 as_u64;
 108   };
 109 }) gtpu4_tunnel_key_t;
 110 /* *INDENT-ON* */
 111
 112 /* *INDENT-OFF* */
 113 typedef CLIB_PACKED
 114 (struct {
 115   /*
 116    * Key fields: ip src and gtpu teid on incoming gtpu packet
 117    * all fields in NET byte order
 118    */
 119   ip6_address_t src;
 120   u32 teid;
 121 }) gtpu6_tunnel_key_t;
 122 /* *INDENT-ON* */
 123
 124 typedef struct
 125 {
 126   /* Required for pool_get_aligned  */
 127   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 128
 129   /* Rewrite string */
 130   u8 *rewrite;
 131
 132   /* FIB DPO for IP forwarding of gtpu encap packet */
 133   dpo_id_t next_dpo;
 134
 135   /* gtpu teid in HOST byte order */
 136   u32 teid;
 137
 138   /* tunnel src and dst addresses */
 139   ip46_address_t src;
 140   ip46_address_t dst;
 141
 142   /* mcast packet output intf index (used only if dst is mcast) */
 143   u32 mcast_sw_if_index;
 144
 145   /* decap next index */
 146   u32 decap_next_index;
 147
 148   /* The FIB index for src/dst addresses */
 149   u32 encap_fib_index;
 150
 151   /* vnet intfc index */
 152   u32 sw_if_index;
 153   u32 hw_if_index;
 154
 155   /**
 156    * Linkage into the FIB object graph
 157    */
 158   fib_node_t node;
 159
 160   /*
 161    * The FIB entry for (depending on gtpu tunnel is unicast or mcast)
 162    * sending unicast gtpu encap packets or receiving mcast gtpu packets
 163    */
 164   fib_node_index_t fib_entry_index;
 165   adj_index_t mcast_adj_index;
 166
 167   /**
 168    * The tunnel is a child of the FIB entry for its destination. This is
 169    * so it receives updates when the forwarding information for that entry
 170    * changes.
 171    * The tunnels sibling index on the FIB entry's dependency list.
 172    */
 173   u32 sibling_index;
 174 } gtpu_tunnel_t;
 175
 176 #define foreach_gtpu_input_next        \
 177 _(DROP, "error-drop")                  \
 178 _(L2_INPUT, "l2-input")                \
 179 _(IP4_INPUT,  "ip4-input")             \
 180 _(IP6_INPUT, "ip6-input" )
 181
 182 typedef enum
 183 {
 184 #define _(s,n) GTPU_INPUT_NEXT_##s,
 185   foreach_gtpu_input_next
 186 #undef _
 187     GTPU_INPUT_N_NEXT,
 188 } gtpu_input_next_t;
 189
 190 typedef enum
 191 {
 192 #define gtpu_error(n,s) GTPU_ERROR_##n,
 193 #include <gtpu/gtpu_error.def>
 194 #undef gtpu_error
 195   GTPU_N_ERROR,
 196 } gtpu_input_error_t;
 197
 198 typedef struct
 199 {
 200   /* vector of encap tunnel instances */
 201   gtpu_tunnel_t *tunnels;
 202
 203   /* lookup tunnel by key */
 204   uword *gtpu4_tunnel_by_key;   /* keyed on ipv4.dst + teid */
 205   uword *gtpu6_tunnel_by_key;   /* keyed on ipv6.dst + teid */
 206
 207   /* local VTEP IPs ref count used by gtpu-bypass node to check if
 208      received gtpu packet DIP matches any local VTEP address */
 209   uword *vtep4;                 /* local ip4 VTEPs keyed on their ip4 addr */
 210   uword *vtep6;                 /* local ip6 VTEPs keyed on their ip6 addr */
 211
 212   /* mcast shared info */
 213   uword *mcast_shared;          /* keyed on mcast ip46 addr */
 214
 215   /* Free vlib hw_if_indices */
 216   u32 *free_gtpu_tunnel_hw_if_indices;
 217
 218   /* Mapping from sw_if_index to tunnel index */
 219   u32 *tunnel_index_by_sw_if_index;
 220
 221   /**
 222    * Node type for registering to fib changes.
 223    */
 224   fib_node_type_t fib_node_type;
 225
 226   /* API message ID base */
 227   u16 msg_id_base;
 228
 229   /* convenience */
 230   vlib_main_t *vlib_main;
 231   vnet_main_t *vnet_main;
 232 } gtpu_main_t;
 233
 234 extern gtpu_main_t gtpu_main;
 235
 236 extern vlib_node_registration_t gtpu4_input_node;
 237 extern vlib_node_registration_t gtpu6_input_node;
 238 extern vlib_node_registration_t gtpu4_encap_node;
 239 extern vlib_node_registration_t gtpu6_encap_node;
 240
 241 u8 *format_gtpu_encap_trace (u8 * s, va_list * args);
 242
 243 typedef struct
 244 {
 245   u8 is_add;
 246   u8 is_ip6;
 247   ip46_address_t src, dst;
 248   u32 mcast_sw_if_index;
 249   u32 encap_fib_index;
 250   u32 decap_next_index;
 251   u32 teid;
 252 } vnet_gtpu_add_del_tunnel_args_t;
 253
 254 int vnet_gtpu_add_del_tunnel
 255   (vnet_gtpu_add_del_tunnel_args_t * a, u32 * sw_if_indexp);
 256
 257 void vnet_int_gtpu_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable);
 258 #endif /* included_vnet_gtpu_h */
 259
 260
 261 /*
 262  * fd.io coding-style-patch-verification: ON
 263  *
 264  * Local Variables:
 265  * eval: (c-set-style "gnu")
 266  * End:
 267  */