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/fib/fib_entry_track.h>
20 #include <vnet/mfib/mfib_table.h>
21 #include <vnet/adj/adj_mcast.h>
22 #include <vnet/adj/rewrite.h>
23 #include <vnet/dpo/drop_dpo.h>
24 #include <vnet/interface.h>
25 #include <vnet/flow/flow.h>
26 #include <vnet/udp/udp_local.h>
27 #include <vlib/vlib.h>
33 * VXLAN provides the features needed to allow L2 bridge domains (BDs)
34 * to span multiple servers. This is done by building an L2 overlay on
35 * top of an L3 network underlay using VXLAN tunnels.
37 * This makes it possible for servers to be co-located in the same data
38 * center or be separated geographically as long as they are reachable
39 * through the underlay L3 network.
41 * You can refer to this kind of L2 overlay bridge domain as a VXLAN
42 * (Virtual eXtensible VLAN) segment.
46 vxlan_main_t vxlan_main;
49 vxlan_eth_flag_change (vnet_main_t *vnm, vnet_hw_interface_t *hi, u32 flags)
56 vxlan_eth_set_max_frame_size (vnet_main_t *vnm, vnet_hw_interface_t *hw,
64 format_decap_next (u8 * s, va_list * args)
66 u32 next_index = va_arg (*args, u32);
68 if (next_index == VXLAN_INPUT_NEXT_DROP)
69 return format (s, "drop");
71 return format (s, "index %d", next_index);
76 format_vxlan_tunnel (u8 * s, va_list * args)
78 vxlan_tunnel_t *t = va_arg (*args, vxlan_tunnel_t *);
81 "[%d] instance %d src %U dst %U src_port %d dst_port %d vni %d "
82 "fib-idx %d sw-if-idx %d ",
83 t->dev_instance, t->user_instance, format_ip46_address, &t->src,
84 IP46_TYPE_ANY, format_ip46_address, &t->dst, IP46_TYPE_ANY,
85 t->src_port, t->dst_port, t->vni, t->encap_fib_index,
88 s = format (s, "encap-dpo-idx %d ", t->next_dpo.dpoi_index);
90 if (PREDICT_FALSE (t->decap_next_index != VXLAN_INPUT_NEXT_L2_INPUT))
91 s = format (s, "decap-next-%U ", format_decap_next, t->decap_next_index);
93 if (PREDICT_FALSE (ip46_address_is_multicast (&t->dst)))
94 s = format (s, "mcast-sw-if-idx %d ", t->mcast_sw_if_index);
96 if (t->flow_index != ~0)
97 s = format (s, "flow-index %d [%U]", t->flow_index,
98 format_flow_enabled_hw, t->flow_index);
104 format_vxlan_name (u8 * s, va_list * args)
106 u32 dev_instance = va_arg (*args, u32);
107 vxlan_main_t *vxm = &vxlan_main;
110 if (dev_instance == ~0)
111 return format (s, "<cached-unused>");
113 if (dev_instance >= vec_len (vxm->tunnels))
114 return format (s, "<improperly-referenced>");
116 t = pool_elt_at_index (vxm->tunnels, dev_instance);
118 return format (s, "vxlan_tunnel%d", t->user_instance);
121 static clib_error_t *
122 vxlan_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
124 u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
125 VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
126 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
128 return /* no error */ 0;
132 VNET_DEVICE_CLASS (vxlan_device_class, static) = {
134 .format_device_name = format_vxlan_name,
135 .format_tx_trace = format_vxlan_encap_trace,
136 .admin_up_down_function = vxlan_interface_admin_up_down,
141 format_vxlan_header_with_length (u8 * s, va_list * args)
143 u32 dev_instance = va_arg (*args, u32);
144 s = format (s, "unimplemented dev %u", dev_instance);
149 VNET_HW_INTERFACE_CLASS (vxlan_hw_class) = {
151 .format_header = format_vxlan_header_with_length,
152 .build_rewrite = default_build_rewrite,
157 vxlan_tunnel_restack_dpo (vxlan_tunnel_t * t)
159 u8 is_ip4 = ip46_address_is_ip4 (&t->dst);
160 dpo_id_t dpo = DPO_INVALID;
161 fib_forward_chain_type_t forw_type = is_ip4 ?
162 FIB_FORW_CHAIN_TYPE_UNICAST_IP4 : FIB_FORW_CHAIN_TYPE_UNICAST_IP6;
164 fib_entry_contribute_forwarding (t->fib_entry_index, forw_type, &dpo);
166 /* vxlan uses the payload hash as the udp source port
167 * hence the packet's hash is unknown
168 * skip single bucket load balance dpo's */
169 while (DPO_LOAD_BALANCE == dpo.dpoi_type)
171 const load_balance_t *lb;
172 const dpo_id_t *choice;
174 lb = load_balance_get (dpo.dpoi_index);
175 if (lb->lb_n_buckets > 1)
178 choice = load_balance_get_bucket_i (lb, 0);
180 if (DPO_RECEIVE == choice->dpoi_type)
181 dpo_copy (&dpo, drop_dpo_get (choice->dpoi_proto));
183 dpo_copy (&dpo, choice);
186 u32 encap_index = is_ip4 ?
187 vxlan4_encap_node.index : vxlan6_encap_node.index;
188 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
192 static vxlan_tunnel_t *
193 vxlan_tunnel_from_fib_node (fib_node_t * node)
195 ASSERT (FIB_NODE_TYPE_VXLAN_TUNNEL == node->fn_type);
196 return ((vxlan_tunnel_t *) (((char *) node) -
197 STRUCT_OFFSET_OF (vxlan_tunnel_t, node)));
201 * Function definition to backwalk a FIB node -
202 * Here we will restack the new dpo of VXLAN DIP to encap node.
204 static fib_node_back_walk_rc_t
205 vxlan_tunnel_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
207 vxlan_tunnel_restack_dpo (vxlan_tunnel_from_fib_node (node));
208 return (FIB_NODE_BACK_WALK_CONTINUE);
212 * Function definition to get a FIB node from its index
215 vxlan_tunnel_fib_node_get (fib_node_index_t index)
218 vxlan_main_t *vxm = &vxlan_main;
220 t = pool_elt_at_index (vxm->tunnels, index);
226 * Function definition to inform the FIB node that its last lock has gone.
229 vxlan_tunnel_last_lock_gone (fib_node_t * node)
232 * The VXLAN tunnel is a root of the graph. As such
233 * it never has children and thus is never locked.
239 * Virtual function table registered by VXLAN tunnels
240 * for participation in the FIB object graph.
242 const static fib_node_vft_t vxlan_vft = {
243 .fnv_get = vxlan_tunnel_fib_node_get,
244 .fnv_last_lock = vxlan_tunnel_last_lock_gone,
245 .fnv_back_walk = vxlan_tunnel_back_walk,
248 #define foreach_copy_field \
250 _ (mcast_sw_if_index) \
251 _ (encap_fib_index) \
252 _ (decap_next_index) \
259 vxlan_rewrite (vxlan_tunnel_t * t, bool is_ip6)
263 ip4_vxlan_header_t h4;
264 ip6_vxlan_header_t h6;
266 int len = is_ip6 ? sizeof h.h6 : sizeof h.h4;
269 vxlan_header_t *vxlan;
270 /* Fixed portion of the (outer) ip header */
272 clib_memset (&h, 0, sizeof (h));
275 ip4_header_t *ip = &h.h4.ip4;
276 udp = &h.h4.udp, vxlan = &h.h4.vxlan;
277 ip->ip_version_and_header_length = 0x45;
279 ip->protocol = IP_PROTOCOL_UDP;
281 ip->src_address = t->src.ip4;
282 ip->dst_address = t->dst.ip4;
284 /* we fix up the ip4 header length and checksum after-the-fact */
285 ip->checksum = ip4_header_checksum (ip);
289 ip6_header_t *ip = &h.h6.ip6;
290 udp = &h.h6.udp, vxlan = &h.h6.vxlan;
291 ip->ip_version_traffic_class_and_flow_label =
292 clib_host_to_net_u32 (6 << 28);
294 ip->protocol = IP_PROTOCOL_UDP;
296 ip->src_address = t->src.ip6;
297 ip->dst_address = t->dst.ip6;
300 /* UDP header, randomize src port on something, maybe? */
301 udp->src_port = clib_host_to_net_u16 (t->src_port);
302 udp->dst_port = clib_host_to_net_u16 (t->dst_port);
305 vnet_set_vni_and_flags (vxlan, t->vni);
306 vnet_rewrite_set_data (*t, &h, len);
310 vxlan_decap_next_is_valid (vxlan_main_t * vxm, u32 is_ip6,
311 u32 decap_next_index)
313 vlib_main_t *vm = vxm->vlib_main;
314 u32 input_idx = (!is_ip6) ?
315 vxlan4_input_node.index : vxlan6_input_node.index;
316 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, input_idx);
318 return decap_next_index < r->n_next_nodes;
322 typedef CLIB_PACKED(union
326 fib_node_index_t mfib_entry_index;
327 adj_index_t mcast_adj_index;
333 static inline mcast_shared_t
334 mcast_shared_get (ip46_address_t * ip)
336 ASSERT (ip46_address_is_multicast (ip));
337 uword *p = hash_get_mem (vxlan_main.mcast_shared, ip);
339 mcast_shared_t ret = {.as_u64 = *p };
344 mcast_shared_add (ip46_address_t * dst, fib_node_index_t mfei, adj_index_t ai)
346 mcast_shared_t new_ep = {
347 .mcast_adj_index = ai,
348 .mfib_entry_index = mfei,
351 hash_set_mem_alloc (&vxlan_main.mcast_shared, dst, new_ep.as_u64);
355 mcast_shared_remove (ip46_address_t * dst)
357 mcast_shared_t ep = mcast_shared_get (dst);
359 adj_unlock (ep.mcast_adj_index);
360 mfib_table_entry_delete_index (ep.mfib_entry_index, MFIB_SOURCE_VXLAN);
362 hash_unset_mem_free (&vxlan_main.mcast_shared, dst);
365 int vnet_vxlan_add_del_tunnel
366 (vnet_vxlan_add_del_tunnel_args_t * a, u32 * sw_if_indexp)
368 vxlan_main_t *vxm = &vxlan_main;
369 vnet_main_t *vnm = vxm->vnet_main;
370 vxlan_decap_info_t *p;
371 u32 sw_if_index = ~0;
372 vxlan4_tunnel_key_t key4;
373 vxlan6_tunnel_key_t key6;
374 u32 is_ip6 = a->is_ip6;
375 vlib_main_t *vm = vlib_get_main ();
379 if (a->src_port == 0)
380 a->src_port = is_ip6 ? UDP_DST_PORT_vxlan6 : UDP_DST_PORT_vxlan;
382 if (a->dst_port == 0)
383 a->dst_port = is_ip6 ? UDP_DST_PORT_vxlan6 : UDP_DST_PORT_vxlan;
388 /* ip4 mcast is indexed by mcast addr only */
389 key4.key[0] = ip46_address_is_multicast (&a->dst) ?
391 a->dst.ip4.as_u32 | (((u64) a->src.ip4.as_u32) << 32);
392 key4.key[1] = ((u64) clib_host_to_net_u16 (a->src_port) << 48) |
393 (((u64) a->encap_fib_index) << 32) |
394 clib_host_to_net_u32 (a->vni << 8);
396 clib_bihash_search_inline_16_8 (&vxm->vxlan4_tunnel_by_key, &key4);
397 p = (void *) &key4.value;
401 key6.key[0] = a->dst.ip6.as_u64[0];
402 key6.key[1] = a->dst.ip6.as_u64[1];
403 key6.key[2] = (((u64) clib_host_to_net_u16 (a->src_port) << 48) |
404 ((u64) a->encap_fib_index) << 32) |
405 clib_host_to_net_u32 (a->vni << 8);
407 clib_bihash_search_inline_24_8 (&vxm->vxlan6_tunnel_by_key, &key6);
408 p = (void *) &key6.value;
416 l2input_main_t *l2im = &l2input_main;
417 u32 dev_instance; /* real dev instance tunnel index */
418 u32 user_instance; /* request and actual instance number */
420 /* adding a tunnel: tunnel must not already exist */
422 return VNET_API_ERROR_TUNNEL_EXIST;
424 /*if not set explicitly, default to l2 */
425 if (a->decap_next_index == ~0)
426 a->decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
427 if (!vxlan_decap_next_is_valid (vxm, is_ip6, a->decap_next_index))
428 return VNET_API_ERROR_INVALID_DECAP_NEXT;
431 pool_get_aligned (vxm->tunnels, t, CLIB_CACHE_LINE_BYTES);
432 clib_memset (t, 0, sizeof (*t));
433 dev_instance = t - vxm->tunnels;
435 /* copy from arg structure */
436 #define _(x) t->x = a->x;
440 vxlan_rewrite (t, is_ip6);
442 * Reconcile the real dev_instance and a possible requested instance.
444 user_instance = a->instance;
445 if (user_instance == ~0)
446 user_instance = dev_instance;
447 if (hash_get (vxm->instance_used, user_instance))
449 pool_put (vxm->tunnels, t);
450 return VNET_API_ERROR_INSTANCE_IN_USE;
453 hash_set (vxm->instance_used, user_instance, 1);
455 t->dev_instance = dev_instance; /* actual */
456 t->user_instance = user_instance; /* name */
461 vnet_register_interface (vnm, vxlan_device_class.index, dev_instance,
462 vxlan_hw_class.index, dev_instance);
465 vnet_eth_interface_registration_t eir = {};
466 f64 now = vlib_time_now (vm);
468 rnd = (u32) (now * 1e6);
469 rnd = random_u32 (&rnd);
470 memcpy (hw_addr + 2, &rnd, sizeof (rnd));
474 eir.dev_class_index = vxlan_device_class.index;
475 eir.dev_instance = dev_instance;
476 eir.address = hw_addr;
477 eir.cb.flag_change = vxlan_eth_flag_change;
478 eir.cb.set_max_frame_size = vxlan_eth_set_max_frame_size;
479 t->hw_if_index = vnet_eth_register_interface (vnm, &eir);
482 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, t->hw_if_index);
484 /* Set vxlan tunnel output node */
485 u32 encap_index = !is_ip6 ?
486 vxlan4_encap_node.index : vxlan6_encap_node.index;
487 vnet_set_interface_output_node (vnm, t->hw_if_index, encap_index);
489 t->sw_if_index = sw_if_index = hi->sw_if_index;
495 key6.value = (u64) dev_instance;
496 add_failed = clib_bihash_add_del_24_8 (&vxm->vxlan6_tunnel_by_key,
501 vxlan_decap_info_t di = {.sw_if_index = t->sw_if_index, };
502 if (ip46_address_is_multicast (&t->dst))
503 di.local_ip = t->src.ip4;
505 di.next_index = t->decap_next_index;
506 key4.value = di.as_u64;
507 add_failed = clib_bihash_add_del_16_8 (&vxm->vxlan4_tunnel_by_key,
514 vnet_delete_hw_interface (vnm, t->hw_if_index);
516 ethernet_delete_interface (vnm, t->hw_if_index);
517 hash_unset (vxm->instance_used, t->user_instance);
518 pool_put (vxm->tunnels, t);
519 return VNET_API_ERROR_INVALID_REGISTRATION;
522 vec_validate_init_empty (vxm->tunnel_index_by_sw_if_index, sw_if_index,
524 vxm->tunnel_index_by_sw_if_index[sw_if_index] = dev_instance;
526 /* setup l2 input config with l2 feature and bd 0 to drop packet */
527 vec_validate (l2im->configs, sw_if_index);
528 l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
529 l2im->configs[sw_if_index].bd_index = 0;
531 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
532 si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
533 vnet_sw_interface_set_flags (vnm, sw_if_index,
534 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
536 fib_node_init (&t->node, FIB_NODE_TYPE_VXLAN_TUNNEL);
537 fib_prefix_t tun_dst_pfx;
538 vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
540 fib_protocol_t fp = fib_ip_proto (is_ip6);
541 fib_prefix_from_ip46_addr (fp, &t->dst, &tun_dst_pfx);
542 if (!ip46_address_is_multicast (&t->dst))
545 * source the FIB entry for the tunnel's destination
546 * and become a child thereof. The tunnel will then get poked
547 * when the forwarding for the entry updates, and the tunnel can
548 * re-stack accordingly
550 vtep_addr_ref (&vxm->vtep_table, t->encap_fib_index, &t->src);
551 t->fib_entry_index = fib_entry_track (t->encap_fib_index,
553 FIB_NODE_TYPE_VXLAN_TUNNEL,
556 vxlan_tunnel_restack_dpo (t);
560 /* Multicast tunnel -
561 * as the same mcast group can be used for multiple mcast tunnels
562 * with different VNIs, create the output fib adjacency only if
563 * it does not already exist
565 if (vtep_addr_ref (&vxm->vtep_table,
566 t->encap_fib_index, &t->dst) == 1)
568 fib_node_index_t mfei;
570 fib_route_path_t path = {
571 .frp_proto = fib_proto_to_dpo (fp),
572 .frp_addr = zero_addr,
573 .frp_sw_if_index = 0xffffffff,
576 .frp_flags = FIB_ROUTE_PATH_LOCAL,
577 .frp_mitf_flags = MFIB_ITF_FLAG_FORWARD,
579 const mfib_prefix_t mpfx = {
581 .fp_len = (is_ip6 ? 128 : 32),
582 .fp_grp_addr = tun_dst_pfx.fp_addr,
586 * Setup the (*,G) to receive traffic on the mcast group
587 * - the forwarding interface is for-us
588 * - the accepting interface is that from the API
590 mfib_table_entry_path_update (t->encap_fib_index, &mpfx,
592 MFIB_ENTRY_FLAG_NONE, &path);
594 path.frp_sw_if_index = a->mcast_sw_if_index;
595 path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
596 path.frp_mitf_flags = MFIB_ITF_FLAG_ACCEPT;
597 mfei = mfib_table_entry_path_update (
598 t->encap_fib_index, &mpfx, MFIB_SOURCE_VXLAN,
599 MFIB_ENTRY_FLAG_NONE, &path);
602 * Create the mcast adjacency to send traffic to the group
604 ai = adj_mcast_add_or_lock (fp,
605 fib_proto_to_link (fp),
606 a->mcast_sw_if_index);
609 * create a new end-point
611 mcast_shared_add (&t->dst, mfei, ai);
614 dpo_id_t dpo = DPO_INVALID;
615 mcast_shared_t ep = mcast_shared_get (&t->dst);
617 /* Stack shared mcast dst mac addr rewrite on encap */
618 dpo_set (&dpo, DPO_ADJACENCY_MCAST,
619 fib_proto_to_dpo (fp), ep.mcast_adj_index);
621 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
623 flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
626 vnet_get_sw_interface (vnet_get_main (), sw_if_index)->flood_class =
631 /* deleting a tunnel: tunnel must exist */
633 return VNET_API_ERROR_NO_SUCH_ENTRY;
635 u32 instance = is_ip6 ? key6.value :
636 vxm->tunnel_index_by_sw_if_index[p->sw_if_index];
637 vxlan_tunnel_t *t = pool_elt_at_index (vxm->tunnels, instance);
639 sw_if_index = t->sw_if_index;
640 vnet_sw_interface_set_flags (vnm, sw_if_index, 0 /* down */ );
642 vxm->tunnel_index_by_sw_if_index[sw_if_index] = ~0;
645 clib_bihash_add_del_16_8 (&vxm->vxlan4_tunnel_by_key, &key4,
648 clib_bihash_add_del_24_8 (&vxm->vxlan6_tunnel_by_key, &key6,
651 if (!ip46_address_is_multicast (&t->dst))
653 if (t->flow_index != ~0)
654 vnet_flow_del (vnm, t->flow_index);
656 vtep_addr_unref (&vxm->vtep_table, t->encap_fib_index, &t->src);
657 fib_entry_untrack (t->fib_entry_index, t->sibling_index);
659 else if (vtep_addr_unref (&vxm->vtep_table,
660 t->encap_fib_index, &t->dst) == 0)
662 mcast_shared_remove (&t->dst);
665 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, t->hw_if_index);
666 if (hw->dev_class_index == vxlan_device_class.index)
667 vnet_delete_hw_interface (vnm, t->hw_if_index);
669 ethernet_delete_interface (vnm, t->hw_if_index);
670 hash_unset (vxm->instance_used, t->user_instance);
672 fib_node_deinit (&t->node);
673 pool_put (vxm->tunnels, t);
677 *sw_if_indexp = sw_if_index;
681 /* register udp ports */
682 if (!is_ip6 && !udp_is_valid_dst_port (a->src_port, 1))
683 udp_register_dst_port (vxm->vlib_main, a->src_port,
684 vxlan4_input_node.index, 1);
685 if (is_ip6 && !udp_is_valid_dst_port (a->src_port, 0))
686 udp_register_dst_port (vxm->vlib_main, a->src_port,
687 vxlan6_input_node.index, 0);
694 get_decap_next_for_node (u32 node_index, u32 ipv4_set)
696 vxlan_main_t *vxm = &vxlan_main;
697 vlib_main_t *vm = vxm->vlib_main;
698 uword input_node = (ipv4_set) ? vxlan4_input_node.index :
699 vxlan6_input_node.index;
701 return vlib_node_add_next (vm, input_node, node_index);
705 unformat_decap_next (unformat_input_t * input, va_list * args)
707 u32 *result = va_arg (*args, u32 *);
708 u32 ipv4_set = va_arg (*args, int);
709 vxlan_main_t *vxm = &vxlan_main;
710 vlib_main_t *vm = vxm->vlib_main;
714 if (unformat (input, "l2"))
715 *result = VXLAN_INPUT_NEXT_L2_INPUT;
716 else if (unformat (input, "node %U", unformat_vlib_node, vm, &node_index))
717 *result = get_decap_next_for_node (node_index, ipv4_set);
718 else if (unformat (input, "%d", &tmp))
725 static clib_error_t *
726 vxlan_add_del_tunnel_command_fn (vlib_main_t * vm,
727 unformat_input_t * input,
728 vlib_cli_command_t * cmd)
730 unformat_input_t _line_input, *line_input = &_line_input;
731 ip46_address_t src = ip46_address_initializer, dst =
732 ip46_address_initializer;
741 u32 encap_fib_index = 0;
742 u32 mcast_sw_if_index = ~0;
743 u32 decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
748 clib_error_t *parse_error = NULL;
750 /* Get a line of input. */
751 if (!unformat_user (input, unformat_line_input, line_input))
754 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
756 if (unformat (line_input, "del"))
760 else if (unformat (line_input, "instance %d", &instance))
762 else if (unformat (line_input, "src %U",
763 unformat_ip46_address, &src, IP46_TYPE_ANY))
766 ip46_address_is_ip4 (&src) ? (ipv4_set = 1) : (ipv6_set = 1);
768 else if (unformat (line_input, "dst %U",
769 unformat_ip46_address, &dst, IP46_TYPE_ANY))
772 ip46_address_is_ip4 (&dst) ? (ipv4_set = 1) : (ipv6_set = 1);
774 else if (unformat (line_input, "group %U %U",
775 unformat_ip46_address, &dst, IP46_TYPE_ANY,
776 unformat_vnet_sw_interface,
777 vnet_get_main (), &mcast_sw_if_index))
779 grp_set = dst_set = 1;
780 ip46_address_is_ip4 (&dst) ? (ipv4_set = 1) : (ipv6_set = 1);
782 else if (unformat (line_input, "encap-vrf-id %d", &table_id))
785 fib_table_find (fib_ip_proto (ipv6_set), table_id);
787 else if (unformat (line_input, "l3"))
789 else if (unformat (line_input, "decap-next %U", unformat_decap_next,
790 &decap_next_index, ipv4_set))
792 else if (unformat (line_input, "vni %d", &vni))
794 else if (unformat (line_input, "src_port %d", &src_port))
796 else if (unformat (line_input, "dst_port %d", &dst_port))
800 parse_error = clib_error_return (0, "parse error: '%U'",
801 format_unformat_error, line_input);
806 unformat_free (line_input);
811 if (is_l3 && decap_next_index == VXLAN_INPUT_NEXT_L2_INPUT)
813 vlib_node_t *node = vlib_get_node_by_name (
814 vm, (u8 *) (ipv4_set ? "ip4-input" : "ip6-input"));
815 decap_next_index = get_decap_next_for_node (node->index, ipv4_set);
818 if (encap_fib_index == ~0)
819 return clib_error_return (0, "nonexistent encap-vrf-id %d", table_id);
822 return clib_error_return (0, "tunnel src address not specified");
825 return clib_error_return (0, "tunnel dst address not specified");
827 if (grp_set && !ip46_address_is_multicast (&dst))
828 return clib_error_return (0, "tunnel group address not multicast");
830 if (grp_set == 0 && ip46_address_is_multicast (&dst))
831 return clib_error_return (0, "dst address must be unicast");
833 if (grp_set && mcast_sw_if_index == ~0)
834 return clib_error_return (0, "tunnel nonexistent multicast device");
836 if (ipv4_set && ipv6_set)
837 return clib_error_return (0, "both IPv4 and IPv6 addresses specified");
839 if (ip46_address_cmp (&src, &dst) == 0)
840 return clib_error_return (0, "src and dst addresses are identical");
842 if (decap_next_index == ~0)
843 return clib_error_return (0, "next node not found");
846 return clib_error_return (0, "vni not specified");
849 return clib_error_return (0, "vni %d out of range", vni);
851 vnet_vxlan_add_del_tunnel_args_t a = { .is_add = is_add,
854 .instance = instance,
860 u32 tunnel_sw_if_index;
861 int rv = vnet_vxlan_add_del_tunnel (&a, &tunnel_sw_if_index);
867 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
868 vnet_get_main (), tunnel_sw_if_index);
871 case VNET_API_ERROR_TUNNEL_EXIST:
872 return clib_error_return (0, "tunnel already exists...");
874 case VNET_API_ERROR_NO_SUCH_ENTRY:
875 return clib_error_return (0, "tunnel does not exist...");
877 case VNET_API_ERROR_INSTANCE_IN_USE:
878 return clib_error_return (0, "Instance is in use");
881 return clib_error_return
882 (0, "vnet_vxlan_add_del_tunnel returned %d", rv);
889 * Add or delete a VXLAN Tunnel.
891 * VXLAN provides the features needed to allow L2 bridge domains (BDs)
892 * to span multiple servers. This is done by building an L2 overlay on
893 * top of an L3 network underlay using VXLAN tunnels.
895 * This makes it possible for servers to be co-located in the same data
896 * center or be separated geographically as long as they are reachable
897 * through the underlay L3 network.
899 * You can refer to this kind of L2 overlay bridge domain as a VXLAN
900 * (Virtual eXtensible VLAN) segment.
903 * Example of how to create a VXLAN Tunnel:
904 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 encap-vrf-id
906 * Example of how to create a VXLAN Tunnel with a known name, vxlan_tunnel42:
907 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 instance 42}
908 * Example of how to create a multicast VXLAN Tunnel with a known name,
910 * @cliexcmd{create vxlan tunnel src 10.0.3.1 group 239.1.1.1
911 GigabitEthernet0/8/0 instance 23}
912 * Example of how to create a VXLAN Tunnel with custom udp-ports:
913 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 src_port
914 59000 dst_port 59001}
915 * Example of how to delete a VXLAN Tunnel:
916 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 del}
919 VLIB_CLI_COMMAND (create_vxlan_tunnel_command, static) = {
920 .path = "create vxlan tunnel",
922 "create vxlan tunnel src <local-vtep-addr>"
923 " {dst <remote-vtep-addr>|group <mcast-vtep-addr> <intf-name>} vni <nn>"
925 " [encap-vrf-id <nn>] [decap-next [l2|node <name>]] [del] [l3]"
926 " [src_port <local-vtep-udp-port>] [dst_port <remote-vtep-udp-port>]",
927 .function = vxlan_add_del_tunnel_command_fn,
931 static clib_error_t *
932 show_vxlan_tunnel_command_fn (vlib_main_t * vm,
933 unformat_input_t * input,
934 vlib_cli_command_t * cmd)
936 vxlan_main_t *vxm = &vxlan_main;
940 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
942 if (unformat (input, "raw"))
945 return clib_error_return (0, "parse error: '%U'",
946 format_unformat_error, input);
949 if (pool_elts (vxm->tunnels) == 0)
950 vlib_cli_output (vm, "No vxlan tunnels configured...");
953 pool_foreach (t, vxm->tunnels)
955 vlib_cli_output (vm, "%U", format_vxlan_tunnel, t);
961 vlib_cli_output (vm, "Raw IPv4 Hash Table:\n%U\n",
962 format_bihash_16_8, &vxm->vxlan4_tunnel_by_key,
964 vlib_cli_output (vm, "Raw IPv6 Hash Table:\n%U\n",
965 format_bihash_24_8, &vxm->vxlan6_tunnel_by_key,
973 * Display all the VXLAN Tunnel entries.
976 * Example of how to display the VXLAN Tunnel entries:
977 * @cliexstart{show vxlan tunnel}
978 * [0] src 10.0.3.1 dst 10.0.3.3 src_port 4789 dst_port 4789 vni 13
979 encap_fib_index 0 sw_if_index 5 decap_next l2
983 VLIB_CLI_COMMAND (show_vxlan_tunnel_command, static) = {
984 .path = "show vxlan tunnel",
985 .short_help = "show vxlan tunnel [raw]",
986 .function = show_vxlan_tunnel_command_fn,
992 vnet_int_vxlan_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable)
994 vxlan_main_t *vxm = &vxlan_main;
996 if (pool_is_free_index (vxm->vnet_main->interface_main.sw_interfaces,
1000 is_enable = ! !is_enable;
1004 if (clib_bitmap_get (vxm->bm_ip6_bypass_enabled_by_sw_if, sw_if_index)
1007 vnet_feature_enable_disable ("ip6-unicast", "ip6-vxlan-bypass",
1008 sw_if_index, is_enable, 0, 0);
1009 vxm->bm_ip6_bypass_enabled_by_sw_if =
1010 clib_bitmap_set (vxm->bm_ip6_bypass_enabled_by_sw_if,
1011 sw_if_index, is_enable);
1016 if (clib_bitmap_get (vxm->bm_ip4_bypass_enabled_by_sw_if, sw_if_index)
1019 vnet_feature_enable_disable ("ip4-unicast", "ip4-vxlan-bypass",
1020 sw_if_index, is_enable, 0, 0);
1021 vxm->bm_ip4_bypass_enabled_by_sw_if =
1022 clib_bitmap_set (vxm->bm_ip4_bypass_enabled_by_sw_if,
1023 sw_if_index, is_enable);
1029 static clib_error_t *
1030 set_ip_vxlan_bypass (u32 is_ip6,
1031 unformat_input_t * input, vlib_cli_command_t * cmd)
1033 unformat_input_t _line_input, *line_input = &_line_input;
1034 vnet_main_t *vnm = vnet_get_main ();
1035 clib_error_t *error = 0;
1036 u32 sw_if_index, is_enable;
1041 if (!unformat_user (input, unformat_line_input, line_input))
1044 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1047 (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
1049 else if (unformat (line_input, "del"))
1053 error = unformat_parse_error (line_input);
1058 if (~0 == sw_if_index)
1060 error = clib_error_return (0, "unknown interface `%U'",
1061 format_unformat_error, line_input);
1065 vnet_int_vxlan_bypass_mode (sw_if_index, is_ip6, is_enable);
1068 unformat_free (line_input);
1073 static clib_error_t *
1074 set_ip4_vxlan_bypass (vlib_main_t * vm,
1075 unformat_input_t * input, vlib_cli_command_t * cmd)
1077 return set_ip_vxlan_bypass (0, input, cmd);
1081 * This command adds the 'ip4-vxlan-bypass' graph node for a given interface.
1082 * By adding the IPv4 vxlan-bypass graph node to an interface, the node checks
1083 * for and validate input vxlan packet and bypass ip4-lookup, ip4-local,
1084 * ip4-udp-lookup nodes to speedup vxlan packet forwarding. This node will
1085 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
1089 * Example of graph node before ip4-vxlan-bypass is enabled:
1090 * @cliexstart{show vlib graph ip4-vxlan-bypass}
1091 * Name Next Previous
1092 * ip4-vxlan-bypass error-drop [0]
1097 * Example of how to enable ip4-vxlan-bypass on an interface:
1098 * @cliexcmd{set interface ip vxlan-bypass GigabitEthernet2/0/0}
1100 * Example of graph node after ip4-vxlan-bypass is enabled:
1101 * @cliexstart{show vlib graph ip4-vxlan-bypass}
1102 * Name Next Previous
1103 * ip4-vxlan-bypass error-drop [0] ip4-input
1104 * vxlan4-input [1] ip4-input-no-checksum
1108 * Example of how to display the feature enabled on an interface:
1109 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1110 * IP feature paths configured on GigabitEthernet2/0/0...
1118 * Example of how to disable ip4-vxlan-bypass on an interface:
1119 * @cliexcmd{set interface ip vxlan-bypass GigabitEthernet2/0/0 del}
1123 VLIB_CLI_COMMAND (set_interface_ip_vxlan_bypass_command, static) = {
1124 .path = "set interface ip vxlan-bypass",
1125 .function = set_ip4_vxlan_bypass,
1126 .short_help = "set interface ip vxlan-bypass <interface> [del]",
1130 static clib_error_t *
1131 set_ip6_vxlan_bypass (vlib_main_t * vm,
1132 unformat_input_t * input, vlib_cli_command_t * cmd)
1134 return set_ip_vxlan_bypass (1, input, cmd);
1138 * This command adds the 'ip6-vxlan-bypass' graph node for a given interface.
1139 * By adding the IPv6 vxlan-bypass graph node to an interface, the node checks
1140 * for and validate input vxlan packet and bypass ip6-lookup, ip6-local,
1141 * ip6-udp-lookup nodes to speedup vxlan packet forwarding. This node will
1142 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
1146 * Example of graph node before ip6-vxlan-bypass is enabled:
1147 * @cliexstart{show vlib graph ip6-vxlan-bypass}
1148 * Name Next Previous
1149 * ip6-vxlan-bypass error-drop [0]
1154 * Example of how to enable ip6-vxlan-bypass on an interface:
1155 * @cliexcmd{set interface ip6 vxlan-bypass GigabitEthernet2/0/0}
1157 * Example of graph node after ip6-vxlan-bypass is enabled:
1158 * @cliexstart{show vlib graph ip6-vxlan-bypass}
1159 * Name Next Previous
1160 * ip6-vxlan-bypass error-drop [0] ip6-input
1161 * vxlan6-input [1] ip4-input-no-checksum
1165 * Example of how to display the feature enabled on an interface:
1166 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1167 * IP feature paths configured on GigabitEthernet2/0/0...
1175 * Example of how to disable ip6-vxlan-bypass on an interface:
1176 * @cliexcmd{set interface ip6 vxlan-bypass GigabitEthernet2/0/0 del}
1180 VLIB_CLI_COMMAND (set_interface_ip6_vxlan_bypass_command, static) = {
1181 .path = "set interface ip6 vxlan-bypass",
1182 .function = set_ip6_vxlan_bypass,
1183 .short_help = "set interface ip6 vxlan-bypass <interface> [del]",
1188 vnet_vxlan_add_del_rx_flow (u32 hw_if_index, u32 t_index, int is_add)
1190 vxlan_main_t *vxm = &vxlan_main;
1191 vxlan_tunnel_t *t = pool_elt_at_index (vxm->tunnels, t_index);
1192 vnet_main_t *vnm = vnet_get_main ();
1195 if (t->flow_index == ~0)
1197 vxlan_main_t *vxm = &vxlan_main;
1198 vnet_flow_t flow = {
1200 VNET_FLOW_ACTION_REDIRECT_TO_NODE | VNET_FLOW_ACTION_MARK |
1201 VNET_FLOW_ACTION_BUFFER_ADVANCE,
1202 .mark_flow_id = t->dev_instance + vxm->flow_id_start,
1203 .redirect_node_index = vxlan4_flow_input_node.index,
1204 .buffer_advance = sizeof (ethernet_header_t),
1205 .type = VNET_FLOW_TYPE_IP4_VXLAN,
1207 .protocol.prot = IP_PROTOCOL_UDP,
1208 .src_addr.addr = t->dst.ip4,
1209 .dst_addr.addr = t->src.ip4,
1210 .src_addr.mask.as_u32 = ~0,
1211 .dst_addr.mask.as_u32 = ~0,
1212 .dst_port.port = t->src_port,
1213 .dst_port.mask = 0xFF,
1218 vnet_flow_add (vnm, &flow, &t->flow_index);
1220 return vnet_flow_enable (vnm, t->flow_index, hw_if_index);
1222 /* flow index is removed when the tunnel is deleted */
1223 return vnet_flow_disable (vnm, t->flow_index, hw_if_index);
1227 vnet_vxlan_get_tunnel_index (u32 sw_if_index)
1229 vxlan_main_t *vxm = &vxlan_main;
1231 if (sw_if_index >= vec_len (vxm->tunnel_index_by_sw_if_index))
1233 return vxm->tunnel_index_by_sw_if_index[sw_if_index];
1236 static clib_error_t *
1237 vxlan_offload_command_fn (vlib_main_t * vm,
1238 unformat_input_t * input, vlib_cli_command_t * cmd)
1240 unformat_input_t _line_input, *line_input = &_line_input;
1242 /* Get a line of input. */
1243 if (!unformat_user (input, unformat_line_input, line_input))
1246 vnet_main_t *vnm = vnet_get_main ();
1247 u32 rx_sw_if_index = ~0;
1248 u32 hw_if_index = ~0;
1251 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1253 if (unformat (line_input, "hw %U", unformat_vnet_hw_interface, vnm,
1256 if (unformat (line_input, "rx %U", unformat_vnet_sw_interface, vnm,
1259 if (unformat (line_input, "del"))
1264 return clib_error_return (0, "unknown input `%U'",
1265 format_unformat_error, line_input);
1268 if (rx_sw_if_index == ~0)
1269 return clib_error_return (0, "missing rx interface");
1270 if (hw_if_index == ~0)
1271 return clib_error_return (0, "missing hw interface");
1273 u32 t_index = vnet_vxlan_get_tunnel_index (rx_sw_if_index);;
1275 return clib_error_return (0, "%U is not a vxlan tunnel",
1276 format_vnet_sw_if_index_name, vnm,
1279 vxlan_main_t *vxm = &vxlan_main;
1280 vxlan_tunnel_t *t = pool_elt_at_index (vxm->tunnels, t_index);
1282 if (!ip46_address_is_ip4 (&t->dst))
1283 return clib_error_return (0, "currently only IPV4 tunnels are supported");
1285 vnet_hw_interface_t *hw_if = vnet_get_hw_interface (vnm, hw_if_index);
1286 ip4_main_t *im = &ip4_main;
1288 vec_elt (im->fib_index_by_sw_if_index, hw_if->sw_if_index);
1290 if (t->encap_fib_index != rx_fib_index)
1291 return clib_error_return (0, "interface/tunnel fib mismatch");
1293 if (vnet_vxlan_add_del_rx_flow (hw_if_index, t_index, is_add))
1294 return clib_error_return (0, "error %s flow",
1295 is_add ? "enabling" : "disabling");
1301 VLIB_CLI_COMMAND (vxlan_offload_command, static) = {
1302 .path = "set flow-offload vxlan",
1304 "set flow-offload vxlan hw <interface-name> rx <tunnel-name> [del]",
1305 .function = vxlan_offload_command_fn,
1309 #define VXLAN_HASH_NUM_BUCKETS (2 * 1024)
1310 #define VXLAN_HASH_MEMORY_SIZE (1 << 20)
1313 vxlan_init (vlib_main_t * vm)
1315 vxlan_main_t *vxm = &vxlan_main;
1317 vxm->vnet_main = vnet_get_main ();
1318 vxm->vlib_main = vm;
1320 vnet_flow_get_range (vxm->vnet_main, "vxlan", 1024 * 1024,
1321 &vxm->flow_id_start);
1323 vxm->bm_ip4_bypass_enabled_by_sw_if = 0;
1324 vxm->bm_ip6_bypass_enabled_by_sw_if = 0;
1326 /* initialize the ip6 hash */
1327 clib_bihash_init_16_8 (&vxm->vxlan4_tunnel_by_key, "vxlan4",
1328 VXLAN_HASH_NUM_BUCKETS, VXLAN_HASH_MEMORY_SIZE);
1329 clib_bihash_init_24_8 (&vxm->vxlan6_tunnel_by_key, "vxlan6",
1330 VXLAN_HASH_NUM_BUCKETS, VXLAN_HASH_MEMORY_SIZE);
1331 vxm->vtep_table = vtep_table_create ();
1332 vxm->mcast_shared = hash_create_mem (0,
1333 sizeof (ip46_address_t),
1334 sizeof (mcast_shared_t));
1336 fib_node_register_type (FIB_NODE_TYPE_VXLAN_TUNNEL, &vxlan_vft);
1341 VLIB_INIT_FUNCTION (vxlan_init);
1344 * fd.io coding-style-patch-verification: ON
1347 * eval: (c-set-style "gnu")