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   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 int vnet_vxlan_gbp_tunnel_add_del
 356   (vnet_vxlan_gbp_tunnel_add_del_args_t * a, u32 * sw_if_indexp)
 357 {
 358   vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
 359   vxlan_gbp_tunnel_t *t = 0;
 360   vnet_main_t *vnm = vxm->vnet_main;
 361   u64 *p;
 362   u32 sw_if_index = ~0;
 363   vxlan4_gbp_tunnel_key_t key4;
 364   vxlan6_gbp_tunnel_key_t key6;
 365   u32 is_ip6 = a->is_ip6;
 366
 367   int not_found;
 368   if (!is_ip6)
 369     {
 370       key4.key[0] = a->dst.ip4.as_u32;
 371       key4.key[1] = (((u64) a->encap_fib_index) << 32)
 372         | clib_host_to_net_u32 (a->vni << 8);
 373       not_found =
 374         clib_bihash_search_inline_16_8 (&vxm->vxlan4_gbp_tunnel_by_key,
 375                                         &key4);
 376       p = &key4.value;
 377     }
 378   else
 379     {
 380       key6.key[0] = a->dst.ip6.as_u64[0];
 381       key6.key[1] = a->dst.ip6.as_u64[1];
 382       key6.key[2] = (((u64) a->encap_fib_index) << 32)
 383         | clib_host_to_net_u32 (a->vni << 8);
 384       not_found =
 385         clib_bihash_search_inline_24_8 (&vxm->vxlan6_gbp_tunnel_by_key,
 386                                         &key6);
 387       p = &key6.value;
 388     }
 389
 390   if (not_found)
 391     p = 0;
 392
 393   if (a->is_add)
 394     {
 395       l2input_main_t *l2im = &l2input_main;
 396       u32 dev_instance;         /* real dev instance tunnel index */
 397       u32 user_instance;        /* request and actual instance number */
 398
 399       /* adding a tunnel: tunnel must not already exist */
 400       if (p)
 401         return VNET_API_ERROR_TUNNEL_EXIST;
 402
 403       /* if not set explicitly, default to l2 */
 404       if (a->decap_next_index == ~0)
 405         a->decap_next_index = VXLAN_GBP_INPUT_NEXT_L2_INPUT;
 406       if (!vxlan_gbp_decap_next_is_valid (vxm, is_ip6, a->decap_next_index))
 407         return VNET_API_ERROR_INVALID_DECAP_NEXT;
 408
 409       pool_get_aligned (vxm->tunnels, t, CLIB_CACHE_LINE_BYTES);
 410       memset (t, 0, sizeof (*t));
 411       dev_instance = t - vxm->tunnels;
 412
 413       /* copy from arg structure */
 414 #define _(x) t->x = a->x;
 415       foreach_copy_field;
 416 #undef _
 417
 418       vxlan_gbp_rewrite (t, is_ip6);
 419       /*
 420        * Reconcile the real dev_instance and a possible requested instance.
 421        */
 422       user_instance = a->instance;
 423       if (user_instance == ~0)
 424         user_instance = dev_instance;
 425       if (hash_get (vxm->instance_used, user_instance))
 426         {
 427           pool_put (vxm->tunnels, t);
 428           return VNET_API_ERROR_INSTANCE_IN_USE;
 429         }
 430       hash_set (vxm->instance_used, user_instance, 1);
 431
 432       t->dev_instance = dev_instance;   /* actual */
 433       t->user_instance = user_instance; /* name */
 434
 435       /* copy the key */
 436       int add_failed;
 437       if (is_ip6)
 438         {
 439           key6.value = (u64) dev_instance;
 440           add_failed =
 441             clib_bihash_add_del_24_8 (&vxm->vxlan6_gbp_tunnel_by_key, &key6,
 442                                       1 /*add */ );
 443         }
 444       else
 445         {
 446           key4.value = (u64) dev_instance;
 447           add_failed =
 448             clib_bihash_add_del_16_8 (&vxm->vxlan4_gbp_tunnel_by_key, &key4,
 449                                       1 /*add */ );
 450         }
 451
 452       if (add_failed)
 453         {
 454           pool_put (vxm->tunnels, t);
 455           return VNET_API_ERROR_INVALID_REGISTRATION;
 456         }
 457
 458       t->hw_if_index = vnet_register_interface
 459         (vnm, vxlan_gbp_device_class.index, dev_instance,
 460          vxlan_gbp_hw_class.index, dev_instance);
 461       vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, t->hw_if_index);
 462
 463       /* Set vxlan_gbp tunnel output node */
 464       u32 encap_index = !is_ip6 ?
 465         vxlan4_gbp_encap_node.index : vxlan6_gbp_encap_node.index;
 466       vnet_set_interface_output_node (vnm, t->hw_if_index, encap_index);
 467
 468       t->sw_if_index = sw_if_index = hi->sw_if_index;
 469
 470       vec_validate_init_empty (vxm->tunnel_index_by_sw_if_index, sw_if_index,
 471                                ~0);
 472       vxm->tunnel_index_by_sw_if_index[sw_if_index] = dev_instance;
 473
 474       /* setup l2 input config with l2 feature and bd 0 to drop packet */
 475       vec_validate (l2im->configs, sw_if_index);
 476       l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
 477       l2im->configs[sw_if_index].bd_index = 0;
 478
 479       vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
 480       si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
 481       vnet_sw_interface_set_flags (vnm, sw_if_index,
 482                                    VNET_SW_INTERFACE_FLAG_ADMIN_UP);
 483
 484       fib_node_init (&t->node, FIB_NODE_TYPE_VXLAN_GBP_TUNNEL);
 485       fib_prefix_t tun_dst_pfx;
 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, FIB_NODE_TYPE_VXLAN_GBP_TUNNEL,
 503              dev_instance);
 504           vxlan_gbp_tunnel_restack_dpo (t);
 505         }
 506       else
 507         {
 508           /* Multicast tunnel -
 509            * as the same mcast group can be used for multiple mcast tunnels
 510            * with different VNIs, create the output fib adjacency only if
 511            * it does not already exist
 512            */
 513           fib_protocol_t fp = fib_ip_proto (is_ip6);
 514
 515           if (vtep_addr_ref (&t->dst) == 1)
 516             {
 517               fib_node_index_t mfei;
 518               adj_index_t ai;
 519               fib_route_path_t path = {
 520                 .frp_proto = fib_proto_to_dpo (fp),
 521                 .frp_addr = zero_addr,
 522                 .frp_sw_if_index = 0xffffffff,
 523                 .frp_fib_index = ~0,
 524                 .frp_weight = 0,
 525                 .frp_flags = FIB_ROUTE_PATH_LOCAL,
 526               };
 527               const mfib_prefix_t mpfx = {
 528                 .fp_proto = fp,
 529                 .fp_len = (is_ip6 ? 128 : 32),
 530                 .fp_grp_addr = tun_dst_pfx.fp_addr,
 531               };
 532
 533               /*
 534                * Setup the (*,G) to receive traffic on the mcast group
 535                *  - the forwarding interface is for-us
 536                *  - the accepting interface is that from the API
 537                */
 538               mfib_table_entry_path_update (t->encap_fib_index,
 539                                             &mpfx,
 540                                             MFIB_SOURCE_VXLAN_GBP,
 541                                             &path, MFIB_ITF_FLAG_FORWARD);
 542
 543               path.frp_sw_if_index = a->mcast_sw_if_index;
 544               path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
 545               mfei = mfib_table_entry_path_update (t->encap_fib_index,
 546                                                    &mpfx,
 547                                                    MFIB_SOURCE_VXLAN_GBP,
 548                                                    &path,
 549                                                    MFIB_ITF_FLAG_ACCEPT);
 550
 551               /*
 552                * Create the mcast adjacency to send traffic to the group
 553                */
 554               ai = adj_mcast_add_or_lock (fp,
 555                                           fib_proto_to_link (fp),
 556                                           a->mcast_sw_if_index);
 557
 558               /*
 559                * create a new end-point
 560                */
 561               mcast_shared_add (&t->dst, mfei, ai);
 562             }
 563
 564           dpo_id_t dpo = DPO_INVALID;
 565           mcast_shared_t ep = mcast_shared_get (&t->dst);
 566
 567           /* Stack shared mcast dst mac addr rewrite on encap */
 568           dpo_set (&dpo, DPO_ADJACENCY_MCAST,
 569                    fib_proto_to_dpo (fp), ep.mcast_adj_index);
 570
 571           dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
 572           dpo_reset (&dpo);
 573           flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
 574         }
 575
 576       vnet_get_sw_interface (vnet_get_main (), sw_if_index)->flood_class =
 577         flood_class;
 578     }
 579   else
 580     {
 581       /* deleting a tunnel: tunnel must exist */
 582       if (!p)
 583         return VNET_API_ERROR_NO_SUCH_ENTRY;
 584
 585       u32 instance = p[0];
 586       t = pool_elt_at_index (vxm->tunnels, instance);
 587
 588       sw_if_index = t->sw_if_index;
 589       vnet_sw_interface_set_flags (vnm, sw_if_index, 0 /* down */ );
 590
 591       vxm->tunnel_index_by_sw_if_index[sw_if_index] = ~0;
 592
 593       if (!is_ip6)
 594         clib_bihash_add_del_16_8 (&vxm->vxlan4_gbp_tunnel_by_key, &key4,
 595                                   0 /*del */ );
 596       else
 597         clib_bihash_add_del_24_8 (&vxm->vxlan6_gbp_tunnel_by_key, &key6,
 598                                   0 /*del */ );
 599
 600       if (!ip46_address_is_multicast (&t->dst))
 601         {
 602           vtep_addr_unref (&t->src);
 603           fib_entry_child_remove (t->fib_entry_index, t->sibling_index);
 604           fib_table_entry_delete_index (t->fib_entry_index, FIB_SOURCE_RR);
 605         }
 606       else if (vtep_addr_unref (&t->dst) == 0)
 607         {
 608           mcast_shared_remove (&t->dst);
 609         }
 610
 611       vnet_delete_hw_interface (vnm, t->hw_if_index);
 612       hash_unset (vxm->instance_used, t->user_instance);
 613
 614       fib_node_deinit (&t->node);
 615       pool_put (vxm->tunnels, t);
 616     }
 617
 618   if (sw_if_indexp)
 619     *sw_if_indexp = sw_if_index;
 620
 621   return 0;
 622 }
 623
 624 static uword
 625 get_decap_next_for_node (u32 node_index, u32 ipv4_set)
 626 {
 627   vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
 628   vlib_main_t *vm = vxm->vlib_main;
 629   uword input_node = (ipv4_set) ? vxlan4_gbp_input_node.index :
 630     vxlan6_gbp_input_node.index;
 631
 632   return vlib_node_add_next (vm, input_node, node_index);
 633 }
 634
 635 static uword
 636 unformat_decap_next (unformat_input_t * input, va_list * args)
 637 {
 638   u32 *result = va_arg (*args, u32 *);
 639   u32 ipv4_set = va_arg (*args, int);
 640   vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
 641   vlib_main_t *vm = vxm->vlib_main;
 642   u32 node_index;
 643   u32 tmp;
 644
 645   if (unformat (input, "l2"))
 646     *result = VXLAN_GBP_INPUT_NEXT_L2_INPUT;
 647   else if (unformat (input, "node %U", unformat_vlib_node, vm, &node_index))
 648     *result = get_decap_next_for_node (node_index, ipv4_set);
 649   else if (unformat (input, "%d", &tmp))
 650     *result = tmp;
 651   else
 652     return 0;
 653   return 1;
 654 }
 655
 656 static clib_error_t *
 657 vxlan_gbp_tunnel_add_del_command_fn (vlib_main_t * vm,
 658                                      unformat_input_t * input,
 659                                      vlib_cli_command_t * cmd)
 660 {
 661   unformat_input_t _line_input, *line_input = &_line_input;
 662   ip46_address_t src = ip46_address_initializer, dst =
 663     ip46_address_initializer;
 664   u8 is_add = 1;
 665   u8 src_set = 0;
 666   u8 dst_set = 0;
 667   u8 grp_set = 0;
 668   u8 ipv4_set = 0;
 669   u8 ipv6_set = 0;
 670   u32 instance = ~0;
 671   u32 encap_fib_index = 0;
 672   u32 mcast_sw_if_index = ~0;
 673   u32 decap_next_index = VXLAN_GBP_INPUT_NEXT_L2_INPUT;
 674   u32 vni = 0;
 675   u32 table_id;
 676   clib_error_t *parse_error = NULL;
 677
 678   /* Get a line of input. */
 679   if (!unformat_user (input, unformat_line_input, line_input))
 680     return 0;
 681
 682   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 683     {
 684       if (unformat (line_input, "del"))
 685         {
 686           is_add = 0;
 687         }
 688       else if (unformat (line_input, "instance %d", &instance))
 689         ;
 690       else if (unformat (line_input, "src %U",
 691                          unformat_ip46_address, &src, IP46_TYPE_ANY))
 692         {
 693           src_set = 1;
 694           ip46_address_is_ip4 (&src) ? (ipv4_set = 1) : (ipv6_set = 1);
 695         }
 696       else if (unformat (line_input, "dst %U",
 697                          unformat_ip46_address, &dst, IP46_TYPE_ANY))
 698         {
 699           dst_set = 1;
 700           ip46_address_is_ip4 (&dst) ? (ipv4_set = 1) : (ipv6_set = 1);
 701         }
 702       else if (unformat (line_input, "group %U %U",
 703                          unformat_ip46_address, &dst, IP46_TYPE_ANY,
 704                          unformat_vnet_sw_interface,
 705                          vnet_get_main (), &mcast_sw_if_index))
 706         {
 707           grp_set = dst_set = 1;
 708           ip46_address_is_ip4 (&dst) ? (ipv4_set = 1) : (ipv6_set = 1);
 709         }
 710       else if (unformat (line_input, "encap-vrf-id %d", &table_id))
 711         {
 712           encap_fib_index =
 713             fib_table_find (fib_ip_proto (ipv6_set), table_id);
 714         }
 715       else if (unformat (line_input, "decap-next %U", unformat_decap_next,
 716                          &decap_next_index, ipv4_set))
 717         ;
 718       else if (unformat (line_input, "vni %d", &vni))
 719         ;
 720       else
 721         {
 722           parse_error = clib_error_return (0, "parse error: '%U'",
 723                                            format_unformat_error, line_input);
 724           break;
 725         }
 726     }
 727
 728   unformat_free (line_input);
 729
 730   if (parse_error)
 731     return parse_error;
 732
 733   if (encap_fib_index == ~0)
 734     return clib_error_return (0, "nonexistent encap-vrf-id %d", table_id);
 735
 736   if (src_set == 0)
 737     return clib_error_return (0, "tunnel src address not specified");
 738
 739   if (dst_set == 0)
 740     return clib_error_return (0, "tunnel dst address not specified");
 741
 742   if (grp_set && !ip46_address_is_multicast (&dst))
 743     return clib_error_return (0, "tunnel group address not multicast");
 744
 745   if (grp_set == 0 && ip46_address_is_multicast (&dst))
 746     return clib_error_return (0, "dst address must be unicast");
 747
 748   if (grp_set && mcast_sw_if_index == ~0)
 749     return clib_error_return (0, "tunnel nonexistent multicast device");
 750
 751   if (ipv4_set && ipv6_set)
 752     return clib_error_return (0, "both IPv4 and IPv6 addresses specified");
 753
 754   if (ip46_address_cmp (&src, &dst) == 0)
 755     return clib_error_return (0, "src and dst addresses are identical");
 756
 757   if (decap_next_index == ~0)
 758     return clib_error_return (0, "next node not found");
 759
 760   if (vni == 0)
 761     return clib_error_return (0, "vni not specified");
 762
 763   if (vni >> 24)
 764     return clib_error_return (0, "vni %d out of range", vni);
 765
 766   vnet_vxlan_gbp_tunnel_add_del_args_t a = {
 767     .is_add = is_add,
 768     .is_ip6 = ipv6_set,
 769     .instance = instance,
 770 #define _(x) .x = x,
 771     foreach_copy_field
 772 #undef _
 773   };
 774
 775   u32 tunnel_sw_if_index;
 776   int rv = vnet_vxlan_gbp_tunnel_add_del (&a, &tunnel_sw_if_index);
 777
 778   switch (rv)
 779     {
 780     case 0:
 781       if (is_add)
 782         vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
 783                          vnet_get_main (), tunnel_sw_if_index);
 784       break;
 785
 786     case VNET_API_ERROR_TUNNEL_EXIST:
 787       return clib_error_return (0, "tunnel already exists...");
 788
 789     case VNET_API_ERROR_NO_SUCH_ENTRY:
 790       return clib_error_return (0, "tunnel does not exist...");
 791
 792     case VNET_API_ERROR_INSTANCE_IN_USE:
 793       return clib_error_return (0, "Instance is in use");
 794
 795     default:
 796       return clib_error_return
 797         (0, "vnet_vxlan_gbp_tunnel_add_del returned %d", rv);
 798     }
 799
 800   return 0;
 801 }
 802
 803 /*?
 804  * Add or delete a VXLAN Tunnel.
 805  *
 806  * VXLAN provides the features needed to allow L2 bridge domains (BDs)
 807  * to span multiple servers. This is done by building an L2 overlay on
 808  * top of an L3 network underlay using VXLAN tunnels.
 809  *
 810  * This makes it possible for servers to be co-located in the same data
 811  * center or be separated geographically as long as they are reachable
 812  * through the underlay L3 network.
 813  *
 814  * You can refer to this kind of L2 overlay bridge domain as a VXLAN
 815  * (Virtual eXtensible VLAN) segment.
 816  *
 817  * @cliexpar
 818  * Example of how to create a VXLAN Tunnel:
 819  * @cliexcmd{create vxlan_gbp tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 encap-vrf-id 7}
 820  * Example of how to create a VXLAN Tunnel with a known name, vxlan_gbp_tunnel42:
 821  * @cliexcmd{create vxlan_gbp tunnel src 10.0.3.1 dst 10.0.3.3 instance 42}
 822  * Example of how to create a multicast VXLAN Tunnel with a known name, vxlan_gbp_tunnel23:
 823  * @cliexcmd{create vxlan_gbp tunnel src 10.0.3.1 group 239.1.1.1 GigabitEthernet0/8/0 instance 23}
 824  * Example of how to delete a VXLAN Tunnel:
 825  * @cliexcmd{create vxlan_gbp tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 del}
 826  ?*/
 827 /* *INDENT-OFF* */
 828 VLIB_CLI_COMMAND (create_vxlan_gbp_tunnel_command, static) = {
 829   .path = "create vxlan-gbp tunnel",
 830   .short_help =
 831   "create vxlan-gbp tunnel src <local-vtep-addr>"
 832   " {dst <remote-vtep-addr>|group <mcast-vtep-addr> <intf-name>} vni <nn>"
 833   " [instance <id>]"
 834   " [encap-vrf-id <nn>] [decap-next [l2|node <name>]] [del]",
 835   .function = vxlan_gbp_tunnel_add_del_command_fn,
 836 };
 837 /* *INDENT-ON* */
 838
 839 static clib_error_t *
 840 show_vxlan_gbp_tunnel_command_fn (vlib_main_t * vm,
 841                                   unformat_input_t * input,
 842                                   vlib_cli_command_t * cmd)
 843 {
 844   vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
 845   vxlan_gbp_tunnel_t *t;
 846   int raw = 0;
 847
 848   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 849     {
 850       if (unformat (input, "raw"))
 851         raw = 1;
 852       else
 853         return clib_error_return (0, "parse error: '%U'",
 854                                   format_unformat_error, input);
 855     }
 856
 857   if (pool_elts (vxm->tunnels) == 0)
 858     vlib_cli_output (vm, "No vxlan-gbp tunnels configured...");
 859
 860 /* *INDENT-OFF* */
 861   pool_foreach (t, vxm->tunnels,
 862   ({
 863     vlib_cli_output (vm, "%U", format_vxlan_gbp_tunnel, t);
 864   }));
 865 /* *INDENT-ON* */
 866
 867   if (raw)
 868     {
 869       vlib_cli_output (vm, "Raw IPv4 Hash Table:\n%U\n",
 870                        format_bihash_16_8, &vxm->vxlan4_gbp_tunnel_by_key,
 871                        1 /* verbose */ );
 872       vlib_cli_output (vm, "Raw IPv6 Hash Table:\n%U\n",
 873                        format_bihash_24_8, &vxm->vxlan6_gbp_tunnel_by_key,
 874                        1 /* verbose */ );
 875     }
 876
 877   return 0;
 878 }
 879
 880 /*?
 881  * Display all the VXLAN Tunnel entries.
 882  *
 883  * @cliexpar
 884  * Example of how to display the VXLAN Tunnel entries:
 885  * @cliexstart{show vxlan_gbp tunnel}
 886  * [0] src 10.0.3.1 dst 10.0.3.3 vni 13 encap_fib_index 0 sw_if_index 5 decap_next l2
 887  * @cliexend
 888  ?*/
 889 /* *INDENT-OFF* */
 890 VLIB_CLI_COMMAND (show_vxlan_gbp_tunnel_command, static) = {
 891     .path = "show vxlan-gbp tunnel",
 892     .short_help = "show vxlan-gbp tunnel [raw]",
 893     .function = show_vxlan_gbp_tunnel_command_fn,
 894 };
 895 /* *INDENT-ON* */
 896
 897
 898 void
 899 vnet_int_vxlan_gbp_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable)
 900 {
 901   if (is_ip6)
 902     vnet_feature_enable_disable ("ip6-unicast", "ip6-vxlan-gbp-bypass",
 903                                  sw_if_index, is_enable, 0, 0);
 904   else
 905     vnet_feature_enable_disable ("ip4-unicast", "ip4-vxlan-gbp-bypass",
 906                                  sw_if_index, is_enable, 0, 0);
 907 }
 908
 909
 910 static clib_error_t *
 911 set_ip_vxlan_gbp_bypass (u32 is_ip6,
 912                          unformat_input_t * input, vlib_cli_command_t * cmd)
 913 {
 914   unformat_input_t _line_input, *line_input = &_line_input;
 915   vnet_main_t *vnm = vnet_get_main ();
 916   clib_error_t *error = 0;
 917   u32 sw_if_index, is_enable;
 918
 919   sw_if_index = ~0;
 920   is_enable = 1;
 921
 922   if (!unformat_user (input, unformat_line_input, line_input))
 923     return 0;
 924
 925   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 926     {
 927       if (unformat_user
 928           (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
 929         ;
 930       else if (unformat (line_input, "del"))
 931         is_enable = 0;
 932       else
 933         {
 934           error = unformat_parse_error (line_input);
 935           goto done;
 936         }
 937     }
 938
 939   if (~0 == sw_if_index)
 940     {
 941       error = clib_error_return (0, "unknown interface `%U'",
 942                                  format_unformat_error, line_input);
 943       goto done;
 944     }
 945
 946   vnet_int_vxlan_gbp_bypass_mode (sw_if_index, is_ip6, is_enable);
 947
 948 done:
 949   unformat_free (line_input);
 950
 951   return error;
 952 }
 953
 954 static clib_error_t *
 955 set_ip4_vxlan_gbp_bypass (vlib_main_t * vm,
 956                           unformat_input_t * input, vlib_cli_command_t * cmd)
 957 {
 958   return set_ip_vxlan_gbp_bypass (0, input, cmd);
 959 }
 960
 961 /*?
 962  * This command adds the 'ip4-vxlan-gbp-bypass' graph node for a given interface.
 963  * By adding the IPv4 vxlan_gbp-bypass graph node to an interface, the node checks
 964  *  for and validate input vxlan_gbp packet and bypass ip4-lookup, ip4-local,
 965  * ip4-udp-lookup nodes to speedup vxlan_gbp packet forwarding. This node will
 966  * cause extra overhead to for non-vxlan_gbp packets which is kept at a minimum.
 967  *
 968  * @cliexpar
 969  * @parblock
 970  * Example of graph node before ip4-vxlan_gbp-bypass is enabled:
 971  * @cliexstart{show vlib graph ip4-vxlan_gbp-bypass}
 972  *            Name                      Next                    Previous
 973  * ip4-vxlan-gbp-bypass              error-drop [0]
 974  *                                vxlan4-gbp-input [1]
 975  *                                   ip4-lookup [2]
 976  * @cliexend
 977  *
 978  * Example of how to enable ip4-vxlan-gbp-bypass on an interface:
 979  * @cliexcmd{set interface ip vxlan-gbp-bypass GigabitEthernet2/0/0}
 980  *
 981  * Example of graph node after ip4-vxlan-gbp-bypass is enabled:
 982  * @cliexstart{show vlib graph ip4-vxlan-gbp-bypass}
 983  *            Name                      Next                    Previous
 984  * ip4-vxlan-gbp-bypass              error-drop [0]               ip4-input
 985  *                                vxlan4-gbp-input [1]        ip4-input-no-checksum
 986  *                                   ip4-lookup [2]
 987  * @cliexend
 988  *
 989  * Example of how to display the feature enabled on an interface:
 990  * @cliexstart{show ip interface features GigabitEthernet2/0/0}
 991  * IP feature paths configured on GigabitEthernet2/0/0...
 992  * ...
 993  * ipv4 unicast:
 994  *   ip4-vxlan-gbp-bypass
 995  *   ip4-lookup
 996  * ...
 997  * @cliexend
 998  *
 999  * Example of how to disable ip4-vxlan-gbp-bypass on an interface:
1000  * @cliexcmd{set interface ip vxlan-gbp-bypass GigabitEthernet2/0/0 del}
1001  * @endparblock
1002 ?*/
1003 /* *INDENT-OFF* */
1004 VLIB_CLI_COMMAND (set_interface_ip_vxlan_gbp_bypass_command, static) = {
1005   .path = "set interface ip vxlan-gbp-bypass",
1006   .function = set_ip4_vxlan_gbp_bypass,
1007   .short_help = "set interface ip vxlan-gbp-bypass <interface> [del]",
1008 };
1009 /* *INDENT-ON* */
1010
1011 static clib_error_t *
1012 set_ip6_vxlan_gbp_bypass (vlib_main_t * vm,
1013                           unformat_input_t * input, vlib_cli_command_t * cmd)
1014 {
1015   return set_ip_vxlan_gbp_bypass (1, input, cmd);
1016 }
1017
1018 /*?
1019  * This command adds the 'ip6-vxlan-gbp-bypass' graph node for a given interface.
1020  * By adding the IPv6 vxlan-gbp-bypass graph node to an interface, the node checks
1021  *  for and validate input vxlan_gbp packet and bypass ip6-lookup, ip6-local,
1022  * ip6-udp-lookup nodes to speedup vxlan_gbp packet forwarding. This node will
1023  * cause extra overhead to for non-vxlan packets which is kept at a minimum.
1024  *
1025  * @cliexpar
1026  * @parblock
1027  * Example of graph node before ip6-vxlan-gbp-bypass is enabled:
1028  * @cliexstart{show vlib graph ip6-vxlan-gbp-bypass}
1029  *            Name                      Next                    Previous
1030  * ip6-vxlan-gbp-bypass              error-drop [0]
1031  *                                vxlan6-gbp-input [1]
1032  *                                   ip6-lookup [2]
1033  * @cliexend
1034  *
1035  * Example of how to enable ip6-vxlan-gbp-bypass on an interface:
1036  * @cliexcmd{set interface ip6 vxlan-gbp-bypass GigabitEthernet2/0/0}
1037  *
1038  * Example of graph node after ip6-vxlan-gbp-bypass is enabled:
1039  * @cliexstart{show vlib graph ip6-vxlan-gbp-bypass}
1040  *            Name                      Next                    Previous
1041  * ip6-vxlan-gbp-bypass              error-drop [0]               ip6-input
1042  *                                vxlan6-gbp-input [1]        ip4-input-no-checksum
1043  *                                   ip6-lookup [2]
1044  * @cliexend
1045  *
1046  * Example of how to display the feature enabled on an interface:
1047  * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1048  * IP feature paths configured on GigabitEthernet2/0/0...
1049  * ...
1050  * ipv6 unicast:
1051  *   ip6-vxlan-gbp-bypass
1052  *   ip6-lookup
1053  * ...
1054  * @cliexend
1055  *
1056  * Example of how to disable ip6-vxlan-gbp-bypass on an interface:
1057  * @cliexcmd{set interface ip6 vxlan-gbp-bypass GigabitEthernet2/0/0 del}
1058  * @endparblock
1059 ?*/
1060 /* *INDENT-OFF* */
1061 VLIB_CLI_COMMAND (set_interface_ip6_vxlan_gbp_bypass_command, static) = {
1062   .path = "set interface ip6 vxlan-gbp-bypass",
1063   .function = set_ip6_vxlan_gbp_bypass,
1064   .short_help = "set interface ip vxlan-gbp-bypass <interface> [del]",
1065 };
1066 /* *INDENT-ON* */
1067
1068 #define VXLAN_GBP_HASH_NUM_BUCKETS (2 * 1024)
1069 #define VXLAN_GBP_HASH_MEMORY_SIZE (1 << 20)
1070
1071 clib_error_t *
1072 vxlan_gbp_init (vlib_main_t * vm)
1073 {
1074   vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
1075
1076   vxm->vnet_main = vnet_get_main ();
1077   vxm->vlib_main = vm;
1078
1079   /* initialize the ip6 hash */
1080   clib_bihash_init_16_8 (&vxm->vxlan4_gbp_tunnel_by_key, "vxlan4-gbp",
1081                          VXLAN_GBP_HASH_NUM_BUCKETS,
1082                          VXLAN_GBP_HASH_MEMORY_SIZE);
1083   clib_bihash_init_24_8 (&vxm->vxlan6_gbp_tunnel_by_key, "vxlan6-gbp",
1084                          VXLAN_GBP_HASH_NUM_BUCKETS,
1085                          VXLAN_GBP_HASH_MEMORY_SIZE);
1086   vxm->vtep6 = hash_create_mem (0, sizeof (ip6_address_t), sizeof (uword));
1087   vxm->mcast_shared = hash_create_mem (0,
1088                                        sizeof (ip46_address_t),
1089                                        sizeof (mcast_shared_t));
1090
1091   udp_register_dst_port (vm, UDP_DST_PORT_vxlan_gbp,
1092                          vxlan4_gbp_input_node.index, /* is_ip4 */ 1);
1093   udp_register_dst_port (vm, UDP_DST_PORT_vxlan6_gbp,
1094                          vxlan6_gbp_input_node.index, /* is_ip4 */ 0);
1095
1096   fib_node_register_type (FIB_NODE_TYPE_VXLAN_GBP_TUNNEL, &vxlan_gbp_vft);
1097
1098   return 0;
1099 }
1100
1101 VLIB_INIT_FUNCTION (vxlan_gbp_init);
1102
1103 /*
1104  * fd.io coding-style-patch-verification: ON
1105  *
1106  * Local Variables:
1107  * eval: (c-set-style "gnu")
1108  * End:
1109  */