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 <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;
131 VNET_DEVICE_CLASS (vxlan_device_class, static) = {
133 .format_device_name = format_vxlan_name,
134 .format_tx_trace = format_vxlan_encap_trace,
135 .admin_up_down_function = vxlan_interface_admin_up_down,
139 format_vxlan_header_with_length (u8 * s, va_list * args)
141 u32 dev_instance = va_arg (*args, u32);
142 s = format (s, "unimplemented dev %u", dev_instance);
146 VNET_HW_INTERFACE_CLASS (vxlan_hw_class) = {
148 .format_header = format_vxlan_header_with_length,
149 .build_rewrite = default_build_rewrite,
153 vxlan_tunnel_restack_dpo (vxlan_tunnel_t * t)
155 u8 is_ip4 = ip46_address_is_ip4 (&t->dst);
156 dpo_id_t dpo = DPO_INVALID;
157 fib_forward_chain_type_t forw_type = is_ip4 ?
158 FIB_FORW_CHAIN_TYPE_UNICAST_IP4 : FIB_FORW_CHAIN_TYPE_UNICAST_IP6;
160 fib_entry_contribute_forwarding (t->fib_entry_index, forw_type, &dpo);
162 /* vxlan uses the payload hash as the udp source port
163 * hence the packet's hash is unknown
164 * skip single bucket load balance dpo's */
165 while (DPO_LOAD_BALANCE == dpo.dpoi_type)
167 const load_balance_t *lb;
168 const dpo_id_t *choice;
170 lb = load_balance_get (dpo.dpoi_index);
171 if (lb->lb_n_buckets > 1)
174 choice = load_balance_get_bucket_i (lb, 0);
176 if (DPO_RECEIVE == choice->dpoi_type)
177 dpo_copy (&dpo, drop_dpo_get (choice->dpoi_proto));
179 dpo_copy (&dpo, choice);
182 u32 encap_index = is_ip4 ?
183 vxlan4_encap_node.index : vxlan6_encap_node.index;
184 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
188 static vxlan_tunnel_t *
189 vxlan_tunnel_from_fib_node (fib_node_t * node)
191 ASSERT (FIB_NODE_TYPE_VXLAN_TUNNEL == node->fn_type);
192 return ((vxlan_tunnel_t *) (((char *) node) -
193 STRUCT_OFFSET_OF (vxlan_tunnel_t, node)));
197 * Function definition to backwalk a FIB node -
198 * Here we will restack the new dpo of VXLAN DIP to encap node.
200 static fib_node_back_walk_rc_t
201 vxlan_tunnel_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
203 vxlan_tunnel_restack_dpo (vxlan_tunnel_from_fib_node (node));
204 return (FIB_NODE_BACK_WALK_CONTINUE);
208 * Function definition to get a FIB node from its index
211 vxlan_tunnel_fib_node_get (fib_node_index_t index)
214 vxlan_main_t *vxm = &vxlan_main;
216 t = pool_elt_at_index (vxm->tunnels, index);
222 * Function definition to inform the FIB node that its last lock has gone.
225 vxlan_tunnel_last_lock_gone (fib_node_t * node)
228 * The VXLAN tunnel is a root of the graph. As such
229 * it never has children and thus is never locked.
235 * Virtual function table registered by VXLAN tunnels
236 * for participation in the FIB object graph.
238 const static fib_node_vft_t vxlan_vft = {
239 .fnv_get = vxlan_tunnel_fib_node_get,
240 .fnv_last_lock = vxlan_tunnel_last_lock_gone,
241 .fnv_back_walk = vxlan_tunnel_back_walk,
244 #define foreach_copy_field \
246 _ (mcast_sw_if_index) \
247 _ (encap_fib_index) \
248 _ (decap_next_index) \
255 vxlan_rewrite (vxlan_tunnel_t * t, bool is_ip6)
259 ip4_vxlan_header_t h4;
260 ip6_vxlan_header_t h6;
262 int len = is_ip6 ? sizeof h.h6 : sizeof h.h4;
265 vxlan_header_t *vxlan;
266 /* Fixed portion of the (outer) ip header */
268 clib_memset (&h, 0, sizeof (h));
271 ip4_header_t *ip = &h.h4.ip4;
272 udp = &h.h4.udp, vxlan = &h.h4.vxlan;
273 ip->ip_version_and_header_length = 0x45;
275 ip->protocol = IP_PROTOCOL_UDP;
277 ip->src_address = t->src.ip4;
278 ip->dst_address = t->dst.ip4;
280 /* we fix up the ip4 header length and checksum after-the-fact */
281 ip->checksum = ip4_header_checksum (ip);
285 ip6_header_t *ip = &h.h6.ip6;
286 udp = &h.h6.udp, vxlan = &h.h6.vxlan;
287 ip->ip_version_traffic_class_and_flow_label =
288 clib_host_to_net_u32 (6 << 28);
290 ip->protocol = IP_PROTOCOL_UDP;
292 ip->src_address = t->src.ip6;
293 ip->dst_address = t->dst.ip6;
296 /* UDP header, randomize src port on something, maybe? */
297 udp->src_port = clib_host_to_net_u16 (t->src_port);
298 udp->dst_port = clib_host_to_net_u16 (t->dst_port);
301 vnet_set_vni_and_flags (vxlan, t->vni);
302 vnet_rewrite_set_data (*t, &h, len);
306 vxlan_decap_next_is_valid (vxlan_main_t * vxm, u32 is_ip6,
307 u32 decap_next_index)
309 vlib_main_t *vm = vxm->vlib_main;
310 u32 input_idx = (!is_ip6) ?
311 vxlan4_input_node.index : vxlan6_input_node.index;
312 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, input_idx);
314 return decap_next_index < r->n_next_nodes;
317 typedef CLIB_PACKED(union
321 fib_node_index_t mfib_entry_index;
322 adj_index_t mcast_adj_index;
327 static inline mcast_shared_t
328 mcast_shared_get (ip46_address_t * ip)
330 ASSERT (ip46_address_is_multicast (ip));
331 uword *p = hash_get_mem (vxlan_main.mcast_shared, ip);
333 mcast_shared_t ret = {.as_u64 = *p };
338 mcast_shared_add (ip46_address_t * dst, fib_node_index_t mfei, adj_index_t ai)
340 mcast_shared_t new_ep = {
341 .mcast_adj_index = ai,
342 .mfib_entry_index = mfei,
345 hash_set_mem_alloc (&vxlan_main.mcast_shared, dst, new_ep.as_u64);
349 mcast_shared_remove (ip46_address_t * dst)
351 mcast_shared_t ep = mcast_shared_get (dst);
353 adj_unlock (ep.mcast_adj_index);
354 mfib_table_entry_delete_index (ep.mfib_entry_index, MFIB_SOURCE_VXLAN);
356 hash_unset_mem_free (&vxlan_main.mcast_shared, dst);
359 int vnet_vxlan_add_del_tunnel
360 (vnet_vxlan_add_del_tunnel_args_t * a, u32 * sw_if_indexp)
362 vxlan_main_t *vxm = &vxlan_main;
363 vnet_main_t *vnm = vxm->vnet_main;
364 vxlan_decap_info_t *p;
365 u32 sw_if_index = ~0;
366 vxlan4_tunnel_key_t key4;
367 vxlan6_tunnel_key_t key6;
368 u32 is_ip6 = a->is_ip6;
369 vlib_main_t *vm = vlib_get_main ();
373 if (a->src_port == 0)
374 a->src_port = is_ip6 ? UDP_DST_PORT_vxlan6 : UDP_DST_PORT_vxlan;
376 if (a->dst_port == 0)
377 a->dst_port = is_ip6 ? UDP_DST_PORT_vxlan6 : UDP_DST_PORT_vxlan;
382 /* ip4 mcast is indexed by mcast addr only */
383 key4.key[0] = ip46_address_is_multicast (&a->dst) ?
385 a->dst.ip4.as_u32 | (((u64) a->src.ip4.as_u32) << 32);
386 key4.key[1] = ((u64) clib_host_to_net_u16 (a->src_port) << 48) |
387 (((u64) a->encap_fib_index) << 32) |
388 clib_host_to_net_u32 (a->vni << 8);
390 clib_bihash_search_inline_16_8 (&vxm->vxlan4_tunnel_by_key, &key4);
391 p = (void *) &key4.value;
395 key6.key[0] = a->dst.ip6.as_u64[0];
396 key6.key[1] = a->dst.ip6.as_u64[1];
397 key6.key[2] = (((u64) clib_host_to_net_u16 (a->src_port) << 48) |
398 ((u64) a->encap_fib_index) << 32) |
399 clib_host_to_net_u32 (a->vni << 8);
401 clib_bihash_search_inline_24_8 (&vxm->vxlan6_tunnel_by_key, &key6);
402 p = (void *) &key6.value;
410 l2input_main_t *l2im = &l2input_main;
411 u32 dev_instance; /* real dev instance tunnel index */
412 u32 user_instance; /* request and actual instance number */
414 /* adding a tunnel: tunnel must not already exist */
416 return VNET_API_ERROR_TUNNEL_EXIST;
418 /*if not set explicitly, default to l2 */
419 if (a->decap_next_index == ~0)
420 a->decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
421 if (!vxlan_decap_next_is_valid (vxm, is_ip6, a->decap_next_index))
422 return VNET_API_ERROR_INVALID_DECAP_NEXT;
425 pool_get_aligned (vxm->tunnels, t, CLIB_CACHE_LINE_BYTES);
426 clib_memset (t, 0, sizeof (*t));
427 dev_instance = t - vxm->tunnels;
429 /* copy from arg structure */
430 #define _(x) t->x = a->x;
434 vxlan_rewrite (t, is_ip6);
436 * Reconcile the real dev_instance and a possible requested instance.
438 user_instance = a->instance;
439 if (user_instance == ~0)
440 user_instance = dev_instance;
441 if (hash_get (vxm->instance_used, user_instance))
443 pool_put (vxm->tunnels, t);
444 return VNET_API_ERROR_INSTANCE_IN_USE;
447 hash_set (vxm->instance_used, user_instance, 1);
449 t->dev_instance = dev_instance; /* actual */
450 t->user_instance = user_instance; /* name */
455 vnet_register_interface (vnm, vxlan_device_class.index, dev_instance,
456 vxlan_hw_class.index, dev_instance);
459 vnet_eth_interface_registration_t eir = {};
460 f64 now = vlib_time_now (vm);
462 rnd = (u32) (now * 1e6);
463 rnd = random_u32 (&rnd);
464 memcpy (hw_addr + 2, &rnd, sizeof (rnd));
468 eir.dev_class_index = vxlan_device_class.index;
469 eir.dev_instance = dev_instance;
470 eir.address = hw_addr;
471 eir.cb.flag_change = vxlan_eth_flag_change;
472 eir.cb.set_max_frame_size = vxlan_eth_set_max_frame_size;
473 t->hw_if_index = vnet_eth_register_interface (vnm, &eir);
476 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, t->hw_if_index);
478 /* Set vxlan tunnel output node */
479 u32 encap_index = !is_ip6 ?
480 vxlan4_encap_node.index : vxlan6_encap_node.index;
481 vnet_set_interface_output_node (vnm, t->hw_if_index, encap_index);
483 t->sw_if_index = sw_if_index = hi->sw_if_index;
489 key6.value = (u64) dev_instance;
490 add_failed = clib_bihash_add_del_24_8 (&vxm->vxlan6_tunnel_by_key,
495 vxlan_decap_info_t di = {.sw_if_index = t->sw_if_index, };
496 if (ip46_address_is_multicast (&t->dst))
497 di.local_ip = t->src.ip4;
499 di.next_index = t->decap_next_index;
500 key4.value = di.as_u64;
501 add_failed = clib_bihash_add_del_16_8 (&vxm->vxlan4_tunnel_by_key,
508 vnet_delete_hw_interface (vnm, t->hw_if_index);
510 ethernet_delete_interface (vnm, t->hw_if_index);
511 hash_unset (vxm->instance_used, t->user_instance);
512 pool_put (vxm->tunnels, t);
513 return VNET_API_ERROR_INVALID_REGISTRATION;
516 vec_validate_init_empty (vxm->tunnel_index_by_sw_if_index, sw_if_index,
518 vxm->tunnel_index_by_sw_if_index[sw_if_index] = dev_instance;
520 /* setup l2 input config with l2 feature and bd 0 to drop packet */
521 vec_validate (l2im->configs, sw_if_index);
522 l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
523 l2im->configs[sw_if_index].bd_index = 0;
525 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
526 si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
527 vnet_sw_interface_set_flags (vnm, sw_if_index,
528 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
530 fib_node_init (&t->node, FIB_NODE_TYPE_VXLAN_TUNNEL);
531 fib_prefix_t tun_dst_pfx;
532 vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
534 fib_protocol_t fp = fib_ip_proto (is_ip6);
535 fib_prefix_from_ip46_addr (fp, &t->dst, &tun_dst_pfx);
536 if (!ip46_address_is_multicast (&t->dst))
539 * source the FIB entry for the tunnel's destination
540 * and become a child thereof. The tunnel will then get poked
541 * when the forwarding for the entry updates, and the tunnel can
542 * re-stack accordingly
544 vtep_addr_ref (&vxm->vtep_table, t->encap_fib_index, &t->src);
545 t->fib_entry_index = fib_entry_track (t->encap_fib_index,
547 FIB_NODE_TYPE_VXLAN_TUNNEL,
550 vxlan_tunnel_restack_dpo (t);
554 /* Multicast tunnel -
555 * as the same mcast group can be used for multiple mcast tunnels
556 * with different VNIs, create the output fib adjacency only if
557 * it does not already exist
559 if (vtep_addr_ref (&vxm->vtep_table,
560 t->encap_fib_index, &t->dst) == 1)
562 fib_node_index_t mfei;
564 fib_route_path_t path = {
565 .frp_proto = fib_proto_to_dpo (fp),
566 .frp_addr = zero_addr,
567 .frp_sw_if_index = 0xffffffff,
570 .frp_flags = FIB_ROUTE_PATH_LOCAL,
571 .frp_mitf_flags = MFIB_ITF_FLAG_FORWARD,
573 const mfib_prefix_t mpfx = {
575 .fp_len = (is_ip6 ? 128 : 32),
576 .fp_grp_addr = tun_dst_pfx.fp_addr,
580 * Setup the (*,G) to receive traffic on the mcast group
581 * - the forwarding interface is for-us
582 * - the accepting interface is that from the API
584 mfib_table_entry_path_update (t->encap_fib_index, &mpfx,
586 MFIB_ENTRY_FLAG_NONE, &path);
588 path.frp_sw_if_index = a->mcast_sw_if_index;
589 path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
590 path.frp_mitf_flags = MFIB_ITF_FLAG_ACCEPT;
591 mfei = mfib_table_entry_path_update (
592 t->encap_fib_index, &mpfx, MFIB_SOURCE_VXLAN,
593 MFIB_ENTRY_FLAG_NONE, &path);
596 * Create the mcast adjacency to send traffic to the group
598 ai = adj_mcast_add_or_lock (fp,
599 fib_proto_to_link (fp),
600 a->mcast_sw_if_index);
603 * create a new end-point
605 mcast_shared_add (&t->dst, mfei, ai);
608 dpo_id_t dpo = DPO_INVALID;
609 mcast_shared_t ep = mcast_shared_get (&t->dst);
611 /* Stack shared mcast dst mac addr rewrite on encap */
612 dpo_set (&dpo, DPO_ADJACENCY_MCAST,
613 fib_proto_to_dpo (fp), ep.mcast_adj_index);
615 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
617 flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
620 vnet_get_sw_interface (vnet_get_main (), sw_if_index)->flood_class =
625 /* deleting a tunnel: tunnel must exist */
627 return VNET_API_ERROR_NO_SUCH_ENTRY;
629 u32 instance = is_ip6 ? key6.value :
630 vxm->tunnel_index_by_sw_if_index[p->sw_if_index];
631 vxlan_tunnel_t *t = pool_elt_at_index (vxm->tunnels, instance);
633 sw_if_index = t->sw_if_index;
634 vnet_sw_interface_set_flags (vnm, sw_if_index, 0 /* down */ );
636 vxm->tunnel_index_by_sw_if_index[sw_if_index] = ~0;
639 clib_bihash_add_del_16_8 (&vxm->vxlan4_tunnel_by_key, &key4,
642 clib_bihash_add_del_24_8 (&vxm->vxlan6_tunnel_by_key, &key6,
645 if (!ip46_address_is_multicast (&t->dst))
647 if (t->flow_index != ~0)
648 vnet_flow_del (vnm, t->flow_index);
650 vtep_addr_unref (&vxm->vtep_table, t->encap_fib_index, &t->src);
651 fib_entry_untrack (t->fib_entry_index, t->sibling_index);
653 else if (vtep_addr_unref (&vxm->vtep_table,
654 t->encap_fib_index, &t->dst) == 0)
656 mcast_shared_remove (&t->dst);
659 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, t->hw_if_index);
660 if (hw->dev_class_index == vxlan_device_class.index)
661 vnet_delete_hw_interface (vnm, t->hw_if_index);
663 ethernet_delete_interface (vnm, t->hw_if_index);
664 hash_unset (vxm->instance_used, t->user_instance);
666 fib_node_deinit (&t->node);
667 pool_put (vxm->tunnels, t);
671 *sw_if_indexp = sw_if_index;
675 /* register udp ports */
676 if (!is_ip6 && !udp_is_valid_dst_port (a->src_port, 1))
677 udp_register_dst_port (vxm->vlib_main, a->src_port,
678 vxlan4_input_node.index, 1);
679 if (is_ip6 && !udp_is_valid_dst_port (a->src_port, 0))
680 udp_register_dst_port (vxm->vlib_main, a->src_port,
681 vxlan6_input_node.index, 0);
688 get_decap_next_for_node (u32 node_index, u32 ipv4_set)
690 vxlan_main_t *vxm = &vxlan_main;
691 vlib_main_t *vm = vxm->vlib_main;
692 uword input_node = (ipv4_set) ? vxlan4_input_node.index :
693 vxlan6_input_node.index;
695 return vlib_node_add_next (vm, input_node, node_index);
699 unformat_decap_next (unformat_input_t * input, va_list * args)
701 u32 *result = va_arg (*args, u32 *);
702 u32 ipv4_set = va_arg (*args, int);
703 vxlan_main_t *vxm = &vxlan_main;
704 vlib_main_t *vm = vxm->vlib_main;
708 if (unformat (input, "l2"))
709 *result = VXLAN_INPUT_NEXT_L2_INPUT;
710 else if (unformat (input, "node %U", unformat_vlib_node, vm, &node_index))
711 *result = get_decap_next_for_node (node_index, ipv4_set);
712 else if (unformat (input, "%d", &tmp))
719 static clib_error_t *
720 vxlan_add_del_tunnel_command_fn (vlib_main_t * vm,
721 unformat_input_t * input,
722 vlib_cli_command_t * cmd)
724 unformat_input_t _line_input, *line_input = &_line_input;
725 ip46_address_t src = ip46_address_initializer, dst =
726 ip46_address_initializer;
735 u32 encap_fib_index = 0;
736 u32 mcast_sw_if_index = ~0;
737 u32 decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
742 clib_error_t *parse_error = NULL;
744 /* Get a line of input. */
745 if (!unformat_user (input, unformat_line_input, line_input))
748 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
750 if (unformat (line_input, "del"))
754 else if (unformat (line_input, "instance %d", &instance))
756 else if (unformat (line_input, "src %U",
757 unformat_ip46_address, &src, IP46_TYPE_ANY))
760 ip46_address_is_ip4 (&src) ? (ipv4_set = 1) : (ipv6_set = 1);
762 else if (unformat (line_input, "dst %U",
763 unformat_ip46_address, &dst, IP46_TYPE_ANY))
766 ip46_address_is_ip4 (&dst) ? (ipv4_set = 1) : (ipv6_set = 1);
768 else if (unformat (line_input, "group %U %U",
769 unformat_ip46_address, &dst, IP46_TYPE_ANY,
770 unformat_vnet_sw_interface,
771 vnet_get_main (), &mcast_sw_if_index))
773 grp_set = dst_set = 1;
774 ip46_address_is_ip4 (&dst) ? (ipv4_set = 1) : (ipv6_set = 1);
776 else if (unformat (line_input, "encap-vrf-id %d", &table_id))
779 fib_table_find (fib_ip_proto (ipv6_set), table_id);
781 else if (unformat (line_input, "l3"))
783 else if (unformat (line_input, "decap-next %U", unformat_decap_next,
784 &decap_next_index, ipv4_set))
786 else if (unformat (line_input, "vni %d", &vni))
788 else if (unformat (line_input, "src_port %d", &src_port))
790 else if (unformat (line_input, "dst_port %d", &dst_port))
794 parse_error = clib_error_return (0, "parse error: '%U'",
795 format_unformat_error, line_input);
800 unformat_free (line_input);
805 if (is_l3 && decap_next_index == VXLAN_INPUT_NEXT_L2_INPUT)
807 vlib_node_t *node = vlib_get_node_by_name (
808 vm, (u8 *) (ipv4_set ? "ip4-input" : "ip6-input"));
809 decap_next_index = get_decap_next_for_node (node->index, ipv4_set);
812 if (encap_fib_index == ~0)
813 return clib_error_return (0, "nonexistent encap-vrf-id %d", table_id);
816 return clib_error_return (0, "tunnel src address not specified");
819 return clib_error_return (0, "tunnel dst address not specified");
821 if (grp_set && !ip46_address_is_multicast (&dst))
822 return clib_error_return (0, "tunnel group address not multicast");
824 if (grp_set == 0 && ip46_address_is_multicast (&dst))
825 return clib_error_return (0, "dst address must be unicast");
827 if (grp_set && mcast_sw_if_index == ~0)
828 return clib_error_return (0, "tunnel nonexistent multicast device");
830 if (ipv4_set && ipv6_set)
831 return clib_error_return (0, "both IPv4 and IPv6 addresses specified");
833 if (ip46_address_cmp (&src, &dst) == 0)
834 return clib_error_return (0, "src and dst addresses are identical");
836 if (decap_next_index == ~0)
837 return clib_error_return (0, "next node not found");
840 return clib_error_return (0, "vni not specified");
843 return clib_error_return (0, "vni %d out of range", vni);
845 vnet_vxlan_add_del_tunnel_args_t a = { .is_add = is_add,
848 .instance = instance,
854 u32 tunnel_sw_if_index;
855 int rv = vnet_vxlan_add_del_tunnel (&a, &tunnel_sw_if_index);
861 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
862 vnet_get_main (), tunnel_sw_if_index);
865 case VNET_API_ERROR_TUNNEL_EXIST:
866 return clib_error_return (0, "tunnel already exists...");
868 case VNET_API_ERROR_NO_SUCH_ENTRY:
869 return clib_error_return (0, "tunnel does not exist...");
871 case VNET_API_ERROR_INSTANCE_IN_USE:
872 return clib_error_return (0, "Instance is in use");
875 return clib_error_return
876 (0, "vnet_vxlan_add_del_tunnel returned %d", rv);
883 * Add or delete a VXLAN Tunnel.
885 * VXLAN provides the features needed to allow L2 bridge domains (BDs)
886 * to span multiple servers. This is done by building an L2 overlay on
887 * top of an L3 network underlay using VXLAN tunnels.
889 * This makes it possible for servers to be co-located in the same data
890 * center or be separated geographically as long as they are reachable
891 * through the underlay L3 network.
893 * You can refer to this kind of L2 overlay bridge domain as a VXLAN
894 * (Virtual eXtensible VLAN) segment.
897 * Example of how to create a VXLAN Tunnel:
898 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 encap-vrf-id
900 * Example of how to create a VXLAN Tunnel with a known name, vxlan_tunnel42:
901 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 instance 42}
902 * Example of how to create a multicast VXLAN Tunnel with a known name,
904 * @cliexcmd{create vxlan tunnel src 10.0.3.1 group 239.1.1.1
905 GigabitEthernet0/8/0 instance 23}
906 * Example of how to create a VXLAN Tunnel with custom udp-ports:
907 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 src_port
908 59000 dst_port 59001}
909 * Example of how to delete a VXLAN Tunnel:
910 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 del}
912 VLIB_CLI_COMMAND (create_vxlan_tunnel_command, static) = {
913 .path = "create vxlan tunnel",
915 "create vxlan tunnel src <local-vtep-addr>"
916 " {dst <remote-vtep-addr>|group <mcast-vtep-addr> <intf-name>} vni <nn>"
918 " [encap-vrf-id <nn>] [decap-next [l2|node <name>]] [del] [l3]"
919 " [src_port <local-vtep-udp-port>] [dst_port <remote-vtep-udp-port>]",
920 .function = vxlan_add_del_tunnel_command_fn,
923 static clib_error_t *
924 show_vxlan_tunnel_command_fn (vlib_main_t * vm,
925 unformat_input_t * input,
926 vlib_cli_command_t * cmd)
928 vxlan_main_t *vxm = &vxlan_main;
932 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
934 if (unformat (input, "raw"))
937 return clib_error_return (0, "parse error: '%U'",
938 format_unformat_error, input);
941 if (pool_elts (vxm->tunnels) == 0)
942 vlib_cli_output (vm, "No vxlan tunnels configured...");
944 pool_foreach (t, vxm->tunnels)
946 vlib_cli_output (vm, "%U", format_vxlan_tunnel, t);
951 vlib_cli_output (vm, "Raw IPv4 Hash Table:\n%U\n",
952 format_bihash_16_8, &vxm->vxlan4_tunnel_by_key,
954 vlib_cli_output (vm, "Raw IPv6 Hash Table:\n%U\n",
955 format_bihash_24_8, &vxm->vxlan6_tunnel_by_key,
963 * Display all the VXLAN Tunnel entries.
966 * Example of how to display the VXLAN Tunnel entries:
967 * @cliexstart{show vxlan tunnel}
968 * [0] src 10.0.3.1 dst 10.0.3.3 src_port 4789 dst_port 4789 vni 13
969 encap_fib_index 0 sw_if_index 5 decap_next l2
972 VLIB_CLI_COMMAND (show_vxlan_tunnel_command, static) = {
973 .path = "show vxlan tunnel",
974 .short_help = "show vxlan tunnel [raw]",
975 .function = show_vxlan_tunnel_command_fn,
980 vnet_int_vxlan_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable)
982 vxlan_main_t *vxm = &vxlan_main;
984 if (pool_is_free_index (vxm->vnet_main->interface_main.sw_interfaces,
988 is_enable = ! !is_enable;
992 if (clib_bitmap_get (vxm->bm_ip6_bypass_enabled_by_sw_if, sw_if_index)
995 vnet_feature_enable_disable ("ip6-unicast", "ip6-vxlan-bypass",
996 sw_if_index, is_enable, 0, 0);
997 vxm->bm_ip6_bypass_enabled_by_sw_if =
998 clib_bitmap_set (vxm->bm_ip6_bypass_enabled_by_sw_if,
999 sw_if_index, is_enable);
1004 if (clib_bitmap_get (vxm->bm_ip4_bypass_enabled_by_sw_if, sw_if_index)
1007 vnet_feature_enable_disable ("ip4-unicast", "ip4-vxlan-bypass",
1008 sw_if_index, is_enable, 0, 0);
1009 vxm->bm_ip4_bypass_enabled_by_sw_if =
1010 clib_bitmap_set (vxm->bm_ip4_bypass_enabled_by_sw_if,
1011 sw_if_index, is_enable);
1017 static clib_error_t *
1018 set_ip_vxlan_bypass (u32 is_ip6,
1019 unformat_input_t * input, vlib_cli_command_t * cmd)
1021 unformat_input_t _line_input, *line_input = &_line_input;
1022 vnet_main_t *vnm = vnet_get_main ();
1023 clib_error_t *error = 0;
1024 u32 sw_if_index, is_enable;
1029 if (!unformat_user (input, unformat_line_input, line_input))
1032 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1035 (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
1037 else if (unformat (line_input, "del"))
1041 error = unformat_parse_error (line_input);
1046 if (~0 == sw_if_index)
1048 error = clib_error_return (0, "unknown interface `%U'",
1049 format_unformat_error, line_input);
1053 vnet_int_vxlan_bypass_mode (sw_if_index, is_ip6, is_enable);
1056 unformat_free (line_input);
1061 static clib_error_t *
1062 set_ip4_vxlan_bypass (vlib_main_t * vm,
1063 unformat_input_t * input, vlib_cli_command_t * cmd)
1065 return set_ip_vxlan_bypass (0, input, cmd);
1069 * This command adds the 'ip4-vxlan-bypass' graph node for a given interface.
1070 * By adding the IPv4 vxlan-bypass graph node to an interface, the node checks
1071 * for and validate input vxlan packet and bypass ip4-lookup, ip4-local,
1072 * ip4-udp-lookup nodes to speedup vxlan packet forwarding. This node will
1073 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
1077 * Example of graph node before ip4-vxlan-bypass is enabled:
1078 * @cliexstart{show vlib graph ip4-vxlan-bypass}
1079 * Name Next Previous
1080 * ip4-vxlan-bypass error-drop [0]
1085 * Example of how to enable ip4-vxlan-bypass on an interface:
1086 * @cliexcmd{set interface ip vxlan-bypass GigabitEthernet2/0/0}
1088 * Example of graph node after ip4-vxlan-bypass is enabled:
1089 * @cliexstart{show vlib graph ip4-vxlan-bypass}
1090 * Name Next Previous
1091 * ip4-vxlan-bypass error-drop [0] ip4-input
1092 * vxlan4-input [1] ip4-input-no-checksum
1096 * Example of how to display the feature enabled on an interface:
1097 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1098 * IP feature paths configured on GigabitEthernet2/0/0...
1106 * Example of how to disable ip4-vxlan-bypass on an interface:
1107 * @cliexcmd{set interface ip vxlan-bypass GigabitEthernet2/0/0 del}
1110 VLIB_CLI_COMMAND (set_interface_ip_vxlan_bypass_command, static) = {
1111 .path = "set interface ip vxlan-bypass",
1112 .function = set_ip4_vxlan_bypass,
1113 .short_help = "set interface ip vxlan-bypass <interface> [del]",
1116 static clib_error_t *
1117 set_ip6_vxlan_bypass (vlib_main_t * vm,
1118 unformat_input_t * input, vlib_cli_command_t * cmd)
1120 return set_ip_vxlan_bypass (1, input, cmd);
1124 * This command adds the 'ip6-vxlan-bypass' graph node for a given interface.
1125 * By adding the IPv6 vxlan-bypass graph node to an interface, the node checks
1126 * for and validate input vxlan packet and bypass ip6-lookup, ip6-local,
1127 * ip6-udp-lookup nodes to speedup vxlan packet forwarding. This node will
1128 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
1132 * Example of graph node before ip6-vxlan-bypass is enabled:
1133 * @cliexstart{show vlib graph ip6-vxlan-bypass}
1134 * Name Next Previous
1135 * ip6-vxlan-bypass error-drop [0]
1140 * Example of how to enable ip6-vxlan-bypass on an interface:
1141 * @cliexcmd{set interface ip6 vxlan-bypass GigabitEthernet2/0/0}
1143 * Example of graph node after ip6-vxlan-bypass is enabled:
1144 * @cliexstart{show vlib graph ip6-vxlan-bypass}
1145 * Name Next Previous
1146 * ip6-vxlan-bypass error-drop [0] ip6-input
1147 * vxlan6-input [1] ip4-input-no-checksum
1151 * Example of how to display the feature enabled on an interface:
1152 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1153 * IP feature paths configured on GigabitEthernet2/0/0...
1161 * Example of how to disable ip6-vxlan-bypass on an interface:
1162 * @cliexcmd{set interface ip6 vxlan-bypass GigabitEthernet2/0/0 del}
1165 VLIB_CLI_COMMAND (set_interface_ip6_vxlan_bypass_command, static) = {
1166 .path = "set interface ip6 vxlan-bypass",
1167 .function = set_ip6_vxlan_bypass,
1168 .short_help = "set interface ip6 vxlan-bypass <interface> [del]",
1172 vnet_vxlan_add_del_rx_flow (u32 hw_if_index, u32 t_index, int is_add)
1174 vxlan_main_t *vxm = &vxlan_main;
1175 vxlan_tunnel_t *t = pool_elt_at_index (vxm->tunnels, t_index);
1176 vnet_main_t *vnm = vnet_get_main ();
1179 if (t->flow_index == ~0)
1181 vxlan_main_t *vxm = &vxlan_main;
1182 vnet_flow_t flow = {
1184 VNET_FLOW_ACTION_REDIRECT_TO_NODE | VNET_FLOW_ACTION_MARK |
1185 VNET_FLOW_ACTION_BUFFER_ADVANCE,
1186 .mark_flow_id = t->dev_instance + vxm->flow_id_start,
1187 .redirect_node_index = vxlan4_flow_input_node.index,
1188 .buffer_advance = sizeof (ethernet_header_t),
1189 .type = VNET_FLOW_TYPE_IP4_VXLAN,
1191 .protocol.prot = IP_PROTOCOL_UDP,
1192 .src_addr.addr = t->dst.ip4,
1193 .dst_addr.addr = t->src.ip4,
1194 .src_addr.mask.as_u32 = ~0,
1195 .dst_addr.mask.as_u32 = ~0,
1196 .dst_port.port = t->src_port,
1197 .dst_port.mask = 0xFF,
1202 vnet_flow_add (vnm, &flow, &t->flow_index);
1204 return vnet_flow_enable (vnm, t->flow_index, hw_if_index);
1206 /* flow index is removed when the tunnel is deleted */
1207 return vnet_flow_disable (vnm, t->flow_index, hw_if_index);
1211 vnet_vxlan_get_tunnel_index (u32 sw_if_index)
1213 vxlan_main_t *vxm = &vxlan_main;
1215 if (sw_if_index >= vec_len (vxm->tunnel_index_by_sw_if_index))
1217 return vxm->tunnel_index_by_sw_if_index[sw_if_index];
1220 static clib_error_t *
1221 vxlan_offload_command_fn (vlib_main_t * vm,
1222 unformat_input_t * input, vlib_cli_command_t * cmd)
1224 unformat_input_t _line_input, *line_input = &_line_input;
1226 /* Get a line of input. */
1227 if (!unformat_user (input, unformat_line_input, line_input))
1230 vnet_main_t *vnm = vnet_get_main ();
1231 u32 rx_sw_if_index = ~0;
1232 u32 hw_if_index = ~0;
1235 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1237 if (unformat (line_input, "hw %U", unformat_vnet_hw_interface, vnm,
1240 if (unformat (line_input, "rx %U", unformat_vnet_sw_interface, vnm,
1243 if (unformat (line_input, "del"))
1248 return clib_error_return (0, "unknown input `%U'",
1249 format_unformat_error, line_input);
1252 if (rx_sw_if_index == ~0)
1253 return clib_error_return (0, "missing rx interface");
1254 if (hw_if_index == ~0)
1255 return clib_error_return (0, "missing hw interface");
1257 u32 t_index = vnet_vxlan_get_tunnel_index (rx_sw_if_index);;
1259 return clib_error_return (0, "%U is not a vxlan tunnel",
1260 format_vnet_sw_if_index_name, vnm,
1263 vxlan_main_t *vxm = &vxlan_main;
1264 vxlan_tunnel_t *t = pool_elt_at_index (vxm->tunnels, t_index);
1266 if (!ip46_address_is_ip4 (&t->dst))
1267 return clib_error_return (0, "currently only IPV4 tunnels are supported");
1269 vnet_hw_interface_t *hw_if = vnet_get_hw_interface (vnm, hw_if_index);
1270 ip4_main_t *im = &ip4_main;
1272 vec_elt (im->fib_index_by_sw_if_index, hw_if->sw_if_index);
1274 if (t->encap_fib_index != rx_fib_index)
1275 return clib_error_return (0, "interface/tunnel fib mismatch");
1277 if (vnet_vxlan_add_del_rx_flow (hw_if_index, t_index, is_add))
1278 return clib_error_return (0, "error %s flow",
1279 is_add ? "enabling" : "disabling");
1284 VLIB_CLI_COMMAND (vxlan_offload_command, static) = {
1285 .path = "set flow-offload vxlan",
1287 "set flow-offload vxlan hw <interface-name> rx <tunnel-name> [del]",
1288 .function = vxlan_offload_command_fn,
1291 #define VXLAN_HASH_NUM_BUCKETS (2 * 1024)
1292 #define VXLAN_HASH_MEMORY_SIZE (1 << 20)
1295 vxlan_init (vlib_main_t * vm)
1297 vxlan_main_t *vxm = &vxlan_main;
1299 vxm->vnet_main = vnet_get_main ();
1300 vxm->vlib_main = vm;
1302 vnet_flow_get_range (vxm->vnet_main, "vxlan", 1024 * 1024,
1303 &vxm->flow_id_start);
1305 vxm->bm_ip4_bypass_enabled_by_sw_if = 0;
1306 vxm->bm_ip6_bypass_enabled_by_sw_if = 0;
1308 /* initialize the ip6 hash */
1309 clib_bihash_init_16_8 (&vxm->vxlan4_tunnel_by_key, "vxlan4",
1310 VXLAN_HASH_NUM_BUCKETS, VXLAN_HASH_MEMORY_SIZE);
1311 clib_bihash_init_24_8 (&vxm->vxlan6_tunnel_by_key, "vxlan6",
1312 VXLAN_HASH_NUM_BUCKETS, VXLAN_HASH_MEMORY_SIZE);
1313 vxm->vtep_table = vtep_table_create ();
1314 vxm->mcast_shared = hash_create_mem (0,
1315 sizeof (ip46_address_t),
1316 sizeof (mcast_shared_t));
1318 fib_node_register_type (FIB_NODE_TYPE_VXLAN_TUNNEL, &vxlan_vft);
1323 VLIB_INIT_FUNCTION (vxlan_init);
1326 * fd.io coding-style-patch-verification: ON
1329 * eval: (c-set-style "gnu")