src/vnet/vxlan-gbp/vxlan_gbp.c

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