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)
142 ASSERT(FIB_NODE_TYPE_VXLAN_TUNNEL == node->fn_type);
144 return ((vxlan_tunnel_t*) (((char*)node) -
145 STRUCT_OFFSET_OF(vxlan_tunnel_t, node)));
149 * Function definition to backwalk a FIB node -
150 * Here we will restack the new dpo of VXLAN DIP to encap node.
152 static fib_node_back_walk_rc_t
153 vxlan_tunnel_back_walk (fib_node_t *node,
154 fib_node_back_walk_ctx_t *ctx)
156 vxlan_tunnel_restack_dpo(vxlan_tunnel_from_fib_node(node));
157 return (FIB_NODE_BACK_WALK_CONTINUE);
161 * Function definition to get a FIB node from its index
164 vxlan_tunnel_fib_node_get (fib_node_index_t index)
167 vxlan_main_t * vxm = &vxlan_main;
169 t = pool_elt_at_index(vxm->tunnels, index);
175 * Function definition to inform the FIB node that its last lock has gone.
178 vxlan_tunnel_last_lock_gone (fib_node_t *node)
181 * The VXLAN tunnel is a root of the graph. As such
182 * it never has children and thus is never locked.
188 * Virtual function table registered by VXLAN tunnels
189 * for participation in the FIB object graph.
191 const static fib_node_vft_t vxlan_vft = {
192 .fnv_get = vxlan_tunnel_fib_node_get,
193 .fnv_last_lock = vxlan_tunnel_last_lock_gone,
194 .fnv_back_walk = vxlan_tunnel_back_walk,
198 #define foreach_copy_field \
200 _(mcast_sw_if_index) \
202 _(decap_next_index) \
207 vxlan_rewrite (vxlan_tunnel_t * t, bool is_ip6)
210 ip4_vxlan_header_t * h4;
211 ip6_vxlan_header_t * h6;
214 int len = is_ip6 ? sizeof *r.h6 : sizeof *r.h4;
216 vec_validate_aligned (r.rw, len-1, CLIB_CACHE_LINE_BYTES);
219 vxlan_header_t * vxlan;
220 /* Fixed portion of the (outer) ip header */
223 ip4_header_t * ip = &r.h4->ip4;
224 udp = &r.h4->udp, vxlan = &r.h4->vxlan;
225 ip->ip_version_and_header_length = 0x45;
227 ip->protocol = IP_PROTOCOL_UDP;
229 ip->src_address = t->src.ip4;
230 ip->dst_address = t->dst.ip4;
232 /* we fix up the ip4 header length and checksum after-the-fact */
233 ip->checksum = ip4_header_checksum (ip);
237 ip6_header_t * ip = &r.h6->ip6;
238 udp = &r.h6->udp, vxlan = &r.h6->vxlan;
239 ip->ip_version_traffic_class_and_flow_label = clib_host_to_net_u32(6 << 28);
241 ip->protocol = IP_PROTOCOL_UDP;
243 ip->src_address = t->src.ip6;
244 ip->dst_address = t->dst.ip6;
247 /* UDP header, randomize src port on something, maybe? */
248 udp->src_port = clib_host_to_net_u16 (4789);
249 udp->dst_port = clib_host_to_net_u16 (UDP_DST_PORT_vxlan);
252 vnet_set_vni_and_flags(vxlan, t->vni);
259 vxlan_decap_next_is_valid (vxlan_main_t * vxm, u32 is_ip6, u32 decap_next_index)
261 vlib_main_t * vm = vxm->vlib_main;
262 u32 input_idx = (!is_ip6) ? vxlan4_input_node.index : vxlan6_input_node.index;
263 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, input_idx);
265 return decap_next_index < r->n_next_nodes;
269 hash_set_key_copy (uword ** h, void * key, uword v) {
270 size_t ksz = hash_header(*h)->user;
271 void * copy = clib_mem_alloc (ksz);
272 clib_memcpy (copy, key, ksz);
273 hash_set_mem (*h, copy, v);
277 hash_unset_key_free (uword ** h, void * key) {
278 hash_pair_t * hp = hash_get_pair_mem (*h, key);
280 key = uword_to_pointer (hp->key, void *);
281 hash_unset_mem (*h, key);
286 vtep_addr_ref(ip46_address_t *ip)
288 uword *vtep = ip46_address_is_ip4(ip) ?
289 hash_get (vxlan_main.vtep4, ip->ip4.as_u32) :
290 hash_get_mem (vxlan_main.vtep6, &ip->ip6);
293 ip46_address_is_ip4(ip) ?
294 hash_set (vxlan_main.vtep4, ip->ip4.as_u32, 1) :
295 hash_set_key_copy (&vxlan_main.vtep6, &ip->ip6, 1);
300 vtep_addr_unref(ip46_address_t *ip)
302 uword *vtep = ip46_address_is_ip4(ip) ?
303 hash_get (vxlan_main.vtep4, ip->ip4.as_u32) :
304 hash_get_mem (vxlan_main.vtep6, &ip->ip6);
308 ip46_address_is_ip4(ip) ?
309 hash_unset (vxlan_main.vtep4, ip->ip4.as_u32) :
310 hash_unset_key_free (&vxlan_main.vtep6, &ip->ip6);
314 typedef CLIB_PACKED(union {
316 fib_node_index_t mfib_entry_index;
317 adj_index_t mcast_adj_index;
322 static inline mcast_shared_t
323 mcast_shared_get(ip46_address_t * ip)
325 ASSERT(ip46_address_is_multicast(ip));
326 uword * p = hash_get_mem (vxlan_main.mcast_shared, ip);
328 return (mcast_shared_t) { .as_u64 = *p };
332 mcast_shared_add(ip46_address_t *dst,
333 fib_node_index_t mfei,
336 mcast_shared_t new_ep = {
337 .mcast_adj_index = ai,
338 .mfib_entry_index = mfei,
341 hash_set_key_copy (&vxlan_main.mcast_shared, dst, new_ep.as_u64);
345 mcast_shared_remove(ip46_address_t *dst)
347 mcast_shared_t ep = mcast_shared_get(dst);
349 adj_unlock(ep.mcast_adj_index);
350 mfib_table_entry_delete_index(ep.mfib_entry_index,
353 hash_unset_key_free (&vxlan_main.mcast_shared, dst);
356 static inline fib_protocol_t
357 fib_ip_proto(bool is_ip6)
359 return (is_ip6) ? FIB_PROTOCOL_IP6 : FIB_PROTOCOL_IP4;
362 int vnet_vxlan_add_del_tunnel
363 (vnet_vxlan_add_del_tunnel_args_t *a, u32 * sw_if_indexp)
365 vxlan_main_t * vxm = &vxlan_main;
366 vxlan_tunnel_t *t = 0;
367 vnet_main_t * vnm = vxm->vnet_main;
369 u32 hw_if_index = ~0;
370 u32 sw_if_index = ~0;
372 vxlan4_tunnel_key_t key4;
373 vxlan6_tunnel_key_t key6;
374 u32 is_ip6 = a->is_ip6;
378 key4.src = a->dst.ip4.as_u32; /* decap src in key is encap dst in config */
379 key4.vni = clib_host_to_net_u32 (a->vni << 8);
380 p = hash_get (vxm->vxlan4_tunnel_by_key, key4.as_u64);
384 key6.src = a->dst.ip6;
385 key6.vni = clib_host_to_net_u32 (a->vni << 8);
386 p = hash_get_mem (vxm->vxlan6_tunnel_by_key, &key6);
391 l2input_main_t * l2im = &l2input_main;
393 /* adding a tunnel: tunnel must not already exist */
395 return VNET_API_ERROR_TUNNEL_EXIST;
397 /*if not set explicitly, default to l2 */
398 if(a->decap_next_index == ~0)
399 a->decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
400 if (!vxlan_decap_next_is_valid(vxm, is_ip6, a->decap_next_index))
401 return VNET_API_ERROR_INVALID_DECAP_NEXT;
403 pool_get_aligned (vxm->tunnels, t, CLIB_CACHE_LINE_BYTES);
404 memset (t, 0, sizeof (*t));
406 /* copy from arg structure */
407 #define _(x) t->x = a->x;
411 rv = vxlan_rewrite (t, is_ip6);
414 pool_put (vxm->tunnels, t);
420 hash_set_key_copy (&vxm->vxlan6_tunnel_by_key, &key6, t - vxm->tunnels);
422 hash_set (vxm->vxlan4_tunnel_by_key, key4.as_u64, t - vxm->tunnels);
424 vnet_hw_interface_t * hi;
425 if (vec_len (vxm->free_vxlan_tunnel_hw_if_indices) > 0)
427 vnet_interface_main_t * im = &vnm->interface_main;
428 hw_if_index = vxm->free_vxlan_tunnel_hw_if_indices
429 [vec_len (vxm->free_vxlan_tunnel_hw_if_indices)-1];
430 _vec_len (vxm->free_vxlan_tunnel_hw_if_indices) -= 1;
432 hi = vnet_get_hw_interface (vnm, hw_if_index);
433 hi->dev_instance = t - vxm->tunnels;
434 hi->hw_instance = hi->dev_instance;
436 /* clear old stats of freed tunnel before reuse */
437 sw_if_index = hi->sw_if_index;
438 vnet_interface_counter_lock(im);
439 vlib_zero_combined_counter
440 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX], sw_if_index);
441 vlib_zero_combined_counter
442 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_RX], sw_if_index);
443 vlib_zero_simple_counter
444 (&im->sw_if_counters[VNET_INTERFACE_COUNTER_DROP], sw_if_index);
445 vnet_interface_counter_unlock(im);
449 hw_if_index = vnet_register_interface
450 (vnm, vxlan_device_class.index, t - vxm->tunnels,
451 vxlan_hw_class.index, t - vxm->tunnels);
452 hi = vnet_get_hw_interface (vnm, hw_if_index);
455 t->hw_if_index = hw_if_index;
456 t->sw_if_index = sw_if_index = hi->sw_if_index;
458 vec_validate_init_empty (vxm->tunnel_index_by_sw_if_index, sw_if_index, ~0);
459 vxm->tunnel_index_by_sw_if_index[sw_if_index] = t - vxm->tunnels;
461 /* setup l2 input config with l2 feature and bd 0 to drop packet */
462 vec_validate (l2im->configs, sw_if_index);
463 l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
464 l2im->configs[sw_if_index].bd_index = 0;
466 vnet_sw_interface_t * si = vnet_get_sw_interface (vnm, sw_if_index);
467 si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
468 vnet_sw_interface_set_flags (vnm, sw_if_index,
469 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
471 fib_node_init(&t->node, FIB_NODE_TYPE_VXLAN_TUNNEL);
472 fib_prefix_t tun_dst_pfx;
473 u32 encap_index = !is_ip6 ?
474 vxlan4_encap_node.index : vxlan6_encap_node.index;
475 vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
477 fib_prefix_from_ip46_addr(&t->dst, &tun_dst_pfx);
478 if (!ip46_address_is_multicast(&t->dst))
481 * source the FIB entry for the tunnel's destination
482 * and become a child thereof. The tunnel will then get poked
483 * when the forwarding for the entry updates, and the tunnel can
484 * re-stack accordingly
486 vtep_addr_ref(&t->src);
487 t->fib_entry_index = fib_table_entry_special_add
488 (t->encap_fib_index, &tun_dst_pfx, FIB_SOURCE_RR,
489 FIB_ENTRY_FLAG_NONE);
490 t->sibling_index = fib_entry_child_add
491 (t->fib_entry_index, FIB_NODE_TYPE_VXLAN_TUNNEL, t - vxm->tunnels);
492 vxlan_tunnel_restack_dpo(t);
496 /* Multicast tunnel -
497 * as the same mcast group can be used for mutiple mcast tunnels
498 * with different VNIs, create the output fib adjecency only if
499 * it does not already exist
501 fib_protocol_t fp = fib_ip_proto(is_ip6);
503 if (vtep_addr_ref(&t->dst) == 1)
505 fib_node_index_t mfei;
507 fib_route_path_t path = {
509 .frp_addr = zero_addr,
510 .frp_sw_if_index = 0xffffffff,
513 .frp_flags = FIB_ROUTE_PATH_LOCAL,
515 const mfib_prefix_t mpfx = {
517 .fp_len = (is_ip6 ? 128 : 32),
518 .fp_grp_addr = tun_dst_pfx.fp_addr,
522 * Setup the (*,G) to receive traffic on the mcast group
523 * - the forwarding interface is for-us
524 * - the accepting interface is that from the API
526 mfib_table_entry_path_update(t->encap_fib_index,
530 MFIB_ITF_FLAG_FORWARD);
532 path.frp_sw_if_index = a->mcast_sw_if_index;
533 path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
534 mfei = mfib_table_entry_path_update(t->encap_fib_index,
538 MFIB_ITF_FLAG_ACCEPT);
541 * Create the mcast adjacency to send traffic to the group
543 ai = adj_mcast_add_or_lock(fp,
544 fib_proto_to_link(fp),
545 a->mcast_sw_if_index);
548 * create a new end-point
550 mcast_shared_add(&t->dst, mfei, ai);
553 dpo_id_t dpo = DPO_INVALID;
554 mcast_shared_t ep = mcast_shared_get(&t->dst);
556 /* Stack shared mcast dst mac addr rewrite on encap */
557 dpo_set (&dpo, DPO_ADJACENCY_MCAST,
558 fib_proto_to_dpo(fp),
561 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
563 flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
566 /* Set vxlan tunnel output node */
567 hi->output_node_index = encap_index;
569 vnet_get_sw_interface (vnet_get_main(), sw_if_index)->flood_class = flood_class;
573 /* deleting a tunnel: tunnel must exist */
575 return VNET_API_ERROR_NO_SUCH_ENTRY;
577 t = pool_elt_at_index (vxm->tunnels, p[0]);
579 sw_if_index = t->sw_if_index;
580 vnet_sw_interface_set_flags (vnm, t->sw_if_index, 0 /* down */);
581 vnet_sw_interface_t * si = vnet_get_sw_interface (vnm, t->sw_if_index);
582 si->flags |= VNET_SW_INTERFACE_FLAG_HIDDEN;
584 /* make sure tunnel is removed from l2 bd or xconnect */
585 set_int_l2_mode(vxm->vlib_main, vnm, MODE_L3, t->sw_if_index, 0, 0, 0, 0);
586 vec_add1 (vxm->free_vxlan_tunnel_hw_if_indices, t->hw_if_index);
588 vxm->tunnel_index_by_sw_if_index[t->sw_if_index] = ~0;
591 hash_unset (vxm->vxlan4_tunnel_by_key, key4.as_u64);
593 hash_unset_key_free (&vxm->vxlan6_tunnel_by_key, &key6);
595 if (!ip46_address_is_multicast(&t->dst))
597 vtep_addr_unref(&t->src);
598 fib_entry_child_remove(t->fib_entry_index, t->sibling_index);
599 fib_table_entry_delete_index(t->fib_entry_index, FIB_SOURCE_RR);
601 else if (vtep_addr_unref(&t->dst) == 0)
603 mcast_shared_remove(&t->dst);
606 fib_node_deinit(&t->node);
607 vec_free (t->rewrite);
608 pool_put (vxm->tunnels, t);
612 *sw_if_indexp = sw_if_index;
617 static uword get_decap_next_for_node(u32 node_index, u32 ipv4_set)
619 vxlan_main_t * vxm = &vxlan_main;
620 vlib_main_t * vm = vxm->vlib_main;
621 uword input_node = (ipv4_set) ? vxlan4_input_node.index :
622 vxlan6_input_node.index;
624 return vlib_node_add_next (vm, input_node, node_index);
627 static uword unformat_decap_next (unformat_input_t * input, va_list * args)
629 u32 * result = va_arg (*args, u32 *);
630 u32 ipv4_set = va_arg (*args, int);
631 vxlan_main_t * vxm = &vxlan_main;
632 vlib_main_t * vm = vxm->vlib_main;
636 if (unformat (input, "l2"))
637 *result = VXLAN_INPUT_NEXT_L2_INPUT;
638 else if (unformat (input, "node %U", unformat_vlib_node, vm, &node_index))
639 *result = get_decap_next_for_node(node_index, ipv4_set);
640 else if (unformat (input, "%d", &tmp))
647 static clib_error_t *
648 vxlan_add_del_tunnel_command_fn (vlib_main_t * vm,
649 unformat_input_t * input,
650 vlib_cli_command_t * cmd)
652 unformat_input_t _line_input, * line_input = &_line_input;
653 ip46_address_t src , dst;
660 u32 encap_fib_index = 0;
661 u32 mcast_sw_if_index = ~0;
662 u32 decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
666 vnet_vxlan_add_del_tunnel_args_t _a, * a = &_a;
667 u32 tunnel_sw_if_index;
668 clib_error_t *error = NULL;
670 /* Cant "universally zero init" (={0}) due to GCC bug 53119 */
671 memset(&src, 0, sizeof src);
672 memset(&dst, 0, sizeof dst);
674 /* Get a line of input. */
675 if (! unformat_user (input, unformat_line_input, line_input))
678 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) {
679 if (unformat (line_input, "del"))
683 else if (unformat (line_input, "src %U",
684 unformat_ip4_address, &src.ip4))
689 else if (unformat (line_input, "dst %U",
690 unformat_ip4_address, &dst.ip4))
695 else if (unformat (line_input, "src %U",
696 unformat_ip6_address, &src.ip6))
701 else if (unformat (line_input, "dst %U",
702 unformat_ip6_address, &dst.ip6))
707 else if (unformat (line_input, "group %U %U",
708 unformat_ip4_address, &dst.ip4,
709 unformat_vnet_sw_interface,
710 vnet_get_main(), &mcast_sw_if_index))
712 grp_set = dst_set = 1;
715 else if (unformat (line_input, "group %U %U",
716 unformat_ip6_address, &dst.ip6,
717 unformat_vnet_sw_interface,
718 vnet_get_main(), &mcast_sw_if_index))
720 grp_set = dst_set = 1;
723 else if (unformat (line_input, "encap-vrf-id %d", &tmp))
725 encap_fib_index = fib_table_find (fib_ip_proto (ipv6_set), tmp);
726 if (encap_fib_index == ~0)
728 error = clib_error_return (0, "nonexistent encap-vrf-id %d", tmp);
732 else if (unformat (line_input, "decap-next %U", unformat_decap_next,
733 &decap_next_index, ipv4_set))
735 else if (unformat (line_input, "vni %d", &vni))
739 error = clib_error_return (0, "vni %d out of range", vni);
745 error = clib_error_return (0, "parse error: '%U'",
746 format_unformat_error, line_input);
753 error = clib_error_return (0, "tunnel src address not specified");
759 error = clib_error_return (0, "tunnel dst address not specified");
763 if (grp_set && !ip46_address_is_multicast(&dst))
765 error = clib_error_return (0, "tunnel group address not multicast");
769 if (grp_set == 0 && ip46_address_is_multicast(&dst))
771 error = clib_error_return (0, "dst address must be unicast");
775 if (grp_set && mcast_sw_if_index == ~0)
777 error = clib_error_return (0, "tunnel nonexistent multicast device");
781 if (ipv4_set && ipv6_set)
783 error = clib_error_return (0, "both IPv4 and IPv6 addresses specified");
787 if (ip46_address_cmp(&src, &dst) == 0)
789 error = clib_error_return (0, "src and dst addresses are identical");
793 if (decap_next_index == ~0)
795 error = clib_error_return (0, "next node not found");
801 error = clib_error_return (0, "vni not specified");
805 memset (a, 0, sizeof (*a));
808 a->is_ip6 = ipv6_set;
810 #define _(x) a->x = x;
814 rv = vnet_vxlan_add_del_tunnel (a, &tunnel_sw_if_index);
820 vlib_cli_output(vm, "%U\n", format_vnet_sw_if_index_name,
821 vnet_get_main(), tunnel_sw_if_index);
824 case VNET_API_ERROR_TUNNEL_EXIST:
825 error = clib_error_return (0, "tunnel already exists...");
828 case VNET_API_ERROR_NO_SUCH_ENTRY:
829 error = clib_error_return (0, "tunnel does not exist...");
833 error = clib_error_return
834 (0, "vnet_vxlan_add_del_tunnel returned %d", rv);
839 unformat_free (line_input);
845 * Add or delete a VXLAN Tunnel.
847 * VXLAN provides the features needed to allow L2 bridge domains (BDs)
848 * to span multiple servers. This is done by building an L2 overlay on
849 * top of an L3 network underlay using VXLAN tunnels.
851 * This makes it possible for servers to be co-located in the same data
852 * center or be separated geographically as long as they are reachable
853 * through the underlay L3 network.
855 * You can refer to this kind of L2 overlay bridge domain as a VXLAN
856 * (Virtual eXtensible VLAN) segment.
859 * Example of how to create a VXLAN Tunnel:
860 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 encap-vrf-id 7}
861 * Example of how to delete a VXLAN Tunnel:
862 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 del}
865 VLIB_CLI_COMMAND (create_vxlan_tunnel_command, static) = {
866 .path = "create vxlan tunnel",
868 "create vxlan tunnel src <local-vtep-addr>"
869 " {dst <remote-vtep-addr>|group <mcast-vtep-addr> <intf-name>} vni <nn>"
870 " [encap-vrf-id <nn>] [decap-next [l2|node <name>]] [del]",
871 .function = vxlan_add_del_tunnel_command_fn,
875 static clib_error_t *
876 show_vxlan_tunnel_command_fn (vlib_main_t * vm,
877 unformat_input_t * input,
878 vlib_cli_command_t * cmd)
880 vxlan_main_t * vxm = &vxlan_main;
883 if (pool_elts (vxm->tunnels) == 0)
884 vlib_cli_output (vm, "No vxlan tunnels configured...");
886 pool_foreach (t, vxm->tunnels,
888 vlib_cli_output (vm, "%U", format_vxlan_tunnel, t);
895 * Display all the VXLAN Tunnel entries.
898 * Example of how to display the VXLAN Tunnel entries:
899 * @cliexstart{show vxlan tunnel}
900 * [0] src 10.0.3.1 dst 10.0.3.3 vni 13 encap_fib_index 0 sw_if_index 5 decap_next l2
904 VLIB_CLI_COMMAND (show_vxlan_tunnel_command, static) = {
905 .path = "show vxlan tunnel",
906 .short_help = "show vxlan tunnel",
907 .function = show_vxlan_tunnel_command_fn,
912 void vnet_int_vxlan_bypass_mode (u32 sw_if_index,
917 vnet_feature_enable_disable ("ip6-unicast", "ip6-vxlan-bypass",
918 sw_if_index, is_enable, 0, 0);
920 vnet_feature_enable_disable ("ip4-unicast", "ip4-vxlan-bypass",
921 sw_if_index, is_enable, 0, 0);
925 static clib_error_t *
926 set_ip_vxlan_bypass (u32 is_ip6,
927 unformat_input_t * input,
928 vlib_cli_command_t * cmd)
930 unformat_input_t _line_input, * line_input = &_line_input;
931 vnet_main_t * vnm = vnet_get_main();
932 clib_error_t * error = 0;
933 u32 sw_if_index, is_enable;
938 if (! unformat_user (input, unformat_line_input, line_input))
941 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
943 if (unformat_user (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
945 else if (unformat (line_input, "del"))
949 error = unformat_parse_error (line_input);
954 if (~0 == sw_if_index)
956 error = clib_error_return (0, "unknown interface `%U'",
957 format_unformat_error, line_input);
961 vnet_int_vxlan_bypass_mode (sw_if_index, is_ip6, is_enable);
964 unformat_free (line_input);
969 static clib_error_t *
970 set_ip4_vxlan_bypass (vlib_main_t * vm,
971 unformat_input_t * input,
972 vlib_cli_command_t * cmd)
974 return set_ip_vxlan_bypass (0, input, cmd);
978 * This command adds the 'ip4-vxlan-bypass' graph node for a given interface.
979 * By adding the IPv4 vxlan-bypass graph node to an interface, the node checks
980 * for and validate input vxlan packet and bypass ip4-lookup, ip4-local,
981 * ip4-udp-lookup nodes to speedup vxlan packet forwarding. This node will
982 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
986 * Example of graph node before ip4-vxlan-bypass is enabled:
987 * @cliexstart{show vlib graph ip4-vxlan-bypass}
989 * ip4-vxlan-bypass error-drop [0]
994 * Example of how to enable ip4-vxlan-bypass on an interface:
995 * @cliexcmd{set interface ip vxlan-bypass GigabitEthernet2/0/0}
997 * Example of graph node after ip4-vxlan-bypass is enabled:
998 * @cliexstart{show vlib graph ip4-vxlan-bypass}
1000 * ip4-vxlan-bypass error-drop [0] ip4-input
1001 * vxlan4-input [1] ip4-input-no-checksum
1005 * Example of how to display the feature enabed on an interface:
1006 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1007 * IP feature paths configured on GigabitEthernet2/0/0...
1015 * Example of how to disable ip4-vxlan-bypass on an interface:
1016 * @cliexcmd{set interface ip vxlan-bypass GigabitEthernet2/0/0 del}
1020 VLIB_CLI_COMMAND (set_interface_ip_vxlan_bypass_command, static) = {
1021 .path = "set interface ip vxlan-bypass",
1022 .function = set_ip4_vxlan_bypass,
1023 .short_help = "set interface ip vxlan-bypass <interface> [del]",
1027 static clib_error_t *
1028 set_ip6_vxlan_bypass (vlib_main_t * vm,
1029 unformat_input_t * input,
1030 vlib_cli_command_t * cmd)
1032 return set_ip_vxlan_bypass (1, input, cmd);
1036 * This command adds the 'ip6-vxlan-bypass' graph node for a given interface.
1037 * By adding the IPv6 vxlan-bypass graph node to an interface, the node checks
1038 * for and validate input vxlan packet and bypass ip6-lookup, ip6-local,
1039 * ip6-udp-lookup nodes to speedup vxlan packet forwarding. This node will
1040 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
1044 * Example of graph node before ip6-vxlan-bypass is enabled:
1045 * @cliexstart{show vlib graph ip6-vxlan-bypass}
1046 * Name Next Previous
1047 * ip6-vxlan-bypass error-drop [0]
1052 * Example of how to enable ip6-vxlan-bypass on an interface:
1053 * @cliexcmd{set interface ip6 vxlan-bypass GigabitEthernet2/0/0}
1055 * Example of graph node after ip6-vxlan-bypass is enabled:
1056 * @cliexstart{show vlib graph ip6-vxlan-bypass}
1057 * Name Next Previous
1058 * ip6-vxlan-bypass error-drop [0] ip6-input
1059 * vxlan6-input [1] ip4-input-no-checksum
1063 * Example of how to display the feature enabed on an interface:
1064 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1065 * IP feature paths configured on GigabitEthernet2/0/0...
1073 * Example of how to disable ip6-vxlan-bypass on an interface:
1074 * @cliexcmd{set interface ip6 vxlan-bypass GigabitEthernet2/0/0 del}
1078 VLIB_CLI_COMMAND (set_interface_ip6_vxlan_bypass_command, static) = {
1079 .path = "set interface ip6 vxlan-bypass",
1080 .function = set_ip6_vxlan_bypass,
1081 .short_help = "set interface ip vxlan-bypass <interface> [del]",
1085 clib_error_t *vxlan_init (vlib_main_t *vm)
1087 vxlan_main_t * vxm = &vxlan_main;
1089 vxm->vnet_main = vnet_get_main();
1090 vxm->vlib_main = vm;
1092 /* initialize the ip6 hash */
1093 vxm->vxlan6_tunnel_by_key = hash_create_mem(0,
1094 sizeof(vxlan6_tunnel_key_t),
1096 vxm->vtep6 = hash_create_mem(0,
1097 sizeof(ip6_address_t),
1099 vxm->mcast_shared = hash_create_mem(0,
1100 sizeof(ip46_address_t),
1101 sizeof(mcast_shared_t));
1103 udp_register_dst_port (vm, UDP_DST_PORT_vxlan,
1104 vxlan4_input_node.index, /* is_ip4 */ 1);
1105 udp_register_dst_port (vm, UDP_DST_PORT_vxlan6,
1106 vxlan6_input_node.index, /* is_ip4 */ 0);
1108 fib_node_register_type(FIB_NODE_TYPE_VXLAN_TUNNEL, &vxlan_vft);
1113 VLIB_INIT_FUNCTION(vxlan_init);