src/plugins/gtpu/gtpu.c

   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 #include <stdint.h>
  18 #include <net/if.h>
  19 #include <sys/ioctl.h>
  20 #include <inttypes.h>
  21
  22 #include <vlib/vlib.h>
  23 #include <vlib/unix/unix.h>
  24 #include <vnet/ethernet/ethernet.h>
  25 #include <vnet/fib/fib_entry.h>
  26 #include <vnet/fib/fib_table.h>
  27 #include <vnet/mfib/mfib_table.h>
  28 #include <vnet/adj/adj_mcast.h>
  29 #include <vnet/dpo/dpo.h>
  30 #include <vnet/plugin/plugin.h>
  31 #include <vpp/app/version.h>
  32 #include <gtpu/gtpu.h>
  33
  34
  35 gtpu_main_t gtpu_main;
  36
  37 /* *INDENT-OFF* */
  38 VNET_FEATURE_INIT (ip4_gtpu_bypass, static) = {
  39   .arc_name = "ip4-unicast",
  40   .node_name = "ip4-gtpu-bypass",
  41   .runs_before = VNET_FEATURES ("ip4-lookup"),
  42 };
  43
  44 VNET_FEATURE_INIT (ip6_gtpu_bypass, static) = {
  45   .arc_name = "ip6-unicast",
  46   .node_name = "ip6-gtpu-bypass",
  47   .runs_before = VNET_FEATURES ("ip6-lookup"),
  48 };
  49 /* *INDENT-on* */
  50
  51 static u8 *
  52 format_decap_next (u8 * s, va_list * args)
  53 {
  54   u32 next_index = va_arg (*args, u32);
  55
  56   switch (next_index)
  57     {
  58     case GTPU_INPUT_NEXT_DROP:
  59       return format (s, "drop");
  60     case GTPU_INPUT_NEXT_L2_INPUT:
  61       return format (s, "l2");
  62     case GTPU_INPUT_NEXT_IP4_INPUT:
  63       return format (s, "ip4");
  64     case GTPU_INPUT_NEXT_IP6_INPUT:
  65       return format (s, "ip6");
  66     default:
  67       return format (s, "index %d", next_index);
  68     }
  69   return s;
  70 }
  71
  72 u8 *
  73 format_gtpu_tunnel (u8 * s, va_list * args)
  74 {
  75   gtpu_tunnel_t *t = va_arg (*args, gtpu_tunnel_t *);
  76   gtpu_main_t *ngm = &gtpu_main;
  77
  78   s = format (s, "[%d] src %U dst %U teid %d sw_if_index %d ",
  79               t - ngm->tunnels,
  80               format_ip46_address, &t->src, IP46_TYPE_ANY,
  81               format_ip46_address, &t->dst, IP46_TYPE_ANY,
  82               t->teid, t->sw_if_index);
  83
  84   if (ip46_address_is_multicast (&t->dst))
  85     s = format (s, "mcast_sw_if_index %d ", t->mcast_sw_if_index);
  86
  87   s = format (s, "encap_fib_index %d fib_entry_index %d decap_next %U\n",
  88               t->encap_fib_index, t->fib_entry_index,
  89               format_decap_next, t->decap_next_index);
  90   return s;
  91 }
  92
  93 static u8 *
  94 format_gtpu_name (u8 * s, va_list * args)
  95 {
  96   u32 dev_instance = va_arg (*args, u32);
  97   return format (s, "gtpu_tunnel%d", dev_instance);
  98 }
  99
 100 static uword
 101 dummy_interface_tx (vlib_main_t * vm,
 102                     vlib_node_runtime_t * node, vlib_frame_t * frame)
 103 {
 104   clib_warning ("you shouldn't be here, leaking buffers...");
 105   return frame->n_vectors;
 106 }
 107
 108 static clib_error_t *
 109 gtpu_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
 110 {
 111   u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
 112     VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
 113   vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
 114
 115   return /* no error */ 0;
 116 }
 117
 118 /* *INDENT-OFF* */
 119 VNET_DEVICE_CLASS (gtpu_device_class,static) = {
 120   .name = "GTPU",
 121   .format_device_name = format_gtpu_name,
 122   .format_tx_trace = format_gtpu_encap_trace,
 123   .tx_function = dummy_interface_tx,
 124   .admin_up_down_function = gtpu_interface_admin_up_down,
 125 };
 126 /* *INDENT-ON* */
 127
 128 static u8 *
 129 format_gtpu_header_with_length (u8 * s, va_list * args)
 130 {
 131   u32 dev_instance = va_arg (*args, u32);
 132   s = format (s, "unimplemented dev %u", dev_instance);
 133   return s;
 134 }
 135
 136 /* *INDENT-OFF* */
 137 VNET_HW_INTERFACE_CLASS (gtpu_hw_class) =
 138 {
 139   .name = "GTPU",
 140   .format_header = format_gtpu_header_with_length,
 141   .build_rewrite = default_build_rewrite,
 142   .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
 143 };
 144 /* *INDENT-ON* */
 145
 146 static void
 147 gtpu_tunnel_restack_dpo (gtpu_tunnel_t * t)
 148 {
 149   dpo_id_t dpo = DPO_INVALID;
 150   u32 encap_index = ip46_address_is_ip4 (&t->dst) ?
 151     gtpu4_encap_node.index : gtpu6_encap_node.index;
 152   fib_forward_chain_type_t forw_type = ip46_address_is_ip4 (&t->dst) ?
 153     FIB_FORW_CHAIN_TYPE_UNICAST_IP4 : FIB_FORW_CHAIN_TYPE_UNICAST_IP6;
 154
 155   fib_entry_contribute_forwarding (t->fib_entry_index, forw_type, &dpo);
 156   dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
 157   dpo_reset (&dpo);
 158 }
 159
 160 static gtpu_tunnel_t *
 161 gtpu_tunnel_from_fib_node (fib_node_t * node)
 162 {
 163   return ((gtpu_tunnel_t *) (((char *) node) -
 164                              STRUCT_OFFSET_OF (gtpu_tunnel_t, node)));
 165 }
 166
 167 /**
 168  * Function definition to backwalk a FIB node -
 169  * Here we will restack the new dpo of GTPU DIP to encap node.
 170  */
 171 static fib_node_back_walk_rc_t
 172 gtpu_tunnel_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
 173 {
 174   gtpu_tunnel_restack_dpo (gtpu_tunnel_from_fib_node (node));
 175   return (FIB_NODE_BACK_WALK_CONTINUE);
 176 }
 177
 178 /**
 179  * Function definition to get a FIB node from its index
 180  */
 181 static fib_node_t *
 182 gtpu_tunnel_fib_node_get (fib_node_index_t index)
 183 {
 184   gtpu_tunnel_t *t;
 185   gtpu_main_t *gtm = &gtpu_main;
 186
 187   t = pool_elt_at_index (gtm->tunnels, index);
 188
 189   return (&t->node);
 190 }
 191
 192 /**
 193  * Function definition to inform the FIB node that its last lock has gone.
 194  */
 195 static void
 196 gtpu_tunnel_last_lock_gone (fib_node_t * node)
 197 {
 198   /*
 199    * The GTPU tunnel is a root of the graph. As such
 200    * it never has children and thus is never locked.
 201    */
 202   ASSERT (0);
 203 }
 204
 205 /*
 206  * Virtual function table registered by GTPU tunnels
 207  * for participation in the FIB object graph.
 208  */
 209 const static fib_node_vft_t gtpu_vft = {
 210   .fnv_get = gtpu_tunnel_fib_node_get,
 211   .fnv_last_lock = gtpu_tunnel_last_lock_gone,
 212   .fnv_back_walk = gtpu_tunnel_back_walk,
 213 };
 214
 215
 216 #define foreach_copy_field                      \
 217 _(teid)                                          \
 218 _(mcast_sw_if_index)                            \
 219 _(encap_fib_index)                              \
 220 _(decap_next_index)                             \
 221 _(src)                                          \
 222 _(dst)
 223
 224 static void
 225 ip_udp_gtpu_rewrite (gtpu_tunnel_t * t, bool is_ip6)
 226 {
 227   union
 228   {
 229     ip4_gtpu_header_t *h4;
 230     ip6_gtpu_header_t *h6;
 231     u8 *rw;
 232   } r =
 233   {
 234   .rw = 0};
 235   int len = is_ip6 ? sizeof *r.h6 : sizeof *r.h4;
 236
 237   vec_validate_aligned (r.rw, len - 1, CLIB_CACHE_LINE_BYTES);
 238
 239   udp_header_t *udp;
 240   gtpu_header_t *gtpu;
 241   /* Fixed portion of the (outer) ip header */
 242   if (!is_ip6)
 243     {
 244       ip4_header_t *ip = &r.h4->ip4;
 245       udp = &r.h4->udp;
 246       gtpu = &r.h4->gtpu;
 247       ip->ip_version_and_header_length = 0x45;
 248       ip->ttl = 254;
 249       ip->protocol = IP_PROTOCOL_UDP;
 250
 251       ip->src_address = t->src.ip4;
 252       ip->dst_address = t->dst.ip4;
 253
 254       /* we fix up the ip4 header length and checksum after-the-fact */
 255       ip->checksum = ip4_header_checksum (ip);
 256     }
 257   else
 258     {
 259       ip6_header_t *ip = &r.h6->ip6;
 260       udp = &r.h6->udp;
 261       gtpu = &r.h6->gtpu;
 262       ip->ip_version_traffic_class_and_flow_label =
 263         clib_host_to_net_u32 (6 << 28);
 264       ip->hop_limit = 255;
 265       ip->protocol = IP_PROTOCOL_UDP;
 266
 267       ip->src_address = t->src.ip6;
 268       ip->dst_address = t->dst.ip6;
 269     }
 270
 271   /* UDP header, randomize src port on something, maybe? */
 272   udp->src_port = clib_host_to_net_u16 (2152);
 273   udp->dst_port = clib_host_to_net_u16 (UDP_DST_PORT_GTPU);
 274
 275   /* GTPU header */
 276   gtpu->ver_flags = GTPU_V1_VER | GTPU_PT_GTP;
 277   gtpu->type = GTPU_TYPE_GTPU;
 278   gtpu->teid = clib_host_to_net_u32 (t->teid);
 279
 280   t->rewrite = r.rw;
 281   /* Now only support 8-byte gtpu header. TBD */
 282   _vec_len (t->rewrite) = sizeof (ip4_gtpu_header_t) - 4;
 283
 284   return;
 285 }
 286
 287 static bool
 288 gtpu_decap_next_is_valid (gtpu_main_t * gtm, u32 is_ip6, u32 decap_next_index)
 289 {
 290   vlib_main_t *vm = gtm->vlib_main;
 291   u32 input_idx = (!is_ip6) ? gtpu4_input_node.index : gtpu6_input_node.index;
 292   vlib_node_runtime_t *r = vlib_node_get_runtime (vm, input_idx);
 293
 294   return decap_next_index < r->n_next_nodes;
 295 }
 296
 297 static uword
 298 vtep_addr_ref (ip46_address_t * ip)
 299 {
 300   uword *vtep = ip46_address_is_ip4 (ip) ?
 301     hash_get (gtpu_main.vtep4, ip->ip4.as_u32) :
 302     hash_get_mem (gtpu_main.vtep6, &ip->ip6);
 303   if (vtep)
 304     return ++(*vtep);
 305   ip46_address_is_ip4 (ip) ?
 306     hash_set (gtpu_main.vtep4, ip->ip4.as_u32, 1) :
 307     hash_set_mem_alloc (&gtpu_main.vtep6, &ip->ip6, 1);
 308   return 1;
 309 }
 310
 311 static uword
 312 vtep_addr_unref (ip46_address_t * ip)
 313 {
 314   uword *vtep = ip46_address_is_ip4 (ip) ?
 315     hash_get (gtpu_main.vtep4, ip->ip4.as_u32) :
 316     hash_get_mem (gtpu_main.vtep6, &ip->ip6);
 317   ASSERT (vtep);
 318   if (--(*vtep) != 0)
 319     return *vtep;
 320   ip46_address_is_ip4 (ip) ?
 321     hash_unset (gtpu_main.vtep4, ip->ip4.as_u32) :
 322     hash_unset_mem_free (&gtpu_main.vtep6, &ip->ip6);
 323   return 0;
 324 }
 325
 326 typedef CLIB_PACKED (union
 327                      {
 328                      struct
 329                      {
 330                      fib_node_index_t mfib_entry_index;
 331                      adj_index_t mcast_adj_index;
 332                      }; u64 as_u64;
 333                      }) mcast_shared_t;
 334
 335 static inline mcast_shared_t
 336 mcast_shared_get (ip46_address_t * ip)
 337 {
 338   ASSERT (ip46_address_is_multicast (ip));
 339   uword *p = hash_get_mem (gtpu_main.mcast_shared, ip);
 340   ASSERT (p);
 341   return (mcast_shared_t)
 342   {
 343   .as_u64 = *p};
 344 }
 345
 346 static inline void
 347 mcast_shared_add (ip46_address_t * dst, fib_node_index_t mfei, adj_index_t ai)
 348 {
 349   mcast_shared_t new_ep = {
 350     .mcast_adj_index = ai,
 351     .mfib_entry_index = mfei,
 352   };
 353
 354   hash_set_mem_alloc (&gtpu_main.mcast_shared, dst, new_ep.as_u64);
 355 }
 356
 357 static inline void
 358 mcast_shared_remove (ip46_address_t * dst)
 359 {
 360   mcast_shared_t ep = mcast_shared_get (dst);
 361
 362   adj_unlock (ep.mcast_adj_index);
 363   mfib_table_entry_delete_index (ep.mfib_entry_index, MFIB_SOURCE_GTPU);
 364
 365   hash_unset_mem_free (&gtpu_main.mcast_shared, dst);
 366 }
 367
 368 static inline fib_protocol_t
 369 fib_ip_proto (bool is_ip6)
 370 {
 371   return (is_ip6) ? FIB_PROTOCOL_IP6 : FIB_PROTOCOL_IP4;
 372 }
 373
 374 int vnet_gtpu_add_del_tunnel
 375   (vnet_gtpu_add_del_tunnel_args_t * a, u32 * sw_if_indexp)
 376 {
 377   gtpu_main_t *gtm = &gtpu_main;
 378   gtpu_tunnel_t *t = 0;
 379   vnet_main_t *vnm = gtm->vnet_main;
 380   uword *p;
 381   u32 hw_if_index = ~0;
 382   u32 sw_if_index = ~0;
 383   gtpu4_tunnel_key_t key4;
 384   gtpu6_tunnel_key_t key6;
 385   u32 is_ip6 = a->is_ip6;
 386
 387   if (!is_ip6)
 388     {
 389       key4.src = a->dst.ip4.as_u32;     /* decap src in key is encap dst in config */
 390       key4.teid = clib_host_to_net_u32 (a->teid);
 391       p = hash_get (gtm->gtpu4_tunnel_by_key, key4.as_u64);
 392     }
 393   else
 394     {
 395       key6.src = a->dst.ip6;
 396       key6.teid = clib_host_to_net_u32 (a->teid);
 397       p = hash_get_mem (gtm->gtpu6_tunnel_by_key, &key6);
 398     }
 399
 400   if (a->is_add)
 401     {
 402       l2input_main_t *l2im = &l2input_main;
 403
 404       /* adding a tunnel: tunnel must not already exist */
 405       if (p)
 406         return VNET_API_ERROR_TUNNEL_EXIST;
 407
 408       /*if not set explicitly, default to l2 */
 409       if (a->decap_next_index == ~0)
 410         a->decap_next_index = GTPU_INPUT_NEXT_L2_INPUT;
 411       if (!gtpu_decap_next_is_valid (gtm, is_ip6, a->decap_next_index))
 412         return VNET_API_ERROR_INVALID_DECAP_NEXT;
 413
 414       pool_get_aligned (gtm->tunnels, t, CLIB_CACHE_LINE_BYTES);
 415       memset (t, 0, sizeof (*t));
 416
 417       /* copy from arg structure */
 418 #define _(x) t->x = a->x;
 419       foreach_copy_field;
 420 #undef _
 421
 422       ip_udp_gtpu_rewrite (t, is_ip6);
 423
 424       /* copy the key */
 425       if (is_ip6)
 426         hash_set_mem_alloc (&gtm->gtpu6_tunnel_by_key, &key6,
 427                             t - gtm->tunnels);
 428       else
 429         hash_set (gtm->gtpu4_tunnel_by_key, key4.as_u64, t - gtm->tunnels);
 430
 431       vnet_hw_interface_t *hi;
 432       if (vec_len (gtm->free_gtpu_tunnel_hw_if_indices) > 0)
 433         {
 434           vnet_interface_main_t *im = &vnm->interface_main;
 435           hw_if_index = gtm->free_gtpu_tunnel_hw_if_indices
 436             [vec_len (gtm->free_gtpu_tunnel_hw_if_indices) - 1];
 437           _vec_len (gtm->free_gtpu_tunnel_hw_if_indices) -= 1;
 438
 439           hi = vnet_get_hw_interface (vnm, hw_if_index);
 440           hi->dev_instance = t - gtm->tunnels;
 441           hi->hw_instance = hi->dev_instance;
 442
 443           /* clear old stats of freed tunnel before reuse */
 444           sw_if_index = hi->sw_if_index;
 445           vnet_interface_counter_lock (im);
 446           vlib_zero_combined_counter
 447             (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX],
 448              sw_if_index);
 449           vlib_zero_combined_counter (&im->combined_sw_if_counters
 450                                       [VNET_INTERFACE_COUNTER_RX],
 451                                       sw_if_index);
 452           vlib_zero_simple_counter (&im->sw_if_counters
 453                                     [VNET_INTERFACE_COUNTER_DROP],
 454                                     sw_if_index);
 455           vnet_interface_counter_unlock (im);
 456         }
 457       else
 458         {
 459           hw_if_index = vnet_register_interface
 460             (vnm, gtpu_device_class.index, t - gtm->tunnels,
 461              gtpu_hw_class.index, t - gtm->tunnels);
 462           hi = vnet_get_hw_interface (vnm, hw_if_index);
 463         }
 464
 465       t->hw_if_index = hw_if_index;
 466       t->sw_if_index = sw_if_index = hi->sw_if_index;
 467
 468       vec_validate_init_empty (gtm->tunnel_index_by_sw_if_index, sw_if_index,
 469                                ~0);
 470       gtm->tunnel_index_by_sw_if_index[sw_if_index] = t - gtm->tunnels;
 471
 472       /* setup l2 input config with l2 feature and bd 0 to drop packet */
 473       vec_validate (l2im->configs, sw_if_index);
 474       l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
 475       l2im->configs[sw_if_index].bd_index = 0;
 476
 477       vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
 478       si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
 479       vnet_sw_interface_set_flags (vnm, sw_if_index,
 480                                    VNET_SW_INTERFACE_FLAG_ADMIN_UP);
 481
 482       fib_node_init (&t->node, gtm->fib_node_type);
 483       fib_prefix_t tun_dst_pfx;
 484       u32 encap_index = !is_ip6 ?
 485         gtpu4_encap_node.index : gtpu6_encap_node.index;
 486       vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
 487
 488       fib_prefix_from_ip46_addr (&t->dst, &tun_dst_pfx);
 489       if (!ip46_address_is_multicast (&t->dst))
 490         {
 491           /* Unicast tunnel -
 492            * source the FIB entry for the tunnel's destination
 493            * and become a child thereof. The tunnel will then get poked
 494            * when the forwarding for the entry updates, and the tunnel can
 495            * re-stack accordingly
 496            */
 497           vtep_addr_ref (&t->src);
 498           t->fib_entry_index = fib_table_entry_special_add
 499             (t->encap_fib_index, &tun_dst_pfx, FIB_SOURCE_RR,
 500              FIB_ENTRY_FLAG_NONE);
 501           t->sibling_index = fib_entry_child_add
 502             (t->fib_entry_index, gtm->fib_node_type, t - gtm->tunnels);
 503           gtpu_tunnel_restack_dpo (t);
 504         }
 505       else
 506         {
 507           /* Multicast tunnel -
 508            * as the same mcast group can be used for mutiple mcast tunnels
 509            * with different VNIs, create the output fib adjecency only if
 510            * it does not already exist
 511            */
 512           fib_protocol_t fp = fib_ip_proto (is_ip6);
 513
 514           if (vtep_addr_ref (&t->dst) == 1)
 515             {
 516               fib_node_index_t mfei;
 517               adj_index_t ai;
 518               fib_route_path_t path = {
 519                 .frp_proto = fib_proto_to_dpo (fp),
 520                 .frp_addr = zero_addr,
 521                 .frp_sw_if_index = 0xffffffff,
 522                 .frp_fib_index = ~0,
 523                 .frp_weight = 0,
 524                 .frp_flags = FIB_ROUTE_PATH_LOCAL,
 525               };
 526               const mfib_prefix_t mpfx = {
 527                 .fp_proto = fp,
 528                 .fp_len = (is_ip6 ? 128 : 32),
 529                 .fp_grp_addr = tun_dst_pfx.fp_addr,
 530               };
 531
 532               /*
 533                * Setup the (*,G) to receive traffic on the mcast group
 534                *  - the forwarding interface is for-us
 535                *  - the accepting interface is that from the API
 536                */
 537               mfib_table_entry_path_update (t->encap_fib_index,
 538                                             &mpfx,
 539                                             MFIB_SOURCE_GTPU,
 540                                             &path, MFIB_ITF_FLAG_FORWARD);
 541
 542               path.frp_sw_if_index = a->mcast_sw_if_index;
 543               path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
 544               mfei = mfib_table_entry_path_update (t->encap_fib_index,
 545                                                    &mpfx,
 546                                                    MFIB_SOURCE_GTPU,
 547                                                    &path,
 548                                                    MFIB_ITF_FLAG_ACCEPT);
 549
 550               /*
 551                * Create the mcast adjacency to send traffic to the group
 552                */
 553               ai = adj_mcast_add_or_lock (fp,
 554                                           fib_proto_to_link (fp),
 555                                           a->mcast_sw_if_index);
 556
 557               /*
 558                * create a new end-point
 559                */
 560               mcast_shared_add (&t->dst, mfei, ai);
 561             }
 562
 563           dpo_id_t dpo = DPO_INVALID;
 564           mcast_shared_t ep = mcast_shared_get (&t->dst);
 565
 566           /* Stack shared mcast dst mac addr rewrite on encap */
 567           dpo_set (&dpo, DPO_ADJACENCY_MCAST,
 568                    fib_proto_to_dpo (fp), ep.mcast_adj_index);
 569
 570           dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
 571
 572           dpo_reset (&dpo);
 573           flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
 574         }
 575
 576       /* Set gtpu tunnel output node */
 577       hi->output_node_index = encap_index;
 578
 579       vnet_get_sw_interface (vnet_get_main (), sw_if_index)->flood_class =
 580         flood_class;
 581     }
 582   else
 583     {
 584       /* deleting a tunnel: tunnel must exist */
 585       if (!p)
 586         return VNET_API_ERROR_NO_SUCH_ENTRY;
 587
 588       t = pool_elt_at_index (gtm->tunnels, p[0]);
 589       sw_if_index = t->sw_if_index;
 590
 591       vnet_sw_interface_set_flags (vnm, t->sw_if_index, 0 /* down */ );
 592       vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, t->sw_if_index);
 593       si->flags |= VNET_SW_INTERFACE_FLAG_HIDDEN;
 594
 595       /* make sure tunnel is removed from l2 bd or xconnect */
 596       set_int_l2_mode (gtm->vlib_main, vnm, MODE_L3, t->sw_if_index, 0, 0, 0,
 597                        0);
 598       vec_add1 (gtm->free_gtpu_tunnel_hw_if_indices, t->hw_if_index);
 599
 600       gtm->tunnel_index_by_sw_if_index[t->sw_if_index] = ~0;
 601
 602       if (!is_ip6)
 603         hash_unset (gtm->gtpu4_tunnel_by_key, key4.as_u64);
 604       else
 605         hash_unset_mem_free (&gtm->gtpu6_tunnel_by_key, &key6);
 606
 607       if (!ip46_address_is_multicast (&t->dst))
 608         {
 609           vtep_addr_unref (&t->src);
 610           fib_entry_child_remove (t->fib_entry_index, t->sibling_index);
 611           fib_table_entry_delete_index (t->fib_entry_index, FIB_SOURCE_RR);
 612         }
 613       else if (vtep_addr_unref (&t->dst) == 0)
 614         {
 615           mcast_shared_remove (&t->dst);
 616         }
 617
 618       fib_node_deinit (&t->node);
 619       vec_free (t->rewrite);
 620       pool_put (gtm->tunnels, t);
 621     }
 622
 623   if (sw_if_indexp)
 624     *sw_if_indexp = sw_if_index;
 625
 626   return 0;
 627 }
 628
 629 static uword
 630 get_decap_next_for_node (u32 node_index, u32 ipv4_set)
 631 {
 632   gtpu_main_t *gtm = &gtpu_main;
 633   vlib_main_t *vm = gtm->vlib_main;
 634   uword input_node = (ipv4_set) ? gtpu4_input_node.index :
 635     gtpu6_input_node.index;
 636
 637   return vlib_node_add_next (vm, input_node, node_index);
 638 }
 639
 640 static uword
 641 unformat_decap_next (unformat_input_t * input, va_list * args)
 642 {
 643   u32 *result = va_arg (*args, u32 *);
 644   u32 ipv4_set = va_arg (*args, int);
 645   gtpu_main_t *gtm = &gtpu_main;
 646   vlib_main_t *vm = gtm->vlib_main;
 647   u32 node_index;
 648   u32 tmp;
 649
 650   if (unformat (input, "l2"))
 651     *result = GTPU_INPUT_NEXT_L2_INPUT;
 652   else if (unformat (input, "ip4"))
 653     *result = GTPU_INPUT_NEXT_IP4_INPUT;
 654   else if (unformat (input, "ip6"))
 655     *result = GTPU_INPUT_NEXT_IP6_INPUT;
 656   else if (unformat (input, "node %U", unformat_vlib_node, vm, &node_index))
 657     *result = get_decap_next_for_node (node_index, ipv4_set);
 658   else if (unformat (input, "%d", &tmp))
 659     *result = tmp;
 660   else
 661     return 0;
 662
 663   return 1;
 664 }
 665
 666 static clib_error_t *
 667 gtpu_add_del_tunnel_command_fn (vlib_main_t * vm,
 668                                 unformat_input_t * input,
 669                                 vlib_cli_command_t * cmd)
 670 {
 671   unformat_input_t _line_input, *line_input = &_line_input;
 672   ip46_address_t src, dst;
 673   u8 is_add = 1;
 674   u8 src_set = 0;
 675   u8 dst_set = 0;
 676   u8 grp_set = 0;
 677   u8 ipv4_set = 0;
 678   u8 ipv6_set = 0;
 679   u32 encap_fib_index = 0;
 680   u32 mcast_sw_if_index = ~0;
 681   u32 decap_next_index = GTPU_INPUT_NEXT_L2_INPUT;
 682   u32 teid = 0;
 683   u32 tmp;
 684   int rv;
 685   vnet_gtpu_add_del_tunnel_args_t _a, *a = &_a;
 686   u32 tunnel_sw_if_index;
 687   clib_error_t *error = NULL;
 688
 689   /* Cant "universally zero init" (={0}) due to GCC bug 53119 */
 690   memset (&src, 0, sizeof src);
 691   memset (&dst, 0, sizeof dst);
 692
 693   /* Get a line of input. */
 694   if (!unformat_user (input, unformat_line_input, line_input))
 695     return 0;
 696
 697   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 698     {
 699       if (unformat (line_input, "del"))
 700         {
 701           is_add = 0;
 702         }
 703       else if (unformat (line_input, "src %U",
 704                          unformat_ip4_address, &src.ip4))
 705         {
 706           src_set = 1;
 707           ipv4_set = 1;
 708         }
 709       else if (unformat (line_input, "dst %U",
 710                          unformat_ip4_address, &dst.ip4))
 711         {
 712           dst_set = 1;
 713           ipv4_set = 1;
 714         }
 715       else if (unformat (line_input, "src %U",
 716                          unformat_ip6_address, &src.ip6))
 717         {
 718           src_set = 1;
 719           ipv6_set = 1;
 720         }
 721       else if (unformat (line_input, "dst %U",
 722                          unformat_ip6_address, &dst.ip6))
 723         {
 724           dst_set = 1;
 725           ipv6_set = 1;
 726         }
 727       else if (unformat (line_input, "group %U %U",
 728                          unformat_ip4_address, &dst.ip4,
 729                          unformat_vnet_sw_interface,
 730                          vnet_get_main (), &mcast_sw_if_index))
 731         {
 732           grp_set = dst_set = 1;
 733           ipv4_set = 1;
 734         }
 735       else if (unformat (line_input, "group %U %U",
 736                          unformat_ip6_address, &dst.ip6,
 737                          unformat_vnet_sw_interface,
 738                          vnet_get_main (), &mcast_sw_if_index))
 739         {
 740           grp_set = dst_set = 1;
 741           ipv6_set = 1;
 742         }
 743       else if (unformat (line_input, "encap-vrf-id %d", &tmp))
 744         {
 745           encap_fib_index = fib_table_find (fib_ip_proto (ipv6_set), tmp);
 746           if (encap_fib_index == ~0)
 747             {
 748               error =
 749                 clib_error_return (0, "nonexistent encap-vrf-id %d", tmp);
 750               goto done;
 751             }
 752         }
 753       else if (unformat (line_input, "decap-next %U", unformat_decap_next,
 754                          &decap_next_index, ipv4_set))
 755         ;
 756       else if (unformat (line_input, "teid %d", &teid))
 757         ;
 758       else
 759         {
 760           error = clib_error_return (0, "parse error: '%U'",
 761                                      format_unformat_error, line_input);
 762           goto done;
 763         }
 764     }
 765
 766   if (src_set == 0)
 767     {
 768       error = clib_error_return (0, "tunnel src address not specified");
 769       goto done;
 770     }
 771
 772   if (dst_set == 0)
 773     {
 774       error = clib_error_return (0, "tunnel dst address not specified");
 775       goto done;
 776     }
 777
 778   if (grp_set && !ip46_address_is_multicast (&dst))
 779     {
 780       error = clib_error_return (0, "tunnel group address not multicast");
 781       goto done;
 782     }
 783
 784   if (grp_set == 0 && ip46_address_is_multicast (&dst))
 785     {
 786       error = clib_error_return (0, "dst address must be unicast");
 787       goto done;
 788     }
 789
 790   if (grp_set && mcast_sw_if_index == ~0)
 791     {
 792       error = clib_error_return (0, "tunnel nonexistent multicast device");
 793       goto done;
 794     }
 795
 796   if (ipv4_set && ipv6_set)
 797     {
 798       error = clib_error_return (0, "both IPv4 and IPv6 addresses specified");
 799       goto done;
 800     }
 801
 802   if (ip46_address_cmp (&src, &dst) == 0)
 803     {
 804       error = clib_error_return (0, "src and dst addresses are identical");
 805       goto done;
 806     }
 807
 808   if (decap_next_index == ~0)
 809     {
 810       error = clib_error_return (0, "next node not found");
 811       goto done;
 812     }
 813
 814   memset (a, 0, sizeof (*a));
 815
 816   a->is_add = is_add;
 817   a->is_ip6 = ipv6_set;
 818
 819 #define _(x) a->x = x;
 820   foreach_copy_field;
 821 #undef _
 822
 823   rv = vnet_gtpu_add_del_tunnel (a, &tunnel_sw_if_index);
 824
 825   switch (rv)
 826     {
 827     case 0:
 828       if (is_add)
 829         vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
 830                          vnet_get_main (), tunnel_sw_if_index);
 831       break;
 832
 833     case VNET_API_ERROR_TUNNEL_EXIST:
 834       error = clib_error_return (0, "tunnel already exists...");
 835       goto done;
 836
 837     case VNET_API_ERROR_NO_SUCH_ENTRY:
 838       error = clib_error_return (0, "tunnel does not exist...");
 839       goto done;
 840
 841     default:
 842       error = clib_error_return
 843         (0, "vnet_gtpu_add_del_tunnel returned %d", rv);
 844       goto done;
 845     }
 846
 847 done:
 848   unformat_free (line_input);
 849
 850   return error;
 851 }
 852
 853 /*?
 854  * Add or delete a GTPU Tunnel.
 855  *
 856  * GTPU provides the features needed to allow L2 bridge domains (BDs)
 857  * to span multiple servers. This is done by building an L2 overlay on
 858  * top of an L3 network underlay using GTPU tunnels.
 859  *
 860  * This makes it possible for servers to be co-located in the same data
 861  * center or be separated geographically as long as they are reachable
 862  * through the underlay L3 network.
 863  *
 864  * You can refer to this kind of L2 overlay bridge domain as a GTPU
 865  * (Virtual eXtensible VLAN) segment.
 866  *
 867  * @cliexpar
 868  * Example of how to create a GTPU Tunnel:
 869  * @cliexcmd{create gtpu tunnel src 10.0.3.1 dst 10.0.3.3 teid 13 encap-vrf-id 7}
 870  * Example of how to delete a GTPU Tunnel:
 871  * @cliexcmd{create gtpu tunnel src 10.0.3.1 dst 10.0.3.3 teid 13 del}
 872  ?*/
 873 /* *INDENT-OFF* */
 874 VLIB_CLI_COMMAND (create_gtpu_tunnel_command, static) = {
 875   .path = "create gtpu tunnel",
 876   .short_help =
 877   "create gtpu tunnel src <local-vtep-addr>"
 878   " {dst <remote-vtep-addr>|group <mcast-vtep-addr> <intf-name>} teid <nn>"
 879   " [encap-vrf-id <nn>] [decap-next [l2|ip4|ip6|node <name>]] [del]",
 880   .function = gtpu_add_del_tunnel_command_fn,
 881 };
 882 /* *INDENT-ON* */
 883
 884 static clib_error_t *
 885 show_gtpu_tunnel_command_fn (vlib_main_t * vm,
 886                              unformat_input_t * input,
 887                              vlib_cli_command_t * cmd)
 888 {
 889   gtpu_main_t *gtm = &gtpu_main;
 890   gtpu_tunnel_t *t;
 891
 892   if (pool_elts (gtm->tunnels) == 0)
 893     vlib_cli_output (vm, "No gtpu tunnels configured...");
 894
 895   pool_foreach (t, gtm->tunnels, (
 896                                    {
 897                                    vlib_cli_output (vm, "%U",
 898                                                     format_gtpu_tunnel, t);
 899                                    }
 900                 ));
 901
 902   return 0;
 903 }
 904
 905 /*?
 906  * Display all the GTPU Tunnel entries.
 907  *
 908  * @cliexpar
 909  * Example of how to display the GTPU Tunnel entries:
 910  * @cliexstart{show gtpu tunnel}
 911  * [0] src 10.0.3.1 dst 10.0.3.3 teid 13 encap_fib_index 0 sw_if_index 5 decap_next l2
 912  * @cliexend
 913  ?*/
 914 /* *INDENT-OFF* */
 915 VLIB_CLI_COMMAND (show_gtpu_tunnel_command, static) = {
 916     .path = "show gtpu tunnel",
 917     .short_help = "show gtpu tunnel",
 918     .function = show_gtpu_tunnel_command_fn,
 919 };
 920 /* *INDENT-ON* */
 921
 922 void
 923 vnet_int_gtpu_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable)
 924 {
 925   if (is_ip6)
 926     vnet_feature_enable_disable ("ip6-unicast", "ip6-gtpu-bypass",
 927                                  sw_if_index, is_enable, 0, 0);
 928   else
 929     vnet_feature_enable_disable ("ip4-unicast", "ip4-gtpu-bypass",
 930                                  sw_if_index, is_enable, 0, 0);
 931 }
 932
 933 static clib_error_t *
 934 set_ip_gtpu_bypass (u32 is_ip6,
 935                     unformat_input_t * input, vlib_cli_command_t * cmd)
 936 {
 937   unformat_input_t _line_input, *line_input = &_line_input;
 938   vnet_main_t *vnm = vnet_get_main ();
 939   clib_error_t *error = 0;
 940   u32 sw_if_index, is_enable;
 941
 942   sw_if_index = ~0;
 943   is_enable = 1;
 944
 945   if (!unformat_user (input, unformat_line_input, line_input))
 946     return 0;
 947
 948   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 949     {
 950       if (unformat_user
 951           (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
 952         ;
 953       else if (unformat (line_input, "del"))
 954         is_enable = 0;
 955       else
 956         {
 957           error = unformat_parse_error (line_input);
 958           goto done;
 959         }
 960     }
 961
 962   if (~0 == sw_if_index)
 963     {
 964       error = clib_error_return (0, "unknown interface `%U'",
 965                                  format_unformat_error, line_input);
 966       goto done;
 967     }
 968
 969   vnet_int_gtpu_bypass_mode (sw_if_index, is_ip6, is_enable);
 970
 971 done:
 972   unformat_free (line_input);
 973
 974   return error;
 975 }
 976
 977 static clib_error_t *
 978 set_ip4_gtpu_bypass (vlib_main_t * vm,
 979                      unformat_input_t * input, vlib_cli_command_t * cmd)
 980 {
 981   return set_ip_gtpu_bypass (0, input, cmd);
 982 }
 983
 984 /*?
 985  * This command adds the 'ip4-gtpu-bypass' graph node for a given interface.
 986  * By adding the IPv4 gtpu-bypass graph node to an interface, the node checks
 987  *  for and validate input gtpu packet and bypass ip4-lookup, ip4-local,
 988  * ip4-udp-lookup nodes to speedup gtpu packet forwarding. This node will
 989  * cause extra overhead to for non-gtpu packets which is kept at a minimum.
 990  *
 991  * @cliexpar
 992  * @parblock
 993  * Example of graph node before ip4-gtpu-bypass is enabled:
 994  * @cliexstart{show vlib graph ip4-gtpu-bypass}
 995  *            Name                      Next                    Previous
 996  * ip4-gtpu-bypass                error-drop [0]
 997  *                                gtpu4-input [1]
 998  *                                 ip4-lookup [2]
 999  * @cliexend
1000  *
1001  * Example of how to enable ip4-gtpu-bypass on an interface:
1002  * @cliexcmd{set interface ip gtpu-bypass GigabitEthernet2/0/0}
1003  *
1004  * Example of graph node after ip4-gtpu-bypass is enabled:
1005  * @cliexstart{show vlib graph ip4-gtpu-bypass}
1006  *            Name                      Next                    Previous
1007  * ip4-gtpu-bypass                error-drop [0]               ip4-input
1008  *                                gtpu4-input [1]        ip4-input-no-checksum
1009  *                                 ip4-lookup [2]
1010  * @cliexend
1011  *
1012  * Example of how to display the feature enabed on an interface:
1013  * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1014  * IP feature paths configured on GigabitEthernet2/0/0...
1015  * ...
1016  * ipv4 unicast:
1017  *   ip4-gtpu-bypass
1018  *   ip4-lookup
1019  * ...
1020  * @cliexend
1021  *
1022  * Example of how to disable ip4-gtpu-bypass on an interface:
1023  * @cliexcmd{set interface ip gtpu-bypass GigabitEthernet2/0/0 del}
1024  * @endparblock
1025 ?*/
1026 /* *INDENT-OFF* */
1027 VLIB_CLI_COMMAND (set_interface_ip_gtpu_bypass_command, static) = {
1028   .path = "set interface ip gtpu-bypass",
1029   .function = set_ip4_gtpu_bypass,
1030   .short_help = "set interface ip gtpu-bypass <interface> [del]",
1031 };
1032 /* *INDENT-ON* */
1033
1034 static clib_error_t *
1035 set_ip6_gtpu_bypass (vlib_main_t * vm,
1036                      unformat_input_t * input, vlib_cli_command_t * cmd)
1037 {
1038   return set_ip_gtpu_bypass (1, input, cmd);
1039 }
1040
1041 /*?
1042  * This command adds the 'ip6-gtpu-bypass' graph node for a given interface.
1043  * By adding the IPv6 gtpu-bypass graph node to an interface, the node checks
1044  *  for and validate input gtpu packet and bypass ip6-lookup, ip6-local,
1045  * ip6-udp-lookup nodes to speedup gtpu packet forwarding. This node will
1046  * cause extra overhead to for non-gtpu packets which is kept at a minimum.
1047  *
1048  * @cliexpar
1049  * @parblock
1050  * Example of graph node before ip6-gtpu-bypass is enabled:
1051  * @cliexstart{show vlib graph ip6-gtpu-bypass}
1052  *            Name                      Next                    Previous
1053  * ip6-gtpu-bypass                error-drop [0]
1054  *                                gtpu6-input [1]
1055  *                                 ip6-lookup [2]
1056  * @cliexend
1057  *
1058  * Example of how to enable ip6-gtpu-bypass on an interface:
1059  * @cliexcmd{set interface ip6 gtpu-bypass GigabitEthernet2/0/0}
1060  *
1061  * Example of graph node after ip6-gtpu-bypass is enabled:
1062  * @cliexstart{show vlib graph ip6-gtpu-bypass}
1063  *            Name                      Next                    Previous
1064  * ip6-gtpu-bypass                error-drop [0]               ip6-input
1065  *                                gtpu6-input [1]        ip4-input-no-checksum
1066  *                                 ip6-lookup [2]
1067  * @cliexend
1068  *
1069  * Example of how to display the feature enabed on an interface:
1070  * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1071  * IP feature paths configured on GigabitEthernet2/0/0...
1072  * ...
1073  * ipv6 unicast:
1074  *   ip6-gtpu-bypass
1075  *   ip6-lookup
1076  * ...
1077  * @cliexend
1078  *
1079  * Example of how to disable ip6-gtpu-bypass on an interface:
1080  * @cliexcmd{set interface ip6 gtpu-bypass GigabitEthernet2/0/0 del}
1081  * @endparblock
1082 ?*/
1083 /* *INDENT-OFF* */
1084 VLIB_CLI_COMMAND (set_interface_ip6_gtpu_bypass_command, static) = {
1085   .path = "set interface ip6 gtpu-bypass",
1086   .function = set_ip6_gtpu_bypass,
1087   .short_help = "set interface ip gtpu-bypass <interface> [del]",
1088 };
1089 /* *INDENT-ON* */
1090
1091 clib_error_t *
1092 gtpu_init (vlib_main_t * vm)
1093 {
1094   gtpu_main_t *gtm = &gtpu_main;
1095
1096   gtm->vnet_main = vnet_get_main ();
1097   gtm->vlib_main = vm;
1098
1099   /* initialize the ip6 hash */
1100   gtm->gtpu6_tunnel_by_key = hash_create_mem (0,
1101                                               sizeof (gtpu6_tunnel_key_t),
1102                                               sizeof (uword));
1103   gtm->vtep6 = hash_create_mem (0, sizeof (ip6_address_t), sizeof (uword));
1104   gtm->mcast_shared = hash_create_mem (0,
1105                                        sizeof (ip46_address_t),
1106                                        sizeof (mcast_shared_t));
1107
1108   udp_register_dst_port (vm, UDP_DST_PORT_GTPU,
1109                          gtpu4_input_node.index, /* is_ip4 */ 1);
1110   udp_register_dst_port (vm, UDP_DST_PORT_GTPU6,
1111                          gtpu6_input_node.index, /* is_ip4 */ 0);
1112
1113   gtm->fib_node_type = fib_node_register_new_type (&gtpu_vft);
1114
1115   return 0;
1116 }
1117
1118 VLIB_INIT_FUNCTION (gtpu_init);
1119
1120 /* *INDENT-OFF* */
1121 VLIB_PLUGIN_REGISTER () = {
1122     .version = VPP_BUILD_VER,
1123     .description = "GTPv1-U",
1124 };
1125 /* *INDENT-ON* */
1126
1127 /*
1128  * fd.io coding-style-patch-verification: ON
1129  *
1130  * Local Variables:
1131  * eval: (c-set-style "gnu")
1132  * End:
1133  */