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 <vlib/vlib.h>
35 * VXLAN-GPE provides the features needed to allow L2 bridge domains (BDs)
36 * to span multiple servers. This is done by building an L2 overlay on
37 * top of an L3 network underlay using VXLAN-GPE tunnels.
39 * This makes it possible for servers to be co-located in the same data
40 * center or be separated geographically as long as they are reachable
41 * through the underlay L3 network.
43 * You can refer to this kind of L2 overlay bridge domain as a VXLAN-GPE segment.
46 vxlan_gpe_main_t vxlan_gpe_main;
49 format_decap_next (u8 * s, va_list * args)
51 vxlan_gpe_tunnel_t *t = va_arg (*args, vxlan_gpe_tunnel_t *);
55 case VXLAN_GPE_PROTOCOL_IP4:
56 s = format (s, "protocol ip4 fib-idx %d", t->decap_fib_index);
58 case VXLAN_GPE_PROTOCOL_IP6:
59 s = format (s, "protocol ip6 fib-idx %d", t->decap_fib_index);
61 case VXLAN_GPE_PROTOCOL_ETHERNET:
62 s = format (s, "protocol ethernet");
64 case VXLAN_GPE_PROTOCOL_NSH:
65 s = format (s, "protocol nsh");
68 s = format (s, "protocol unknown %d", t->protocol);
75 * @brief Format function for VXLAN GPE tunnel
77 * @param *s formatting string
80 * @return *s formatted string
84 format_vxlan_gpe_tunnel (u8 * s, va_list * args)
86 vxlan_gpe_tunnel_t *t = va_arg (*args, vxlan_gpe_tunnel_t *);
87 vxlan_gpe_main_t *ngm = &vxlan_gpe_main;
89 s = format (s, "[%d] lcl %U rmt %U vni %d fib-idx %d sw-if-idx %d ",
91 format_ip46_address, &t->local, IP46_TYPE_ANY,
92 format_ip46_address, &t->remote, IP46_TYPE_ANY,
93 t->vni, t->encap_fib_index, t->sw_if_index);
96 /* next_dpo not yet used by vxlan-gpe-encap node */
97 s = format (s, "encap-dpo-idx %d ", t->next_dpo.dpoi_index);
100 s = format (s, "decap-next-%U ", format_decap_next, t);
102 if (PREDICT_FALSE (ip46_address_is_multicast (&t->remote)))
103 s = format (s, "mcast-sw-if-idx %d ", t->mcast_sw_if_index);
109 * @brief Naming for VXLAN GPE tunnel
111 * @param *s formatting string
114 * @return *s formatted string
118 format_vxlan_gpe_name (u8 * s, va_list * args)
120 u32 dev_instance = va_arg (*args, u32);
121 return format (s, "vxlan_gpe_tunnel%d", dev_instance);
125 * @brief CLI function for VXLAN GPE admin up/down
134 static clib_error_t *
135 vxlan_gpe_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index,
138 u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
139 VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
140 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
146 VNET_DEVICE_CLASS (vxlan_gpe_device_class,static) = {
148 .format_device_name = format_vxlan_gpe_name,
149 .format_tx_trace = format_vxlan_gpe_encap_trace,
150 .admin_up_down_function = vxlan_gpe_interface_admin_up_down,
156 * @brief Formatting function for tracing VXLAN GPE with length
165 format_vxlan_gpe_header_with_length (u8 * s, va_list * args)
167 u32 dev_instance = va_arg (*args, u32);
168 s = format (s, "unimplemented dev %u", dev_instance);
173 VNET_HW_INTERFACE_CLASS (vxlan_gpe_hw_class) = {
175 .format_header = format_vxlan_gpe_header_with_length,
176 .build_rewrite = default_build_rewrite,
181 vxlan_gpe_tunnel_restack_dpo (vxlan_gpe_tunnel_t * t)
183 dpo_id_t dpo = DPO_INVALID;
184 u32 encap_index = vxlan_gpe_encap_node.index;
185 fib_forward_chain_type_t forw_type = ip46_address_is_ip4 (&t->remote) ?
186 FIB_FORW_CHAIN_TYPE_UNICAST_IP4 : FIB_FORW_CHAIN_TYPE_UNICAST_IP6;
188 fib_entry_contribute_forwarding (t->fib_entry_index, forw_type, &dpo);
189 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
193 static vxlan_gpe_tunnel_t *
194 vxlan_gpe_tunnel_from_fib_node (fib_node_t * node)
196 ASSERT (FIB_NODE_TYPE_VXLAN_GPE_TUNNEL == node->fn_type);
197 return ((vxlan_gpe_tunnel_t *) (((char *) node) -
198 STRUCT_OFFSET_OF (vxlan_gpe_tunnel_t,
203 * Function definition to backwalk a FIB node -
204 * Here we will restack the new dpo of VXLAN_GPE DIP to encap node.
206 static fib_node_back_walk_rc_t
207 vxlan_gpe_tunnel_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
209 vxlan_gpe_tunnel_restack_dpo (vxlan_gpe_tunnel_from_fib_node (node));
210 return (FIB_NODE_BACK_WALK_CONTINUE);
214 * Function definition to get a FIB node from its index
217 vxlan_gpe_tunnel_fib_node_get (fib_node_index_t index)
219 vxlan_gpe_tunnel_t *t;
220 vxlan_gpe_main_t *ngm = &vxlan_gpe_main;
222 t = pool_elt_at_index (ngm->tunnels, index);
228 * Function definition to inform the FIB node that its last lock has gone.
231 vxlan_gpe_tunnel_last_lock_gone (fib_node_t * node)
234 * The VXLAN_GPE tunnel is a root of the graph. As such
235 * it never has children and thus is never locked.
241 * Virtual function table registered by VXLAN_GPE tunnels
242 * for participation in the FIB object graph.
244 const static fib_node_vft_t vxlan_gpe_vft = {
245 .fnv_get = vxlan_gpe_tunnel_fib_node_get,
246 .fnv_last_lock = vxlan_gpe_tunnel_last_lock_gone,
247 .fnv_back_walk = vxlan_gpe_tunnel_back_walk,
250 #define foreach_gpe_copy_field \
253 _(mcast_sw_if_index) \
257 #define foreach_copy_ipv4 { \
258 _(local.ip4.as_u32) \
259 _(remote.ip4.as_u32) \
262 #define foreach_copy_ipv6 { \
263 _(local.ip6.as_u64[0]) \
264 _(local.ip6.as_u64[1]) \
265 _(remote.ip6.as_u64[0]) \
266 _(remote.ip6.as_u64[1]) \
271 * @brief Calculate IPv4 VXLAN GPE rewrite header
279 vxlan4_gpe_rewrite (vxlan_gpe_tunnel_t * t, u32 extension_size,
280 u8 protocol_override, uword encap_next_node)
284 ip4_vxlan_gpe_header_t *h0;
287 len = sizeof (*h0) + extension_size;
289 vec_free (t->rewrite);
290 vec_validate_aligned (rw, len - 1, CLIB_CACHE_LINE_BYTES);
292 h0 = (ip4_vxlan_gpe_header_t *) rw;
294 /* Fixed portion of the (outer) ip4 header */
296 ip0->ip_version_and_header_length = 0x45;
298 ip0->protocol = IP_PROTOCOL_UDP;
300 /* we fix up the ip4 header length and checksum after-the-fact */
301 ip0->src_address.as_u32 = t->local.ip4.as_u32;
302 ip0->dst_address.as_u32 = t->remote.ip4.as_u32;
303 ip0->checksum = ip4_header_checksum (ip0);
305 /* UDP header, randomize src port on something, maybe? */
306 h0->udp.src_port = clib_host_to_net_u16 (4790);
307 h0->udp.dst_port = clib_host_to_net_u16 (UDP_DST_PORT_VXLAN_GPE);
309 /* VXLAN header. Are we having fun yet? */
310 h0->vxlan.flags = VXLAN_GPE_FLAGS_I | VXLAN_GPE_FLAGS_P;
311 h0->vxlan.ver_res = VXLAN_GPE_VERSION;
312 if (protocol_override)
314 h0->vxlan.protocol = protocol_override;
318 h0->vxlan.protocol = t->protocol;
320 t->rewrite_size = sizeof (ip4_vxlan_gpe_header_t) + extension_size;
321 h0->vxlan.vni_res = clib_host_to_net_u32 (t->vni << 8);
324 t->encap_next_node = encap_next_node;
329 * @brief Calculate IPv6 VXLAN GPE rewrite header
337 vxlan6_gpe_rewrite (vxlan_gpe_tunnel_t * t, u32 extension_size,
338 u8 protocol_override, uword encap_next_node)
342 ip6_vxlan_gpe_header_t *h0;
345 len = sizeof (*h0) + extension_size;
347 vec_free (t->rewrite);
348 vec_validate_aligned (rw, len - 1, CLIB_CACHE_LINE_BYTES);
350 h0 = (ip6_vxlan_gpe_header_t *) rw;
352 /* Fixed portion of the (outer) ip4 header */
354 ip0->ip_version_traffic_class_and_flow_label =
355 clib_host_to_net_u32 (6 << 28);
356 ip0->hop_limit = 255;
357 ip0->protocol = IP_PROTOCOL_UDP;
359 ip0->src_address.as_u64[0] = t->local.ip6.as_u64[0];
360 ip0->src_address.as_u64[1] = t->local.ip6.as_u64[1];
361 ip0->dst_address.as_u64[0] = t->remote.ip6.as_u64[0];
362 ip0->dst_address.as_u64[1] = t->remote.ip6.as_u64[1];
364 /* UDP header, randomize src port on something, maybe? */
365 h0->udp.src_port = clib_host_to_net_u16 (4790);
366 h0->udp.dst_port = clib_host_to_net_u16 (UDP_DST_PORT_VXLAN_GPE);
368 /* VXLAN header. Are we having fun yet? */
369 h0->vxlan.flags = VXLAN_GPE_FLAGS_I | VXLAN_GPE_FLAGS_P;
370 h0->vxlan.ver_res = VXLAN_GPE_VERSION;
371 if (protocol_override)
373 h0->vxlan.protocol = t->protocol;
377 h0->vxlan.protocol = protocol_override;
379 t->rewrite_size = sizeof (ip4_vxlan_gpe_header_t) + extension_size;
380 h0->vxlan.vni_res = clib_host_to_net_u32 (t->vni << 8);
383 t->encap_next_node = encap_next_node;
388 typedef CLIB_PACKED(union {
390 fib_node_index_t mfib_entry_index;
391 adj_index_t mcast_adj_index;
397 static inline mcast_shared_t
398 mcast_shared_get (ip46_address_t * ip)
400 ASSERT (ip46_address_is_multicast (ip));
401 uword *p = hash_get_mem (vxlan_gpe_main.mcast_shared, ip);
403 return (mcast_shared_t)
409 mcast_shared_add (ip46_address_t * remote,
410 fib_node_index_t mfei, adj_index_t ai)
412 mcast_shared_t new_ep = {
413 .mcast_adj_index = ai,
414 .mfib_entry_index = mfei,
417 hash_set_mem_alloc (&vxlan_gpe_main.mcast_shared, remote, new_ep.as_u64);
421 mcast_shared_remove (ip46_address_t * remote)
423 mcast_shared_t ep = mcast_shared_get (remote);
425 adj_unlock (ep.mcast_adj_index);
426 mfib_table_entry_delete_index (ep.mfib_entry_index, MFIB_SOURCE_VXLAN_GPE);
428 hash_unset_mem_free (&vxlan_gpe_main.mcast_shared, remote);
432 * @brief Add or Del a VXLAN GPE tunnel
435 * @param *sw_if_index
440 int vnet_vxlan_gpe_add_del_tunnel
441 (vnet_vxlan_gpe_add_del_tunnel_args_t * a, u32 * sw_if_indexp)
443 vxlan_gpe_main_t *ngm = &vxlan_gpe_main;
444 vxlan_gpe_tunnel_t *t = 0;
445 vnet_main_t *vnm = ngm->vnet_main;
446 vnet_hw_interface_t *hi;
448 u32 hw_if_index = ~0;
449 u32 sw_if_index = ~0;
451 vxlan4_gpe_tunnel_key_t key4, *key4_copy;
452 vxlan6_gpe_tunnel_key_t key6, *key6_copy;
453 u32 is_ip6 = a->is_ip6;
457 key4.local = a->local.ip4.as_u32;
458 key4.remote = a->remote.ip4.as_u32;
459 key4.vni = clib_host_to_net_u32 (a->vni << 8);
462 p = hash_get_mem (ngm->vxlan4_gpe_tunnel_by_key, &key4);
466 key6.local.as_u64[0] = a->local.ip6.as_u64[0];
467 key6.local.as_u64[1] = a->local.ip6.as_u64[1];
468 key6.remote.as_u64[0] = a->remote.ip6.as_u64[0];
469 key6.remote.as_u64[1] = a->remote.ip6.as_u64[1];
470 key6.vni = clib_host_to_net_u32 (a->vni << 8);
472 p = hash_get_mem (ngm->vxlan6_gpe_tunnel_by_key, &key6);
477 l2input_main_t *l2im = &l2input_main;
479 /* adding a tunnel: tunnel must not already exist */
481 return VNET_API_ERROR_TUNNEL_EXIST;
483 pool_get_aligned (ngm->tunnels, t, CLIB_CACHE_LINE_BYTES);
484 clib_memset (t, 0, sizeof (*t));
486 /* copy from arg structure */
488 #define _(x) t->x = a->x;
489 foreach_gpe_copy_field;
498 t->flags |= VXLAN_GPE_TUNNEL_IS_IPV4;
502 rv = vxlan4_gpe_rewrite (t, 0, 0, VXLAN_GPE_ENCAP_NEXT_IP4_LOOKUP);
506 rv = vxlan6_gpe_rewrite (t, 0, 0, VXLAN_GPE_ENCAP_NEXT_IP6_LOOKUP);
511 pool_put (ngm->tunnels, t);
517 key4_copy = clib_mem_alloc (sizeof (*key4_copy));
518 clib_memcpy_fast (key4_copy, &key4, sizeof (*key4_copy));
519 hash_set_mem (ngm->vxlan4_gpe_tunnel_by_key, key4_copy,
524 key6_copy = clib_mem_alloc (sizeof (*key6_copy));
525 clib_memcpy_fast (key6_copy, &key6, sizeof (*key6_copy));
526 hash_set_mem (ngm->vxlan6_gpe_tunnel_by_key, key6_copy,
530 if (vec_len (ngm->free_vxlan_gpe_tunnel_hw_if_indices) > 0)
532 vnet_interface_main_t *im = &vnm->interface_main;
533 hw_if_index = ngm->free_vxlan_gpe_tunnel_hw_if_indices
534 [vec_len (ngm->free_vxlan_gpe_tunnel_hw_if_indices) - 1];
535 _vec_len (ngm->free_vxlan_gpe_tunnel_hw_if_indices) -= 1;
537 hi = vnet_get_hw_interface (vnm, hw_if_index);
538 hi->dev_instance = t - ngm->tunnels;
539 hi->hw_instance = hi->dev_instance;
540 /* clear old stats of freed tunnel before reuse */
541 sw_if_index = hi->sw_if_index;
542 vnet_interface_counter_lock (im);
543 vlib_zero_combined_counter
544 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX],
546 vlib_zero_combined_counter (&im->combined_sw_if_counters
547 [VNET_INTERFACE_COUNTER_RX],
549 vlib_zero_simple_counter (&im->sw_if_counters
550 [VNET_INTERFACE_COUNTER_DROP],
552 vnet_interface_counter_unlock (im);
556 hw_if_index = vnet_register_interface
557 (vnm, vxlan_gpe_device_class.index, t - ngm->tunnels,
558 vxlan_gpe_hw_class.index, t - ngm->tunnels);
559 hi = vnet_get_hw_interface (vnm, hw_if_index);
562 /* Set vxlan-gpe tunnel output node */
563 u32 encap_index = vxlan_gpe_encap_node.index;
564 vnet_set_interface_output_node (vnm, hw_if_index, encap_index);
566 t->hw_if_index = hw_if_index;
567 t->sw_if_index = sw_if_index = hi->sw_if_index;
568 vec_validate_init_empty (ngm->tunnel_index_by_sw_if_index, sw_if_index,
570 ngm->tunnel_index_by_sw_if_index[sw_if_index] = t - ngm->tunnels;
572 /* setup l2 input config with l2 feature and bd 0 to drop packet */
573 vec_validate (l2im->configs, sw_if_index);
574 l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
575 l2im->configs[sw_if_index].bd_index = 0;
577 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
578 si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
579 vnet_sw_interface_set_flags (vnm, hi->sw_if_index,
580 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
581 fib_node_init (&t->node, FIB_NODE_TYPE_VXLAN_GPE_TUNNEL);
582 fib_prefix_t tun_remote_pfx;
583 vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
585 fib_prefix_from_ip46_addr (&t->remote, &tun_remote_pfx);
586 if (!ip46_address_is_multicast (&t->remote))
589 * source the FIB entry for the tunnel's destination
590 * and become a child thereof. The tunnel will then get poked
591 * when the forwarding for the entry updates, and the tunnel can
592 * re-stack accordingly
594 vtep_addr_ref (&ngm->vtep_table, t->encap_fib_index, &t->local);
595 t->fib_entry_index = fib_entry_track (t->encap_fib_index,
597 FIB_NODE_TYPE_VXLAN_GPE_TUNNEL,
600 vxlan_gpe_tunnel_restack_dpo (t);
604 /* Multicast tunnel -
605 * as the same mcast group can be used for multiple mcast tunnels
606 * with different VNIs, create the output fib adjacency only if
607 * it does not already exist
609 fib_protocol_t fp = fib_ip_proto (is_ip6);
611 if (vtep_addr_ref (&ngm->vtep_table,
612 t->encap_fib_index, &t->remote) == 1)
614 fib_node_index_t mfei;
616 fib_route_path_t path = {
617 .frp_proto = fib_proto_to_dpo (fp),
618 .frp_addr = zero_addr,
619 .frp_sw_if_index = 0xffffffff,
622 .frp_flags = FIB_ROUTE_PATH_LOCAL,
623 .frp_mitf_flags = MFIB_ITF_FLAG_FORWARD,
625 const mfib_prefix_t mpfx = {
627 .fp_len = (is_ip6 ? 128 : 32),
628 .fp_grp_addr = tun_remote_pfx.fp_addr,
632 * Setup the (*,G) to receive traffic on the mcast group
633 * - the forwarding interface is for-us
634 * - the accepting interface is that from the API
636 mfib_table_entry_path_update (t->encap_fib_index,
638 MFIB_SOURCE_VXLAN_GPE, &path);
640 path.frp_sw_if_index = a->mcast_sw_if_index;
641 path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
642 path.frp_mitf_flags = MFIB_ITF_FLAG_ACCEPT;
643 mfei = mfib_table_entry_path_update (t->encap_fib_index,
645 MFIB_SOURCE_VXLAN_GPE,
649 * Create the mcast adjacency to send traffic to the group
651 ai = adj_mcast_add_or_lock (fp,
652 fib_proto_to_link (fp),
653 a->mcast_sw_if_index);
656 * create a new end-point
658 mcast_shared_add (&t->remote, mfei, ai);
661 dpo_id_t dpo = DPO_INVALID;
662 mcast_shared_t ep = mcast_shared_get (&t->remote);
664 /* Stack shared mcast remote mac addr rewrite on encap */
665 dpo_set (&dpo, DPO_ADJACENCY_MCAST,
666 fib_proto_to_dpo (fp), ep.mcast_adj_index);
668 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
670 flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
673 vnet_get_sw_interface (vnet_get_main (), sw_if_index)->flood_class =
678 /* deleting a tunnel: tunnel must exist */
680 return VNET_API_ERROR_NO_SUCH_ENTRY;
682 t = pool_elt_at_index (ngm->tunnels, p[0]);
684 sw_if_index = t->sw_if_index;
685 vnet_sw_interface_set_flags (vnm, t->sw_if_index, 0 /* down */ );
686 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, t->sw_if_index);
687 si->flags |= VNET_SW_INTERFACE_FLAG_HIDDEN;
688 set_int_l2_mode (ngm->vlib_main, vnm, MODE_L3, t->sw_if_index, 0,
689 L2_BD_PORT_TYPE_NORMAL, 0, 0);
690 vec_add1 (ngm->free_vxlan_gpe_tunnel_hw_if_indices, t->hw_if_index);
692 ngm->tunnel_index_by_sw_if_index[t->sw_if_index] = ~0;
695 hash_unset (ngm->vxlan4_gpe_tunnel_by_key, key4.as_u64);
697 hash_unset_mem_free (&ngm->vxlan6_gpe_tunnel_by_key, &key6);
699 if (!ip46_address_is_multicast (&t->remote))
701 vtep_addr_unref (&ngm->vtep_table, t->encap_fib_index, &t->local);
702 fib_entry_untrack (t->fib_entry_index, t->sibling_index);
704 else if (vtep_addr_unref (&ngm->vtep_table,
705 t->encap_fib_index, &t->remote) == 0)
707 mcast_shared_remove (&t->remote);
710 fib_node_deinit (&t->node);
711 vec_free (t->rewrite);
712 pool_put (ngm->tunnels, t);
716 *sw_if_indexp = sw_if_index;
720 /* register udp ports */
721 if (!is_ip6 && !udp_is_valid_dst_port (UDP_DST_PORT_VXLAN_GPE, 1))
722 udp_register_dst_port (ngm->vlib_main, UDP_DST_PORT_VXLAN_GPE,
723 vxlan4_gpe_input_node.index, 1 /* is_ip4 */ );
724 if (is_ip6 && !udp_is_valid_dst_port (UDP_DST_PORT_VXLAN6_GPE, 0))
725 udp_register_dst_port (ngm->vlib_main, UDP_DST_PORT_VXLAN6_GPE,
726 vxlan6_gpe_input_node.index, 0 /* is_ip4 */ );
732 static clib_error_t *
733 vxlan_gpe_add_del_tunnel_command_fn (vlib_main_t * vm,
734 unformat_input_t * input,
735 vlib_cli_command_t * cmd)
737 unformat_input_t _line_input, *line_input = &_line_input;
739 ip46_address_t local, remote;
745 u32 mcast_sw_if_index = ~0;
746 u32 encap_fib_index = 0;
747 u32 decap_fib_index = 0;
748 u8 protocol = VXLAN_GPE_PROTOCOL_IP4;
753 vnet_vxlan_gpe_add_del_tunnel_args_t _a, *a = &_a;
755 clib_error_t *error = NULL;
757 /* Get a line of input. */
758 if (!unformat_user (input, unformat_line_input, line_input))
761 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
763 if (unformat (line_input, "del"))
765 else if (unformat (line_input, "local %U",
766 unformat_ip4_address, &local.ip4))
771 else if (unformat (line_input, "remote %U",
772 unformat_ip4_address, &remote.ip4))
777 else if (unformat (line_input, "local %U",
778 unformat_ip6_address, &local.ip6))
783 else if (unformat (line_input, "remote %U",
784 unformat_ip6_address, &remote.ip6))
789 else if (unformat (line_input, "group %U %U",
790 unformat_ip4_address, &remote.ip4,
791 unformat_vnet_sw_interface,
792 vnet_get_main (), &mcast_sw_if_index))
794 grp_set = remote_set = 1;
797 else if (unformat (line_input, "group %U %U",
798 unformat_ip6_address, &remote.ip6,
799 unformat_vnet_sw_interface,
800 vnet_get_main (), &mcast_sw_if_index))
802 grp_set = remote_set = 1;
805 else if (unformat (line_input, "encap-vrf-id %d", &tmp))
808 encap_fib_index = fib_table_find (FIB_PROTOCOL_IP6, tmp);
810 encap_fib_index = fib_table_find (FIB_PROTOCOL_IP4, tmp);
812 if (encap_fib_index == ~0)
815 clib_error_return (0, "nonexistent encap fib id %d", tmp);
819 else if (unformat (line_input, "decap-vrf-id %d", &tmp))
822 decap_fib_index = fib_table_find (FIB_PROTOCOL_IP6, tmp);
824 decap_fib_index = fib_table_find (FIB_PROTOCOL_IP4, tmp);
826 if (decap_fib_index == ~0)
829 clib_error_return (0, "nonexistent decap fib id %d", tmp);
833 else if (unformat (line_input, "vni %d", &vni))
835 else if (unformat (line_input, "next-ip4"))
836 protocol = VXLAN_GPE_PROTOCOL_IP4;
837 else if (unformat (line_input, "next-ip6"))
838 protocol = VXLAN_GPE_PROTOCOL_IP6;
839 else if (unformat (line_input, "next-ethernet"))
840 protocol = VXLAN_GPE_PROTOCOL_ETHERNET;
841 else if (unformat (line_input, "next-nsh"))
842 protocol = VXLAN_GPE_PROTOCOL_NSH;
845 error = clib_error_return (0, "parse error: '%U'",
846 format_unformat_error, line_input);
853 error = clib_error_return (0, "tunnel local address not specified");
859 error = clib_error_return (0, "tunnel remote address not specified");
863 if (grp_set && !ip46_address_is_multicast (&remote))
865 error = clib_error_return (0, "tunnel group address not multicast");
869 if (grp_set == 0 && ip46_address_is_multicast (&remote))
871 error = clib_error_return (0, "remote address must be unicast");
875 if (grp_set && mcast_sw_if_index == ~0)
877 error = clib_error_return (0, "tunnel nonexistent multicast device");
880 if (ipv4_set && ipv6_set)
882 error = clib_error_return (0, "both IPv4 and IPv6 addresses specified");
886 if ((ipv4_set && memcmp (&local.ip4, &remote.ip4, sizeof (local.ip4)) == 0)
888 && memcmp (&local.ip6, &remote.ip6, sizeof (local.ip6)) == 0))
890 error = clib_error_return (0, "src and remote addresses are identical");
896 error = clib_error_return (0, "vni not specified");
900 clib_memset (a, 0, sizeof (*a));
903 a->is_ip6 = ipv6_set;
906 #define _(x) a->x = x;
907 foreach_gpe_copy_field;
915 rv = vnet_vxlan_gpe_add_del_tunnel (a, &sw_if_index);
920 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
921 vnet_get_main (), sw_if_index);
923 case VNET_API_ERROR_INVALID_DECAP_NEXT:
924 error = clib_error_return (0, "invalid decap-next...");
927 case VNET_API_ERROR_TUNNEL_EXIST:
928 error = clib_error_return (0, "tunnel already exists...");
931 case VNET_API_ERROR_NO_SUCH_ENTRY:
932 error = clib_error_return (0, "tunnel does not exist...");
936 error = clib_error_return
937 (0, "vnet_vxlan_gpe_add_del_tunnel returned %d", rv);
942 unformat_free (line_input);
948 * Add or delete a VXLAN-GPE Tunnel.
950 * VXLAN-GPE provides the features needed to allow L2 bridge domains (BDs)
951 * to span multiple servers. This is done by building an L2 overlay on
952 * top of an L3 network underlay using VXLAN-GPE tunnels.
954 * This makes it possible for servers to be co-located in the same data
955 * center or be separated geographically as long as they are reachable
956 * through the underlay L3 network.
958 * You can refer to this kind of L2 overlay bridge domain as a VXLAN-GPE segment.
961 * Example of how to create a VXLAN-GPE Tunnel:
962 * @cliexcmd{create vxlan-gpe tunnel local 10.0.3.1 remote 10.0.3.3 vni 13 encap-vrf-id 7}
963 * Example of how to delete a VXLAN-GPE Tunnel:
964 * @cliexcmd{create vxlan-gpe tunnel local 10.0.3.1 remote 10.0.3.3 vni 13 del}
967 VLIB_CLI_COMMAND (create_vxlan_gpe_tunnel_command, static) = {
968 .path = "create vxlan-gpe tunnel",
970 "create vxlan-gpe tunnel local <local-addr> "
971 " {remote <remote-addr>|group <mcast-addr> <intf-name>}"
972 " vni <nn> [next-ip4][next-ip6][next-ethernet][next-nsh]"
973 " [encap-vrf-id <nn>] [decap-vrf-id <nn>] [del]\n",
974 .function = vxlan_gpe_add_del_tunnel_command_fn,
979 * @brief CLI function for showing VXLAN GPE tunnels
988 static clib_error_t *
989 show_vxlan_gpe_tunnel_command_fn (vlib_main_t * vm,
990 unformat_input_t * input,
991 vlib_cli_command_t * cmd)
993 vxlan_gpe_main_t *ngm = &vxlan_gpe_main;
994 vxlan_gpe_tunnel_t *t;
996 if (pool_elts (ngm->tunnels) == 0)
997 vlib_cli_output (vm, "No vxlan-gpe tunnels configured.");
1000 pool_foreach (t, ngm->tunnels,
1002 vlib_cli_output (vm, "%U", format_vxlan_gpe_tunnel, t);
1010 * Display all the VXLAN-GPE Tunnel entries.
1013 * Example of how to display the VXLAN-GPE Tunnel entries:
1014 * @cliexstart{show vxlan-gpe tunnel}
1015 * [0] local 10.0.3.1 remote 10.0.3.3 vni 13 encap_fib_index 0 sw_if_index 5 decap_next l2
1019 VLIB_CLI_COMMAND (show_vxlan_gpe_tunnel_command, static) = {
1020 .path = "show vxlan-gpe",
1021 .function = show_vxlan_gpe_tunnel_command_fn,
1026 vnet_int_vxlan_gpe_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable)
1029 vnet_feature_enable_disable ("ip6-unicast", "ip6-vxlan-gpe-bypass",
1030 sw_if_index, is_enable, 0, 0);
1032 vnet_feature_enable_disable ("ip4-unicast", "ip4-vxlan-gpe-bypass",
1033 sw_if_index, is_enable, 0, 0);
1037 static clib_error_t *
1038 set_ip_vxlan_gpe_bypass (u32 is_ip6,
1039 unformat_input_t * input, vlib_cli_command_t * cmd)
1041 unformat_input_t _line_input, *line_input = &_line_input;
1042 vnet_main_t *vnm = vnet_get_main ();
1043 clib_error_t *error = 0;
1044 u32 sw_if_index, is_enable;
1049 if (!unformat_user (input, unformat_line_input, line_input))
1052 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1055 (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
1057 else if (unformat (line_input, "del"))
1061 error = unformat_parse_error (line_input);
1066 if (~0 == sw_if_index)
1068 error = clib_error_return (0, "unknown interface `%U'",
1069 format_unformat_error, line_input);
1073 vnet_int_vxlan_gpe_bypass_mode (sw_if_index, is_ip6, is_enable);
1076 unformat_free (line_input);
1081 static clib_error_t *
1082 set_ip4_vxlan_gpe_bypass (vlib_main_t * vm,
1083 unformat_input_t * input, vlib_cli_command_t * cmd)
1085 return set_ip_vxlan_gpe_bypass (0, input, cmd);
1089 * This command adds the 'ip4-vxlan-gpe-bypass' graph node for a given interface.
1090 * By adding the IPv4 vxlan-gpe-bypass graph node to an interface, the node checks
1091 * for and validate input vxlan_gpe packet and bypass ip4-lookup, ip4-local,
1092 * ip4-udp-lookup nodes to speedup vxlan_gpe packet forwarding. This node will
1093 * cause extra overhead to for non-vxlan_gpe packets which is kept at a minimum.
1097 * Example of graph node before ip4-vxlan-gpe-bypass is enabled:
1098 * @cliexstart{show vlib graph ip4-vxlan-gpe-bypass}
1099 * Name Next Previous
1100 * ip4-vxlan-gpe-bypass error-drop [0]
1101 * vxlan4-gpe-input [1]
1105 * Example of how to enable ip4-vxlan-gpe-bypass on an interface:
1106 * @cliexcmd{set interface ip vxlan-gpe-bypass GigabitEthernet2/0/0}
1108 * Example of graph node after ip4-vxlan-gpe-bypass is enabled:
1109 * @cliexstart{show vlib graph ip4-vxlan-gpe-bypass}
1110 * Name Next Previous
1111 * ip4-vxlan-gpe-bypass error-drop [0] ip4-input
1112 * vxlan4-gpe-input [1] ip4-input-no-checksum
1116 * Example of how to display the feature enabled on an interface:
1117 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1118 * IP feature paths configured on GigabitEthernet2/0/0...
1121 * ip4-vxlan-gpe-bypass
1126 * Example of how to disable ip4-vxlan-gpe-bypass on an interface:
1127 * @cliexcmd{set interface ip vxlan-gpe-bypass GigabitEthernet2/0/0 del}
1131 VLIB_CLI_COMMAND (set_interface_ip_vxlan_gpe_bypass_command, static) = {
1132 .path = "set interface ip vxlan-gpe-bypass",
1133 .function = set_ip4_vxlan_gpe_bypass,
1134 .short_help = "set interface ip vxlan-gpe-bypass <interface> [del]",
1138 static clib_error_t *
1139 set_ip6_vxlan_gpe_bypass (vlib_main_t * vm,
1140 unformat_input_t * input, vlib_cli_command_t * cmd)
1142 return set_ip_vxlan_gpe_bypass (1, input, cmd);
1146 * This command adds the 'ip6-vxlan-gpe-bypass' graph node for a given interface.
1147 * By adding the IPv6 vxlan-gpe-bypass graph node to an interface, the node checks
1148 * for and validate input vxlan_gpe packet and bypass ip6-lookup, ip6-local,
1149 * ip6-udp-lookup nodes to speedup vxlan_gpe packet forwarding. This node will
1150 * cause extra overhead to for non-vxlan_gpe packets which is kept at a minimum.
1154 * Example of graph node before ip6-vxlan-gpe-bypass is enabled:
1155 * @cliexstart{show vlib graph ip6-vxlan-gpe-bypass}
1156 * Name Next Previous
1157 * ip6-vxlan-gpe-bypass error-drop [0]
1158 * vxlan6-gpe-input [1]
1162 * Example of how to enable ip6-vxlan-gpe-bypass on an interface:
1163 * @cliexcmd{set interface ip6 vxlan-gpe-bypass GigabitEthernet2/0/0}
1165 * Example of graph node after ip6-vxlan-gpe-bypass is enabled:
1166 * @cliexstart{show vlib graph ip6-vxlan-gpe-bypass}
1167 * Name Next Previous
1168 * ip6-vxlan-gpe-bypass error-drop [0] ip6-input
1169 * vxlan6-gpe-input [1] ip4-input-no-checksum
1173 * Example of how to display the feature enabled on an interface:
1174 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1175 * IP feature paths configured on GigabitEthernet2/0/0...
1178 * ip6-vxlan-gpe-bypass
1183 * Example of how to disable ip6-vxlan-gpe-bypass on an interface:
1184 * @cliexcmd{set interface ip6 vxlan-gpe-bypass GigabitEthernet2/0/0 del}
1188 VLIB_CLI_COMMAND (set_interface_ip6_vxlan_gpe_bypass_command, static) = {
1189 .path = "set interface ip6 vxlan-gpe-bypass",
1190 .function = set_ip6_vxlan_gpe_bypass,
1191 .short_help = "set interface ip6 vxlan-gpe-bypass <interface> [del]",
1196 VNET_FEATURE_INIT (ip4_vxlan_gpe_bypass, static) =
1198 .arc_name = "ip4-unicast",
1199 .node_name = "ip4-vxlan-gpe-bypass",
1200 .runs_before = VNET_FEATURES ("ip4-lookup"),
1203 VNET_FEATURE_INIT (ip6_vxlan_gpe_bypass, static) =
1205 .arc_name = "ip6-unicast",
1206 .node_name = "ip6-vxlan-gpe-bypass",
1207 .runs_before = VNET_FEATURES ("ip6-lookup"),
1212 * @brief Feature init function for VXLAN GPE
1220 vxlan_gpe_init (vlib_main_t * vm)
1222 vxlan_gpe_main_t *ngm = &vxlan_gpe_main;
1224 ngm->vnet_main = vnet_get_main ();
1225 ngm->vlib_main = vm;
1227 ngm->vxlan4_gpe_tunnel_by_key
1228 = hash_create_mem (0, sizeof (vxlan4_gpe_tunnel_key_t), sizeof (uword));
1230 ngm->vxlan6_gpe_tunnel_by_key
1231 = hash_create_mem (0, sizeof (vxlan6_gpe_tunnel_key_t), sizeof (uword));
1234 ngm->mcast_shared = hash_create_mem (0,
1235 sizeof (ip46_address_t),
1236 sizeof (mcast_shared_t));
1237 ngm->vtep_table = vtep_table_create ();
1239 /* Register the list of standard decap protocols supported */
1240 vxlan_gpe_register_decap_protocol (VXLAN_GPE_PROTOCOL_IP4,
1241 VXLAN_GPE_INPUT_NEXT_IP4_INPUT);
1242 vxlan_gpe_register_decap_protocol (VXLAN_GPE_PROTOCOL_IP6,
1243 VXLAN_GPE_INPUT_NEXT_IP6_INPUT);
1244 vxlan_gpe_register_decap_protocol (VXLAN_GPE_PROTOCOL_ETHERNET,
1245 VXLAN_GPE_INPUT_NEXT_L2_INPUT);
1247 fib_node_register_type (FIB_NODE_TYPE_VXLAN_GPE_TUNNEL, &vxlan_gpe_vft);
1252 VLIB_INIT_FUNCTION (vxlan_gpe_init);
1256 * fd.io coding-style-patch-verification: ON
1259 * eval: (c-set-style "gnu")