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