src/vnet/vxlan/vxlan.c

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