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);
47 if (next_index == VXLAN_INPUT_NEXT_DROP)
48 return format (s, "drop");
50 return format (s, "index %d", next_index);
54 u8 * format_vxlan_tunnel (u8 * s, va_list * args)
56 vxlan_tunnel_t * t = va_arg (*args, vxlan_tunnel_t *);
57 vxlan_main_t * ngm = &vxlan_main;
59 s = format (s, "[%d] src %U dst %U vni %d fib-idx %d sw-if-idx %d ",
61 format_ip46_address, &t->src, IP46_TYPE_ANY,
62 format_ip46_address, &t->dst, IP46_TYPE_ANY,
63 t->vni, t->encap_fib_index, t->sw_if_index);
65 s = format (s, "encap-dpo-idx %d ", t->next_dpo.dpoi_index);
67 if (PREDICT_FALSE (t->decap_next_index != VXLAN_INPUT_NEXT_L2_INPUT))
68 s = format (s, "decap-next-%U ", format_decap_next, t->decap_next_index);
70 if (PREDICT_FALSE (ip46_address_is_multicast (&t->dst)))
71 s = format (s, "mcast-sw-if-idx %d ", t->mcast_sw_if_index);
76 static u8 * format_vxlan_name (u8 * s, va_list * args)
78 u32 dev_instance = va_arg (*args, u32);
79 return format (s, "vxlan_tunnel%d", dev_instance);
82 static uword dummy_interface_tx (vlib_main_t * vm,
83 vlib_node_runtime_t * node,
86 clib_warning ("you shouldn't be here, leaking buffers...");
87 return frame->n_vectors;
91 vxlan_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
93 u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
94 VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
95 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
97 return /* no error */ 0;
100 VNET_DEVICE_CLASS (vxlan_device_class,static) = {
102 .format_device_name = format_vxlan_name,
103 .format_tx_trace = format_vxlan_encap_trace,
104 .tx_function = dummy_interface_tx,
105 .admin_up_down_function = vxlan_interface_admin_up_down,
108 static u8 * format_vxlan_header_with_length (u8 * s, va_list * args)
110 u32 dev_instance = va_arg (*args, u32);
111 s = format (s, "unimplemented dev %u", dev_instance);
115 VNET_HW_INTERFACE_CLASS (vxlan_hw_class) = {
117 .format_header = format_vxlan_header_with_length,
118 .build_rewrite = default_build_rewrite,
122 vxlan_tunnel_restack_dpo(vxlan_tunnel_t * t)
124 dpo_id_t dpo = DPO_INVALID;
125 u32 encap_index = ip46_address_is_ip4(&t->dst) ?
126 vxlan4_encap_node.index : vxlan6_encap_node.index;
127 fib_forward_chain_type_t forw_type = ip46_address_is_ip4(&t->dst) ?
128 FIB_FORW_CHAIN_TYPE_UNICAST_IP4 : FIB_FORW_CHAIN_TYPE_UNICAST_IP6;
130 fib_entry_contribute_forwarding (t->fib_entry_index, forw_type, &dpo);
131 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
135 static vxlan_tunnel_t *
136 vxlan_tunnel_from_fib_node (fib_node_t *node)
138 ASSERT(FIB_NODE_TYPE_VXLAN_TUNNEL == node->fn_type);
139 return ((vxlan_tunnel_t*) (((char*)node) -
140 STRUCT_OFFSET_OF(vxlan_tunnel_t, node)));
144 * Function definition to backwalk a FIB node -
145 * Here we will restack the new dpo of VXLAN DIP to encap node.
147 static fib_node_back_walk_rc_t
148 vxlan_tunnel_back_walk (fib_node_t *node,
149 fib_node_back_walk_ctx_t *ctx)
151 vxlan_tunnel_restack_dpo(vxlan_tunnel_from_fib_node(node));
152 return (FIB_NODE_BACK_WALK_CONTINUE);
156 * Function definition to get a FIB node from its index
159 vxlan_tunnel_fib_node_get (fib_node_index_t index)
162 vxlan_main_t * vxm = &vxlan_main;
164 t = pool_elt_at_index(vxm->tunnels, index);
170 * Function definition to inform the FIB node that its last lock has gone.
173 vxlan_tunnel_last_lock_gone (fib_node_t *node)
176 * The VXLAN tunnel is a root of the graph. As such
177 * it never has children and thus is never locked.
183 * Virtual function table registered by VXLAN tunnels
184 * for participation in the FIB object graph.
186 const static fib_node_vft_t vxlan_vft = {
187 .fnv_get = vxlan_tunnel_fib_node_get,
188 .fnv_last_lock = vxlan_tunnel_last_lock_gone,
189 .fnv_back_walk = vxlan_tunnel_back_walk,
193 #define foreach_copy_field \
195 _(mcast_sw_if_index) \
197 _(decap_next_index) \
202 vxlan_rewrite (vxlan_tunnel_t * t, bool is_ip6)
205 ip4_vxlan_header_t * h4;
206 ip6_vxlan_header_t * h6;
209 int len = is_ip6 ? sizeof *r.h6 : sizeof *r.h4;
211 vec_validate_aligned (r.rw, len-1, CLIB_CACHE_LINE_BYTES);
214 vxlan_header_t * vxlan;
215 /* Fixed portion of the (outer) ip header */
218 ip4_header_t * ip = &r.h4->ip4;
219 udp = &r.h4->udp, vxlan = &r.h4->vxlan;
220 ip->ip_version_and_header_length = 0x45;
222 ip->protocol = IP_PROTOCOL_UDP;
224 ip->src_address = t->src.ip4;
225 ip->dst_address = t->dst.ip4;
227 /* we fix up the ip4 header length and checksum after-the-fact */
228 ip->checksum = ip4_header_checksum (ip);
232 ip6_header_t * ip = &r.h6->ip6;
233 udp = &r.h6->udp, vxlan = &r.h6->vxlan;
234 ip->ip_version_traffic_class_and_flow_label = clib_host_to_net_u32(6 << 28);
236 ip->protocol = IP_PROTOCOL_UDP;
238 ip->src_address = t->src.ip6;
239 ip->dst_address = t->dst.ip6;
242 /* UDP header, randomize src port on something, maybe? */
243 udp->src_port = clib_host_to_net_u16 (4789);
244 udp->dst_port = clib_host_to_net_u16 (UDP_DST_PORT_vxlan);
247 vnet_set_vni_and_flags(vxlan, t->vni);
254 vxlan_decap_next_is_valid (vxlan_main_t * vxm, u32 is_ip6, u32 decap_next_index)
256 vlib_main_t * vm = vxm->vlib_main;
257 u32 input_idx = (!is_ip6) ? vxlan4_input_node.index : vxlan6_input_node.index;
258 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, input_idx);
260 return decap_next_index < r->n_next_nodes;
264 vtep_addr_ref(ip46_address_t *ip)
266 uword *vtep = ip46_address_is_ip4(ip) ?
267 hash_get (vxlan_main.vtep4, ip->ip4.as_u32) :
268 hash_get_mem (vxlan_main.vtep6, &ip->ip6);
271 ip46_address_is_ip4(ip) ?
272 hash_set (vxlan_main.vtep4, ip->ip4.as_u32, 1) :
273 hash_set_mem_alloc (&vxlan_main.vtep6, &ip->ip6, 1);
278 vtep_addr_unref(ip46_address_t *ip)
280 uword *vtep = ip46_address_is_ip4(ip) ?
281 hash_get (vxlan_main.vtep4, ip->ip4.as_u32) :
282 hash_get_mem (vxlan_main.vtep6, &ip->ip6);
286 ip46_address_is_ip4(ip) ?
287 hash_unset (vxlan_main.vtep4, ip->ip4.as_u32) :
288 hash_unset_mem_free (&vxlan_main.vtep6, &ip->ip6);
292 typedef CLIB_PACKED(union {
294 fib_node_index_t mfib_entry_index;
295 adj_index_t mcast_adj_index;
300 static inline mcast_shared_t
301 mcast_shared_get(ip46_address_t * ip)
303 ASSERT(ip46_address_is_multicast(ip));
304 uword * p = hash_get_mem (vxlan_main.mcast_shared, ip);
306 return (mcast_shared_t) { .as_u64 = *p };
310 mcast_shared_add(ip46_address_t *dst,
311 fib_node_index_t mfei,
314 mcast_shared_t new_ep = {
315 .mcast_adj_index = ai,
316 .mfib_entry_index = mfei,
319 hash_set_mem_alloc (&vxlan_main.mcast_shared, dst, new_ep.as_u64);
323 mcast_shared_remove(ip46_address_t *dst)
325 mcast_shared_t ep = mcast_shared_get(dst);
327 adj_unlock(ep.mcast_adj_index);
328 mfib_table_entry_delete_index(ep.mfib_entry_index,
331 hash_unset_mem_free (&vxlan_main.mcast_shared, dst);
334 static inline fib_protocol_t
335 fib_ip_proto(bool is_ip6)
337 return (is_ip6) ? FIB_PROTOCOL_IP6 : FIB_PROTOCOL_IP4;
340 int vnet_vxlan_add_del_tunnel
341 (vnet_vxlan_add_del_tunnel_args_t *a, u32 * sw_if_indexp)
343 vxlan_main_t * vxm = &vxlan_main;
344 vxlan_tunnel_t *t = 0;
345 vnet_main_t * vnm = vxm->vnet_main;
347 u32 hw_if_index = ~0;
348 u32 sw_if_index = ~0;
350 vxlan4_tunnel_key_t key4;
351 vxlan6_tunnel_key_t key6;
352 u32 is_ip6 = a->is_ip6;
356 key4.src = a->dst.ip4.as_u32; /* decap src in key is encap dst in config */
357 key4.vni = clib_host_to_net_u32 (a->vni << 8);
358 p = hash_get (vxm->vxlan4_tunnel_by_key, key4.as_u64);
362 key6.src = a->dst.ip6;
363 key6.vni = clib_host_to_net_u32 (a->vni << 8);
364 p = hash_get_mem (vxm->vxlan6_tunnel_by_key, &key6);
369 l2input_main_t * l2im = &l2input_main;
371 /* adding a tunnel: tunnel must not already exist */
373 return VNET_API_ERROR_TUNNEL_EXIST;
375 /*if not set explicitly, default to l2 */
376 if(a->decap_next_index == ~0)
377 a->decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
378 if (!vxlan_decap_next_is_valid(vxm, is_ip6, a->decap_next_index))
379 return VNET_API_ERROR_INVALID_DECAP_NEXT;
381 pool_get_aligned (vxm->tunnels, t, CLIB_CACHE_LINE_BYTES);
382 memset (t, 0, sizeof (*t));
384 /* copy from arg structure */
385 #define _(x) t->x = a->x;
389 rv = vxlan_rewrite (t, is_ip6);
392 pool_put (vxm->tunnels, t);
398 hash_set_mem_alloc (&vxm->vxlan6_tunnel_by_key, &key6,
401 hash_set (vxm->vxlan4_tunnel_by_key, key4.as_u64, t - vxm->tunnels);
403 vnet_hw_interface_t * hi;
404 if (vec_len (vxm->free_vxlan_tunnel_hw_if_indices) > 0)
406 vnet_interface_main_t * im = &vnm->interface_main;
407 hw_if_index = vxm->free_vxlan_tunnel_hw_if_indices
408 [vec_len (vxm->free_vxlan_tunnel_hw_if_indices)-1];
409 _vec_len (vxm->free_vxlan_tunnel_hw_if_indices) -= 1;
411 hi = vnet_get_hw_interface (vnm, hw_if_index);
412 hi->dev_instance = t - vxm->tunnels;
413 hi->hw_instance = hi->dev_instance;
415 /* clear old stats of freed tunnel before reuse */
416 sw_if_index = hi->sw_if_index;
417 vnet_interface_counter_lock(im);
418 vlib_zero_combined_counter
419 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX], sw_if_index);
420 vlib_zero_combined_counter
421 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_RX], sw_if_index);
422 vlib_zero_simple_counter
423 (&im->sw_if_counters[VNET_INTERFACE_COUNTER_DROP], sw_if_index);
424 vnet_interface_counter_unlock(im);
428 hw_if_index = vnet_register_interface
429 (vnm, vxlan_device_class.index, t - vxm->tunnels,
430 vxlan_hw_class.index, t - vxm->tunnels);
431 hi = vnet_get_hw_interface (vnm, hw_if_index);
434 t->hw_if_index = hw_if_index;
435 t->sw_if_index = sw_if_index = hi->sw_if_index;
437 vec_validate_init_empty (vxm->tunnel_index_by_sw_if_index, sw_if_index, ~0);
438 vxm->tunnel_index_by_sw_if_index[sw_if_index] = t - vxm->tunnels;
440 /* setup l2 input config with l2 feature and bd 0 to drop packet */
441 vec_validate (l2im->configs, sw_if_index);
442 l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
443 l2im->configs[sw_if_index].bd_index = 0;
445 vnet_sw_interface_t * si = vnet_get_sw_interface (vnm, sw_if_index);
446 si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
447 vnet_sw_interface_set_flags (vnm, sw_if_index,
448 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
450 fib_node_init(&t->node, FIB_NODE_TYPE_VXLAN_TUNNEL);
451 fib_prefix_t tun_dst_pfx;
452 u32 encap_index = !is_ip6 ?
453 vxlan4_encap_node.index : vxlan6_encap_node.index;
454 vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
456 fib_prefix_from_ip46_addr(&t->dst, &tun_dst_pfx);
457 if (!ip46_address_is_multicast(&t->dst))
460 * source the FIB entry for the tunnel's destination
461 * and become a child thereof. The tunnel will then get poked
462 * when the forwarding for the entry updates, and the tunnel can
463 * re-stack accordingly
465 vtep_addr_ref(&t->src);
466 t->fib_entry_index = fib_table_entry_special_add
467 (t->encap_fib_index, &tun_dst_pfx, FIB_SOURCE_RR,
468 FIB_ENTRY_FLAG_NONE);
469 t->sibling_index = fib_entry_child_add
470 (t->fib_entry_index, FIB_NODE_TYPE_VXLAN_TUNNEL, t - vxm->tunnels);
471 vxlan_tunnel_restack_dpo(t);
475 /* Multicast tunnel -
476 * as the same mcast group can be used for mutiple mcast tunnels
477 * with different VNIs, create the output fib adjecency only if
478 * it does not already exist
480 fib_protocol_t fp = fib_ip_proto(is_ip6);
482 if (vtep_addr_ref(&t->dst) == 1)
484 fib_node_index_t mfei;
486 fib_route_path_t path = {
487 .frp_proto = fib_proto_to_dpo(fp),
488 .frp_addr = zero_addr,
489 .frp_sw_if_index = 0xffffffff,
492 .frp_flags = FIB_ROUTE_PATH_LOCAL,
494 const mfib_prefix_t mpfx = {
496 .fp_len = (is_ip6 ? 128 : 32),
497 .fp_grp_addr = tun_dst_pfx.fp_addr,
501 * Setup the (*,G) to receive traffic on the mcast group
502 * - the forwarding interface is for-us
503 * - the accepting interface is that from the API
505 mfib_table_entry_path_update(t->encap_fib_index,
509 MFIB_ITF_FLAG_FORWARD);
511 path.frp_sw_if_index = a->mcast_sw_if_index;
512 path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
513 mfei = mfib_table_entry_path_update(t->encap_fib_index,
517 MFIB_ITF_FLAG_ACCEPT);
520 * Create the mcast adjacency to send traffic to the group
522 ai = adj_mcast_add_or_lock(fp,
523 fib_proto_to_link(fp),
524 a->mcast_sw_if_index);
527 * create a new end-point
529 mcast_shared_add(&t->dst, mfei, ai);
532 dpo_id_t dpo = DPO_INVALID;
533 mcast_shared_t ep = mcast_shared_get(&t->dst);
535 /* Stack shared mcast dst mac addr rewrite on encap */
536 dpo_set (&dpo, DPO_ADJACENCY_MCAST,
537 fib_proto_to_dpo(fp),
540 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
542 flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
545 /* Set vxlan tunnel output node */
546 hi->output_node_index = encap_index;
548 vnet_get_sw_interface (vnet_get_main(), sw_if_index)->flood_class = flood_class;
552 /* deleting a tunnel: tunnel must exist */
554 return VNET_API_ERROR_NO_SUCH_ENTRY;
556 t = pool_elt_at_index (vxm->tunnels, p[0]);
558 sw_if_index = t->sw_if_index;
559 vnet_sw_interface_set_flags (vnm, t->sw_if_index, 0 /* down */);
560 vnet_sw_interface_t * si = vnet_get_sw_interface (vnm, t->sw_if_index);
561 si->flags |= VNET_SW_INTERFACE_FLAG_HIDDEN;
563 /* make sure tunnel is removed from l2 bd or xconnect */
564 set_int_l2_mode(vxm->vlib_main, vnm, MODE_L3, t->sw_if_index, 0, 0, 0, 0);
565 vec_add1 (vxm->free_vxlan_tunnel_hw_if_indices, t->hw_if_index);
567 vxm->tunnel_index_by_sw_if_index[t->sw_if_index] = ~0;
570 hash_unset (vxm->vxlan4_tunnel_by_key, key4.as_u64);
572 hash_unset_mem_free (&vxm->vxlan6_tunnel_by_key, &key6);
574 if (!ip46_address_is_multicast(&t->dst))
576 vtep_addr_unref(&t->src);
577 fib_entry_child_remove(t->fib_entry_index, t->sibling_index);
578 fib_table_entry_delete_index(t->fib_entry_index, FIB_SOURCE_RR);
580 else if (vtep_addr_unref(&t->dst) == 0)
582 mcast_shared_remove(&t->dst);
585 fib_node_deinit(&t->node);
586 vec_free (t->rewrite);
587 pool_put (vxm->tunnels, t);
591 *sw_if_indexp = sw_if_index;
596 static uword get_decap_next_for_node(u32 node_index, u32 ipv4_set)
598 vxlan_main_t * vxm = &vxlan_main;
599 vlib_main_t * vm = vxm->vlib_main;
600 uword input_node = (ipv4_set) ? vxlan4_input_node.index :
601 vxlan6_input_node.index;
603 return vlib_node_add_next (vm, input_node, node_index);
606 static uword unformat_decap_next (unformat_input_t * input, va_list * args)
608 u32 * result = va_arg (*args, u32 *);
609 u32 ipv4_set = va_arg (*args, int);
610 vxlan_main_t * vxm = &vxlan_main;
611 vlib_main_t * vm = vxm->vlib_main;
615 if (unformat (input, "l2"))
616 *result = VXLAN_INPUT_NEXT_L2_INPUT;
617 else if (unformat (input, "node %U", unformat_vlib_node, vm, &node_index))
618 *result = get_decap_next_for_node(node_index, ipv4_set);
619 else if (unformat (input, "%d", &tmp))
626 static clib_error_t *
627 vxlan_add_del_tunnel_command_fn (vlib_main_t * vm,
628 unformat_input_t * input,
629 vlib_cli_command_t * cmd)
631 unformat_input_t _line_input, * line_input = &_line_input;
632 ip46_address_t src , dst;
639 u32 encap_fib_index = 0;
640 u32 mcast_sw_if_index = ~0;
641 u32 decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
645 vnet_vxlan_add_del_tunnel_args_t _a, * a = &_a;
646 u32 tunnel_sw_if_index;
647 clib_error_t *error = NULL;
649 /* Cant "universally zero init" (={0}) due to GCC bug 53119 */
650 memset(&src, 0, sizeof src);
651 memset(&dst, 0, sizeof dst);
653 /* Get a line of input. */
654 if (! unformat_user (input, unformat_line_input, line_input))
657 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) {
658 if (unformat (line_input, "del"))
662 else if (unformat (line_input, "src %U",
663 unformat_ip4_address, &src.ip4))
668 else if (unformat (line_input, "dst %U",
669 unformat_ip4_address, &dst.ip4))
674 else if (unformat (line_input, "src %U",
675 unformat_ip6_address, &src.ip6))
680 else if (unformat (line_input, "dst %U",
681 unformat_ip6_address, &dst.ip6))
686 else if (unformat (line_input, "group %U %U",
687 unformat_ip4_address, &dst.ip4,
688 unformat_vnet_sw_interface,
689 vnet_get_main(), &mcast_sw_if_index))
691 grp_set = dst_set = 1;
694 else if (unformat (line_input, "group %U %U",
695 unformat_ip6_address, &dst.ip6,
696 unformat_vnet_sw_interface,
697 vnet_get_main(), &mcast_sw_if_index))
699 grp_set = dst_set = 1;
702 else if (unformat (line_input, "encap-vrf-id %d", &tmp))
704 encap_fib_index = fib_table_find (fib_ip_proto (ipv6_set), tmp);
705 if (encap_fib_index == ~0)
707 error = clib_error_return (0, "nonexistent encap-vrf-id %d", tmp);
711 else if (unformat (line_input, "decap-next %U", unformat_decap_next,
712 &decap_next_index, ipv4_set))
714 else if (unformat (line_input, "vni %d", &vni))
718 error = clib_error_return (0, "vni %d out of range", vni);
724 error = clib_error_return (0, "parse error: '%U'",
725 format_unformat_error, line_input);
732 error = clib_error_return (0, "tunnel src address not specified");
738 error = clib_error_return (0, "tunnel dst address not specified");
742 if (grp_set && !ip46_address_is_multicast(&dst))
744 error = clib_error_return (0, "tunnel group address not multicast");
748 if (grp_set == 0 && ip46_address_is_multicast(&dst))
750 error = clib_error_return (0, "dst address must be unicast");
754 if (grp_set && mcast_sw_if_index == ~0)
756 error = clib_error_return (0, "tunnel nonexistent multicast device");
760 if (ipv4_set && ipv6_set)
762 error = clib_error_return (0, "both IPv4 and IPv6 addresses specified");
766 if (ip46_address_cmp(&src, &dst) == 0)
768 error = clib_error_return (0, "src and dst addresses are identical");
772 if (decap_next_index == ~0)
774 error = clib_error_return (0, "next node not found");
780 error = clib_error_return (0, "vni not specified");
784 memset (a, 0, sizeof (*a));
787 a->is_ip6 = ipv6_set;
789 #define _(x) a->x = x;
793 rv = vnet_vxlan_add_del_tunnel (a, &tunnel_sw_if_index);
799 vlib_cli_output(vm, "%U\n", format_vnet_sw_if_index_name,
800 vnet_get_main(), tunnel_sw_if_index);
803 case VNET_API_ERROR_TUNNEL_EXIST:
804 error = clib_error_return (0, "tunnel already exists...");
807 case VNET_API_ERROR_NO_SUCH_ENTRY:
808 error = clib_error_return (0, "tunnel does not exist...");
812 error = clib_error_return
813 (0, "vnet_vxlan_add_del_tunnel returned %d", rv);
818 unformat_free (line_input);
824 * Add or delete a VXLAN Tunnel.
826 * VXLAN provides the features needed to allow L2 bridge domains (BDs)
827 * to span multiple servers. This is done by building an L2 overlay on
828 * top of an L3 network underlay using VXLAN tunnels.
830 * This makes it possible for servers to be co-located in the same data
831 * center or be separated geographically as long as they are reachable
832 * through the underlay L3 network.
834 * You can refer to this kind of L2 overlay bridge domain as a VXLAN
835 * (Virtual eXtensible VLAN) segment.
838 * Example of how to create a VXLAN Tunnel:
839 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 encap-vrf-id 7}
840 * Example of how to delete a VXLAN Tunnel:
841 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 del}
844 VLIB_CLI_COMMAND (create_vxlan_tunnel_command, static) = {
845 .path = "create vxlan tunnel",
847 "create vxlan tunnel src <local-vtep-addr>"
848 " {dst <remote-vtep-addr>|group <mcast-vtep-addr> <intf-name>} vni <nn>"
849 " [encap-vrf-id <nn>] [decap-next [l2|node <name>]] [del]",
850 .function = vxlan_add_del_tunnel_command_fn,
854 static clib_error_t *
855 show_vxlan_tunnel_command_fn (vlib_main_t * vm,
856 unformat_input_t * input,
857 vlib_cli_command_t * cmd)
859 vxlan_main_t * vxm = &vxlan_main;
862 if (pool_elts (vxm->tunnels) == 0)
863 vlib_cli_output (vm, "No vxlan tunnels configured...");
865 pool_foreach (t, vxm->tunnels,
867 vlib_cli_output (vm, "%U", format_vxlan_tunnel, t);
874 * Display all the VXLAN Tunnel entries.
877 * Example of how to display the VXLAN Tunnel entries:
878 * @cliexstart{show vxlan tunnel}
879 * [0] src 10.0.3.1 dst 10.0.3.3 vni 13 encap_fib_index 0 sw_if_index 5 decap_next l2
883 VLIB_CLI_COMMAND (show_vxlan_tunnel_command, static) = {
884 .path = "show vxlan tunnel",
885 .short_help = "show vxlan tunnel",
886 .function = show_vxlan_tunnel_command_fn,
891 void vnet_int_vxlan_bypass_mode (u32 sw_if_index,
896 vnet_feature_enable_disable ("ip6-unicast", "ip6-vxlan-bypass",
897 sw_if_index, is_enable, 0, 0);
899 vnet_feature_enable_disable ("ip4-unicast", "ip4-vxlan-bypass",
900 sw_if_index, is_enable, 0, 0);
904 static clib_error_t *
905 set_ip_vxlan_bypass (u32 is_ip6,
906 unformat_input_t * input,
907 vlib_cli_command_t * cmd)
909 unformat_input_t _line_input, * line_input = &_line_input;
910 vnet_main_t * vnm = vnet_get_main();
911 clib_error_t * error = 0;
912 u32 sw_if_index, is_enable;
917 if (! unformat_user (input, unformat_line_input, line_input))
920 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
922 if (unformat_user (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
924 else if (unformat (line_input, "del"))
928 error = unformat_parse_error (line_input);
933 if (~0 == sw_if_index)
935 error = clib_error_return (0, "unknown interface `%U'",
936 format_unformat_error, line_input);
940 vnet_int_vxlan_bypass_mode (sw_if_index, is_ip6, is_enable);
943 unformat_free (line_input);
948 static clib_error_t *
949 set_ip4_vxlan_bypass (vlib_main_t * vm,
950 unformat_input_t * input,
951 vlib_cli_command_t * cmd)
953 return set_ip_vxlan_bypass (0, input, cmd);
957 * This command adds the 'ip4-vxlan-bypass' graph node for a given interface.
958 * By adding the IPv4 vxlan-bypass graph node to an interface, the node checks
959 * for and validate input vxlan packet and bypass ip4-lookup, ip4-local,
960 * ip4-udp-lookup nodes to speedup vxlan packet forwarding. This node will
961 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
965 * Example of graph node before ip4-vxlan-bypass is enabled:
966 * @cliexstart{show vlib graph ip4-vxlan-bypass}
968 * ip4-vxlan-bypass error-drop [0]
973 * Example of how to enable ip4-vxlan-bypass on an interface:
974 * @cliexcmd{set interface ip vxlan-bypass GigabitEthernet2/0/0}
976 * Example of graph node after ip4-vxlan-bypass is enabled:
977 * @cliexstart{show vlib graph ip4-vxlan-bypass}
979 * ip4-vxlan-bypass error-drop [0] ip4-input
980 * vxlan4-input [1] ip4-input-no-checksum
984 * Example of how to display the feature enabed on an interface:
985 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
986 * IP feature paths configured on GigabitEthernet2/0/0...
994 * Example of how to disable ip4-vxlan-bypass on an interface:
995 * @cliexcmd{set interface ip vxlan-bypass GigabitEthernet2/0/0 del}
999 VLIB_CLI_COMMAND (set_interface_ip_vxlan_bypass_command, static) = {
1000 .path = "set interface ip vxlan-bypass",
1001 .function = set_ip4_vxlan_bypass,
1002 .short_help = "set interface ip vxlan-bypass <interface> [del]",
1006 static clib_error_t *
1007 set_ip6_vxlan_bypass (vlib_main_t * vm,
1008 unformat_input_t * input,
1009 vlib_cli_command_t * cmd)
1011 return set_ip_vxlan_bypass (1, input, cmd);
1015 * This command adds the 'ip6-vxlan-bypass' graph node for a given interface.
1016 * By adding the IPv6 vxlan-bypass graph node to an interface, the node checks
1017 * for and validate input vxlan packet and bypass ip6-lookup, ip6-local,
1018 * ip6-udp-lookup nodes to speedup vxlan packet forwarding. This node will
1019 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
1023 * Example of graph node before ip6-vxlan-bypass is enabled:
1024 * @cliexstart{show vlib graph ip6-vxlan-bypass}
1025 * Name Next Previous
1026 * ip6-vxlan-bypass error-drop [0]
1031 * Example of how to enable ip6-vxlan-bypass on an interface:
1032 * @cliexcmd{set interface ip6 vxlan-bypass GigabitEthernet2/0/0}
1034 * Example of graph node after ip6-vxlan-bypass is enabled:
1035 * @cliexstart{show vlib graph ip6-vxlan-bypass}
1036 * Name Next Previous
1037 * ip6-vxlan-bypass error-drop [0] ip6-input
1038 * vxlan6-input [1] ip4-input-no-checksum
1042 * Example of how to display the feature enabed on an interface:
1043 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1044 * IP feature paths configured on GigabitEthernet2/0/0...
1052 * Example of how to disable ip6-vxlan-bypass on an interface:
1053 * @cliexcmd{set interface ip6 vxlan-bypass GigabitEthernet2/0/0 del}
1057 VLIB_CLI_COMMAND (set_interface_ip6_vxlan_bypass_command, static) = {
1058 .path = "set interface ip6 vxlan-bypass",
1059 .function = set_ip6_vxlan_bypass,
1060 .short_help = "set interface ip vxlan-bypass <interface> [del]",
1064 clib_error_t *vxlan_init (vlib_main_t *vm)
1066 vxlan_main_t * vxm = &vxlan_main;
1068 vxm->vnet_main = vnet_get_main();
1069 vxm->vlib_main = vm;
1071 /* initialize the ip6 hash */
1072 vxm->vxlan6_tunnel_by_key = hash_create_mem(0,
1073 sizeof(vxlan6_tunnel_key_t),
1075 vxm->vtep6 = hash_create_mem(0,
1076 sizeof(ip6_address_t),
1078 vxm->mcast_shared = hash_create_mem(0,
1079 sizeof(ip46_address_t),
1080 sizeof(mcast_shared_t));
1082 udp_register_dst_port (vm, UDP_DST_PORT_vxlan,
1083 vxlan4_input_node.index, /* is_ip4 */ 1);
1084 udp_register_dst_port (vm, UDP_DST_PORT_vxlan6,
1085 vxlan6_input_node.index, /* is_ip4 */ 0);
1087 fib_node_register_type(FIB_NODE_TYPE_VXLAN_TUNNEL, &vxlan_vft);
1092 VLIB_INIT_FUNCTION(vxlan_init);