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 u8 is_ip4 = ip46_address_is_ip4(&t->dst);
127 dpo_id_t dpo = DPO_INVALID;
128 fib_forward_chain_type_t forw_type = is_ip4 ?
129 FIB_FORW_CHAIN_TYPE_UNICAST_IP4 : FIB_FORW_CHAIN_TYPE_UNICAST_IP6;
131 fib_entry_contribute_forwarding (t->fib_entry_index, forw_type, &dpo);
133 /* vxlan uses the payload hash as the udp source port
134 * hence the packet's hash is unknown
135 * skip single bucket load balance dpo's */
136 while (DPO_LOAD_BALANCE == dpo.dpoi_type)
138 load_balance_t *lb = load_balance_get (dpo.dpoi_index);
139 if (lb->lb_n_buckets > 1)
142 dpo_copy (&dpo, load_balance_get_bucket_i (lb, 0));
145 u32 encap_index = is_ip4 ?
146 vxlan4_encap_node.index : vxlan6_encap_node.index;
147 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
151 static vxlan_tunnel_t *
152 vxlan_tunnel_from_fib_node (fib_node_t *node)
154 ASSERT(FIB_NODE_TYPE_VXLAN_TUNNEL == node->fn_type);
155 return ((vxlan_tunnel_t*) (((char*)node) -
156 STRUCT_OFFSET_OF(vxlan_tunnel_t, node)));
160 * Function definition to backwalk a FIB node -
161 * Here we will restack the new dpo of VXLAN DIP to encap node.
163 static fib_node_back_walk_rc_t
164 vxlan_tunnel_back_walk (fib_node_t *node,
165 fib_node_back_walk_ctx_t *ctx)
167 vxlan_tunnel_restack_dpo(vxlan_tunnel_from_fib_node(node));
168 return (FIB_NODE_BACK_WALK_CONTINUE);
172 * Function definition to get a FIB node from its index
175 vxlan_tunnel_fib_node_get (fib_node_index_t index)
178 vxlan_main_t * vxm = &vxlan_main;
180 t = pool_elt_at_index(vxm->tunnels, index);
186 * Function definition to inform the FIB node that its last lock has gone.
189 vxlan_tunnel_last_lock_gone (fib_node_t *node)
192 * The VXLAN tunnel is a root of the graph. As such
193 * it never has children and thus is never locked.
199 * Virtual function table registered by VXLAN tunnels
200 * for participation in the FIB object graph.
202 const static fib_node_vft_t vxlan_vft = {
203 .fnv_get = vxlan_tunnel_fib_node_get,
204 .fnv_last_lock = vxlan_tunnel_last_lock_gone,
205 .fnv_back_walk = vxlan_tunnel_back_walk,
209 #define foreach_copy_field \
211 _(mcast_sw_if_index) \
213 _(decap_next_index) \
218 vxlan_rewrite (vxlan_tunnel_t * t, bool is_ip6)
221 ip4_vxlan_header_t * h4;
222 ip6_vxlan_header_t * h6;
225 int len = is_ip6 ? sizeof *r.h6 : sizeof *r.h4;
227 vec_validate_aligned (r.rw, len-1, CLIB_CACHE_LINE_BYTES);
230 vxlan_header_t * vxlan;
231 /* Fixed portion of the (outer) ip header */
234 ip4_header_t * ip = &r.h4->ip4;
235 udp = &r.h4->udp, vxlan = &r.h4->vxlan;
236 ip->ip_version_and_header_length = 0x45;
238 ip->protocol = IP_PROTOCOL_UDP;
240 ip->src_address = t->src.ip4;
241 ip->dst_address = t->dst.ip4;
243 /* we fix up the ip4 header length and checksum after-the-fact */
244 ip->checksum = ip4_header_checksum (ip);
248 ip6_header_t * ip = &r.h6->ip6;
249 udp = &r.h6->udp, vxlan = &r.h6->vxlan;
250 ip->ip_version_traffic_class_and_flow_label = clib_host_to_net_u32(6 << 28);
252 ip->protocol = IP_PROTOCOL_UDP;
254 ip->src_address = t->src.ip6;
255 ip->dst_address = t->dst.ip6;
258 /* UDP header, randomize src port on something, maybe? */
259 udp->src_port = clib_host_to_net_u16 (4789);
260 udp->dst_port = clib_host_to_net_u16 (UDP_DST_PORT_vxlan);
263 vnet_set_vni_and_flags(vxlan, t->vni);
269 vxlan_decap_next_is_valid (vxlan_main_t * vxm, u32 is_ip6, u32 decap_next_index)
271 vlib_main_t * vm = vxm->vlib_main;
272 u32 input_idx = (!is_ip6) ? vxlan4_input_node.index : vxlan6_input_node.index;
273 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, input_idx);
275 return decap_next_index < r->n_next_nodes;
279 vtep_addr_ref(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);
286 ip46_address_is_ip4(ip) ?
287 hash_set (vxlan_main.vtep4, ip->ip4.as_u32, 1) :
288 hash_set_mem_alloc (&vxlan_main.vtep6, &ip->ip6, 1);
293 vtep_addr_unref(ip46_address_t *ip)
295 uword *vtep = ip46_address_is_ip4(ip) ?
296 hash_get (vxlan_main.vtep4, ip->ip4.as_u32) :
297 hash_get_mem (vxlan_main.vtep6, &ip->ip6);
301 ip46_address_is_ip4(ip) ?
302 hash_unset (vxlan_main.vtep4, ip->ip4.as_u32) :
303 hash_unset_mem_free (&vxlan_main.vtep6, &ip->ip6);
307 typedef CLIB_PACKED(union {
309 fib_node_index_t mfib_entry_index;
310 adj_index_t mcast_adj_index;
315 static inline mcast_shared_t
316 mcast_shared_get(ip46_address_t * ip)
318 ASSERT(ip46_address_is_multicast(ip));
319 uword * p = hash_get_mem (vxlan_main.mcast_shared, ip);
321 return (mcast_shared_t) { .as_u64 = *p };
325 mcast_shared_add(ip46_address_t *dst,
326 fib_node_index_t mfei,
329 mcast_shared_t new_ep = {
330 .mcast_adj_index = ai,
331 .mfib_entry_index = mfei,
334 hash_set_mem_alloc (&vxlan_main.mcast_shared, dst, new_ep.as_u64);
338 mcast_shared_remove(ip46_address_t *dst)
340 mcast_shared_t ep = mcast_shared_get(dst);
342 adj_unlock(ep.mcast_adj_index);
343 mfib_table_entry_delete_index(ep.mfib_entry_index,
346 hash_unset_mem_free (&vxlan_main.mcast_shared, dst);
349 int vnet_vxlan_add_del_tunnel
350 (vnet_vxlan_add_del_tunnel_args_t *a, u32 * sw_if_indexp)
352 vxlan_main_t * vxm = &vxlan_main;
353 vxlan_tunnel_t *t = 0;
354 vnet_main_t * vnm = vxm->vnet_main;
356 u32 sw_if_index = ~0;
357 vxlan4_tunnel_key_t key4;
358 vxlan6_tunnel_key_t key6;
359 u32 is_ip6 = a->is_ip6;
363 key4.src = a->dst.ip4.as_u32; /* decap src in key is encap dst in config */
364 key4.vni = clib_host_to_net_u32 (a->vni << 8);
365 p = hash_get (vxm->vxlan4_tunnel_by_key, key4.as_u64);
369 key6.src = a->dst.ip6;
370 key6.vni = clib_host_to_net_u32 (a->vni << 8);
371 p = hash_get_mem (vxm->vxlan6_tunnel_by_key, &key6);
376 l2input_main_t * l2im = &l2input_main;
377 u32 dev_instance; /* real dev instance tunnel index */
378 u32 user_instance; /* request and actual instance number */
380 /* adding a tunnel: tunnel must not already exist */
382 return VNET_API_ERROR_TUNNEL_EXIST;
384 /*if not set explicitly, default to l2 */
385 if(a->decap_next_index == ~0)
386 a->decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
387 if (!vxlan_decap_next_is_valid(vxm, is_ip6, a->decap_next_index))
388 return VNET_API_ERROR_INVALID_DECAP_NEXT;
390 pool_get_aligned (vxm->tunnels, t, CLIB_CACHE_LINE_BYTES);
391 *t = (vxlan_tunnel_t){ 0 };
392 dev_instance = t - vxm->tunnels;
394 /* copy from arg structure */
395 #define _(x) t->x = a->x;
399 vxlan_rewrite (t, is_ip6);
401 * Reconcile the real dev_instance and a possible requested instance.
403 user_instance = a->instance;
404 if (user_instance == ~0)
405 user_instance = dev_instance;
406 if (hash_get (vxm->instance_used, user_instance))
408 pool_put (vxm->tunnels, t);
409 return VNET_API_ERROR_INSTANCE_IN_USE;
411 hash_set (vxm->instance_used, user_instance, 1);
413 t->dev_instance = dev_instance; /* actual */
414 t->user_instance = user_instance; /* name */
418 hash_set_mem_alloc (&vxm->vxlan6_tunnel_by_key, &key6, dev_instance);
420 hash_set (vxm->vxlan4_tunnel_by_key, key4.as_u64, dev_instance);
422 t->hw_if_index = vnet_register_interface
423 (vnm, vxlan_device_class.index, dev_instance,
424 vxlan_hw_class.index, dev_instance);
425 vnet_hw_interface_t * hi = vnet_get_hw_interface (vnm, t->hw_if_index);
427 /* Set vxlan tunnel output node */
428 u32 encap_index = !is_ip6 ?
429 vxlan4_encap_node.index : vxlan6_encap_node.index;
430 vnet_set_interface_output_node (vnm, t->hw_if_index, encap_index);
432 t->sw_if_index = sw_if_index = hi->sw_if_index;
434 vec_validate_init_empty (vxm->tunnel_index_by_sw_if_index, sw_if_index, ~0);
435 vxm->tunnel_index_by_sw_if_index[sw_if_index] = dev_instance;
437 /* setup l2 input config with l2 feature and bd 0 to drop packet */
438 vec_validate (l2im->configs, sw_if_index);
439 l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
440 l2im->configs[sw_if_index].bd_index = 0;
442 vnet_sw_interface_t * si = vnet_get_sw_interface (vnm, sw_if_index);
443 si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
444 vnet_sw_interface_set_flags (vnm, sw_if_index,
445 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
447 fib_node_init(&t->node, FIB_NODE_TYPE_VXLAN_TUNNEL);
448 fib_prefix_t tun_dst_pfx;
449 vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
451 fib_prefix_from_ip46_addr(&t->dst, &tun_dst_pfx);
452 if (!ip46_address_is_multicast(&t->dst))
455 * source the FIB entry for the tunnel's destination
456 * and become a child thereof. The tunnel will then get poked
457 * when the forwarding for the entry updates, and the tunnel can
458 * re-stack accordingly
460 vtep_addr_ref(&t->src);
461 t->fib_entry_index = fib_table_entry_special_add
462 (t->encap_fib_index, &tun_dst_pfx, FIB_SOURCE_RR,
463 FIB_ENTRY_FLAG_NONE);
464 t->sibling_index = fib_entry_child_add
465 (t->fib_entry_index, FIB_NODE_TYPE_VXLAN_TUNNEL, dev_instance);
466 vxlan_tunnel_restack_dpo(t);
470 /* Multicast tunnel -
471 * as the same mcast group can be used for mutiple mcast tunnels
472 * with different VNIs, create the output fib adjecency only if
473 * it does not already exist
475 fib_protocol_t fp = fib_ip_proto(is_ip6);
477 if (vtep_addr_ref(&t->dst) == 1)
479 fib_node_index_t mfei;
481 fib_route_path_t path = {
482 .frp_proto = fib_proto_to_dpo(fp),
483 .frp_addr = zero_addr,
484 .frp_sw_if_index = 0xffffffff,
487 .frp_flags = FIB_ROUTE_PATH_LOCAL,
489 const mfib_prefix_t mpfx = {
491 .fp_len = (is_ip6 ? 128 : 32),
492 .fp_grp_addr = tun_dst_pfx.fp_addr,
496 * Setup the (*,G) to receive traffic on the mcast group
497 * - the forwarding interface is for-us
498 * - the accepting interface is that from the API
500 mfib_table_entry_path_update(t->encap_fib_index,
504 MFIB_ITF_FLAG_FORWARD);
506 path.frp_sw_if_index = a->mcast_sw_if_index;
507 path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
508 mfei = mfib_table_entry_path_update(t->encap_fib_index,
512 MFIB_ITF_FLAG_ACCEPT);
515 * Create the mcast adjacency to send traffic to the group
517 ai = adj_mcast_add_or_lock(fp,
518 fib_proto_to_link(fp),
519 a->mcast_sw_if_index);
522 * create a new end-point
524 mcast_shared_add(&t->dst, mfei, ai);
527 dpo_id_t dpo = DPO_INVALID;
528 mcast_shared_t ep = mcast_shared_get(&t->dst);
530 /* Stack shared mcast dst mac addr rewrite on encap */
531 dpo_set (&dpo, DPO_ADJACENCY_MCAST,
532 fib_proto_to_dpo(fp),
535 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
537 flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
540 vnet_get_sw_interface (vnet_get_main(), sw_if_index)->flood_class = flood_class;
544 /* deleting a tunnel: tunnel must exist */
546 return VNET_API_ERROR_NO_SUCH_ENTRY;
549 t = pool_elt_at_index (vxm->tunnels, instance);
551 sw_if_index = t->sw_if_index;
552 vnet_sw_interface_set_flags (vnm, sw_if_index, 0 /* down */);
554 vxm->tunnel_index_by_sw_if_index[sw_if_index] = ~0;
557 hash_unset (vxm->vxlan4_tunnel_by_key, key4.as_u64);
559 hash_unset_mem_free (&vxm->vxlan6_tunnel_by_key, &key6);
561 if (!ip46_address_is_multicast(&t->dst))
563 vtep_addr_unref(&t->src);
564 fib_entry_child_remove(t->fib_entry_index, t->sibling_index);
565 fib_table_entry_delete_index(t->fib_entry_index, FIB_SOURCE_RR);
567 else if (vtep_addr_unref(&t->dst) == 0)
569 mcast_shared_remove(&t->dst);
572 vnet_delete_hw_interface (vnm, t->hw_if_index);
573 hash_unset (vxm->instance_used, t->user_instance);
575 fib_node_deinit(&t->node);
576 vec_free (t->rewrite);
577 pool_put (vxm->tunnels, t);
581 *sw_if_indexp = sw_if_index;
586 static uword get_decap_next_for_node(u32 node_index, u32 ipv4_set)
588 vxlan_main_t * vxm = &vxlan_main;
589 vlib_main_t * vm = vxm->vlib_main;
590 uword input_node = (ipv4_set) ? vxlan4_input_node.index :
591 vxlan6_input_node.index;
593 return vlib_node_add_next (vm, input_node, node_index);
596 static uword unformat_decap_next (unformat_input_t * input, va_list * args)
598 u32 * result = va_arg (*args, u32 *);
599 u32 ipv4_set = va_arg (*args, int);
600 vxlan_main_t * vxm = &vxlan_main;
601 vlib_main_t * vm = vxm->vlib_main;
605 if (unformat (input, "l2"))
606 *result = VXLAN_INPUT_NEXT_L2_INPUT;
607 else if (unformat (input, "node %U", unformat_vlib_node, vm, &node_index))
608 *result = get_decap_next_for_node(node_index, ipv4_set);
609 else if (unformat (input, "%d", &tmp))
616 static clib_error_t *
617 vxlan_add_del_tunnel_command_fn (vlib_main_t * vm,
618 unformat_input_t * input,
619 vlib_cli_command_t * cmd)
621 unformat_input_t _line_input, * line_input = &_line_input;
622 ip46_address_t src = ip46_address_initializer, dst = ip46_address_initializer;
630 u32 encap_fib_index = 0;
631 u32 mcast_sw_if_index = ~0;
632 u32 decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
635 clib_error_t *error = NULL;
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_ip46_address, &src, IP46_TYPE_ANY))
652 ip46_address_is_ip4(&src) ? (ipv4_set = 1) : (ipv6_set = 1);
654 else if (unformat (line_input, "dst %U",
655 unformat_ip46_address, &dst, IP46_TYPE_ANY))
658 ip46_address_is_ip4(&dst) ? (ipv4_set = 1) : (ipv6_set = 1);
660 else if (unformat (line_input, "group %U %U",
661 unformat_ip46_address, &dst, IP46_TYPE_ANY,
662 unformat_vnet_sw_interface,
663 vnet_get_main(), &mcast_sw_if_index))
665 grp_set = dst_set = 1;
666 ip46_address_is_ip4(&dst) ? (ipv4_set = 1) : (ipv6_set = 1);
668 else if (unformat (line_input, "encap-vrf-id %d", &table_id))
670 encap_fib_index = fib_table_find (fib_ip_proto (ipv6_set), table_id);
671 if (encap_fib_index == ~0)
673 error = clib_error_return (0, "nonexistent encap-vrf-id %d", table_id);
677 else if (unformat (line_input, "decap-next %U", unformat_decap_next,
678 &decap_next_index, ipv4_set))
680 else if (unformat (line_input, "vni %d", &vni))
684 error = clib_error_return (0, "parse error: '%U'",
685 format_unformat_error, line_input);
690 unformat_free (line_input);
696 return clib_error_return (0, "tunnel src address not specified");
699 return clib_error_return (0, "tunnel dst address not specified");
701 if (grp_set && !ip46_address_is_multicast(&dst))
702 return clib_error_return (0, "tunnel group address not multicast");
704 if (grp_set == 0 && ip46_address_is_multicast(&dst))
705 return clib_error_return (0, "dst address must be unicast");
707 if (grp_set && mcast_sw_if_index == ~0)
708 return clib_error_return (0, "tunnel nonexistent multicast device");
710 if (ipv4_set && ipv6_set)
711 return clib_error_return (0, "both IPv4 and IPv6 addresses specified");
713 if (ip46_address_cmp(&src, &dst) == 0)
714 return clib_error_return (0, "src and dst addresses are identical");
716 if (decap_next_index == ~0)
717 return clib_error_return (0, "next node not found");
720 return clib_error_return (0, "vni not specified");
723 return clib_error_return (0, "vni %d out of range", vni);
725 vnet_vxlan_add_del_tunnel_args_t a = {
728 .instance = instance,
734 u32 tunnel_sw_if_index;
735 int rv = vnet_vxlan_add_del_tunnel (&a, &tunnel_sw_if_index);
741 vlib_cli_output(vm, "%U\n", format_vnet_sw_if_index_name,
742 vnet_get_main(), tunnel_sw_if_index);
745 case VNET_API_ERROR_TUNNEL_EXIST:
746 return clib_error_return (0, "tunnel already exists...");
748 case VNET_API_ERROR_NO_SUCH_ENTRY:
749 return clib_error_return (0, "tunnel does not exist...");
751 case VNET_API_ERROR_INSTANCE_IN_USE:
752 return clib_error_return (0, "Instance is in use");
755 return clib_error_return
756 (0, "vnet_vxlan_add_del_tunnel returned %d", rv);
763 * Add or delete a VXLAN Tunnel.
765 * VXLAN provides the features needed to allow L2 bridge domains (BDs)
766 * to span multiple servers. This is done by building an L2 overlay on
767 * top of an L3 network underlay using VXLAN tunnels.
769 * This makes it possible for servers to be co-located in the same data
770 * center or be separated geographically as long as they are reachable
771 * through the underlay L3 network.
773 * You can refer to this kind of L2 overlay bridge domain as a VXLAN
774 * (Virtual eXtensible VLAN) segment.
777 * Example of how to create a VXLAN Tunnel:
778 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 encap-vrf-id 7}
779 * Example of how to create a VXLAN Tunnel with a known name, vxlan_tunnel42:
780 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 instance 42}
781 * Example of how to delete a VXLAN Tunnel:
782 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 del}
785 VLIB_CLI_COMMAND (create_vxlan_tunnel_command, static) = {
786 .path = "create vxlan tunnel",
788 "create vxlan tunnel src <local-vtep-addr>"
789 " {dst <remote-vtep-addr>|group <mcast-vtep-addr> <intf-name>} vni <nn>"
791 " [encap-vrf-id <nn>] [decap-next [l2|node <name>]] [del]",
792 .function = vxlan_add_del_tunnel_command_fn,
796 static clib_error_t *
797 show_vxlan_tunnel_command_fn (vlib_main_t * vm,
798 unformat_input_t * input,
799 vlib_cli_command_t * cmd)
801 vxlan_main_t * vxm = &vxlan_main;
804 if (pool_elts (vxm->tunnels) == 0)
805 vlib_cli_output (vm, "No vxlan tunnels configured...");
807 pool_foreach (t, vxm->tunnels,
809 vlib_cli_output (vm, "%U", format_vxlan_tunnel, t);
816 * Display all the VXLAN Tunnel entries.
819 * Example of how to display the VXLAN Tunnel entries:
820 * @cliexstart{show vxlan tunnel}
821 * [0] src 10.0.3.1 dst 10.0.3.3 vni 13 encap_fib_index 0 sw_if_index 5 decap_next l2
825 VLIB_CLI_COMMAND (show_vxlan_tunnel_command, static) = {
826 .path = "show vxlan tunnel",
827 .short_help = "show vxlan tunnel",
828 .function = show_vxlan_tunnel_command_fn,
833 void vnet_int_vxlan_bypass_mode (u32 sw_if_index,
838 vnet_feature_enable_disable ("ip6-unicast", "ip6-vxlan-bypass",
839 sw_if_index, is_enable, 0, 0);
841 vnet_feature_enable_disable ("ip4-unicast", "ip4-vxlan-bypass",
842 sw_if_index, is_enable, 0, 0);
846 static clib_error_t *
847 set_ip_vxlan_bypass (u32 is_ip6,
848 unformat_input_t * input,
849 vlib_cli_command_t * cmd)
851 unformat_input_t _line_input, * line_input = &_line_input;
852 vnet_main_t * vnm = vnet_get_main();
853 clib_error_t * error = 0;
854 u32 sw_if_index, is_enable;
859 if (! unformat_user (input, unformat_line_input, line_input))
862 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
864 if (unformat_user (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
866 else if (unformat (line_input, "del"))
870 error = unformat_parse_error (line_input);
875 if (~0 == sw_if_index)
877 error = clib_error_return (0, "unknown interface `%U'",
878 format_unformat_error, line_input);
882 vnet_int_vxlan_bypass_mode (sw_if_index, is_ip6, is_enable);
885 unformat_free (line_input);
890 static clib_error_t *
891 set_ip4_vxlan_bypass (vlib_main_t * vm,
892 unformat_input_t * input,
893 vlib_cli_command_t * cmd)
895 return set_ip_vxlan_bypass (0, input, cmd);
899 * This command adds the 'ip4-vxlan-bypass' graph node for a given interface.
900 * By adding the IPv4 vxlan-bypass graph node to an interface, the node checks
901 * for and validate input vxlan packet and bypass ip4-lookup, ip4-local,
902 * ip4-udp-lookup nodes to speedup vxlan packet forwarding. This node will
903 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
907 * Example of graph node before ip4-vxlan-bypass is enabled:
908 * @cliexstart{show vlib graph ip4-vxlan-bypass}
910 * ip4-vxlan-bypass error-drop [0]
915 * Example of how to enable ip4-vxlan-bypass on an interface:
916 * @cliexcmd{set interface ip vxlan-bypass GigabitEthernet2/0/0}
918 * Example of graph node after ip4-vxlan-bypass is enabled:
919 * @cliexstart{show vlib graph ip4-vxlan-bypass}
921 * ip4-vxlan-bypass error-drop [0] ip4-input
922 * vxlan4-input [1] ip4-input-no-checksum
926 * Example of how to display the feature enabed on an interface:
927 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
928 * IP feature paths configured on GigabitEthernet2/0/0...
936 * Example of how to disable ip4-vxlan-bypass on an interface:
937 * @cliexcmd{set interface ip vxlan-bypass GigabitEthernet2/0/0 del}
941 VLIB_CLI_COMMAND (set_interface_ip_vxlan_bypass_command, static) = {
942 .path = "set interface ip vxlan-bypass",
943 .function = set_ip4_vxlan_bypass,
944 .short_help = "set interface ip vxlan-bypass <interface> [del]",
948 static clib_error_t *
949 set_ip6_vxlan_bypass (vlib_main_t * vm,
950 unformat_input_t * input,
951 vlib_cli_command_t * cmd)
953 return set_ip_vxlan_bypass (1, input, cmd);
957 * This command adds the 'ip6-vxlan-bypass' graph node for a given interface.
958 * By adding the IPv6 vxlan-bypass graph node to an interface, the node checks
959 * for and validate input vxlan packet and bypass ip6-lookup, ip6-local,
960 * ip6-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 ip6-vxlan-bypass is enabled:
966 * @cliexstart{show vlib graph ip6-vxlan-bypass}
968 * ip6-vxlan-bypass error-drop [0]
973 * Example of how to enable ip6-vxlan-bypass on an interface:
974 * @cliexcmd{set interface ip6 vxlan-bypass GigabitEthernet2/0/0}
976 * Example of graph node after ip6-vxlan-bypass is enabled:
977 * @cliexstart{show vlib graph ip6-vxlan-bypass}
979 * ip6-vxlan-bypass error-drop [0] ip6-input
980 * vxlan6-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 ip6-vxlan-bypass on an interface:
995 * @cliexcmd{set interface ip6 vxlan-bypass GigabitEthernet2/0/0 del}
999 VLIB_CLI_COMMAND (set_interface_ip6_vxlan_bypass_command, static) = {
1000 .path = "set interface ip6 vxlan-bypass",
1001 .function = set_ip6_vxlan_bypass,
1002 .short_help = "set interface ip vxlan-bypass <interface> [del]",
1006 clib_error_t *vxlan_init (vlib_main_t *vm)
1008 vxlan_main_t * vxm = &vxlan_main;
1010 vxm->vnet_main = vnet_get_main();
1011 vxm->vlib_main = vm;
1013 /* initialize the ip6 hash */
1014 vxm->vxlan6_tunnel_by_key = hash_create_mem(0,
1015 sizeof(vxlan6_tunnel_key_t),
1017 vxm->vtep6 = hash_create_mem(0,
1018 sizeof(ip6_address_t),
1020 vxm->mcast_shared = hash_create_mem(0,
1021 sizeof(ip46_address_t),
1022 sizeof(mcast_shared_t));
1024 udp_register_dst_port (vm, UDP_DST_PORT_vxlan,
1025 vxlan4_input_node.index, /* is_ip4 */ 1);
1026 udp_register_dst_port (vm, UDP_DST_PORT_vxlan6,
1027 vxlan6_input_node.index, /* is_ip4 */ 0);
1029 fib_node_register_type(FIB_NODE_TYPE_VXLAN_TUNNEL, &vxlan_vft);
1034 VLIB_INIT_FUNCTION(vxlan_init);
1038 * eval: (c-set-style "gnu")