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