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/mfib/mfib_table.h>
20 #include <vnet/adj/adj_mcast.h>
21 #include <vnet/adj/rewrite.h>
22 #include <vnet/interface.h>
23 #include <vnet/flow/flow.h>
24 #include <vlib/vlib.h>
30 * VXLAN provides the features needed to allow L2 bridge domains (BDs)
31 * to span multiple servers. This is done by building an L2 overlay on
32 * top of an L3 network underlay using VXLAN tunnels.
34 * This makes it possible for servers to be co-located in the same data
35 * center or be separated geographically as long as they are reachable
36 * through the underlay L3 network.
38 * You can refer to this kind of L2 overlay bridge domain as a VXLAN
39 * (Virtual eXtensible VLAN) segment.
43 vxlan_main_t vxlan_main;
46 format_decap_next (u8 * s, va_list * args)
48 u32 next_index = va_arg (*args, u32);
50 if (next_index == VXLAN_INPUT_NEXT_DROP)
51 return format (s, "drop");
53 return format (s, "index %d", next_index);
58 format_vxlan_tunnel (u8 * s, va_list * args)
60 vxlan_tunnel_t *t = va_arg (*args, vxlan_tunnel_t *);
63 "[%d] instance %d src %U dst %U vni %d fib-idx %d sw-if-idx %d ",
64 t->dev_instance, t->user_instance,
65 format_ip46_address, &t->src, IP46_TYPE_ANY,
66 format_ip46_address, &t->dst, IP46_TYPE_ANY,
67 t->vni, t->encap_fib_index, t->sw_if_index);
69 s = format (s, "encap-dpo-idx %d ", t->next_dpo.dpoi_index);
71 if (PREDICT_FALSE (t->decap_next_index != VXLAN_INPUT_NEXT_L2_INPUT))
72 s = format (s, "decap-next-%U ", format_decap_next, t->decap_next_index);
74 if (PREDICT_FALSE (ip46_address_is_multicast (&t->dst)))
75 s = format (s, "mcast-sw-if-idx %d ", t->mcast_sw_if_index);
77 if (t->flow_index != ~0)
78 s = format (s, "flow-index %d [%U]", t->flow_index,
79 format_flow_enabled_hw, t->flow_index);
85 format_vxlan_name (u8 * s, va_list * args)
87 u32 dev_instance = va_arg (*args, u32);
88 vxlan_main_t *vxm = &vxlan_main;
91 if (dev_instance == ~0)
92 return format (s, "<cached-unused>");
94 if (dev_instance >= vec_len (vxm->tunnels))
95 return format (s, "<improperly-referenced>");
97 t = pool_elt_at_index (vxm->tunnels, dev_instance);
99 return format (s, "vxlan_tunnel%d", t->user_instance);
102 static clib_error_t *
103 vxlan_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
105 u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
106 VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
107 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
109 return /* no error */ 0;
113 VNET_DEVICE_CLASS (vxlan_device_class, static) = {
115 .format_device_name = format_vxlan_name,
116 .format_tx_trace = format_vxlan_encap_trace,
117 .admin_up_down_function = vxlan_interface_admin_up_down,
122 format_vxlan_header_with_length (u8 * s, va_list * args)
124 u32 dev_instance = va_arg (*args, u32);
125 s = format (s, "unimplemented dev %u", dev_instance);
130 VNET_HW_INTERFACE_CLASS (vxlan_hw_class) = {
132 .format_header = format_vxlan_header_with_length,
133 .build_rewrite = default_build_rewrite,
138 vxlan_tunnel_restack_dpo (vxlan_tunnel_t * t)
140 u8 is_ip4 = ip46_address_is_ip4 (&t->dst);
141 dpo_id_t dpo = DPO_INVALID;
142 fib_forward_chain_type_t forw_type = is_ip4 ?
143 FIB_FORW_CHAIN_TYPE_UNICAST_IP4 : FIB_FORW_CHAIN_TYPE_UNICAST_IP6;
145 fib_entry_contribute_forwarding (t->fib_entry_index, forw_type, &dpo);
147 /* vxlan uses the payload hash as the udp source port
148 * hence the packet's hash is unknown
149 * skip single bucket load balance dpo's */
150 while (DPO_LOAD_BALANCE == dpo.dpoi_type)
152 load_balance_t *lb = load_balance_get (dpo.dpoi_index);
153 if (lb->lb_n_buckets > 1)
156 dpo_copy (&dpo, load_balance_get_bucket_i (lb, 0));
159 u32 encap_index = is_ip4 ?
160 vxlan4_encap_node.index : vxlan6_encap_node.index;
161 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
165 static vxlan_tunnel_t *
166 vxlan_tunnel_from_fib_node (fib_node_t * node)
168 ASSERT (FIB_NODE_TYPE_VXLAN_TUNNEL == node->fn_type);
169 return ((vxlan_tunnel_t *) (((char *) node) -
170 STRUCT_OFFSET_OF (vxlan_tunnel_t, node)));
174 * Function definition to backwalk a FIB node -
175 * Here we will restack the new dpo of VXLAN DIP to encap node.
177 static fib_node_back_walk_rc_t
178 vxlan_tunnel_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
180 vxlan_tunnel_restack_dpo (vxlan_tunnel_from_fib_node (node));
181 return (FIB_NODE_BACK_WALK_CONTINUE);
185 * Function definition to get a FIB node from its index
188 vxlan_tunnel_fib_node_get (fib_node_index_t index)
191 vxlan_main_t *vxm = &vxlan_main;
193 t = pool_elt_at_index (vxm->tunnels, index);
199 * Function definition to inform the FIB node that its last lock has gone.
202 vxlan_tunnel_last_lock_gone (fib_node_t * node)
205 * The VXLAN tunnel is a root of the graph. As such
206 * it never has children and thus is never locked.
212 * Virtual function table registered by VXLAN tunnels
213 * for participation in the FIB object graph.
215 const static fib_node_vft_t vxlan_vft = {
216 .fnv_get = vxlan_tunnel_fib_node_get,
217 .fnv_last_lock = vxlan_tunnel_last_lock_gone,
218 .fnv_back_walk = vxlan_tunnel_back_walk,
222 #define foreach_copy_field \
224 _(mcast_sw_if_index) \
226 _(decap_next_index) \
231 vxlan_rewrite (vxlan_tunnel_t * t, bool is_ip6)
235 ip4_vxlan_header_t h4;
236 ip6_vxlan_header_t h6;
238 int len = is_ip6 ? sizeof h.h6 : sizeof h.h4;
241 vxlan_header_t *vxlan;
242 /* Fixed portion of the (outer) ip header */
244 clib_memset (&h, 0, sizeof (h));
247 ip4_header_t *ip = &h.h4.ip4;
248 udp = &h.h4.udp, vxlan = &h.h4.vxlan;
249 ip->ip_version_and_header_length = 0x45;
251 ip->protocol = IP_PROTOCOL_UDP;
253 ip->src_address = t->src.ip4;
254 ip->dst_address = t->dst.ip4;
256 /* we fix up the ip4 header length and checksum after-the-fact */
257 ip->checksum = ip4_header_checksum (ip);
261 ip6_header_t *ip = &h.h6.ip6;
262 udp = &h.h6.udp, vxlan = &h.h6.vxlan;
263 ip->ip_version_traffic_class_and_flow_label =
264 clib_host_to_net_u32 (6 << 28);
266 ip->protocol = IP_PROTOCOL_UDP;
268 ip->src_address = t->src.ip6;
269 ip->dst_address = t->dst.ip6;
272 /* UDP header, randomize src port on something, maybe? */
273 udp->src_port = clib_host_to_net_u16 (4789);
274 udp->dst_port = clib_host_to_net_u16 (UDP_DST_PORT_vxlan);
277 vnet_set_vni_and_flags (vxlan, t->vni);
278 vnet_rewrite_set_data (*t, &h, len);
282 vxlan_decap_next_is_valid (vxlan_main_t * vxm, u32 is_ip6,
283 u32 decap_next_index)
285 vlib_main_t *vm = vxm->vlib_main;
286 u32 input_idx = (!is_ip6) ?
287 vxlan4_input_node.index : vxlan6_input_node.index;
288 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, input_idx);
290 return decap_next_index < r->n_next_nodes;
294 vtep_addr_ref (ip46_address_t * ip)
296 uword *vtep = ip46_address_is_ip4 (ip) ?
297 hash_get (vxlan_main.vtep4, ip->ip4.as_u32) :
298 hash_get_mem (vxlan_main.vtep6, &ip->ip6);
301 ip46_address_is_ip4 (ip) ?
302 hash_set (vxlan_main.vtep4, ip->ip4.as_u32, 1) :
303 hash_set_mem_alloc (&vxlan_main.vtep6, &ip->ip6, 1);
308 vtep_addr_unref (ip46_address_t * ip)
310 uword *vtep = ip46_address_is_ip4 (ip) ?
311 hash_get (vxlan_main.vtep4, ip->ip4.as_u32) :
312 hash_get_mem (vxlan_main.vtep6, &ip->ip6);
316 ip46_address_is_ip4 (ip) ?
317 hash_unset (vxlan_main.vtep4, ip->ip4.as_u32) :
318 hash_unset_mem_free (&vxlan_main.vtep6, &ip->ip6);
323 typedef CLIB_PACKED(union
327 fib_node_index_t mfib_entry_index;
328 adj_index_t mcast_adj_index;
334 static inline mcast_shared_t
335 mcast_shared_get (ip46_address_t * ip)
337 ASSERT (ip46_address_is_multicast (ip));
338 uword *p = hash_get_mem (vxlan_main.mcast_shared, ip);
340 mcast_shared_t ret = {.as_u64 = *p };
345 mcast_shared_add (ip46_address_t * dst, fib_node_index_t mfei, adj_index_t ai)
347 mcast_shared_t new_ep = {
348 .mcast_adj_index = ai,
349 .mfib_entry_index = mfei,
352 hash_set_mem_alloc (&vxlan_main.mcast_shared, dst, new_ep.as_u64);
356 mcast_shared_remove (ip46_address_t * dst)
358 mcast_shared_t ep = mcast_shared_get (dst);
360 adj_unlock (ep.mcast_adj_index);
361 mfib_table_entry_delete_index (ep.mfib_entry_index, MFIB_SOURCE_VXLAN);
363 hash_unset_mem_free (&vxlan_main.mcast_shared, dst);
366 int vnet_vxlan_add_del_tunnel
367 (vnet_vxlan_add_del_tunnel_args_t * a, u32 * sw_if_indexp)
369 vxlan_main_t *vxm = &vxlan_main;
370 vnet_main_t *vnm = vxm->vnet_main;
371 vxlan_decap_info_t *p;
372 u32 sw_if_index = ~0;
373 vxlan4_tunnel_key_t key4;
374 vxlan6_tunnel_key_t key6;
375 u32 is_ip6 = a->is_ip6;
380 /* ip4 mcast is indexed by mcast addr only */
381 key4.key[0] = ip46_address_is_multicast (&a->dst) ?
383 a->dst.ip4.as_u32 | (((u64) a->src.ip4.as_u32) << 32);
384 key4.key[1] = (((u64) a->encap_fib_index) << 32)
385 | clib_host_to_net_u32 (a->vni << 8);
387 clib_bihash_search_inline_16_8 (&vxm->vxlan4_tunnel_by_key, &key4);
388 p = (void *) &key4.value;
392 key6.key[0] = a->dst.ip6.as_u64[0];
393 key6.key[1] = a->dst.ip6.as_u64[1];
394 key6.key[2] = (((u64) a->encap_fib_index) << 32)
395 | clib_host_to_net_u32 (a->vni << 8);
397 clib_bihash_search_inline_24_8 (&vxm->vxlan6_tunnel_by_key, &key6);
398 p = (void *) &key6.value;
406 l2input_main_t *l2im = &l2input_main;
407 u32 dev_instance; /* real dev instance tunnel index */
408 u32 user_instance; /* request and actual instance number */
410 /* adding a tunnel: tunnel must not already exist */
412 return VNET_API_ERROR_TUNNEL_EXIST;
414 /*if not set explicitly, default to l2 */
415 if (a->decap_next_index == ~0)
416 a->decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
417 if (!vxlan_decap_next_is_valid (vxm, is_ip6, a->decap_next_index))
418 return VNET_API_ERROR_INVALID_DECAP_NEXT;
421 pool_get_aligned (vxm->tunnels, t, CLIB_CACHE_LINE_BYTES);
422 clib_memset (t, 0, sizeof (*t));
423 dev_instance = t - vxm->tunnels;
425 /* copy from arg structure */
426 #define _(x) t->x = a->x;
430 vxlan_rewrite (t, is_ip6);
432 * Reconcile the real dev_instance and a possible requested instance.
434 user_instance = a->instance;
435 if (user_instance == ~0)
436 user_instance = dev_instance;
437 if (hash_get (vxm->instance_used, user_instance))
439 pool_put (vxm->tunnels, t);
440 return VNET_API_ERROR_INSTANCE_IN_USE;
442 hash_set (vxm->instance_used, user_instance, 1);
444 t->dev_instance = dev_instance; /* actual */
445 t->user_instance = user_instance; /* name */
448 t->hw_if_index = vnet_register_interface
449 (vnm, vxlan_device_class.index, dev_instance,
450 vxlan_hw_class.index, dev_instance);
451 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, t->hw_if_index);
453 /* Set vxlan tunnel output node */
454 u32 encap_index = !is_ip6 ?
455 vxlan4_encap_node.index : vxlan6_encap_node.index;
456 vnet_set_interface_output_node (vnm, t->hw_if_index, encap_index);
458 t->sw_if_index = sw_if_index = hi->sw_if_index;
464 key6.value = (u64) dev_instance;
465 add_failed = clib_bihash_add_del_24_8 (&vxm->vxlan6_tunnel_by_key,
470 vxlan_decap_info_t di = {.sw_if_index = t->sw_if_index, };
471 if (ip46_address_is_multicast (&t->dst))
472 di.local_ip = t->src.ip4;
474 di.next_index = t->decap_next_index;
475 key4.value = di.as_u64;
476 add_failed = clib_bihash_add_del_16_8 (&vxm->vxlan4_tunnel_by_key,
482 vnet_delete_hw_interface (vnm, t->hw_if_index);
483 hash_unset (vxm->instance_used, t->user_instance);
484 pool_put (vxm->tunnels, t);
485 return VNET_API_ERROR_INVALID_REGISTRATION;
488 vec_validate_init_empty (vxm->tunnel_index_by_sw_if_index, sw_if_index,
490 vxm->tunnel_index_by_sw_if_index[sw_if_index] = dev_instance;
492 /* setup l2 input config with l2 feature and bd 0 to drop packet */
493 vec_validate (l2im->configs, sw_if_index);
494 l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
495 l2im->configs[sw_if_index].bd_index = 0;
497 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
498 si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
499 vnet_sw_interface_set_flags (vnm, sw_if_index,
500 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
502 fib_node_init (&t->node, FIB_NODE_TYPE_VXLAN_TUNNEL);
503 fib_prefix_t tun_dst_pfx;
504 vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
506 fib_prefix_from_ip46_addr (&t->dst, &tun_dst_pfx);
507 if (!ip46_address_is_multicast (&t->dst))
510 * source the FIB entry for the tunnel's destination
511 * and become a child thereof. The tunnel will then get poked
512 * when the forwarding for the entry updates, and the tunnel can
513 * re-stack accordingly
515 vtep_addr_ref (&t->src);
516 t->fib_entry_index = fib_table_entry_special_add
517 (t->encap_fib_index, &tun_dst_pfx, FIB_SOURCE_RR,
518 FIB_ENTRY_FLAG_NONE);
519 t->sibling_index = fib_entry_child_add
520 (t->fib_entry_index, FIB_NODE_TYPE_VXLAN_TUNNEL, dev_instance);
521 vxlan_tunnel_restack_dpo (t);
525 /* Multicast tunnel -
526 * as the same mcast group can be used for multiple mcast tunnels
527 * with different VNIs, create the output fib adjacency only if
528 * it does not already exist
530 fib_protocol_t fp = fib_ip_proto (is_ip6);
532 if (vtep_addr_ref (&t->dst) == 1)
534 fib_node_index_t mfei;
536 fib_route_path_t path = {
537 .frp_proto = fib_proto_to_dpo (fp),
538 .frp_addr = zero_addr,
539 .frp_sw_if_index = 0xffffffff,
542 .frp_flags = FIB_ROUTE_PATH_LOCAL,
544 const mfib_prefix_t mpfx = {
546 .fp_len = (is_ip6 ? 128 : 32),
547 .fp_grp_addr = tun_dst_pfx.fp_addr,
551 * Setup the (*,G) to receive traffic on the mcast group
552 * - the forwarding interface is for-us
553 * - the accepting interface is that from the API
555 mfib_table_entry_path_update (t->encap_fib_index,
558 &path, MFIB_ITF_FLAG_FORWARD);
560 path.frp_sw_if_index = a->mcast_sw_if_index;
561 path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
562 mfei = mfib_table_entry_path_update (t->encap_fib_index,
566 MFIB_ITF_FLAG_ACCEPT);
569 * Create the mcast adjacency to send traffic to the group
571 ai = adj_mcast_add_or_lock (fp,
572 fib_proto_to_link (fp),
573 a->mcast_sw_if_index);
576 * create a new end-point
578 mcast_shared_add (&t->dst, mfei, ai);
581 dpo_id_t dpo = DPO_INVALID;
582 mcast_shared_t ep = mcast_shared_get (&t->dst);
584 /* Stack shared mcast dst mac addr rewrite on encap */
585 dpo_set (&dpo, DPO_ADJACENCY_MCAST,
586 fib_proto_to_dpo (fp), ep.mcast_adj_index);
588 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
590 flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
593 vnet_get_sw_interface (vnet_get_main (), sw_if_index)->flood_class =
598 /* deleting a tunnel: tunnel must exist */
600 return VNET_API_ERROR_NO_SUCH_ENTRY;
602 u32 instance = is_ip6 ? key6.value :
603 vxm->tunnel_index_by_sw_if_index[p->sw_if_index];
604 vxlan_tunnel_t *t = pool_elt_at_index (vxm->tunnels, instance);
606 sw_if_index = t->sw_if_index;
607 vnet_sw_interface_set_flags (vnm, sw_if_index, 0 /* down */ );
609 vxm->tunnel_index_by_sw_if_index[sw_if_index] = ~0;
612 clib_bihash_add_del_16_8 (&vxm->vxlan4_tunnel_by_key, &key4,
615 clib_bihash_add_del_24_8 (&vxm->vxlan6_tunnel_by_key, &key6,
618 if (!ip46_address_is_multicast (&t->dst))
620 if (t->flow_index != ~0)
621 vnet_flow_del (vnm, t->flow_index);
623 vtep_addr_unref (&t->src);
624 fib_entry_child_remove (t->fib_entry_index, t->sibling_index);
625 fib_table_entry_delete_index (t->fib_entry_index, FIB_SOURCE_RR);
627 else if (vtep_addr_unref (&t->dst) == 0)
629 mcast_shared_remove (&t->dst);
632 vnet_delete_hw_interface (vnm, t->hw_if_index);
633 hash_unset (vxm->instance_used, t->user_instance);
635 fib_node_deinit (&t->node);
636 pool_put (vxm->tunnels, t);
640 *sw_if_indexp = sw_if_index;
646 get_decap_next_for_node (u32 node_index, u32 ipv4_set)
648 vxlan_main_t *vxm = &vxlan_main;
649 vlib_main_t *vm = vxm->vlib_main;
650 uword input_node = (ipv4_set) ? vxlan4_input_node.index :
651 vxlan6_input_node.index;
653 return vlib_node_add_next (vm, input_node, node_index);
657 unformat_decap_next (unformat_input_t * input, va_list * args)
659 u32 *result = va_arg (*args, u32 *);
660 u32 ipv4_set = va_arg (*args, int);
661 vxlan_main_t *vxm = &vxlan_main;
662 vlib_main_t *vm = vxm->vlib_main;
666 if (unformat (input, "l2"))
667 *result = VXLAN_INPUT_NEXT_L2_INPUT;
668 else if (unformat (input, "node %U", unformat_vlib_node, vm, &node_index))
669 *result = get_decap_next_for_node (node_index, ipv4_set);
670 else if (unformat (input, "%d", &tmp))
677 static clib_error_t *
678 vxlan_add_del_tunnel_command_fn (vlib_main_t * vm,
679 unformat_input_t * input,
680 vlib_cli_command_t * cmd)
682 unformat_input_t _line_input, *line_input = &_line_input;
683 ip46_address_t src = ip46_address_initializer, dst =
684 ip46_address_initializer;
692 u32 encap_fib_index = 0;
693 u32 mcast_sw_if_index = ~0;
694 u32 decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
697 clib_error_t *parse_error = NULL;
699 /* Get a line of input. */
700 if (!unformat_user (input, unformat_line_input, line_input))
703 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
705 if (unformat (line_input, "del"))
709 else if (unformat (line_input, "instance %d", &instance))
711 else if (unformat (line_input, "src %U",
712 unformat_ip46_address, &src, IP46_TYPE_ANY))
715 ip46_address_is_ip4 (&src) ? (ipv4_set = 1) : (ipv6_set = 1);
717 else if (unformat (line_input, "dst %U",
718 unformat_ip46_address, &dst, IP46_TYPE_ANY))
721 ip46_address_is_ip4 (&dst) ? (ipv4_set = 1) : (ipv6_set = 1);
723 else if (unformat (line_input, "group %U %U",
724 unformat_ip46_address, &dst, IP46_TYPE_ANY,
725 unformat_vnet_sw_interface,
726 vnet_get_main (), &mcast_sw_if_index))
728 grp_set = dst_set = 1;
729 ip46_address_is_ip4 (&dst) ? (ipv4_set = 1) : (ipv6_set = 1);
731 else if (unformat (line_input, "encap-vrf-id %d", &table_id))
734 fib_table_find (fib_ip_proto (ipv6_set), table_id);
736 else if (unformat (line_input, "decap-next %U", unformat_decap_next,
737 &decap_next_index, ipv4_set))
739 else if (unformat (line_input, "vni %d", &vni))
743 parse_error = clib_error_return (0, "parse error: '%U'",
744 format_unformat_error, line_input);
749 unformat_free (line_input);
754 if (encap_fib_index == ~0)
755 return clib_error_return (0, "nonexistent encap-vrf-id %d", table_id);
758 return clib_error_return (0, "tunnel src address not specified");
761 return clib_error_return (0, "tunnel dst address not specified");
763 if (grp_set && !ip46_address_is_multicast (&dst))
764 return clib_error_return (0, "tunnel group address not multicast");
766 if (grp_set == 0 && ip46_address_is_multicast (&dst))
767 return clib_error_return (0, "dst address must be unicast");
769 if (grp_set && mcast_sw_if_index == ~0)
770 return clib_error_return (0, "tunnel nonexistent multicast device");
772 if (ipv4_set && ipv6_set)
773 return clib_error_return (0, "both IPv4 and IPv6 addresses specified");
775 if (ip46_address_cmp (&src, &dst) == 0)
776 return clib_error_return (0, "src and dst addresses are identical");
778 if (decap_next_index == ~0)
779 return clib_error_return (0, "next node not found");
782 return clib_error_return (0, "vni not specified");
785 return clib_error_return (0, "vni %d out of range", vni);
787 vnet_vxlan_add_del_tunnel_args_t a = {
790 .instance = instance,
796 u32 tunnel_sw_if_index;
797 int rv = vnet_vxlan_add_del_tunnel (&a, &tunnel_sw_if_index);
803 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
804 vnet_get_main (), tunnel_sw_if_index);
807 case VNET_API_ERROR_TUNNEL_EXIST:
808 return clib_error_return (0, "tunnel already exists...");
810 case VNET_API_ERROR_NO_SUCH_ENTRY:
811 return clib_error_return (0, "tunnel does not exist...");
813 case VNET_API_ERROR_INSTANCE_IN_USE:
814 return clib_error_return (0, "Instance is in use");
817 return clib_error_return
818 (0, "vnet_vxlan_add_del_tunnel returned %d", rv);
825 * Add or delete a VXLAN Tunnel.
827 * VXLAN provides the features needed to allow L2 bridge domains (BDs)
828 * to span multiple servers. This is done by building an L2 overlay on
829 * top of an L3 network underlay using VXLAN tunnels.
831 * This makes it possible for servers to be co-located in the same data
832 * center or be separated geographically as long as they are reachable
833 * through the underlay L3 network.
835 * You can refer to this kind of L2 overlay bridge domain as a VXLAN
836 * (Virtual eXtensible VLAN) segment.
839 * Example of how to create a VXLAN Tunnel:
840 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 encap-vrf-id 7}
841 * Example of how to create a VXLAN Tunnel with a known name, vxlan_tunnel42:
842 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 instance 42}
843 * Example of how to create a multicast VXLAN Tunnel with a known name, vxlan_tunnel23:
844 * @cliexcmd{create vxlan tunnel src 10.0.3.1 group 239.1.1.1 GigabitEthernet0/8/0 instance 23}
845 * Example of how to delete a VXLAN Tunnel:
846 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 del}
849 VLIB_CLI_COMMAND (create_vxlan_tunnel_command, static) = {
850 .path = "create vxlan tunnel",
852 "create vxlan tunnel src <local-vtep-addr>"
853 " {dst <remote-vtep-addr>|group <mcast-vtep-addr> <intf-name>} vni <nn>"
855 " [encap-vrf-id <nn>] [decap-next [l2|node <name>]] [del]",
856 .function = vxlan_add_del_tunnel_command_fn,
860 static clib_error_t *
861 show_vxlan_tunnel_command_fn (vlib_main_t * vm,
862 unformat_input_t * input,
863 vlib_cli_command_t * cmd)
865 vxlan_main_t *vxm = &vxlan_main;
869 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
871 if (unformat (input, "raw"))
874 return clib_error_return (0, "parse error: '%U'",
875 format_unformat_error, input);
878 if (pool_elts (vxm->tunnels) == 0)
879 vlib_cli_output (vm, "No vxlan tunnels configured...");
882 pool_foreach (t, vxm->tunnels,
884 vlib_cli_output (vm, "%U", format_vxlan_tunnel, t);
890 vlib_cli_output (vm, "Raw IPv4 Hash Table:\n%U\n",
891 format_bihash_16_8, &vxm->vxlan4_tunnel_by_key,
893 vlib_cli_output (vm, "Raw IPv6 Hash Table:\n%U\n",
894 format_bihash_24_8, &vxm->vxlan6_tunnel_by_key,
902 * Display all the VXLAN Tunnel entries.
905 * Example of how to display the VXLAN Tunnel entries:
906 * @cliexstart{show vxlan tunnel}
907 * [0] src 10.0.3.1 dst 10.0.3.3 vni 13 encap_fib_index 0 sw_if_index 5 decap_next l2
911 VLIB_CLI_COMMAND (show_vxlan_tunnel_command, static) = {
912 .path = "show vxlan tunnel",
913 .short_help = "show vxlan tunnel [raw]",
914 .function = show_vxlan_tunnel_command_fn,
920 vnet_int_vxlan_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable)
923 vnet_feature_enable_disable ("ip6-unicast", "ip6-vxlan-bypass",
924 sw_if_index, is_enable, 0, 0);
926 vnet_feature_enable_disable ("ip4-unicast", "ip4-vxlan-bypass",
927 sw_if_index, is_enable, 0, 0);
931 static clib_error_t *
932 set_ip_vxlan_bypass (u32 is_ip6,
933 unformat_input_t * input, vlib_cli_command_t * cmd)
935 unformat_input_t _line_input, *line_input = &_line_input;
936 vnet_main_t *vnm = vnet_get_main ();
937 clib_error_t *error = 0;
938 u32 sw_if_index, is_enable;
943 if (!unformat_user (input, unformat_line_input, line_input))
946 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
949 (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
951 else if (unformat (line_input, "del"))
955 error = unformat_parse_error (line_input);
960 if (~0 == sw_if_index)
962 error = clib_error_return (0, "unknown interface `%U'",
963 format_unformat_error, line_input);
967 vnet_int_vxlan_bypass_mode (sw_if_index, is_ip6, is_enable);
970 unformat_free (line_input);
975 static clib_error_t *
976 set_ip4_vxlan_bypass (vlib_main_t * vm,
977 unformat_input_t * input, vlib_cli_command_t * cmd)
979 return set_ip_vxlan_bypass (0, input, cmd);
983 * This command adds the 'ip4-vxlan-bypass' graph node for a given interface.
984 * By adding the IPv4 vxlan-bypass graph node to an interface, the node checks
985 * for and validate input vxlan packet and bypass ip4-lookup, ip4-local,
986 * ip4-udp-lookup nodes to speedup vxlan packet forwarding. This node will
987 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
991 * Example of graph node before ip4-vxlan-bypass is enabled:
992 * @cliexstart{show vlib graph ip4-vxlan-bypass}
994 * ip4-vxlan-bypass error-drop [0]
999 * Example of how to enable ip4-vxlan-bypass on an interface:
1000 * @cliexcmd{set interface ip vxlan-bypass GigabitEthernet2/0/0}
1002 * Example of graph node after ip4-vxlan-bypass is enabled:
1003 * @cliexstart{show vlib graph ip4-vxlan-bypass}
1004 * Name Next Previous
1005 * ip4-vxlan-bypass error-drop [0] ip4-input
1006 * vxlan4-input [1] ip4-input-no-checksum
1010 * Example of how to display the feature enabled on an interface:
1011 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1012 * IP feature paths configured on GigabitEthernet2/0/0...
1020 * Example of how to disable ip4-vxlan-bypass on an interface:
1021 * @cliexcmd{set interface ip vxlan-bypass GigabitEthernet2/0/0 del}
1025 VLIB_CLI_COMMAND (set_interface_ip_vxlan_bypass_command, static) = {
1026 .path = "set interface ip vxlan-bypass",
1027 .function = set_ip4_vxlan_bypass,
1028 .short_help = "set interface ip vxlan-bypass <interface> [del]",
1032 static clib_error_t *
1033 set_ip6_vxlan_bypass (vlib_main_t * vm,
1034 unformat_input_t * input, vlib_cli_command_t * cmd)
1036 return set_ip_vxlan_bypass (1, input, cmd);
1040 * This command adds the 'ip6-vxlan-bypass' graph node for a given interface.
1041 * By adding the IPv6 vxlan-bypass graph node to an interface, the node checks
1042 * for and validate input vxlan packet and bypass ip6-lookup, ip6-local,
1043 * ip6-udp-lookup nodes to speedup vxlan packet forwarding. This node will
1044 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
1048 * Example of graph node before ip6-vxlan-bypass is enabled:
1049 * @cliexstart{show vlib graph ip6-vxlan-bypass}
1050 * Name Next Previous
1051 * ip6-vxlan-bypass error-drop [0]
1056 * Example of how to enable ip6-vxlan-bypass on an interface:
1057 * @cliexcmd{set interface ip6 vxlan-bypass GigabitEthernet2/0/0}
1059 * Example of graph node after ip6-vxlan-bypass is enabled:
1060 * @cliexstart{show vlib graph ip6-vxlan-bypass}
1061 * Name Next Previous
1062 * ip6-vxlan-bypass error-drop [0] ip6-input
1063 * vxlan6-input [1] ip4-input-no-checksum
1067 * Example of how to display the feature enabled on an interface:
1068 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1069 * IP feature paths configured on GigabitEthernet2/0/0...
1077 * Example of how to disable ip6-vxlan-bypass on an interface:
1078 * @cliexcmd{set interface ip6 vxlan-bypass GigabitEthernet2/0/0 del}
1082 VLIB_CLI_COMMAND (set_interface_ip6_vxlan_bypass_command, static) = {
1083 .path = "set interface ip6 vxlan-bypass",
1084 .function = set_ip6_vxlan_bypass,
1085 .short_help = "set interface ip vxlan-bypass <interface> [del]",
1090 vnet_vxlan_add_del_rx_flow (u32 hw_if_index, u32 t_index, int is_add)
1092 vxlan_main_t *vxm = &vxlan_main;
1093 vxlan_tunnel_t *t = pool_elt_at_index (vxm->tunnels, t_index);
1094 vnet_main_t *vnm = vnet_get_main ();
1097 if (t->flow_index == ~0)
1099 vxlan_main_t *vxm = &vxlan_main;
1100 vnet_flow_t flow = {
1102 VNET_FLOW_ACTION_REDIRECT_TO_NODE | VNET_FLOW_ACTION_MARK,
1103 .mark_flow_id = t->dev_instance + vxm->flow_id_start,
1104 .redirect_node_index = vxlan4_flow_input_node.index,
1105 .type = VNET_FLOW_TYPE_IP4_VXLAN,
1107 .src_addr = t->dst.ip4,
1108 .dst_addr = t->src.ip4,
1109 .dst_port = UDP_DST_PORT_vxlan,
1114 vnet_flow_add (vnm, &flow, &t->flow_index);
1116 return vnet_flow_enable (vnm, t->flow_index, hw_if_index);
1118 /* flow index is removed when the tunnel is deleted */
1119 return vnet_flow_disable (vnm, t->flow_index, hw_if_index);
1123 vnet_vxlan_get_tunnel_index (u32 sw_if_index)
1125 vxlan_main_t *vxm = &vxlan_main;
1127 if (sw_if_index >= vec_len (vxm->tunnel_index_by_sw_if_index))
1129 return vxm->tunnel_index_by_sw_if_index[sw_if_index];
1132 static clib_error_t *
1133 vxlan_offload_command_fn (vlib_main_t * vm,
1134 unformat_input_t * input, vlib_cli_command_t * cmd)
1136 unformat_input_t _line_input, *line_input = &_line_input;
1138 /* Get a line of input. */
1139 if (!unformat_user (input, unformat_line_input, line_input))
1142 vnet_main_t *vnm = vnet_get_main ();
1143 u32 rx_sw_if_index = ~0;
1144 u32 hw_if_index = ~0;
1147 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1149 if (unformat (line_input, "hw %U", unformat_vnet_hw_interface, vnm,
1152 if (unformat (line_input, "rx %U", unformat_vnet_sw_interface, vnm,
1155 if (unformat (line_input, "del"))
1160 return clib_error_return (0, "unknown input `%U'",
1161 format_unformat_error, line_input);
1164 if (rx_sw_if_index == ~0)
1165 return clib_error_return (0, "missing rx interface");
1166 if (hw_if_index == ~0)
1167 return clib_error_return (0, "missing hw interface");
1169 u32 t_index = vnet_vxlan_get_tunnel_index (rx_sw_if_index);;
1171 return clib_error_return (0, "%U is not a vxlan tunnel",
1172 format_vnet_sw_if_index_name, vnm,
1175 vxlan_main_t *vxm = &vxlan_main;
1176 vxlan_tunnel_t *t = pool_elt_at_index (vxm->tunnels, t_index);
1178 if (!ip46_address_is_ip4 (&t->dst))
1179 return clib_error_return (0, "currently only IPV4 tunnels are supported");
1181 vnet_hw_interface_t *hw_if = vnet_get_hw_interface (vnm, hw_if_index);
1182 ip4_main_t *im = &ip4_main;
1184 vec_elt (im->fib_index_by_sw_if_index, hw_if->sw_if_index);
1186 if (t->encap_fib_index != rx_fib_index)
1187 return clib_error_return (0, "interface/tunnel fib mismatch");
1189 if (vnet_vxlan_add_del_rx_flow (hw_if_index, t_index, is_add))
1190 return clib_error_return (0, "error %s flow",
1191 is_add ? "enabling" : "disabling");
1197 VLIB_CLI_COMMAND (vxlan_offload_command, static) = {
1198 .path = "set flow-offload vxlan",
1200 "set flow-offload vxlan hw <interface-name> rx <tunnel-name> [del]",
1201 .function = vxlan_offload_command_fn,
1205 #define VXLAN_HASH_NUM_BUCKETS (2 * 1024)
1206 #define VXLAN_HASH_MEMORY_SIZE (1 << 20)
1209 vxlan_init (vlib_main_t * vm)
1211 vxlan_main_t *vxm = &vxlan_main;
1213 vxm->vnet_main = vnet_get_main ();
1214 vxm->vlib_main = vm;
1216 vnet_flow_get_range (vxm->vnet_main, "vxlan", 1024 * 1024,
1217 &vxm->flow_id_start);
1219 /* initialize the ip6 hash */
1220 clib_bihash_init_16_8 (&vxm->vxlan4_tunnel_by_key, "vxlan4",
1221 VXLAN_HASH_NUM_BUCKETS, VXLAN_HASH_MEMORY_SIZE);
1222 clib_bihash_init_24_8 (&vxm->vxlan6_tunnel_by_key, "vxlan6",
1223 VXLAN_HASH_NUM_BUCKETS, VXLAN_HASH_MEMORY_SIZE);
1224 vxm->vtep6 = hash_create_mem (0, sizeof (ip6_address_t), sizeof (uword));
1225 vxm->mcast_shared = hash_create_mem (0,
1226 sizeof (ip46_address_t),
1227 sizeof (mcast_shared_t));
1229 udp_register_dst_port (vm, UDP_DST_PORT_vxlan,
1230 vxlan4_input_node.index, /* is_ip4 */ 1);
1231 udp_register_dst_port (vm, UDP_DST_PORT_vxlan6,
1232 vxlan6_input_node.index, /* is_ip4 */ 0);
1234 fib_node_register_type (FIB_NODE_TYPE_VXLAN_TUNNEL, &vxlan_vft);
1239 VLIB_INIT_FUNCTION (vxlan_init);
1242 * fd.io coding-style-patch-verification: ON
1245 * eval: (c-set-style "gnu")