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;
61 dev_instance = t - ngm->tunnels;
62 user_instance = t->user_instance;
65 "[%d] instance %d src %U dst %U vni %d fib-idx %d sw-if-idx %d ",
68 format_ip46_address, &t->src, IP46_TYPE_ANY,
69 format_ip46_address, &t->dst, IP46_TYPE_ANY,
70 t->vni, t->encap_fib_index, t->sw_if_index);
72 s = format (s, "encap-dpo-idx %d ", t->next_dpo.dpoi_index);
74 if (PREDICT_FALSE (t->decap_next_index != VXLAN_INPUT_NEXT_L2_INPUT))
75 s = format (s, "decap-next-%U ", format_decap_next, t->decap_next_index);
77 if (PREDICT_FALSE (ip46_address_is_multicast (&t->dst)))
78 s = format (s, "mcast-sw-if-idx %d ", t->mcast_sw_if_index);
83 static u8 * format_vxlan_name (u8 * s, va_list * args)
85 u32 dev_instance = va_arg (*args, u32);
86 vxlan_main_t * vxm = &vxlan_main;
89 if (dev_instance == ~0)
90 return format(s, "<cached-unused>");
92 if (dev_instance >= vec_len(vxm->tunnels))
93 return format(s, "<improperly-referenced>");
95 t = pool_elt_at_index(vxm->tunnels, dev_instance);
97 return format (s, "vxlan_tunnel%d", t->user_instance);
100 static clib_error_t *
101 vxlan_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
103 u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
104 VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
105 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
107 return /* no error */ 0;
110 VNET_DEVICE_CLASS (vxlan_device_class,static) = {
112 .format_device_name = format_vxlan_name,
113 .format_tx_trace = format_vxlan_encap_trace,
114 .admin_up_down_function = vxlan_interface_admin_up_down,
117 static u8 * format_vxlan_header_with_length (u8 * s, va_list * args)
119 u32 dev_instance = va_arg (*args, u32);
120 s = format (s, "unimplemented dev %u", dev_instance);
124 VNET_HW_INTERFACE_CLASS (vxlan_hw_class) = {
126 .format_header = format_vxlan_header_with_length,
127 .build_rewrite = default_build_rewrite,
131 vxlan_tunnel_restack_dpo(vxlan_tunnel_t * t)
133 dpo_id_t dpo = DPO_INVALID;
134 u32 encap_index = ip46_address_is_ip4(&t->dst) ?
135 vxlan4_encap_node.index : vxlan6_encap_node.index;
136 fib_forward_chain_type_t forw_type = ip46_address_is_ip4(&t->dst) ?
137 FIB_FORW_CHAIN_TYPE_UNICAST_IP4 : FIB_FORW_CHAIN_TYPE_UNICAST_IP6;
139 fib_entry_contribute_forwarding (t->fib_entry_index, forw_type, &dpo);
140 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
144 static vxlan_tunnel_t *
145 vxlan_tunnel_from_fib_node (fib_node_t *node)
147 ASSERT(FIB_NODE_TYPE_VXLAN_TUNNEL == node->fn_type);
148 return ((vxlan_tunnel_t*) (((char*)node) -
149 STRUCT_OFFSET_OF(vxlan_tunnel_t, node)));
153 * Function definition to backwalk a FIB node -
154 * Here we will restack the new dpo of VXLAN DIP to encap node.
156 static fib_node_back_walk_rc_t
157 vxlan_tunnel_back_walk (fib_node_t *node,
158 fib_node_back_walk_ctx_t *ctx)
160 vxlan_tunnel_restack_dpo(vxlan_tunnel_from_fib_node(node));
161 return (FIB_NODE_BACK_WALK_CONTINUE);
165 * Function definition to get a FIB node from its index
168 vxlan_tunnel_fib_node_get (fib_node_index_t index)
171 vxlan_main_t * vxm = &vxlan_main;
173 t = pool_elt_at_index(vxm->tunnels, index);
179 * Function definition to inform the FIB node that its last lock has gone.
182 vxlan_tunnel_last_lock_gone (fib_node_t *node)
185 * The VXLAN tunnel is a root of the graph. As such
186 * it never has children and thus is never locked.
192 * Virtual function table registered by VXLAN tunnels
193 * for participation in the FIB object graph.
195 const static fib_node_vft_t vxlan_vft = {
196 .fnv_get = vxlan_tunnel_fib_node_get,
197 .fnv_last_lock = vxlan_tunnel_last_lock_gone,
198 .fnv_back_walk = vxlan_tunnel_back_walk,
202 #define foreach_copy_field \
204 _(mcast_sw_if_index) \
206 _(decap_next_index) \
211 vxlan_rewrite (vxlan_tunnel_t * t, bool is_ip6)
214 ip4_vxlan_header_t * h4;
215 ip6_vxlan_header_t * h6;
218 int len = is_ip6 ? sizeof *r.h6 : sizeof *r.h4;
220 vec_validate_aligned (r.rw, len-1, CLIB_CACHE_LINE_BYTES);
223 vxlan_header_t * vxlan;
224 /* Fixed portion of the (outer) ip header */
227 ip4_header_t * ip = &r.h4->ip4;
228 udp = &r.h4->udp, vxlan = &r.h4->vxlan;
229 ip->ip_version_and_header_length = 0x45;
231 ip->protocol = IP_PROTOCOL_UDP;
233 ip->src_address = t->src.ip4;
234 ip->dst_address = t->dst.ip4;
236 /* we fix up the ip4 header length and checksum after-the-fact */
237 ip->checksum = ip4_header_checksum (ip);
241 ip6_header_t * ip = &r.h6->ip6;
242 udp = &r.h6->udp, vxlan = &r.h6->vxlan;
243 ip->ip_version_traffic_class_and_flow_label = clib_host_to_net_u32(6 << 28);
245 ip->protocol = IP_PROTOCOL_UDP;
247 ip->src_address = t->src.ip6;
248 ip->dst_address = t->dst.ip6;
251 /* UDP header, randomize src port on something, maybe? */
252 udp->src_port = clib_host_to_net_u16 (4789);
253 udp->dst_port = clib_host_to_net_u16 (UDP_DST_PORT_vxlan);
256 vnet_set_vni_and_flags(vxlan, t->vni);
262 vxlan_decap_next_is_valid (vxlan_main_t * vxm, u32 is_ip6, u32 decap_next_index)
264 vlib_main_t * vm = vxm->vlib_main;
265 u32 input_idx = (!is_ip6) ? vxlan4_input_node.index : vxlan6_input_node.index;
266 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, input_idx);
268 return decap_next_index < r->n_next_nodes;
272 vtep_addr_ref(ip46_address_t *ip)
274 uword *vtep = ip46_address_is_ip4(ip) ?
275 hash_get (vxlan_main.vtep4, ip->ip4.as_u32) :
276 hash_get_mem (vxlan_main.vtep6, &ip->ip6);
279 ip46_address_is_ip4(ip) ?
280 hash_set (vxlan_main.vtep4, ip->ip4.as_u32, 1) :
281 hash_set_mem_alloc (&vxlan_main.vtep6, &ip->ip6, 1);
286 vtep_addr_unref(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);
294 ip46_address_is_ip4(ip) ?
295 hash_unset (vxlan_main.vtep4, ip->ip4.as_u32) :
296 hash_unset_mem_free (&vxlan_main.vtep6, &ip->ip6);
300 typedef CLIB_PACKED(union {
302 fib_node_index_t mfib_entry_index;
303 adj_index_t mcast_adj_index;
308 static inline mcast_shared_t
309 mcast_shared_get(ip46_address_t * ip)
311 ASSERT(ip46_address_is_multicast(ip));
312 uword * p = hash_get_mem (vxlan_main.mcast_shared, ip);
314 return (mcast_shared_t) { .as_u64 = *p };
318 mcast_shared_add(ip46_address_t *dst,
319 fib_node_index_t mfei,
322 mcast_shared_t new_ep = {
323 .mcast_adj_index = ai,
324 .mfib_entry_index = mfei,
327 hash_set_mem_alloc (&vxlan_main.mcast_shared, dst, new_ep.as_u64);
331 mcast_shared_remove(ip46_address_t *dst)
333 mcast_shared_t ep = mcast_shared_get(dst);
335 adj_unlock(ep.mcast_adj_index);
336 mfib_table_entry_delete_index(ep.mfib_entry_index,
339 hash_unset_mem_free (&vxlan_main.mcast_shared, dst);
342 int vnet_vxlan_add_del_tunnel
343 (vnet_vxlan_add_del_tunnel_args_t *a, u32 * sw_if_indexp)
345 vxlan_main_t * vxm = &vxlan_main;
346 vxlan_tunnel_t *t = 0;
347 vnet_main_t * vnm = vxm->vnet_main;
349 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;
370 u32 dev_instance; /* real dev instance tunnel index */
371 u32 user_instance; /* request and actual instance number */
373 /* adding a tunnel: tunnel must not already exist */
375 return VNET_API_ERROR_TUNNEL_EXIST;
377 /*if not set explicitly, default to l2 */
378 if(a->decap_next_index == ~0)
379 a->decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
380 if (!vxlan_decap_next_is_valid(vxm, is_ip6, a->decap_next_index))
381 return VNET_API_ERROR_INVALID_DECAP_NEXT;
383 pool_get_aligned (vxm->tunnels, t, CLIB_CACHE_LINE_BYTES);
384 *t = (vxlan_tunnel_t){ 0 };
385 dev_instance = t - vxm->tunnels;
387 /* copy from arg structure */
388 #define _(x) t->x = a->x;
392 vxlan_rewrite (t, is_ip6);
394 * Reconcile the real dev_instance and a possible requested instance.
396 user_instance = a->instance;
397 if (user_instance == ~0)
398 user_instance = dev_instance;
399 if (hash_get (vxm->instance_used, user_instance))
401 pool_put (vxm->tunnels, t);
402 return VNET_API_ERROR_INSTANCE_IN_USE;
404 hash_set (vxm->instance_used, user_instance, 1);
406 t->dev_instance = dev_instance; /* actual */
407 t->user_instance = user_instance; /* name */
411 hash_set_mem_alloc (&vxm->vxlan6_tunnel_by_key, &key6, dev_instance);
413 hash_set (vxm->vxlan4_tunnel_by_key, key4.as_u64, dev_instance);
415 t->hw_if_index = vnet_register_interface
416 (vnm, vxlan_device_class.index, dev_instance,
417 vxlan_hw_class.index, dev_instance);
418 vnet_hw_interface_t * hi = vnet_get_hw_interface (vnm, t->hw_if_index);
420 /* Set vxlan tunnel output node */
421 u32 encap_index = !is_ip6 ?
422 vxlan4_encap_node.index : vxlan6_encap_node.index;
423 vnet_set_interface_output_node (vnm, t->hw_if_index, encap_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] = dev_instance;
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, dev_instance);
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;
542 t = pool_elt_at_index (vxm->tunnels, instance);
544 sw_if_index = t->sw_if_index;
545 vnet_sw_interface_set_flags (vnm, sw_if_index, 0 /* down */);
547 vxm->tunnel_index_by_sw_if_index[sw_if_index] = ~0;
550 hash_unset (vxm->vxlan4_tunnel_by_key, key4.as_u64);
552 hash_unset_mem_free (&vxm->vxlan6_tunnel_by_key, &key6);
554 if (!ip46_address_is_multicast(&t->dst))
556 vtep_addr_unref(&t->src);
557 fib_entry_child_remove(t->fib_entry_index, t->sibling_index);
558 fib_table_entry_delete_index(t->fib_entry_index, FIB_SOURCE_RR);
560 else if (vtep_addr_unref(&t->dst) == 0)
562 mcast_shared_remove(&t->dst);
565 vnet_delete_hw_interface (vnm, t->hw_if_index);
566 hash_unset (vxlan_main.instance_used, instance);
568 fib_node_deinit(&t->node);
569 vec_free (t->rewrite);
570 pool_put (vxm->tunnels, t);
574 *sw_if_indexp = sw_if_index;
579 static uword get_decap_next_for_node(u32 node_index, u32 ipv4_set)
581 vxlan_main_t * vxm = &vxlan_main;
582 vlib_main_t * vm = vxm->vlib_main;
583 uword input_node = (ipv4_set) ? vxlan4_input_node.index :
584 vxlan6_input_node.index;
586 return vlib_node_add_next (vm, input_node, node_index);
589 static uword unformat_decap_next (unformat_input_t * input, va_list * args)
591 u32 * result = va_arg (*args, u32 *);
592 u32 ipv4_set = va_arg (*args, int);
593 vxlan_main_t * vxm = &vxlan_main;
594 vlib_main_t * vm = vxm->vlib_main;
598 if (unformat (input, "l2"))
599 *result = VXLAN_INPUT_NEXT_L2_INPUT;
600 else if (unformat (input, "node %U", unformat_vlib_node, vm, &node_index))
601 *result = get_decap_next_for_node(node_index, ipv4_set);
602 else if (unformat (input, "%d", &tmp))
609 static clib_error_t *
610 vxlan_add_del_tunnel_command_fn (vlib_main_t * vm,
611 unformat_input_t * input,
612 vlib_cli_command_t * cmd)
614 unformat_input_t _line_input, * line_input = &_line_input;
615 ip46_address_t src , dst;
623 u32 encap_fib_index = 0;
624 u32 mcast_sw_if_index = ~0;
625 u32 decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
629 vnet_vxlan_add_del_tunnel_args_t _a, * a = &_a;
630 u32 tunnel_sw_if_index;
631 clib_error_t *error = NULL;
633 /* Cant "universally zero init" (={0}) due to GCC bug 53119 */
634 memset(&src, 0, sizeof src);
635 memset(&dst, 0, sizeof dst);
637 /* Get a line of input. */
638 if (! unformat_user (input, unformat_line_input, line_input))
641 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) {
642 if (unformat (line_input, "del"))
646 else if (unformat (line_input, "instance %d", &instance))
648 else if (unformat (line_input, "src %U",
649 unformat_ip4_address, &src.ip4))
654 else if (unformat (line_input, "dst %U",
655 unformat_ip4_address, &dst.ip4))
660 else if (unformat (line_input, "src %U",
661 unformat_ip6_address, &src.ip6))
666 else if (unformat (line_input, "dst %U",
667 unformat_ip6_address, &dst.ip6))
672 else if (unformat (line_input, "group %U %U",
673 unformat_ip4_address, &dst.ip4,
674 unformat_vnet_sw_interface,
675 vnet_get_main(), &mcast_sw_if_index))
677 grp_set = dst_set = 1;
680 else if (unformat (line_input, "group %U %U",
681 unformat_ip6_address, &dst.ip6,
682 unformat_vnet_sw_interface,
683 vnet_get_main(), &mcast_sw_if_index))
685 grp_set = dst_set = 1;
688 else if (unformat (line_input, "encap-vrf-id %d", &tmp))
690 encap_fib_index = fib_table_find (fib_ip_proto (ipv6_set), tmp);
691 if (encap_fib_index == ~0)
693 error = clib_error_return (0, "nonexistent encap-vrf-id %d", tmp);
697 else if (unformat (line_input, "decap-next %U", unformat_decap_next,
698 &decap_next_index, ipv4_set))
700 else if (unformat (line_input, "vni %d", &vni))
704 error = clib_error_return (0, "vni %d out of range", vni);
710 error = clib_error_return (0, "parse error: '%U'",
711 format_unformat_error, line_input);
718 error = clib_error_return (0, "tunnel src address not specified");
724 error = clib_error_return (0, "tunnel dst address not specified");
728 if (grp_set && !ip46_address_is_multicast(&dst))
730 error = clib_error_return (0, "tunnel group address not multicast");
734 if (grp_set == 0 && ip46_address_is_multicast(&dst))
736 error = clib_error_return (0, "dst address must be unicast");
740 if (grp_set && mcast_sw_if_index == ~0)
742 error = clib_error_return (0, "tunnel nonexistent multicast device");
746 if (ipv4_set && ipv6_set)
748 error = clib_error_return (0, "both IPv4 and IPv6 addresses specified");
752 if (ip46_address_cmp(&src, &dst) == 0)
754 error = clib_error_return (0, "src and dst addresses are identical");
758 if (decap_next_index == ~0)
760 error = clib_error_return (0, "next node not found");
766 error = clib_error_return (0, "vni not specified");
770 memset (a, 0, sizeof (*a));
773 a->is_ip6 = ipv6_set;
774 a->instance = instance;
776 #define _(x) a->x = x;
780 rv = vnet_vxlan_add_del_tunnel (a, &tunnel_sw_if_index);
786 vlib_cli_output(vm, "%U\n", format_vnet_sw_if_index_name,
787 vnet_get_main(), tunnel_sw_if_index);
790 case VNET_API_ERROR_TUNNEL_EXIST:
791 error = clib_error_return (0, "tunnel already exists...");
794 case VNET_API_ERROR_NO_SUCH_ENTRY:
795 error = clib_error_return (0, "tunnel does not exist...");
798 case VNET_API_ERROR_INSTANCE_IN_USE:
799 error = clib_error_return (0, "Instance is in use");
803 error = clib_error_return
804 (0, "vnet_vxlan_add_del_tunnel returned %d", rv);
809 unformat_free (line_input);
815 * Add or delete a VXLAN Tunnel.
817 * VXLAN provides the features needed to allow L2 bridge domains (BDs)
818 * to span multiple servers. This is done by building an L2 overlay on
819 * top of an L3 network underlay using VXLAN tunnels.
821 * This makes it possible for servers to be co-located in the same data
822 * center or be separated geographically as long as they are reachable
823 * through the underlay L3 network.
825 * You can refer to this kind of L2 overlay bridge domain as a VXLAN
826 * (Virtual eXtensible VLAN) segment.
829 * Example of how to create a VXLAN Tunnel:
830 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 encap-vrf-id 7}
831 * Example of how to create a VXLAN Tunnel with a known name, vxlan_tunnel42:
832 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 instance 42}
833 * Example of how to delete a VXLAN Tunnel:
834 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 del}
837 VLIB_CLI_COMMAND (create_vxlan_tunnel_command, static) = {
838 .path = "create vxlan tunnel",
840 "create vxlan tunnel src <local-vtep-addr>"
841 " {dst <remote-vtep-addr>|group <mcast-vtep-addr> <intf-name>} vni <nn>"
843 " [encap-vrf-id <nn>] [decap-next [l2|node <name>]] [del]",
844 .function = vxlan_add_del_tunnel_command_fn,
848 static clib_error_t *
849 show_vxlan_tunnel_command_fn (vlib_main_t * vm,
850 unformat_input_t * input,
851 vlib_cli_command_t * cmd)
853 vxlan_main_t * vxm = &vxlan_main;
856 if (pool_elts (vxm->tunnels) == 0)
857 vlib_cli_output (vm, "No vxlan tunnels configured...");
859 pool_foreach (t, vxm->tunnels,
861 vlib_cli_output (vm, "%U", format_vxlan_tunnel, t);
868 * Display all the VXLAN Tunnel entries.
871 * Example of how to display the VXLAN Tunnel entries:
872 * @cliexstart{show vxlan tunnel}
873 * [0] src 10.0.3.1 dst 10.0.3.3 vni 13 encap_fib_index 0 sw_if_index 5 decap_next l2
877 VLIB_CLI_COMMAND (show_vxlan_tunnel_command, static) = {
878 .path = "show vxlan tunnel",
879 .short_help = "show vxlan tunnel",
880 .function = show_vxlan_tunnel_command_fn,
885 void vnet_int_vxlan_bypass_mode (u32 sw_if_index,
890 vnet_feature_enable_disable ("ip6-unicast", "ip6-vxlan-bypass",
891 sw_if_index, is_enable, 0, 0);
893 vnet_feature_enable_disable ("ip4-unicast", "ip4-vxlan-bypass",
894 sw_if_index, is_enable, 0, 0);
898 static clib_error_t *
899 set_ip_vxlan_bypass (u32 is_ip6,
900 unformat_input_t * input,
901 vlib_cli_command_t * cmd)
903 unformat_input_t _line_input, * line_input = &_line_input;
904 vnet_main_t * vnm = vnet_get_main();
905 clib_error_t * error = 0;
906 u32 sw_if_index, is_enable;
911 if (! unformat_user (input, unformat_line_input, line_input))
914 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
916 if (unformat_user (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
918 else if (unformat (line_input, "del"))
922 error = unformat_parse_error (line_input);
927 if (~0 == sw_if_index)
929 error = clib_error_return (0, "unknown interface `%U'",
930 format_unformat_error, line_input);
934 vnet_int_vxlan_bypass_mode (sw_if_index, is_ip6, is_enable);
937 unformat_free (line_input);
942 static clib_error_t *
943 set_ip4_vxlan_bypass (vlib_main_t * vm,
944 unformat_input_t * input,
945 vlib_cli_command_t * cmd)
947 return set_ip_vxlan_bypass (0, input, cmd);
951 * This command adds the 'ip4-vxlan-bypass' graph node for a given interface.
952 * By adding the IPv4 vxlan-bypass graph node to an interface, the node checks
953 * for and validate input vxlan packet and bypass ip4-lookup, ip4-local,
954 * ip4-udp-lookup nodes to speedup vxlan packet forwarding. This node will
955 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
959 * Example of graph node before ip4-vxlan-bypass is enabled:
960 * @cliexstart{show vlib graph ip4-vxlan-bypass}
962 * ip4-vxlan-bypass error-drop [0]
967 * Example of how to enable ip4-vxlan-bypass on an interface:
968 * @cliexcmd{set interface ip vxlan-bypass GigabitEthernet2/0/0}
970 * Example of graph node after ip4-vxlan-bypass is enabled:
971 * @cliexstart{show vlib graph ip4-vxlan-bypass}
973 * ip4-vxlan-bypass error-drop [0] ip4-input
974 * vxlan4-input [1] ip4-input-no-checksum
978 * Example of how to display the feature enabed on an interface:
979 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
980 * IP feature paths configured on GigabitEthernet2/0/0...
988 * Example of how to disable ip4-vxlan-bypass on an interface:
989 * @cliexcmd{set interface ip vxlan-bypass GigabitEthernet2/0/0 del}
993 VLIB_CLI_COMMAND (set_interface_ip_vxlan_bypass_command, static) = {
994 .path = "set interface ip vxlan-bypass",
995 .function = set_ip4_vxlan_bypass,
996 .short_help = "set interface ip vxlan-bypass <interface> [del]",
1000 static clib_error_t *
1001 set_ip6_vxlan_bypass (vlib_main_t * vm,
1002 unformat_input_t * input,
1003 vlib_cli_command_t * cmd)
1005 return set_ip_vxlan_bypass (1, input, cmd);
1009 * This command adds the 'ip6-vxlan-bypass' graph node for a given interface.
1010 * By adding the IPv6 vxlan-bypass graph node to an interface, the node checks
1011 * for and validate input vxlan packet and bypass ip6-lookup, ip6-local,
1012 * ip6-udp-lookup nodes to speedup vxlan packet forwarding. This node will
1013 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
1017 * Example of graph node before ip6-vxlan-bypass is enabled:
1018 * @cliexstart{show vlib graph ip6-vxlan-bypass}
1019 * Name Next Previous
1020 * ip6-vxlan-bypass error-drop [0]
1025 * Example of how to enable ip6-vxlan-bypass on an interface:
1026 * @cliexcmd{set interface ip6 vxlan-bypass GigabitEthernet2/0/0}
1028 * Example of graph node after ip6-vxlan-bypass is enabled:
1029 * @cliexstart{show vlib graph ip6-vxlan-bypass}
1030 * Name Next Previous
1031 * ip6-vxlan-bypass error-drop [0] ip6-input
1032 * vxlan6-input [1] ip4-input-no-checksum
1036 * Example of how to display the feature enabed on an interface:
1037 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1038 * IP feature paths configured on GigabitEthernet2/0/0...
1046 * Example of how to disable ip6-vxlan-bypass on an interface:
1047 * @cliexcmd{set interface ip6 vxlan-bypass GigabitEthernet2/0/0 del}
1051 VLIB_CLI_COMMAND (set_interface_ip6_vxlan_bypass_command, static) = {
1052 .path = "set interface ip6 vxlan-bypass",
1053 .function = set_ip6_vxlan_bypass,
1054 .short_help = "set interface ip vxlan-bypass <interface> [del]",
1058 clib_error_t *vxlan_init (vlib_main_t *vm)
1060 vxlan_main_t * vxm = &vxlan_main;
1062 vxm->vnet_main = vnet_get_main();
1063 vxm->vlib_main = vm;
1065 /* initialize the ip6 hash */
1066 vxm->vxlan6_tunnel_by_key = hash_create_mem(0,
1067 sizeof(vxlan6_tunnel_key_t),
1069 vxm->vtep6 = hash_create_mem(0,
1070 sizeof(ip6_address_t),
1072 vxm->mcast_shared = hash_create_mem(0,
1073 sizeof(ip46_address_t),
1074 sizeof(mcast_shared_t));
1076 udp_register_dst_port (vm, UDP_DST_PORT_vxlan,
1077 vxlan4_input_node.index, /* is_ip4 */ 1);
1078 udp_register_dst_port (vm, UDP_DST_PORT_vxlan6,
1079 vxlan6_input_node.index, /* is_ip4 */ 0);
1081 fib_node_register_type(FIB_NODE_TYPE_VXLAN_TUNNEL, &vxlan_vft);
1086 VLIB_INIT_FUNCTION(vxlan_init);
1090 * eval: (c-set-style "gnu")