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/interface.h>
22 #include <vlib/vlib.h>
28 * VXLAN provides the features needed to allow L2 bridge domains (BDs)
29 * to span multiple servers. This is done by building an L2 overlay on
30 * top of an L3 network underlay using VXLAN tunnels.
32 * This makes it possible for servers to be co-located in the same data
33 * center or be separated geographically as long as they are reachable
34 * through the underlay L3 network.
36 * You can refer to this kind of L2 overlay bridge domain as a VXLAN
37 * (Virtual eXtensible VLAN) segment.
41 vxlan_main_t vxlan_main;
43 static u8 * format_decap_next (u8 * s, va_list * args)
45 u32 next_index = va_arg (*args, u32);
47 if (next_index == VXLAN_INPUT_NEXT_DROP)
48 return format (s, "drop");
50 return format (s, "index %d", next_index);
54 u8 * format_vxlan_tunnel (u8 * s, va_list * args)
56 vxlan_tunnel_t * t = va_arg (*args, vxlan_tunnel_t *);
57 vxlan_main_t * ngm = &vxlan_main;
61 dev_instance = t - ngm->tunnels;
62 user_instance = t->user_instance;
65 "[%d] instance %d src %U dst %U vni %d fib-idx %d sw-if-idx %d ",
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);
83 static u8 * format_vxlan_name (u8 * s, va_list * args)
85 u32 dev_instance = va_arg (*args, u32);
86 vxlan_main_t * vxm = &vxlan_main;
89 if (dev_instance == ~0)
90 return format(s, "<cached-unused>");
92 if (dev_instance >= vec_len(vxm->tunnels))
93 return format(s, "<improperly-referenced>");
95 t = pool_elt_at_index(vxm->tunnels, dev_instance);
97 return format (s, "vxlan_tunnel%d", t->user_instance);
100 static clib_error_t *
101 vxlan_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
103 u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
104 VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
105 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
107 return /* no error */ 0;
111 vxlan_name_renumber (vnet_hw_interface_t *hi, u32 new_dev_instance)
116 VNET_DEVICE_CLASS (vxlan_device_class,static) = {
118 .format_device_name = format_vxlan_name,
119 .name_renumber = vxlan_name_renumber,
120 .format_tx_trace = format_vxlan_encap_trace,
121 .admin_up_down_function = vxlan_interface_admin_up_down,
124 static u8 * format_vxlan_header_with_length (u8 * s, va_list * args)
126 u32 dev_instance = va_arg (*args, u32);
127 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,
138 vxlan_tunnel_restack_dpo(vxlan_tunnel_t * t)
140 dpo_id_t dpo = DPO_INVALID;
141 u32 encap_index = ip46_address_is_ip4(&t->dst) ?
142 vxlan4_encap_node.index : vxlan6_encap_node.index;
143 fib_forward_chain_type_t forw_type = ip46_address_is_ip4(&t->dst) ?
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);
147 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
151 static vxlan_tunnel_t *
152 vxlan_tunnel_from_fib_node (fib_node_t *node)
154 ASSERT(FIB_NODE_TYPE_VXLAN_TUNNEL == node->fn_type);
155 return ((vxlan_tunnel_t*) (((char*)node) -
156 STRUCT_OFFSET_OF(vxlan_tunnel_t, node)));
160 * Function definition to backwalk a FIB node -
161 * Here we will restack the new dpo of VXLAN DIP to encap node.
163 static fib_node_back_walk_rc_t
164 vxlan_tunnel_back_walk (fib_node_t *node,
165 fib_node_back_walk_ctx_t *ctx)
167 vxlan_tunnel_restack_dpo(vxlan_tunnel_from_fib_node(node));
168 return (FIB_NODE_BACK_WALK_CONTINUE);
172 * Function definition to get a FIB node from its index
175 vxlan_tunnel_fib_node_get (fib_node_index_t index)
178 vxlan_main_t * vxm = &vxlan_main;
180 t = pool_elt_at_index(vxm->tunnels, index);
186 * Function definition to inform the FIB node that its last lock has gone.
189 vxlan_tunnel_last_lock_gone (fib_node_t *node)
192 * The VXLAN tunnel is a root of the graph. As such
193 * it never has children and thus is never locked.
199 * Virtual function table registered by VXLAN tunnels
200 * for participation in the FIB object graph.
202 const static fib_node_vft_t vxlan_vft = {
203 .fnv_get = vxlan_tunnel_fib_node_get,
204 .fnv_last_lock = vxlan_tunnel_last_lock_gone,
205 .fnv_back_walk = vxlan_tunnel_back_walk,
209 #define foreach_copy_field \
211 _(mcast_sw_if_index) \
213 _(decap_next_index) \
218 vxlan_rewrite (vxlan_tunnel_t * t, bool is_ip6)
221 ip4_vxlan_header_t * h4;
222 ip6_vxlan_header_t * h6;
225 int len = is_ip6 ? sizeof *r.h6 : sizeof *r.h4;
227 vec_validate_aligned (r.rw, len-1, CLIB_CACHE_LINE_BYTES);
230 vxlan_header_t * vxlan;
231 /* Fixed portion of the (outer) ip header */
234 ip4_header_t * ip = &r.h4->ip4;
235 udp = &r.h4->udp, vxlan = &r.h4->vxlan;
236 ip->ip_version_and_header_length = 0x45;
238 ip->protocol = IP_PROTOCOL_UDP;
240 ip->src_address = t->src.ip4;
241 ip->dst_address = t->dst.ip4;
243 /* we fix up the ip4 header length and checksum after-the-fact */
244 ip->checksum = ip4_header_checksum (ip);
248 ip6_header_t * ip = &r.h6->ip6;
249 udp = &r.h6->udp, vxlan = &r.h6->vxlan;
250 ip->ip_version_traffic_class_and_flow_label = clib_host_to_net_u32(6 << 28);
252 ip->protocol = IP_PROTOCOL_UDP;
254 ip->src_address = t->src.ip6;
255 ip->dst_address = t->dst.ip6;
258 /* UDP header, randomize src port on something, maybe? */
259 udp->src_port = clib_host_to_net_u16 (4789);
260 udp->dst_port = clib_host_to_net_u16 (UDP_DST_PORT_vxlan);
263 vnet_set_vni_and_flags(vxlan, t->vni);
270 vxlan_decap_next_is_valid (vxlan_main_t * vxm, u32 is_ip6, u32 decap_next_index)
272 vlib_main_t * vm = vxm->vlib_main;
273 u32 input_idx = (!is_ip6) ? vxlan4_input_node.index : vxlan6_input_node.index;
274 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, input_idx);
276 return decap_next_index < r->n_next_nodes;
280 vtep_addr_ref(ip46_address_t *ip)
282 uword *vtep = ip46_address_is_ip4(ip) ?
283 hash_get (vxlan_main.vtep4, ip->ip4.as_u32) :
284 hash_get_mem (vxlan_main.vtep6, &ip->ip6);
287 ip46_address_is_ip4(ip) ?
288 hash_set (vxlan_main.vtep4, ip->ip4.as_u32, 1) :
289 hash_set_mem_alloc (&vxlan_main.vtep6, &ip->ip6, 1);
294 vtep_addr_unref(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);
302 ip46_address_is_ip4(ip) ?
303 hash_unset (vxlan_main.vtep4, ip->ip4.as_u32) :
304 hash_unset_mem_free (&vxlan_main.vtep6, &ip->ip6);
308 typedef CLIB_PACKED(union {
310 fib_node_index_t mfib_entry_index;
311 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 return (mcast_shared_t) { .as_u64 = *p };
326 mcast_shared_add(ip46_address_t *dst,
327 fib_node_index_t mfei,
330 mcast_shared_t new_ep = {
331 .mcast_adj_index = ai,
332 .mfib_entry_index = mfei,
335 hash_set_mem_alloc (&vxlan_main.mcast_shared, dst, new_ep.as_u64);
339 mcast_shared_remove(ip46_address_t *dst)
341 mcast_shared_t ep = mcast_shared_get(dst);
343 adj_unlock(ep.mcast_adj_index);
344 mfib_table_entry_delete_index(ep.mfib_entry_index,
347 hash_unset_mem_free (&vxlan_main.mcast_shared, dst);
350 int vnet_vxlan_add_del_tunnel
351 (vnet_vxlan_add_del_tunnel_args_t *a, u32 * sw_if_indexp)
353 vxlan_main_t * vxm = &vxlan_main;
354 vxlan_tunnel_t *t = 0;
355 vnet_main_t * vnm = vxm->vnet_main;
357 u32 hw_if_index = ~0;
358 u32 sw_if_index = ~0;
360 vxlan4_tunnel_key_t key4;
361 vxlan6_tunnel_key_t key6;
362 u32 is_ip6 = a->is_ip6;
366 key4.src = a->dst.ip4.as_u32; /* decap src in key is encap dst in config */
367 key4.vni = clib_host_to_net_u32 (a->vni << 8);
368 p = hash_get (vxm->vxlan4_tunnel_by_key, key4.as_u64);
372 key6.src = a->dst.ip6;
373 key6.vni = clib_host_to_net_u32 (a->vni << 8);
374 p = hash_get_mem (vxm->vxlan6_tunnel_by_key, &key6);
379 l2input_main_t * l2im = &l2input_main;
380 u32 dev_instance; /* real dev instance tunnel index */
381 u32 user_instance; /* request and actual instance number */
383 /* adding a tunnel: tunnel must not already exist */
385 return VNET_API_ERROR_TUNNEL_EXIST;
387 /*if not set explicitly, default to l2 */
388 if(a->decap_next_index == ~0)
389 a->decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
390 if (!vxlan_decap_next_is_valid(vxm, is_ip6, a->decap_next_index))
391 return VNET_API_ERROR_INVALID_DECAP_NEXT;
393 pool_get_aligned (vxm->tunnels, t, CLIB_CACHE_LINE_BYTES);
394 memset (t, 0, sizeof (*t));
395 dev_instance = t - vxm->tunnels;
397 /* copy from arg structure */
398 #define _(x) t->x = a->x;
402 rv = vxlan_rewrite (t, is_ip6);
405 pool_put (vxm->tunnels, t);
410 * Reconcile the real dev_instance and a possible requested instance.
412 user_instance = a->instance;
413 if (user_instance == ~0)
414 user_instance = dev_instance;
415 if (hash_get (vxm->instance_used, user_instance))
417 pool_put (vxm->tunnels, t);
418 return VNET_API_ERROR_INSTANCE_IN_USE;
420 hash_set (vxm->instance_used, user_instance, 1);
422 t->dev_instance = dev_instance; /* actual */
423 t->user_instance = user_instance; /* name */
427 hash_set_mem_alloc (&vxm->vxlan6_tunnel_by_key, &key6,
430 hash_set (vxm->vxlan4_tunnel_by_key, key4.as_u64, t - vxm->tunnels);
432 vnet_hw_interface_t * hi;
433 if (vec_len (vxm->free_vxlan_tunnel_hw_if_indices) > 0)
435 vnet_interface_main_t * im = &vnm->interface_main;
436 hw_if_index = vxm->free_vxlan_tunnel_hw_if_indices
437 [vec_len (vxm->free_vxlan_tunnel_hw_if_indices)-1];
438 _vec_len (vxm->free_vxlan_tunnel_hw_if_indices) -= 1;
440 hi = vnet_get_hw_interface (vnm, hw_if_index);
441 hi->dev_instance = dev_instance;
442 hi->hw_instance = dev_instance;
444 sw_if_index = hi->sw_if_index;
445 vnet_interface_name_renumber(sw_if_index, user_instance);
447 /* clear old stats of freed tunnel before reuse */
448 vnet_interface_counter_lock(im);
449 vlib_zero_combined_counter
450 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX], sw_if_index);
451 vlib_zero_combined_counter
452 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_RX], sw_if_index);
453 vlib_zero_simple_counter
454 (&im->sw_if_counters[VNET_INTERFACE_COUNTER_DROP], sw_if_index);
455 vnet_interface_counter_unlock(im);
459 hw_if_index = vnet_register_interface
460 (vnm, vxlan_device_class.index, t - vxm->tunnels,
461 vxlan_hw_class.index, t - vxm->tunnels);
462 hi = vnet_get_hw_interface (vnm, hw_if_index);
465 /* Set vxlan tunnel output node */
466 u32 encap_index = !is_ip6 ?
467 vxlan4_encap_node.index : vxlan6_encap_node.index;
468 vnet_set_interface_output_node (vnm, hw_if_index, encap_index);
470 t->hw_if_index = hw_if_index;
471 t->sw_if_index = sw_if_index = hi->sw_if_index;
473 vec_validate_init_empty (vxm->tunnel_index_by_sw_if_index, sw_if_index, ~0);
474 vxm->tunnel_index_by_sw_if_index[sw_if_index] = dev_instance;
476 /* setup l2 input config with l2 feature and bd 0 to drop packet */
477 vec_validate (l2im->configs, sw_if_index);
478 l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
479 l2im->configs[sw_if_index].bd_index = 0;
481 vnet_sw_interface_t * si = vnet_get_sw_interface (vnm, sw_if_index);
482 si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
483 vnet_sw_interface_set_flags (vnm, sw_if_index,
484 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
486 fib_node_init(&t->node, FIB_NODE_TYPE_VXLAN_TUNNEL);
487 fib_prefix_t tun_dst_pfx;
488 vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
490 fib_prefix_from_ip46_addr(&t->dst, &tun_dst_pfx);
491 if (!ip46_address_is_multicast(&t->dst))
494 * source the FIB entry for the tunnel's destination
495 * and become a child thereof. The tunnel will then get poked
496 * when the forwarding for the entry updates, and the tunnel can
497 * re-stack accordingly
499 vtep_addr_ref(&t->src);
500 t->fib_entry_index = fib_table_entry_special_add
501 (t->encap_fib_index, &tun_dst_pfx, FIB_SOURCE_RR,
502 FIB_ENTRY_FLAG_NONE);
503 t->sibling_index = fib_entry_child_add
504 (t->fib_entry_index, FIB_NODE_TYPE_VXLAN_TUNNEL, dev_instance);
505 vxlan_tunnel_restack_dpo(t);
509 /* Multicast tunnel -
510 * as the same mcast group can be used for mutiple mcast tunnels
511 * with different VNIs, create the output fib adjecency only if
512 * it does not already exist
514 fib_protocol_t fp = fib_ip_proto(is_ip6);
516 if (vtep_addr_ref(&t->dst) == 1)
518 fib_node_index_t mfei;
520 fib_route_path_t path = {
521 .frp_proto = fib_proto_to_dpo(fp),
522 .frp_addr = zero_addr,
523 .frp_sw_if_index = 0xffffffff,
526 .frp_flags = FIB_ROUTE_PATH_LOCAL,
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,
543 MFIB_ITF_FLAG_FORWARD);
545 path.frp_sw_if_index = a->mcast_sw_if_index;
546 path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
547 mfei = mfib_table_entry_path_update(t->encap_fib_index,
551 MFIB_ITF_FLAG_ACCEPT);
554 * Create the mcast adjacency to send traffic to the group
556 ai = adj_mcast_add_or_lock(fp,
557 fib_proto_to_link(fp),
558 a->mcast_sw_if_index);
561 * create a new end-point
563 mcast_shared_add(&t->dst, mfei, ai);
566 dpo_id_t dpo = DPO_INVALID;
567 mcast_shared_t ep = mcast_shared_get(&t->dst);
569 /* Stack shared mcast dst mac addr rewrite on encap */
570 dpo_set (&dpo, DPO_ADJACENCY_MCAST,
571 fib_proto_to_dpo(fp),
574 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
576 flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
579 vnet_get_sw_interface (vnet_get_main(), sw_if_index)->flood_class = flood_class;
583 /* deleting a tunnel: tunnel must exist */
585 return VNET_API_ERROR_NO_SUCH_ENTRY;
588 t = pool_elt_at_index (vxm->tunnels, instance);
590 sw_if_index = t->sw_if_index;
591 vnet_sw_interface_set_flags (vnm, sw_if_index, 0 /* down */);
592 vnet_sw_interface_t * si = vnet_get_sw_interface (vnm, sw_if_index);
593 si->flags |= VNET_SW_INTERFACE_FLAG_HIDDEN;
595 /* make sure tunnel is removed from l2 bd or xconnect */
596 set_int_l2_mode(vxm->vlib_main, vnm, MODE_L3, sw_if_index, 0, 0, 0, 0);
597 vec_add1 (vxm->free_vxlan_tunnel_hw_if_indices, t->hw_if_index);
599 vxm->tunnel_index_by_sw_if_index[sw_if_index] = ~0;
602 hash_unset (vxm->vxlan4_tunnel_by_key, key4.as_u64);
604 hash_unset_mem_free (&vxm->vxlan6_tunnel_by_key, &key6);
606 if (!ip46_address_is_multicast(&t->dst))
608 vtep_addr_unref(&t->src);
609 fib_entry_child_remove(t->fib_entry_index, t->sibling_index);
610 fib_table_entry_delete_index(t->fib_entry_index, FIB_SOURCE_RR);
612 else if (vtep_addr_unref(&t->dst) == 0)
614 mcast_shared_remove(&t->dst);
617 vnet_hw_interface_t *hi;
618 hi = vnet_get_hw_interface (vnm, t->hw_if_index);
619 hi->dev_instance = ~0;
621 hash_unset (vxlan_main.instance_used, instance);
623 fib_node_deinit(&t->node);
624 vec_free (t->rewrite);
625 pool_put (vxm->tunnels, t);
629 *sw_if_indexp = sw_if_index;
634 static uword get_decap_next_for_node(u32 node_index, u32 ipv4_set)
636 vxlan_main_t * vxm = &vxlan_main;
637 vlib_main_t * vm = vxm->vlib_main;
638 uword input_node = (ipv4_set) ? vxlan4_input_node.index :
639 vxlan6_input_node.index;
641 return vlib_node_add_next (vm, input_node, node_index);
644 static uword unformat_decap_next (unformat_input_t * input, va_list * args)
646 u32 * result = va_arg (*args, u32 *);
647 u32 ipv4_set = va_arg (*args, int);
648 vxlan_main_t * vxm = &vxlan_main;
649 vlib_main_t * vm = vxm->vlib_main;
653 if (unformat (input, "l2"))
654 *result = VXLAN_INPUT_NEXT_L2_INPUT;
655 else if (unformat (input, "node %U", unformat_vlib_node, vm, &node_index))
656 *result = get_decap_next_for_node(node_index, ipv4_set);
657 else if (unformat (input, "%d", &tmp))
664 static clib_error_t *
665 vxlan_add_del_tunnel_command_fn (vlib_main_t * vm,
666 unformat_input_t * input,
667 vlib_cli_command_t * cmd)
669 unformat_input_t _line_input, * line_input = &_line_input;
670 ip46_address_t src , dst;
678 u32 encap_fib_index = 0;
679 u32 mcast_sw_if_index = ~0;
680 u32 decap_next_index = VXLAN_INPUT_NEXT_L2_INPUT;
684 vnet_vxlan_add_del_tunnel_args_t _a, * a = &_a;
685 u32 tunnel_sw_if_index;
686 clib_error_t *error = NULL;
688 /* Cant "universally zero init" (={0}) due to GCC bug 53119 */
689 memset(&src, 0, sizeof src);
690 memset(&dst, 0, sizeof dst);
692 /* Get a line of input. */
693 if (! unformat_user (input, unformat_line_input, line_input))
696 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_ip4_address, &src.ip4))
709 else if (unformat (line_input, "dst %U",
710 unformat_ip4_address, &dst.ip4))
715 else if (unformat (line_input, "src %U",
716 unformat_ip6_address, &src.ip6))
721 else if (unformat (line_input, "dst %U",
722 unformat_ip6_address, &dst.ip6))
727 else if (unformat (line_input, "group %U %U",
728 unformat_ip4_address, &dst.ip4,
729 unformat_vnet_sw_interface,
730 vnet_get_main(), &mcast_sw_if_index))
732 grp_set = dst_set = 1;
735 else if (unformat (line_input, "group %U %U",
736 unformat_ip6_address, &dst.ip6,
737 unformat_vnet_sw_interface,
738 vnet_get_main(), &mcast_sw_if_index))
740 grp_set = dst_set = 1;
743 else if (unformat (line_input, "encap-vrf-id %d", &tmp))
745 encap_fib_index = fib_table_find (fib_ip_proto (ipv6_set), tmp);
746 if (encap_fib_index == ~0)
748 error = clib_error_return (0, "nonexistent encap-vrf-id %d", tmp);
752 else if (unformat (line_input, "decap-next %U", unformat_decap_next,
753 &decap_next_index, ipv4_set))
755 else if (unformat (line_input, "vni %d", &vni))
759 error = clib_error_return (0, "vni %d out of range", vni);
765 error = clib_error_return (0, "parse error: '%U'",
766 format_unformat_error, line_input);
773 error = clib_error_return (0, "tunnel src address not specified");
779 error = clib_error_return (0, "tunnel dst address not specified");
783 if (grp_set && !ip46_address_is_multicast(&dst))
785 error = clib_error_return (0, "tunnel group address not multicast");
789 if (grp_set == 0 && ip46_address_is_multicast(&dst))
791 error = clib_error_return (0, "dst address must be unicast");
795 if (grp_set && mcast_sw_if_index == ~0)
797 error = clib_error_return (0, "tunnel nonexistent multicast device");
801 if (ipv4_set && ipv6_set)
803 error = clib_error_return (0, "both IPv4 and IPv6 addresses specified");
807 if (ip46_address_cmp(&src, &dst) == 0)
809 error = clib_error_return (0, "src and dst addresses are identical");
813 if (decap_next_index == ~0)
815 error = clib_error_return (0, "next node not found");
821 error = clib_error_return (0, "vni not specified");
825 memset (a, 0, sizeof (*a));
828 a->is_ip6 = ipv6_set;
829 a->instance = instance;
831 #define _(x) a->x = x;
835 rv = vnet_vxlan_add_del_tunnel (a, &tunnel_sw_if_index);
841 vlib_cli_output(vm, "%U\n", format_vnet_sw_if_index_name,
842 vnet_get_main(), tunnel_sw_if_index);
845 case VNET_API_ERROR_TUNNEL_EXIST:
846 error = clib_error_return (0, "tunnel already exists...");
849 case VNET_API_ERROR_NO_SUCH_ENTRY:
850 error = clib_error_return (0, "tunnel does not exist...");
853 case VNET_API_ERROR_INVALID_ARGUMENT:
854 error = clib_error_return (0, "Invalid argument");
857 case VNET_API_ERROR_INSTANCE_IN_USE:
858 error = clib_error_return (0, "Instance is in use");
862 error = clib_error_return
863 (0, "vnet_vxlan_add_del_tunnel returned %d", rv);
868 unformat_free (line_input);
874 * Add or delete a VXLAN Tunnel.
876 * VXLAN provides the features needed to allow L2 bridge domains (BDs)
877 * to span multiple servers. This is done by building an L2 overlay on
878 * top of an L3 network underlay using VXLAN tunnels.
880 * This makes it possible for servers to be co-located in the same data
881 * center or be separated geographically as long as they are reachable
882 * through the underlay L3 network.
884 * You can refer to this kind of L2 overlay bridge domain as a VXLAN
885 * (Virtual eXtensible VLAN) segment.
888 * Example of how to create a VXLAN Tunnel:
889 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 encap-vrf-id 7}
890 * Example of how to create a VXLAN Tunnel with a known name, vxlan_tunnel42:
891 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 instance 42}
892 * Example of how to delete a VXLAN Tunnel:
893 * @cliexcmd{create vxlan tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 del}
896 VLIB_CLI_COMMAND (create_vxlan_tunnel_command, static) = {
897 .path = "create vxlan tunnel",
899 "create vxlan tunnel src <local-vtep-addr>"
900 " {dst <remote-vtep-addr>|group <mcast-vtep-addr> <intf-name>} vni <nn>"
902 " [encap-vrf-id <nn>] [decap-next [l2|node <name>]] [del]",
903 .function = vxlan_add_del_tunnel_command_fn,
907 static clib_error_t *
908 show_vxlan_tunnel_command_fn (vlib_main_t * vm,
909 unformat_input_t * input,
910 vlib_cli_command_t * cmd)
912 vxlan_main_t * vxm = &vxlan_main;
915 if (pool_elts (vxm->tunnels) == 0)
916 vlib_cli_output (vm, "No vxlan tunnels configured...");
918 pool_foreach (t, vxm->tunnels,
920 vlib_cli_output (vm, "%U", format_vxlan_tunnel, t);
927 * Display all the VXLAN Tunnel entries.
930 * Example of how to display the VXLAN Tunnel entries:
931 * @cliexstart{show vxlan tunnel}
932 * [0] src 10.0.3.1 dst 10.0.3.3 vni 13 encap_fib_index 0 sw_if_index 5 decap_next l2
936 VLIB_CLI_COMMAND (show_vxlan_tunnel_command, static) = {
937 .path = "show vxlan tunnel",
938 .short_help = "show vxlan tunnel",
939 .function = show_vxlan_tunnel_command_fn,
944 void vnet_int_vxlan_bypass_mode (u32 sw_if_index,
949 vnet_feature_enable_disable ("ip6-unicast", "ip6-vxlan-bypass",
950 sw_if_index, is_enable, 0, 0);
952 vnet_feature_enable_disable ("ip4-unicast", "ip4-vxlan-bypass",
953 sw_if_index, is_enable, 0, 0);
957 static clib_error_t *
958 set_ip_vxlan_bypass (u32 is_ip6,
959 unformat_input_t * input,
960 vlib_cli_command_t * cmd)
962 unformat_input_t _line_input, * line_input = &_line_input;
963 vnet_main_t * vnm = vnet_get_main();
964 clib_error_t * error = 0;
965 u32 sw_if_index, is_enable;
970 if (! unformat_user (input, unformat_line_input, line_input))
973 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
975 if (unformat_user (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
977 else if (unformat (line_input, "del"))
981 error = unformat_parse_error (line_input);
986 if (~0 == sw_if_index)
988 error = clib_error_return (0, "unknown interface `%U'",
989 format_unformat_error, line_input);
993 vnet_int_vxlan_bypass_mode (sw_if_index, is_ip6, is_enable);
996 unformat_free (line_input);
1001 static clib_error_t *
1002 set_ip4_vxlan_bypass (vlib_main_t * vm,
1003 unformat_input_t * input,
1004 vlib_cli_command_t * cmd)
1006 return set_ip_vxlan_bypass (0, input, cmd);
1010 * This command adds the 'ip4-vxlan-bypass' graph node for a given interface.
1011 * By adding the IPv4 vxlan-bypass graph node to an interface, the node checks
1012 * for and validate input vxlan packet and bypass ip4-lookup, ip4-local,
1013 * ip4-udp-lookup nodes to speedup vxlan packet forwarding. This node will
1014 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
1018 * Example of graph node before ip4-vxlan-bypass is enabled:
1019 * @cliexstart{show vlib graph ip4-vxlan-bypass}
1020 * Name Next Previous
1021 * ip4-vxlan-bypass error-drop [0]
1026 * Example of how to enable ip4-vxlan-bypass on an interface:
1027 * @cliexcmd{set interface ip vxlan-bypass GigabitEthernet2/0/0}
1029 * Example of graph node after ip4-vxlan-bypass is enabled:
1030 * @cliexstart{show vlib graph ip4-vxlan-bypass}
1031 * Name Next Previous
1032 * ip4-vxlan-bypass error-drop [0] ip4-input
1033 * vxlan4-input [1] ip4-input-no-checksum
1037 * Example of how to display the feature enabed on an interface:
1038 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1039 * IP feature paths configured on GigabitEthernet2/0/0...
1047 * Example of how to disable ip4-vxlan-bypass on an interface:
1048 * @cliexcmd{set interface ip vxlan-bypass GigabitEthernet2/0/0 del}
1052 VLIB_CLI_COMMAND (set_interface_ip_vxlan_bypass_command, static) = {
1053 .path = "set interface ip vxlan-bypass",
1054 .function = set_ip4_vxlan_bypass,
1055 .short_help = "set interface ip vxlan-bypass <interface> [del]",
1059 static clib_error_t *
1060 set_ip6_vxlan_bypass (vlib_main_t * vm,
1061 unformat_input_t * input,
1062 vlib_cli_command_t * cmd)
1064 return set_ip_vxlan_bypass (1, input, cmd);
1068 * This command adds the 'ip6-vxlan-bypass' graph node for a given interface.
1069 * By adding the IPv6 vxlan-bypass graph node to an interface, the node checks
1070 * for and validate input vxlan packet and bypass ip6-lookup, ip6-local,
1071 * ip6-udp-lookup nodes to speedup vxlan packet forwarding. This node will
1072 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
1076 * Example of graph node before ip6-vxlan-bypass is enabled:
1077 * @cliexstart{show vlib graph ip6-vxlan-bypass}
1078 * Name Next Previous
1079 * ip6-vxlan-bypass error-drop [0]
1084 * Example of how to enable ip6-vxlan-bypass on an interface:
1085 * @cliexcmd{set interface ip6 vxlan-bypass GigabitEthernet2/0/0}
1087 * Example of graph node after ip6-vxlan-bypass is enabled:
1088 * @cliexstart{show vlib graph ip6-vxlan-bypass}
1089 * Name Next Previous
1090 * ip6-vxlan-bypass error-drop [0] ip6-input
1091 * vxlan6-input [1] ip4-input-no-checksum
1095 * Example of how to display the feature enabed on an interface:
1096 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1097 * IP feature paths configured on GigabitEthernet2/0/0...
1105 * Example of how to disable ip6-vxlan-bypass on an interface:
1106 * @cliexcmd{set interface ip6 vxlan-bypass GigabitEthernet2/0/0 del}
1110 VLIB_CLI_COMMAND (set_interface_ip6_vxlan_bypass_command, static) = {
1111 .path = "set interface ip6 vxlan-bypass",
1112 .function = set_ip6_vxlan_bypass,
1113 .short_help = "set interface ip vxlan-bypass <interface> [del]",
1117 clib_error_t *vxlan_init (vlib_main_t *vm)
1119 vxlan_main_t * vxm = &vxlan_main;
1121 vxm->vnet_main = vnet_get_main();
1122 vxm->vlib_main = vm;
1124 /* initialize the ip6 hash */
1125 vxm->vxlan6_tunnel_by_key = hash_create_mem(0,
1126 sizeof(vxlan6_tunnel_key_t),
1128 vxm->vtep6 = hash_create_mem(0,
1129 sizeof(ip6_address_t),
1131 vxm->mcast_shared = hash_create_mem(0,
1132 sizeof(ip46_address_t),
1133 sizeof(mcast_shared_t));
1135 udp_register_dst_port (vm, UDP_DST_PORT_vxlan,
1136 vxlan4_input_node.index, /* is_ip4 */ 1);
1137 udp_register_dst_port (vm, UDP_DST_PORT_vxlan6,
1138 vxlan6_input_node.index, /* is_ip4 */ 0);
1140 fib_node_register_type(FIB_NODE_TYPE_VXLAN_TUNNEL, &vxlan_vft);
1145 VLIB_INIT_FUNCTION(vxlan_init);
1149 * eval: (c-set-style "gnu")