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/fib/fib_entry_track.h>
26 #include <vnet/mfib/mfib_table.h>
27 #include <vnet/adj/adj_mcast.h>
28 #include <vnet/interface.h>
29 #include <vnet/udp/udp_local.h>
30 #include <vlib/vlib.h>
36 * VXLAN-GPE provides the features needed to allow L2 bridge domains (BDs)
37 * to span multiple servers. This is done by building an L2 overlay on
38 * top of an L3 network underlay using VXLAN-GPE tunnels.
40 * This makes it possible for servers to be co-located in the same data
41 * center or be separated geographically as long as they are reachable
42 * through the underlay L3 network.
44 * You can refer to this kind of L2 overlay bridge domain as a VXLAN-GPE segment.
47 vxlan_gpe_main_t vxlan_gpe_main;
50 format_decap_next (u8 * s, va_list * args)
52 vxlan_gpe_tunnel_t *t = va_arg (*args, vxlan_gpe_tunnel_t *);
56 case VXLAN_GPE_PROTOCOL_IP4:
57 s = format (s, "protocol ip4 fib-idx %d", t->decap_fib_index);
59 case VXLAN_GPE_PROTOCOL_IP6:
60 s = format (s, "protocol ip6 fib-idx %d", t->decap_fib_index);
62 case VXLAN_GPE_PROTOCOL_ETHERNET:
63 s = format (s, "protocol ethernet");
65 case VXLAN_GPE_PROTOCOL_NSH:
66 s = format (s, "protocol nsh");
69 s = format (s, "protocol unknown %d", t->protocol);
76 * @brief Format function for VXLAN GPE tunnel
78 * @param *s formatting string
81 * @return *s formatted string
85 format_vxlan_gpe_tunnel (u8 * s, va_list * args)
87 vxlan_gpe_tunnel_t *t = va_arg (*args, vxlan_gpe_tunnel_t *);
88 vxlan_gpe_main_t *ngm = &vxlan_gpe_main;
91 "[%d] lcl %U rmt %U lcl_port %d rmt_port %d vni %d "
92 "fib-idx %d sw-if-idx %d ",
93 t - ngm->tunnels, format_ip46_address, &t->local, IP46_TYPE_ANY,
94 format_ip46_address, &t->remote, IP46_TYPE_ANY, t->local_port,
95 t->remote_port, t->vni, t->encap_fib_index, t->sw_if_index);
98 /* next_dpo not yet used by vxlan-gpe-encap node */
99 s = format (s, "encap-dpo-idx %d ", t->next_dpo.dpoi_index);
102 s = format (s, "decap-next-%U ", format_decap_next, t);
104 if (PREDICT_FALSE (ip46_address_is_multicast (&t->remote)))
105 s = format (s, "mcast-sw-if-idx %d ", t->mcast_sw_if_index);
111 * @brief Naming for VXLAN GPE tunnel
113 * @param *s formatting string
116 * @return *s formatted string
120 format_vxlan_gpe_name (u8 * s, va_list * args)
122 u32 dev_instance = va_arg (*args, u32);
123 return format (s, "vxlan_gpe_tunnel%d", dev_instance);
127 * @brief CLI function for VXLAN GPE admin up/down
136 static clib_error_t *
137 vxlan_gpe_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index,
140 u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
141 VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
142 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
148 VNET_DEVICE_CLASS (vxlan_gpe_device_class,static) = {
150 .format_device_name = format_vxlan_gpe_name,
151 .format_tx_trace = format_vxlan_gpe_encap_trace,
152 .admin_up_down_function = vxlan_gpe_interface_admin_up_down,
158 * @brief Formatting function for tracing VXLAN GPE with length
167 format_vxlan_gpe_header_with_length (u8 * s, va_list * args)
169 u32 dev_instance = va_arg (*args, u32);
170 s = format (s, "unimplemented dev %u", dev_instance);
175 VNET_HW_INTERFACE_CLASS (vxlan_gpe_hw_class) = {
177 .format_header = format_vxlan_gpe_header_with_length,
178 .build_rewrite = default_build_rewrite,
183 vxlan_gpe_tunnel_restack_dpo (vxlan_gpe_tunnel_t * t)
185 dpo_id_t dpo = DPO_INVALID;
186 u32 encap_index = vxlan_gpe_encap_node.index;
187 fib_forward_chain_type_t forw_type = ip46_address_is_ip4 (&t->remote) ?
188 FIB_FORW_CHAIN_TYPE_UNICAST_IP4 : FIB_FORW_CHAIN_TYPE_UNICAST_IP6;
190 fib_entry_contribute_forwarding (t->fib_entry_index, forw_type, &dpo);
191 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
195 static vxlan_gpe_tunnel_t *
196 vxlan_gpe_tunnel_from_fib_node (fib_node_t * node)
198 ASSERT (FIB_NODE_TYPE_VXLAN_GPE_TUNNEL == node->fn_type);
199 return ((vxlan_gpe_tunnel_t *) (((char *) node) -
200 STRUCT_OFFSET_OF (vxlan_gpe_tunnel_t,
205 * Function definition to backwalk a FIB node -
206 * Here we will restack the new dpo of VXLAN_GPE DIP to encap node.
208 static fib_node_back_walk_rc_t
209 vxlan_gpe_tunnel_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
211 vxlan_gpe_tunnel_restack_dpo (vxlan_gpe_tunnel_from_fib_node (node));
212 return (FIB_NODE_BACK_WALK_CONTINUE);
216 * Function definition to get a FIB node from its index
219 vxlan_gpe_tunnel_fib_node_get (fib_node_index_t index)
221 vxlan_gpe_tunnel_t *t;
222 vxlan_gpe_main_t *ngm = &vxlan_gpe_main;
224 t = pool_elt_at_index (ngm->tunnels, index);
230 * Function definition to inform the FIB node that its last lock has gone.
233 vxlan_gpe_tunnel_last_lock_gone (fib_node_t * node)
236 * The VXLAN_GPE tunnel is a root of the graph. As such
237 * it never has children and thus is never locked.
243 * Virtual function table registered by VXLAN_GPE tunnels
244 * for participation in the FIB object graph.
246 const static fib_node_vft_t vxlan_gpe_vft = {
247 .fnv_get = vxlan_gpe_tunnel_fib_node_get,
248 .fnv_last_lock = vxlan_gpe_tunnel_last_lock_gone,
249 .fnv_back_walk = vxlan_gpe_tunnel_back_walk,
252 #define foreach_gpe_copy_field \
255 _ (mcast_sw_if_index) \
256 _ (encap_fib_index) \
257 _ (decap_fib_index) \
261 #define foreach_copy_ipv4 { \
262 _(local.ip4.as_u32) \
263 _(remote.ip4.as_u32) \
266 #define foreach_copy_ipv6 { \
267 _(local.ip6.as_u64[0]) \
268 _(local.ip6.as_u64[1]) \
269 _(remote.ip6.as_u64[0]) \
270 _(remote.ip6.as_u64[1]) \
275 * @brief Calculate IPv4 VXLAN GPE rewrite header
283 vxlan4_gpe_rewrite (vxlan_gpe_tunnel_t * t, u32 extension_size,
284 u8 protocol_override, uword encap_next_node)
288 ip4_vxlan_gpe_header_t *h0;
291 len = sizeof (*h0) + extension_size;
293 vec_free (t->rewrite);
294 vec_validate_aligned (rw, len - 1, CLIB_CACHE_LINE_BYTES);
296 h0 = (ip4_vxlan_gpe_header_t *) rw;
298 /* Fixed portion of the (outer) ip4 header */
300 ip0->ip_version_and_header_length = 0x45;
302 ip0->protocol = IP_PROTOCOL_UDP;
304 /* we fix up the ip4 header length and checksum after-the-fact */
305 ip0->src_address.as_u32 = t->local.ip4.as_u32;
306 ip0->dst_address.as_u32 = t->remote.ip4.as_u32;
307 ip0->checksum = ip4_header_checksum (ip0);
309 /* UDP header, randomize src port on something, maybe? */
310 h0->udp.src_port = clib_host_to_net_u16 (t->local_port);
311 h0->udp.dst_port = clib_host_to_net_u16 (t->remote_port);
313 /* VXLAN header. Are we having fun yet? */
314 h0->vxlan.flags = VXLAN_GPE_FLAGS_I | VXLAN_GPE_FLAGS_P;
315 h0->vxlan.ver_res = VXLAN_GPE_VERSION;
316 if (protocol_override)
318 h0->vxlan.protocol = protocol_override;
322 h0->vxlan.protocol = t->protocol;
324 t->rewrite_size = sizeof (ip4_vxlan_gpe_header_t) + extension_size;
325 h0->vxlan.vni_res = clib_host_to_net_u32 (t->vni << 8);
328 t->encap_next_node = encap_next_node;
333 * @brief Calculate IPv6 VXLAN GPE rewrite header
341 vxlan6_gpe_rewrite (vxlan_gpe_tunnel_t * t, u32 extension_size,
342 u8 protocol_override, uword encap_next_node)
346 ip6_vxlan_gpe_header_t *h0;
349 len = sizeof (*h0) + extension_size;
351 vec_free (t->rewrite);
352 vec_validate_aligned (rw, len - 1, CLIB_CACHE_LINE_BYTES);
354 h0 = (ip6_vxlan_gpe_header_t *) rw;
356 /* Fixed portion of the (outer) ip4 header */
358 ip0->ip_version_traffic_class_and_flow_label =
359 clib_host_to_net_u32 (6 << 28);
360 ip0->hop_limit = 255;
361 ip0->protocol = IP_PROTOCOL_UDP;
363 ip0->src_address.as_u64[0] = t->local.ip6.as_u64[0];
364 ip0->src_address.as_u64[1] = t->local.ip6.as_u64[1];
365 ip0->dst_address.as_u64[0] = t->remote.ip6.as_u64[0];
366 ip0->dst_address.as_u64[1] = t->remote.ip6.as_u64[1];
368 /* UDP header, randomize src port on something, maybe? */
369 h0->udp.src_port = clib_host_to_net_u16 (t->local_port);
370 h0->udp.dst_port = clib_host_to_net_u16 (t->remote_port);
372 /* VXLAN header. Are we having fun yet? */
373 h0->vxlan.flags = VXLAN_GPE_FLAGS_I | VXLAN_GPE_FLAGS_P;
374 h0->vxlan.ver_res = VXLAN_GPE_VERSION;
375 if (protocol_override)
377 h0->vxlan.protocol = t->protocol;
381 h0->vxlan.protocol = protocol_override;
383 t->rewrite_size = sizeof (ip4_vxlan_gpe_header_t) + extension_size;
384 h0->vxlan.vni_res = clib_host_to_net_u32 (t->vni << 8);
387 t->encap_next_node = encap_next_node;
392 typedef CLIB_PACKED(union {
394 fib_node_index_t mfib_entry_index;
395 adj_index_t mcast_adj_index;
401 static inline mcast_shared_t
402 mcast_shared_get (ip46_address_t * ip)
404 ASSERT (ip46_address_is_multicast (ip));
405 uword *p = hash_get_mem (vxlan_gpe_main.mcast_shared, ip);
407 return (mcast_shared_t)
413 mcast_shared_add (ip46_address_t * remote,
414 fib_node_index_t mfei, adj_index_t ai)
416 mcast_shared_t new_ep = {
417 .mcast_adj_index = ai,
418 .mfib_entry_index = mfei,
421 hash_set_mem_alloc (&vxlan_gpe_main.mcast_shared, remote, new_ep.as_u64);
425 mcast_shared_remove (ip46_address_t * remote)
427 mcast_shared_t ep = mcast_shared_get (remote);
429 adj_unlock (ep.mcast_adj_index);
430 mfib_table_entry_delete_index (ep.mfib_entry_index, MFIB_SOURCE_VXLAN_GPE);
432 hash_unset_mem_free (&vxlan_gpe_main.mcast_shared, remote);
436 * @brief Add or Del a VXLAN GPE tunnel
439 * @param *sw_if_index
444 int vnet_vxlan_gpe_add_del_tunnel
445 (vnet_vxlan_gpe_add_del_tunnel_args_t * a, u32 * sw_if_indexp)
447 vxlan_gpe_main_t *ngm = &vxlan_gpe_main;
448 vxlan_gpe_tunnel_t *t = 0;
449 vnet_main_t *vnm = ngm->vnet_main;
450 vnet_hw_interface_t *hi;
452 u32 hw_if_index = ~0;
453 u32 sw_if_index = ~0;
455 vxlan4_gpe_tunnel_key_t key4, *key4_copy;
456 vxlan6_gpe_tunnel_key_t key6, *key6_copy;
457 u32 is_ip6 = a->is_ip6;
460 if (a->local_port == 0)
461 a->local_port = is_ip6 ? UDP_DST_PORT_VXLAN6_GPE : UDP_DST_PORT_VXLAN_GPE;
463 if (a->remote_port == 0)
464 a->remote_port = is_ip6 ? UDP_DST_PORT_VXLAN6_GPE : UDP_DST_PORT_VXLAN_GPE;
468 key4.local = a->local.ip4.as_u32;
469 key4.remote = a->remote.ip4.as_u32;
470 key4.vni = clib_host_to_net_u32 (a->vni << 8);
471 key4.port = (u32) clib_host_to_net_u16 (a->local_port);
473 p = hash_get_mem (ngm->vxlan4_gpe_tunnel_by_key, &key4);
477 key6.local.as_u64[0] = a->local.ip6.as_u64[0];
478 key6.local.as_u64[1] = a->local.ip6.as_u64[1];
479 key6.remote.as_u64[0] = a->remote.ip6.as_u64[0];
480 key6.remote.as_u64[1] = a->remote.ip6.as_u64[1];
481 key6.vni = clib_host_to_net_u32 (a->vni << 8);
482 key6.port = (u32) clib_host_to_net_u16 (a->local_port);
484 p = hash_get_mem (ngm->vxlan6_gpe_tunnel_by_key, &key6);
489 l2input_main_t *l2im = &l2input_main;
491 /* adding a tunnel: tunnel must not already exist */
493 return VNET_API_ERROR_TUNNEL_EXIST;
495 pool_get_aligned (ngm->tunnels, t, CLIB_CACHE_LINE_BYTES);
496 clib_memset (t, 0, sizeof (*t));
498 /* copy from arg structure */
500 #define _(x) t->x = a->x;
501 foreach_gpe_copy_field;
510 t->flags |= VXLAN_GPE_TUNNEL_IS_IPV4;
514 rv = vxlan4_gpe_rewrite (t, 0, 0, VXLAN_GPE_ENCAP_NEXT_IP4_LOOKUP);
518 rv = vxlan6_gpe_rewrite (t, 0, 0, VXLAN_GPE_ENCAP_NEXT_IP6_LOOKUP);
523 pool_put (ngm->tunnels, t);
529 key4_copy = clib_mem_alloc (sizeof (*key4_copy));
530 clib_memcpy_fast (key4_copy, &key4, sizeof (*key4_copy));
531 hash_set_mem (ngm->vxlan4_gpe_tunnel_by_key, key4_copy,
536 key6_copy = clib_mem_alloc (sizeof (*key6_copy));
537 clib_memcpy_fast (key6_copy, &key6, sizeof (*key6_copy));
538 hash_set_mem (ngm->vxlan6_gpe_tunnel_by_key, key6_copy,
542 if (vec_len (ngm->free_vxlan_gpe_tunnel_hw_if_indices) > 0)
544 vnet_interface_main_t *im = &vnm->interface_main;
545 hw_if_index = ngm->free_vxlan_gpe_tunnel_hw_if_indices
546 [vec_len (ngm->free_vxlan_gpe_tunnel_hw_if_indices) - 1];
547 _vec_len (ngm->free_vxlan_gpe_tunnel_hw_if_indices) -= 1;
549 hi = vnet_get_hw_interface (vnm, hw_if_index);
550 hi->dev_instance = t - ngm->tunnels;
551 hi->hw_instance = hi->dev_instance;
552 /* clear old stats of freed tunnel before reuse */
553 sw_if_index = hi->sw_if_index;
554 vnet_interface_counter_lock (im);
555 vlib_zero_combined_counter
556 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX],
558 vlib_zero_combined_counter (&im->combined_sw_if_counters
559 [VNET_INTERFACE_COUNTER_RX],
561 vlib_zero_simple_counter (&im->sw_if_counters
562 [VNET_INTERFACE_COUNTER_DROP],
564 vnet_interface_counter_unlock (im);
568 hw_if_index = vnet_register_interface
569 (vnm, vxlan_gpe_device_class.index, t - ngm->tunnels,
570 vxlan_gpe_hw_class.index, t - ngm->tunnels);
571 hi = vnet_get_hw_interface (vnm, hw_if_index);
574 /* Set vxlan-gpe tunnel output node */
575 u32 encap_index = vxlan_gpe_encap_node.index;
576 vnet_set_interface_output_node (vnm, hw_if_index, encap_index);
578 t->hw_if_index = hw_if_index;
579 t->sw_if_index = sw_if_index = hi->sw_if_index;
580 vec_validate_init_empty (ngm->tunnel_index_by_sw_if_index, sw_if_index,
582 ngm->tunnel_index_by_sw_if_index[sw_if_index] = t - ngm->tunnels;
584 /* setup l2 input config with l2 feature and bd 0 to drop packet */
585 vec_validate (l2im->configs, sw_if_index);
586 l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
587 l2im->configs[sw_if_index].bd_index = 0;
589 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
590 si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
591 vnet_sw_interface_set_flags (vnm, hi->sw_if_index,
592 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
593 fib_node_init (&t->node, FIB_NODE_TYPE_VXLAN_GPE_TUNNEL);
594 fib_prefix_t tun_remote_pfx;
595 vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
597 fib_prefix_from_ip46_addr (&t->remote, &tun_remote_pfx);
598 if (!ip46_address_is_multicast (&t->remote))
601 * source the FIB entry for the tunnel's destination
602 * and become a child thereof. The tunnel will then get poked
603 * when the forwarding for the entry updates, and the tunnel can
604 * re-stack accordingly
606 vtep_addr_ref (&ngm->vtep_table, t->encap_fib_index, &t->local);
607 t->fib_entry_index = fib_entry_track (t->encap_fib_index,
609 FIB_NODE_TYPE_VXLAN_GPE_TUNNEL,
612 vxlan_gpe_tunnel_restack_dpo (t);
616 /* Multicast tunnel -
617 * as the same mcast group can be used for multiple mcast tunnels
618 * with different VNIs, create the output fib adjacency only if
619 * it does not already exist
621 fib_protocol_t fp = fib_ip_proto (is_ip6);
623 if (vtep_addr_ref (&ngm->vtep_table,
624 t->encap_fib_index, &t->remote) == 1)
626 fib_node_index_t mfei;
628 fib_route_path_t path = {
629 .frp_proto = fib_proto_to_dpo (fp),
630 .frp_addr = zero_addr,
631 .frp_sw_if_index = 0xffffffff,
634 .frp_flags = FIB_ROUTE_PATH_LOCAL,
635 .frp_mitf_flags = MFIB_ITF_FLAG_FORWARD,
637 const mfib_prefix_t mpfx = {
639 .fp_len = (is_ip6 ? 128 : 32),
640 .fp_grp_addr = tun_remote_pfx.fp_addr,
644 * Setup the (*,G) to receive traffic on the mcast group
645 * - the forwarding interface is for-us
646 * - the accepting interface is that from the API
648 mfib_table_entry_path_update (t->encap_fib_index,
650 MFIB_SOURCE_VXLAN_GPE, &path);
652 path.frp_sw_if_index = a->mcast_sw_if_index;
653 path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
654 path.frp_mitf_flags = MFIB_ITF_FLAG_ACCEPT;
655 mfei = mfib_table_entry_path_update (t->encap_fib_index,
657 MFIB_SOURCE_VXLAN_GPE,
661 * Create the mcast adjacency to send traffic to the group
663 ai = adj_mcast_add_or_lock (fp,
664 fib_proto_to_link (fp),
665 a->mcast_sw_if_index);
668 * create a new end-point
670 mcast_shared_add (&t->remote, mfei, ai);
673 dpo_id_t dpo = DPO_INVALID;
674 mcast_shared_t ep = mcast_shared_get (&t->remote);
676 /* Stack shared mcast remote mac addr rewrite on encap */
677 dpo_set (&dpo, DPO_ADJACENCY_MCAST,
678 fib_proto_to_dpo (fp), ep.mcast_adj_index);
680 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
682 flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
685 vnet_get_sw_interface (vnet_get_main (), sw_if_index)->flood_class =
690 /* deleting a tunnel: tunnel must exist */
692 return VNET_API_ERROR_NO_SUCH_ENTRY;
694 t = pool_elt_at_index (ngm->tunnels, p[0]);
696 sw_if_index = t->sw_if_index;
697 vnet_sw_interface_set_flags (vnm, t->sw_if_index, 0 /* down */ );
698 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, t->sw_if_index);
699 si->flags |= VNET_SW_INTERFACE_FLAG_HIDDEN;
700 set_int_l2_mode (ngm->vlib_main, vnm, MODE_L3, t->sw_if_index, 0,
701 L2_BD_PORT_TYPE_NORMAL, 0, 0);
702 vec_add1 (ngm->free_vxlan_gpe_tunnel_hw_if_indices, t->hw_if_index);
704 ngm->tunnel_index_by_sw_if_index[t->sw_if_index] = ~0;
707 hash_unset (ngm->vxlan4_gpe_tunnel_by_key, key4.as_u64);
709 hash_unset_mem_free (&ngm->vxlan6_gpe_tunnel_by_key, &key6);
711 if (!ip46_address_is_multicast (&t->remote))
713 vtep_addr_unref (&ngm->vtep_table, t->encap_fib_index, &t->local);
714 fib_entry_untrack (t->fib_entry_index, t->sibling_index);
716 else if (vtep_addr_unref (&ngm->vtep_table,
717 t->encap_fib_index, &t->remote) == 0)
719 mcast_shared_remove (&t->remote);
722 fib_node_deinit (&t->node);
723 vec_free (t->rewrite);
724 pool_put (ngm->tunnels, t);
728 *sw_if_indexp = sw_if_index;
732 /* register udp ports */
733 if (!is_ip6 && !udp_is_valid_dst_port (a->local_port, 1))
734 udp_register_dst_port (ngm->vlib_main, a->local_port,
735 vxlan4_gpe_input_node.index, 1 /* is_ip4 */);
736 if (is_ip6 && !udp_is_valid_dst_port (a->remote_port, 0))
737 udp_register_dst_port (ngm->vlib_main, a->remote_port,
738 vxlan6_gpe_input_node.index, 0 /* is_ip4 */);
744 static clib_error_t *
745 vxlan_gpe_add_del_tunnel_command_fn (vlib_main_t * vm,
746 unformat_input_t * input,
747 vlib_cli_command_t * cmd)
749 unformat_input_t _line_input, *line_input = &_line_input;
751 ip46_address_t local, remote;
757 u32 mcast_sw_if_index = ~0;
758 u32 encap_fib_index = 0;
759 u32 decap_fib_index = 0;
760 u8 protocol = VXLAN_GPE_PROTOCOL_IP4;
767 vnet_vxlan_gpe_add_del_tunnel_args_t _a, *a = &_a;
769 clib_error_t *error = NULL;
771 /* Get a line of input. */
772 if (!unformat_user (input, unformat_line_input, line_input))
775 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
777 if (unformat (line_input, "del"))
779 else if (unformat (line_input, "local %U",
780 unformat_ip4_address, &local.ip4))
785 else if (unformat (line_input, "remote %U",
786 unformat_ip4_address, &remote.ip4))
791 else if (unformat (line_input, "local %U",
792 unformat_ip6_address, &local.ip6))
797 else if (unformat (line_input, "remote %U",
798 unformat_ip6_address, &remote.ip6))
803 else if (unformat (line_input, "group %U %U",
804 unformat_ip4_address, &remote.ip4,
805 unformat_vnet_sw_interface,
806 vnet_get_main (), &mcast_sw_if_index))
808 grp_set = remote_set = 1;
811 else if (unformat (line_input, "group %U %U",
812 unformat_ip6_address, &remote.ip6,
813 unformat_vnet_sw_interface,
814 vnet_get_main (), &mcast_sw_if_index))
816 grp_set = remote_set = 1;
819 else if (unformat (line_input, "encap-vrf-id %d", &tmp))
822 encap_fib_index = fib_table_find (FIB_PROTOCOL_IP6, tmp);
824 encap_fib_index = fib_table_find (FIB_PROTOCOL_IP4, tmp);
826 if (encap_fib_index == ~0)
829 clib_error_return (0, "nonexistent encap fib id %d", tmp);
833 else if (unformat (line_input, "decap-vrf-id %d", &tmp))
836 decap_fib_index = fib_table_find (FIB_PROTOCOL_IP6, tmp);
838 decap_fib_index = fib_table_find (FIB_PROTOCOL_IP4, tmp);
840 if (decap_fib_index == ~0)
843 clib_error_return (0, "nonexistent decap fib id %d", tmp);
847 else if (unformat (line_input, "vni %d", &vni))
849 else if (unformat (line_input, "local_port %d", &local_port))
851 else if (unformat (line_input, "remote_port %d", &remote_port))
853 else if (unformat (line_input, "next-ip4"))
854 protocol = VXLAN_GPE_PROTOCOL_IP4;
855 else if (unformat (line_input, "next-ip6"))
856 protocol = VXLAN_GPE_PROTOCOL_IP6;
857 else if (unformat (line_input, "next-ethernet"))
858 protocol = VXLAN_GPE_PROTOCOL_ETHERNET;
859 else if (unformat (line_input, "next-nsh"))
860 protocol = VXLAN_GPE_PROTOCOL_NSH;
863 error = clib_error_return (0, "parse error: '%U'",
864 format_unformat_error, line_input);
871 error = clib_error_return (0, "tunnel local address not specified");
877 error = clib_error_return (0, "tunnel remote address not specified");
881 if (grp_set && !ip46_address_is_multicast (&remote))
883 error = clib_error_return (0, "tunnel group address not multicast");
887 if (grp_set == 0 && ip46_address_is_multicast (&remote))
889 error = clib_error_return (0, "remote address must be unicast");
893 if (grp_set && mcast_sw_if_index == ~0)
895 error = clib_error_return (0, "tunnel nonexistent multicast device");
898 if (ipv4_set && ipv6_set)
900 error = clib_error_return (0, "both IPv4 and IPv6 addresses specified");
904 if ((ipv4_set && memcmp (&local.ip4, &remote.ip4, sizeof (local.ip4)) == 0)
906 && memcmp (&local.ip6, &remote.ip6, sizeof (local.ip6)) == 0))
908 error = clib_error_return (0, "src and remote addresses are identical");
914 error = clib_error_return (0, "vni not specified");
918 clib_memset (a, 0, sizeof (*a));
921 a->is_ip6 = ipv6_set;
924 #define _(x) a->x = x;
925 foreach_gpe_copy_field;
933 rv = vnet_vxlan_gpe_add_del_tunnel (a, &sw_if_index);
938 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
939 vnet_get_main (), sw_if_index);
941 case VNET_API_ERROR_INVALID_DECAP_NEXT:
942 error = clib_error_return (0, "invalid decap-next...");
945 case VNET_API_ERROR_TUNNEL_EXIST:
946 error = clib_error_return (0, "tunnel already exists...");
949 case VNET_API_ERROR_NO_SUCH_ENTRY:
950 error = clib_error_return (0, "tunnel does not exist...");
954 error = clib_error_return
955 (0, "vnet_vxlan_gpe_add_del_tunnel returned %d", rv);
960 unformat_free (line_input);
966 * Add or delete a VXLAN-GPE Tunnel.
968 * VXLAN-GPE provides the features needed to allow L2 bridge domains (BDs)
969 * to span multiple servers. This is done by building an L2 overlay on
970 * top of an L3 network underlay using VXLAN-GPE tunnels.
972 * This makes it possible for servers to be co-located in the same data
973 * center or be separated geographically as long as they are reachable
974 * through the underlay L3 network.
976 * You can refer to this kind of L2 overlay bridge domain as a VXLAN-GPE segment.
979 * Example of how to create a VXLAN-GPE Tunnel:
980 * @cliexcmd{create vxlan-gpe tunnel local 10.0.3.1 remote 10.0.3.3 vni 13 encap-vrf-id 7}
981 * Example of how to delete a VXLAN-GPE Tunnel:
982 * @cliexcmd{create vxlan-gpe tunnel local 10.0.3.1 remote 10.0.3.3 vni 13 del}
985 VLIB_CLI_COMMAND (create_vxlan_gpe_tunnel_command, static) = {
986 .path = "create vxlan-gpe tunnel",
988 "create vxlan-gpe tunnel local <local-addr> "
989 " {remote <remote-addr>|group <mcast-addr> <intf-name>}"
990 " vni <nn> [next-ip4][next-ip6][next-ethernet][next-nsh]"
991 " [encap-vrf-id <nn>] [decap-vrf-id <nn>] [del]\n",
992 .function = vxlan_gpe_add_del_tunnel_command_fn,
997 * @brief CLI function for showing VXLAN GPE tunnels
1006 static clib_error_t *
1007 show_vxlan_gpe_tunnel_command_fn (vlib_main_t * vm,
1008 unformat_input_t * input,
1009 vlib_cli_command_t * cmd)
1011 vxlan_gpe_main_t *ngm = &vxlan_gpe_main;
1012 vxlan_gpe_tunnel_t *t;
1014 if (pool_elts (ngm->tunnels) == 0)
1015 vlib_cli_output (vm, "No vxlan-gpe tunnels configured.");
1018 pool_foreach (t, ngm->tunnels)
1020 vlib_cli_output (vm, "%U", format_vxlan_gpe_tunnel, t);
1028 * Display all the VXLAN-GPE Tunnel entries.
1031 * Example of how to display the VXLAN-GPE Tunnel entries:
1032 * @cliexstart{show vxlan-gpe tunnel}
1033 * [0] local 10.0.3.1 remote 10.0.3.3 vni 13 encap_fib_index 0 sw_if_index 5 decap_next l2
1037 VLIB_CLI_COMMAND (show_vxlan_gpe_tunnel_command, static) = {
1038 .path = "show vxlan-gpe",
1039 .function = show_vxlan_gpe_tunnel_command_fn,
1044 vnet_int_vxlan_gpe_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable)
1047 vnet_feature_enable_disable ("ip6-unicast", "ip6-vxlan-gpe-bypass",
1048 sw_if_index, is_enable, 0, 0);
1050 vnet_feature_enable_disable ("ip4-unicast", "ip4-vxlan-gpe-bypass",
1051 sw_if_index, is_enable, 0, 0);
1055 static clib_error_t *
1056 set_ip_vxlan_gpe_bypass (u32 is_ip6,
1057 unformat_input_t * input, vlib_cli_command_t * cmd)
1059 unformat_input_t _line_input, *line_input = &_line_input;
1060 vnet_main_t *vnm = vnet_get_main ();
1061 clib_error_t *error = 0;
1062 u32 sw_if_index, is_enable;
1067 if (!unformat_user (input, unformat_line_input, line_input))
1070 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1073 (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
1075 else if (unformat (line_input, "del"))
1079 error = unformat_parse_error (line_input);
1084 if (~0 == sw_if_index)
1086 error = clib_error_return (0, "unknown interface `%U'",
1087 format_unformat_error, line_input);
1091 vnet_int_vxlan_gpe_bypass_mode (sw_if_index, is_ip6, is_enable);
1094 unformat_free (line_input);
1099 static clib_error_t *
1100 set_ip4_vxlan_gpe_bypass (vlib_main_t * vm,
1101 unformat_input_t * input, vlib_cli_command_t * cmd)
1103 return set_ip_vxlan_gpe_bypass (0, input, cmd);
1107 * This command adds the 'ip4-vxlan-gpe-bypass' graph node for a given
1108 * interface. By adding the IPv4 vxlan-gpe-bypass graph node to an interface,
1109 * the node checks for and validate input vxlan_gpe packet and bypass
1110 * ip4-lookup, ip4-local, ip4-udp-lookup nodes to speedup vxlan_gpe packet
1111 * forwarding. This node will cause extra overhead to for non-vxlan_gpe
1112 * packets which is kept at a minimum.
1116 * Example of graph node before ip4-vxlan-gpe-bypass is enabled:
1117 * @cliexstart{show vlib graph ip4-vxlan-gpe-bypass}
1118 * Name Next Previous
1119 * ip4-vxlan-gpe-bypass error-drop [0]
1120 * vxlan4-gpe-input [1]
1124 * Example of how to enable ip4-vxlan-gpe-bypass on an interface:
1125 * @cliexcmd{set interface ip vxlan-gpe-bypass GigabitEthernet2/0/0}
1127 * Example of graph node after ip4-vxlan-gpe-bypass is enabled:
1128 * @cliexstart{show vlib graph ip4-vxlan-gpe-bypass}
1129 * Name Next Previous
1130 * ip4-vxlan-gpe-bypass error-drop [0] ip4-input
1131 * vxlan4-gpe-input [1] ip4-input-no-checksum
1135 * Example of how to display the feature enabled on an interface:
1136 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1137 * IP feature paths configured on GigabitEthernet2/0/0...
1140 * ip4-vxlan-gpe-bypass
1145 * Example of how to disable ip4-vxlan-gpe-bypass on an interface:
1146 * @cliexcmd{set interface ip vxlan-gpe-bypass GigabitEthernet2/0/0 del}
1150 VLIB_CLI_COMMAND (set_interface_ip_vxlan_gpe_bypass_command, static) = {
1151 .path = "set interface ip vxlan-gpe-bypass",
1152 .function = set_ip4_vxlan_gpe_bypass,
1153 .short_help = "set interface ip vxlan-gpe-bypass <interface> [del]",
1157 static clib_error_t *
1158 set_ip6_vxlan_gpe_bypass (vlib_main_t * vm,
1159 unformat_input_t * input, vlib_cli_command_t * cmd)
1161 return set_ip_vxlan_gpe_bypass (1, input, cmd);
1165 * This command adds the 'ip6-vxlan-gpe-bypass' graph node for a given
1166 * interface. By adding the IPv6 vxlan-gpe-bypass graph node to an interface,
1167 * the node checks for and validate input vxlan_gpe packet and bypass
1168 * ip6-lookup, ip6-local, ip6-udp-lookup nodes to speedup vxlan_gpe packet
1169 * forwarding. This node will cause extra overhead to for non-vxlan_gpe packets
1170 * which is kept at a minimum.
1174 * Example of graph node before ip6-vxlan-gpe-bypass is enabled:
1175 * @cliexstart{show vlib graph ip6-vxlan-gpe-bypass}
1176 * Name Next Previous
1177 * ip6-vxlan-gpe-bypass error-drop [0]
1178 * vxlan6-gpe-input [1]
1182 * Example of how to enable ip6-vxlan-gpe-bypass on an interface:
1183 * @cliexcmd{set interface ip6 vxlan-gpe-bypass GigabitEthernet2/0/0}
1185 * Example of graph node after ip6-vxlan-gpe-bypass is enabled:
1186 * @cliexstart{show vlib graph ip6-vxlan-gpe-bypass}
1187 * Name Next Previous
1188 * ip6-vxlan-gpe-bypass error-drop [0] ip6-input
1189 * vxlan6-gpe-input [1] ip4-input-no-checksum
1193 * Example of how to display the feature enabled on an interface:
1194 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1195 * IP feature paths configured on GigabitEthernet2/0/0...
1198 * ip6-vxlan-gpe-bypass
1203 * Example of how to disable ip6-vxlan-gpe-bypass on an interface:
1204 * @cliexcmd{set interface ip6 vxlan-gpe-bypass GigabitEthernet2/0/0 del}
1208 VLIB_CLI_COMMAND (set_interface_ip6_vxlan_gpe_bypass_command, static) = {
1209 .path = "set interface ip6 vxlan-gpe-bypass",
1210 .function = set_ip6_vxlan_gpe_bypass,
1211 .short_help = "set interface ip6 vxlan-gpe-bypass <interface> [del]",
1216 VNET_FEATURE_INIT (ip4_vxlan_gpe_bypass, static) =
1218 .arc_name = "ip4-unicast",
1219 .node_name = "ip4-vxlan-gpe-bypass",
1220 .runs_before = VNET_FEATURES ("ip4-lookup"),
1223 VNET_FEATURE_INIT (ip6_vxlan_gpe_bypass, static) =
1225 .arc_name = "ip6-unicast",
1226 .node_name = "ip6-vxlan-gpe-bypass",
1227 .runs_before = VNET_FEATURES ("ip6-lookup"),
1232 * @brief Feature init function for VXLAN GPE
1240 vxlan_gpe_init (vlib_main_t * vm)
1242 vxlan_gpe_main_t *ngm = &vxlan_gpe_main;
1244 ngm->vnet_main = vnet_get_main ();
1245 ngm->vlib_main = vm;
1247 ngm->vxlan4_gpe_tunnel_by_key
1248 = hash_create_mem (0, sizeof (vxlan4_gpe_tunnel_key_t), sizeof (uword));
1250 ngm->vxlan6_gpe_tunnel_by_key
1251 = hash_create_mem (0, sizeof (vxlan6_gpe_tunnel_key_t), sizeof (uword));
1254 ngm->mcast_shared = hash_create_mem (0,
1255 sizeof (ip46_address_t),
1256 sizeof (mcast_shared_t));
1257 ngm->vtep_table = vtep_table_create ();
1259 /* Register the list of standard decap protocols supported */
1260 vxlan_gpe_register_decap_protocol (VXLAN_GPE_PROTOCOL_IP4,
1261 VXLAN_GPE_INPUT_NEXT_IP4_INPUT);
1262 vxlan_gpe_register_decap_protocol (VXLAN_GPE_PROTOCOL_IP6,
1263 VXLAN_GPE_INPUT_NEXT_IP6_INPUT);
1264 vxlan_gpe_register_decap_protocol (VXLAN_GPE_PROTOCOL_ETHERNET,
1265 VXLAN_GPE_INPUT_NEXT_L2_INPUT);
1267 fib_node_register_type (FIB_NODE_TYPE_VXLAN_GPE_TUNNEL, &vxlan_gpe_vft);
1272 VLIB_INIT_FUNCTION (vxlan_gpe_init);
1276 * fd.io coding-style-patch-verification: ON
1279 * eval: (c-set-style "gnu")