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