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 <vlib/vlib.h>
27 * VXLAN provides the features needed to allow L2 bridge domains (BDs)
28 * to span multiple servers. This is done by building an L2 overlay on
29 * top of an L3 network underlay using VXLAN tunnels.
31 * This makes it possible for servers to be co-located in the same data
32 * center or be separated geographically as long as they are reachable
33 * through the underlay L3 network.
35 * You can refer to this kind of L2 overlay bridge domain as a VXLAN
36 * (Virtual eXtensible VLAN) segment.
40 vxlan_main_t vxlan_main;
42 static u8 * format_decap_next (u8 * s, va_list * args)
44 u32 next_index = va_arg (*args, u32);
48 case VXLAN_INPUT_NEXT_DROP:
49 return format (s, "drop");
50 case VXLAN_INPUT_NEXT_L2_INPUT:
51 return format (s, "l2");
53 return format (s, "index %d", next_index);
58 u8 * format_vxlan_tunnel (u8 * s, va_list * args)
60 vxlan_tunnel_t * t = va_arg (*args, vxlan_tunnel_t *);
61 vxlan_main_t * ngm = &vxlan_main;
63 s = format (s, "[%d] src %U dst %U vni %d sw_if_index %d ",
65 format_ip46_address, &t->src, IP46_TYPE_ANY,
66 format_ip46_address, &t->dst, IP46_TYPE_ANY,
67 t->vni, t->sw_if_index);
69 if (ip46_address_is_multicast (&t->dst))
70 s = format (s, "mcast_sw_if_index %d ", t->mcast_sw_if_index);
72 s = format (s, "encap_fib_index %d fib_entry_index %d decap_next %U\n",
73 t->encap_fib_index, t->fib_entry_index,
74 format_decap_next, t->decap_next_index);
78 static u8 * format_vxlan_name (u8 * s, va_list * args)
80 u32 dev_instance = va_arg (*args, u32);
81 return format (s, "vxlan_tunnel%d", dev_instance);
84 static uword dummy_interface_tx (vlib_main_t * vm,
85 vlib_node_runtime_t * node,
88 clib_warning ("you shouldn't be here, leaking buffers...");
89 return frame->n_vectors;
93 vxlan_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
95 u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
96 VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
97 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
99 return /* no error */ 0;
102 VNET_DEVICE_CLASS (vxlan_device_class,static) = {
104 .format_device_name = format_vxlan_name,
105 .format_tx_trace = format_vxlan_encap_trace,
106 .tx_function = dummy_interface_tx,
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)
141 ASSERT(FIB_NODE_TYPE_VXLAN_TUNNEL == node->fn_type);
143 return ((vxlan_tunnel_t*) (((char*)node) -
144 STRUCT_OFFSET_OF(vxlan_tunnel_t, node)));
148 * Function definition to backwalk a FIB node -
149 * Here we will restack the new dpo of VXLAN DIP to encap node.
151 static fib_node_back_walk_rc_t
152 vxlan_tunnel_back_walk (fib_node_t *node,
153 fib_node_back_walk_ctx_t *ctx)
155 vxlan_tunnel_restack_dpo(vxlan_tunnel_from_fib_node(node));
156 return (FIB_NODE_BACK_WALK_CONTINUE);
160 * Function definition to get a FIB node from its index
163 vxlan_tunnel_fib_node_get (fib_node_index_t index)
166 vxlan_main_t * vxm = &vxlan_main;
168 t = pool_elt_at_index(vxm->tunnels, index);
174 * Function definition to inform the FIB node that its last lock has gone.
177 vxlan_tunnel_last_lock_gone (fib_node_t *node)
180 * The VXLAN tunnel is a root of the graph. As such
181 * it never has children and thus is never locked.
187 * Virtual function table registered by VXLAN tunnels
188 * for participation in the FIB object graph.
190 const static fib_node_vft_t vxlan_vft = {
191 .fnv_get = vxlan_tunnel_fib_node_get,
192 .fnv_last_lock = vxlan_tunnel_last_lock_gone,
193 .fnv_back_walk = vxlan_tunnel_back_walk,
197 #define foreach_copy_field \
199 _(mcast_sw_if_index) \
201 _(decap_next_index) \
206 vxlan_rewrite (vxlan_tunnel_t * t, bool is_ip6)
209 ip4_vxlan_header_t * h4;
210 ip6_vxlan_header_t * h6;
213 int len = is_ip6 ? sizeof *r.h6 : sizeof *r.h4;
215 vec_validate_aligned (r.rw, len-1, CLIB_CACHE_LINE_BYTES);
218 vxlan_header_t * vxlan;
219 /* Fixed portion of the (outer) ip header */
222 ip4_header_t * ip = &r.h4->ip4;
223 udp = &r.h4->udp, vxlan = &r.h4->vxlan;
224 ip->ip_version_and_header_length = 0x45;
226 ip->protocol = IP_PROTOCOL_UDP;
228 ip->src_address = t->src.ip4;
229 ip->dst_address = t->dst.ip4;
231 /* we fix up the ip4 header length and checksum after-the-fact */
232 ip->checksum = ip4_header_checksum (ip);
236 ip6_header_t * ip = &r.h6->ip6;
237 udp = &r.h6->udp, vxlan = &r.h6->vxlan;
238 ip->ip_version_traffic_class_and_flow_label = clib_host_to_net_u32(6 << 28);
240 ip->protocol = IP_PROTOCOL_UDP;
242 ip->src_address = t->src.ip6;
243 ip->dst_address = t->dst.ip6;
246 /* UDP header, randomize src port on something, maybe? */
247 udp->src_port = clib_host_to_net_u16 (4789);
248 udp->dst_port = clib_host_to_net_u16 (UDP_DST_PORT_vxlan);
251 vnet_set_vni_and_flags(vxlan, t->vni);
258 vxlan_decap_next_is_valid (vxlan_main_t * vxm, u32 is_ip6, u32 decap_next_index)
260 vlib_main_t * vm = vxm->vlib_main;
261 u32 input_idx = (!is_ip6) ? vxlan4_input_node.index : vxlan6_input_node.index;
262 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, input_idx);
264 return decap_next_index < r->n_next_nodes;
268 hash_set_key_copy (uword ** h, void * key, uword v) {
269 size_t ksz = hash_header(*h)->user;
270 void * copy = clib_mem_alloc (ksz);
271 clib_memcpy (copy, key, ksz);
272 hash_set_mem (*h, copy, v);
276 hash_unset_key_free (uword ** h, void * key) {
277 hash_pair_t * hp = hash_get_pair_mem (*h, key);
279 key = uword_to_pointer (hp->key, void *);
280 hash_unset_mem (*h, key);
285 vtep_addr_ref(ip46_address_t *ip)
287 uword *vtep = ip46_address_is_ip4(ip) ?
288 hash_get (vxlan_main.vtep4, ip->ip4.as_u32) :
289 hash_get_mem (vxlan_main.vtep6, &ip->ip6);
292 ip46_address_is_ip4(ip) ?
293 hash_set (vxlan_main.vtep4, ip->ip4.as_u32, 1) :
294 hash_set_key_copy (&vxlan_main.vtep6, &ip->ip6, 1);
299 vtep_addr_unref(ip46_address_t *ip)
301 uword *vtep = ip46_address_is_ip4(ip) ?
302 hash_get (vxlan_main.vtep4, ip->ip4.as_u32) :
303 hash_get_mem (vxlan_main.vtep6, &ip->ip6);
307 ip46_address_is_ip4(ip) ?
308 hash_unset (vxlan_main.vtep4, ip->ip4.as_u32) :
309 hash_unset_key_free (&vxlan_main.vtep6, &ip->ip6);
313 typedef CLIB_PACKED(union {
315 fib_node_index_t mfib_entry_index;
316 adj_index_t mcast_adj_index;
321 static inline mcast_shared_t
322 mcast_shared_get(ip46_address_t * ip)
324 ASSERT(ip46_address_is_multicast(ip));
325 uword * p = hash_get_mem (vxlan_main.mcast_shared, ip);
327 return (mcast_shared_t) { .as_u64 = *p };
331 mcast_shared_add(ip46_address_t *dst,
332 fib_node_index_t mfei,
335 mcast_shared_t new_ep = {
336 .mcast_adj_index = ai,
337 .mfib_entry_index = mfei,
340 hash_set_key_copy (&vxlan_main.mcast_shared, dst, new_ep.as_u64);
344 mcast_shared_remove(ip46_address_t *dst)
346 mcast_shared_t ep = mcast_shared_get(dst);
348 adj_unlock(ep.mcast_adj_index);
349 mfib_table_entry_delete_index(ep.mfib_entry_index,
352 hash_unset_key_free (&vxlan_main.mcast_shared, dst);
355 static inline fib_protocol_t
356 fib_ip_proto(bool is_ip6)
358 return (is_ip6) ? FIB_PROTOCOL_IP6 : FIB_PROTOCOL_IP4;
361 int vnet_vxlan_add_del_tunnel
362 (vnet_vxlan_add_del_tunnel_args_t *a, u32 * sw_if_indexp)
364 vxlan_main_t * vxm = &vxlan_main;
365 vxlan_tunnel_t *t = 0;
366 vnet_main_t * vnm = vxm->vnet_main;
368 u32 hw_if_index = ~0;
369 u32 sw_if_index = ~0;
371 vxlan4_tunnel_key_t key4;
372 vxlan6_tunnel_key_t key6;
373 u32 is_ip6 = a->is_ip6;
377 key4.src = a->dst.ip4.as_u32; /* decap src in key is encap dst in config */
378 key4.vni = clib_host_to_net_u32 (a->vni << 8);
379 p = hash_get (vxm->vxlan4_tunnel_by_key, key4.as_u64);
383 key6.src = a->dst.ip6;
384 key6.vni = clib_host_to_net_u32 (a->vni << 8);
385 p = hash_get_mem (vxm->vxlan6_tunnel_by_key, &key6);
390 l2input_main_t * l2im = &l2input_main;
392 /* adding a tunnel: tunnel must not already exist */
394 return VNET_API_ERROR_TUNNEL_EXIST;
396 /*if not set explicitly, default to l2 */
397 if(a->decap_next_index == ~0)
398 a->decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
399 if (!vxlan_decap_next_is_valid(vxm, is_ip6, a->decap_next_index))
400 return VNET_API_ERROR_INVALID_DECAP_NEXT;
402 pool_get_aligned (vxm->tunnels, t, CLIB_CACHE_LINE_BYTES);
403 memset (t, 0, sizeof (*t));
405 /* copy from arg structure */
406 #define _(x) t->x = a->x;
410 rv = vxlan_rewrite (t, is_ip6);
413 pool_put (vxm->tunnels, t);
419 hash_set_key_copy (&vxm->vxlan6_tunnel_by_key, &key6, t - vxm->tunnels);
421 hash_set (vxm->vxlan4_tunnel_by_key, key4.as_u64, t - vxm->tunnels);
423 vnet_hw_interface_t * hi;
424 if (vec_len (vxm->free_vxlan_tunnel_hw_if_indices) > 0)
426 vnet_interface_main_t * im = &vnm->interface_main;
427 hw_if_index = vxm->free_vxlan_tunnel_hw_if_indices
428 [vec_len (vxm->free_vxlan_tunnel_hw_if_indices)-1];
429 _vec_len (vxm->free_vxlan_tunnel_hw_if_indices) -= 1;
431 hi = vnet_get_hw_interface (vnm, hw_if_index);
432 hi->dev_instance = t - vxm->tunnels;
433 hi->hw_instance = hi->dev_instance;
435 /* clear old stats of freed tunnel before reuse */
436 sw_if_index = hi->sw_if_index;
437 vnet_interface_counter_lock(im);
438 vlib_zero_combined_counter
439 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX], sw_if_index);
440 vlib_zero_combined_counter
441 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_RX], sw_if_index);
442 vlib_zero_simple_counter
443 (&im->sw_if_counters[VNET_INTERFACE_COUNTER_DROP], sw_if_index);
444 vnet_interface_counter_unlock(im);
448 hw_if_index = vnet_register_interface
449 (vnm, vxlan_device_class.index, t - vxm->tunnels,
450 vxlan_hw_class.index, t - vxm->tunnels);
451 hi = vnet_get_hw_interface (vnm, hw_if_index);
454 t->hw_if_index = hw_if_index;
455 t->sw_if_index = sw_if_index = hi->sw_if_index;
457 vec_validate_init_empty (vxm->tunnel_index_by_sw_if_index, sw_if_index, ~0);
458 vxm->tunnel_index_by_sw_if_index[sw_if_index] = t - vxm->tunnels;
460 /* setup l2 input config with l2 feature and bd 0 to drop packet */
461 vec_validate (l2im->configs, sw_if_index);
462 l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
463 l2im->configs[sw_if_index].bd_index = 0;
465 vnet_sw_interface_set_flags (vnm, sw_if_index,
466 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
467 fib_node_init(&t->node, FIB_NODE_TYPE_VXLAN_TUNNEL);
468 fib_prefix_t tun_dst_pfx;
469 u32 encap_index = !is_ip6 ?
470 vxlan4_encap_node.index : vxlan6_encap_node.index;
471 vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
473 fib_prefix_from_ip46_addr(&t->dst, &tun_dst_pfx);
474 if (!ip46_address_is_multicast(&t->dst))
477 * source the FIB entry for the tunnel's destination
478 * and become a child thereof. The tunnel will then get poked
479 * when the forwarding for the entry updates, and the tunnel can
480 * re-stack accordingly
482 vtep_addr_ref(&t->src);
483 t->fib_entry_index = fib_table_entry_special_add
484 (t->encap_fib_index, &tun_dst_pfx, FIB_SOURCE_RR,
485 FIB_ENTRY_FLAG_NONE, ADJ_INDEX_INVALID);
486 t->sibling_index = fib_entry_child_add
487 (t->fib_entry_index, FIB_NODE_TYPE_VXLAN_TUNNEL, t - vxm->tunnels);
488 vxlan_tunnel_restack_dpo(t);
492 /* Multicast tunnel -
493 * as the same mcast group can be used for mutiple mcast tunnels
494 * with different VNIs, create the output fib adjecency only if
495 * it does not already exist
497 fib_protocol_t fp = fib_ip_proto(is_ip6);
499 if (vtep_addr_ref(&t->dst) == 1)
501 fib_node_index_t mfei;
503 fib_route_path_t path = {
505 .frp_addr = zero_addr,
506 .frp_sw_if_index = 0xffffffff,
509 .frp_flags = FIB_ROUTE_PATH_LOCAL,
511 const mfib_prefix_t mpfx = {
513 .fp_len = (is_ip6 ? 128 : 32),
514 .fp_grp_addr = tun_dst_pfx.fp_addr,
518 * Setup the (*,G) to receive traffic on the mcast group
519 * - the forwarding interface is for-us
520 * - the accepting interface is that from the API
522 mfib_table_entry_path_update(t->encap_fib_index,
526 MFIB_ITF_FLAG_FORWARD);
528 path.frp_sw_if_index = a->mcast_sw_if_index;
529 path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
530 mfei = mfib_table_entry_path_update(t->encap_fib_index,
534 MFIB_ITF_FLAG_ACCEPT);
537 * Create the mcast adjacency to send traffic to the group
539 ai = adj_mcast_add_or_lock(fp,
540 fib_proto_to_link(fp),
541 a->mcast_sw_if_index);
544 * create a new end-point
546 mcast_shared_add(&t->dst, mfei, ai);
549 dpo_id_t dpo = DPO_INVALID;
550 mcast_shared_t ep = mcast_shared_get(&t->dst);
552 /* Stack shared mcast dst mac addr rewrite on encap */
553 dpo_set (&dpo, DPO_ADJACENCY_MCAST,
554 fib_proto_to_dpo(fp),
557 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
559 flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
562 /* Set vxlan tunnel output node */
563 hi->output_node_index = encap_index;
565 vnet_get_sw_interface (vnet_get_main(), sw_if_index)->flood_class = flood_class;
569 /* deleting a tunnel: tunnel must exist */
571 return VNET_API_ERROR_NO_SUCH_ENTRY;
573 t = pool_elt_at_index (vxm->tunnels, p[0]);
575 vnet_sw_interface_set_flags (vnm, t->sw_if_index, 0 /* down */);
576 /* make sure tunnel is removed from l2 bd or xconnect */
577 set_int_l2_mode(vxm->vlib_main, vnm, MODE_L3, t->sw_if_index, 0, 0, 0, 0);
578 vec_add1 (vxm->free_vxlan_tunnel_hw_if_indices, t->hw_if_index);
580 vxm->tunnel_index_by_sw_if_index[t->sw_if_index] = ~0;
583 hash_unset (vxm->vxlan4_tunnel_by_key, key4.as_u64);
585 hash_unset_key_free (&vxm->vxlan6_tunnel_by_key, &key6);
587 if (!ip46_address_is_multicast(&t->dst))
589 vtep_addr_unref(&t->src);
590 fib_entry_child_remove(t->fib_entry_index, t->sibling_index);
591 fib_table_entry_delete_index(t->fib_entry_index, FIB_SOURCE_RR);
593 else if (vtep_addr_unref(&t->dst) == 0)
595 mcast_shared_remove(&t->dst);
598 fib_node_deinit(&t->node);
599 vec_free (t->rewrite);
600 pool_put (vxm->tunnels, t);
604 *sw_if_indexp = sw_if_index;
609 static uword get_decap_next_for_node(u32 node_index, u32 ipv4_set)
611 vxlan_main_t * vxm = &vxlan_main;
612 vlib_main_t * vm = vxm->vlib_main;
613 uword input_node = (ipv4_set) ? vxlan4_input_node.index :
614 vxlan6_input_node.index;
616 return vlib_node_add_next (vm, input_node, node_index);
619 static uword unformat_decap_next (unformat_input_t * input, va_list * args)
621 u32 * result = va_arg (*args, u32 *);
622 u32 ipv4_set = va_arg (*args, int);
623 vxlan_main_t * vxm = &vxlan_main;
624 vlib_main_t * vm = vxm->vlib_main;
628 if (unformat (input, "l2"))
629 *result = VXLAN_INPUT_NEXT_L2_INPUT;
630 else if (unformat (input, "node %U", unformat_vlib_node, vm, &node_index))
631 *result = get_decap_next_for_node(node_index, ipv4_set);
632 else if (unformat (input, "%d", &tmp))
639 static clib_error_t *
640 vxlan_add_del_tunnel_command_fn (vlib_main_t * vm,
641 unformat_input_t * input,
642 vlib_cli_command_t * cmd)
644 unformat_input_t _line_input, * line_input = &_line_input;
645 ip46_address_t src , dst;
652 u32 encap_fib_index = 0;
653 u32 mcast_sw_if_index = ~0;
654 u32 decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
658 vnet_vxlan_add_del_tunnel_args_t _a, * a = &_a;
659 u32 tunnel_sw_if_index;
660 clib_error_t *error = NULL;
662 /* Cant "universally zero init" (={0}) due to GCC bug 53119 */
663 memset(&src, 0, sizeof src);
664 memset(&dst, 0, sizeof dst);
666 /* Get a line of input. */
667 if (! unformat_user (input, unformat_line_input, line_input))
670 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) {
671 if (unformat (line_input, "del"))
675 else if (unformat (line_input, "src %U",
676 unformat_ip4_address, &src.ip4))
681 else if (unformat (line_input, "dst %U",
682 unformat_ip4_address, &dst.ip4))
687 else if (unformat (line_input, "src %U",
688 unformat_ip6_address, &src.ip6))
693 else if (unformat (line_input, "dst %U",
694 unformat_ip6_address, &dst.ip6))
699 else if (unformat (line_input, "group %U %U",
700 unformat_ip4_address, &dst.ip4,
701 unformat_vnet_sw_interface,
702 vnet_get_main(), &mcast_sw_if_index))
704 grp_set = dst_set = 1;
707 else if (unformat (line_input, "group %U %U",
708 unformat_ip6_address, &dst.ip6,
709 unformat_vnet_sw_interface,
710 vnet_get_main(), &mcast_sw_if_index))
712 grp_set = dst_set = 1;
715 else if (unformat (line_input, "encap-vrf-id %d", &tmp))
717 encap_fib_index = fib_table_find (fib_ip_proto (ipv6_set), tmp);
718 if (encap_fib_index == ~0)
720 error = clib_error_return (0, "nonexistent encap-vrf-id %d", tmp);
724 else if (unformat (line_input, "decap-next %U", unformat_decap_next,
725 &decap_next_index, ipv4_set))
727 else if (unformat (line_input, "vni %d", &vni))
731 error = clib_error_return (0, "vni %d out of range", vni);
737 error = clib_error_return (0, "parse error: '%U'",
738 format_unformat_error, line_input);
745 error = clib_error_return (0, "tunnel src address not specified");
751 error = clib_error_return (0, "tunnel dst address not specified");
755 if (grp_set && !ip46_address_is_multicast(&dst))
757 error = clib_error_return (0, "tunnel group address not multicast");
761 if (grp_set == 0 && ip46_address_is_multicast(&dst))
763 error = clib_error_return (0, "dst address must be unicast");
767 if (grp_set && mcast_sw_if_index == ~0)
769 error = clib_error_return (0, "tunnel nonexistent multicast device");
773 if (ipv4_set && ipv6_set)
775 error = clib_error_return (0, "both IPv4 and IPv6 addresses specified");
779 if (ip46_address_cmp(&src, &dst) == 0)
781 error = clib_error_return (0, "src and dst addresses are identical");
785 if (decap_next_index == ~0)
787 error = clib_error_return (0, "next node not found");
793 error = clib_error_return (0, "vni not specified");
797 memset (a, 0, sizeof (*a));
800 a->is_ip6 = ipv6_set;
802 #define _(x) a->x = x;
806 rv = vnet_vxlan_add_del_tunnel (a, &tunnel_sw_if_index);
812 vlib_cli_output(vm, "%U\n", format_vnet_sw_if_index_name,
813 vnet_get_main(), tunnel_sw_if_index);
816 case VNET_API_ERROR_TUNNEL_EXIST:
817 error = clib_error_return (0, "tunnel already exists...");
820 case VNET_API_ERROR_NO_SUCH_ENTRY:
821 error = clib_error_return (0, "tunnel does not exist...");
825 error = clib_error_return
826 (0, "vnet_vxlan_add_del_tunnel returned %d", rv);
831 unformat_free (line_input);
837 * Add or delete a VXLAN Tunnel.
839 * VXLAN provides the features needed to allow L2 bridge domains (BDs)
840 * to span multiple servers. This is done by building an L2 overlay on
841 * top of an L3 network underlay using VXLAN tunnels.
843 * This makes it possible for servers to be co-located in the same data
844 * center or be separated geographically as long as they are reachable
845 * through the underlay L3 network.
847 * You can refer to this kind of L2 overlay bridge domain as a VXLAN
848 * (Virtual eXtensible VLAN) segment.
851 * Example of how to create a VXLAN Tunnel:
852 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 encap-vrf-id 7}
853 * Example of how to delete a VXLAN Tunnel:
854 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 del}
857 VLIB_CLI_COMMAND (create_vxlan_tunnel_command, static) = {
858 .path = "create vxlan tunnel",
860 "create vxlan tunnel src <local-vtep-addr>"
861 " {dst <remote-vtep-addr>|group <mcast-vtep-addr> <intf-name>} vni <nn>"
862 " [encap-vrf-id <nn>] [decap-next [l2|node <name>]] [del]",
863 .function = vxlan_add_del_tunnel_command_fn,
867 static clib_error_t *
868 show_vxlan_tunnel_command_fn (vlib_main_t * vm,
869 unformat_input_t * input,
870 vlib_cli_command_t * cmd)
872 vxlan_main_t * vxm = &vxlan_main;
875 if (pool_elts (vxm->tunnels) == 0)
876 vlib_cli_output (vm, "No vxlan tunnels configured...");
878 pool_foreach (t, vxm->tunnels,
880 vlib_cli_output (vm, "%U", format_vxlan_tunnel, t);
887 * Display all the VXLAN Tunnel entries.
890 * Example of how to display the VXLAN Tunnel entries:
891 * @cliexstart{show vxlan tunnel}
892 * [0] src 10.0.3.1 dst 10.0.3.3 vni 13 encap_fib_index 0 sw_if_index 5 decap_next l2
896 VLIB_CLI_COMMAND (show_vxlan_tunnel_command, static) = {
897 .path = "show vxlan tunnel",
898 .short_help = "show vxlan tunnel",
899 .function = show_vxlan_tunnel_command_fn,
904 void vnet_int_vxlan_bypass_mode (u32 sw_if_index,
909 vnet_feature_enable_disable ("ip6-unicast", "ip6-vxlan-bypass",
910 sw_if_index, is_enable, 0, 0);
912 vnet_feature_enable_disable ("ip4-unicast", "ip4-vxlan-bypass",
913 sw_if_index, is_enable, 0, 0);
917 static clib_error_t *
918 set_ip_vxlan_bypass (u32 is_ip6,
919 unformat_input_t * input,
920 vlib_cli_command_t * cmd)
922 unformat_input_t _line_input, * line_input = &_line_input;
923 vnet_main_t * vnm = vnet_get_main();
924 clib_error_t * error = 0;
925 u32 sw_if_index, is_enable;
930 if (! unformat_user (input, unformat_line_input, line_input))
933 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
935 if (unformat_user (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
937 else if (unformat (line_input, "del"))
941 error = unformat_parse_error (line_input);
946 if (~0 == sw_if_index)
948 error = clib_error_return (0, "unknown interface `%U'",
949 format_unformat_error, line_input);
953 vnet_int_vxlan_bypass_mode (sw_if_index, is_ip6, is_enable);
956 unformat_free (line_input);
961 static clib_error_t *
962 set_ip4_vxlan_bypass (vlib_main_t * vm,
963 unformat_input_t * input,
964 vlib_cli_command_t * cmd)
966 return set_ip_vxlan_bypass (0, input, cmd);
970 * This command adds the 'ip4-vxlan-bypass' graph node for a given interface.
971 * By adding the IPv4 vxlan-bypass graph node to an interface, the node checks
972 * for and validate input vxlan packet and bypass ip4-lookup, ip4-local,
973 * ip4-udp-lookup nodes to speedup vxlan packet forwarding. This node will
974 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
978 * Example of graph node before ip4-vxlan-bypass is enabled:
979 * @cliexstart{show vlib graph ip4-vxlan-bypass}
981 * ip4-vxlan-bypass error-drop [0]
986 * Example of how to enable ip4-vxlan-bypass on an interface:
987 * @cliexcmd{set interface ip vxlan-bypass GigabitEthernet2/0/0}
989 * Example of graph node after ip4-vxlan-bypass is enabled:
990 * @cliexstart{show vlib graph ip4-vxlan-bypass}
992 * ip4-vxlan-bypass error-drop [0] ip4-input
993 * vxlan4-input [1] ip4-input-no-checksum
997 * Example of how to display the feature enabed on an interface:
998 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
999 * IP feature paths configured on GigabitEthernet2/0/0...
1007 * Example of how to disable ip4-vxlan-bypass on an interface:
1008 * @cliexcmd{set interface ip vxlan-bypass GigabitEthernet2/0/0 del}
1012 VLIB_CLI_COMMAND (set_interface_ip_vxlan_bypass_command, static) = {
1013 .path = "set interface ip vxlan-bypass",
1014 .function = set_ip4_vxlan_bypass,
1015 .short_help = "set interface ip vxlan-bypass <interface> [del]",
1019 static clib_error_t *
1020 set_ip6_vxlan_bypass (vlib_main_t * vm,
1021 unformat_input_t * input,
1022 vlib_cli_command_t * cmd)
1024 return set_ip_vxlan_bypass (1, input, cmd);
1028 * This command adds the 'ip6-vxlan-bypass' graph node for a given interface.
1029 * By adding the IPv6 vxlan-bypass graph node to an interface, the node checks
1030 * for and validate input vxlan packet and bypass ip6-lookup, ip6-local,
1031 * ip6-udp-lookup nodes to speedup vxlan packet forwarding. This node will
1032 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
1036 * Example of graph node before ip6-vxlan-bypass is enabled:
1037 * @cliexstart{show vlib graph ip6-vxlan-bypass}
1038 * Name Next Previous
1039 * ip6-vxlan-bypass error-drop [0]
1044 * Example of how to enable ip6-vxlan-bypass on an interface:
1045 * @cliexcmd{set interface ip6 vxlan-bypass GigabitEthernet2/0/0}
1047 * Example of graph node after ip6-vxlan-bypass is enabled:
1048 * @cliexstart{show vlib graph ip6-vxlan-bypass}
1049 * Name Next Previous
1050 * ip6-vxlan-bypass error-drop [0] ip6-input
1051 * vxlan6-input [1] ip4-input-no-checksum
1055 * Example of how to display the feature enabed on an interface:
1056 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1057 * IP feature paths configured on GigabitEthernet2/0/0...
1065 * Example of how to disable ip6-vxlan-bypass on an interface:
1066 * @cliexcmd{set interface ip6 vxlan-bypass GigabitEthernet2/0/0 del}
1070 VLIB_CLI_COMMAND (set_interface_ip6_vxlan_bypass_command, static) = {
1071 .path = "set interface ip6 vxlan-bypass",
1072 .function = set_ip6_vxlan_bypass,
1073 .short_help = "set interface ip vxlan-bypass <interface> [del]",
1077 clib_error_t *vxlan_init (vlib_main_t *vm)
1079 vxlan_main_t * vxm = &vxlan_main;
1081 vxm->vnet_main = vnet_get_main();
1082 vxm->vlib_main = vm;
1084 /* initialize the ip6 hash */
1085 vxm->vxlan6_tunnel_by_key = hash_create_mem(0,
1086 sizeof(vxlan6_tunnel_key_t),
1088 vxm->vtep6 = hash_create_mem(0,
1089 sizeof(ip6_address_t),
1091 vxm->mcast_shared = hash_create_mem(0,
1092 sizeof(ip46_address_t),
1093 sizeof(mcast_shared_t));
1095 udp_register_dst_port (vm, UDP_DST_PORT_vxlan,
1096 vxlan4_input_node.index, /* is_ip4 */ 1);
1097 udp_register_dst_port (vm, UDP_DST_PORT_vxlan6,
1098 vxlan6_input_node.index, /* is_ip4 */ 0);
1100 fib_node_register_type(FIB_NODE_TYPE_VXLAN_TUNNEL, &vxlan_vft);
1105 VLIB_INIT_FUNCTION(vxlan_init);