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 vni %d fib-idx %d sw-if-idx %d ",
74 t->dev_instance, t->user_instance,
75 format_ip46_address, &t->src, IP46_TYPE_ANY,
76 format_ip46_address, &t->dst, IP46_TYPE_ANY,
77 t->vni, t->encap_fib_index, t->sw_if_index);
79 s = format (s, "encap-dpo-idx %d ", t->next_dpo.dpoi_index);
81 if (PREDICT_FALSE (t->decap_next_index != VXLAN_INPUT_NEXT_L2_INPUT))
82 s = format (s, "decap-next-%U ", format_decap_next, t->decap_next_index);
84 if (PREDICT_FALSE (ip46_address_is_multicast (&t->dst)))
85 s = format (s, "mcast-sw-if-idx %d ", t->mcast_sw_if_index);
87 if (t->flow_index != ~0)
88 s = format (s, "flow-index %d [%U]", t->flow_index,
89 format_flow_enabled_hw, t->flow_index);
95 format_vxlan_name (u8 * s, va_list * args)
97 u32 dev_instance = va_arg (*args, u32);
98 vxlan_main_t *vxm = &vxlan_main;
101 if (dev_instance == ~0)
102 return format (s, "<cached-unused>");
104 if (dev_instance >= vec_len (vxm->tunnels))
105 return format (s, "<improperly-referenced>");
107 t = pool_elt_at_index (vxm->tunnels, dev_instance);
109 return format (s, "vxlan_tunnel%d", t->user_instance);
112 static clib_error_t *
113 vxlan_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
115 u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
116 VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
117 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
119 return /* no error */ 0;
123 VNET_DEVICE_CLASS (vxlan_device_class, static) = {
125 .format_device_name = format_vxlan_name,
126 .format_tx_trace = format_vxlan_encap_trace,
127 .admin_up_down_function = vxlan_interface_admin_up_down,
132 format_vxlan_header_with_length (u8 * s, va_list * args)
134 u32 dev_instance = va_arg (*args, u32);
135 s = format (s, "unimplemented dev %u", dev_instance);
140 VNET_HW_INTERFACE_CLASS (vxlan_hw_class) = {
142 .format_header = format_vxlan_header_with_length,
143 .build_rewrite = default_build_rewrite,
148 vxlan_tunnel_restack_dpo (vxlan_tunnel_t * t)
150 u8 is_ip4 = ip46_address_is_ip4 (&t->dst);
151 dpo_id_t dpo = DPO_INVALID;
152 fib_forward_chain_type_t forw_type = is_ip4 ?
153 FIB_FORW_CHAIN_TYPE_UNICAST_IP4 : FIB_FORW_CHAIN_TYPE_UNICAST_IP6;
155 fib_entry_contribute_forwarding (t->fib_entry_index, forw_type, &dpo);
157 /* vxlan uses the payload hash as the udp source port
158 * hence the packet's hash is unknown
159 * skip single bucket load balance dpo's */
160 while (DPO_LOAD_BALANCE == dpo.dpoi_type)
162 const load_balance_t *lb;
163 const dpo_id_t *choice;
165 lb = load_balance_get (dpo.dpoi_index);
166 if (lb->lb_n_buckets > 1)
169 choice = load_balance_get_bucket_i (lb, 0);
171 if (DPO_RECEIVE == choice->dpoi_type)
172 dpo_copy (&dpo, drop_dpo_get (choice->dpoi_proto));
174 dpo_copy (&dpo, choice);
177 u32 encap_index = is_ip4 ?
178 vxlan4_encap_node.index : vxlan6_encap_node.index;
179 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
183 static vxlan_tunnel_t *
184 vxlan_tunnel_from_fib_node (fib_node_t * node)
186 ASSERT (FIB_NODE_TYPE_VXLAN_TUNNEL == node->fn_type);
187 return ((vxlan_tunnel_t *) (((char *) node) -
188 STRUCT_OFFSET_OF (vxlan_tunnel_t, node)));
192 * Function definition to backwalk a FIB node -
193 * Here we will restack the new dpo of VXLAN DIP to encap node.
195 static fib_node_back_walk_rc_t
196 vxlan_tunnel_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
198 vxlan_tunnel_restack_dpo (vxlan_tunnel_from_fib_node (node));
199 return (FIB_NODE_BACK_WALK_CONTINUE);
203 * Function definition to get a FIB node from its index
206 vxlan_tunnel_fib_node_get (fib_node_index_t index)
209 vxlan_main_t *vxm = &vxlan_main;
211 t = pool_elt_at_index (vxm->tunnels, index);
217 * Function definition to inform the FIB node that its last lock has gone.
220 vxlan_tunnel_last_lock_gone (fib_node_t * node)
223 * The VXLAN tunnel is a root of the graph. As such
224 * it never has children and thus is never locked.
230 * Virtual function table registered by VXLAN tunnels
231 * for participation in the FIB object graph.
233 const static fib_node_vft_t vxlan_vft = {
234 .fnv_get = vxlan_tunnel_fib_node_get,
235 .fnv_last_lock = vxlan_tunnel_last_lock_gone,
236 .fnv_back_walk = vxlan_tunnel_back_walk,
240 #define foreach_copy_field \
242 _(mcast_sw_if_index) \
244 _(decap_next_index) \
249 vxlan_rewrite (vxlan_tunnel_t * t, bool is_ip6)
253 ip4_vxlan_header_t h4;
254 ip6_vxlan_header_t h6;
256 int len = is_ip6 ? sizeof h.h6 : sizeof h.h4;
259 vxlan_header_t *vxlan;
260 /* Fixed portion of the (outer) ip header */
262 clib_memset (&h, 0, sizeof (h));
265 ip4_header_t *ip = &h.h4.ip4;
266 udp = &h.h4.udp, vxlan = &h.h4.vxlan;
267 ip->ip_version_and_header_length = 0x45;
269 ip->protocol = IP_PROTOCOL_UDP;
271 ip->src_address = t->src.ip4;
272 ip->dst_address = t->dst.ip4;
274 /* we fix up the ip4 header length and checksum after-the-fact */
275 ip->checksum = ip4_header_checksum (ip);
279 ip6_header_t *ip = &h.h6.ip6;
280 udp = &h.h6.udp, vxlan = &h.h6.vxlan;
281 ip->ip_version_traffic_class_and_flow_label =
282 clib_host_to_net_u32 (6 << 28);
284 ip->protocol = IP_PROTOCOL_UDP;
286 ip->src_address = t->src.ip6;
287 ip->dst_address = t->dst.ip6;
290 /* UDP header, randomize src port on something, maybe? */
291 udp->src_port = clib_host_to_net_u16 (4789);
292 udp->dst_port = clib_host_to_net_u16 (UDP_DST_PORT_vxlan);
295 vnet_set_vni_and_flags (vxlan, t->vni);
296 vnet_rewrite_set_data (*t, &h, len);
300 vxlan_decap_next_is_valid (vxlan_main_t * vxm, u32 is_ip6,
301 u32 decap_next_index)
303 vlib_main_t *vm = vxm->vlib_main;
304 u32 input_idx = (!is_ip6) ?
305 vxlan4_input_node.index : vxlan6_input_node.index;
306 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, input_idx);
308 return decap_next_index < r->n_next_nodes;
312 typedef CLIB_PACKED(union
316 fib_node_index_t mfib_entry_index;
317 adj_index_t mcast_adj_index;
323 static inline mcast_shared_t
324 mcast_shared_get (ip46_address_t * ip)
326 ASSERT (ip46_address_is_multicast (ip));
327 uword *p = hash_get_mem (vxlan_main.mcast_shared, ip);
329 mcast_shared_t ret = {.as_u64 = *p };
334 mcast_shared_add (ip46_address_t * dst, fib_node_index_t mfei, adj_index_t ai)
336 mcast_shared_t new_ep = {
337 .mcast_adj_index = ai,
338 .mfib_entry_index = mfei,
341 hash_set_mem_alloc (&vxlan_main.mcast_shared, dst, new_ep.as_u64);
345 mcast_shared_remove (ip46_address_t * dst)
347 mcast_shared_t ep = mcast_shared_get (dst);
349 adj_unlock (ep.mcast_adj_index);
350 mfib_table_entry_delete_index (ep.mfib_entry_index, MFIB_SOURCE_VXLAN);
352 hash_unset_mem_free (&vxlan_main.mcast_shared, dst);
355 int vnet_vxlan_add_del_tunnel
356 (vnet_vxlan_add_del_tunnel_args_t * a, u32 * sw_if_indexp)
358 vxlan_main_t *vxm = &vxlan_main;
359 vnet_main_t *vnm = vxm->vnet_main;
360 vxlan_decap_info_t *p;
361 u32 sw_if_index = ~0;
362 vxlan4_tunnel_key_t key4;
363 vxlan6_tunnel_key_t key6;
364 u32 is_ip6 = a->is_ip6;
365 vlib_main_t *vm = vlib_get_main ();
371 /* ip4 mcast is indexed by mcast addr only */
372 key4.key[0] = ip46_address_is_multicast (&a->dst) ?
374 a->dst.ip4.as_u32 | (((u64) a->src.ip4.as_u32) << 32);
375 key4.key[1] = (((u64) a->encap_fib_index) << 32)
376 | clib_host_to_net_u32 (a->vni << 8);
378 clib_bihash_search_inline_16_8 (&vxm->vxlan4_tunnel_by_key, &key4);
379 p = (void *) &key4.value;
383 key6.key[0] = a->dst.ip6.as_u64[0];
384 key6.key[1] = a->dst.ip6.as_u64[1];
385 key6.key[2] = (((u64) a->encap_fib_index) << 32)
386 | clib_host_to_net_u32 (a->vni << 8);
388 clib_bihash_search_inline_24_8 (&vxm->vxlan6_tunnel_by_key, &key6);
389 p = (void *) &key6.value;
397 l2input_main_t *l2im = &l2input_main;
398 u32 dev_instance; /* real dev instance tunnel index */
399 u32 user_instance; /* request and actual instance number */
401 /* adding a tunnel: tunnel must not already exist */
403 return VNET_API_ERROR_TUNNEL_EXIST;
405 /*if not set explicitly, default to l2 */
406 if (a->decap_next_index == ~0)
407 a->decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
408 if (!vxlan_decap_next_is_valid (vxm, is_ip6, a->decap_next_index))
409 return VNET_API_ERROR_INVALID_DECAP_NEXT;
412 pool_get_aligned (vxm->tunnels, t, CLIB_CACHE_LINE_BYTES);
413 clib_memset (t, 0, sizeof (*t));
414 dev_instance = t - vxm->tunnels;
416 /* copy from arg structure */
417 #define _(x) t->x = a->x;
421 vxlan_rewrite (t, is_ip6);
423 * Reconcile the real dev_instance and a possible requested instance.
425 user_instance = a->instance;
426 if (user_instance == ~0)
427 user_instance = dev_instance;
428 if (hash_get (vxm->instance_used, user_instance))
430 pool_put (vxm->tunnels, t);
431 return VNET_API_ERROR_INSTANCE_IN_USE;
434 f64 now = vlib_time_now (vm);
436 rnd = (u32) (now * 1e6);
437 rnd = random_u32 (&rnd);
439 memcpy (hw_addr + 2, &rnd, sizeof (rnd));
443 hash_set (vxm->instance_used, user_instance, 1);
445 t->dev_instance = dev_instance; /* actual */
446 t->user_instance = user_instance; /* name */
449 if (ethernet_register_interface (vnm, vxlan_device_class.index,
450 dev_instance, hw_addr, &t->hw_if_index,
451 vxlan_eth_flag_change))
453 hash_unset (vxm->instance_used, t->user_instance);
455 pool_put (vxm->tunnels, t);
456 return VNET_API_ERROR_SYSCALL_ERROR_2;
459 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, t->hw_if_index);
461 /* Set vxlan tunnel output node */
462 u32 encap_index = !is_ip6 ?
463 vxlan4_encap_node.index : vxlan6_encap_node.index;
464 vnet_set_interface_output_node (vnm, t->hw_if_index, encap_index);
466 t->sw_if_index = sw_if_index = hi->sw_if_index;
472 key6.value = (u64) dev_instance;
473 add_failed = clib_bihash_add_del_24_8 (&vxm->vxlan6_tunnel_by_key,
478 vxlan_decap_info_t di = {.sw_if_index = t->sw_if_index, };
479 if (ip46_address_is_multicast (&t->dst))
480 di.local_ip = t->src.ip4;
482 di.next_index = t->decap_next_index;
483 key4.value = di.as_u64;
484 add_failed = clib_bihash_add_del_16_8 (&vxm->vxlan4_tunnel_by_key,
490 ethernet_delete_interface (vnm, t->hw_if_index);
491 hash_unset (vxm->instance_used, t->user_instance);
492 pool_put (vxm->tunnels, t);
493 return VNET_API_ERROR_INVALID_REGISTRATION;
496 vec_validate_init_empty (vxm->tunnel_index_by_sw_if_index, sw_if_index,
498 vxm->tunnel_index_by_sw_if_index[sw_if_index] = dev_instance;
500 /* setup l2 input config with l2 feature and bd 0 to drop packet */
501 vec_validate (l2im->configs, sw_if_index);
502 l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
503 l2im->configs[sw_if_index].bd_index = 0;
505 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
506 si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
507 vnet_sw_interface_set_flags (vnm, sw_if_index,
508 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
510 fib_node_init (&t->node, FIB_NODE_TYPE_VXLAN_TUNNEL);
511 fib_prefix_t tun_dst_pfx;
512 vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
514 fib_prefix_from_ip46_addr (&t->dst, &tun_dst_pfx);
515 if (!ip46_address_is_multicast (&t->dst))
518 * source the FIB entry for the tunnel's destination
519 * and become a child thereof. The tunnel will then get poked
520 * when the forwarding for the entry updates, and the tunnel can
521 * re-stack accordingly
523 vtep_addr_ref (&vxm->vtep_table, t->encap_fib_index, &t->src);
524 t->fib_entry_index = fib_entry_track (t->encap_fib_index,
526 FIB_NODE_TYPE_VXLAN_TUNNEL,
529 vxlan_tunnel_restack_dpo (t);
533 /* Multicast tunnel -
534 * as the same mcast group can be used for multiple mcast tunnels
535 * with different VNIs, create the output fib adjacency only if
536 * it does not already exist
538 fib_protocol_t fp = fib_ip_proto (is_ip6);
540 if (vtep_addr_ref (&vxm->vtep_table,
541 t->encap_fib_index, &t->dst) == 1)
543 fib_node_index_t mfei;
545 fib_route_path_t path = {
546 .frp_proto = fib_proto_to_dpo (fp),
547 .frp_addr = zero_addr,
548 .frp_sw_if_index = 0xffffffff,
551 .frp_flags = FIB_ROUTE_PATH_LOCAL,
552 .frp_mitf_flags = MFIB_ITF_FLAG_FORWARD,
554 const mfib_prefix_t mpfx = {
556 .fp_len = (is_ip6 ? 128 : 32),
557 .fp_grp_addr = tun_dst_pfx.fp_addr,
561 * Setup the (*,G) to receive traffic on the mcast group
562 * - the forwarding interface is for-us
563 * - the accepting interface is that from the API
565 mfib_table_entry_path_update (t->encap_fib_index,
566 &mpfx, MFIB_SOURCE_VXLAN, &path);
568 path.frp_sw_if_index = a->mcast_sw_if_index;
569 path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
570 path.frp_mitf_flags = MFIB_ITF_FLAG_ACCEPT;
571 mfei = mfib_table_entry_path_update (t->encap_fib_index,
573 MFIB_SOURCE_VXLAN, &path);
576 * Create the mcast adjacency to send traffic to the group
578 ai = adj_mcast_add_or_lock (fp,
579 fib_proto_to_link (fp),
580 a->mcast_sw_if_index);
583 * create a new end-point
585 mcast_shared_add (&t->dst, mfei, ai);
588 dpo_id_t dpo = DPO_INVALID;
589 mcast_shared_t ep = mcast_shared_get (&t->dst);
591 /* Stack shared mcast dst mac addr rewrite on encap */
592 dpo_set (&dpo, DPO_ADJACENCY_MCAST,
593 fib_proto_to_dpo (fp), ep.mcast_adj_index);
595 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
597 flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
600 vnet_get_sw_interface (vnet_get_main (), sw_if_index)->flood_class =
605 /* deleting a tunnel: tunnel must exist */
607 return VNET_API_ERROR_NO_SUCH_ENTRY;
609 u32 instance = is_ip6 ? key6.value :
610 vxm->tunnel_index_by_sw_if_index[p->sw_if_index];
611 vxlan_tunnel_t *t = pool_elt_at_index (vxm->tunnels, instance);
613 sw_if_index = t->sw_if_index;
614 vnet_sw_interface_set_flags (vnm, sw_if_index, 0 /* down */ );
616 vxm->tunnel_index_by_sw_if_index[sw_if_index] = ~0;
619 clib_bihash_add_del_16_8 (&vxm->vxlan4_tunnel_by_key, &key4,
622 clib_bihash_add_del_24_8 (&vxm->vxlan6_tunnel_by_key, &key6,
625 if (!ip46_address_is_multicast (&t->dst))
627 if (t->flow_index != ~0)
628 vnet_flow_del (vnm, t->flow_index);
630 vtep_addr_unref (&vxm->vtep_table, t->encap_fib_index, &t->src);
631 fib_entry_untrack (t->fib_entry_index, t->sibling_index);
633 else if (vtep_addr_unref (&vxm->vtep_table,
634 t->encap_fib_index, &t->dst) == 0)
636 mcast_shared_remove (&t->dst);
639 ethernet_delete_interface (vnm, t->hw_if_index);
640 hash_unset (vxm->instance_used, t->user_instance);
642 fib_node_deinit (&t->node);
643 pool_put (vxm->tunnels, t);
647 *sw_if_indexp = sw_if_index;
651 /* register udp ports */
652 if (!is_ip6 && !udp_is_valid_dst_port (UDP_DST_PORT_vxlan, 1))
653 udp_register_dst_port (vxm->vlib_main, UDP_DST_PORT_vxlan,
654 vxlan4_input_node.index, 1);
655 if (is_ip6 && !udp_is_valid_dst_port (UDP_DST_PORT_vxlan6, 0))
656 udp_register_dst_port (vxm->vlib_main, UDP_DST_PORT_vxlan6,
657 vxlan6_input_node.index, 0);
664 get_decap_next_for_node (u32 node_index, u32 ipv4_set)
666 vxlan_main_t *vxm = &vxlan_main;
667 vlib_main_t *vm = vxm->vlib_main;
668 uword input_node = (ipv4_set) ? vxlan4_input_node.index :
669 vxlan6_input_node.index;
671 return vlib_node_add_next (vm, input_node, node_index);
675 unformat_decap_next (unformat_input_t * input, va_list * args)
677 u32 *result = va_arg (*args, u32 *);
678 u32 ipv4_set = va_arg (*args, int);
679 vxlan_main_t *vxm = &vxlan_main;
680 vlib_main_t *vm = vxm->vlib_main;
684 if (unformat (input, "l2"))
685 *result = VXLAN_INPUT_NEXT_L2_INPUT;
686 else if (unformat (input, "node %U", unformat_vlib_node, vm, &node_index))
687 *result = get_decap_next_for_node (node_index, ipv4_set);
688 else if (unformat (input, "%d", &tmp))
695 static clib_error_t *
696 vxlan_add_del_tunnel_command_fn (vlib_main_t * vm,
697 unformat_input_t * input,
698 vlib_cli_command_t * cmd)
700 unformat_input_t _line_input, *line_input = &_line_input;
701 ip46_address_t src = ip46_address_initializer, dst =
702 ip46_address_initializer;
710 u32 encap_fib_index = 0;
711 u32 mcast_sw_if_index = ~0;
712 u32 decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
715 clib_error_t *parse_error = NULL;
717 /* Get a line of input. */
718 if (!unformat_user (input, unformat_line_input, line_input))
721 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
723 if (unformat (line_input, "del"))
727 else if (unformat (line_input, "instance %d", &instance))
729 else if (unformat (line_input, "src %U",
730 unformat_ip46_address, &src, IP46_TYPE_ANY))
733 ip46_address_is_ip4 (&src) ? (ipv4_set = 1) : (ipv6_set = 1);
735 else if (unformat (line_input, "dst %U",
736 unformat_ip46_address, &dst, IP46_TYPE_ANY))
739 ip46_address_is_ip4 (&dst) ? (ipv4_set = 1) : (ipv6_set = 1);
741 else if (unformat (line_input, "group %U %U",
742 unformat_ip46_address, &dst, IP46_TYPE_ANY,
743 unformat_vnet_sw_interface,
744 vnet_get_main (), &mcast_sw_if_index))
746 grp_set = dst_set = 1;
747 ip46_address_is_ip4 (&dst) ? (ipv4_set = 1) : (ipv6_set = 1);
749 else if (unformat (line_input, "encap-vrf-id %d", &table_id))
752 fib_table_find (fib_ip_proto (ipv6_set), table_id);
754 else if (unformat (line_input, "decap-next %U", unformat_decap_next,
755 &decap_next_index, ipv4_set))
757 else if (unformat (line_input, "vni %d", &vni))
761 parse_error = clib_error_return (0, "parse error: '%U'",
762 format_unformat_error, line_input);
767 unformat_free (line_input);
772 if (encap_fib_index == ~0)
773 return clib_error_return (0, "nonexistent encap-vrf-id %d", table_id);
776 return clib_error_return (0, "tunnel src address not specified");
779 return clib_error_return (0, "tunnel dst address not specified");
781 if (grp_set && !ip46_address_is_multicast (&dst))
782 return clib_error_return (0, "tunnel group address not multicast");
784 if (grp_set == 0 && ip46_address_is_multicast (&dst))
785 return clib_error_return (0, "dst address must be unicast");
787 if (grp_set && mcast_sw_if_index == ~0)
788 return clib_error_return (0, "tunnel nonexistent multicast device");
790 if (ipv4_set && ipv6_set)
791 return clib_error_return (0, "both IPv4 and IPv6 addresses specified");
793 if (ip46_address_cmp (&src, &dst) == 0)
794 return clib_error_return (0, "src and dst addresses are identical");
796 if (decap_next_index == ~0)
797 return clib_error_return (0, "next node not found");
800 return clib_error_return (0, "vni not specified");
803 return clib_error_return (0, "vni %d out of range", vni);
805 vnet_vxlan_add_del_tunnel_args_t a = {
808 .instance = instance,
814 u32 tunnel_sw_if_index;
815 int rv = vnet_vxlan_add_del_tunnel (&a, &tunnel_sw_if_index);
821 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
822 vnet_get_main (), tunnel_sw_if_index);
825 case VNET_API_ERROR_TUNNEL_EXIST:
826 return clib_error_return (0, "tunnel already exists...");
828 case VNET_API_ERROR_NO_SUCH_ENTRY:
829 return clib_error_return (0, "tunnel does not exist...");
831 case VNET_API_ERROR_INSTANCE_IN_USE:
832 return clib_error_return (0, "Instance is in use");
835 return clib_error_return
836 (0, "vnet_vxlan_add_del_tunnel returned %d", rv);
843 * Add or delete a VXLAN Tunnel.
845 * VXLAN provides the features needed to allow L2 bridge domains (BDs)
846 * to span multiple servers. This is done by building an L2 overlay on
847 * top of an L3 network underlay using VXLAN tunnels.
849 * This makes it possible for servers to be co-located in the same data
850 * center or be separated geographically as long as they are reachable
851 * through the underlay L3 network.
853 * You can refer to this kind of L2 overlay bridge domain as a VXLAN
854 * (Virtual eXtensible VLAN) segment.
857 * Example of how to create a VXLAN Tunnel:
858 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 encap-vrf-id 7}
859 * Example of how to create a VXLAN Tunnel with a known name, vxlan_tunnel42:
860 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 instance 42}
861 * Example of how to create a multicast VXLAN Tunnel with a known name, vxlan_tunnel23:
862 * @cliexcmd{create vxlan tunnel src 10.0.3.1 group 239.1.1.1 GigabitEthernet0/8/0 instance 23}
863 * Example of how to delete a VXLAN Tunnel:
864 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 del}
867 VLIB_CLI_COMMAND (create_vxlan_tunnel_command, static) = {
868 .path = "create vxlan tunnel",
870 "create vxlan tunnel src <local-vtep-addr>"
871 " {dst <remote-vtep-addr>|group <mcast-vtep-addr> <intf-name>} vni <nn>"
873 " [encap-vrf-id <nn>] [decap-next [l2|node <name>]] [del]",
874 .function = vxlan_add_del_tunnel_command_fn,
878 static clib_error_t *
879 show_vxlan_tunnel_command_fn (vlib_main_t * vm,
880 unformat_input_t * input,
881 vlib_cli_command_t * cmd)
883 vxlan_main_t *vxm = &vxlan_main;
887 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
889 if (unformat (input, "raw"))
892 return clib_error_return (0, "parse error: '%U'",
893 format_unformat_error, input);
896 if (pool_elts (vxm->tunnels) == 0)
897 vlib_cli_output (vm, "No vxlan tunnels configured...");
900 pool_foreach (t, vxm->tunnels)
902 vlib_cli_output (vm, "%U", format_vxlan_tunnel, t);
908 vlib_cli_output (vm, "Raw IPv4 Hash Table:\n%U\n",
909 format_bihash_16_8, &vxm->vxlan4_tunnel_by_key,
911 vlib_cli_output (vm, "Raw IPv6 Hash Table:\n%U\n",
912 format_bihash_24_8, &vxm->vxlan6_tunnel_by_key,
920 * Display all the VXLAN Tunnel entries.
923 * Example of how to display the VXLAN Tunnel entries:
924 * @cliexstart{show vxlan tunnel}
925 * [0] src 10.0.3.1 dst 10.0.3.3 vni 13 encap_fib_index 0 sw_if_index 5 decap_next l2
929 VLIB_CLI_COMMAND (show_vxlan_tunnel_command, static) = {
930 .path = "show vxlan tunnel",
931 .short_help = "show vxlan tunnel [raw]",
932 .function = show_vxlan_tunnel_command_fn,
938 vnet_int_vxlan_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable)
940 vxlan_main_t *vxm = &vxlan_main;
942 if (pool_is_free_index (vxm->vnet_main->interface_main.sw_interfaces,
946 is_enable = ! !is_enable;
950 if (clib_bitmap_get (vxm->bm_ip6_bypass_enabled_by_sw_if, sw_if_index)
953 vnet_feature_enable_disable ("ip6-unicast", "ip6-vxlan-bypass",
954 sw_if_index, is_enable, 0, 0);
955 vxm->bm_ip6_bypass_enabled_by_sw_if =
956 clib_bitmap_set (vxm->bm_ip6_bypass_enabled_by_sw_if,
957 sw_if_index, is_enable);
962 if (clib_bitmap_get (vxm->bm_ip4_bypass_enabled_by_sw_if, sw_if_index)
965 vnet_feature_enable_disable ("ip4-unicast", "ip4-vxlan-bypass",
966 sw_if_index, is_enable, 0, 0);
967 vxm->bm_ip4_bypass_enabled_by_sw_if =
968 clib_bitmap_set (vxm->bm_ip4_bypass_enabled_by_sw_if,
969 sw_if_index, is_enable);
975 static clib_error_t *
976 set_ip_vxlan_bypass (u32 is_ip6,
977 unformat_input_t * input, vlib_cli_command_t * cmd)
979 unformat_input_t _line_input, *line_input = &_line_input;
980 vnet_main_t *vnm = vnet_get_main ();
981 clib_error_t *error = 0;
982 u32 sw_if_index, is_enable;
987 if (!unformat_user (input, unformat_line_input, line_input))
990 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
993 (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
995 else if (unformat (line_input, "del"))
999 error = unformat_parse_error (line_input);
1004 if (~0 == sw_if_index)
1006 error = clib_error_return (0, "unknown interface `%U'",
1007 format_unformat_error, line_input);
1011 vnet_int_vxlan_bypass_mode (sw_if_index, is_ip6, is_enable);
1014 unformat_free (line_input);
1019 static clib_error_t *
1020 set_ip4_vxlan_bypass (vlib_main_t * vm,
1021 unformat_input_t * input, vlib_cli_command_t * cmd)
1023 return set_ip_vxlan_bypass (0, input, cmd);
1027 * This command adds the 'ip4-vxlan-bypass' graph node for a given interface.
1028 * By adding the IPv4 vxlan-bypass graph node to an interface, the node checks
1029 * for and validate input vxlan packet and bypass ip4-lookup, ip4-local,
1030 * ip4-udp-lookup nodes to speedup vxlan packet forwarding. This node will
1031 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
1035 * Example of graph node before ip4-vxlan-bypass is enabled:
1036 * @cliexstart{show vlib graph ip4-vxlan-bypass}
1037 * Name Next Previous
1038 * ip4-vxlan-bypass error-drop [0]
1043 * Example of how to enable ip4-vxlan-bypass on an interface:
1044 * @cliexcmd{set interface ip vxlan-bypass GigabitEthernet2/0/0}
1046 * Example of graph node after ip4-vxlan-bypass is enabled:
1047 * @cliexstart{show vlib graph ip4-vxlan-bypass}
1048 * Name Next Previous
1049 * ip4-vxlan-bypass error-drop [0] ip4-input
1050 * vxlan4-input [1] ip4-input-no-checksum
1054 * Example of how to display the feature enabled on an interface:
1055 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1056 * IP feature paths configured on GigabitEthernet2/0/0...
1064 * Example of how to disable ip4-vxlan-bypass on an interface:
1065 * @cliexcmd{set interface ip vxlan-bypass GigabitEthernet2/0/0 del}
1069 VLIB_CLI_COMMAND (set_interface_ip_vxlan_bypass_command, static) = {
1070 .path = "set interface ip vxlan-bypass",
1071 .function = set_ip4_vxlan_bypass,
1072 .short_help = "set interface ip vxlan-bypass <interface> [del]",
1076 static clib_error_t *
1077 set_ip6_vxlan_bypass (vlib_main_t * vm,
1078 unformat_input_t * input, vlib_cli_command_t * cmd)
1080 return set_ip_vxlan_bypass (1, input, cmd);
1084 * This command adds the 'ip6-vxlan-bypass' graph node for a given interface.
1085 * By adding the IPv6 vxlan-bypass graph node to an interface, the node checks
1086 * for and validate input vxlan packet and bypass ip6-lookup, ip6-local,
1087 * ip6-udp-lookup nodes to speedup vxlan packet forwarding. This node will
1088 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
1092 * Example of graph node before ip6-vxlan-bypass is enabled:
1093 * @cliexstart{show vlib graph ip6-vxlan-bypass}
1094 * Name Next Previous
1095 * ip6-vxlan-bypass error-drop [0]
1100 * Example of how to enable ip6-vxlan-bypass on an interface:
1101 * @cliexcmd{set interface ip6 vxlan-bypass GigabitEthernet2/0/0}
1103 * Example of graph node after ip6-vxlan-bypass is enabled:
1104 * @cliexstart{show vlib graph ip6-vxlan-bypass}
1105 * Name Next Previous
1106 * ip6-vxlan-bypass error-drop [0] ip6-input
1107 * vxlan6-input [1] ip4-input-no-checksum
1111 * Example of how to display the feature enabled on an interface:
1112 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1113 * IP feature paths configured on GigabitEthernet2/0/0...
1121 * Example of how to disable ip6-vxlan-bypass on an interface:
1122 * @cliexcmd{set interface ip6 vxlan-bypass GigabitEthernet2/0/0 del}
1126 VLIB_CLI_COMMAND (set_interface_ip6_vxlan_bypass_command, static) = {
1127 .path = "set interface ip6 vxlan-bypass",
1128 .function = set_ip6_vxlan_bypass,
1129 .short_help = "set interface ip6 vxlan-bypass <interface> [del]",
1134 vnet_vxlan_add_del_rx_flow (u32 hw_if_index, u32 t_index, int is_add)
1136 vxlan_main_t *vxm = &vxlan_main;
1137 vxlan_tunnel_t *t = pool_elt_at_index (vxm->tunnels, t_index);
1138 vnet_main_t *vnm = vnet_get_main ();
1141 if (t->flow_index == ~0)
1143 vxlan_main_t *vxm = &vxlan_main;
1144 vnet_flow_t flow = {
1146 VNET_FLOW_ACTION_REDIRECT_TO_NODE | VNET_FLOW_ACTION_MARK |
1147 VNET_FLOW_ACTION_BUFFER_ADVANCE,
1148 .mark_flow_id = t->dev_instance + vxm->flow_id_start,
1149 .redirect_node_index = vxlan4_flow_input_node.index,
1150 .buffer_advance = sizeof (ethernet_header_t),
1151 .type = VNET_FLOW_TYPE_IP4_VXLAN,
1153 .protocol.prot = IP_PROTOCOL_UDP,
1154 .src_addr.addr = t->dst.ip4,
1155 .dst_addr.addr = t->src.ip4,
1156 .src_addr.mask.as_u32 = ~0,
1157 .dst_addr.mask.as_u32 = ~0,
1158 .dst_port.port = UDP_DST_PORT_vxlan,
1159 .dst_port.mask = 0xFF,
1164 vnet_flow_add (vnm, &flow, &t->flow_index);
1166 return vnet_flow_enable (vnm, t->flow_index, hw_if_index);
1168 /* flow index is removed when the tunnel is deleted */
1169 return vnet_flow_disable (vnm, t->flow_index, hw_if_index);
1173 vnet_vxlan_get_tunnel_index (u32 sw_if_index)
1175 vxlan_main_t *vxm = &vxlan_main;
1177 if (sw_if_index >= vec_len (vxm->tunnel_index_by_sw_if_index))
1179 return vxm->tunnel_index_by_sw_if_index[sw_if_index];
1182 static clib_error_t *
1183 vxlan_offload_command_fn (vlib_main_t * vm,
1184 unformat_input_t * input, vlib_cli_command_t * cmd)
1186 unformat_input_t _line_input, *line_input = &_line_input;
1188 /* Get a line of input. */
1189 if (!unformat_user (input, unformat_line_input, line_input))
1192 vnet_main_t *vnm = vnet_get_main ();
1193 u32 rx_sw_if_index = ~0;
1194 u32 hw_if_index = ~0;
1197 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1199 if (unformat (line_input, "hw %U", unformat_vnet_hw_interface, vnm,
1202 if (unformat (line_input, "rx %U", unformat_vnet_sw_interface, vnm,
1205 if (unformat (line_input, "del"))
1210 return clib_error_return (0, "unknown input `%U'",
1211 format_unformat_error, line_input);
1214 if (rx_sw_if_index == ~0)
1215 return clib_error_return (0, "missing rx interface");
1216 if (hw_if_index == ~0)
1217 return clib_error_return (0, "missing hw interface");
1219 u32 t_index = vnet_vxlan_get_tunnel_index (rx_sw_if_index);;
1221 return clib_error_return (0, "%U is not a vxlan tunnel",
1222 format_vnet_sw_if_index_name, vnm,
1225 vxlan_main_t *vxm = &vxlan_main;
1226 vxlan_tunnel_t *t = pool_elt_at_index (vxm->tunnels, t_index);
1228 if (!ip46_address_is_ip4 (&t->dst))
1229 return clib_error_return (0, "currently only IPV4 tunnels are supported");
1231 vnet_hw_interface_t *hw_if = vnet_get_hw_interface (vnm, hw_if_index);
1232 ip4_main_t *im = &ip4_main;
1234 vec_elt (im->fib_index_by_sw_if_index, hw_if->sw_if_index);
1236 if (t->encap_fib_index != rx_fib_index)
1237 return clib_error_return (0, "interface/tunnel fib mismatch");
1239 if (vnet_vxlan_add_del_rx_flow (hw_if_index, t_index, is_add))
1240 return clib_error_return (0, "error %s flow",
1241 is_add ? "enabling" : "disabling");
1247 VLIB_CLI_COMMAND (vxlan_offload_command, static) = {
1248 .path = "set flow-offload vxlan",
1250 "set flow-offload vxlan hw <interface-name> rx <tunnel-name> [del]",
1251 .function = vxlan_offload_command_fn,
1255 #define VXLAN_HASH_NUM_BUCKETS (2 * 1024)
1256 #define VXLAN_HASH_MEMORY_SIZE (1 << 20)
1259 vxlan_init (vlib_main_t * vm)
1261 vxlan_main_t *vxm = &vxlan_main;
1263 vxm->vnet_main = vnet_get_main ();
1264 vxm->vlib_main = vm;
1266 vnet_flow_get_range (vxm->vnet_main, "vxlan", 1024 * 1024,
1267 &vxm->flow_id_start);
1269 vxm->bm_ip4_bypass_enabled_by_sw_if = 0;
1270 vxm->bm_ip6_bypass_enabled_by_sw_if = 0;
1272 /* initialize the ip6 hash */
1273 clib_bihash_init_16_8 (&vxm->vxlan4_tunnel_by_key, "vxlan4",
1274 VXLAN_HASH_NUM_BUCKETS, VXLAN_HASH_MEMORY_SIZE);
1275 clib_bihash_init_24_8 (&vxm->vxlan6_tunnel_by_key, "vxlan6",
1276 VXLAN_HASH_NUM_BUCKETS, VXLAN_HASH_MEMORY_SIZE);
1277 vxm->vtep_table = vtep_table_create ();
1278 vxm->mcast_shared = hash_create_mem (0,
1279 sizeof (ip46_address_t),
1280 sizeof (mcast_shared_t));
1282 fib_node_register_type (FIB_NODE_TYPE_VXLAN_TUNNEL, &vxlan_vft);
1287 VLIB_INIT_FUNCTION (vxlan_init);
1290 * fd.io coding-style-patch-verification: ON
1293 * eval: (c-set-style "gnu")