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/interface.h>
24 #include <vnet/flow/flow.h>
25 #include <vlib/vlib.h>
31 * VXLAN provides the features needed to allow L2 bridge domains (BDs)
32 * to span multiple servers. This is done by building an L2 overlay on
33 * top of an L3 network underlay using VXLAN tunnels.
35 * This makes it possible for servers to be co-located in the same data
36 * center or be separated geographically as long as they are reachable
37 * through the underlay L3 network.
39 * You can refer to this kind of L2 overlay bridge domain as a VXLAN
40 * (Virtual eXtensible VLAN) segment.
44 vxlan_main_t vxlan_main;
47 format_decap_next (u8 * s, va_list * args)
49 u32 next_index = va_arg (*args, u32);
51 if (next_index == VXLAN_INPUT_NEXT_DROP)
52 return format (s, "drop");
54 return format (s, "index %d", next_index);
59 format_vxlan_tunnel (u8 * s, va_list * args)
61 vxlan_tunnel_t *t = va_arg (*args, vxlan_tunnel_t *);
64 "[%d] instance %d src %U dst %U vni %d fib-idx %d sw-if-idx %d ",
65 t->dev_instance, t->user_instance,
66 format_ip46_address, &t->src, IP46_TYPE_ANY,
67 format_ip46_address, &t->dst, IP46_TYPE_ANY,
68 t->vni, t->encap_fib_index, t->sw_if_index);
70 s = format (s, "encap-dpo-idx %d ", t->next_dpo.dpoi_index);
72 if (PREDICT_FALSE (t->decap_next_index != VXLAN_INPUT_NEXT_L2_INPUT))
73 s = format (s, "decap-next-%U ", format_decap_next, t->decap_next_index);
75 if (PREDICT_FALSE (ip46_address_is_multicast (&t->dst)))
76 s = format (s, "mcast-sw-if-idx %d ", t->mcast_sw_if_index);
78 if (t->flow_index != ~0)
79 s = format (s, "flow-index %d [%U]", t->flow_index,
80 format_flow_enabled_hw, t->flow_index);
86 format_vxlan_name (u8 * s, va_list * args)
88 u32 dev_instance = va_arg (*args, u32);
89 vxlan_main_t *vxm = &vxlan_main;
92 if (dev_instance == ~0)
93 return format (s, "<cached-unused>");
95 if (dev_instance >= vec_len (vxm->tunnels))
96 return format (s, "<improperly-referenced>");
98 t = pool_elt_at_index (vxm->tunnels, dev_instance);
100 return format (s, "vxlan_tunnel%d", t->user_instance);
103 static clib_error_t *
104 vxlan_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
106 u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
107 VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
108 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
110 return /* no error */ 0;
114 VNET_DEVICE_CLASS (vxlan_device_class, static) = {
116 .format_device_name = format_vxlan_name,
117 .format_tx_trace = format_vxlan_encap_trace,
118 .admin_up_down_function = vxlan_interface_admin_up_down,
123 format_vxlan_header_with_length (u8 * s, va_list * args)
125 u32 dev_instance = va_arg (*args, u32);
126 s = format (s, "unimplemented dev %u", dev_instance);
131 VNET_HW_INTERFACE_CLASS (vxlan_hw_class) = {
133 .format_header = format_vxlan_header_with_length,
134 .build_rewrite = default_build_rewrite,
139 vxlan_tunnel_restack_dpo (vxlan_tunnel_t * t)
141 u8 is_ip4 = ip46_address_is_ip4 (&t->dst);
142 dpo_id_t dpo = DPO_INVALID;
143 fib_forward_chain_type_t forw_type = is_ip4 ?
144 FIB_FORW_CHAIN_TYPE_UNICAST_IP4 : FIB_FORW_CHAIN_TYPE_UNICAST_IP6;
146 fib_entry_contribute_forwarding (t->fib_entry_index, forw_type, &dpo);
148 /* vxlan uses the payload hash as the udp source port
149 * hence the packet's hash is unknown
150 * skip single bucket load balance dpo's */
151 while (DPO_LOAD_BALANCE == dpo.dpoi_type)
153 load_balance_t *lb = load_balance_get (dpo.dpoi_index);
154 if (lb->lb_n_buckets > 1)
157 dpo_copy (&dpo, load_balance_get_bucket_i (lb, 0));
160 u32 encap_index = is_ip4 ?
161 vxlan4_encap_node.index : vxlan6_encap_node.index;
162 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
166 static vxlan_tunnel_t *
167 vxlan_tunnel_from_fib_node (fib_node_t * node)
169 ASSERT (FIB_NODE_TYPE_VXLAN_TUNNEL == node->fn_type);
170 return ((vxlan_tunnel_t *) (((char *) node) -
171 STRUCT_OFFSET_OF (vxlan_tunnel_t, node)));
175 * Function definition to backwalk a FIB node -
176 * Here we will restack the new dpo of VXLAN DIP to encap node.
178 static fib_node_back_walk_rc_t
179 vxlan_tunnel_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
181 vxlan_tunnel_restack_dpo (vxlan_tunnel_from_fib_node (node));
182 return (FIB_NODE_BACK_WALK_CONTINUE);
186 * Function definition to get a FIB node from its index
189 vxlan_tunnel_fib_node_get (fib_node_index_t index)
192 vxlan_main_t *vxm = &vxlan_main;
194 t = pool_elt_at_index (vxm->tunnels, index);
200 * Function definition to inform the FIB node that its last lock has gone.
203 vxlan_tunnel_last_lock_gone (fib_node_t * node)
206 * The VXLAN tunnel is a root of the graph. As such
207 * it never has children and thus is never locked.
213 * Virtual function table registered by VXLAN tunnels
214 * for participation in the FIB object graph.
216 const static fib_node_vft_t vxlan_vft = {
217 .fnv_get = vxlan_tunnel_fib_node_get,
218 .fnv_last_lock = vxlan_tunnel_last_lock_gone,
219 .fnv_back_walk = vxlan_tunnel_back_walk,
223 #define foreach_copy_field \
225 _(mcast_sw_if_index) \
227 _(decap_next_index) \
232 vxlan_rewrite (vxlan_tunnel_t * t, bool is_ip6)
236 ip4_vxlan_header_t h4;
237 ip6_vxlan_header_t h6;
239 int len = is_ip6 ? sizeof h.h6 : sizeof h.h4;
242 vxlan_header_t *vxlan;
243 /* Fixed portion of the (outer) ip header */
245 clib_memset (&h, 0, sizeof (h));
248 ip4_header_t *ip = &h.h4.ip4;
249 udp = &h.h4.udp, vxlan = &h.h4.vxlan;
250 ip->ip_version_and_header_length = 0x45;
252 ip->protocol = IP_PROTOCOL_UDP;
254 ip->src_address = t->src.ip4;
255 ip->dst_address = t->dst.ip4;
257 /* we fix up the ip4 header length and checksum after-the-fact */
258 ip->checksum = ip4_header_checksum (ip);
262 ip6_header_t *ip = &h.h6.ip6;
263 udp = &h.h6.udp, vxlan = &h.h6.vxlan;
264 ip->ip_version_traffic_class_and_flow_label =
265 clib_host_to_net_u32 (6 << 28);
267 ip->protocol = IP_PROTOCOL_UDP;
269 ip->src_address = t->src.ip6;
270 ip->dst_address = t->dst.ip6;
273 /* UDP header, randomize src port on something, maybe? */
274 udp->src_port = clib_host_to_net_u16 (4789);
275 udp->dst_port = clib_host_to_net_u16 (UDP_DST_PORT_vxlan);
278 vnet_set_vni_and_flags (vxlan, t->vni);
279 vnet_rewrite_set_data (*t, &h, len);
283 vxlan_decap_next_is_valid (vxlan_main_t * vxm, u32 is_ip6,
284 u32 decap_next_index)
286 vlib_main_t *vm = vxm->vlib_main;
287 u32 input_idx = (!is_ip6) ?
288 vxlan4_input_node.index : vxlan6_input_node.index;
289 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, input_idx);
291 return decap_next_index < r->n_next_nodes;
295 typedef CLIB_PACKED(union
299 fib_node_index_t mfib_entry_index;
300 adj_index_t mcast_adj_index;
306 static inline mcast_shared_t
307 mcast_shared_get (ip46_address_t * ip)
309 ASSERT (ip46_address_is_multicast (ip));
310 uword *p = hash_get_mem (vxlan_main.mcast_shared, ip);
312 mcast_shared_t ret = {.as_u64 = *p };
317 mcast_shared_add (ip46_address_t * dst, fib_node_index_t mfei, adj_index_t ai)
319 mcast_shared_t new_ep = {
320 .mcast_adj_index = ai,
321 .mfib_entry_index = mfei,
324 hash_set_mem_alloc (&vxlan_main.mcast_shared, dst, new_ep.as_u64);
328 mcast_shared_remove (ip46_address_t * dst)
330 mcast_shared_t ep = mcast_shared_get (dst);
332 adj_unlock (ep.mcast_adj_index);
333 mfib_table_entry_delete_index (ep.mfib_entry_index, MFIB_SOURCE_VXLAN);
335 hash_unset_mem_free (&vxlan_main.mcast_shared, dst);
338 int vnet_vxlan_add_del_tunnel
339 (vnet_vxlan_add_del_tunnel_args_t * a, u32 * sw_if_indexp)
341 vxlan_main_t *vxm = &vxlan_main;
342 vnet_main_t *vnm = vxm->vnet_main;
343 vxlan_decap_info_t *p;
344 u32 sw_if_index = ~0;
345 vxlan4_tunnel_key_t key4;
346 vxlan6_tunnel_key_t key6;
347 u32 is_ip6 = a->is_ip6;
352 /* ip4 mcast is indexed by mcast addr only */
353 key4.key[0] = ip46_address_is_multicast (&a->dst) ?
355 a->dst.ip4.as_u32 | (((u64) a->src.ip4.as_u32) << 32);
356 key4.key[1] = (((u64) a->encap_fib_index) << 32)
357 | clib_host_to_net_u32 (a->vni << 8);
359 clib_bihash_search_inline_16_8 (&vxm->vxlan4_tunnel_by_key, &key4);
360 p = (void *) &key4.value;
364 key6.key[0] = a->dst.ip6.as_u64[0];
365 key6.key[1] = a->dst.ip6.as_u64[1];
366 key6.key[2] = (((u64) a->encap_fib_index) << 32)
367 | clib_host_to_net_u32 (a->vni << 8);
369 clib_bihash_search_inline_24_8 (&vxm->vxlan6_tunnel_by_key, &key6);
370 p = (void *) &key6.value;
378 l2input_main_t *l2im = &l2input_main;
379 u32 dev_instance; /* real dev instance tunnel index */
380 u32 user_instance; /* request and actual instance number */
382 /* adding a tunnel: tunnel must not already exist */
384 return VNET_API_ERROR_TUNNEL_EXIST;
386 /*if not set explicitly, default to l2 */
387 if (a->decap_next_index == ~0)
388 a->decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
389 if (!vxlan_decap_next_is_valid (vxm, is_ip6, a->decap_next_index))
390 return VNET_API_ERROR_INVALID_DECAP_NEXT;
393 pool_get_aligned (vxm->tunnels, t, CLIB_CACHE_LINE_BYTES);
394 clib_memset (t, 0, sizeof (*t));
395 dev_instance = t - vxm->tunnels;
397 /* copy from arg structure */
398 #define _(x) t->x = a->x;
402 vxlan_rewrite (t, is_ip6);
404 * Reconcile the real dev_instance and a possible requested instance.
406 user_instance = a->instance;
407 if (user_instance == ~0)
408 user_instance = dev_instance;
409 if (hash_get (vxm->instance_used, user_instance))
411 pool_put (vxm->tunnels, t);
412 return VNET_API_ERROR_INSTANCE_IN_USE;
414 hash_set (vxm->instance_used, user_instance, 1);
416 t->dev_instance = dev_instance; /* actual */
417 t->user_instance = user_instance; /* name */
420 t->hw_if_index = vnet_register_interface
421 (vnm, vxlan_device_class.index, dev_instance,
422 vxlan_hw_class.index, dev_instance);
423 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, t->hw_if_index);
425 /* Set vxlan tunnel output node */
426 u32 encap_index = !is_ip6 ?
427 vxlan4_encap_node.index : vxlan6_encap_node.index;
428 vnet_set_interface_output_node (vnm, t->hw_if_index, encap_index);
430 t->sw_if_index = sw_if_index = hi->sw_if_index;
436 key6.value = (u64) dev_instance;
437 add_failed = clib_bihash_add_del_24_8 (&vxm->vxlan6_tunnel_by_key,
442 vxlan_decap_info_t di = {.sw_if_index = t->sw_if_index, };
443 if (ip46_address_is_multicast (&t->dst))
444 di.local_ip = t->src.ip4;
446 di.next_index = t->decap_next_index;
447 key4.value = di.as_u64;
448 add_failed = clib_bihash_add_del_16_8 (&vxm->vxlan4_tunnel_by_key,
454 vnet_delete_hw_interface (vnm, t->hw_if_index);
455 hash_unset (vxm->instance_used, t->user_instance);
456 pool_put (vxm->tunnels, t);
457 return VNET_API_ERROR_INVALID_REGISTRATION;
460 vec_validate_init_empty (vxm->tunnel_index_by_sw_if_index, sw_if_index,
462 vxm->tunnel_index_by_sw_if_index[sw_if_index] = dev_instance;
464 /* setup l2 input config with l2 feature and bd 0 to drop packet */
465 vec_validate (l2im->configs, sw_if_index);
466 l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
467 l2im->configs[sw_if_index].bd_index = 0;
469 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
470 si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
471 vnet_sw_interface_set_flags (vnm, sw_if_index,
472 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
474 fib_node_init (&t->node, FIB_NODE_TYPE_VXLAN_TUNNEL);
475 fib_prefix_t tun_dst_pfx;
476 vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
478 fib_prefix_from_ip46_addr (&t->dst, &tun_dst_pfx);
479 if (!ip46_address_is_multicast (&t->dst))
482 * source the FIB entry for the tunnel's destination
483 * and become a child thereof. The tunnel will then get poked
484 * when the forwarding for the entry updates, and the tunnel can
485 * re-stack accordingly
487 vtep_addr_ref (&vxm->vtep_table, t->encap_fib_index, &t->src);
488 t->fib_entry_index = fib_entry_track (t->encap_fib_index,
490 FIB_NODE_TYPE_VXLAN_TUNNEL,
493 vxlan_tunnel_restack_dpo (t);
497 /* Multicast tunnel -
498 * as the same mcast group can be used for multiple mcast tunnels
499 * with different VNIs, create the output fib adjacency only if
500 * it does not already exist
502 fib_protocol_t fp = fib_ip_proto (is_ip6);
504 if (vtep_addr_ref (&vxm->vtep_table,
505 t->encap_fib_index, &t->dst) == 1)
507 fib_node_index_t mfei;
509 fib_route_path_t path = {
510 .frp_proto = fib_proto_to_dpo (fp),
511 .frp_addr = zero_addr,
512 .frp_sw_if_index = 0xffffffff,
515 .frp_flags = FIB_ROUTE_PATH_LOCAL,
516 .frp_mitf_flags = MFIB_ITF_FLAG_FORWARD,
518 const mfib_prefix_t mpfx = {
520 .fp_len = (is_ip6 ? 128 : 32),
521 .fp_grp_addr = tun_dst_pfx.fp_addr,
525 * Setup the (*,G) to receive traffic on the mcast group
526 * - the forwarding interface is for-us
527 * - the accepting interface is that from the API
529 mfib_table_entry_path_update (t->encap_fib_index,
530 &mpfx, MFIB_SOURCE_VXLAN, &path);
532 path.frp_sw_if_index = a->mcast_sw_if_index;
533 path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
534 path.frp_mitf_flags = MFIB_ITF_FLAG_ACCEPT;
535 mfei = mfib_table_entry_path_update (t->encap_fib_index,
537 MFIB_SOURCE_VXLAN, &path);
540 * Create the mcast adjacency to send traffic to the group
542 ai = adj_mcast_add_or_lock (fp,
543 fib_proto_to_link (fp),
544 a->mcast_sw_if_index);
547 * create a new end-point
549 mcast_shared_add (&t->dst, mfei, ai);
552 dpo_id_t dpo = DPO_INVALID;
553 mcast_shared_t ep = mcast_shared_get (&t->dst);
555 /* Stack shared mcast dst mac addr rewrite on encap */
556 dpo_set (&dpo, DPO_ADJACENCY_MCAST,
557 fib_proto_to_dpo (fp), ep.mcast_adj_index);
559 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
561 flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
564 vnet_get_sw_interface (vnet_get_main (), sw_if_index)->flood_class =
569 /* deleting a tunnel: tunnel must exist */
571 return VNET_API_ERROR_NO_SUCH_ENTRY;
573 u32 instance = is_ip6 ? key6.value :
574 vxm->tunnel_index_by_sw_if_index[p->sw_if_index];
575 vxlan_tunnel_t *t = pool_elt_at_index (vxm->tunnels, instance);
577 sw_if_index = t->sw_if_index;
578 vnet_sw_interface_set_flags (vnm, sw_if_index, 0 /* down */ );
580 vxm->tunnel_index_by_sw_if_index[sw_if_index] = ~0;
583 clib_bihash_add_del_16_8 (&vxm->vxlan4_tunnel_by_key, &key4,
586 clib_bihash_add_del_24_8 (&vxm->vxlan6_tunnel_by_key, &key6,
589 if (!ip46_address_is_multicast (&t->dst))
591 if (t->flow_index != ~0)
592 vnet_flow_del (vnm, t->flow_index);
594 vtep_addr_unref (&vxm->vtep_table, t->encap_fib_index, &t->src);
595 fib_entry_untrack (t->fib_entry_index, t->sibling_index);
597 else if (vtep_addr_unref (&vxm->vtep_table,
598 t->encap_fib_index, &t->dst) == 0)
600 mcast_shared_remove (&t->dst);
603 vnet_delete_hw_interface (vnm, t->hw_if_index);
604 hash_unset (vxm->instance_used, t->user_instance);
606 fib_node_deinit (&t->node);
607 pool_put (vxm->tunnels, t);
611 *sw_if_indexp = sw_if_index;
615 /* register udp ports */
616 if (!is_ip6 && !udp_is_valid_dst_port (UDP_DST_PORT_vxlan, 1))
617 udp_register_dst_port (vxm->vlib_main, UDP_DST_PORT_vxlan,
618 vxlan4_input_node.index, 1);
619 if (is_ip6 && !udp_is_valid_dst_port (UDP_DST_PORT_vxlan6, 0))
620 udp_register_dst_port (vxm->vlib_main, UDP_DST_PORT_vxlan6,
621 vxlan6_input_node.index, 0);
628 get_decap_next_for_node (u32 node_index, u32 ipv4_set)
630 vxlan_main_t *vxm = &vxlan_main;
631 vlib_main_t *vm = vxm->vlib_main;
632 uword input_node = (ipv4_set) ? vxlan4_input_node.index :
633 vxlan6_input_node.index;
635 return vlib_node_add_next (vm, input_node, node_index);
639 unformat_decap_next (unformat_input_t * input, va_list * args)
641 u32 *result = va_arg (*args, u32 *);
642 u32 ipv4_set = va_arg (*args, int);
643 vxlan_main_t *vxm = &vxlan_main;
644 vlib_main_t *vm = vxm->vlib_main;
648 if (unformat (input, "l2"))
649 *result = VXLAN_INPUT_NEXT_L2_INPUT;
650 else if (unformat (input, "node %U", unformat_vlib_node, vm, &node_index))
651 *result = get_decap_next_for_node (node_index, ipv4_set);
652 else if (unformat (input, "%d", &tmp))
659 static clib_error_t *
660 vxlan_add_del_tunnel_command_fn (vlib_main_t * vm,
661 unformat_input_t * input,
662 vlib_cli_command_t * cmd)
664 unformat_input_t _line_input, *line_input = &_line_input;
665 ip46_address_t src = ip46_address_initializer, dst =
666 ip46_address_initializer;
674 u32 encap_fib_index = 0;
675 u32 mcast_sw_if_index = ~0;
676 u32 decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
679 clib_error_t *parse_error = NULL;
681 /* Get a line of input. */
682 if (!unformat_user (input, unformat_line_input, line_input))
685 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
687 if (unformat (line_input, "del"))
691 else if (unformat (line_input, "instance %d", &instance))
693 else if (unformat (line_input, "src %U",
694 unformat_ip46_address, &src, IP46_TYPE_ANY))
697 ip46_address_is_ip4 (&src) ? (ipv4_set = 1) : (ipv6_set = 1);
699 else if (unformat (line_input, "dst %U",
700 unformat_ip46_address, &dst, IP46_TYPE_ANY))
703 ip46_address_is_ip4 (&dst) ? (ipv4_set = 1) : (ipv6_set = 1);
705 else if (unformat (line_input, "group %U %U",
706 unformat_ip46_address, &dst, IP46_TYPE_ANY,
707 unformat_vnet_sw_interface,
708 vnet_get_main (), &mcast_sw_if_index))
710 grp_set = dst_set = 1;
711 ip46_address_is_ip4 (&dst) ? (ipv4_set = 1) : (ipv6_set = 1);
713 else if (unformat (line_input, "encap-vrf-id %d", &table_id))
716 fib_table_find (fib_ip_proto (ipv6_set), table_id);
718 else if (unformat (line_input, "decap-next %U", unformat_decap_next,
719 &decap_next_index, ipv4_set))
721 else if (unformat (line_input, "vni %d", &vni))
725 parse_error = clib_error_return (0, "parse error: '%U'",
726 format_unformat_error, line_input);
731 unformat_free (line_input);
736 if (encap_fib_index == ~0)
737 return clib_error_return (0, "nonexistent encap-vrf-id %d", table_id);
740 return clib_error_return (0, "tunnel src address not specified");
743 return clib_error_return (0, "tunnel dst address not specified");
745 if (grp_set && !ip46_address_is_multicast (&dst))
746 return clib_error_return (0, "tunnel group address not multicast");
748 if (grp_set == 0 && ip46_address_is_multicast (&dst))
749 return clib_error_return (0, "dst address must be unicast");
751 if (grp_set && mcast_sw_if_index == ~0)
752 return clib_error_return (0, "tunnel nonexistent multicast device");
754 if (ipv4_set && ipv6_set)
755 return clib_error_return (0, "both IPv4 and IPv6 addresses specified");
757 if (ip46_address_cmp (&src, &dst) == 0)
758 return clib_error_return (0, "src and dst addresses are identical");
760 if (decap_next_index == ~0)
761 return clib_error_return (0, "next node not found");
764 return clib_error_return (0, "vni not specified");
767 return clib_error_return (0, "vni %d out of range", vni);
769 vnet_vxlan_add_del_tunnel_args_t a = {
772 .instance = instance,
778 u32 tunnel_sw_if_index;
779 int rv = vnet_vxlan_add_del_tunnel (&a, &tunnel_sw_if_index);
785 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
786 vnet_get_main (), tunnel_sw_if_index);
789 case VNET_API_ERROR_TUNNEL_EXIST:
790 return clib_error_return (0, "tunnel already exists...");
792 case VNET_API_ERROR_NO_SUCH_ENTRY:
793 return clib_error_return (0, "tunnel does not exist...");
795 case VNET_API_ERROR_INSTANCE_IN_USE:
796 return clib_error_return (0, "Instance is in use");
799 return clib_error_return
800 (0, "vnet_vxlan_add_del_tunnel returned %d", rv);
807 * Add or delete a VXLAN Tunnel.
809 * VXLAN provides the features needed to allow L2 bridge domains (BDs)
810 * to span multiple servers. This is done by building an L2 overlay on
811 * top of an L3 network underlay using VXLAN tunnels.
813 * This makes it possible for servers to be co-located in the same data
814 * center or be separated geographically as long as they are reachable
815 * through the underlay L3 network.
817 * You can refer to this kind of L2 overlay bridge domain as a VXLAN
818 * (Virtual eXtensible VLAN) segment.
821 * Example of how to create a VXLAN Tunnel:
822 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 encap-vrf-id 7}
823 * Example of how to create a VXLAN Tunnel with a known name, vxlan_tunnel42:
824 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 instance 42}
825 * Example of how to create a multicast VXLAN Tunnel with a known name, vxlan_tunnel23:
826 * @cliexcmd{create vxlan tunnel src 10.0.3.1 group 239.1.1.1 GigabitEthernet0/8/0 instance 23}
827 * Example of how to delete a VXLAN Tunnel:
828 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 del}
831 VLIB_CLI_COMMAND (create_vxlan_tunnel_command, static) = {
832 .path = "create vxlan tunnel",
834 "create vxlan tunnel src <local-vtep-addr>"
835 " {dst <remote-vtep-addr>|group <mcast-vtep-addr> <intf-name>} vni <nn>"
837 " [encap-vrf-id <nn>] [decap-next [l2|node <name>]] [del]",
838 .function = vxlan_add_del_tunnel_command_fn,
842 static clib_error_t *
843 show_vxlan_tunnel_command_fn (vlib_main_t * vm,
844 unformat_input_t * input,
845 vlib_cli_command_t * cmd)
847 vxlan_main_t *vxm = &vxlan_main;
851 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
853 if (unformat (input, "raw"))
856 return clib_error_return (0, "parse error: '%U'",
857 format_unformat_error, input);
860 if (pool_elts (vxm->tunnels) == 0)
861 vlib_cli_output (vm, "No vxlan tunnels configured...");
864 pool_foreach (t, vxm->tunnels,
866 vlib_cli_output (vm, "%U", format_vxlan_tunnel, t);
872 vlib_cli_output (vm, "Raw IPv4 Hash Table:\n%U\n",
873 format_bihash_16_8, &vxm->vxlan4_tunnel_by_key,
875 vlib_cli_output (vm, "Raw IPv6 Hash Table:\n%U\n",
876 format_bihash_24_8, &vxm->vxlan6_tunnel_by_key,
884 * Display all the VXLAN Tunnel entries.
887 * Example of how to display the VXLAN Tunnel entries:
888 * @cliexstart{show vxlan tunnel}
889 * [0] src 10.0.3.1 dst 10.0.3.3 vni 13 encap_fib_index 0 sw_if_index 5 decap_next l2
893 VLIB_CLI_COMMAND (show_vxlan_tunnel_command, static) = {
894 .path = "show vxlan tunnel",
895 .short_help = "show vxlan tunnel [raw]",
896 .function = show_vxlan_tunnel_command_fn,
902 vnet_int_vxlan_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable)
904 vxlan_main_t *vxm = &vxlan_main;
906 if (pool_is_free_index (vxm->vnet_main->interface_main.sw_interfaces,
910 is_enable = ! !is_enable;
914 if (clib_bitmap_get (vxm->bm_ip6_bypass_enabled_by_sw_if, sw_if_index)
917 vnet_feature_enable_disable ("ip6-unicast", "ip6-vxlan-bypass",
918 sw_if_index, is_enable, 0, 0);
919 vxm->bm_ip6_bypass_enabled_by_sw_if =
920 clib_bitmap_set (vxm->bm_ip6_bypass_enabled_by_sw_if,
921 sw_if_index, is_enable);
926 if (clib_bitmap_get (vxm->bm_ip4_bypass_enabled_by_sw_if, sw_if_index)
929 vnet_feature_enable_disable ("ip4-unicast", "ip4-vxlan-bypass",
930 sw_if_index, is_enable, 0, 0);
931 vxm->bm_ip4_bypass_enabled_by_sw_if =
932 clib_bitmap_set (vxm->bm_ip4_bypass_enabled_by_sw_if,
933 sw_if_index, is_enable);
939 static clib_error_t *
940 set_ip_vxlan_bypass (u32 is_ip6,
941 unformat_input_t * input, vlib_cli_command_t * cmd)
943 unformat_input_t _line_input, *line_input = &_line_input;
944 vnet_main_t *vnm = vnet_get_main ();
945 clib_error_t *error = 0;
946 u32 sw_if_index, is_enable;
951 if (!unformat_user (input, unformat_line_input, line_input))
954 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
957 (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
959 else if (unformat (line_input, "del"))
963 error = unformat_parse_error (line_input);
968 if (~0 == sw_if_index)
970 error = clib_error_return (0, "unknown interface `%U'",
971 format_unformat_error, line_input);
975 vnet_int_vxlan_bypass_mode (sw_if_index, is_ip6, is_enable);
978 unformat_free (line_input);
983 static clib_error_t *
984 set_ip4_vxlan_bypass (vlib_main_t * vm,
985 unformat_input_t * input, vlib_cli_command_t * cmd)
987 return set_ip_vxlan_bypass (0, input, cmd);
991 * This command adds the 'ip4-vxlan-bypass' graph node for a given interface.
992 * By adding the IPv4 vxlan-bypass graph node to an interface, the node checks
993 * for and validate input vxlan packet and bypass ip4-lookup, ip4-local,
994 * ip4-udp-lookup nodes to speedup vxlan packet forwarding. This node will
995 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
999 * Example of graph node before ip4-vxlan-bypass is enabled:
1000 * @cliexstart{show vlib graph ip4-vxlan-bypass}
1001 * Name Next Previous
1002 * ip4-vxlan-bypass error-drop [0]
1007 * Example of how to enable ip4-vxlan-bypass on an interface:
1008 * @cliexcmd{set interface ip vxlan-bypass GigabitEthernet2/0/0}
1010 * Example of graph node after ip4-vxlan-bypass is enabled:
1011 * @cliexstart{show vlib graph ip4-vxlan-bypass}
1012 * Name Next Previous
1013 * ip4-vxlan-bypass error-drop [0] ip4-input
1014 * vxlan4-input [1] ip4-input-no-checksum
1018 * Example of how to display the feature enabled on an interface:
1019 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1020 * IP feature paths configured on GigabitEthernet2/0/0...
1028 * Example of how to disable ip4-vxlan-bypass on an interface:
1029 * @cliexcmd{set interface ip vxlan-bypass GigabitEthernet2/0/0 del}
1033 VLIB_CLI_COMMAND (set_interface_ip_vxlan_bypass_command, static) = {
1034 .path = "set interface ip vxlan-bypass",
1035 .function = set_ip4_vxlan_bypass,
1036 .short_help = "set interface ip vxlan-bypass <interface> [del]",
1040 static clib_error_t *
1041 set_ip6_vxlan_bypass (vlib_main_t * vm,
1042 unformat_input_t * input, vlib_cli_command_t * cmd)
1044 return set_ip_vxlan_bypass (1, input, cmd);
1048 * This command adds the 'ip6-vxlan-bypass' graph node for a given interface.
1049 * By adding the IPv6 vxlan-bypass graph node to an interface, the node checks
1050 * for and validate input vxlan packet and bypass ip6-lookup, ip6-local,
1051 * ip6-udp-lookup nodes to speedup vxlan packet forwarding. This node will
1052 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
1056 * Example of graph node before ip6-vxlan-bypass is enabled:
1057 * @cliexstart{show vlib graph ip6-vxlan-bypass}
1058 * Name Next Previous
1059 * ip6-vxlan-bypass error-drop [0]
1064 * Example of how to enable ip6-vxlan-bypass on an interface:
1065 * @cliexcmd{set interface ip6 vxlan-bypass GigabitEthernet2/0/0}
1067 * Example of graph node after ip6-vxlan-bypass is enabled:
1068 * @cliexstart{show vlib graph ip6-vxlan-bypass}
1069 * Name Next Previous
1070 * ip6-vxlan-bypass error-drop [0] ip6-input
1071 * vxlan6-input [1] ip4-input-no-checksum
1075 * Example of how to display the feature enabled on an interface:
1076 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1077 * IP feature paths configured on GigabitEthernet2/0/0...
1085 * Example of how to disable ip6-vxlan-bypass on an interface:
1086 * @cliexcmd{set interface ip6 vxlan-bypass GigabitEthernet2/0/0 del}
1090 VLIB_CLI_COMMAND (set_interface_ip6_vxlan_bypass_command, static) = {
1091 .path = "set interface ip6 vxlan-bypass",
1092 .function = set_ip6_vxlan_bypass,
1093 .short_help = "set interface ip6 vxlan-bypass <interface> [del]",
1098 vnet_vxlan_add_del_rx_flow (u32 hw_if_index, u32 t_index, int is_add)
1100 vxlan_main_t *vxm = &vxlan_main;
1101 vxlan_tunnel_t *t = pool_elt_at_index (vxm->tunnels, t_index);
1102 vnet_main_t *vnm = vnet_get_main ();
1105 if (t->flow_index == ~0)
1107 vxlan_main_t *vxm = &vxlan_main;
1108 vnet_flow_t flow = {
1110 VNET_FLOW_ACTION_REDIRECT_TO_NODE | VNET_FLOW_ACTION_MARK |
1111 VNET_FLOW_ACTION_BUFFER_ADVANCE,
1112 .mark_flow_id = t->dev_instance + vxm->flow_id_start,
1113 .redirect_node_index = vxlan4_flow_input_node.index,
1114 .buffer_advance = sizeof (ethernet_header_t),
1115 .type = VNET_FLOW_TYPE_IP4_VXLAN,
1117 .src_addr = t->dst.ip4,
1118 .dst_addr = t->src.ip4,
1119 .dst_port = UDP_DST_PORT_vxlan,
1124 vnet_flow_add (vnm, &flow, &t->flow_index);
1126 return vnet_flow_enable (vnm, t->flow_index, hw_if_index);
1128 /* flow index is removed when the tunnel is deleted */
1129 return vnet_flow_disable (vnm, t->flow_index, hw_if_index);
1133 vnet_vxlan_get_tunnel_index (u32 sw_if_index)
1135 vxlan_main_t *vxm = &vxlan_main;
1137 if (sw_if_index >= vec_len (vxm->tunnel_index_by_sw_if_index))
1139 return vxm->tunnel_index_by_sw_if_index[sw_if_index];
1142 static clib_error_t *
1143 vxlan_offload_command_fn (vlib_main_t * vm,
1144 unformat_input_t * input, vlib_cli_command_t * cmd)
1146 unformat_input_t _line_input, *line_input = &_line_input;
1148 /* Get a line of input. */
1149 if (!unformat_user (input, unformat_line_input, line_input))
1152 vnet_main_t *vnm = vnet_get_main ();
1153 u32 rx_sw_if_index = ~0;
1154 u32 hw_if_index = ~0;
1157 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1159 if (unformat (line_input, "hw %U", unformat_vnet_hw_interface, vnm,
1162 if (unformat (line_input, "rx %U", unformat_vnet_sw_interface, vnm,
1165 if (unformat (line_input, "del"))
1170 return clib_error_return (0, "unknown input `%U'",
1171 format_unformat_error, line_input);
1174 if (rx_sw_if_index == ~0)
1175 return clib_error_return (0, "missing rx interface");
1176 if (hw_if_index == ~0)
1177 return clib_error_return (0, "missing hw interface");
1179 u32 t_index = vnet_vxlan_get_tunnel_index (rx_sw_if_index);;
1181 return clib_error_return (0, "%U is not a vxlan tunnel",
1182 format_vnet_sw_if_index_name, vnm,
1185 vxlan_main_t *vxm = &vxlan_main;
1186 vxlan_tunnel_t *t = pool_elt_at_index (vxm->tunnels, t_index);
1188 if (!ip46_address_is_ip4 (&t->dst))
1189 return clib_error_return (0, "currently only IPV4 tunnels are supported");
1191 vnet_hw_interface_t *hw_if = vnet_get_hw_interface (vnm, hw_if_index);
1192 ip4_main_t *im = &ip4_main;
1194 vec_elt (im->fib_index_by_sw_if_index, hw_if->sw_if_index);
1196 if (t->encap_fib_index != rx_fib_index)
1197 return clib_error_return (0, "interface/tunnel fib mismatch");
1199 if (vnet_vxlan_add_del_rx_flow (hw_if_index, t_index, is_add))
1200 return clib_error_return (0, "error %s flow",
1201 is_add ? "enabling" : "disabling");
1207 VLIB_CLI_COMMAND (vxlan_offload_command, static) = {
1208 .path = "set flow-offload vxlan",
1210 "set flow-offload vxlan hw <interface-name> rx <tunnel-name> [del]",
1211 .function = vxlan_offload_command_fn,
1215 #define VXLAN_HASH_NUM_BUCKETS (2 * 1024)
1216 #define VXLAN_HASH_MEMORY_SIZE (1 << 20)
1219 vxlan_init (vlib_main_t * vm)
1221 vxlan_main_t *vxm = &vxlan_main;
1223 vxm->vnet_main = vnet_get_main ();
1224 vxm->vlib_main = vm;
1226 vnet_flow_get_range (vxm->vnet_main, "vxlan", 1024 * 1024,
1227 &vxm->flow_id_start);
1229 vxm->bm_ip4_bypass_enabled_by_sw_if = 0;
1230 vxm->bm_ip6_bypass_enabled_by_sw_if = 0;
1232 /* initialize the ip6 hash */
1233 clib_bihash_init_16_8 (&vxm->vxlan4_tunnel_by_key, "vxlan4",
1234 VXLAN_HASH_NUM_BUCKETS, VXLAN_HASH_MEMORY_SIZE);
1235 clib_bihash_init_24_8 (&vxm->vxlan6_tunnel_by_key, "vxlan6",
1236 VXLAN_HASH_NUM_BUCKETS, VXLAN_HASH_MEMORY_SIZE);
1237 vxm->vtep_table = vtep_table_create ();
1238 vxm->mcast_shared = hash_create_mem (0,
1239 sizeof (ip46_address_t),
1240 sizeof (mcast_shared_t));
1242 fib_node_register_type (FIB_NODE_TYPE_VXLAN_TUNNEL, &vxlan_vft);
1247 VLIB_INIT_FUNCTION (vxlan_init);
1250 * fd.io coding-style-patch-verification: ON
1253 * eval: (c-set-style "gnu")