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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
15 #include <vnet/vxlan/vxlan.h>
16 #include <vnet/ip/format.h>
17 #include <vnet/fib/fib_entry.h>
18 #include <vnet/fib/fib_table.h>
19 #include <vnet/mfib/mfib_table.h>
20 #include <vnet/adj/adj_mcast.h>
21 #include <vnet/interface.h>
22 #include <vlib/vlib.h>
28 * VXLAN provides the features needed to allow L2 bridge domains (BDs)
29 * to span multiple servers. This is done by building an L2 overlay on
30 * top of an L3 network underlay using VXLAN tunnels.
32 * This makes it possible for servers to be co-located in the same data
33 * center or be separated geographically as long as they are reachable
34 * through the underlay L3 network.
36 * You can refer to this kind of L2 overlay bridge domain as a VXLAN
37 * (Virtual eXtensible VLAN) segment.
41 vxlan_main_t vxlan_main;
43 static u8 * format_decap_next (u8 * s, va_list * args)
45 u32 next_index = va_arg (*args, u32);
49 case VXLAN_INPUT_NEXT_DROP:
50 return format (s, "drop");
51 case VXLAN_INPUT_NEXT_L2_INPUT:
52 return format (s, "l2");
54 return format (s, "index %d", next_index);
59 u8 * format_vxlan_tunnel (u8 * s, va_list * args)
61 vxlan_tunnel_t * t = va_arg (*args, vxlan_tunnel_t *);
62 vxlan_main_t * ngm = &vxlan_main;
64 s = format (s, "[%d] src %U dst %U vni %d sw_if_index %d ",
66 format_ip46_address, &t->src, IP46_TYPE_ANY,
67 format_ip46_address, &t->dst, IP46_TYPE_ANY,
68 t->vni, t->sw_if_index);
70 if (ip46_address_is_multicast (&t->dst))
71 s = format (s, "mcast_sw_if_index %d ", t->mcast_sw_if_index);
73 s = format (s, "encap_fib_index %d fib_entry_index %d decap_next %U\n",
74 t->encap_fib_index, t->fib_entry_index,
75 format_decap_next, t->decap_next_index);
79 static u8 * format_vxlan_name (u8 * s, va_list * args)
81 u32 dev_instance = va_arg (*args, u32);
82 return format (s, "vxlan_tunnel%d", dev_instance);
85 static uword dummy_interface_tx (vlib_main_t * vm,
86 vlib_node_runtime_t * node,
89 clib_warning ("you shouldn't be here, leaking buffers...");
90 return frame->n_vectors;
94 vxlan_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
96 u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
97 VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
98 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
100 return /* no error */ 0;
103 VNET_DEVICE_CLASS (vxlan_device_class,static) = {
105 .format_device_name = format_vxlan_name,
106 .format_tx_trace = format_vxlan_encap_trace,
107 .tx_function = dummy_interface_tx,
108 .admin_up_down_function = vxlan_interface_admin_up_down,
111 static u8 * format_vxlan_header_with_length (u8 * s, va_list * args)
113 u32 dev_instance = va_arg (*args, u32);
114 s = format (s, "unimplemented dev %u", dev_instance);
118 VNET_HW_INTERFACE_CLASS (vxlan_hw_class) = {
120 .format_header = format_vxlan_header_with_length,
121 .build_rewrite = default_build_rewrite,
125 vxlan_tunnel_restack_dpo(vxlan_tunnel_t * t)
127 dpo_id_t dpo = DPO_INVALID;
128 u32 encap_index = ip46_address_is_ip4(&t->dst) ?
129 vxlan4_encap_node.index : vxlan6_encap_node.index;
130 fib_forward_chain_type_t forw_type = ip46_address_is_ip4(&t->dst) ?
131 FIB_FORW_CHAIN_TYPE_UNICAST_IP4 : FIB_FORW_CHAIN_TYPE_UNICAST_IP6;
133 fib_entry_contribute_forwarding (t->fib_entry_index, forw_type, &dpo);
134 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
138 static vxlan_tunnel_t *
139 vxlan_tunnel_from_fib_node (fib_node_t *node)
141 ASSERT(FIB_NODE_TYPE_VXLAN_TUNNEL == node->fn_type);
142 return ((vxlan_tunnel_t*) (((char*)node) -
143 STRUCT_OFFSET_OF(vxlan_tunnel_t, node)));
147 * Function definition to backwalk a FIB node -
148 * Here we will restack the new dpo of VXLAN DIP to encap node.
150 static fib_node_back_walk_rc_t
151 vxlan_tunnel_back_walk (fib_node_t *node,
152 fib_node_back_walk_ctx_t *ctx)
154 vxlan_tunnel_restack_dpo(vxlan_tunnel_from_fib_node(node));
155 return (FIB_NODE_BACK_WALK_CONTINUE);
159 * Function definition to get a FIB node from its index
162 vxlan_tunnel_fib_node_get (fib_node_index_t index)
165 vxlan_main_t * vxm = &vxlan_main;
167 t = pool_elt_at_index(vxm->tunnels, index);
173 * Function definition to inform the FIB node that its last lock has gone.
176 vxlan_tunnel_last_lock_gone (fib_node_t *node)
179 * The VXLAN tunnel is a root of the graph. As such
180 * it never has children and thus is never locked.
186 * Virtual function table registered by VXLAN tunnels
187 * for participation in the FIB object graph.
189 const static fib_node_vft_t vxlan_vft = {
190 .fnv_get = vxlan_tunnel_fib_node_get,
191 .fnv_last_lock = vxlan_tunnel_last_lock_gone,
192 .fnv_back_walk = vxlan_tunnel_back_walk,
196 #define foreach_copy_field \
198 _(mcast_sw_if_index) \
200 _(decap_next_index) \
205 vxlan_rewrite (vxlan_tunnel_t * t, bool is_ip6)
208 ip4_vxlan_header_t * h4;
209 ip6_vxlan_header_t * h6;
212 int len = is_ip6 ? sizeof *r.h6 : sizeof *r.h4;
214 vec_validate_aligned (r.rw, len-1, CLIB_CACHE_LINE_BYTES);
217 vxlan_header_t * vxlan;
218 /* Fixed portion of the (outer) ip header */
221 ip4_header_t * ip = &r.h4->ip4;
222 udp = &r.h4->udp, vxlan = &r.h4->vxlan;
223 ip->ip_version_and_header_length = 0x45;
225 ip->protocol = IP_PROTOCOL_UDP;
227 ip->src_address = t->src.ip4;
228 ip->dst_address = t->dst.ip4;
230 /* we fix up the ip4 header length and checksum after-the-fact */
231 ip->checksum = ip4_header_checksum (ip);
235 ip6_header_t * ip = &r.h6->ip6;
236 udp = &r.h6->udp, vxlan = &r.h6->vxlan;
237 ip->ip_version_traffic_class_and_flow_label = clib_host_to_net_u32(6 << 28);
239 ip->protocol = IP_PROTOCOL_UDP;
241 ip->src_address = t->src.ip6;
242 ip->dst_address = t->dst.ip6;
245 /* UDP header, randomize src port on something, maybe? */
246 udp->src_port = clib_host_to_net_u16 (4789);
247 udp->dst_port = clib_host_to_net_u16 (UDP_DST_PORT_vxlan);
250 vnet_set_vni_and_flags(vxlan, t->vni);
257 vxlan_decap_next_is_valid (vxlan_main_t * vxm, u32 is_ip6, u32 decap_next_index)
259 vlib_main_t * vm = vxm->vlib_main;
260 u32 input_idx = (!is_ip6) ? vxlan4_input_node.index : vxlan6_input_node.index;
261 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, input_idx);
263 return decap_next_index < r->n_next_nodes;
267 hash_set_key_copy (uword ** h, void * key, uword v) {
268 size_t ksz = hash_header(*h)->user;
269 void * copy = clib_mem_alloc (ksz);
270 clib_memcpy (copy, key, ksz);
271 hash_set_mem (*h, copy, v);
275 hash_unset_key_free (uword ** h, void * key) {
276 hash_pair_t * hp = hash_get_pair_mem (*h, key);
278 key = uword_to_pointer (hp->key, void *);
279 hash_unset_mem (*h, key);
284 vtep_addr_ref(ip46_address_t *ip)
286 uword *vtep = ip46_address_is_ip4(ip) ?
287 hash_get (vxlan_main.vtep4, ip->ip4.as_u32) :
288 hash_get_mem (vxlan_main.vtep6, &ip->ip6);
291 ip46_address_is_ip4(ip) ?
292 hash_set (vxlan_main.vtep4, ip->ip4.as_u32, 1) :
293 hash_set_key_copy (&vxlan_main.vtep6, &ip->ip6, 1);
298 vtep_addr_unref(ip46_address_t *ip)
300 uword *vtep = ip46_address_is_ip4(ip) ?
301 hash_get (vxlan_main.vtep4, ip->ip4.as_u32) :
302 hash_get_mem (vxlan_main.vtep6, &ip->ip6);
306 ip46_address_is_ip4(ip) ?
307 hash_unset (vxlan_main.vtep4, ip->ip4.as_u32) :
308 hash_unset_key_free (&vxlan_main.vtep6, &ip->ip6);
312 typedef CLIB_PACKED(union {
314 fib_node_index_t mfib_entry_index;
315 adj_index_t mcast_adj_index;
320 static inline mcast_shared_t
321 mcast_shared_get(ip46_address_t * ip)
323 ASSERT(ip46_address_is_multicast(ip));
324 uword * p = hash_get_mem (vxlan_main.mcast_shared, ip);
326 return (mcast_shared_t) { .as_u64 = *p };
330 mcast_shared_add(ip46_address_t *dst,
331 fib_node_index_t mfei,
334 mcast_shared_t new_ep = {
335 .mcast_adj_index = ai,
336 .mfib_entry_index = mfei,
339 hash_set_key_copy (&vxlan_main.mcast_shared, dst, new_ep.as_u64);
343 mcast_shared_remove(ip46_address_t *dst)
345 mcast_shared_t ep = mcast_shared_get(dst);
347 adj_unlock(ep.mcast_adj_index);
348 mfib_table_entry_delete_index(ep.mfib_entry_index,
351 hash_unset_key_free (&vxlan_main.mcast_shared, dst);
354 static inline fib_protocol_t
355 fib_ip_proto(bool is_ip6)
357 return (is_ip6) ? FIB_PROTOCOL_IP6 : FIB_PROTOCOL_IP4;
360 int vnet_vxlan_add_del_tunnel
361 (vnet_vxlan_add_del_tunnel_args_t *a, u32 * sw_if_indexp)
363 vxlan_main_t * vxm = &vxlan_main;
364 vxlan_tunnel_t *t = 0;
365 vnet_main_t * vnm = vxm->vnet_main;
367 u32 hw_if_index = ~0;
368 u32 sw_if_index = ~0;
370 vxlan4_tunnel_key_t key4;
371 vxlan6_tunnel_key_t key6;
372 u32 is_ip6 = a->is_ip6;
376 key4.src = a->dst.ip4.as_u32; /* decap src in key is encap dst in config */
377 key4.vni = clib_host_to_net_u32 (a->vni << 8);
378 p = hash_get (vxm->vxlan4_tunnel_by_key, key4.as_u64);
382 key6.src = a->dst.ip6;
383 key6.vni = clib_host_to_net_u32 (a->vni << 8);
384 p = hash_get_mem (vxm->vxlan6_tunnel_by_key, &key6);
389 l2input_main_t * l2im = &l2input_main;
391 /* adding a tunnel: tunnel must not already exist */
393 return VNET_API_ERROR_TUNNEL_EXIST;
395 /*if not set explicitly, default to l2 */
396 if(a->decap_next_index == ~0)
397 a->decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
398 if (!vxlan_decap_next_is_valid(vxm, is_ip6, a->decap_next_index))
399 return VNET_API_ERROR_INVALID_DECAP_NEXT;
401 pool_get_aligned (vxm->tunnels, t, CLIB_CACHE_LINE_BYTES);
402 memset (t, 0, sizeof (*t));
404 /* copy from arg structure */
405 #define _(x) t->x = a->x;
409 rv = vxlan_rewrite (t, is_ip6);
412 pool_put (vxm->tunnels, t);
418 hash_set_key_copy (&vxm->vxlan6_tunnel_by_key, &key6, t - vxm->tunnels);
420 hash_set (vxm->vxlan4_tunnel_by_key, key4.as_u64, t - vxm->tunnels);
422 vnet_hw_interface_t * hi;
423 if (vec_len (vxm->free_vxlan_tunnel_hw_if_indices) > 0)
425 vnet_interface_main_t * im = &vnm->interface_main;
426 hw_if_index = vxm->free_vxlan_tunnel_hw_if_indices
427 [vec_len (vxm->free_vxlan_tunnel_hw_if_indices)-1];
428 _vec_len (vxm->free_vxlan_tunnel_hw_if_indices) -= 1;
430 hi = vnet_get_hw_interface (vnm, hw_if_index);
431 hi->dev_instance = t - vxm->tunnels;
432 hi->hw_instance = hi->dev_instance;
434 /* clear old stats of freed tunnel before reuse */
435 sw_if_index = hi->sw_if_index;
436 vnet_interface_counter_lock(im);
437 vlib_zero_combined_counter
438 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX], sw_if_index);
439 vlib_zero_combined_counter
440 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_RX], sw_if_index);
441 vlib_zero_simple_counter
442 (&im->sw_if_counters[VNET_INTERFACE_COUNTER_DROP], sw_if_index);
443 vnet_interface_counter_unlock(im);
447 hw_if_index = vnet_register_interface
448 (vnm, vxlan_device_class.index, t - vxm->tunnels,
449 vxlan_hw_class.index, t - vxm->tunnels);
450 hi = vnet_get_hw_interface (vnm, hw_if_index);
453 t->hw_if_index = hw_if_index;
454 t->sw_if_index = sw_if_index = hi->sw_if_index;
456 vec_validate_init_empty (vxm->tunnel_index_by_sw_if_index, sw_if_index, ~0);
457 vxm->tunnel_index_by_sw_if_index[sw_if_index] = t - vxm->tunnels;
459 /* setup l2 input config with l2 feature and bd 0 to drop packet */
460 vec_validate (l2im->configs, sw_if_index);
461 l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
462 l2im->configs[sw_if_index].bd_index = 0;
464 vnet_sw_interface_t * si = vnet_get_sw_interface (vnm, sw_if_index);
465 si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
466 vnet_sw_interface_set_flags (vnm, sw_if_index,
467 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
469 fib_node_init(&t->node, FIB_NODE_TYPE_VXLAN_TUNNEL);
470 fib_prefix_t tun_dst_pfx;
471 u32 encap_index = !is_ip6 ?
472 vxlan4_encap_node.index : vxlan6_encap_node.index;
473 vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
475 fib_prefix_from_ip46_addr(&t->dst, &tun_dst_pfx);
476 if (!ip46_address_is_multicast(&t->dst))
479 * source the FIB entry for the tunnel's destination
480 * and become a child thereof. The tunnel will then get poked
481 * when the forwarding for the entry updates, and the tunnel can
482 * re-stack accordingly
484 vtep_addr_ref(&t->src);
485 t->fib_entry_index = fib_table_entry_special_add
486 (t->encap_fib_index, &tun_dst_pfx, FIB_SOURCE_RR,
487 FIB_ENTRY_FLAG_NONE);
488 t->sibling_index = fib_entry_child_add
489 (t->fib_entry_index, FIB_NODE_TYPE_VXLAN_TUNNEL, t - vxm->tunnels);
490 vxlan_tunnel_restack_dpo(t);
494 /* Multicast tunnel -
495 * as the same mcast group can be used for mutiple mcast tunnels
496 * with different VNIs, create the output fib adjecency only if
497 * it does not already exist
499 fib_protocol_t fp = fib_ip_proto(is_ip6);
501 if (vtep_addr_ref(&t->dst) == 1)
503 fib_node_index_t mfei;
505 fib_route_path_t path = {
506 .frp_proto = fib_proto_to_dpo(fp),
507 .frp_addr = zero_addr,
508 .frp_sw_if_index = 0xffffffff,
511 .frp_flags = FIB_ROUTE_PATH_LOCAL,
513 const mfib_prefix_t mpfx = {
515 .fp_len = (is_ip6 ? 128 : 32),
516 .fp_grp_addr = tun_dst_pfx.fp_addr,
520 * Setup the (*,G) to receive traffic on the mcast group
521 * - the forwarding interface is for-us
522 * - the accepting interface is that from the API
524 mfib_table_entry_path_update(t->encap_fib_index,
528 MFIB_ITF_FLAG_FORWARD);
530 path.frp_sw_if_index = a->mcast_sw_if_index;
531 path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
532 mfei = mfib_table_entry_path_update(t->encap_fib_index,
536 MFIB_ITF_FLAG_ACCEPT);
539 * Create the mcast adjacency to send traffic to the group
541 ai = adj_mcast_add_or_lock(fp,
542 fib_proto_to_link(fp),
543 a->mcast_sw_if_index);
546 * create a new end-point
548 mcast_shared_add(&t->dst, mfei, ai);
551 dpo_id_t dpo = DPO_INVALID;
552 mcast_shared_t ep = mcast_shared_get(&t->dst);
554 /* Stack shared mcast dst mac addr rewrite on encap */
555 dpo_set (&dpo, DPO_ADJACENCY_MCAST,
556 fib_proto_to_dpo(fp),
559 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
561 flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
564 /* Set vxlan tunnel output node */
565 hi->output_node_index = encap_index;
567 vnet_get_sw_interface (vnet_get_main(), sw_if_index)->flood_class = flood_class;
571 /* deleting a tunnel: tunnel must exist */
573 return VNET_API_ERROR_NO_SUCH_ENTRY;
575 t = pool_elt_at_index (vxm->tunnels, p[0]);
577 sw_if_index = t->sw_if_index;
578 vnet_sw_interface_set_flags (vnm, t->sw_if_index, 0 /* down */);
579 vnet_sw_interface_t * si = vnet_get_sw_interface (vnm, t->sw_if_index);
580 si->flags |= VNET_SW_INTERFACE_FLAG_HIDDEN;
582 /* make sure tunnel is removed from l2 bd or xconnect */
583 set_int_l2_mode(vxm->vlib_main, vnm, MODE_L3, t->sw_if_index, 0, 0, 0, 0);
584 vec_add1 (vxm->free_vxlan_tunnel_hw_if_indices, t->hw_if_index);
586 vxm->tunnel_index_by_sw_if_index[t->sw_if_index] = ~0;
589 hash_unset (vxm->vxlan4_tunnel_by_key, key4.as_u64);
591 hash_unset_key_free (&vxm->vxlan6_tunnel_by_key, &key6);
593 if (!ip46_address_is_multicast(&t->dst))
595 vtep_addr_unref(&t->src);
596 fib_entry_child_remove(t->fib_entry_index, t->sibling_index);
597 fib_table_entry_delete_index(t->fib_entry_index, FIB_SOURCE_RR);
599 else if (vtep_addr_unref(&t->dst) == 0)
601 mcast_shared_remove(&t->dst);
604 fib_node_deinit(&t->node);
605 vec_free (t->rewrite);
606 pool_put (vxm->tunnels, t);
610 *sw_if_indexp = sw_if_index;
615 static uword get_decap_next_for_node(u32 node_index, u32 ipv4_set)
617 vxlan_main_t * vxm = &vxlan_main;
618 vlib_main_t * vm = vxm->vlib_main;
619 uword input_node = (ipv4_set) ? vxlan4_input_node.index :
620 vxlan6_input_node.index;
622 return vlib_node_add_next (vm, input_node, node_index);
625 static uword unformat_decap_next (unformat_input_t * input, va_list * args)
627 u32 * result = va_arg (*args, u32 *);
628 u32 ipv4_set = va_arg (*args, int);
629 vxlan_main_t * vxm = &vxlan_main;
630 vlib_main_t * vm = vxm->vlib_main;
634 if (unformat (input, "l2"))
635 *result = VXLAN_INPUT_NEXT_L2_INPUT;
636 else if (unformat (input, "node %U", unformat_vlib_node, vm, &node_index))
637 *result = get_decap_next_for_node(node_index, ipv4_set);
638 else if (unformat (input, "%d", &tmp))
645 static clib_error_t *
646 vxlan_add_del_tunnel_command_fn (vlib_main_t * vm,
647 unformat_input_t * input,
648 vlib_cli_command_t * cmd)
650 unformat_input_t _line_input, * line_input = &_line_input;
651 ip46_address_t src , dst;
658 u32 encap_fib_index = 0;
659 u32 mcast_sw_if_index = ~0;
660 u32 decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
664 vnet_vxlan_add_del_tunnel_args_t _a, * a = &_a;
665 u32 tunnel_sw_if_index;
666 clib_error_t *error = NULL;
668 /* Cant "universally zero init" (={0}) due to GCC bug 53119 */
669 memset(&src, 0, sizeof src);
670 memset(&dst, 0, sizeof dst);
672 /* Get a line of input. */
673 if (! unformat_user (input, unformat_line_input, line_input))
676 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) {
677 if (unformat (line_input, "del"))
681 else if (unformat (line_input, "src %U",
682 unformat_ip4_address, &src.ip4))
687 else if (unformat (line_input, "dst %U",
688 unformat_ip4_address, &dst.ip4))
693 else if (unformat (line_input, "src %U",
694 unformat_ip6_address, &src.ip6))
699 else if (unformat (line_input, "dst %U",
700 unformat_ip6_address, &dst.ip6))
705 else if (unformat (line_input, "group %U %U",
706 unformat_ip4_address, &dst.ip4,
707 unformat_vnet_sw_interface,
708 vnet_get_main(), &mcast_sw_if_index))
710 grp_set = dst_set = 1;
713 else if (unformat (line_input, "group %U %U",
714 unformat_ip6_address, &dst.ip6,
715 unformat_vnet_sw_interface,
716 vnet_get_main(), &mcast_sw_if_index))
718 grp_set = dst_set = 1;
721 else if (unformat (line_input, "encap-vrf-id %d", &tmp))
723 encap_fib_index = fib_table_find (fib_ip_proto (ipv6_set), tmp);
724 if (encap_fib_index == ~0)
726 error = clib_error_return (0, "nonexistent encap-vrf-id %d", tmp);
730 else if (unformat (line_input, "decap-next %U", unformat_decap_next,
731 &decap_next_index, ipv4_set))
733 else if (unformat (line_input, "vni %d", &vni))
737 error = clib_error_return (0, "vni %d out of range", vni);
743 error = clib_error_return (0, "parse error: '%U'",
744 format_unformat_error, line_input);
751 error = clib_error_return (0, "tunnel src address not specified");
757 error = clib_error_return (0, "tunnel dst address not specified");
761 if (grp_set && !ip46_address_is_multicast(&dst))
763 error = clib_error_return (0, "tunnel group address not multicast");
767 if (grp_set == 0 && ip46_address_is_multicast(&dst))
769 error = clib_error_return (0, "dst address must be unicast");
773 if (grp_set && mcast_sw_if_index == ~0)
775 error = clib_error_return (0, "tunnel nonexistent multicast device");
779 if (ipv4_set && ipv6_set)
781 error = clib_error_return (0, "both IPv4 and IPv6 addresses specified");
785 if (ip46_address_cmp(&src, &dst) == 0)
787 error = clib_error_return (0, "src and dst addresses are identical");
791 if (decap_next_index == ~0)
793 error = clib_error_return (0, "next node not found");
799 error = clib_error_return (0, "vni not specified");
803 memset (a, 0, sizeof (*a));
806 a->is_ip6 = ipv6_set;
808 #define _(x) a->x = x;
812 rv = vnet_vxlan_add_del_tunnel (a, &tunnel_sw_if_index);
818 vlib_cli_output(vm, "%U\n", format_vnet_sw_if_index_name,
819 vnet_get_main(), tunnel_sw_if_index);
822 case VNET_API_ERROR_TUNNEL_EXIST:
823 error = clib_error_return (0, "tunnel already exists...");
826 case VNET_API_ERROR_NO_SUCH_ENTRY:
827 error = clib_error_return (0, "tunnel does not exist...");
831 error = clib_error_return
832 (0, "vnet_vxlan_add_del_tunnel returned %d", rv);
837 unformat_free (line_input);
843 * Add or delete a VXLAN Tunnel.
845 * VXLAN provides the features needed to allow L2 bridge domains (BDs)
846 * to span multiple servers. This is done by building an L2 overlay on
847 * top of an L3 network underlay using VXLAN tunnels.
849 * This makes it possible for servers to be co-located in the same data
850 * center or be separated geographically as long as they are reachable
851 * through the underlay L3 network.
853 * You can refer to this kind of L2 overlay bridge domain as a VXLAN
854 * (Virtual eXtensible VLAN) segment.
857 * Example of how to create a VXLAN Tunnel:
858 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 encap-vrf-id 7}
859 * Example of how to delete a VXLAN Tunnel:
860 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 del}
863 VLIB_CLI_COMMAND (create_vxlan_tunnel_command, static) = {
864 .path = "create vxlan tunnel",
866 "create vxlan tunnel src <local-vtep-addr>"
867 " {dst <remote-vtep-addr>|group <mcast-vtep-addr> <intf-name>} vni <nn>"
868 " [encap-vrf-id <nn>] [decap-next [l2|node <name>]] [del]",
869 .function = vxlan_add_del_tunnel_command_fn,
873 static clib_error_t *
874 show_vxlan_tunnel_command_fn (vlib_main_t * vm,
875 unformat_input_t * input,
876 vlib_cli_command_t * cmd)
878 vxlan_main_t * vxm = &vxlan_main;
881 if (pool_elts (vxm->tunnels) == 0)
882 vlib_cli_output (vm, "No vxlan tunnels configured...");
884 pool_foreach (t, vxm->tunnels,
886 vlib_cli_output (vm, "%U", format_vxlan_tunnel, t);
893 * Display all the VXLAN Tunnel entries.
896 * Example of how to display the VXLAN Tunnel entries:
897 * @cliexstart{show vxlan tunnel}
898 * [0] src 10.0.3.1 dst 10.0.3.3 vni 13 encap_fib_index 0 sw_if_index 5 decap_next l2
902 VLIB_CLI_COMMAND (show_vxlan_tunnel_command, static) = {
903 .path = "show vxlan tunnel",
904 .short_help = "show vxlan tunnel",
905 .function = show_vxlan_tunnel_command_fn,
910 void vnet_int_vxlan_bypass_mode (u32 sw_if_index,
915 vnet_feature_enable_disable ("ip6-unicast", "ip6-vxlan-bypass",
916 sw_if_index, is_enable, 0, 0);
918 vnet_feature_enable_disable ("ip4-unicast", "ip4-vxlan-bypass",
919 sw_if_index, is_enable, 0, 0);
923 static clib_error_t *
924 set_ip_vxlan_bypass (u32 is_ip6,
925 unformat_input_t * input,
926 vlib_cli_command_t * cmd)
928 unformat_input_t _line_input, * line_input = &_line_input;
929 vnet_main_t * vnm = vnet_get_main();
930 clib_error_t * error = 0;
931 u32 sw_if_index, is_enable;
936 if (! unformat_user (input, unformat_line_input, line_input))
939 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
941 if (unformat_user (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
943 else if (unformat (line_input, "del"))
947 error = unformat_parse_error (line_input);
952 if (~0 == sw_if_index)
954 error = clib_error_return (0, "unknown interface `%U'",
955 format_unformat_error, line_input);
959 vnet_int_vxlan_bypass_mode (sw_if_index, is_ip6, is_enable);
962 unformat_free (line_input);
967 static clib_error_t *
968 set_ip4_vxlan_bypass (vlib_main_t * vm,
969 unformat_input_t * input,
970 vlib_cli_command_t * cmd)
972 return set_ip_vxlan_bypass (0, input, cmd);
976 * This command adds the 'ip4-vxlan-bypass' graph node for a given interface.
977 * By adding the IPv4 vxlan-bypass graph node to an interface, the node checks
978 * for and validate input vxlan packet and bypass ip4-lookup, ip4-local,
979 * ip4-udp-lookup nodes to speedup vxlan packet forwarding. This node will
980 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
984 * Example of graph node before ip4-vxlan-bypass is enabled:
985 * @cliexstart{show vlib graph ip4-vxlan-bypass}
987 * ip4-vxlan-bypass error-drop [0]
992 * Example of how to enable ip4-vxlan-bypass on an interface:
993 * @cliexcmd{set interface ip vxlan-bypass GigabitEthernet2/0/0}
995 * Example of graph node after ip4-vxlan-bypass is enabled:
996 * @cliexstart{show vlib graph ip4-vxlan-bypass}
998 * ip4-vxlan-bypass error-drop [0] ip4-input
999 * vxlan4-input [1] ip4-input-no-checksum
1003 * Example of how to display the feature enabed on an interface:
1004 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1005 * IP feature paths configured on GigabitEthernet2/0/0...
1013 * Example of how to disable ip4-vxlan-bypass on an interface:
1014 * @cliexcmd{set interface ip vxlan-bypass GigabitEthernet2/0/0 del}
1018 VLIB_CLI_COMMAND (set_interface_ip_vxlan_bypass_command, static) = {
1019 .path = "set interface ip vxlan-bypass",
1020 .function = set_ip4_vxlan_bypass,
1021 .short_help = "set interface ip vxlan-bypass <interface> [del]",
1025 static clib_error_t *
1026 set_ip6_vxlan_bypass (vlib_main_t * vm,
1027 unformat_input_t * input,
1028 vlib_cli_command_t * cmd)
1030 return set_ip_vxlan_bypass (1, input, cmd);
1034 * This command adds the 'ip6-vxlan-bypass' graph node for a given interface.
1035 * By adding the IPv6 vxlan-bypass graph node to an interface, the node checks
1036 * for and validate input vxlan packet and bypass ip6-lookup, ip6-local,
1037 * ip6-udp-lookup nodes to speedup vxlan packet forwarding. This node will
1038 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
1042 * Example of graph node before ip6-vxlan-bypass is enabled:
1043 * @cliexstart{show vlib graph ip6-vxlan-bypass}
1044 * Name Next Previous
1045 * ip6-vxlan-bypass error-drop [0]
1050 * Example of how to enable ip6-vxlan-bypass on an interface:
1051 * @cliexcmd{set interface ip6 vxlan-bypass GigabitEthernet2/0/0}
1053 * Example of graph node after ip6-vxlan-bypass is enabled:
1054 * @cliexstart{show vlib graph ip6-vxlan-bypass}
1055 * Name Next Previous
1056 * ip6-vxlan-bypass error-drop [0] ip6-input
1057 * vxlan6-input [1] ip4-input-no-checksum
1061 * Example of how to display the feature enabed on an interface:
1062 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1063 * IP feature paths configured on GigabitEthernet2/0/0...
1071 * Example of how to disable ip6-vxlan-bypass on an interface:
1072 * @cliexcmd{set interface ip6 vxlan-bypass GigabitEthernet2/0/0 del}
1076 VLIB_CLI_COMMAND (set_interface_ip6_vxlan_bypass_command, static) = {
1077 .path = "set interface ip6 vxlan-bypass",
1078 .function = set_ip6_vxlan_bypass,
1079 .short_help = "set interface ip vxlan-bypass <interface> [del]",
1083 clib_error_t *vxlan_init (vlib_main_t *vm)
1085 vxlan_main_t * vxm = &vxlan_main;
1087 vxm->vnet_main = vnet_get_main();
1088 vxm->vlib_main = vm;
1090 /* initialize the ip6 hash */
1091 vxm->vxlan6_tunnel_by_key = hash_create_mem(0,
1092 sizeof(vxlan6_tunnel_key_t),
1094 vxm->vtep6 = hash_create_mem(0,
1095 sizeof(ip6_address_t),
1097 vxm->mcast_shared = hash_create_mem(0,
1098 sizeof(ip46_address_t),
1099 sizeof(mcast_shared_t));
1101 udp_register_dst_port (vm, UDP_DST_PORT_vxlan,
1102 vxlan4_input_node.index, /* is_ip4 */ 1);
1103 udp_register_dst_port (vm, UDP_DST_PORT_vxlan6,
1104 vxlan6_input_node.index, /* is_ip4 */ 0);
1106 fib_node_register_type(FIB_NODE_TYPE_VXLAN_TUNNEL, &vxlan_vft);
1111 VLIB_INIT_FUNCTION(vxlan_init);