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);
83 vxlan_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
85 u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
86 VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
87 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
89 return /* no error */ 0;
92 VNET_DEVICE_CLASS (vxlan_device_class,static) = {
94 .format_device_name = format_vxlan_name,
95 .format_tx_trace = format_vxlan_encap_trace,
96 .admin_up_down_function = vxlan_interface_admin_up_down,
99 static u8 * format_vxlan_header_with_length (u8 * s, va_list * args)
101 u32 dev_instance = va_arg (*args, u32);
102 s = format (s, "unimplemented dev %u", dev_instance);
106 VNET_HW_INTERFACE_CLASS (vxlan_hw_class) = {
108 .format_header = format_vxlan_header_with_length,
109 .build_rewrite = default_build_rewrite,
113 vxlan_tunnel_restack_dpo(vxlan_tunnel_t * t)
115 dpo_id_t dpo = DPO_INVALID;
116 u32 encap_index = ip46_address_is_ip4(&t->dst) ?
117 vxlan4_encap_node.index : vxlan6_encap_node.index;
118 fib_forward_chain_type_t forw_type = ip46_address_is_ip4(&t->dst) ?
119 FIB_FORW_CHAIN_TYPE_UNICAST_IP4 : FIB_FORW_CHAIN_TYPE_UNICAST_IP6;
121 fib_entry_contribute_forwarding (t->fib_entry_index, forw_type, &dpo);
122 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
126 static vxlan_tunnel_t *
127 vxlan_tunnel_from_fib_node (fib_node_t *node)
129 ASSERT(FIB_NODE_TYPE_VXLAN_TUNNEL == node->fn_type);
130 return ((vxlan_tunnel_t*) (((char*)node) -
131 STRUCT_OFFSET_OF(vxlan_tunnel_t, node)));
135 * Function definition to backwalk a FIB node -
136 * Here we will restack the new dpo of VXLAN DIP to encap node.
138 static fib_node_back_walk_rc_t
139 vxlan_tunnel_back_walk (fib_node_t *node,
140 fib_node_back_walk_ctx_t *ctx)
142 vxlan_tunnel_restack_dpo(vxlan_tunnel_from_fib_node(node));
143 return (FIB_NODE_BACK_WALK_CONTINUE);
147 * Function definition to get a FIB node from its index
150 vxlan_tunnel_fib_node_get (fib_node_index_t index)
153 vxlan_main_t * vxm = &vxlan_main;
155 t = pool_elt_at_index(vxm->tunnels, index);
161 * Function definition to inform the FIB node that its last lock has gone.
164 vxlan_tunnel_last_lock_gone (fib_node_t *node)
167 * The VXLAN tunnel is a root of the graph. As such
168 * it never has children and thus is never locked.
174 * Virtual function table registered by VXLAN tunnels
175 * for participation in the FIB object graph.
177 const static fib_node_vft_t vxlan_vft = {
178 .fnv_get = vxlan_tunnel_fib_node_get,
179 .fnv_last_lock = vxlan_tunnel_last_lock_gone,
180 .fnv_back_walk = vxlan_tunnel_back_walk,
184 #define foreach_copy_field \
186 _(mcast_sw_if_index) \
188 _(decap_next_index) \
193 vxlan_rewrite (vxlan_tunnel_t * t, bool is_ip6)
196 ip4_vxlan_header_t * h4;
197 ip6_vxlan_header_t * h6;
200 int len = is_ip6 ? sizeof *r.h6 : sizeof *r.h4;
202 vec_validate_aligned (r.rw, len-1, CLIB_CACHE_LINE_BYTES);
205 vxlan_header_t * vxlan;
206 /* Fixed portion of the (outer) ip header */
209 ip4_header_t * ip = &r.h4->ip4;
210 udp = &r.h4->udp, vxlan = &r.h4->vxlan;
211 ip->ip_version_and_header_length = 0x45;
213 ip->protocol = IP_PROTOCOL_UDP;
215 ip->src_address = t->src.ip4;
216 ip->dst_address = t->dst.ip4;
218 /* we fix up the ip4 header length and checksum after-the-fact */
219 ip->checksum = ip4_header_checksum (ip);
223 ip6_header_t * ip = &r.h6->ip6;
224 udp = &r.h6->udp, vxlan = &r.h6->vxlan;
225 ip->ip_version_traffic_class_and_flow_label = clib_host_to_net_u32(6 << 28);
227 ip->protocol = IP_PROTOCOL_UDP;
229 ip->src_address = t->src.ip6;
230 ip->dst_address = t->dst.ip6;
233 /* UDP header, randomize src port on something, maybe? */
234 udp->src_port = clib_host_to_net_u16 (4789);
235 udp->dst_port = clib_host_to_net_u16 (UDP_DST_PORT_vxlan);
238 vnet_set_vni_and_flags(vxlan, t->vni);
245 vxlan_decap_next_is_valid (vxlan_main_t * vxm, u32 is_ip6, u32 decap_next_index)
247 vlib_main_t * vm = vxm->vlib_main;
248 u32 input_idx = (!is_ip6) ? vxlan4_input_node.index : vxlan6_input_node.index;
249 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, input_idx);
251 return decap_next_index < r->n_next_nodes;
255 vtep_addr_ref(ip46_address_t *ip)
257 uword *vtep = ip46_address_is_ip4(ip) ?
258 hash_get (vxlan_main.vtep4, ip->ip4.as_u32) :
259 hash_get_mem (vxlan_main.vtep6, &ip->ip6);
262 ip46_address_is_ip4(ip) ?
263 hash_set (vxlan_main.vtep4, ip->ip4.as_u32, 1) :
264 hash_set_mem_alloc (&vxlan_main.vtep6, &ip->ip6, 1);
269 vtep_addr_unref(ip46_address_t *ip)
271 uword *vtep = ip46_address_is_ip4(ip) ?
272 hash_get (vxlan_main.vtep4, ip->ip4.as_u32) :
273 hash_get_mem (vxlan_main.vtep6, &ip->ip6);
277 ip46_address_is_ip4(ip) ?
278 hash_unset (vxlan_main.vtep4, ip->ip4.as_u32) :
279 hash_unset_mem_free (&vxlan_main.vtep6, &ip->ip6);
283 typedef CLIB_PACKED(union {
285 fib_node_index_t mfib_entry_index;
286 adj_index_t mcast_adj_index;
291 static inline mcast_shared_t
292 mcast_shared_get(ip46_address_t * ip)
294 ASSERT(ip46_address_is_multicast(ip));
295 uword * p = hash_get_mem (vxlan_main.mcast_shared, ip);
297 return (mcast_shared_t) { .as_u64 = *p };
301 mcast_shared_add(ip46_address_t *dst,
302 fib_node_index_t mfei,
305 mcast_shared_t new_ep = {
306 .mcast_adj_index = ai,
307 .mfib_entry_index = mfei,
310 hash_set_mem_alloc (&vxlan_main.mcast_shared, dst, new_ep.as_u64);
314 mcast_shared_remove(ip46_address_t *dst)
316 mcast_shared_t ep = mcast_shared_get(dst);
318 adj_unlock(ep.mcast_adj_index);
319 mfib_table_entry_delete_index(ep.mfib_entry_index,
322 hash_unset_mem_free (&vxlan_main.mcast_shared, dst);
325 int vnet_vxlan_add_del_tunnel
326 (vnet_vxlan_add_del_tunnel_args_t *a, u32 * sw_if_indexp)
328 vxlan_main_t * vxm = &vxlan_main;
329 vxlan_tunnel_t *t = 0;
330 vnet_main_t * vnm = vxm->vnet_main;
332 u32 hw_if_index = ~0;
333 u32 sw_if_index = ~0;
335 vxlan4_tunnel_key_t key4;
336 vxlan6_tunnel_key_t key6;
337 u32 is_ip6 = a->is_ip6;
341 key4.src = a->dst.ip4.as_u32; /* decap src in key is encap dst in config */
342 key4.vni = clib_host_to_net_u32 (a->vni << 8);
343 p = hash_get (vxm->vxlan4_tunnel_by_key, key4.as_u64);
347 key6.src = a->dst.ip6;
348 key6.vni = clib_host_to_net_u32 (a->vni << 8);
349 p = hash_get_mem (vxm->vxlan6_tunnel_by_key, &key6);
354 l2input_main_t * l2im = &l2input_main;
356 /* adding a tunnel: tunnel must not already exist */
358 return VNET_API_ERROR_TUNNEL_EXIST;
360 /*if not set explicitly, default to l2 */
361 if(a->decap_next_index == ~0)
362 a->decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
363 if (!vxlan_decap_next_is_valid(vxm, is_ip6, a->decap_next_index))
364 return VNET_API_ERROR_INVALID_DECAP_NEXT;
366 pool_get_aligned (vxm->tunnels, t, CLIB_CACHE_LINE_BYTES);
367 memset (t, 0, sizeof (*t));
369 /* copy from arg structure */
370 #define _(x) t->x = a->x;
374 rv = vxlan_rewrite (t, is_ip6);
377 pool_put (vxm->tunnels, t);
383 hash_set_mem_alloc (&vxm->vxlan6_tunnel_by_key, &key6,
386 hash_set (vxm->vxlan4_tunnel_by_key, key4.as_u64, t - vxm->tunnels);
388 vnet_hw_interface_t * hi;
389 if (vec_len (vxm->free_vxlan_tunnel_hw_if_indices) > 0)
391 vnet_interface_main_t * im = &vnm->interface_main;
392 hw_if_index = vxm->free_vxlan_tunnel_hw_if_indices
393 [vec_len (vxm->free_vxlan_tunnel_hw_if_indices)-1];
394 _vec_len (vxm->free_vxlan_tunnel_hw_if_indices) -= 1;
396 hi = vnet_get_hw_interface (vnm, hw_if_index);
397 hi->dev_instance = t - vxm->tunnels;
398 hi->hw_instance = hi->dev_instance;
400 /* clear old stats of freed tunnel before reuse */
401 sw_if_index = hi->sw_if_index;
402 vnet_interface_counter_lock(im);
403 vlib_zero_combined_counter
404 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX], sw_if_index);
405 vlib_zero_combined_counter
406 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_RX], sw_if_index);
407 vlib_zero_simple_counter
408 (&im->sw_if_counters[VNET_INTERFACE_COUNTER_DROP], sw_if_index);
409 vnet_interface_counter_unlock(im);
413 hw_if_index = vnet_register_interface
414 (vnm, vxlan_device_class.index, t - vxm->tunnels,
415 vxlan_hw_class.index, t - vxm->tunnels);
416 hi = vnet_get_hw_interface (vnm, hw_if_index);
419 /* Set vxlan tunnel output node */
420 u32 encap_index = !is_ip6 ?
421 vxlan4_encap_node.index : vxlan6_encap_node.index;
422 vnet_set_interface_output_node (vnm, hw_if_index, encap_index);
424 t->hw_if_index = hw_if_index;
425 t->sw_if_index = sw_if_index = hi->sw_if_index;
427 vec_validate_init_empty (vxm->tunnel_index_by_sw_if_index, sw_if_index, ~0);
428 vxm->tunnel_index_by_sw_if_index[sw_if_index] = t - vxm->tunnels;
430 /* setup l2 input config with l2 feature and bd 0 to drop packet */
431 vec_validate (l2im->configs, sw_if_index);
432 l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
433 l2im->configs[sw_if_index].bd_index = 0;
435 vnet_sw_interface_t * si = vnet_get_sw_interface (vnm, sw_if_index);
436 si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
437 vnet_sw_interface_set_flags (vnm, sw_if_index,
438 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
440 fib_node_init(&t->node, FIB_NODE_TYPE_VXLAN_TUNNEL);
441 fib_prefix_t tun_dst_pfx;
442 vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
444 fib_prefix_from_ip46_addr(&t->dst, &tun_dst_pfx);
445 if (!ip46_address_is_multicast(&t->dst))
448 * source the FIB entry for the tunnel's destination
449 * and become a child thereof. The tunnel will then get poked
450 * when the forwarding for the entry updates, and the tunnel can
451 * re-stack accordingly
453 vtep_addr_ref(&t->src);
454 t->fib_entry_index = fib_table_entry_special_add
455 (t->encap_fib_index, &tun_dst_pfx, FIB_SOURCE_RR,
456 FIB_ENTRY_FLAG_NONE);
457 t->sibling_index = fib_entry_child_add
458 (t->fib_entry_index, FIB_NODE_TYPE_VXLAN_TUNNEL, t - vxm->tunnels);
459 vxlan_tunnel_restack_dpo(t);
463 /* Multicast tunnel -
464 * as the same mcast group can be used for mutiple mcast tunnels
465 * with different VNIs, create the output fib adjecency only if
466 * it does not already exist
468 fib_protocol_t fp = fib_ip_proto(is_ip6);
470 if (vtep_addr_ref(&t->dst) == 1)
472 fib_node_index_t mfei;
474 fib_route_path_t path = {
475 .frp_proto = fib_proto_to_dpo(fp),
476 .frp_addr = zero_addr,
477 .frp_sw_if_index = 0xffffffff,
480 .frp_flags = FIB_ROUTE_PATH_LOCAL,
482 const mfib_prefix_t mpfx = {
484 .fp_len = (is_ip6 ? 128 : 32),
485 .fp_grp_addr = tun_dst_pfx.fp_addr,
489 * Setup the (*,G) to receive traffic on the mcast group
490 * - the forwarding interface is for-us
491 * - the accepting interface is that from the API
493 mfib_table_entry_path_update(t->encap_fib_index,
497 MFIB_ITF_FLAG_FORWARD);
499 path.frp_sw_if_index = a->mcast_sw_if_index;
500 path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
501 mfei = mfib_table_entry_path_update(t->encap_fib_index,
505 MFIB_ITF_FLAG_ACCEPT);
508 * Create the mcast adjacency to send traffic to the group
510 ai = adj_mcast_add_or_lock(fp,
511 fib_proto_to_link(fp),
512 a->mcast_sw_if_index);
515 * create a new end-point
517 mcast_shared_add(&t->dst, mfei, ai);
520 dpo_id_t dpo = DPO_INVALID;
521 mcast_shared_t ep = mcast_shared_get(&t->dst);
523 /* Stack shared mcast dst mac addr rewrite on encap */
524 dpo_set (&dpo, DPO_ADJACENCY_MCAST,
525 fib_proto_to_dpo(fp),
528 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
530 flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
533 vnet_get_sw_interface (vnet_get_main(), sw_if_index)->flood_class = flood_class;
537 /* deleting a tunnel: tunnel must exist */
539 return VNET_API_ERROR_NO_SUCH_ENTRY;
541 t = pool_elt_at_index (vxm->tunnels, p[0]);
543 sw_if_index = t->sw_if_index;
544 vnet_sw_interface_set_flags (vnm, t->sw_if_index, 0 /* down */);
545 vnet_sw_interface_t * si = vnet_get_sw_interface (vnm, t->sw_if_index);
546 si->flags |= VNET_SW_INTERFACE_FLAG_HIDDEN;
548 /* make sure tunnel is removed from l2 bd or xconnect */
549 set_int_l2_mode(vxm->vlib_main, vnm, MODE_L3, t->sw_if_index, 0, 0, 0, 0);
550 vec_add1 (vxm->free_vxlan_tunnel_hw_if_indices, t->hw_if_index);
552 vxm->tunnel_index_by_sw_if_index[t->sw_if_index] = ~0;
555 hash_unset (vxm->vxlan4_tunnel_by_key, key4.as_u64);
557 hash_unset_mem_free (&vxm->vxlan6_tunnel_by_key, &key6);
559 if (!ip46_address_is_multicast(&t->dst))
561 vtep_addr_unref(&t->src);
562 fib_entry_child_remove(t->fib_entry_index, t->sibling_index);
563 fib_table_entry_delete_index(t->fib_entry_index, FIB_SOURCE_RR);
565 else if (vtep_addr_unref(&t->dst) == 0)
567 mcast_shared_remove(&t->dst);
570 fib_node_deinit(&t->node);
571 vec_free (t->rewrite);
572 pool_put (vxm->tunnels, t);
576 *sw_if_indexp = sw_if_index;
581 static uword get_decap_next_for_node(u32 node_index, u32 ipv4_set)
583 vxlan_main_t * vxm = &vxlan_main;
584 vlib_main_t * vm = vxm->vlib_main;
585 uword input_node = (ipv4_set) ? vxlan4_input_node.index :
586 vxlan6_input_node.index;
588 return vlib_node_add_next (vm, input_node, node_index);
591 static uword unformat_decap_next (unformat_input_t * input, va_list * args)
593 u32 * result = va_arg (*args, u32 *);
594 u32 ipv4_set = va_arg (*args, int);
595 vxlan_main_t * vxm = &vxlan_main;
596 vlib_main_t * vm = vxm->vlib_main;
600 if (unformat (input, "l2"))
601 *result = VXLAN_INPUT_NEXT_L2_INPUT;
602 else if (unformat (input, "node %U", unformat_vlib_node, vm, &node_index))
603 *result = get_decap_next_for_node(node_index, ipv4_set);
604 else if (unformat (input, "%d", &tmp))
611 static clib_error_t *
612 vxlan_add_del_tunnel_command_fn (vlib_main_t * vm,
613 unformat_input_t * input,
614 vlib_cli_command_t * cmd)
616 unformat_input_t _line_input, * line_input = &_line_input;
617 ip46_address_t src , dst;
624 u32 encap_fib_index = 0;
625 u32 mcast_sw_if_index = ~0;
626 u32 decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
630 vnet_vxlan_add_del_tunnel_args_t _a, * a = &_a;
631 u32 tunnel_sw_if_index;
632 clib_error_t *error = NULL;
634 /* Cant "universally zero init" (={0}) due to GCC bug 53119 */
635 memset(&src, 0, sizeof src);
636 memset(&dst, 0, sizeof dst);
638 /* Get a line of input. */
639 if (! unformat_user (input, unformat_line_input, line_input))
642 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) {
643 if (unformat (line_input, "del"))
647 else if (unformat (line_input, "src %U",
648 unformat_ip4_address, &src.ip4))
653 else if (unformat (line_input, "dst %U",
654 unformat_ip4_address, &dst.ip4))
659 else if (unformat (line_input, "src %U",
660 unformat_ip6_address, &src.ip6))
665 else if (unformat (line_input, "dst %U",
666 unformat_ip6_address, &dst.ip6))
671 else if (unformat (line_input, "group %U %U",
672 unformat_ip4_address, &dst.ip4,
673 unformat_vnet_sw_interface,
674 vnet_get_main(), &mcast_sw_if_index))
676 grp_set = dst_set = 1;
679 else if (unformat (line_input, "group %U %U",
680 unformat_ip6_address, &dst.ip6,
681 unformat_vnet_sw_interface,
682 vnet_get_main(), &mcast_sw_if_index))
684 grp_set = dst_set = 1;
687 else if (unformat (line_input, "encap-vrf-id %d", &tmp))
689 encap_fib_index = fib_table_find (fib_ip_proto (ipv6_set), tmp);
690 if (encap_fib_index == ~0)
692 error = clib_error_return (0, "nonexistent encap-vrf-id %d", tmp);
696 else if (unformat (line_input, "decap-next %U", unformat_decap_next,
697 &decap_next_index, ipv4_set))
699 else if (unformat (line_input, "vni %d", &vni))
703 error = clib_error_return (0, "vni %d out of range", vni);
709 error = clib_error_return (0, "parse error: '%U'",
710 format_unformat_error, line_input);
717 error = clib_error_return (0, "tunnel src address not specified");
723 error = clib_error_return (0, "tunnel dst address not specified");
727 if (grp_set && !ip46_address_is_multicast(&dst))
729 error = clib_error_return (0, "tunnel group address not multicast");
733 if (grp_set == 0 && ip46_address_is_multicast(&dst))
735 error = clib_error_return (0, "dst address must be unicast");
739 if (grp_set && mcast_sw_if_index == ~0)
741 error = clib_error_return (0, "tunnel nonexistent multicast device");
745 if (ipv4_set && ipv6_set)
747 error = clib_error_return (0, "both IPv4 and IPv6 addresses specified");
751 if (ip46_address_cmp(&src, &dst) == 0)
753 error = clib_error_return (0, "src and dst addresses are identical");
757 if (decap_next_index == ~0)
759 error = clib_error_return (0, "next node not found");
765 error = clib_error_return (0, "vni not specified");
769 memset (a, 0, sizeof (*a));
772 a->is_ip6 = ipv6_set;
774 #define _(x) a->x = x;
778 rv = vnet_vxlan_add_del_tunnel (a, &tunnel_sw_if_index);
784 vlib_cli_output(vm, "%U\n", format_vnet_sw_if_index_name,
785 vnet_get_main(), tunnel_sw_if_index);
788 case VNET_API_ERROR_TUNNEL_EXIST:
789 error = clib_error_return (0, "tunnel already exists...");
792 case VNET_API_ERROR_NO_SUCH_ENTRY:
793 error = clib_error_return (0, "tunnel does not exist...");
797 error = clib_error_return
798 (0, "vnet_vxlan_add_del_tunnel returned %d", rv);
803 unformat_free (line_input);
809 * Add or delete a VXLAN Tunnel.
811 * VXLAN provides the features needed to allow L2 bridge domains (BDs)
812 * to span multiple servers. This is done by building an L2 overlay on
813 * top of an L3 network underlay using VXLAN tunnels.
815 * This makes it possible for servers to be co-located in the same data
816 * center or be separated geographically as long as they are reachable
817 * through the underlay L3 network.
819 * You can refer to this kind of L2 overlay bridge domain as a VXLAN
820 * (Virtual eXtensible VLAN) segment.
823 * Example of how to create a VXLAN Tunnel:
824 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 encap-vrf-id 7}
825 * Example of how to delete a VXLAN Tunnel:
826 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 del}
829 VLIB_CLI_COMMAND (create_vxlan_tunnel_command, static) = {
830 .path = "create vxlan tunnel",
832 "create vxlan tunnel src <local-vtep-addr>"
833 " {dst <remote-vtep-addr>|group <mcast-vtep-addr> <intf-name>} vni <nn>"
834 " [encap-vrf-id <nn>] [decap-next [l2|node <name>]] [del]",
835 .function = vxlan_add_del_tunnel_command_fn,
839 static clib_error_t *
840 show_vxlan_tunnel_command_fn (vlib_main_t * vm,
841 unformat_input_t * input,
842 vlib_cli_command_t * cmd)
844 vxlan_main_t * vxm = &vxlan_main;
847 if (pool_elts (vxm->tunnels) == 0)
848 vlib_cli_output (vm, "No vxlan tunnels configured...");
850 pool_foreach (t, vxm->tunnels,
852 vlib_cli_output (vm, "%U", format_vxlan_tunnel, t);
859 * Display all the VXLAN Tunnel entries.
862 * Example of how to display the VXLAN Tunnel entries:
863 * @cliexstart{show vxlan tunnel}
864 * [0] src 10.0.3.1 dst 10.0.3.3 vni 13 encap_fib_index 0 sw_if_index 5 decap_next l2
868 VLIB_CLI_COMMAND (show_vxlan_tunnel_command, static) = {
869 .path = "show vxlan tunnel",
870 .short_help = "show vxlan tunnel",
871 .function = show_vxlan_tunnel_command_fn,
876 void vnet_int_vxlan_bypass_mode (u32 sw_if_index,
881 vnet_feature_enable_disable ("ip6-unicast", "ip6-vxlan-bypass",
882 sw_if_index, is_enable, 0, 0);
884 vnet_feature_enable_disable ("ip4-unicast", "ip4-vxlan-bypass",
885 sw_if_index, is_enable, 0, 0);
889 static clib_error_t *
890 set_ip_vxlan_bypass (u32 is_ip6,
891 unformat_input_t * input,
892 vlib_cli_command_t * cmd)
894 unformat_input_t _line_input, * line_input = &_line_input;
895 vnet_main_t * vnm = vnet_get_main();
896 clib_error_t * error = 0;
897 u32 sw_if_index, is_enable;
902 if (! unformat_user (input, unformat_line_input, line_input))
905 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
907 if (unformat_user (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
909 else if (unformat (line_input, "del"))
913 error = unformat_parse_error (line_input);
918 if (~0 == sw_if_index)
920 error = clib_error_return (0, "unknown interface `%U'",
921 format_unformat_error, line_input);
925 vnet_int_vxlan_bypass_mode (sw_if_index, is_ip6, is_enable);
928 unformat_free (line_input);
933 static clib_error_t *
934 set_ip4_vxlan_bypass (vlib_main_t * vm,
935 unformat_input_t * input,
936 vlib_cli_command_t * cmd)
938 return set_ip_vxlan_bypass (0, input, cmd);
942 * This command adds the 'ip4-vxlan-bypass' graph node for a given interface.
943 * By adding the IPv4 vxlan-bypass graph node to an interface, the node checks
944 * for and validate input vxlan packet and bypass ip4-lookup, ip4-local,
945 * ip4-udp-lookup nodes to speedup vxlan packet forwarding. This node will
946 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
950 * Example of graph node before ip4-vxlan-bypass is enabled:
951 * @cliexstart{show vlib graph ip4-vxlan-bypass}
953 * ip4-vxlan-bypass error-drop [0]
958 * Example of how to enable ip4-vxlan-bypass on an interface:
959 * @cliexcmd{set interface ip vxlan-bypass GigabitEthernet2/0/0}
961 * Example of graph node after ip4-vxlan-bypass is enabled:
962 * @cliexstart{show vlib graph ip4-vxlan-bypass}
964 * ip4-vxlan-bypass error-drop [0] ip4-input
965 * vxlan4-input [1] ip4-input-no-checksum
969 * Example of how to display the feature enabed on an interface:
970 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
971 * IP feature paths configured on GigabitEthernet2/0/0...
979 * Example of how to disable ip4-vxlan-bypass on an interface:
980 * @cliexcmd{set interface ip vxlan-bypass GigabitEthernet2/0/0 del}
984 VLIB_CLI_COMMAND (set_interface_ip_vxlan_bypass_command, static) = {
985 .path = "set interface ip vxlan-bypass",
986 .function = set_ip4_vxlan_bypass,
987 .short_help = "set interface ip vxlan-bypass <interface> [del]",
991 static clib_error_t *
992 set_ip6_vxlan_bypass (vlib_main_t * vm,
993 unformat_input_t * input,
994 vlib_cli_command_t * cmd)
996 return set_ip_vxlan_bypass (1, input, cmd);
1000 * This command adds the 'ip6-vxlan-bypass' graph node for a given interface.
1001 * By adding the IPv6 vxlan-bypass graph node to an interface, the node checks
1002 * for and validate input vxlan packet and bypass ip6-lookup, ip6-local,
1003 * ip6-udp-lookup nodes to speedup vxlan packet forwarding. This node will
1004 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
1008 * Example of graph node before ip6-vxlan-bypass is enabled:
1009 * @cliexstart{show vlib graph ip6-vxlan-bypass}
1010 * Name Next Previous
1011 * ip6-vxlan-bypass error-drop [0]
1016 * Example of how to enable ip6-vxlan-bypass on an interface:
1017 * @cliexcmd{set interface ip6 vxlan-bypass GigabitEthernet2/0/0}
1019 * Example of graph node after ip6-vxlan-bypass is enabled:
1020 * @cliexstart{show vlib graph ip6-vxlan-bypass}
1021 * Name Next Previous
1022 * ip6-vxlan-bypass error-drop [0] ip6-input
1023 * vxlan6-input [1] ip4-input-no-checksum
1027 * Example of how to display the feature enabed on an interface:
1028 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1029 * IP feature paths configured on GigabitEthernet2/0/0...
1037 * Example of how to disable ip6-vxlan-bypass on an interface:
1038 * @cliexcmd{set interface ip6 vxlan-bypass GigabitEthernet2/0/0 del}
1042 VLIB_CLI_COMMAND (set_interface_ip6_vxlan_bypass_command, static) = {
1043 .path = "set interface ip6 vxlan-bypass",
1044 .function = set_ip6_vxlan_bypass,
1045 .short_help = "set interface ip vxlan-bypass <interface> [del]",
1049 clib_error_t *vxlan_init (vlib_main_t *vm)
1051 vxlan_main_t * vxm = &vxlan_main;
1053 vxm->vnet_main = vnet_get_main();
1054 vxm->vlib_main = vm;
1056 /* initialize the ip6 hash */
1057 vxm->vxlan6_tunnel_by_key = hash_create_mem(0,
1058 sizeof(vxlan6_tunnel_key_t),
1060 vxm->vtep6 = hash_create_mem(0,
1061 sizeof(ip6_address_t),
1063 vxm->mcast_shared = hash_create_mem(0,
1064 sizeof(ip46_address_t),
1065 sizeof(mcast_shared_t));
1067 udp_register_dst_port (vm, UDP_DST_PORT_vxlan,
1068 vxlan4_input_node.index, /* is_ip4 */ 1);
1069 udp_register_dst_port (vm, UDP_DST_PORT_vxlan6,
1070 vxlan6_input_node.index, /* is_ip4 */ 0);
1072 fib_node_register_type(FIB_NODE_TYPE_VXLAN_TUNNEL, &vxlan_vft);
1077 VLIB_INIT_FUNCTION(vxlan_init);