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 = {0};
 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   if (!is_ip6)
 231     {
 232       ip4_header_t * ip = &h.h4.ip4;
 233       udp = &h.h4.udp, vxlan = &h.h4.vxlan;
 234       ip->ip_version_and_header_length = 0x45;
 235       ip->ttl = 254;
 236       ip->protocol = IP_PROTOCOL_UDP;
 237
 238       ip->src_address = t->src.ip4;
 239       ip->dst_address = t->dst.ip4;
 240
 241       /* we fix up the ip4 header length and checksum after-the-fact */
 242       ip->checksum = ip4_header_checksum (ip);
 243     }
 244   else
 245     {
 246       ip6_header_t * ip = &h.h6.ip6;
 247       udp = &h.h6.udp, vxlan = &h.h6.vxlan;
 248       ip->ip_version_traffic_class_and_flow_label = clib_host_to_net_u32(6 << 28);
 249       ip->hop_limit = 255;
 250       ip->protocol = IP_PROTOCOL_UDP;
 251
 252       ip->src_address = t->src.ip6;
 253       ip->dst_address = t->dst.ip6;
 254     }
 255
 256   /* UDP header, randomize src port on something, maybe? */
 257   udp->src_port = clib_host_to_net_u16 (4789);
 258   udp->dst_port = clib_host_to_net_u16 (UDP_DST_PORT_vxlan);
 259
 260   /* VXLAN header */
 261   vnet_set_vni_and_flags(vxlan, t->vni);
 262   vnet_rewrite_set_data (*t, &h, len);
 263 }
 264
 265 static bool
 266 vxlan_decap_next_is_valid (vxlan_main_t * vxm, u32 is_ip6, u32 decap_next_index)
 267 {
 268   vlib_main_t * vm = vxm->vlib_main;
 269   u32 input_idx = (!is_ip6) ? vxlan4_input_node.index : vxlan6_input_node.index;
 270   vlib_node_runtime_t *r = vlib_node_get_runtime (vm, input_idx);
 271
 272   return decap_next_index < r->n_next_nodes;
 273 }
 274
 275 static uword
 276 vtep_addr_ref(ip46_address_t *ip)
 277 {
 278         uword *vtep = ip46_address_is_ip4(ip) ?
 279                          hash_get (vxlan_main.vtep4, ip->ip4.as_u32) :
 280                          hash_get_mem (vxlan_main.vtep6, &ip->ip6);
 281         if (vtep)
 282                 return ++(*vtep);
 283         ip46_address_is_ip4(ip) ?
 284                          hash_set (vxlan_main.vtep4, ip->ip4.as_u32, 1) :
 285                          hash_set_mem_alloc (&vxlan_main.vtep6, &ip->ip6, 1);
 286         return 1;
 287 }
 288
 289 static uword
 290 vtep_addr_unref(ip46_address_t *ip)
 291 {
 292         uword *vtep = ip46_address_is_ip4(ip) ?
 293                          hash_get (vxlan_main.vtep4, ip->ip4.as_u32) :
 294                          hash_get_mem (vxlan_main.vtep6, &ip->ip6);
 295         ASSERT(vtep);
 296         if (--(*vtep) != 0)
 297                 return *vtep;
 298         ip46_address_is_ip4(ip) ?
 299                 hash_unset (vxlan_main.vtep4, ip->ip4.as_u32) :
 300                 hash_unset_mem_free (&vxlan_main.vtep6, &ip->ip6);
 301         return 0;
 302 }
 303
 304 typedef CLIB_PACKED(union {
 305   struct {
 306     fib_node_index_t mfib_entry_index;
 307     adj_index_t mcast_adj_index;
 308   };
 309   u64 as_u64;
 310 }) mcast_shared_t;
 311
 312 static inline mcast_shared_t
 313 mcast_shared_get(ip46_address_t * ip)
 314 {
 315         ASSERT(ip46_address_is_multicast(ip));
 316         uword * p = hash_get_mem (vxlan_main.mcast_shared, ip);
 317         ASSERT(p);
 318         return (mcast_shared_t) { .as_u64 = *p };
 319 }
 320
 321 static inline void
 322 mcast_shared_add(ip46_address_t *dst,
 323                  fib_node_index_t mfei,
 324                  adj_index_t ai)
 325 {
 326     mcast_shared_t new_ep = {
 327         .mcast_adj_index = ai,
 328         .mfib_entry_index = mfei,
 329     };
 330
 331     hash_set_mem_alloc (&vxlan_main.mcast_shared, dst, new_ep.as_u64);
 332 }
 333
 334 static inline void
 335 mcast_shared_remove(ip46_address_t *dst)
 336 {
 337     mcast_shared_t ep = mcast_shared_get(dst);
 338
 339     adj_unlock(ep.mcast_adj_index);
 340     mfib_table_entry_delete_index(ep.mfib_entry_index,
 341                                   MFIB_SOURCE_VXLAN);
 342
 343     hash_unset_mem_free (&vxlan_main.mcast_shared, dst);
 344 }
 345
 346 int vnet_vxlan_add_del_tunnel
 347 (vnet_vxlan_add_del_tunnel_args_t *a, u32 * sw_if_indexp)
 348 {
 349   vxlan_main_t * vxm = &vxlan_main;
 350   vxlan_tunnel_t *t = 0;
 351   vnet_main_t * vnm = vxm->vnet_main;
 352   uword * p;
 353   u32 sw_if_index = ~0;
 354   vxlan4_tunnel_key_t key4;
 355   vxlan6_tunnel_key_t key6;
 356   u32 is_ip6 = a->is_ip6;
 357
 358   if (!is_ip6)
 359     {
 360       key4.src = a->dst.ip4.as_u32; /* decap src in key is encap dst in config */
 361       key4.vni = clib_host_to_net_u32 (a->vni << 8);
 362       p = hash_get (vxm->vxlan4_tunnel_by_key, key4.as_u64);
 363     }
 364   else
 365     {
 366       key6.src = a->dst.ip6;
 367       key6.vni = clib_host_to_net_u32 (a->vni << 8);
 368       p = hash_get_mem (vxm->vxlan6_tunnel_by_key, &key6);
 369     }
 370
 371   if (a->is_add)
 372     {
 373       l2input_main_t * l2im = &l2input_main;
 374       u32 dev_instance;         /* real dev instance tunnel index */
 375       u32 user_instance;        /* request and actual instance number */
 376
 377       /* adding a tunnel: tunnel must not already exist */
 378       if (p)
 379         return VNET_API_ERROR_TUNNEL_EXIST;
 380
 381       /*if not set explicitly, default to l2 */
 382       if(a->decap_next_index == ~0)
 383         a->decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
 384       if (!vxlan_decap_next_is_valid(vxm, is_ip6, a->decap_next_index))
 385           return VNET_API_ERROR_INVALID_DECAP_NEXT;
 386
 387       pool_get_aligned (vxm->tunnels, t, CLIB_CACHE_LINE_BYTES);
 388       *t = (vxlan_tunnel_t){ 0 };
 389       dev_instance = t - vxm->tunnels;
 390
 391       /* copy from arg structure */
 392 #define _(x) t->x = a->x;
 393       foreach_copy_field;
 394 #undef _
 395
 396       vxlan_rewrite (t, is_ip6);
 397       /*
 398        * Reconcile the real dev_instance and a possible requested instance.
 399        */
 400       user_instance = a->instance;
 401       if (user_instance == ~0)
 402         user_instance = dev_instance;
 403       if (hash_get (vxm->instance_used, user_instance))
 404         {
 405           pool_put (vxm->tunnels, t);
 406           return VNET_API_ERROR_INSTANCE_IN_USE;
 407         }
 408       hash_set (vxm->instance_used, user_instance, 1);
 409
 410       t->dev_instance = dev_instance;           /* actual */
 411       t->user_instance = user_instance;         /* name */
 412
 413       /* copy the key */
 414       if (is_ip6)
 415         hash_set_mem_alloc (&vxm->vxlan6_tunnel_by_key, &key6, dev_instance);
 416       else
 417         hash_set (vxm->vxlan4_tunnel_by_key, key4.as_u64, dev_instance);
 418
 419       t->hw_if_index = vnet_register_interface
 420         (vnm, vxlan_device_class.index, dev_instance,
 421          vxlan_hw_class.index, dev_instance);
 422       vnet_hw_interface_t * hi = vnet_get_hw_interface (vnm, t->hw_if_index);
 423
 424       /* Set vxlan tunnel output node */
 425       u32 encap_index = !is_ip6 ?
 426           vxlan4_encap_node.index : vxlan6_encap_node.index;
 427       vnet_set_interface_output_node (vnm, t->hw_if_index, encap_index);
 428
 429       t->sw_if_index = sw_if_index = hi->sw_if_index;
 430
 431       vec_validate_init_empty (vxm->tunnel_index_by_sw_if_index, sw_if_index, ~0);
 432       vxm->tunnel_index_by_sw_if_index[sw_if_index] = dev_instance;
 433
 434       /* setup l2 input config with l2 feature and bd 0 to drop packet */
 435       vec_validate (l2im->configs, sw_if_index);
 436       l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
 437       l2im->configs[sw_if_index].bd_index = 0;
 438
 439       vnet_sw_interface_t * si = vnet_get_sw_interface (vnm, sw_if_index);
 440       si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
 441       vnet_sw_interface_set_flags (vnm, sw_if_index,
 442                                    VNET_SW_INTERFACE_FLAG_ADMIN_UP);
 443
 444       fib_node_init(&t->node, FIB_NODE_TYPE_VXLAN_TUNNEL);
 445       fib_prefix_t tun_dst_pfx;
 446       vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
 447
 448       fib_prefix_from_ip46_addr(&t->dst, &tun_dst_pfx);
 449       if (!ip46_address_is_multicast(&t->dst))
 450         {
 451           /* Unicast tunnel -
 452            * source the FIB entry for the tunnel's destination
 453            * and become a child thereof. The tunnel will then get poked
 454            * when the forwarding for the entry updates, and the tunnel can
 455            * re-stack accordingly
 456            */
 457           vtep_addr_ref(&t->src);
 458           t->fib_entry_index = fib_table_entry_special_add
 459             (t->encap_fib_index, &tun_dst_pfx, FIB_SOURCE_RR,
 460              FIB_ENTRY_FLAG_NONE);
 461           t->sibling_index = fib_entry_child_add
 462             (t->fib_entry_index, FIB_NODE_TYPE_VXLAN_TUNNEL, dev_instance);
 463           vxlan_tunnel_restack_dpo(t);
 464         }
 465       else
 466         {
 467           /* Multicast tunnel -
 468            * as the same mcast group can be used for mutiple mcast tunnels
 469            * with different VNIs, create the output fib adjecency only if
 470            * it does not already exist
 471            */
 472           fib_protocol_t fp = fib_ip_proto(is_ip6);
 473
 474           if (vtep_addr_ref(&t->dst) == 1)
 475           {
 476               fib_node_index_t mfei;
 477               adj_index_t ai;
 478               fib_route_path_t path = {
 479                   .frp_proto = fib_proto_to_dpo(fp),
 480                   .frp_addr = zero_addr,
 481                   .frp_sw_if_index = 0xffffffff,
 482                   .frp_fib_index = ~0,
 483                   .frp_weight = 0,
 484                   .frp_flags = FIB_ROUTE_PATH_LOCAL,
 485               };
 486               const mfib_prefix_t mpfx = {
 487                   .fp_proto = fp,
 488                   .fp_len = (is_ip6 ? 128 : 32),
 489                   .fp_grp_addr = tun_dst_pfx.fp_addr,
 490               };
 491
 492               /*
 493                * Setup the (*,G) to receive traffic on the mcast group
 494                *  - the forwarding interface is for-us
 495                *  - the accepting interface is that from the API
 496                */
 497               mfib_table_entry_path_update(t->encap_fib_index,
 498                                            &mpfx,
 499                                            MFIB_SOURCE_VXLAN,
 500                                            &path,
 501                                            MFIB_ITF_FLAG_FORWARD);
 502
 503               path.frp_sw_if_index = a->mcast_sw_if_index;
 504               path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
 505               mfei = mfib_table_entry_path_update(t->encap_fib_index,
 506                                                   &mpfx,
 507                                                   MFIB_SOURCE_VXLAN,
 508                                                   &path,
 509                                                   MFIB_ITF_FLAG_ACCEPT);
 510
 511               /*
 512                * Create the mcast adjacency to send traffic to the group
 513                */
 514               ai = adj_mcast_add_or_lock(fp,
 515                                          fib_proto_to_link(fp),
 516                                          a->mcast_sw_if_index);
 517
 518               /*
 519                * create a new end-point
 520                */
 521               mcast_shared_add(&t->dst, mfei, ai);
 522           }
 523
 524           dpo_id_t dpo = DPO_INVALID;
 525           mcast_shared_t ep = mcast_shared_get(&t->dst);
 526
 527           /* Stack shared mcast dst mac addr rewrite on encap */
 528           dpo_set (&dpo, DPO_ADJACENCY_MCAST,
 529                    fib_proto_to_dpo(fp),
 530                    ep.mcast_adj_index);
 531
 532           dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
 533           dpo_reset (&dpo);
 534           flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
 535         }
 536
 537       vnet_get_sw_interface (vnet_get_main(), sw_if_index)->flood_class = flood_class;
 538     }
 539   else
 540     {
 541       /* deleting a tunnel: tunnel must exist */
 542       if (!p)
 543         return VNET_API_ERROR_NO_SUCH_ENTRY;
 544
 545       u32 instance = p[0];
 546       t = pool_elt_at_index (vxm->tunnels, instance);
 547
 548       sw_if_index = t->sw_if_index;
 549       vnet_sw_interface_set_flags (vnm, sw_if_index, 0 /* down */);
 550
 551       vxm->tunnel_index_by_sw_if_index[sw_if_index] = ~0;
 552
 553       if (!is_ip6)
 554         hash_unset (vxm->vxlan4_tunnel_by_key, key4.as_u64);
 555       else
 556         hash_unset_mem_free (&vxm->vxlan6_tunnel_by_key, &key6);
 557
 558       if (!ip46_address_is_multicast(&t->dst))
 559         {
 560           vtep_addr_unref(&t->src);
 561           fib_entry_child_remove(t->fib_entry_index, t->sibling_index);
 562           fib_table_entry_delete_index(t->fib_entry_index, FIB_SOURCE_RR);
 563         }
 564       else if (vtep_addr_unref(&t->dst) == 0)
 565         {
 566           mcast_shared_remove(&t->dst);
 567         }
 568
 569       vnet_delete_hw_interface (vnm, t->hw_if_index);
 570       hash_unset (vxm->instance_used, t->user_instance);
 571
 572       fib_node_deinit(&t->node);
 573       pool_put (vxm->tunnels, t);
 574     }
 575
 576   if (sw_if_indexp)
 577       *sw_if_indexp = sw_if_index;
 578
 579   return 0;
 580 }
 581
 582 static uword get_decap_next_for_node(u32 node_index, u32 ipv4_set)
 583 {
 584   vxlan_main_t * vxm = &vxlan_main;
 585   vlib_main_t * vm = vxm->vlib_main;
 586   uword input_node = (ipv4_set) ? vxlan4_input_node.index :
 587     vxlan6_input_node.index;
 588
 589   return vlib_node_add_next (vm, input_node, node_index);
 590 }
 591
 592 static uword unformat_decap_next (unformat_input_t * input, va_list * args)
 593 {
 594   u32 * result = va_arg (*args, u32 *);
 595   u32 ipv4_set = va_arg (*args, int);
 596   vxlan_main_t * vxm = &vxlan_main;
 597   vlib_main_t * vm = vxm->vlib_main;
 598   u32 node_index;
 599   u32 tmp;
 600
 601   if (unformat (input, "l2"))
 602     *result = VXLAN_INPUT_NEXT_L2_INPUT;
 603   else if (unformat (input, "node %U", unformat_vlib_node, vm, &node_index))
 604     *result = get_decap_next_for_node(node_index, ipv4_set);
 605   else if (unformat (input, "%d", &tmp))
 606     *result = tmp;
 607   else
 608     return 0;
 609   return 1;
 610 }
 611
 612 static clib_error_t *
 613 vxlan_add_del_tunnel_command_fn (vlib_main_t * vm,
 614                                    unformat_input_t * input,
 615                                    vlib_cli_command_t * cmd)
 616 {
 617   unformat_input_t _line_input, * line_input = &_line_input;
 618   ip46_address_t src = ip46_address_initializer, dst = ip46_address_initializer;
 619   u8 is_add = 1;
 620   u8 src_set = 0;
 621   u8 dst_set = 0;
 622   u8 grp_set = 0;
 623   u8 ipv4_set = 0;
 624   u8 ipv6_set = 0;
 625   u32 instance = ~0;
 626   u32 encap_fib_index = 0;
 627   u32 mcast_sw_if_index = ~0;
 628   u32 decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
 629   u32 vni = 0;
 630   u32 table_id;
 631   clib_error_t *error = NULL;
 632
 633   /* Get a line of input. */
 634   if (! unformat_user (input, unformat_line_input, line_input))
 635     return 0;
 636
 637   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) {
 638     if (unformat (line_input, "del"))
 639       {
 640         is_add = 0;
 641       }
 642     else if (unformat (line_input, "instance %d", &instance))
 643       ;
 644     else if (unformat (line_input, "src %U",
 645                        unformat_ip46_address, &src, IP46_TYPE_ANY))
 646       {
 647         src_set = 1;
 648         ip46_address_is_ip4(&src) ? (ipv4_set = 1) : (ipv6_set = 1);
 649       }
 650     else if (unformat (line_input, "dst %U",
 651                        unformat_ip46_address, &dst, IP46_TYPE_ANY))
 652       {
 653         dst_set = 1;
 654         ip46_address_is_ip4(&dst) ? (ipv4_set = 1) : (ipv6_set = 1);
 655       }
 656     else if (unformat (line_input, "group %U %U",
 657                        unformat_ip46_address, &dst, IP46_TYPE_ANY,
 658                        unformat_vnet_sw_interface,
 659                        vnet_get_main(), &mcast_sw_if_index))
 660       {
 661         grp_set = dst_set = 1;
 662         ip46_address_is_ip4(&dst) ? (ipv4_set = 1) : (ipv6_set = 1);
 663       }
 664     else if (unformat (line_input, "encap-vrf-id %d", &table_id))
 665       {
 666         encap_fib_index = fib_table_find (fib_ip_proto (ipv6_set), table_id);
 667         if (encap_fib_index == ~0)
 668           {
 669             error = clib_error_return (0, "nonexistent encap-vrf-id %d", table_id);
 670             break;
 671           }
 672       }
 673     else if (unformat (line_input, "decap-next %U", unformat_decap_next,
 674                        &decap_next_index, ipv4_set))
 675       ;
 676     else if (unformat (line_input, "vni %d", &vni))
 677       ;
 678     else
 679       {
 680         error = clib_error_return (0, "parse error: '%U'",
 681                                    format_unformat_error, line_input);
 682         break;
 683       }
 684   }
 685
 686   unformat_free (line_input);
 687
 688   if (error)
 689     return error;
 690
 691   if (src_set == 0)
 692     return clib_error_return (0, "tunnel src address not specified");
 693
 694   if (dst_set == 0)
 695     return clib_error_return (0, "tunnel dst address not specified");
 696
 697   if (grp_set && !ip46_address_is_multicast(&dst))
 698     return clib_error_return (0, "tunnel group address not multicast");
 699
 700   if (grp_set == 0 && ip46_address_is_multicast(&dst))
 701     return clib_error_return (0, "dst address must be unicast");
 702
 703   if (grp_set && mcast_sw_if_index == ~0)
 704     return clib_error_return (0, "tunnel nonexistent multicast device");
 705
 706   if (ipv4_set && ipv6_set)
 707     return clib_error_return (0, "both IPv4 and IPv6 addresses specified");
 708
 709   if (ip46_address_cmp(&src, &dst) == 0)
 710     return clib_error_return (0, "src and dst addresses are identical");
 711
 712   if (decap_next_index == ~0)
 713     return clib_error_return (0, "next node not found");
 714
 715   if (vni == 0)
 716     return clib_error_return (0, "vni not specified");
 717
 718   if (vni >> 24)
 719     return clib_error_return (0, "vni %d out of range", vni);
 720
 721   vnet_vxlan_add_del_tunnel_args_t a = {
 722   .is_add = is_add,
 723   .is_ip6 = ipv6_set,
 724   .instance = instance,
 725 #define _(x) .x = x,
 726   foreach_copy_field
 727 #undef _
 728   };
 729
 730   u32 tunnel_sw_if_index;
 731   int rv = vnet_vxlan_add_del_tunnel (&a, &tunnel_sw_if_index);
 732
 733   switch(rv)
 734     {
 735     case 0:
 736       if (is_add)
 737         vlib_cli_output(vm, "%U\n", format_vnet_sw_if_index_name,
 738                         vnet_get_main(), tunnel_sw_if_index);
 739       break;
 740
 741     case VNET_API_ERROR_TUNNEL_EXIST:
 742       return clib_error_return (0, "tunnel already exists...");
 743
 744     case VNET_API_ERROR_NO_SUCH_ENTRY:
 745       return clib_error_return (0, "tunnel does not exist...");
 746
 747     case VNET_API_ERROR_INSTANCE_IN_USE:
 748       return clib_error_return (0, "Instance is in use");
 749
 750     default:
 751       return clib_error_return
 752         (0, "vnet_vxlan_add_del_tunnel returned %d", rv);
 753     }
 754
 755   return error;
 756 }
 757
 758 /*?
 759  * Add or delete a VXLAN Tunnel.
 760  *
 761  * VXLAN provides the features needed to allow L2 bridge domains (BDs)
 762  * to span multiple servers. This is done by building an L2 overlay on
 763  * top of an L3 network underlay using VXLAN tunnels.
 764  *
 765  * This makes it possible for servers to be co-located in the same data
 766  * center or be separated geographically as long as they are reachable
 767  * through the underlay L3 network.
 768  *
 769  * You can refer to this kind of L2 overlay bridge domain as a VXLAN
 770  * (Virtual eXtensible VLAN) segment.
 771  *
 772  * @cliexpar
 773  * Example of how to create a VXLAN Tunnel:
 774  * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 encap-vrf-id 7}
 775  * Example of how to create a VXLAN Tunnel with a known name, vxlan_tunnel42:
 776  * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 instance 42}
 777  * Example of how to delete a VXLAN Tunnel:
 778  * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 del}
 779  ?*/
 780 /* *INDENT-OFF* */
 781 VLIB_CLI_COMMAND (create_vxlan_tunnel_command, static) = {
 782   .path = "create vxlan tunnel",
 783   .short_help =
 784   "create vxlan tunnel src <local-vtep-addr>"
 785   " {dst <remote-vtep-addr>|group <mcast-vtep-addr> <intf-name>} vni <nn>"
 786   " [instance <id>]"
 787   " [encap-vrf-id <nn>] [decap-next [l2|node <name>]] [del]",
 788   .function = vxlan_add_del_tunnel_command_fn,
 789 };
 790 /* *INDENT-ON* */
 791
 792 static clib_error_t *
 793 show_vxlan_tunnel_command_fn (vlib_main_t * vm,
 794                                 unformat_input_t * input,
 795                                 vlib_cli_command_t * cmd)
 796 {
 797   vxlan_main_t * vxm = &vxlan_main;
 798   vxlan_tunnel_t * t;
 799
 800   if (pool_elts (vxm->tunnels) == 0)
 801     vlib_cli_output (vm, "No vxlan tunnels configured...");
 802
 803   pool_foreach (t, vxm->tunnels,
 804   ({
 805     vlib_cli_output (vm, "%U", format_vxlan_tunnel, t);
 806   }));
 807
 808   return 0;
 809 }
 810
 811 /*?
 812  * Display all the VXLAN Tunnel entries.
 813  *
 814  * @cliexpar
 815  * Example of how to display the VXLAN Tunnel entries:
 816  * @cliexstart{show vxlan tunnel}
 817  * [0] src 10.0.3.1 dst 10.0.3.3 vni 13 encap_fib_index 0 sw_if_index 5 decap_next l2
 818  * @cliexend
 819  ?*/
 820 /* *INDENT-OFF* */
 821 VLIB_CLI_COMMAND (show_vxlan_tunnel_command, static) = {
 822     .path = "show vxlan tunnel",
 823     .short_help = "show vxlan tunnel",
 824     .function = show_vxlan_tunnel_command_fn,
 825 };
 826 /* *INDENT-ON* */
 827
 828
 829 void vnet_int_vxlan_bypass_mode (u32 sw_if_index,
 830                                  u8 is_ip6,
 831                                  u8 is_enable)
 832 {
 833   if (is_ip6)
 834     vnet_feature_enable_disable ("ip6-unicast", "ip6-vxlan-bypass",
 835                                  sw_if_index, is_enable, 0, 0);
 836   else
 837     vnet_feature_enable_disable ("ip4-unicast", "ip4-vxlan-bypass",
 838                                  sw_if_index, is_enable, 0, 0);
 839 }
 840
 841
 842 static clib_error_t *
 843 set_ip_vxlan_bypass (u32 is_ip6,
 844                      unformat_input_t * input,
 845                      vlib_cli_command_t * cmd)
 846 {
 847   unformat_input_t _line_input, * line_input = &_line_input;
 848   vnet_main_t * vnm = vnet_get_main();
 849   clib_error_t * error = 0;
 850   u32 sw_if_index, is_enable;
 851
 852   sw_if_index = ~0;
 853   is_enable = 1;
 854
 855   if (! unformat_user (input, unformat_line_input, line_input))
 856     return 0;
 857
 858   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 859     {
 860       if (unformat_user (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
 861           ;
 862       else if (unformat (line_input, "del"))
 863         is_enable = 0;
 864       else
 865         {
 866           error = unformat_parse_error (line_input);
 867           goto done;
 868         }
 869     }
 870
 871   if (~0 == sw_if_index)
 872     {
 873       error = clib_error_return (0, "unknown interface `%U'",
 874                                  format_unformat_error, line_input);
 875       goto done;
 876     }
 877
 878   vnet_int_vxlan_bypass_mode (sw_if_index, is_ip6, is_enable);
 879
 880  done:
 881   unformat_free (line_input);
 882
 883   return error;
 884 }
 885
 886 static clib_error_t *
 887 set_ip4_vxlan_bypass (vlib_main_t * vm,
 888                       unformat_input_t * input,
 889                       vlib_cli_command_t * cmd)
 890 {
 891   return set_ip_vxlan_bypass (0, input, cmd);
 892 }
 893
 894 /*?
 895  * This command adds the 'ip4-vxlan-bypass' graph node for a given interface.
 896  * By adding the IPv4 vxlan-bypass graph node to an interface, the node checks
 897  *  for and validate input vxlan packet and bypass ip4-lookup, ip4-local,
 898  * ip4-udp-lookup nodes to speedup vxlan packet forwarding. This node will
 899  * cause extra overhead to for non-vxlan packets which is kept at a minimum.
 900  *
 901  * @cliexpar
 902  * @parblock
 903  * Example of graph node before ip4-vxlan-bypass is enabled:
 904  * @cliexstart{show vlib graph ip4-vxlan-bypass}
 905  *            Name                      Next                    Previous
 906  * ip4-vxlan-bypass                error-drop [0]
 907  *                                vxlan4-input [1]
 908  *                                 ip4-lookup [2]
 909  * @cliexend
 910  *
 911  * Example of how to enable ip4-vxlan-bypass on an interface:
 912  * @cliexcmd{set interface ip vxlan-bypass GigabitEthernet2/0/0}
 913  *
 914  * Example of graph node after ip4-vxlan-bypass is enabled:
 915  * @cliexstart{show vlib graph ip4-vxlan-bypass}
 916  *            Name                      Next                    Previous
 917  * ip4-vxlan-bypass                error-drop [0]               ip4-input
 918  *                                vxlan4-input [1]        ip4-input-no-checksum
 919  *                                 ip4-lookup [2]
 920  * @cliexend
 921  *
 922  * Example of how to display the feature enabed on an interface:
 923  * @cliexstart{show ip interface features GigabitEthernet2/0/0}
 924  * IP feature paths configured on GigabitEthernet2/0/0...
 925  * ...
 926  * ipv4 unicast:
 927  *   ip4-vxlan-bypass
 928  *   ip4-lookup
 929  * ...
 930  * @cliexend
 931  *
 932  * Example of how to disable ip4-vxlan-bypass on an interface:
 933  * @cliexcmd{set interface ip vxlan-bypass GigabitEthernet2/0/0 del}
 934  * @endparblock
 935 ?*/
 936 /* *INDENT-OFF* */
 937 VLIB_CLI_COMMAND (set_interface_ip_vxlan_bypass_command, static) = {
 938   .path = "set interface ip vxlan-bypass",
 939   .function = set_ip4_vxlan_bypass,
 940   .short_help = "set interface ip vxlan-bypass <interface> [del]",
 941 };
 942 /* *INDENT-ON* */
 943
 944 static clib_error_t *
 945 set_ip6_vxlan_bypass (vlib_main_t * vm,
 946                       unformat_input_t * input,
 947                       vlib_cli_command_t * cmd)
 948 {
 949   return set_ip_vxlan_bypass (1, input, cmd);
 950 }
 951
 952 /*?
 953  * This command adds the 'ip6-vxlan-bypass' graph node for a given interface.
 954  * By adding the IPv6 vxlan-bypass graph node to an interface, the node checks
 955  *  for and validate input vxlan packet and bypass ip6-lookup, ip6-local,
 956  * ip6-udp-lookup nodes to speedup vxlan packet forwarding. This node will
 957  * cause extra overhead to for non-vxlan packets which is kept at a minimum.
 958  *
 959  * @cliexpar
 960  * @parblock
 961  * Example of graph node before ip6-vxlan-bypass is enabled:
 962  * @cliexstart{show vlib graph ip6-vxlan-bypass}
 963  *            Name                      Next                    Previous
 964  * ip6-vxlan-bypass                error-drop [0]
 965  *                                vxlan6-input [1]
 966  *                                 ip6-lookup [2]
 967  * @cliexend
 968  *
 969  * Example of how to enable ip6-vxlan-bypass on an interface:
 970  * @cliexcmd{set interface ip6 vxlan-bypass GigabitEthernet2/0/0}
 971  *
 972  * Example of graph node after ip6-vxlan-bypass is enabled:
 973  * @cliexstart{show vlib graph ip6-vxlan-bypass}
 974  *            Name                      Next                    Previous
 975  * ip6-vxlan-bypass                error-drop [0]               ip6-input
 976  *                                vxlan6-input [1]        ip4-input-no-checksum
 977  *                                 ip6-lookup [2]
 978  * @cliexend
 979  *
 980  * Example of how to display the feature enabed on an interface:
 981  * @cliexstart{show ip interface features GigabitEthernet2/0/0}
 982  * IP feature paths configured on GigabitEthernet2/0/0...
 983  * ...
 984  * ipv6 unicast:
 985  *   ip6-vxlan-bypass
 986  *   ip6-lookup
 987  * ...
 988  * @cliexend
 989  *
 990  * Example of how to disable ip6-vxlan-bypass on an interface:
 991  * @cliexcmd{set interface ip6 vxlan-bypass GigabitEthernet2/0/0 del}
 992  * @endparblock
 993 ?*/
 994 /* *INDENT-OFF* */
 995 VLIB_CLI_COMMAND (set_interface_ip6_vxlan_bypass_command, static) = {
 996   .path = "set interface ip6 vxlan-bypass",
 997   .function = set_ip6_vxlan_bypass,
 998   .short_help = "set interface ip vxlan-bypass <interface> [del]",
 999 };
1000 /* *INDENT-ON* */
1001
1002 clib_error_t *vxlan_init (vlib_main_t *vm)
1003 {
1004   vxlan_main_t * vxm = &vxlan_main;
1005
1006   vxm->vnet_main = vnet_get_main();
1007   vxm->vlib_main = vm;
1008
1009   /* initialize the ip6 hash */
1010   vxm->vxlan6_tunnel_by_key = hash_create_mem(0,
1011         sizeof(vxlan6_tunnel_key_t),
1012         sizeof(uword));
1013   vxm->vtep6 = hash_create_mem(0,
1014         sizeof(ip6_address_t),
1015         sizeof(uword));
1016   vxm->mcast_shared = hash_create_mem(0,
1017         sizeof(ip46_address_t),
1018         sizeof(mcast_shared_t));
1019
1020   udp_register_dst_port (vm, UDP_DST_PORT_vxlan,
1021                          vxlan4_input_node.index, /* is_ip4 */ 1);
1022   udp_register_dst_port (vm, UDP_DST_PORT_vxlan6,
1023                          vxlan6_input_node.index, /* is_ip4 */ 0);
1024
1025   fib_node_register_type(FIB_NODE_TYPE_VXLAN_TUNNEL, &vxlan_vft);
1026
1027   return 0;
1028 }
1029
1030 VLIB_INIT_FUNCTION(vxlan_init);
1031
1032 /*
1033  * Local Variables:
1034  * eval: (c-set-style "gnu")
1035  * End:
1036  */