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.
17 * @brief Common utility functions for IPv4 and IPv6 VXLAN GPE tunnels
20 #include <vnet/vxlan-gpe/vxlan_gpe.h>
21 #include <vnet/fib/fib.h>
22 #include <vnet/ip/format.h>
23 #include <vnet/fib/fib_entry.h>
24 #include <vnet/fib/fib_table.h>
25 #include <vnet/mfib/mfib_table.h>
26 #include <vnet/adj/adj_mcast.h>
27 #include <vnet/interface.h>
28 #include <vlib/vlib.h>
34 * VXLAN-GPE provides the features needed to allow L2 bridge domains (BDs)
35 * to span multiple servers. This is done by building an L2 overlay on
36 * top of an L3 network underlay using VXLAN-GPE tunnels.
38 * This makes it possible for servers to be co-located in the same data
39 * center or be separated geographically as long as they are reachable
40 * through the underlay L3 network.
42 * You can refer to this kind of L2 overlay bridge domain as a VXLAN-GPE segment.
45 vxlan_gpe_main_t vxlan_gpe_main;
48 format_decap_next (u8 * s, va_list * args)
50 vxlan_gpe_tunnel_t *t = va_arg (*args, vxlan_gpe_tunnel_t *);
54 case VXLAN_GPE_PROTOCOL_IP4:
55 s = format (s, "protocol ip4 fib-idx %d", t->decap_fib_index);
57 case VXLAN_GPE_PROTOCOL_IP6:
58 s = format (s, "protocol ip6 fib-idx %d", t->decap_fib_index);
60 case VXLAN_GPE_PROTOCOL_ETHERNET:
61 s = format (s, "protocol ethernet");
63 case VXLAN_GPE_PROTOCOL_NSH:
64 s = format (s, "protocol nsh");
67 s = format (s, "protocol unknown %d", t->protocol);
74 * @brief Format function for VXLAN GPE tunnel
76 * @param *s formatting string
79 * @return *s formatted string
83 format_vxlan_gpe_tunnel (u8 * s, va_list * args)
85 vxlan_gpe_tunnel_t *t = va_arg (*args, vxlan_gpe_tunnel_t *);
86 vxlan_gpe_main_t *ngm = &vxlan_gpe_main;
88 s = format (s, "[%d] lcl %U rmt %U vni %d fib-idx %d sw-if-idx %d ",
90 format_ip46_address, &t->local, IP46_TYPE_ANY,
91 format_ip46_address, &t->remote, IP46_TYPE_ANY,
92 t->vni, t->encap_fib_index, t->sw_if_index);
95 /* next_dpo not yet used by vxlan-gpe-encap node */
96 s = format (s, "encap-dpo-idx %d ", t->next_dpo.dpoi_index);
99 s = format (s, "decap-next-%U ", format_decap_next, t);
101 if (PREDICT_FALSE (ip46_address_is_multicast (&t->remote)))
102 s = format (s, "mcast-sw-if-idx %d ", t->mcast_sw_if_index);
108 * @brief Naming for VXLAN GPE tunnel
110 * @param *s formatting string
113 * @return *s formatted string
117 format_vxlan_gpe_name (u8 * s, va_list * args)
119 u32 dev_instance = va_arg (*args, u32);
120 return format (s, "vxlan_gpe_tunnel%d", dev_instance);
124 * @brief CLI function for VXLAN GPE admin up/down
133 static clib_error_t *
134 vxlan_gpe_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index,
137 u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
138 VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
139 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
145 VNET_DEVICE_CLASS (vxlan_gpe_device_class,static) = {
147 .format_device_name = format_vxlan_gpe_name,
148 .format_tx_trace = format_vxlan_gpe_encap_trace,
149 .admin_up_down_function = vxlan_gpe_interface_admin_up_down,
155 * @brief Formatting function for tracing VXLAN GPE with length
164 format_vxlan_gpe_header_with_length (u8 * s, va_list * args)
166 u32 dev_instance = va_arg (*args, u32);
167 s = format (s, "unimplemented dev %u", dev_instance);
172 VNET_HW_INTERFACE_CLASS (vxlan_gpe_hw_class) = {
174 .format_header = format_vxlan_gpe_header_with_length,
175 .build_rewrite = default_build_rewrite,
180 vxlan_gpe_tunnel_restack_dpo (vxlan_gpe_tunnel_t * t)
182 dpo_id_t dpo = DPO_INVALID;
183 u32 encap_index = vxlan_gpe_encap_node.index;
184 fib_forward_chain_type_t forw_type = ip46_address_is_ip4 (&t->remote) ?
185 FIB_FORW_CHAIN_TYPE_UNICAST_IP4 : FIB_FORW_CHAIN_TYPE_UNICAST_IP6;
187 fib_entry_contribute_forwarding (t->fib_entry_index, forw_type, &dpo);
188 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
192 static vxlan_gpe_tunnel_t *
193 vxlan_gpe_tunnel_from_fib_node (fib_node_t * node)
195 ASSERT (FIB_NODE_TYPE_VXLAN_GPE_TUNNEL == node->fn_type);
196 return ((vxlan_gpe_tunnel_t *) (((char *) node) -
197 STRUCT_OFFSET_OF (vxlan_gpe_tunnel_t,
202 * Function definition to backwalk a FIB node -
203 * Here we will restack the new dpo of VXLAN_GPE DIP to encap node.
205 static fib_node_back_walk_rc_t
206 vxlan_gpe_tunnel_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
208 vxlan_gpe_tunnel_restack_dpo (vxlan_gpe_tunnel_from_fib_node (node));
209 return (FIB_NODE_BACK_WALK_CONTINUE);
213 * Function definition to get a FIB node from its index
216 vxlan_gpe_tunnel_fib_node_get (fib_node_index_t index)
218 vxlan_gpe_tunnel_t *t;
219 vxlan_gpe_main_t *ngm = &vxlan_gpe_main;
221 t = pool_elt_at_index (ngm->tunnels, index);
227 * Function definition to inform the FIB node that its last lock has gone.
230 vxlan_gpe_tunnel_last_lock_gone (fib_node_t * node)
233 * The VXLAN_GPE tunnel is a root of the graph. As such
234 * it never has children and thus is never locked.
240 * Virtual function table registered by VXLAN_GPE tunnels
241 * for participation in the FIB object graph.
243 const static fib_node_vft_t vxlan_gpe_vft = {
244 .fnv_get = vxlan_gpe_tunnel_fib_node_get,
245 .fnv_last_lock = vxlan_gpe_tunnel_last_lock_gone,
246 .fnv_back_walk = vxlan_gpe_tunnel_back_walk,
249 #define foreach_gpe_copy_field \
252 _(mcast_sw_if_index) \
256 #define foreach_copy_ipv4 { \
257 _(local.ip4.as_u32) \
258 _(remote.ip4.as_u32) \
261 #define foreach_copy_ipv6 { \
262 _(local.ip6.as_u64[0]) \
263 _(local.ip6.as_u64[1]) \
264 _(remote.ip6.as_u64[0]) \
265 _(remote.ip6.as_u64[1]) \
270 * @brief Calculate IPv4 VXLAN GPE rewrite header
278 vxlan4_gpe_rewrite (vxlan_gpe_tunnel_t * t, u32 extension_size,
279 u8 protocol_override, uword encap_next_node)
283 ip4_vxlan_gpe_header_t *h0;
286 len = sizeof (*h0) + extension_size;
288 vec_free (t->rewrite);
289 vec_validate_aligned (rw, len - 1, CLIB_CACHE_LINE_BYTES);
291 h0 = (ip4_vxlan_gpe_header_t *) rw;
293 /* Fixed portion of the (outer) ip4 header */
295 ip0->ip_version_and_header_length = 0x45;
297 ip0->protocol = IP_PROTOCOL_UDP;
299 /* we fix up the ip4 header length and checksum after-the-fact */
300 ip0->src_address.as_u32 = t->local.ip4.as_u32;
301 ip0->dst_address.as_u32 = t->remote.ip4.as_u32;
302 ip0->checksum = ip4_header_checksum (ip0);
304 /* UDP header, randomize src port on something, maybe? */
305 h0->udp.src_port = clib_host_to_net_u16 (4790);
306 h0->udp.dst_port = clib_host_to_net_u16 (UDP_DST_PORT_VXLAN_GPE);
308 /* VXLAN header. Are we having fun yet? */
309 h0->vxlan.flags = VXLAN_GPE_FLAGS_I | VXLAN_GPE_FLAGS_P;
310 h0->vxlan.ver_res = VXLAN_GPE_VERSION;
311 if (protocol_override)
313 h0->vxlan.protocol = protocol_override;
317 h0->vxlan.protocol = t->protocol;
319 t->rewrite_size = sizeof (ip4_vxlan_gpe_header_t) + extension_size;
320 h0->vxlan.vni_res = clib_host_to_net_u32 (t->vni << 8);
323 t->encap_next_node = encap_next_node;
328 * @brief Calculate IPv6 VXLAN GPE rewrite header
336 vxlan6_gpe_rewrite (vxlan_gpe_tunnel_t * t, u32 extension_size,
337 u8 protocol_override, uword encap_next_node)
341 ip6_vxlan_gpe_header_t *h0;
344 len = sizeof (*h0) + extension_size;
346 vec_free (t->rewrite);
347 vec_validate_aligned (rw, len - 1, CLIB_CACHE_LINE_BYTES);
349 h0 = (ip6_vxlan_gpe_header_t *) rw;
351 /* Fixed portion of the (outer) ip4 header */
353 ip0->ip_version_traffic_class_and_flow_label =
354 clib_host_to_net_u32 (6 << 28);
355 ip0->hop_limit = 255;
356 ip0->protocol = IP_PROTOCOL_UDP;
358 ip0->src_address.as_u64[0] = t->local.ip6.as_u64[0];
359 ip0->src_address.as_u64[1] = t->local.ip6.as_u64[1];
360 ip0->dst_address.as_u64[0] = t->remote.ip6.as_u64[0];
361 ip0->dst_address.as_u64[1] = t->remote.ip6.as_u64[1];
363 /* UDP header, randomize src port on something, maybe? */
364 h0->udp.src_port = clib_host_to_net_u16 (4790);
365 h0->udp.dst_port = clib_host_to_net_u16 (UDP_DST_PORT_VXLAN_GPE);
367 /* VXLAN header. Are we having fun yet? */
368 h0->vxlan.flags = VXLAN_GPE_FLAGS_I | VXLAN_GPE_FLAGS_P;
369 h0->vxlan.ver_res = VXLAN_GPE_VERSION;
370 if (protocol_override)
372 h0->vxlan.protocol = t->protocol;
376 h0->vxlan.protocol = protocol_override;
378 t->rewrite_size = sizeof (ip4_vxlan_gpe_header_t) + extension_size;
379 h0->vxlan.vni_res = clib_host_to_net_u32 (t->vni << 8);
382 t->encap_next_node = encap_next_node;
387 vtep_addr_ref (ip46_address_t * ip)
389 uword *vtep = ip46_address_is_ip4 (ip) ?
390 hash_get (vxlan_gpe_main.vtep4, ip->ip4.as_u32) :
391 hash_get_mem (vxlan_gpe_main.vtep6, &ip->ip6);
394 ip46_address_is_ip4 (ip) ?
395 hash_set (vxlan_gpe_main.vtep4, ip->ip4.as_u32, 1) :
396 hash_set_mem_alloc (&vxlan_gpe_main.vtep6, &ip->ip6, 1);
401 vtep_addr_unref (ip46_address_t * ip)
403 uword *vtep = ip46_address_is_ip4 (ip) ?
404 hash_get (vxlan_gpe_main.vtep4, ip->ip4.as_u32) :
405 hash_get_mem (vxlan_gpe_main.vtep6, &ip->ip6);
409 ip46_address_is_ip4 (ip) ?
410 hash_unset (vxlan_gpe_main.vtep4, ip->ip4.as_u32) :
411 hash_unset_mem_free (&vxlan_gpe_main.vtep6, &ip->ip6);
416 typedef CLIB_PACKED(union {
418 fib_node_index_t mfib_entry_index;
419 adj_index_t mcast_adj_index;
425 static inline mcast_shared_t
426 mcast_shared_get (ip46_address_t * ip)
428 ASSERT (ip46_address_is_multicast (ip));
429 uword *p = hash_get_mem (vxlan_gpe_main.mcast_shared, ip);
431 return (mcast_shared_t)
437 mcast_shared_add (ip46_address_t * remote,
438 fib_node_index_t mfei, adj_index_t ai)
440 mcast_shared_t new_ep = {
441 .mcast_adj_index = ai,
442 .mfib_entry_index = mfei,
445 hash_set_mem_alloc (&vxlan_gpe_main.mcast_shared, remote, new_ep.as_u64);
449 mcast_shared_remove (ip46_address_t * remote)
451 mcast_shared_t ep = mcast_shared_get (remote);
453 adj_unlock (ep.mcast_adj_index);
454 mfib_table_entry_delete_index (ep.mfib_entry_index, MFIB_SOURCE_VXLAN_GPE);
456 hash_unset_mem_free (&vxlan_gpe_main.mcast_shared, remote);
460 * @brief Add or Del a VXLAN GPE tunnel
463 * @param *sw_if_index
468 int vnet_vxlan_gpe_add_del_tunnel
469 (vnet_vxlan_gpe_add_del_tunnel_args_t * a, u32 * sw_if_indexp)
471 vxlan_gpe_main_t *ngm = &vxlan_gpe_main;
472 vxlan_gpe_tunnel_t *t = 0;
473 vnet_main_t *vnm = ngm->vnet_main;
474 vnet_hw_interface_t *hi;
476 u32 hw_if_index = ~0;
477 u32 sw_if_index = ~0;
479 vxlan4_gpe_tunnel_key_t key4, *key4_copy;
480 vxlan6_gpe_tunnel_key_t key6, *key6_copy;
481 u32 is_ip6 = a->is_ip6;
485 key4.local = a->local.ip4.as_u32;
486 key4.remote = a->remote.ip4.as_u32;
487 key4.vni = clib_host_to_net_u32 (a->vni << 8);
490 p = hash_get_mem (ngm->vxlan4_gpe_tunnel_by_key, &key4);
494 key6.local.as_u64[0] = a->local.ip6.as_u64[0];
495 key6.local.as_u64[1] = a->local.ip6.as_u64[1];
496 key6.remote.as_u64[0] = a->remote.ip6.as_u64[0];
497 key6.remote.as_u64[1] = a->remote.ip6.as_u64[1];
498 key6.vni = clib_host_to_net_u32 (a->vni << 8);
500 p = hash_get_mem (ngm->vxlan6_gpe_tunnel_by_key, &key6);
505 l2input_main_t *l2im = &l2input_main;
507 /* adding a tunnel: tunnel must not already exist */
509 return VNET_API_ERROR_TUNNEL_EXIST;
511 pool_get_aligned (ngm->tunnels, t, CLIB_CACHE_LINE_BYTES);
512 clib_memset (t, 0, sizeof (*t));
514 /* copy from arg structure */
516 #define _(x) t->x = a->x;
517 foreach_gpe_copy_field;
526 t->flags |= VXLAN_GPE_TUNNEL_IS_IPV4;
530 rv = vxlan4_gpe_rewrite (t, 0, 0, VXLAN_GPE_ENCAP_NEXT_IP4_LOOKUP);
534 rv = vxlan6_gpe_rewrite (t, 0, 0, VXLAN_GPE_ENCAP_NEXT_IP6_LOOKUP);
539 pool_put (ngm->tunnels, t);
545 key4_copy = clib_mem_alloc (sizeof (*key4_copy));
546 clib_memcpy_fast (key4_copy, &key4, sizeof (*key4_copy));
547 hash_set_mem (ngm->vxlan4_gpe_tunnel_by_key, key4_copy,
552 key6_copy = clib_mem_alloc (sizeof (*key6_copy));
553 clib_memcpy_fast (key6_copy, &key6, sizeof (*key6_copy));
554 hash_set_mem (ngm->vxlan6_gpe_tunnel_by_key, key6_copy,
558 if (vec_len (ngm->free_vxlan_gpe_tunnel_hw_if_indices) > 0)
560 vnet_interface_main_t *im = &vnm->interface_main;
561 hw_if_index = ngm->free_vxlan_gpe_tunnel_hw_if_indices
562 [vec_len (ngm->free_vxlan_gpe_tunnel_hw_if_indices) - 1];
563 _vec_len (ngm->free_vxlan_gpe_tunnel_hw_if_indices) -= 1;
565 hi = vnet_get_hw_interface (vnm, hw_if_index);
566 hi->dev_instance = t - ngm->tunnels;
567 hi->hw_instance = hi->dev_instance;
568 /* clear old stats of freed tunnel before reuse */
569 sw_if_index = hi->sw_if_index;
570 vnet_interface_counter_lock (im);
571 vlib_zero_combined_counter
572 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX],
574 vlib_zero_combined_counter (&im->combined_sw_if_counters
575 [VNET_INTERFACE_COUNTER_RX],
577 vlib_zero_simple_counter (&im->sw_if_counters
578 [VNET_INTERFACE_COUNTER_DROP],
580 vnet_interface_counter_unlock (im);
584 hw_if_index = vnet_register_interface
585 (vnm, vxlan_gpe_device_class.index, t - ngm->tunnels,
586 vxlan_gpe_hw_class.index, t - ngm->tunnels);
587 hi = vnet_get_hw_interface (vnm, hw_if_index);
590 /* Set vxlan-gpe tunnel output node */
591 u32 encap_index = vxlan_gpe_encap_node.index;
592 vnet_set_interface_output_node (vnm, hw_if_index, encap_index);
594 t->hw_if_index = hw_if_index;
595 t->sw_if_index = sw_if_index = hi->sw_if_index;
596 vec_validate_init_empty (ngm->tunnel_index_by_sw_if_index, sw_if_index,
598 ngm->tunnel_index_by_sw_if_index[sw_if_index] = t - ngm->tunnels;
600 /* setup l2 input config with l2 feature and bd 0 to drop packet */
601 vec_validate (l2im->configs, sw_if_index);
602 l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
603 l2im->configs[sw_if_index].bd_index = 0;
605 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
606 si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
607 vnet_sw_interface_set_flags (vnm, hi->sw_if_index,
608 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
609 fib_node_init (&t->node, FIB_NODE_TYPE_VXLAN_GPE_TUNNEL);
610 fib_prefix_t tun_remote_pfx;
611 vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
613 fib_prefix_from_ip46_addr (&t->remote, &tun_remote_pfx);
614 if (!ip46_address_is_multicast (&t->remote))
617 * source the FIB entry for the tunnel's destination
618 * and become a child thereof. The tunnel will then get poked
619 * when the forwarding for the entry updates, and the tunnel can
620 * re-stack accordingly
622 vtep_addr_ref (&t->local);
623 t->fib_entry_index = fib_table_entry_special_add
624 (t->encap_fib_index, &tun_remote_pfx, FIB_SOURCE_RR,
625 FIB_ENTRY_FLAG_NONE);
626 t->sibling_index = fib_entry_child_add
627 (t->fib_entry_index, FIB_NODE_TYPE_VXLAN_GPE_TUNNEL,
629 vxlan_gpe_tunnel_restack_dpo (t);
633 /* Multicast tunnel -
634 * as the same mcast group can be used for multiple mcast tunnels
635 * with different VNIs, create the output fib adjacency only if
636 * it does not already exist
638 fib_protocol_t fp = fib_ip_proto (is_ip6);
640 if (vtep_addr_ref (&t->remote) == 1)
642 fib_node_index_t mfei;
644 fib_route_path_t path = {
645 .frp_proto = fib_proto_to_dpo (fp),
646 .frp_addr = zero_addr,
647 .frp_sw_if_index = 0xffffffff,
650 .frp_flags = FIB_ROUTE_PATH_LOCAL,
652 const mfib_prefix_t mpfx = {
654 .fp_len = (is_ip6 ? 128 : 32),
655 .fp_grp_addr = tun_remote_pfx.fp_addr,
659 * Setup the (*,G) to receive traffic on the mcast group
660 * - the forwarding interface is for-us
661 * - the accepting interface is that from the API
663 mfib_table_entry_path_update (t->encap_fib_index,
665 MFIB_SOURCE_VXLAN_GPE,
666 &path, MFIB_ITF_FLAG_FORWARD);
668 path.frp_sw_if_index = a->mcast_sw_if_index;
669 path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
670 mfei = mfib_table_entry_path_update (t->encap_fib_index,
672 MFIB_SOURCE_VXLAN_GPE,
674 MFIB_ITF_FLAG_ACCEPT);
677 * Create the mcast adjacency to send traffic to the group
679 ai = adj_mcast_add_or_lock (fp,
680 fib_proto_to_link (fp),
681 a->mcast_sw_if_index);
684 * create a new end-point
686 mcast_shared_add (&t->remote, mfei, ai);
689 dpo_id_t dpo = DPO_INVALID;
690 mcast_shared_t ep = mcast_shared_get (&t->remote);
692 /* Stack shared mcast remote mac addr rewrite on encap */
693 dpo_set (&dpo, DPO_ADJACENCY_MCAST,
694 fib_proto_to_dpo (fp), ep.mcast_adj_index);
696 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
698 flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
701 vnet_get_sw_interface (vnet_get_main (), sw_if_index)->flood_class =
706 /* deleting a tunnel: tunnel must exist */
708 return VNET_API_ERROR_NO_SUCH_ENTRY;
710 t = pool_elt_at_index (ngm->tunnels, p[0]);
712 sw_if_index = t->sw_if_index;
713 vnet_sw_interface_set_flags (vnm, t->sw_if_index, 0 /* down */ );
714 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, t->sw_if_index);
715 si->flags |= VNET_SW_INTERFACE_FLAG_HIDDEN;
716 set_int_l2_mode (ngm->vlib_main, vnm, MODE_L3, t->sw_if_index, 0,
717 L2_BD_PORT_TYPE_NORMAL, 0, 0);
718 vec_add1 (ngm->free_vxlan_gpe_tunnel_hw_if_indices, t->hw_if_index);
720 ngm->tunnel_index_by_sw_if_index[t->sw_if_index] = ~0;
723 hash_unset (ngm->vxlan4_gpe_tunnel_by_key, key4.as_u64);
725 hash_unset_mem_free (&ngm->vxlan6_gpe_tunnel_by_key, &key6);
727 if (!ip46_address_is_multicast (&t->remote))
729 vtep_addr_unref (&t->local);
730 fib_entry_child_remove (t->fib_entry_index, t->sibling_index);
731 fib_table_entry_delete_index (t->fib_entry_index, FIB_SOURCE_RR);
733 else if (vtep_addr_unref (&t->remote) == 0)
735 mcast_shared_remove (&t->remote);
738 fib_node_deinit (&t->node);
739 vec_free (t->rewrite);
740 pool_put (ngm->tunnels, t);
744 *sw_if_indexp = sw_if_index;
749 static clib_error_t *
750 vxlan_gpe_add_del_tunnel_command_fn (vlib_main_t * vm,
751 unformat_input_t * input,
752 vlib_cli_command_t * cmd)
754 unformat_input_t _line_input, *line_input = &_line_input;
756 ip46_address_t local, remote;
762 u32 mcast_sw_if_index = ~0;
763 u32 encap_fib_index = 0;
764 u32 decap_fib_index = 0;
765 u8 protocol = VXLAN_GPE_PROTOCOL_IP4;
770 vnet_vxlan_gpe_add_del_tunnel_args_t _a, *a = &_a;
772 clib_error_t *error = NULL;
774 /* Get a line of input. */
775 if (!unformat_user (input, unformat_line_input, line_input))
778 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
780 if (unformat (line_input, "del"))
782 else if (unformat (line_input, "local %U",
783 unformat_ip4_address, &local.ip4))
788 else if (unformat (line_input, "remote %U",
789 unformat_ip4_address, &remote.ip4))
794 else if (unformat (line_input, "local %U",
795 unformat_ip6_address, &local.ip6))
800 else if (unformat (line_input, "remote %U",
801 unformat_ip6_address, &remote.ip6))
806 else if (unformat (line_input, "group %U %U",
807 unformat_ip4_address, &remote.ip4,
808 unformat_vnet_sw_interface,
809 vnet_get_main (), &mcast_sw_if_index))
811 grp_set = remote_set = 1;
814 else if (unformat (line_input, "group %U %U",
815 unformat_ip6_address, &remote.ip6,
816 unformat_vnet_sw_interface,
817 vnet_get_main (), &mcast_sw_if_index))
819 grp_set = remote_set = 1;
822 else if (unformat (line_input, "encap-vrf-id %d", &tmp))
825 encap_fib_index = fib_table_find (FIB_PROTOCOL_IP6, tmp);
827 encap_fib_index = fib_table_find (FIB_PROTOCOL_IP4, tmp);
829 if (encap_fib_index == ~0)
832 clib_error_return (0, "nonexistent encap fib id %d", tmp);
836 else if (unformat (line_input, "decap-vrf-id %d", &tmp))
839 decap_fib_index = fib_table_find (FIB_PROTOCOL_IP6, tmp);
841 decap_fib_index = fib_table_find (FIB_PROTOCOL_IP4, tmp);
843 if (decap_fib_index == ~0)
846 clib_error_return (0, "nonexistent decap fib id %d", tmp);
850 else if (unformat (line_input, "vni %d", &vni))
852 else if (unformat (line_input, "next-ip4"))
853 protocol = VXLAN_GPE_PROTOCOL_IP4;
854 else if (unformat (line_input, "next-ip6"))
855 protocol = VXLAN_GPE_PROTOCOL_IP6;
856 else if (unformat (line_input, "next-ethernet"))
857 protocol = VXLAN_GPE_PROTOCOL_ETHERNET;
858 else if (unformat (line_input, "next-nsh"))
859 protocol = VXLAN_GPE_PROTOCOL_NSH;
862 error = clib_error_return (0, "parse error: '%U'",
863 format_unformat_error, line_input);
870 error = clib_error_return (0, "tunnel local address not specified");
876 error = clib_error_return (0, "tunnel remote address not specified");
880 if (grp_set && !ip46_address_is_multicast (&remote))
882 error = clib_error_return (0, "tunnel group address not multicast");
886 if (grp_set == 0 && ip46_address_is_multicast (&remote))
888 error = clib_error_return (0, "remote address must be unicast");
892 if (grp_set && mcast_sw_if_index == ~0)
894 error = clib_error_return (0, "tunnel nonexistent multicast device");
897 if (ipv4_set && ipv6_set)
899 error = clib_error_return (0, "both IPv4 and IPv6 addresses specified");
903 if ((ipv4_set && memcmp (&local.ip4, &remote.ip4, sizeof (local.ip4)) == 0)
905 && memcmp (&local.ip6, &remote.ip6, sizeof (local.ip6)) == 0))
907 error = clib_error_return (0, "src and remote addresses are identical");
913 error = clib_error_return (0, "vni not specified");
917 clib_memset (a, 0, sizeof (*a));
920 a->is_ip6 = ipv6_set;
923 #define _(x) a->x = x;
924 foreach_gpe_copy_field;
932 rv = vnet_vxlan_gpe_add_del_tunnel (a, &sw_if_index);
937 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
938 vnet_get_main (), sw_if_index);
940 case VNET_API_ERROR_INVALID_DECAP_NEXT:
941 error = clib_error_return (0, "invalid decap-next...");
944 case VNET_API_ERROR_TUNNEL_EXIST:
945 error = clib_error_return (0, "tunnel already exists...");
948 case VNET_API_ERROR_NO_SUCH_ENTRY:
949 error = clib_error_return (0, "tunnel does not exist...");
953 error = clib_error_return
954 (0, "vnet_vxlan_gpe_add_del_tunnel returned %d", rv);
959 unformat_free (line_input);
965 * Add or delete a VXLAN-GPE Tunnel.
967 * VXLAN-GPE provides the features needed to allow L2 bridge domains (BDs)
968 * to span multiple servers. This is done by building an L2 overlay on
969 * top of an L3 network underlay using VXLAN-GPE tunnels.
971 * This makes it possible for servers to be co-located in the same data
972 * center or be separated geographically as long as they are reachable
973 * through the underlay L3 network.
975 * You can refer to this kind of L2 overlay bridge domain as a VXLAN-GPE segment.
978 * Example of how to create a VXLAN-GPE Tunnel:
979 * @cliexcmd{create vxlan-gpe tunnel local 10.0.3.1 local 10.0.3.3 vni 13 encap-vrf-id 7}
980 * Example of how to delete a VXLAN Tunnel:
981 * @cliexcmd{create vxlan tunnel src 10.0.3.1 remote 10.0.3.3 vni 13 del}
984 VLIB_CLI_COMMAND (create_vxlan_gpe_tunnel_command, static) = {
985 .path = "create vxlan-gpe tunnel",
987 "create vxlan-gpe tunnel local <local-addr> "
988 " {remote <remote-addr>|group <mcast-addr> <intf-name>}"
989 " vni <nn> [next-ip4][next-ip6][next-ethernet][next-nsh]"
990 " [encap-vrf-id <nn>] [decap-vrf-id <nn>] [del]\n",
991 .function = vxlan_gpe_add_del_tunnel_command_fn,
996 * @brief CLI function for showing VXLAN GPE tunnels
1005 static clib_error_t *
1006 show_vxlan_gpe_tunnel_command_fn (vlib_main_t * vm,
1007 unformat_input_t * input,
1008 vlib_cli_command_t * cmd)
1010 vxlan_gpe_main_t *ngm = &vxlan_gpe_main;
1011 vxlan_gpe_tunnel_t *t;
1013 if (pool_elts (ngm->tunnels) == 0)
1014 vlib_cli_output (vm, "No vxlan-gpe tunnels configured.");
1017 pool_foreach (t, ngm->tunnels,
1019 vlib_cli_output (vm, "%U", format_vxlan_gpe_tunnel, t);
1027 * Display all the VXLAN-GPE Tunnel entries.
1030 * Example of how to display the VXLAN-GPE Tunnel entries:
1031 * @cliexstart{show vxlan-gpe tunnel}
1032 * [0] local 10.0.3.1 remote 10.0.3.3 vni 13 encap_fib_index 0 sw_if_index 5 decap_next l2
1036 VLIB_CLI_COMMAND (show_vxlan_gpe_tunnel_command, static) = {
1037 .path = "show vxlan-gpe",
1038 .function = show_vxlan_gpe_tunnel_command_fn,
1043 vnet_int_vxlan_gpe_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable)
1046 vnet_feature_enable_disable ("ip6-unicast", "ip6-vxlan-gpe-bypass",
1047 sw_if_index, is_enable, 0, 0);
1049 vnet_feature_enable_disable ("ip4-unicast", "ip4-vxlan-gpe-bypass",
1050 sw_if_index, is_enable, 0, 0);
1054 static clib_error_t *
1055 set_ip_vxlan_gpe_bypass (u32 is_ip6,
1056 unformat_input_t * input, vlib_cli_command_t * cmd)
1058 unformat_input_t _line_input, *line_input = &_line_input;
1059 vnet_main_t *vnm = vnet_get_main ();
1060 clib_error_t *error = 0;
1061 u32 sw_if_index, is_enable;
1066 if (!unformat_user (input, unformat_line_input, line_input))
1069 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1072 (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
1074 else if (unformat (line_input, "del"))
1078 error = unformat_parse_error (line_input);
1083 if (~0 == sw_if_index)
1085 error = clib_error_return (0, "unknown interface `%U'",
1086 format_unformat_error, line_input);
1090 vnet_int_vxlan_gpe_bypass_mode (sw_if_index, is_ip6, is_enable);
1093 unformat_free (line_input);
1098 static clib_error_t *
1099 set_ip4_vxlan_gpe_bypass (vlib_main_t * vm,
1100 unformat_input_t * input, vlib_cli_command_t * cmd)
1102 return set_ip_vxlan_gpe_bypass (0, input, cmd);
1106 * This command adds the 'ip4-vxlan-gpe-bypass' graph node for a given interface.
1107 * By adding the IPv4 vxlan-gpe-bypass graph node to an interface, the node checks
1108 * for and validate input vxlan_gpe packet and bypass ip4-lookup, ip4-local,
1109 * ip4-udp-lookup nodes to speedup vxlan_gpe packet forwarding. This node will
1110 * cause extra overhead to for non-vxlan_gpe packets which is kept at a minimum.
1114 * Example of graph node before ip4-vxlan-gpe-bypass is enabled:
1115 * @cliexstart{show vlib graph ip4-vxlan-gpe-bypass}
1116 * Name Next Previous
1117 * ip4-vxlan-gpe-bypass error-drop [0]
1118 * vxlan4-gpe-input [1]
1122 * Example of how to enable ip4-vxlan-gpe-bypass on an interface:
1123 * @cliexcmd{set interface ip vxlan-gpe-bypass GigabitEthernet2/0/0}
1125 * Example of graph node after ip4-vxlan-gpe-bypass is enabled:
1126 * @cliexstart{show vlib graph ip4-vxlan-gpe-bypass}
1127 * Name Next Previous
1128 * ip4-vxlan-gpe-bypass error-drop [0] ip4-input
1129 * vxlan4-gpe-input [1] ip4-input-no-checksum
1133 * Example of how to display the feature enabled on an interface:
1134 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1135 * IP feature paths configured on GigabitEthernet2/0/0...
1138 * ip4-vxlan-gpe-bypass
1143 * Example of how to disable ip4-vxlan-gpe-bypass on an interface:
1144 * @cliexcmd{set interface ip vxlan-gpe-bypass GigabitEthernet2/0/0 del}
1148 VLIB_CLI_COMMAND (set_interface_ip_vxlan_gpe_bypass_command, static) = {
1149 .path = "set interface ip vxlan-gpe-bypass",
1150 .function = set_ip4_vxlan_gpe_bypass,
1151 .short_help = "set interface ip vxlan-gpe-bypass <interface> [del]",
1155 static clib_error_t *
1156 set_ip6_vxlan_gpe_bypass (vlib_main_t * vm,
1157 unformat_input_t * input, vlib_cli_command_t * cmd)
1159 return set_ip_vxlan_gpe_bypass (1, input, cmd);
1163 * This command adds the 'ip6-vxlan-gpe-bypass' graph node for a given interface.
1164 * By adding the IPv6 vxlan-gpe-bypass graph node to an interface, the node checks
1165 * for and validate input vxlan_gpe packet and bypass ip6-lookup, ip6-local,
1166 * ip6-udp-lookup nodes to speedup vxlan_gpe packet forwarding. This node will
1167 * cause extra overhead to for non-vxlan_gpe packets which is kept at a minimum.
1171 * Example of graph node before ip6-vxlan-gpe-bypass is enabled:
1172 * @cliexstart{show vlib graph ip6-vxlan-gpe-bypass}
1173 * Name Next Previous
1174 * ip6-vxlan-gpe-bypass error-drop [0]
1175 * vxlan6-gpe-input [1]
1179 * Example of how to enable ip6-vxlan-gpe-bypass on an interface:
1180 * @cliexcmd{set interface ip6 vxlan-gpe-bypass GigabitEthernet2/0/0}
1182 * Example of graph node after ip6-vxlan-gpe-bypass is enabled:
1183 * @cliexstart{show vlib graph ip6-vxlan-gpe-bypass}
1184 * Name Next Previous
1185 * ip6-vxlan-gpe-bypass error-drop [0] ip6-input
1186 * vxlan6-gpe-input [1] ip4-input-no-checksum
1190 * Example of how to display the feature enabled on an interface:
1191 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1192 * IP feature paths configured on GigabitEthernet2/0/0...
1195 * ip6-vxlan-gpe-bypass
1200 * Example of how to disable ip6-vxlan-gpe-bypass on an interface:
1201 * @cliexcmd{set interface ip6 vxlan-gpe-bypass GigabitEthernet2/0/0 del}
1205 VLIB_CLI_COMMAND (set_interface_ip6_vxlan_gpe_bypass_command, static) = {
1206 .path = "set interface ip6 vxlan-gpe-bypass",
1207 .function = set_ip6_vxlan_gpe_bypass,
1208 .short_help = "set interface ip vxlan-gpe-bypass <interface> [del]",
1213 VNET_FEATURE_INIT (ip4_vxlan_gpe_bypass, static) =
1215 .arc_name = "ip4-unicast",
1216 .node_name = "ip4-vxlan-gpe-bypass",
1217 .runs_before = VNET_FEATURES ("ip4-lookup"),
1220 VNET_FEATURE_INIT (ip6_vxlan_gpe_bypass, static) =
1222 .arc_name = "ip6-unicast",
1223 .node_name = "ip6-vxlan-gpe-bypass",
1224 .runs_before = VNET_FEATURES ("ip6-lookup"),
1229 * @brief Feature init function for VXLAN GPE
1237 vxlan_gpe_init (vlib_main_t * vm)
1239 vxlan_gpe_main_t *ngm = &vxlan_gpe_main;
1241 ngm->vnet_main = vnet_get_main ();
1242 ngm->vlib_main = vm;
1244 ngm->vxlan4_gpe_tunnel_by_key
1245 = hash_create_mem (0, sizeof (vxlan4_gpe_tunnel_key_t), sizeof (uword));
1247 ngm->vxlan6_gpe_tunnel_by_key
1248 = hash_create_mem (0, sizeof (vxlan6_gpe_tunnel_key_t), sizeof (uword));
1251 ngm->mcast_shared = hash_create_mem (0,
1252 sizeof (ip46_address_t),
1253 sizeof (mcast_shared_t));
1254 ngm->vtep6 = hash_create_mem (0, sizeof (ip6_address_t), sizeof (uword));
1256 udp_register_dst_port (vm, UDP_DST_PORT_VXLAN_GPE,
1257 vxlan4_gpe_input_node.index, 1 /* is_ip4 */ );
1258 udp_register_dst_port (vm, UDP_DST_PORT_VXLAN6_GPE,
1259 vxlan6_gpe_input_node.index, 0 /* is_ip4 */ );
1261 /* Register the list of standard decap protocols supported */
1262 vxlan_gpe_register_decap_protocol (VXLAN_GPE_PROTOCOL_IP4,
1263 VXLAN_GPE_INPUT_NEXT_IP4_INPUT);
1264 vxlan_gpe_register_decap_protocol (VXLAN_GPE_PROTOCOL_IP6,
1265 VXLAN_GPE_INPUT_NEXT_IP6_INPUT);
1266 vxlan_gpe_register_decap_protocol (VXLAN_GPE_PROTOCOL_ETHERNET,
1267 VXLAN_GPE_INPUT_NEXT_L2_INPUT);
1269 fib_node_register_type (FIB_NODE_TYPE_VXLAN_GPE_TUNNEL, &vxlan_gpe_vft);
1274 VLIB_INIT_FUNCTION (vxlan_gpe_init);
1278 * fd.io coding-style-patch-verification: ON
1281 * eval: (c-set-style "gnu")