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 format_decap_next (u8 * s, va_list * args)
51 u32 next_index = va_arg (*args, u32);
53 if (next_index == VXLAN_INPUT_NEXT_DROP)
54 return format (s, "drop");
56 return format (s, "index %d", next_index);
61 format_vxlan_tunnel (u8 * s, va_list * args)
63 vxlan_tunnel_t *t = va_arg (*args, vxlan_tunnel_t *);
66 "[%d] instance %d src %U dst %U vni %d fib-idx %d sw-if-idx %d ",
67 t->dev_instance, t->user_instance,
68 format_ip46_address, &t->src, IP46_TYPE_ANY,
69 format_ip46_address, &t->dst, IP46_TYPE_ANY,
70 t->vni, t->encap_fib_index, t->sw_if_index);
72 s = format (s, "encap-dpo-idx %d ", t->next_dpo.dpoi_index);
74 if (PREDICT_FALSE (t->decap_next_index != VXLAN_INPUT_NEXT_L2_INPUT))
75 s = format (s, "decap-next-%U ", format_decap_next, t->decap_next_index);
77 if (PREDICT_FALSE (ip46_address_is_multicast (&t->dst)))
78 s = format (s, "mcast-sw-if-idx %d ", t->mcast_sw_if_index);
80 if (t->flow_index != ~0)
81 s = format (s, "flow-index %d [%U]", t->flow_index,
82 format_flow_enabled_hw, t->flow_index);
88 format_vxlan_name (u8 * s, va_list * args)
90 u32 dev_instance = va_arg (*args, u32);
91 vxlan_main_t *vxm = &vxlan_main;
94 if (dev_instance == ~0)
95 return format (s, "<cached-unused>");
97 if (dev_instance >= vec_len (vxm->tunnels))
98 return format (s, "<improperly-referenced>");
100 t = pool_elt_at_index (vxm->tunnels, dev_instance);
102 return format (s, "vxlan_tunnel%d", t->user_instance);
105 static clib_error_t *
106 vxlan_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
108 u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
109 VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
110 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
112 return /* no error */ 0;
116 VNET_DEVICE_CLASS (vxlan_device_class, static) = {
118 .format_device_name = format_vxlan_name,
119 .format_tx_trace = format_vxlan_encap_trace,
120 .admin_up_down_function = vxlan_interface_admin_up_down,
125 format_vxlan_header_with_length (u8 * s, va_list * args)
127 u32 dev_instance = va_arg (*args, u32);
128 s = format (s, "unimplemented dev %u", dev_instance);
133 VNET_HW_INTERFACE_CLASS (vxlan_hw_class) = {
135 .format_header = format_vxlan_header_with_length,
136 .build_rewrite = default_build_rewrite,
141 vxlan_tunnel_restack_dpo (vxlan_tunnel_t * t)
143 u8 is_ip4 = ip46_address_is_ip4 (&t->dst);
144 dpo_id_t dpo = DPO_INVALID;
145 fib_forward_chain_type_t forw_type = is_ip4 ?
146 FIB_FORW_CHAIN_TYPE_UNICAST_IP4 : FIB_FORW_CHAIN_TYPE_UNICAST_IP6;
148 fib_entry_contribute_forwarding (t->fib_entry_index, forw_type, &dpo);
150 /* vxlan uses the payload hash as the udp source port
151 * hence the packet's hash is unknown
152 * skip single bucket load balance dpo's */
153 while (DPO_LOAD_BALANCE == dpo.dpoi_type)
155 const load_balance_t *lb;
156 const dpo_id_t *choice;
158 lb = load_balance_get (dpo.dpoi_index);
159 if (lb->lb_n_buckets > 1)
162 choice = load_balance_get_bucket_i (lb, 0);
164 if (DPO_RECEIVE == choice->dpoi_type)
165 dpo_copy (&dpo, drop_dpo_get (choice->dpoi_proto));
167 dpo_copy (&dpo, choice);
170 u32 encap_index = is_ip4 ?
171 vxlan4_encap_node.index : vxlan6_encap_node.index;
172 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
176 static vxlan_tunnel_t *
177 vxlan_tunnel_from_fib_node (fib_node_t * node)
179 ASSERT (FIB_NODE_TYPE_VXLAN_TUNNEL == node->fn_type);
180 return ((vxlan_tunnel_t *) (((char *) node) -
181 STRUCT_OFFSET_OF (vxlan_tunnel_t, node)));
185 * Function definition to backwalk a FIB node -
186 * Here we will restack the new dpo of VXLAN DIP to encap node.
188 static fib_node_back_walk_rc_t
189 vxlan_tunnel_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
191 vxlan_tunnel_restack_dpo (vxlan_tunnel_from_fib_node (node));
192 return (FIB_NODE_BACK_WALK_CONTINUE);
196 * Function definition to get a FIB node from its index
199 vxlan_tunnel_fib_node_get (fib_node_index_t index)
202 vxlan_main_t *vxm = &vxlan_main;
204 t = pool_elt_at_index (vxm->tunnels, index);
210 * Function definition to inform the FIB node that its last lock has gone.
213 vxlan_tunnel_last_lock_gone (fib_node_t * node)
216 * The VXLAN tunnel is a root of the graph. As such
217 * it never has children and thus is never locked.
223 * Virtual function table registered by VXLAN tunnels
224 * for participation in the FIB object graph.
226 const static fib_node_vft_t vxlan_vft = {
227 .fnv_get = vxlan_tunnel_fib_node_get,
228 .fnv_last_lock = vxlan_tunnel_last_lock_gone,
229 .fnv_back_walk = vxlan_tunnel_back_walk,
233 #define foreach_copy_field \
235 _(mcast_sw_if_index) \
237 _(decap_next_index) \
242 vxlan_rewrite (vxlan_tunnel_t * t, bool is_ip6)
246 ip4_vxlan_header_t h4;
247 ip6_vxlan_header_t h6;
249 int len = is_ip6 ? sizeof h.h6 : sizeof h.h4;
252 vxlan_header_t *vxlan;
253 /* Fixed portion of the (outer) ip header */
255 clib_memset (&h, 0, sizeof (h));
258 ip4_header_t *ip = &h.h4.ip4;
259 udp = &h.h4.udp, vxlan = &h.h4.vxlan;
260 ip->ip_version_and_header_length = 0x45;
262 ip->protocol = IP_PROTOCOL_UDP;
264 ip->src_address = t->src.ip4;
265 ip->dst_address = t->dst.ip4;
267 /* we fix up the ip4 header length and checksum after-the-fact */
268 ip->checksum = ip4_header_checksum (ip);
272 ip6_header_t *ip = &h.h6.ip6;
273 udp = &h.h6.udp, vxlan = &h.h6.vxlan;
274 ip->ip_version_traffic_class_and_flow_label =
275 clib_host_to_net_u32 (6 << 28);
277 ip->protocol = IP_PROTOCOL_UDP;
279 ip->src_address = t->src.ip6;
280 ip->dst_address = t->dst.ip6;
283 /* UDP header, randomize src port on something, maybe? */
284 udp->src_port = clib_host_to_net_u16 (4789);
285 udp->dst_port = clib_host_to_net_u16 (UDP_DST_PORT_vxlan);
288 vnet_set_vni_and_flags (vxlan, t->vni);
289 vnet_rewrite_set_data (*t, &h, len);
293 vxlan_decap_next_is_valid (vxlan_main_t * vxm, u32 is_ip6,
294 u32 decap_next_index)
296 vlib_main_t *vm = vxm->vlib_main;
297 u32 input_idx = (!is_ip6) ?
298 vxlan4_input_node.index : vxlan6_input_node.index;
299 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, input_idx);
301 return decap_next_index < r->n_next_nodes;
305 typedef CLIB_PACKED(union
309 fib_node_index_t mfib_entry_index;
310 adj_index_t mcast_adj_index;
316 static inline mcast_shared_t
317 mcast_shared_get (ip46_address_t * ip)
319 ASSERT (ip46_address_is_multicast (ip));
320 uword *p = hash_get_mem (vxlan_main.mcast_shared, ip);
322 mcast_shared_t ret = {.as_u64 = *p };
327 mcast_shared_add (ip46_address_t * dst, fib_node_index_t mfei, adj_index_t ai)
329 mcast_shared_t new_ep = {
330 .mcast_adj_index = ai,
331 .mfib_entry_index = mfei,
334 hash_set_mem_alloc (&vxlan_main.mcast_shared, dst, new_ep.as_u64);
338 mcast_shared_remove (ip46_address_t * dst)
340 mcast_shared_t ep = mcast_shared_get (dst);
342 adj_unlock (ep.mcast_adj_index);
343 mfib_table_entry_delete_index (ep.mfib_entry_index, MFIB_SOURCE_VXLAN);
345 hash_unset_mem_free (&vxlan_main.mcast_shared, dst);
348 int vnet_vxlan_add_del_tunnel
349 (vnet_vxlan_add_del_tunnel_args_t * a, u32 * sw_if_indexp)
351 vxlan_main_t *vxm = &vxlan_main;
352 vnet_main_t *vnm = vxm->vnet_main;
353 vxlan_decap_info_t *p;
354 u32 sw_if_index = ~0;
355 vxlan4_tunnel_key_t key4;
356 vxlan6_tunnel_key_t key6;
357 u32 is_ip6 = a->is_ip6;
362 /* ip4 mcast is indexed by mcast addr only */
363 key4.key[0] = ip46_address_is_multicast (&a->dst) ?
365 a->dst.ip4.as_u32 | (((u64) a->src.ip4.as_u32) << 32);
366 key4.key[1] = (((u64) a->encap_fib_index) << 32)
367 | clib_host_to_net_u32 (a->vni << 8);
369 clib_bihash_search_inline_16_8 (&vxm->vxlan4_tunnel_by_key, &key4);
370 p = (void *) &key4.value;
374 key6.key[0] = a->dst.ip6.as_u64[0];
375 key6.key[1] = a->dst.ip6.as_u64[1];
376 key6.key[2] = (((u64) a->encap_fib_index) << 32)
377 | clib_host_to_net_u32 (a->vni << 8);
379 clib_bihash_search_inline_24_8 (&vxm->vxlan6_tunnel_by_key, &key6);
380 p = (void *) &key6.value;
388 l2input_main_t *l2im = &l2input_main;
389 u32 dev_instance; /* real dev instance tunnel index */
390 u32 user_instance; /* request and actual instance number */
392 /* adding a tunnel: tunnel must not already exist */
394 return VNET_API_ERROR_TUNNEL_EXIST;
396 /*if not set explicitly, default to l2 */
397 if (a->decap_next_index == ~0)
398 a->decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
399 if (!vxlan_decap_next_is_valid (vxm, is_ip6, a->decap_next_index))
400 return VNET_API_ERROR_INVALID_DECAP_NEXT;
403 pool_get_aligned (vxm->tunnels, t, CLIB_CACHE_LINE_BYTES);
404 clib_memset (t, 0, sizeof (*t));
405 dev_instance = t - vxm->tunnels;
407 /* copy from arg structure */
408 #define _(x) t->x = a->x;
412 vxlan_rewrite (t, is_ip6);
414 * Reconcile the real dev_instance and a possible requested instance.
416 user_instance = a->instance;
417 if (user_instance == ~0)
418 user_instance = dev_instance;
419 if (hash_get (vxm->instance_used, user_instance))
421 pool_put (vxm->tunnels, t);
422 return VNET_API_ERROR_INSTANCE_IN_USE;
424 hash_set (vxm->instance_used, user_instance, 1);
426 t->dev_instance = dev_instance; /* actual */
427 t->user_instance = user_instance; /* name */
430 t->hw_if_index = vnet_register_interface
431 (vnm, vxlan_device_class.index, dev_instance,
432 vxlan_hw_class.index, dev_instance);
433 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, t->hw_if_index);
435 /* Set vxlan tunnel output node */
436 u32 encap_index = !is_ip6 ?
437 vxlan4_encap_node.index : vxlan6_encap_node.index;
438 vnet_set_interface_output_node (vnm, t->hw_if_index, encap_index);
440 t->sw_if_index = sw_if_index = hi->sw_if_index;
446 key6.value = (u64) dev_instance;
447 add_failed = clib_bihash_add_del_24_8 (&vxm->vxlan6_tunnel_by_key,
452 vxlan_decap_info_t di = {.sw_if_index = t->sw_if_index, };
453 if (ip46_address_is_multicast (&t->dst))
454 di.local_ip = t->src.ip4;
456 di.next_index = t->decap_next_index;
457 key4.value = di.as_u64;
458 add_failed = clib_bihash_add_del_16_8 (&vxm->vxlan4_tunnel_by_key,
464 vnet_delete_hw_interface (vnm, t->hw_if_index);
465 hash_unset (vxm->instance_used, t->user_instance);
466 pool_put (vxm->tunnels, t);
467 return VNET_API_ERROR_INVALID_REGISTRATION;
470 vec_validate_init_empty (vxm->tunnel_index_by_sw_if_index, sw_if_index,
472 vxm->tunnel_index_by_sw_if_index[sw_if_index] = dev_instance;
474 /* setup l2 input config with l2 feature and bd 0 to drop packet */
475 vec_validate (l2im->configs, sw_if_index);
476 l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
477 l2im->configs[sw_if_index].bd_index = 0;
479 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
480 si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
481 vnet_sw_interface_set_flags (vnm, sw_if_index,
482 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
484 fib_node_init (&t->node, FIB_NODE_TYPE_VXLAN_TUNNEL);
485 fib_prefix_t tun_dst_pfx;
486 vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
488 fib_prefix_from_ip46_addr (&t->dst, &tun_dst_pfx);
489 if (!ip46_address_is_multicast (&t->dst))
492 * source the FIB entry for the tunnel's destination
493 * and become a child thereof. The tunnel will then get poked
494 * when the forwarding for the entry updates, and the tunnel can
495 * re-stack accordingly
497 vtep_addr_ref (&vxm->vtep_table, t->encap_fib_index, &t->src);
498 t->fib_entry_index = fib_entry_track (t->encap_fib_index,
500 FIB_NODE_TYPE_VXLAN_TUNNEL,
503 vxlan_tunnel_restack_dpo (t);
507 /* Multicast tunnel -
508 * as the same mcast group can be used for multiple mcast tunnels
509 * with different VNIs, create the output fib adjacency only if
510 * it does not already exist
512 fib_protocol_t fp = fib_ip_proto (is_ip6);
514 if (vtep_addr_ref (&vxm->vtep_table,
515 t->encap_fib_index, &t->dst) == 1)
517 fib_node_index_t mfei;
519 fib_route_path_t path = {
520 .frp_proto = fib_proto_to_dpo (fp),
521 .frp_addr = zero_addr,
522 .frp_sw_if_index = 0xffffffff,
525 .frp_flags = FIB_ROUTE_PATH_LOCAL,
526 .frp_mitf_flags = MFIB_ITF_FLAG_FORWARD,
528 const mfib_prefix_t mpfx = {
530 .fp_len = (is_ip6 ? 128 : 32),
531 .fp_grp_addr = tun_dst_pfx.fp_addr,
535 * Setup the (*,G) to receive traffic on the mcast group
536 * - the forwarding interface is for-us
537 * - the accepting interface is that from the API
539 mfib_table_entry_path_update (t->encap_fib_index,
540 &mpfx, MFIB_SOURCE_VXLAN, &path);
542 path.frp_sw_if_index = a->mcast_sw_if_index;
543 path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
544 path.frp_mitf_flags = MFIB_ITF_FLAG_ACCEPT;
545 mfei = mfib_table_entry_path_update (t->encap_fib_index,
547 MFIB_SOURCE_VXLAN, &path);
550 * Create the mcast adjacency to send traffic to the group
552 ai = adj_mcast_add_or_lock (fp,
553 fib_proto_to_link (fp),
554 a->mcast_sw_if_index);
557 * create a new end-point
559 mcast_shared_add (&t->dst, mfei, ai);
562 dpo_id_t dpo = DPO_INVALID;
563 mcast_shared_t ep = mcast_shared_get (&t->dst);
565 /* Stack shared mcast dst mac addr rewrite on encap */
566 dpo_set (&dpo, DPO_ADJACENCY_MCAST,
567 fib_proto_to_dpo (fp), ep.mcast_adj_index);
569 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
571 flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
574 vnet_get_sw_interface (vnet_get_main (), sw_if_index)->flood_class =
579 /* deleting a tunnel: tunnel must exist */
581 return VNET_API_ERROR_NO_SUCH_ENTRY;
583 u32 instance = is_ip6 ? key6.value :
584 vxm->tunnel_index_by_sw_if_index[p->sw_if_index];
585 vxlan_tunnel_t *t = pool_elt_at_index (vxm->tunnels, instance);
587 sw_if_index = t->sw_if_index;
588 vnet_sw_interface_set_flags (vnm, sw_if_index, 0 /* down */ );
590 vxm->tunnel_index_by_sw_if_index[sw_if_index] = ~0;
593 clib_bihash_add_del_16_8 (&vxm->vxlan4_tunnel_by_key, &key4,
596 clib_bihash_add_del_24_8 (&vxm->vxlan6_tunnel_by_key, &key6,
599 if (!ip46_address_is_multicast (&t->dst))
601 if (t->flow_index != ~0)
602 vnet_flow_del (vnm, t->flow_index);
604 vtep_addr_unref (&vxm->vtep_table, t->encap_fib_index, &t->src);
605 fib_entry_untrack (t->fib_entry_index, t->sibling_index);
607 else if (vtep_addr_unref (&vxm->vtep_table,
608 t->encap_fib_index, &t->dst) == 0)
610 mcast_shared_remove (&t->dst);
613 vnet_delete_hw_interface (vnm, t->hw_if_index);
614 hash_unset (vxm->instance_used, t->user_instance);
616 fib_node_deinit (&t->node);
617 pool_put (vxm->tunnels, t);
621 *sw_if_indexp = sw_if_index;
625 /* register udp ports */
626 if (!is_ip6 && !udp_is_valid_dst_port (UDP_DST_PORT_vxlan, 1))
627 udp_register_dst_port (vxm->vlib_main, UDP_DST_PORT_vxlan,
628 vxlan4_input_node.index, 1);
629 if (is_ip6 && !udp_is_valid_dst_port (UDP_DST_PORT_vxlan6, 0))
630 udp_register_dst_port (vxm->vlib_main, UDP_DST_PORT_vxlan6,
631 vxlan6_input_node.index, 0);
638 get_decap_next_for_node (u32 node_index, u32 ipv4_set)
640 vxlan_main_t *vxm = &vxlan_main;
641 vlib_main_t *vm = vxm->vlib_main;
642 uword input_node = (ipv4_set) ? vxlan4_input_node.index :
643 vxlan6_input_node.index;
645 return vlib_node_add_next (vm, input_node, node_index);
649 unformat_decap_next (unformat_input_t * input, va_list * args)
651 u32 *result = va_arg (*args, u32 *);
652 u32 ipv4_set = va_arg (*args, int);
653 vxlan_main_t *vxm = &vxlan_main;
654 vlib_main_t *vm = vxm->vlib_main;
658 if (unformat (input, "l2"))
659 *result = VXLAN_INPUT_NEXT_L2_INPUT;
660 else if (unformat (input, "node %U", unformat_vlib_node, vm, &node_index))
661 *result = get_decap_next_for_node (node_index, ipv4_set);
662 else if (unformat (input, "%d", &tmp))
669 static clib_error_t *
670 vxlan_add_del_tunnel_command_fn (vlib_main_t * vm,
671 unformat_input_t * input,
672 vlib_cli_command_t * cmd)
674 unformat_input_t _line_input, *line_input = &_line_input;
675 ip46_address_t src = ip46_address_initializer, dst =
676 ip46_address_initializer;
684 u32 encap_fib_index = 0;
685 u32 mcast_sw_if_index = ~0;
686 u32 decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
689 clib_error_t *parse_error = NULL;
691 /* Get a line of input. */
692 if (!unformat_user (input, unformat_line_input, line_input))
695 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
697 if (unformat (line_input, "del"))
701 else if (unformat (line_input, "instance %d", &instance))
703 else if (unformat (line_input, "src %U",
704 unformat_ip46_address, &src, IP46_TYPE_ANY))
707 ip46_address_is_ip4 (&src) ? (ipv4_set = 1) : (ipv6_set = 1);
709 else if (unformat (line_input, "dst %U",
710 unformat_ip46_address, &dst, IP46_TYPE_ANY))
713 ip46_address_is_ip4 (&dst) ? (ipv4_set = 1) : (ipv6_set = 1);
715 else if (unformat (line_input, "group %U %U",
716 unformat_ip46_address, &dst, IP46_TYPE_ANY,
717 unformat_vnet_sw_interface,
718 vnet_get_main (), &mcast_sw_if_index))
720 grp_set = dst_set = 1;
721 ip46_address_is_ip4 (&dst) ? (ipv4_set = 1) : (ipv6_set = 1);
723 else if (unformat (line_input, "encap-vrf-id %d", &table_id))
726 fib_table_find (fib_ip_proto (ipv6_set), table_id);
728 else if (unformat (line_input, "decap-next %U", unformat_decap_next,
729 &decap_next_index, ipv4_set))
731 else if (unformat (line_input, "vni %d", &vni))
735 parse_error = clib_error_return (0, "parse error: '%U'",
736 format_unformat_error, line_input);
741 unformat_free (line_input);
746 if (encap_fib_index == ~0)
747 return clib_error_return (0, "nonexistent encap-vrf-id %d", table_id);
750 return clib_error_return (0, "tunnel src address not specified");
753 return clib_error_return (0, "tunnel dst address not specified");
755 if (grp_set && !ip46_address_is_multicast (&dst))
756 return clib_error_return (0, "tunnel group address not multicast");
758 if (grp_set == 0 && ip46_address_is_multicast (&dst))
759 return clib_error_return (0, "dst address must be unicast");
761 if (grp_set && mcast_sw_if_index == ~0)
762 return clib_error_return (0, "tunnel nonexistent multicast device");
764 if (ipv4_set && ipv6_set)
765 return clib_error_return (0, "both IPv4 and IPv6 addresses specified");
767 if (ip46_address_cmp (&src, &dst) == 0)
768 return clib_error_return (0, "src and dst addresses are identical");
770 if (decap_next_index == ~0)
771 return clib_error_return (0, "next node not found");
774 return clib_error_return (0, "vni not specified");
777 return clib_error_return (0, "vni %d out of range", vni);
779 vnet_vxlan_add_del_tunnel_args_t a = {
782 .instance = instance,
788 u32 tunnel_sw_if_index;
789 int rv = vnet_vxlan_add_del_tunnel (&a, &tunnel_sw_if_index);
795 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
796 vnet_get_main (), tunnel_sw_if_index);
799 case VNET_API_ERROR_TUNNEL_EXIST:
800 return clib_error_return (0, "tunnel already exists...");
802 case VNET_API_ERROR_NO_SUCH_ENTRY:
803 return clib_error_return (0, "tunnel does not exist...");
805 case VNET_API_ERROR_INSTANCE_IN_USE:
806 return clib_error_return (0, "Instance is in use");
809 return clib_error_return
810 (0, "vnet_vxlan_add_del_tunnel returned %d", rv);
817 * Add or delete a VXLAN Tunnel.
819 * VXLAN provides the features needed to allow L2 bridge domains (BDs)
820 * to span multiple servers. This is done by building an L2 overlay on
821 * top of an L3 network underlay using VXLAN tunnels.
823 * This makes it possible for servers to be co-located in the same data
824 * center or be separated geographically as long as they are reachable
825 * through the underlay L3 network.
827 * You can refer to this kind of L2 overlay bridge domain as a VXLAN
828 * (Virtual eXtensible VLAN) segment.
831 * Example of how to create a VXLAN Tunnel:
832 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 encap-vrf-id 7}
833 * Example of how to create a VXLAN Tunnel with a known name, vxlan_tunnel42:
834 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 instance 42}
835 * Example of how to create a multicast VXLAN Tunnel with a known name, vxlan_tunnel23:
836 * @cliexcmd{create vxlan tunnel src 10.0.3.1 group 239.1.1.1 GigabitEthernet0/8/0 instance 23}
837 * Example of how to delete a VXLAN Tunnel:
838 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 del}
841 VLIB_CLI_COMMAND (create_vxlan_tunnel_command, static) = {
842 .path = "create vxlan tunnel",
844 "create vxlan tunnel src <local-vtep-addr>"
845 " {dst <remote-vtep-addr>|group <mcast-vtep-addr> <intf-name>} vni <nn>"
847 " [encap-vrf-id <nn>] [decap-next [l2|node <name>]] [del]",
848 .function = vxlan_add_del_tunnel_command_fn,
852 static clib_error_t *
853 show_vxlan_tunnel_command_fn (vlib_main_t * vm,
854 unformat_input_t * input,
855 vlib_cli_command_t * cmd)
857 vxlan_main_t *vxm = &vxlan_main;
861 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
863 if (unformat (input, "raw"))
866 return clib_error_return (0, "parse error: '%U'",
867 format_unformat_error, input);
870 if (pool_elts (vxm->tunnels) == 0)
871 vlib_cli_output (vm, "No vxlan tunnels configured...");
874 pool_foreach (t, vxm->tunnels)
876 vlib_cli_output (vm, "%U", format_vxlan_tunnel, t);
882 vlib_cli_output (vm, "Raw IPv4 Hash Table:\n%U\n",
883 format_bihash_16_8, &vxm->vxlan4_tunnel_by_key,
885 vlib_cli_output (vm, "Raw IPv6 Hash Table:\n%U\n",
886 format_bihash_24_8, &vxm->vxlan6_tunnel_by_key,
894 * Display all the VXLAN Tunnel entries.
897 * Example of how to display the VXLAN Tunnel entries:
898 * @cliexstart{show vxlan tunnel}
899 * [0] src 10.0.3.1 dst 10.0.3.3 vni 13 encap_fib_index 0 sw_if_index 5 decap_next l2
903 VLIB_CLI_COMMAND (show_vxlan_tunnel_command, static) = {
904 .path = "show vxlan tunnel",
905 .short_help = "show vxlan tunnel [raw]",
906 .function = show_vxlan_tunnel_command_fn,
912 vnet_int_vxlan_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable)
914 vxlan_main_t *vxm = &vxlan_main;
916 if (pool_is_free_index (vxm->vnet_main->interface_main.sw_interfaces,
920 is_enable = ! !is_enable;
924 if (clib_bitmap_get (vxm->bm_ip6_bypass_enabled_by_sw_if, sw_if_index)
927 vnet_feature_enable_disable ("ip6-unicast", "ip6-vxlan-bypass",
928 sw_if_index, is_enable, 0, 0);
929 vxm->bm_ip6_bypass_enabled_by_sw_if =
930 clib_bitmap_set (vxm->bm_ip6_bypass_enabled_by_sw_if,
931 sw_if_index, is_enable);
936 if (clib_bitmap_get (vxm->bm_ip4_bypass_enabled_by_sw_if, sw_if_index)
939 vnet_feature_enable_disable ("ip4-unicast", "ip4-vxlan-bypass",
940 sw_if_index, is_enable, 0, 0);
941 vxm->bm_ip4_bypass_enabled_by_sw_if =
942 clib_bitmap_set (vxm->bm_ip4_bypass_enabled_by_sw_if,
943 sw_if_index, is_enable);
949 static clib_error_t *
950 set_ip_vxlan_bypass (u32 is_ip6,
951 unformat_input_t * input, vlib_cli_command_t * cmd)
953 unformat_input_t _line_input, *line_input = &_line_input;
954 vnet_main_t *vnm = vnet_get_main ();
955 clib_error_t *error = 0;
956 u32 sw_if_index, is_enable;
961 if (!unformat_user (input, unformat_line_input, line_input))
964 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
967 (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
969 else if (unformat (line_input, "del"))
973 error = unformat_parse_error (line_input);
978 if (~0 == sw_if_index)
980 error = clib_error_return (0, "unknown interface `%U'",
981 format_unformat_error, line_input);
985 vnet_int_vxlan_bypass_mode (sw_if_index, is_ip6, is_enable);
988 unformat_free (line_input);
993 static clib_error_t *
994 set_ip4_vxlan_bypass (vlib_main_t * vm,
995 unformat_input_t * input, vlib_cli_command_t * cmd)
997 return set_ip_vxlan_bypass (0, input, cmd);
1001 * This command adds the 'ip4-vxlan-bypass' graph node for a given interface.
1002 * By adding the IPv4 vxlan-bypass graph node to an interface, the node checks
1003 * for and validate input vxlan packet and bypass ip4-lookup, ip4-local,
1004 * ip4-udp-lookup nodes to speedup vxlan packet forwarding. This node will
1005 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
1009 * Example of graph node before ip4-vxlan-bypass is enabled:
1010 * @cliexstart{show vlib graph ip4-vxlan-bypass}
1011 * Name Next Previous
1012 * ip4-vxlan-bypass error-drop [0]
1017 * Example of how to enable ip4-vxlan-bypass on an interface:
1018 * @cliexcmd{set interface ip vxlan-bypass GigabitEthernet2/0/0}
1020 * Example of graph node after ip4-vxlan-bypass is enabled:
1021 * @cliexstart{show vlib graph ip4-vxlan-bypass}
1022 * Name Next Previous
1023 * ip4-vxlan-bypass error-drop [0] ip4-input
1024 * vxlan4-input [1] ip4-input-no-checksum
1028 * Example of how to display the feature enabled on an interface:
1029 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1030 * IP feature paths configured on GigabitEthernet2/0/0...
1038 * Example of how to disable ip4-vxlan-bypass on an interface:
1039 * @cliexcmd{set interface ip vxlan-bypass GigabitEthernet2/0/0 del}
1043 VLIB_CLI_COMMAND (set_interface_ip_vxlan_bypass_command, static) = {
1044 .path = "set interface ip vxlan-bypass",
1045 .function = set_ip4_vxlan_bypass,
1046 .short_help = "set interface ip vxlan-bypass <interface> [del]",
1050 static clib_error_t *
1051 set_ip6_vxlan_bypass (vlib_main_t * vm,
1052 unformat_input_t * input, vlib_cli_command_t * cmd)
1054 return set_ip_vxlan_bypass (1, input, cmd);
1058 * This command adds the 'ip6-vxlan-bypass' graph node for a given interface.
1059 * By adding the IPv6 vxlan-bypass graph node to an interface, the node checks
1060 * for and validate input vxlan packet and bypass ip6-lookup, ip6-local,
1061 * ip6-udp-lookup nodes to speedup vxlan packet forwarding. This node will
1062 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
1066 * Example of graph node before ip6-vxlan-bypass is enabled:
1067 * @cliexstart{show vlib graph ip6-vxlan-bypass}
1068 * Name Next Previous
1069 * ip6-vxlan-bypass error-drop [0]
1074 * Example of how to enable ip6-vxlan-bypass on an interface:
1075 * @cliexcmd{set interface ip6 vxlan-bypass GigabitEthernet2/0/0}
1077 * Example of graph node after ip6-vxlan-bypass is enabled:
1078 * @cliexstart{show vlib graph ip6-vxlan-bypass}
1079 * Name Next Previous
1080 * ip6-vxlan-bypass error-drop [0] ip6-input
1081 * vxlan6-input [1] ip4-input-no-checksum
1085 * Example of how to display the feature enabled on an interface:
1086 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1087 * IP feature paths configured on GigabitEthernet2/0/0...
1095 * Example of how to disable ip6-vxlan-bypass on an interface:
1096 * @cliexcmd{set interface ip6 vxlan-bypass GigabitEthernet2/0/0 del}
1100 VLIB_CLI_COMMAND (set_interface_ip6_vxlan_bypass_command, static) = {
1101 .path = "set interface ip6 vxlan-bypass",
1102 .function = set_ip6_vxlan_bypass,
1103 .short_help = "set interface ip6 vxlan-bypass <interface> [del]",
1108 vnet_vxlan_add_del_rx_flow (u32 hw_if_index, u32 t_index, int is_add)
1110 vxlan_main_t *vxm = &vxlan_main;
1111 vxlan_tunnel_t *t = pool_elt_at_index (vxm->tunnels, t_index);
1112 vnet_main_t *vnm = vnet_get_main ();
1115 if (t->flow_index == ~0)
1117 vxlan_main_t *vxm = &vxlan_main;
1118 vnet_flow_t flow = {
1120 VNET_FLOW_ACTION_REDIRECT_TO_NODE | VNET_FLOW_ACTION_MARK |
1121 VNET_FLOW_ACTION_BUFFER_ADVANCE,
1122 .mark_flow_id = t->dev_instance + vxm->flow_id_start,
1123 .redirect_node_index = vxlan4_flow_input_node.index,
1124 .buffer_advance = sizeof (ethernet_header_t),
1125 .type = VNET_FLOW_TYPE_IP4_VXLAN,
1127 .protocol.prot = IP_PROTOCOL_UDP,
1128 .src_addr.addr = t->dst.ip4,
1129 .dst_addr.addr = t->src.ip4,
1130 .src_addr.mask.as_u32 = ~0,
1131 .dst_addr.mask.as_u32 = ~0,
1132 .dst_port.port = UDP_DST_PORT_vxlan,
1133 .dst_port.mask = 0xFF,
1138 vnet_flow_add (vnm, &flow, &t->flow_index);
1140 return vnet_flow_enable (vnm, t->flow_index, hw_if_index);
1142 /* flow index is removed when the tunnel is deleted */
1143 return vnet_flow_disable (vnm, t->flow_index, hw_if_index);
1147 vnet_vxlan_get_tunnel_index (u32 sw_if_index)
1149 vxlan_main_t *vxm = &vxlan_main;
1151 if (sw_if_index >= vec_len (vxm->tunnel_index_by_sw_if_index))
1153 return vxm->tunnel_index_by_sw_if_index[sw_if_index];
1156 static clib_error_t *
1157 vxlan_offload_command_fn (vlib_main_t * vm,
1158 unformat_input_t * input, vlib_cli_command_t * cmd)
1160 unformat_input_t _line_input, *line_input = &_line_input;
1162 /* Get a line of input. */
1163 if (!unformat_user (input, unformat_line_input, line_input))
1166 vnet_main_t *vnm = vnet_get_main ();
1167 u32 rx_sw_if_index = ~0;
1168 u32 hw_if_index = ~0;
1171 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1173 if (unformat (line_input, "hw %U", unformat_vnet_hw_interface, vnm,
1176 if (unformat (line_input, "rx %U", unformat_vnet_sw_interface, vnm,
1179 if (unformat (line_input, "del"))
1184 return clib_error_return (0, "unknown input `%U'",
1185 format_unformat_error, line_input);
1188 if (rx_sw_if_index == ~0)
1189 return clib_error_return (0, "missing rx interface");
1190 if (hw_if_index == ~0)
1191 return clib_error_return (0, "missing hw interface");
1193 u32 t_index = vnet_vxlan_get_tunnel_index (rx_sw_if_index);;
1195 return clib_error_return (0, "%U is not a vxlan tunnel",
1196 format_vnet_sw_if_index_name, vnm,
1199 vxlan_main_t *vxm = &vxlan_main;
1200 vxlan_tunnel_t *t = pool_elt_at_index (vxm->tunnels, t_index);
1202 if (!ip46_address_is_ip4 (&t->dst))
1203 return clib_error_return (0, "currently only IPV4 tunnels are supported");
1205 vnet_hw_interface_t *hw_if = vnet_get_hw_interface (vnm, hw_if_index);
1206 ip4_main_t *im = &ip4_main;
1208 vec_elt (im->fib_index_by_sw_if_index, hw_if->sw_if_index);
1210 if (t->encap_fib_index != rx_fib_index)
1211 return clib_error_return (0, "interface/tunnel fib mismatch");
1213 if (vnet_vxlan_add_del_rx_flow (hw_if_index, t_index, is_add))
1214 return clib_error_return (0, "error %s flow",
1215 is_add ? "enabling" : "disabling");
1221 VLIB_CLI_COMMAND (vxlan_offload_command, static) = {
1222 .path = "set flow-offload vxlan",
1224 "set flow-offload vxlan hw <interface-name> rx <tunnel-name> [del]",
1225 .function = vxlan_offload_command_fn,
1229 #define VXLAN_HASH_NUM_BUCKETS (2 * 1024)
1230 #define VXLAN_HASH_MEMORY_SIZE (1 << 20)
1233 vxlan_init (vlib_main_t * vm)
1235 vxlan_main_t *vxm = &vxlan_main;
1237 vxm->vnet_main = vnet_get_main ();
1238 vxm->vlib_main = vm;
1240 vnet_flow_get_range (vxm->vnet_main, "vxlan", 1024 * 1024,
1241 &vxm->flow_id_start);
1243 vxm->bm_ip4_bypass_enabled_by_sw_if = 0;
1244 vxm->bm_ip6_bypass_enabled_by_sw_if = 0;
1246 /* initialize the ip6 hash */
1247 clib_bihash_init_16_8 (&vxm->vxlan4_tunnel_by_key, "vxlan4",
1248 VXLAN_HASH_NUM_BUCKETS, VXLAN_HASH_MEMORY_SIZE);
1249 clib_bihash_init_24_8 (&vxm->vxlan6_tunnel_by_key, "vxlan6",
1250 VXLAN_HASH_NUM_BUCKETS, VXLAN_HASH_MEMORY_SIZE);
1251 vxm->vtep_table = vtep_table_create ();
1252 vxm->mcast_shared = hash_create_mem (0,
1253 sizeof (ip46_address_t),
1254 sizeof (mcast_shared_t));
1256 fib_node_register_type (FIB_NODE_TYPE_VXLAN_TUNNEL, &vxlan_vft);
1261 VLIB_INIT_FUNCTION (vxlan_init);
1264 * fd.io coding-style-patch-verification: ON
1267 * eval: (c-set-style "gnu")