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 format_decap_next (u8 * s, va_list * args)
58 u32 next_index = va_arg (*args, u32);
60 if (next_index == VXLAN_INPUT_NEXT_DROP)
61 return format (s, "drop");
63 return format (s, "index %d", next_index);
68 format_vxlan_tunnel (u8 * s, va_list * args)
70 vxlan_tunnel_t *t = va_arg (*args, vxlan_tunnel_t *);
73 "[%d] instance %d src %U dst %U src_port %d dst_port %d vni %d "
74 "fib-idx %d sw-if-idx %d ",
75 t->dev_instance, t->user_instance, format_ip46_address, &t->src,
76 IP46_TYPE_ANY, format_ip46_address, &t->dst, IP46_TYPE_ANY,
77 t->src_port, t->dst_port, t->vni, t->encap_fib_index,
80 s = format (s, "encap-dpo-idx %d ", t->next_dpo.dpoi_index);
82 if (PREDICT_FALSE (t->decap_next_index != VXLAN_INPUT_NEXT_L2_INPUT))
83 s = format (s, "decap-next-%U ", format_decap_next, t->decap_next_index);
85 s = format (s, "l3 %u ", t->is_l3);
87 if (PREDICT_FALSE (ip46_address_is_multicast (&t->dst)))
88 s = format (s, "mcast-sw-if-idx %d ", t->mcast_sw_if_index);
90 if (t->flow_index != ~0)
91 s = format (s, "flow-index %d [%U]", t->flow_index,
92 format_flow_enabled_hw, t->flow_index);
98 format_vxlan_name (u8 * s, va_list * args)
100 u32 dev_instance = va_arg (*args, u32);
101 vxlan_main_t *vxm = &vxlan_main;
104 if (dev_instance == ~0)
105 return format (s, "<cached-unused>");
107 if (dev_instance >= vec_len (vxm->tunnels))
108 return format (s, "<improperly-referenced>");
110 t = pool_elt_at_index (vxm->tunnels, dev_instance);
112 return format (s, "vxlan_tunnel%d", t->user_instance);
115 static clib_error_t *
116 vxlan_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
118 u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
119 VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
120 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
122 return /* no error */ 0;
126 VNET_DEVICE_CLASS (vxlan_device_class, static) = {
128 .format_device_name = format_vxlan_name,
129 .format_tx_trace = format_vxlan_encap_trace,
130 .admin_up_down_function = vxlan_interface_admin_up_down,
135 format_vxlan_header_with_length (u8 * s, va_list * args)
137 u32 dev_instance = va_arg (*args, u32);
138 s = format (s, "unimplemented dev %u", dev_instance);
143 VNET_HW_INTERFACE_CLASS (vxlan_hw_class) = {
145 .format_header = format_vxlan_header_with_length,
146 .build_rewrite = default_build_rewrite,
151 vxlan_tunnel_restack_dpo (vxlan_tunnel_t * t)
153 u8 is_ip4 = ip46_address_is_ip4 (&t->dst);
154 dpo_id_t dpo = DPO_INVALID;
155 fib_forward_chain_type_t forw_type = is_ip4 ?
156 FIB_FORW_CHAIN_TYPE_UNICAST_IP4 : FIB_FORW_CHAIN_TYPE_UNICAST_IP6;
158 fib_entry_contribute_forwarding (t->fib_entry_index, forw_type, &dpo);
160 /* vxlan uses the payload hash as the udp source port
161 * hence the packet's hash is unknown
162 * skip single bucket load balance dpo's */
163 while (DPO_LOAD_BALANCE == dpo.dpoi_type)
165 const load_balance_t *lb;
166 const dpo_id_t *choice;
168 lb = load_balance_get (dpo.dpoi_index);
169 if (lb->lb_n_buckets > 1)
172 choice = load_balance_get_bucket_i (lb, 0);
174 if (DPO_RECEIVE == choice->dpoi_type)
175 dpo_copy (&dpo, drop_dpo_get (choice->dpoi_proto));
177 dpo_copy (&dpo, choice);
180 u32 encap_index = is_ip4 ?
181 vxlan4_encap_node.index : vxlan6_encap_node.index;
182 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
186 static vxlan_tunnel_t *
187 vxlan_tunnel_from_fib_node (fib_node_t * node)
189 ASSERT (FIB_NODE_TYPE_VXLAN_TUNNEL == node->fn_type);
190 return ((vxlan_tunnel_t *) (((char *) node) -
191 STRUCT_OFFSET_OF (vxlan_tunnel_t, node)));
195 * Function definition to backwalk a FIB node -
196 * Here we will restack the new dpo of VXLAN DIP to encap node.
198 static fib_node_back_walk_rc_t
199 vxlan_tunnel_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
201 vxlan_tunnel_restack_dpo (vxlan_tunnel_from_fib_node (node));
202 return (FIB_NODE_BACK_WALK_CONTINUE);
206 * Function definition to get a FIB node from its index
209 vxlan_tunnel_fib_node_get (fib_node_index_t index)
212 vxlan_main_t *vxm = &vxlan_main;
214 t = pool_elt_at_index (vxm->tunnels, index);
220 * Function definition to inform the FIB node that its last lock has gone.
223 vxlan_tunnel_last_lock_gone (fib_node_t * node)
226 * The VXLAN tunnel is a root of the graph. As such
227 * it never has children and thus is never locked.
233 * Virtual function table registered by VXLAN tunnels
234 * for participation in the FIB object graph.
236 const static fib_node_vft_t vxlan_vft = {
237 .fnv_get = vxlan_tunnel_fib_node_get,
238 .fnv_last_lock = vxlan_tunnel_last_lock_gone,
239 .fnv_back_walk = vxlan_tunnel_back_walk,
242 #define foreach_copy_field \
244 _ (mcast_sw_if_index) \
245 _ (encap_fib_index) \
246 _ (decap_next_index) \
254 vxlan_rewrite (vxlan_tunnel_t * t, bool is_ip6)
258 ip4_vxlan_header_t h4;
259 ip6_vxlan_header_t h6;
261 int len = is_ip6 ? sizeof h.h6 : sizeof h.h4;
264 vxlan_header_t *vxlan;
265 /* Fixed portion of the (outer) ip header */
267 clib_memset (&h, 0, sizeof (h));
270 ip4_header_t *ip = &h.h4.ip4;
271 udp = &h.h4.udp, vxlan = &h.h4.vxlan;
272 ip->ip_version_and_header_length = 0x45;
274 ip->protocol = IP_PROTOCOL_UDP;
276 ip->src_address = t->src.ip4;
277 ip->dst_address = t->dst.ip4;
279 /* we fix up the ip4 header length and checksum after-the-fact */
280 ip->checksum = ip4_header_checksum (ip);
284 ip6_header_t *ip = &h.h6.ip6;
285 udp = &h.h6.udp, vxlan = &h.h6.vxlan;
286 ip->ip_version_traffic_class_and_flow_label =
287 clib_host_to_net_u32 (6 << 28);
289 ip->protocol = IP_PROTOCOL_UDP;
291 ip->src_address = t->src.ip6;
292 ip->dst_address = t->dst.ip6;
295 /* UDP header, randomize src port on something, maybe? */
296 udp->src_port = clib_host_to_net_u16 (t->src_port);
297 udp->dst_port = clib_host_to_net_u16 (t->dst_port);
300 vnet_set_vni_and_flags (vxlan, t->vni);
301 vnet_rewrite_set_data (*t, &h, len);
305 vxlan_decap_next_is_valid (vxlan_main_t * vxm, u32 is_ip6,
306 u32 decap_next_index)
308 vlib_main_t *vm = vxm->vlib_main;
309 u32 input_idx = (!is_ip6) ?
310 vxlan4_input_node.index : vxlan6_input_node.index;
311 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, input_idx);
313 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;
328 static inline mcast_shared_t
329 mcast_shared_get (ip46_address_t * ip)
331 ASSERT (ip46_address_is_multicast (ip));
332 uword *p = hash_get_mem (vxlan_main.mcast_shared, ip);
334 mcast_shared_t ret = {.as_u64 = *p };
339 mcast_shared_add (ip46_address_t * dst, fib_node_index_t mfei, adj_index_t ai)
341 mcast_shared_t new_ep = {
342 .mcast_adj_index = ai,
343 .mfib_entry_index = mfei,
346 hash_set_mem_alloc (&vxlan_main.mcast_shared, dst, new_ep.as_u64);
350 mcast_shared_remove (ip46_address_t * dst)
352 mcast_shared_t ep = mcast_shared_get (dst);
354 adj_unlock (ep.mcast_adj_index);
355 mfib_table_entry_delete_index (ep.mfib_entry_index, MFIB_SOURCE_VXLAN);
357 hash_unset_mem_free (&vxlan_main.mcast_shared, dst);
360 int vnet_vxlan_add_del_tunnel
361 (vnet_vxlan_add_del_tunnel_args_t * a, u32 * sw_if_indexp)
363 vxlan_main_t *vxm = &vxlan_main;
364 vnet_main_t *vnm = vxm->vnet_main;
365 vxlan_decap_info_t *p;
366 u32 sw_if_index = ~0;
367 vxlan4_tunnel_key_t key4;
368 vxlan6_tunnel_key_t key6;
369 u32 is_ip6 = a->is_ip6;
370 vlib_main_t *vm = vlib_get_main ();
374 if (a->src_port == 0)
375 a->src_port = is_ip6 ? UDP_DST_PORT_vxlan6 : UDP_DST_PORT_vxlan;
377 if (a->dst_port == 0)
378 a->dst_port = is_ip6 ? UDP_DST_PORT_vxlan6 : UDP_DST_PORT_vxlan;
383 /* ip4 mcast is indexed by mcast addr only */
384 key4.key[0] = ip46_address_is_multicast (&a->dst) ?
386 a->dst.ip4.as_u32 | (((u64) a->src.ip4.as_u32) << 32);
387 key4.key[1] = ((u64) clib_host_to_net_u16 (a->src_port) << 48) |
388 (((u64) a->encap_fib_index) << 32) |
389 clib_host_to_net_u32 (a->vni << 8);
391 clib_bihash_search_inline_16_8 (&vxm->vxlan4_tunnel_by_key, &key4);
392 p = (void *) &key4.value;
396 key6.key[0] = a->dst.ip6.as_u64[0];
397 key6.key[1] = a->dst.ip6.as_u64[1];
398 key6.key[2] = (((u64) clib_host_to_net_u16 (a->src_port) << 48) |
399 ((u64) a->encap_fib_index) << 32) |
400 clib_host_to_net_u32 (a->vni << 8);
402 clib_bihash_search_inline_24_8 (&vxm->vxlan6_tunnel_by_key, &key6);
403 p = (void *) &key6.value;
411 l2input_main_t *l2im = &l2input_main;
412 u32 dev_instance; /* real dev instance tunnel index */
413 u32 user_instance; /* request and actual instance number */
415 /* adding a tunnel: tunnel must not already exist */
417 return VNET_API_ERROR_TUNNEL_EXIST;
419 /*if not set explicitly, default to l2 */
420 if (a->decap_next_index == ~0)
421 a->decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
422 if (!vxlan_decap_next_is_valid (vxm, is_ip6, a->decap_next_index))
423 return VNET_API_ERROR_INVALID_DECAP_NEXT;
426 pool_get_aligned (vxm->tunnels, t, CLIB_CACHE_LINE_BYTES);
427 clib_memset (t, 0, sizeof (*t));
428 dev_instance = t - vxm->tunnels;
430 /* copy from arg structure */
431 #define _(x) t->x = a->x;
435 vxlan_rewrite (t, is_ip6);
437 * Reconcile the real dev_instance and a possible requested instance.
439 user_instance = a->instance;
440 if (user_instance == ~0)
441 user_instance = dev_instance;
442 if (hash_get (vxm->instance_used, user_instance))
444 pool_put (vxm->tunnels, t);
445 return VNET_API_ERROR_INSTANCE_IN_USE;
448 hash_set (vxm->instance_used, user_instance, 1);
450 t->dev_instance = dev_instance; /* actual */
451 t->user_instance = user_instance; /* name */
456 vnet_register_interface (vnm, vxlan_device_class.index, dev_instance,
457 vxlan_hw_class.index, dev_instance);
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));
467 if (ethernet_register_interface (
468 vnm, vxlan_device_class.index, dev_instance, hw_addr,
469 &t->hw_if_index, vxlan_eth_flag_change))
471 hash_unset (vxm->instance_used, t->user_instance);
473 pool_put (vxm->tunnels, t);
474 return VNET_API_ERROR_SYSCALL_ERROR_2;
478 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, t->hw_if_index);
480 /* Set vxlan tunnel output node */
481 u32 encap_index = !is_ip6 ?
482 vxlan4_encap_node.index : vxlan6_encap_node.index;
483 vnet_set_interface_output_node (vnm, t->hw_if_index, encap_index);
485 t->sw_if_index = sw_if_index = hi->sw_if_index;
491 key6.value = (u64) dev_instance;
492 add_failed = clib_bihash_add_del_24_8 (&vxm->vxlan6_tunnel_by_key,
497 vxlan_decap_info_t di = {.sw_if_index = t->sw_if_index, };
498 if (ip46_address_is_multicast (&t->dst))
499 di.local_ip = t->src.ip4;
501 di.next_index = t->decap_next_index;
502 key4.value = di.as_u64;
503 add_failed = clib_bihash_add_del_16_8 (&vxm->vxlan4_tunnel_by_key,
510 vnet_delete_hw_interface (vnm, t->hw_if_index);
512 ethernet_delete_interface (vnm, t->hw_if_index);
513 hash_unset (vxm->instance_used, t->user_instance);
514 pool_put (vxm->tunnels, t);
515 return VNET_API_ERROR_INVALID_REGISTRATION;
518 vec_validate_init_empty (vxm->tunnel_index_by_sw_if_index, sw_if_index,
520 vxm->tunnel_index_by_sw_if_index[sw_if_index] = dev_instance;
522 /* setup l2 input config with l2 feature and bd 0 to drop packet */
523 vec_validate (l2im->configs, sw_if_index);
524 l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
525 l2im->configs[sw_if_index].bd_index = 0;
527 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
528 si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
529 vnet_sw_interface_set_flags (vnm, sw_if_index,
530 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
532 fib_node_init (&t->node, FIB_NODE_TYPE_VXLAN_TUNNEL);
533 fib_prefix_t tun_dst_pfx;
534 vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
536 fib_prefix_from_ip46_addr (&t->dst, &tun_dst_pfx);
537 if (!ip46_address_is_multicast (&t->dst))
540 * source the FIB entry for the tunnel's destination
541 * and become a child thereof. The tunnel will then get poked
542 * when the forwarding for the entry updates, and the tunnel can
543 * re-stack accordingly
545 vtep_addr_ref (&vxm->vtep_table, t->encap_fib_index, &t->src);
546 t->fib_entry_index = fib_entry_track (t->encap_fib_index,
548 FIB_NODE_TYPE_VXLAN_TUNNEL,
551 vxlan_tunnel_restack_dpo (t);
555 /* Multicast tunnel -
556 * as the same mcast group can be used for multiple mcast tunnels
557 * with different VNIs, create the output fib adjacency only if
558 * it does not already exist
560 fib_protocol_t fp = fib_ip_proto (is_ip6);
562 if (vtep_addr_ref (&vxm->vtep_table,
563 t->encap_fib_index, &t->dst) == 1)
565 fib_node_index_t mfei;
567 fib_route_path_t path = {
568 .frp_proto = fib_proto_to_dpo (fp),
569 .frp_addr = zero_addr,
570 .frp_sw_if_index = 0xffffffff,
573 .frp_flags = FIB_ROUTE_PATH_LOCAL,
574 .frp_mitf_flags = MFIB_ITF_FLAG_FORWARD,
576 const mfib_prefix_t mpfx = {
578 .fp_len = (is_ip6 ? 128 : 32),
579 .fp_grp_addr = tun_dst_pfx.fp_addr,
583 * Setup the (*,G) to receive traffic on the mcast group
584 * - the forwarding interface is for-us
585 * - the accepting interface is that from the API
587 mfib_table_entry_path_update (t->encap_fib_index, &mpfx,
589 MFIB_ENTRY_FLAG_NONE, &path);
591 path.frp_sw_if_index = a->mcast_sw_if_index;
592 path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
593 path.frp_mitf_flags = MFIB_ITF_FLAG_ACCEPT;
594 mfei = mfib_table_entry_path_update (
595 t->encap_fib_index, &mpfx, MFIB_SOURCE_VXLAN,
596 MFIB_ENTRY_FLAG_NONE, &path);
599 * Create the mcast adjacency to send traffic to the group
601 ai = adj_mcast_add_or_lock (fp,
602 fib_proto_to_link (fp),
603 a->mcast_sw_if_index);
606 * create a new end-point
608 mcast_shared_add (&t->dst, mfei, ai);
611 dpo_id_t dpo = DPO_INVALID;
612 mcast_shared_t ep = mcast_shared_get (&t->dst);
614 /* Stack shared mcast dst mac addr rewrite on encap */
615 dpo_set (&dpo, DPO_ADJACENCY_MCAST,
616 fib_proto_to_dpo (fp), ep.mcast_adj_index);
618 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
620 flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
623 vnet_get_sw_interface (vnet_get_main (), sw_if_index)->flood_class =
628 /* deleting a tunnel: tunnel must exist */
630 return VNET_API_ERROR_NO_SUCH_ENTRY;
632 u32 instance = is_ip6 ? key6.value :
633 vxm->tunnel_index_by_sw_if_index[p->sw_if_index];
634 vxlan_tunnel_t *t = pool_elt_at_index (vxm->tunnels, instance);
636 sw_if_index = t->sw_if_index;
637 vnet_sw_interface_set_flags (vnm, sw_if_index, 0 /* down */ );
639 vxm->tunnel_index_by_sw_if_index[sw_if_index] = ~0;
642 clib_bihash_add_del_16_8 (&vxm->vxlan4_tunnel_by_key, &key4,
645 clib_bihash_add_del_24_8 (&vxm->vxlan6_tunnel_by_key, &key6,
648 if (!ip46_address_is_multicast (&t->dst))
650 if (t->flow_index != ~0)
651 vnet_flow_del (vnm, t->flow_index);
653 vtep_addr_unref (&vxm->vtep_table, t->encap_fib_index, &t->src);
654 fib_entry_untrack (t->fib_entry_index, t->sibling_index);
656 else if (vtep_addr_unref (&vxm->vtep_table,
657 t->encap_fib_index, &t->dst) == 0)
659 mcast_shared_remove (&t->dst);
663 vnet_delete_hw_interface (vnm, t->hw_if_index);
665 ethernet_delete_interface (vnm, t->hw_if_index);
666 hash_unset (vxm->instance_used, t->user_instance);
668 fib_node_deinit (&t->node);
669 pool_put (vxm->tunnels, t);
673 *sw_if_indexp = sw_if_index;
677 /* register udp ports */
678 if (!is_ip6 && !udp_is_valid_dst_port (a->src_port, 1))
679 udp_register_dst_port (vxm->vlib_main, a->src_port,
680 vxlan4_input_node.index, 1);
681 if (is_ip6 && !udp_is_valid_dst_port (a->src_port, 0))
682 udp_register_dst_port (vxm->vlib_main, a->src_port,
683 vxlan6_input_node.index, 0);
690 get_decap_next_for_node (u32 node_index, u32 ipv4_set)
692 vxlan_main_t *vxm = &vxlan_main;
693 vlib_main_t *vm = vxm->vlib_main;
694 uword input_node = (ipv4_set) ? vxlan4_input_node.index :
695 vxlan6_input_node.index;
697 return vlib_node_add_next (vm, input_node, node_index);
701 unformat_decap_next (unformat_input_t * input, va_list * args)
703 u32 *result = va_arg (*args, u32 *);
704 u32 ipv4_set = va_arg (*args, int);
705 vxlan_main_t *vxm = &vxlan_main;
706 vlib_main_t *vm = vxm->vlib_main;
710 if (unformat (input, "l2"))
711 *result = VXLAN_INPUT_NEXT_L2_INPUT;
712 else if (unformat (input, "node %U", unformat_vlib_node, vm, &node_index))
713 *result = get_decap_next_for_node (node_index, ipv4_set);
714 else if (unformat (input, "%d", &tmp))
721 static clib_error_t *
722 vxlan_add_del_tunnel_command_fn (vlib_main_t * vm,
723 unformat_input_t * input,
724 vlib_cli_command_t * cmd)
726 unformat_input_t _line_input, *line_input = &_line_input;
727 ip46_address_t src = ip46_address_initializer, dst =
728 ip46_address_initializer;
737 u32 encap_fib_index = 0;
738 u32 mcast_sw_if_index = ~0;
739 u32 decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
744 clib_error_t *parse_error = NULL;
746 /* Get a line of input. */
747 if (!unformat_user (input, unformat_line_input, line_input))
750 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
752 if (unformat (line_input, "del"))
756 else if (unformat (line_input, "instance %d", &instance))
758 else if (unformat (line_input, "src %U",
759 unformat_ip46_address, &src, IP46_TYPE_ANY))
762 ip46_address_is_ip4 (&src) ? (ipv4_set = 1) : (ipv6_set = 1);
764 else if (unformat (line_input, "dst %U",
765 unformat_ip46_address, &dst, IP46_TYPE_ANY))
768 ip46_address_is_ip4 (&dst) ? (ipv4_set = 1) : (ipv6_set = 1);
770 else if (unformat (line_input, "group %U %U",
771 unformat_ip46_address, &dst, IP46_TYPE_ANY,
772 unformat_vnet_sw_interface,
773 vnet_get_main (), &mcast_sw_if_index))
775 grp_set = dst_set = 1;
776 ip46_address_is_ip4 (&dst) ? (ipv4_set = 1) : (ipv6_set = 1);
778 else if (unformat (line_input, "encap-vrf-id %d", &table_id))
781 fib_table_find (fib_ip_proto (ipv6_set), table_id);
783 else if (unformat (line_input, "l3"))
785 else if (unformat (line_input, "decap-next %U", unformat_decap_next,
786 &decap_next_index, ipv4_set))
788 else if (unformat (line_input, "vni %d", &vni))
790 else if (unformat (line_input, "src_port %d", &src_port))
792 else if (unformat (line_input, "dst_port %d", &dst_port))
796 parse_error = clib_error_return (0, "parse error: '%U'",
797 format_unformat_error, line_input);
802 unformat_free (line_input);
807 if (is_l3 && decap_next_index == VXLAN_INPUT_NEXT_L2_INPUT)
809 vlib_node_t *node = vlib_get_node_by_name (
810 vm, (u8 *) (ipv4_set ? "ip4-input" : "ip6-input"));
811 decap_next_index = get_decap_next_for_node (node->index, ipv4_set);
814 if (encap_fib_index == ~0)
815 return clib_error_return (0, "nonexistent encap-vrf-id %d", table_id);
818 return clib_error_return (0, "tunnel src address not specified");
821 return clib_error_return (0, "tunnel dst address not specified");
823 if (grp_set && !ip46_address_is_multicast (&dst))
824 return clib_error_return (0, "tunnel group address not multicast");
826 if (grp_set == 0 && ip46_address_is_multicast (&dst))
827 return clib_error_return (0, "dst address must be unicast");
829 if (grp_set && mcast_sw_if_index == ~0)
830 return clib_error_return (0, "tunnel nonexistent multicast device");
832 if (ipv4_set && ipv6_set)
833 return clib_error_return (0, "both IPv4 and IPv6 addresses specified");
835 if (ip46_address_cmp (&src, &dst) == 0)
836 return clib_error_return (0, "src and dst addresses are identical");
838 if (decap_next_index == ~0)
839 return clib_error_return (0, "next node not found");
842 return clib_error_return (0, "vni not specified");
845 return clib_error_return (0, "vni %d out of range", vni);
847 vnet_vxlan_add_del_tunnel_args_t a = { .is_add = is_add,
849 .instance = instance,
855 u32 tunnel_sw_if_index;
856 int rv = vnet_vxlan_add_del_tunnel (&a, &tunnel_sw_if_index);
862 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
863 vnet_get_main (), tunnel_sw_if_index);
866 case VNET_API_ERROR_TUNNEL_EXIST:
867 return clib_error_return (0, "tunnel already exists...");
869 case VNET_API_ERROR_NO_SUCH_ENTRY:
870 return clib_error_return (0, "tunnel does not exist...");
872 case VNET_API_ERROR_INSTANCE_IN_USE:
873 return clib_error_return (0, "Instance is in use");
876 return clib_error_return
877 (0, "vnet_vxlan_add_del_tunnel returned %d", rv);
884 * Add or delete a VXLAN Tunnel.
886 * VXLAN provides the features needed to allow L2 bridge domains (BDs)
887 * to span multiple servers. This is done by building an L2 overlay on
888 * top of an L3 network underlay using VXLAN tunnels.
890 * This makes it possible for servers to be co-located in the same data
891 * center or be separated geographically as long as they are reachable
892 * through the underlay L3 network.
894 * You can refer to this kind of L2 overlay bridge domain as a VXLAN
895 * (Virtual eXtensible VLAN) segment.
898 * Example of how to create a VXLAN Tunnel:
899 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 encap-vrf-id
901 * Example of how to create a VXLAN Tunnel with a known name, vxlan_tunnel42:
902 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 instance 42}
903 * Example of how to create a multicast VXLAN Tunnel with a known name,
905 * @cliexcmd{create vxlan tunnel src 10.0.3.1 group 239.1.1.1
906 GigabitEthernet0/8/0 instance 23}
907 * Example of how to create a VXLAN Tunnel with custom udp-ports:
908 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 src_port
909 59000 dst_port 59001}
910 * Example of how to delete a VXLAN Tunnel:
911 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 del}
914 VLIB_CLI_COMMAND (create_vxlan_tunnel_command, static) = {
915 .path = "create vxlan tunnel",
917 "create vxlan tunnel src <local-vtep-addr>"
918 " {dst <remote-vtep-addr>|group <mcast-vtep-addr> <intf-name>} vni <nn>"
920 " [encap-vrf-id <nn>] [decap-next [l2|node <name>]] [del] [l3]"
921 " [src_port <local-vtep-udp-port>] [dst_port <remote-vtep-udp-port>]",
922 .function = vxlan_add_del_tunnel_command_fn,
926 static clib_error_t *
927 show_vxlan_tunnel_command_fn (vlib_main_t * vm,
928 unformat_input_t * input,
929 vlib_cli_command_t * cmd)
931 vxlan_main_t *vxm = &vxlan_main;
935 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
937 if (unformat (input, "raw"))
940 return clib_error_return (0, "parse error: '%U'",
941 format_unformat_error, input);
944 if (pool_elts (vxm->tunnels) == 0)
945 vlib_cli_output (vm, "No vxlan tunnels configured...");
948 pool_foreach (t, vxm->tunnels)
950 vlib_cli_output (vm, "%U", format_vxlan_tunnel, t);
956 vlib_cli_output (vm, "Raw IPv4 Hash Table:\n%U\n",
957 format_bihash_16_8, &vxm->vxlan4_tunnel_by_key,
959 vlib_cli_output (vm, "Raw IPv6 Hash Table:\n%U\n",
960 format_bihash_24_8, &vxm->vxlan6_tunnel_by_key,
968 * Display all the VXLAN Tunnel entries.
971 * Example of how to display the VXLAN Tunnel entries:
972 * @cliexstart{show vxlan tunnel}
973 * [0] src 10.0.3.1 dst 10.0.3.3 src_port 4789 dst_port 4789 vni 13
974 encap_fib_index 0 sw_if_index 5 decap_next l2
978 VLIB_CLI_COMMAND (show_vxlan_tunnel_command, static) = {
979 .path = "show vxlan tunnel",
980 .short_help = "show vxlan tunnel [raw]",
981 .function = show_vxlan_tunnel_command_fn,
987 vnet_int_vxlan_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable)
989 vxlan_main_t *vxm = &vxlan_main;
991 if (pool_is_free_index (vxm->vnet_main->interface_main.sw_interfaces,
995 is_enable = ! !is_enable;
999 if (clib_bitmap_get (vxm->bm_ip6_bypass_enabled_by_sw_if, sw_if_index)
1002 vnet_feature_enable_disable ("ip6-unicast", "ip6-vxlan-bypass",
1003 sw_if_index, is_enable, 0, 0);
1004 vxm->bm_ip6_bypass_enabled_by_sw_if =
1005 clib_bitmap_set (vxm->bm_ip6_bypass_enabled_by_sw_if,
1006 sw_if_index, is_enable);
1011 if (clib_bitmap_get (vxm->bm_ip4_bypass_enabled_by_sw_if, sw_if_index)
1014 vnet_feature_enable_disable ("ip4-unicast", "ip4-vxlan-bypass",
1015 sw_if_index, is_enable, 0, 0);
1016 vxm->bm_ip4_bypass_enabled_by_sw_if =
1017 clib_bitmap_set (vxm->bm_ip4_bypass_enabled_by_sw_if,
1018 sw_if_index, is_enable);
1024 static clib_error_t *
1025 set_ip_vxlan_bypass (u32 is_ip6,
1026 unformat_input_t * input, vlib_cli_command_t * cmd)
1028 unformat_input_t _line_input, *line_input = &_line_input;
1029 vnet_main_t *vnm = vnet_get_main ();
1030 clib_error_t *error = 0;
1031 u32 sw_if_index, is_enable;
1036 if (!unformat_user (input, unformat_line_input, line_input))
1039 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1042 (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
1044 else if (unformat (line_input, "del"))
1048 error = unformat_parse_error (line_input);
1053 if (~0 == sw_if_index)
1055 error = clib_error_return (0, "unknown interface `%U'",
1056 format_unformat_error, line_input);
1060 vnet_int_vxlan_bypass_mode (sw_if_index, is_ip6, is_enable);
1063 unformat_free (line_input);
1068 static clib_error_t *
1069 set_ip4_vxlan_bypass (vlib_main_t * vm,
1070 unformat_input_t * input, vlib_cli_command_t * cmd)
1072 return set_ip_vxlan_bypass (0, input, cmd);
1076 * This command adds the 'ip4-vxlan-bypass' graph node for a given interface.
1077 * By adding the IPv4 vxlan-bypass graph node to an interface, the node checks
1078 * for and validate input vxlan packet and bypass ip4-lookup, ip4-local,
1079 * ip4-udp-lookup nodes to speedup vxlan packet forwarding. This node will
1080 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
1084 * Example of graph node before ip4-vxlan-bypass is enabled:
1085 * @cliexstart{show vlib graph ip4-vxlan-bypass}
1086 * Name Next Previous
1087 * ip4-vxlan-bypass error-drop [0]
1092 * Example of how to enable ip4-vxlan-bypass on an interface:
1093 * @cliexcmd{set interface ip vxlan-bypass GigabitEthernet2/0/0}
1095 * Example of graph node after ip4-vxlan-bypass is enabled:
1096 * @cliexstart{show vlib graph ip4-vxlan-bypass}
1097 * Name Next Previous
1098 * ip4-vxlan-bypass error-drop [0] ip4-input
1099 * vxlan4-input [1] ip4-input-no-checksum
1103 * Example of how to display the feature enabled on an interface:
1104 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1105 * IP feature paths configured on GigabitEthernet2/0/0...
1113 * Example of how to disable ip4-vxlan-bypass on an interface:
1114 * @cliexcmd{set interface ip vxlan-bypass GigabitEthernet2/0/0 del}
1118 VLIB_CLI_COMMAND (set_interface_ip_vxlan_bypass_command, static) = {
1119 .path = "set interface ip vxlan-bypass",
1120 .function = set_ip4_vxlan_bypass,
1121 .short_help = "set interface ip vxlan-bypass <interface> [del]",
1125 static clib_error_t *
1126 set_ip6_vxlan_bypass (vlib_main_t * vm,
1127 unformat_input_t * input, vlib_cli_command_t * cmd)
1129 return set_ip_vxlan_bypass (1, input, cmd);
1133 * This command adds the 'ip6-vxlan-bypass' graph node for a given interface.
1134 * By adding the IPv6 vxlan-bypass graph node to an interface, the node checks
1135 * for and validate input vxlan packet and bypass ip6-lookup, ip6-local,
1136 * ip6-udp-lookup nodes to speedup vxlan packet forwarding. This node will
1137 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
1141 * Example of graph node before ip6-vxlan-bypass is enabled:
1142 * @cliexstart{show vlib graph ip6-vxlan-bypass}
1143 * Name Next Previous
1144 * ip6-vxlan-bypass error-drop [0]
1149 * Example of how to enable ip6-vxlan-bypass on an interface:
1150 * @cliexcmd{set interface ip6 vxlan-bypass GigabitEthernet2/0/0}
1152 * Example of graph node after ip6-vxlan-bypass is enabled:
1153 * @cliexstart{show vlib graph ip6-vxlan-bypass}
1154 * Name Next Previous
1155 * ip6-vxlan-bypass error-drop [0] ip6-input
1156 * vxlan6-input [1] ip4-input-no-checksum
1160 * Example of how to display the feature enabled on an interface:
1161 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1162 * IP feature paths configured on GigabitEthernet2/0/0...
1170 * Example of how to disable ip6-vxlan-bypass on an interface:
1171 * @cliexcmd{set interface ip6 vxlan-bypass GigabitEthernet2/0/0 del}
1175 VLIB_CLI_COMMAND (set_interface_ip6_vxlan_bypass_command, static) = {
1176 .path = "set interface ip6 vxlan-bypass",
1177 .function = set_ip6_vxlan_bypass,
1178 .short_help = "set interface ip6 vxlan-bypass <interface> [del]",
1183 vnet_vxlan_add_del_rx_flow (u32 hw_if_index, u32 t_index, int is_add)
1185 vxlan_main_t *vxm = &vxlan_main;
1186 vxlan_tunnel_t *t = pool_elt_at_index (vxm->tunnels, t_index);
1187 vnet_main_t *vnm = vnet_get_main ();
1190 if (t->flow_index == ~0)
1192 vxlan_main_t *vxm = &vxlan_main;
1193 vnet_flow_t flow = {
1195 VNET_FLOW_ACTION_REDIRECT_TO_NODE | VNET_FLOW_ACTION_MARK |
1196 VNET_FLOW_ACTION_BUFFER_ADVANCE,
1197 .mark_flow_id = t->dev_instance + vxm->flow_id_start,
1198 .redirect_node_index = vxlan4_flow_input_node.index,
1199 .buffer_advance = sizeof (ethernet_header_t),
1200 .type = VNET_FLOW_TYPE_IP4_VXLAN,
1202 .protocol.prot = IP_PROTOCOL_UDP,
1203 .src_addr.addr = t->dst.ip4,
1204 .dst_addr.addr = t->src.ip4,
1205 .src_addr.mask.as_u32 = ~0,
1206 .dst_addr.mask.as_u32 = ~0,
1207 .dst_port.port = t->src_port,
1208 .dst_port.mask = 0xFF,
1213 vnet_flow_add (vnm, &flow, &t->flow_index);
1215 return vnet_flow_enable (vnm, t->flow_index, hw_if_index);
1217 /* flow index is removed when the tunnel is deleted */
1218 return vnet_flow_disable (vnm, t->flow_index, hw_if_index);
1222 vnet_vxlan_get_tunnel_index (u32 sw_if_index)
1224 vxlan_main_t *vxm = &vxlan_main;
1226 if (sw_if_index >= vec_len (vxm->tunnel_index_by_sw_if_index))
1228 return vxm->tunnel_index_by_sw_if_index[sw_if_index];
1231 static clib_error_t *
1232 vxlan_offload_command_fn (vlib_main_t * vm,
1233 unformat_input_t * input, vlib_cli_command_t * cmd)
1235 unformat_input_t _line_input, *line_input = &_line_input;
1237 /* Get a line of input. */
1238 if (!unformat_user (input, unformat_line_input, line_input))
1241 vnet_main_t *vnm = vnet_get_main ();
1242 u32 rx_sw_if_index = ~0;
1243 u32 hw_if_index = ~0;
1246 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1248 if (unformat (line_input, "hw %U", unformat_vnet_hw_interface, vnm,
1251 if (unformat (line_input, "rx %U", unformat_vnet_sw_interface, vnm,
1254 if (unformat (line_input, "del"))
1259 return clib_error_return (0, "unknown input `%U'",
1260 format_unformat_error, line_input);
1263 if (rx_sw_if_index == ~0)
1264 return clib_error_return (0, "missing rx interface");
1265 if (hw_if_index == ~0)
1266 return clib_error_return (0, "missing hw interface");
1268 u32 t_index = vnet_vxlan_get_tunnel_index (rx_sw_if_index);;
1270 return clib_error_return (0, "%U is not a vxlan tunnel",
1271 format_vnet_sw_if_index_name, vnm,
1274 vxlan_main_t *vxm = &vxlan_main;
1275 vxlan_tunnel_t *t = pool_elt_at_index (vxm->tunnels, t_index);
1277 if (!ip46_address_is_ip4 (&t->dst))
1278 return clib_error_return (0, "currently only IPV4 tunnels are supported");
1280 vnet_hw_interface_t *hw_if = vnet_get_hw_interface (vnm, hw_if_index);
1281 ip4_main_t *im = &ip4_main;
1283 vec_elt (im->fib_index_by_sw_if_index, hw_if->sw_if_index);
1285 if (t->encap_fib_index != rx_fib_index)
1286 return clib_error_return (0, "interface/tunnel fib mismatch");
1288 if (vnet_vxlan_add_del_rx_flow (hw_if_index, t_index, is_add))
1289 return clib_error_return (0, "error %s flow",
1290 is_add ? "enabling" : "disabling");
1296 VLIB_CLI_COMMAND (vxlan_offload_command, static) = {
1297 .path = "set flow-offload vxlan",
1299 "set flow-offload vxlan hw <interface-name> rx <tunnel-name> [del]",
1300 .function = vxlan_offload_command_fn,
1304 #define VXLAN_HASH_NUM_BUCKETS (2 * 1024)
1305 #define VXLAN_HASH_MEMORY_SIZE (1 << 20)
1308 vxlan_init (vlib_main_t * vm)
1310 vxlan_main_t *vxm = &vxlan_main;
1312 vxm->vnet_main = vnet_get_main ();
1313 vxm->vlib_main = vm;
1315 vnet_flow_get_range (vxm->vnet_main, "vxlan", 1024 * 1024,
1316 &vxm->flow_id_start);
1318 vxm->bm_ip4_bypass_enabled_by_sw_if = 0;
1319 vxm->bm_ip6_bypass_enabled_by_sw_if = 0;
1321 /* initialize the ip6 hash */
1322 clib_bihash_init_16_8 (&vxm->vxlan4_tunnel_by_key, "vxlan4",
1323 VXLAN_HASH_NUM_BUCKETS, VXLAN_HASH_MEMORY_SIZE);
1324 clib_bihash_init_24_8 (&vxm->vxlan6_tunnel_by_key, "vxlan6",
1325 VXLAN_HASH_NUM_BUCKETS, VXLAN_HASH_MEMORY_SIZE);
1326 vxm->vtep_table = vtep_table_create ();
1327 vxm->mcast_shared = hash_create_mem (0,
1328 sizeof (ip46_address_t),
1329 sizeof (mcast_shared_t));
1331 fib_node_register_type (FIB_NODE_TYPE_VXLAN_TUNNEL, &vxlan_vft);
1336 VLIB_INIT_FUNCTION (vxlan_init);
1339 * fd.io coding-style-patch-verification: ON
1342 * eval: (c-set-style "gnu")