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 *);
59 "[%d] instance %d src %U dst %U vni %d fib-idx %d sw-if-idx %d ",
60 t->dev_instance, t->user_instance,
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 vxlan_main_t * vxm = &vxlan_main;
82 if (dev_instance == ~0)
83 return format(s, "<cached-unused>");
85 if (dev_instance >= vec_len(vxm->tunnels))
86 return format(s, "<improperly-referenced>");
88 t = pool_elt_at_index(vxm->tunnels, dev_instance);
90 return format (s, "vxlan_tunnel%d", t->user_instance);
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 .admin_up_down_function = vxlan_interface_admin_up_down,
110 static u8 * format_vxlan_header_with_length (u8 * s, va_list * args)
112 u32 dev_instance = va_arg (*args, u32);
113 s = format (s, "unimplemented dev %u", dev_instance);
117 VNET_HW_INTERFACE_CLASS (vxlan_hw_class) = {
119 .format_header = format_vxlan_header_with_length,
120 .build_rewrite = default_build_rewrite,
124 vxlan_tunnel_restack_dpo(vxlan_tunnel_t * t)
126 dpo_id_t dpo = DPO_INVALID;
127 u32 encap_index = ip46_address_is_ip4(&t->dst) ?
128 vxlan4_encap_node.index : vxlan6_encap_node.index;
129 fib_forward_chain_type_t forw_type = ip46_address_is_ip4(&t->dst) ?
130 FIB_FORW_CHAIN_TYPE_UNICAST_IP4 : FIB_FORW_CHAIN_TYPE_UNICAST_IP6;
132 fib_entry_contribute_forwarding (t->fib_entry_index, forw_type, &dpo);
133 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
137 static vxlan_tunnel_t *
138 vxlan_tunnel_from_fib_node (fib_node_t *node)
140 ASSERT(FIB_NODE_TYPE_VXLAN_TUNNEL == node->fn_type);
141 return ((vxlan_tunnel_t*) (((char*)node) -
142 STRUCT_OFFSET_OF(vxlan_tunnel_t, node)));
146 * Function definition to backwalk a FIB node -
147 * Here we will restack the new dpo of VXLAN DIP to encap node.
149 static fib_node_back_walk_rc_t
150 vxlan_tunnel_back_walk (fib_node_t *node,
151 fib_node_back_walk_ctx_t *ctx)
153 vxlan_tunnel_restack_dpo(vxlan_tunnel_from_fib_node(node));
154 return (FIB_NODE_BACK_WALK_CONTINUE);
158 * Function definition to get a FIB node from its index
161 vxlan_tunnel_fib_node_get (fib_node_index_t index)
164 vxlan_main_t * vxm = &vxlan_main;
166 t = pool_elt_at_index(vxm->tunnels, index);
172 * Function definition to inform the FIB node that its last lock has gone.
175 vxlan_tunnel_last_lock_gone (fib_node_t *node)
178 * The VXLAN tunnel is a root of the graph. As such
179 * it never has children and thus is never locked.
185 * Virtual function table registered by VXLAN tunnels
186 * for participation in the FIB object graph.
188 const static fib_node_vft_t vxlan_vft = {
189 .fnv_get = vxlan_tunnel_fib_node_get,
190 .fnv_last_lock = vxlan_tunnel_last_lock_gone,
191 .fnv_back_walk = vxlan_tunnel_back_walk,
195 #define foreach_copy_field \
197 _(mcast_sw_if_index) \
199 _(decap_next_index) \
204 vxlan_rewrite (vxlan_tunnel_t * t, bool is_ip6)
207 ip4_vxlan_header_t * h4;
208 ip6_vxlan_header_t * h6;
211 int len = is_ip6 ? sizeof *r.h6 : sizeof *r.h4;
213 vec_validate_aligned (r.rw, len-1, CLIB_CACHE_LINE_BYTES);
216 vxlan_header_t * vxlan;
217 /* Fixed portion of the (outer) ip header */
220 ip4_header_t * ip = &r.h4->ip4;
221 udp = &r.h4->udp, vxlan = &r.h4->vxlan;
222 ip->ip_version_and_header_length = 0x45;
224 ip->protocol = IP_PROTOCOL_UDP;
226 ip->src_address = t->src.ip4;
227 ip->dst_address = t->dst.ip4;
229 /* we fix up the ip4 header length and checksum after-the-fact */
230 ip->checksum = ip4_header_checksum (ip);
234 ip6_header_t * ip = &r.h6->ip6;
235 udp = &r.h6->udp, vxlan = &r.h6->vxlan;
236 ip->ip_version_traffic_class_and_flow_label = clib_host_to_net_u32(6 << 28);
238 ip->protocol = IP_PROTOCOL_UDP;
240 ip->src_address = t->src.ip6;
241 ip->dst_address = t->dst.ip6;
244 /* UDP header, randomize src port on something, maybe? */
245 udp->src_port = clib_host_to_net_u16 (4789);
246 udp->dst_port = clib_host_to_net_u16 (UDP_DST_PORT_vxlan);
249 vnet_set_vni_and_flags(vxlan, t->vni);
255 vxlan_decap_next_is_valid (vxlan_main_t * vxm, u32 is_ip6, u32 decap_next_index)
257 vlib_main_t * vm = vxm->vlib_main;
258 u32 input_idx = (!is_ip6) ? vxlan4_input_node.index : vxlan6_input_node.index;
259 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, input_idx);
261 return decap_next_index < r->n_next_nodes;
265 vtep_addr_ref(ip46_address_t *ip)
267 uword *vtep = ip46_address_is_ip4(ip) ?
268 hash_get (vxlan_main.vtep4, ip->ip4.as_u32) :
269 hash_get_mem (vxlan_main.vtep6, &ip->ip6);
272 ip46_address_is_ip4(ip) ?
273 hash_set (vxlan_main.vtep4, ip->ip4.as_u32, 1) :
274 hash_set_mem_alloc (&vxlan_main.vtep6, &ip->ip6, 1);
279 vtep_addr_unref(ip46_address_t *ip)
281 uword *vtep = ip46_address_is_ip4(ip) ?
282 hash_get (vxlan_main.vtep4, ip->ip4.as_u32) :
283 hash_get_mem (vxlan_main.vtep6, &ip->ip6);
287 ip46_address_is_ip4(ip) ?
288 hash_unset (vxlan_main.vtep4, ip->ip4.as_u32) :
289 hash_unset_mem_free (&vxlan_main.vtep6, &ip->ip6);
293 typedef CLIB_PACKED(union {
295 fib_node_index_t mfib_entry_index;
296 adj_index_t mcast_adj_index;
301 static inline mcast_shared_t
302 mcast_shared_get(ip46_address_t * ip)
304 ASSERT(ip46_address_is_multicast(ip));
305 uword * p = hash_get_mem (vxlan_main.mcast_shared, ip);
307 return (mcast_shared_t) { .as_u64 = *p };
311 mcast_shared_add(ip46_address_t *dst,
312 fib_node_index_t mfei,
315 mcast_shared_t new_ep = {
316 .mcast_adj_index = ai,
317 .mfib_entry_index = mfei,
320 hash_set_mem_alloc (&vxlan_main.mcast_shared, dst, new_ep.as_u64);
324 mcast_shared_remove(ip46_address_t *dst)
326 mcast_shared_t ep = mcast_shared_get(dst);
328 adj_unlock(ep.mcast_adj_index);
329 mfib_table_entry_delete_index(ep.mfib_entry_index,
332 hash_unset_mem_free (&vxlan_main.mcast_shared, dst);
335 int vnet_vxlan_add_del_tunnel
336 (vnet_vxlan_add_del_tunnel_args_t *a, u32 * sw_if_indexp)
338 vxlan_main_t * vxm = &vxlan_main;
339 vxlan_tunnel_t *t = 0;
340 vnet_main_t * vnm = vxm->vnet_main;
342 u32 sw_if_index = ~0;
343 vxlan4_tunnel_key_t key4;
344 vxlan6_tunnel_key_t key6;
345 u32 is_ip6 = a->is_ip6;
349 key4.src = a->dst.ip4.as_u32; /* decap src in key is encap dst in config */
350 key4.vni = clib_host_to_net_u32 (a->vni << 8);
351 p = hash_get (vxm->vxlan4_tunnel_by_key, key4.as_u64);
355 key6.src = a->dst.ip6;
356 key6.vni = clib_host_to_net_u32 (a->vni << 8);
357 p = hash_get_mem (vxm->vxlan6_tunnel_by_key, &key6);
362 l2input_main_t * l2im = &l2input_main;
363 u32 dev_instance; /* real dev instance tunnel index */
364 u32 user_instance; /* request and actual instance number */
366 /* adding a tunnel: tunnel must not already exist */
368 return VNET_API_ERROR_TUNNEL_EXIST;
370 /*if not set explicitly, default to l2 */
371 if(a->decap_next_index == ~0)
372 a->decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
373 if (!vxlan_decap_next_is_valid(vxm, is_ip6, a->decap_next_index))
374 return VNET_API_ERROR_INVALID_DECAP_NEXT;
376 pool_get_aligned (vxm->tunnels, t, CLIB_CACHE_LINE_BYTES);
377 *t = (vxlan_tunnel_t){ 0 };
378 dev_instance = t - vxm->tunnels;
380 /* copy from arg structure */
381 #define _(x) t->x = a->x;
385 vxlan_rewrite (t, is_ip6);
387 * Reconcile the real dev_instance and a possible requested instance.
389 user_instance = a->instance;
390 if (user_instance == ~0)
391 user_instance = dev_instance;
392 if (hash_get (vxm->instance_used, user_instance))
394 pool_put (vxm->tunnels, t);
395 return VNET_API_ERROR_INSTANCE_IN_USE;
397 hash_set (vxm->instance_used, user_instance, 1);
399 t->dev_instance = dev_instance; /* actual */
400 t->user_instance = user_instance; /* name */
404 hash_set_mem_alloc (&vxm->vxlan6_tunnel_by_key, &key6, dev_instance);
406 hash_set (vxm->vxlan4_tunnel_by_key, key4.as_u64, dev_instance);
408 t->hw_if_index = vnet_register_interface
409 (vnm, vxlan_device_class.index, dev_instance,
410 vxlan_hw_class.index, dev_instance);
411 vnet_hw_interface_t * hi = vnet_get_hw_interface (vnm, t->hw_if_index);
413 /* Set vxlan tunnel output node */
414 u32 encap_index = !is_ip6 ?
415 vxlan4_encap_node.index : vxlan6_encap_node.index;
416 vnet_set_interface_output_node (vnm, t->hw_if_index, encap_index);
418 t->sw_if_index = sw_if_index = hi->sw_if_index;
420 vec_validate_init_empty (vxm->tunnel_index_by_sw_if_index, sw_if_index, ~0);
421 vxm->tunnel_index_by_sw_if_index[sw_if_index] = dev_instance;
423 /* setup l2 input config with l2 feature and bd 0 to drop packet */
424 vec_validate (l2im->configs, sw_if_index);
425 l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
426 l2im->configs[sw_if_index].bd_index = 0;
428 vnet_sw_interface_t * si = vnet_get_sw_interface (vnm, sw_if_index);
429 si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
430 vnet_sw_interface_set_flags (vnm, sw_if_index,
431 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
433 fib_node_init(&t->node, FIB_NODE_TYPE_VXLAN_TUNNEL);
434 fib_prefix_t tun_dst_pfx;
435 vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
437 fib_prefix_from_ip46_addr(&t->dst, &tun_dst_pfx);
438 if (!ip46_address_is_multicast(&t->dst))
441 * source the FIB entry for the tunnel's destination
442 * and become a child thereof. The tunnel will then get poked
443 * when the forwarding for the entry updates, and the tunnel can
444 * re-stack accordingly
446 vtep_addr_ref(&t->src);
447 t->fib_entry_index = fib_table_entry_special_add
448 (t->encap_fib_index, &tun_dst_pfx, FIB_SOURCE_RR,
449 FIB_ENTRY_FLAG_NONE);
450 t->sibling_index = fib_entry_child_add
451 (t->fib_entry_index, FIB_NODE_TYPE_VXLAN_TUNNEL, dev_instance);
452 vxlan_tunnel_restack_dpo(t);
456 /* Multicast tunnel -
457 * as the same mcast group can be used for mutiple mcast tunnels
458 * with different VNIs, create the output fib adjecency only if
459 * it does not already exist
461 fib_protocol_t fp = fib_ip_proto(is_ip6);
463 if (vtep_addr_ref(&t->dst) == 1)
465 fib_node_index_t mfei;
467 fib_route_path_t path = {
468 .frp_proto = fib_proto_to_dpo(fp),
469 .frp_addr = zero_addr,
470 .frp_sw_if_index = 0xffffffff,
473 .frp_flags = FIB_ROUTE_PATH_LOCAL,
475 const mfib_prefix_t mpfx = {
477 .fp_len = (is_ip6 ? 128 : 32),
478 .fp_grp_addr = tun_dst_pfx.fp_addr,
482 * Setup the (*,G) to receive traffic on the mcast group
483 * - the forwarding interface is for-us
484 * - the accepting interface is that from the API
486 mfib_table_entry_path_update(t->encap_fib_index,
490 MFIB_ITF_FLAG_FORWARD);
492 path.frp_sw_if_index = a->mcast_sw_if_index;
493 path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
494 mfei = mfib_table_entry_path_update(t->encap_fib_index,
498 MFIB_ITF_FLAG_ACCEPT);
501 * Create the mcast adjacency to send traffic to the group
503 ai = adj_mcast_add_or_lock(fp,
504 fib_proto_to_link(fp),
505 a->mcast_sw_if_index);
508 * create a new end-point
510 mcast_shared_add(&t->dst, mfei, ai);
513 dpo_id_t dpo = DPO_INVALID;
514 mcast_shared_t ep = mcast_shared_get(&t->dst);
516 /* Stack shared mcast dst mac addr rewrite on encap */
517 dpo_set (&dpo, DPO_ADJACENCY_MCAST,
518 fib_proto_to_dpo(fp),
521 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
523 flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
526 vnet_get_sw_interface (vnet_get_main(), sw_if_index)->flood_class = flood_class;
530 /* deleting a tunnel: tunnel must exist */
532 return VNET_API_ERROR_NO_SUCH_ENTRY;
535 t = pool_elt_at_index (vxm->tunnels, instance);
537 sw_if_index = t->sw_if_index;
538 vnet_sw_interface_set_flags (vnm, sw_if_index, 0 /* down */);
540 vxm->tunnel_index_by_sw_if_index[sw_if_index] = ~0;
543 hash_unset (vxm->vxlan4_tunnel_by_key, key4.as_u64);
545 hash_unset_mem_free (&vxm->vxlan6_tunnel_by_key, &key6);
547 if (!ip46_address_is_multicast(&t->dst))
549 vtep_addr_unref(&t->src);
550 fib_entry_child_remove(t->fib_entry_index, t->sibling_index);
551 fib_table_entry_delete_index(t->fib_entry_index, FIB_SOURCE_RR);
553 else if (vtep_addr_unref(&t->dst) == 0)
555 mcast_shared_remove(&t->dst);
558 vnet_delete_hw_interface (vnm, t->hw_if_index);
559 hash_unset (vxm->instance_used, t->user_instance);
561 fib_node_deinit(&t->node);
562 vec_free (t->rewrite);
563 pool_put (vxm->tunnels, t);
567 *sw_if_indexp = sw_if_index;
572 static uword get_decap_next_for_node(u32 node_index, u32 ipv4_set)
574 vxlan_main_t * vxm = &vxlan_main;
575 vlib_main_t * vm = vxm->vlib_main;
576 uword input_node = (ipv4_set) ? vxlan4_input_node.index :
577 vxlan6_input_node.index;
579 return vlib_node_add_next (vm, input_node, node_index);
582 static uword unformat_decap_next (unformat_input_t * input, va_list * args)
584 u32 * result = va_arg (*args, u32 *);
585 u32 ipv4_set = va_arg (*args, int);
586 vxlan_main_t * vxm = &vxlan_main;
587 vlib_main_t * vm = vxm->vlib_main;
591 if (unformat (input, "l2"))
592 *result = VXLAN_INPUT_NEXT_L2_INPUT;
593 else if (unformat (input, "node %U", unformat_vlib_node, vm, &node_index))
594 *result = get_decap_next_for_node(node_index, ipv4_set);
595 else if (unformat (input, "%d", &tmp))
602 static clib_error_t *
603 vxlan_add_del_tunnel_command_fn (vlib_main_t * vm,
604 unformat_input_t * input,
605 vlib_cli_command_t * cmd)
607 unformat_input_t _line_input, * line_input = &_line_input;
608 ip46_address_t src , dst;
616 u32 encap_fib_index = 0;
617 u32 mcast_sw_if_index = ~0;
618 u32 decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
622 vnet_vxlan_add_del_tunnel_args_t _a, * a = &_a;
623 u32 tunnel_sw_if_index;
624 clib_error_t *error = NULL;
626 /* Cant "universally zero init" (={0}) due to GCC bug 53119 */
627 memset(&src, 0, sizeof src);
628 memset(&dst, 0, sizeof dst);
630 /* Get a line of input. */
631 if (! unformat_user (input, unformat_line_input, line_input))
634 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) {
635 if (unformat (line_input, "del"))
639 else if (unformat (line_input, "instance %d", &instance))
641 else if (unformat (line_input, "src %U",
642 unformat_ip4_address, &src.ip4))
647 else if (unformat (line_input, "dst %U",
648 unformat_ip4_address, &dst.ip4))
653 else if (unformat (line_input, "src %U",
654 unformat_ip6_address, &src.ip6))
659 else if (unformat (line_input, "dst %U",
660 unformat_ip6_address, &dst.ip6))
665 else if (unformat (line_input, "group %U %U",
666 unformat_ip4_address, &dst.ip4,
667 unformat_vnet_sw_interface,
668 vnet_get_main(), &mcast_sw_if_index))
670 grp_set = dst_set = 1;
673 else if (unformat (line_input, "group %U %U",
674 unformat_ip6_address, &dst.ip6,
675 unformat_vnet_sw_interface,
676 vnet_get_main(), &mcast_sw_if_index))
678 grp_set = dst_set = 1;
681 else if (unformat (line_input, "encap-vrf-id %d", &tmp))
683 encap_fib_index = fib_table_find (fib_ip_proto (ipv6_set), tmp);
684 if (encap_fib_index == ~0)
686 error = clib_error_return (0, "nonexistent encap-vrf-id %d", tmp);
690 else if (unformat (line_input, "decap-next %U", unformat_decap_next,
691 &decap_next_index, ipv4_set))
693 else if (unformat (line_input, "vni %d", &vni))
697 error = clib_error_return (0, "vni %d out of range", vni);
703 error = clib_error_return (0, "parse error: '%U'",
704 format_unformat_error, line_input);
711 error = clib_error_return (0, "tunnel src address not specified");
717 error = clib_error_return (0, "tunnel dst address not specified");
721 if (grp_set && !ip46_address_is_multicast(&dst))
723 error = clib_error_return (0, "tunnel group address not multicast");
727 if (grp_set == 0 && ip46_address_is_multicast(&dst))
729 error = clib_error_return (0, "dst address must be unicast");
733 if (grp_set && mcast_sw_if_index == ~0)
735 error = clib_error_return (0, "tunnel nonexistent multicast device");
739 if (ipv4_set && ipv6_set)
741 error = clib_error_return (0, "both IPv4 and IPv6 addresses specified");
745 if (ip46_address_cmp(&src, &dst) == 0)
747 error = clib_error_return (0, "src and dst addresses are identical");
751 if (decap_next_index == ~0)
753 error = clib_error_return (0, "next node not found");
759 error = clib_error_return (0, "vni not specified");
763 memset (a, 0, sizeof (*a));
766 a->is_ip6 = ipv6_set;
767 a->instance = instance;
769 #define _(x) a->x = x;
773 rv = vnet_vxlan_add_del_tunnel (a, &tunnel_sw_if_index);
779 vlib_cli_output(vm, "%U\n", format_vnet_sw_if_index_name,
780 vnet_get_main(), tunnel_sw_if_index);
783 case VNET_API_ERROR_TUNNEL_EXIST:
784 error = clib_error_return (0, "tunnel already exists...");
787 case VNET_API_ERROR_NO_SUCH_ENTRY:
788 error = clib_error_return (0, "tunnel does not exist...");
791 case VNET_API_ERROR_INSTANCE_IN_USE:
792 error = clib_error_return (0, "Instance is in use");
796 error = clib_error_return
797 (0, "vnet_vxlan_add_del_tunnel returned %d", rv);
802 unformat_free (line_input);
808 * Add or delete a VXLAN Tunnel.
810 * VXLAN provides the features needed to allow L2 bridge domains (BDs)
811 * to span multiple servers. This is done by building an L2 overlay on
812 * top of an L3 network underlay using VXLAN tunnels.
814 * This makes it possible for servers to be co-located in the same data
815 * center or be separated geographically as long as they are reachable
816 * through the underlay L3 network.
818 * You can refer to this kind of L2 overlay bridge domain as a VXLAN
819 * (Virtual eXtensible VLAN) segment.
822 * Example of how to create a VXLAN Tunnel:
823 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 encap-vrf-id 7}
824 * Example of how to create a VXLAN Tunnel with a known name, vxlan_tunnel42:
825 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 instance 42}
826 * Example of how to delete a VXLAN Tunnel:
827 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 del}
830 VLIB_CLI_COMMAND (create_vxlan_tunnel_command, static) = {
831 .path = "create vxlan tunnel",
833 "create vxlan tunnel src <local-vtep-addr>"
834 " {dst <remote-vtep-addr>|group <mcast-vtep-addr> <intf-name>} vni <nn>"
836 " [encap-vrf-id <nn>] [decap-next [l2|node <name>]] [del]",
837 .function = vxlan_add_del_tunnel_command_fn,
841 static clib_error_t *
842 show_vxlan_tunnel_command_fn (vlib_main_t * vm,
843 unformat_input_t * input,
844 vlib_cli_command_t * cmd)
846 vxlan_main_t * vxm = &vxlan_main;
849 if (pool_elts (vxm->tunnels) == 0)
850 vlib_cli_output (vm, "No vxlan tunnels configured...");
852 pool_foreach (t, vxm->tunnels,
854 vlib_cli_output (vm, "%U", format_vxlan_tunnel, t);
861 * Display all the VXLAN Tunnel entries.
864 * Example of how to display the VXLAN Tunnel entries:
865 * @cliexstart{show vxlan tunnel}
866 * [0] src 10.0.3.1 dst 10.0.3.3 vni 13 encap_fib_index 0 sw_if_index 5 decap_next l2
870 VLIB_CLI_COMMAND (show_vxlan_tunnel_command, static) = {
871 .path = "show vxlan tunnel",
872 .short_help = "show vxlan tunnel",
873 .function = show_vxlan_tunnel_command_fn,
878 void vnet_int_vxlan_bypass_mode (u32 sw_if_index,
883 vnet_feature_enable_disable ("ip6-unicast", "ip6-vxlan-bypass",
884 sw_if_index, is_enable, 0, 0);
886 vnet_feature_enable_disable ("ip4-unicast", "ip4-vxlan-bypass",
887 sw_if_index, is_enable, 0, 0);
891 static clib_error_t *
892 set_ip_vxlan_bypass (u32 is_ip6,
893 unformat_input_t * input,
894 vlib_cli_command_t * cmd)
896 unformat_input_t _line_input, * line_input = &_line_input;
897 vnet_main_t * vnm = vnet_get_main();
898 clib_error_t * error = 0;
899 u32 sw_if_index, is_enable;
904 if (! unformat_user (input, unformat_line_input, line_input))
907 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
909 if (unformat_user (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
911 else if (unformat (line_input, "del"))
915 error = unformat_parse_error (line_input);
920 if (~0 == sw_if_index)
922 error = clib_error_return (0, "unknown interface `%U'",
923 format_unformat_error, line_input);
927 vnet_int_vxlan_bypass_mode (sw_if_index, is_ip6, is_enable);
930 unformat_free (line_input);
935 static clib_error_t *
936 set_ip4_vxlan_bypass (vlib_main_t * vm,
937 unformat_input_t * input,
938 vlib_cli_command_t * cmd)
940 return set_ip_vxlan_bypass (0, input, cmd);
944 * This command adds the 'ip4-vxlan-bypass' graph node for a given interface.
945 * By adding the IPv4 vxlan-bypass graph node to an interface, the node checks
946 * for and validate input vxlan packet and bypass ip4-lookup, ip4-local,
947 * ip4-udp-lookup nodes to speedup vxlan packet forwarding. This node will
948 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
952 * Example of graph node before ip4-vxlan-bypass is enabled:
953 * @cliexstart{show vlib graph ip4-vxlan-bypass}
955 * ip4-vxlan-bypass error-drop [0]
960 * Example of how to enable ip4-vxlan-bypass on an interface:
961 * @cliexcmd{set interface ip vxlan-bypass GigabitEthernet2/0/0}
963 * Example of graph node after ip4-vxlan-bypass is enabled:
964 * @cliexstart{show vlib graph ip4-vxlan-bypass}
966 * ip4-vxlan-bypass error-drop [0] ip4-input
967 * vxlan4-input [1] ip4-input-no-checksum
971 * Example of how to display the feature enabed on an interface:
972 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
973 * IP feature paths configured on GigabitEthernet2/0/0...
981 * Example of how to disable ip4-vxlan-bypass on an interface:
982 * @cliexcmd{set interface ip vxlan-bypass GigabitEthernet2/0/0 del}
986 VLIB_CLI_COMMAND (set_interface_ip_vxlan_bypass_command, static) = {
987 .path = "set interface ip vxlan-bypass",
988 .function = set_ip4_vxlan_bypass,
989 .short_help = "set interface ip vxlan-bypass <interface> [del]",
993 static clib_error_t *
994 set_ip6_vxlan_bypass (vlib_main_t * vm,
995 unformat_input_t * input,
996 vlib_cli_command_t * cmd)
998 return set_ip_vxlan_bypass (1, input, cmd);
1002 * This command adds the 'ip6-vxlan-bypass' graph node for a given interface.
1003 * By adding the IPv6 vxlan-bypass graph node to an interface, the node checks
1004 * for and validate input vxlan packet and bypass ip6-lookup, ip6-local,
1005 * ip6-udp-lookup nodes to speedup vxlan packet forwarding. This node will
1006 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
1010 * Example of graph node before ip6-vxlan-bypass is enabled:
1011 * @cliexstart{show vlib graph ip6-vxlan-bypass}
1012 * Name Next Previous
1013 * ip6-vxlan-bypass error-drop [0]
1018 * Example of how to enable ip6-vxlan-bypass on an interface:
1019 * @cliexcmd{set interface ip6 vxlan-bypass GigabitEthernet2/0/0}
1021 * Example of graph node after ip6-vxlan-bypass is enabled:
1022 * @cliexstart{show vlib graph ip6-vxlan-bypass}
1023 * Name Next Previous
1024 * ip6-vxlan-bypass error-drop [0] ip6-input
1025 * vxlan6-input [1] ip4-input-no-checksum
1029 * Example of how to display the feature enabed on an interface:
1030 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1031 * IP feature paths configured on GigabitEthernet2/0/0...
1039 * Example of how to disable ip6-vxlan-bypass on an interface:
1040 * @cliexcmd{set interface ip6 vxlan-bypass GigabitEthernet2/0/0 del}
1044 VLIB_CLI_COMMAND (set_interface_ip6_vxlan_bypass_command, static) = {
1045 .path = "set interface ip6 vxlan-bypass",
1046 .function = set_ip6_vxlan_bypass,
1047 .short_help = "set interface ip vxlan-bypass <interface> [del]",
1051 clib_error_t *vxlan_init (vlib_main_t *vm)
1053 vxlan_main_t * vxm = &vxlan_main;
1055 vxm->vnet_main = vnet_get_main();
1056 vxm->vlib_main = vm;
1058 /* initialize the ip6 hash */
1059 vxm->vxlan6_tunnel_by_key = hash_create_mem(0,
1060 sizeof(vxlan6_tunnel_key_t),
1062 vxm->vtep6 = hash_create_mem(0,
1063 sizeof(ip6_address_t),
1065 vxm->mcast_shared = hash_create_mem(0,
1066 sizeof(ip46_address_t),
1067 sizeof(mcast_shared_t));
1069 udp_register_dst_port (vm, UDP_DST_PORT_vxlan,
1070 vxlan4_input_node.index, /* is_ip4 */ 1);
1071 udp_register_dst_port (vm, UDP_DST_PORT_vxlan6,
1072 vxlan6_input_node.index, /* is_ip4 */ 0);
1074 fib_node_register_type(FIB_NODE_TYPE_VXLAN_TUNNEL, &vxlan_vft);
1079 VLIB_INIT_FUNCTION(vxlan_init);
1083 * eval: (c-set-style "gnu")