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);
147 VNET_DEVICE_CLASS (vxlan_gpe_device_class,static) = {
149 .format_device_name = format_vxlan_gpe_name,
150 .format_tx_trace = format_vxlan_gpe_encap_trace,
151 .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);
172 VNET_HW_INTERFACE_CLASS (vxlan_gpe_hw_class) = {
174 .format_header = format_vxlan_gpe_header_with_length,
175 .build_rewrite = default_build_rewrite,
179 vxlan_gpe_tunnel_restack_dpo (vxlan_gpe_tunnel_t * t)
181 dpo_id_t dpo = DPO_INVALID;
182 u32 encap_index = vxlan_gpe_encap_node.index;
183 fib_forward_chain_type_t forw_type = ip46_address_is_ip4 (&t->remote) ?
184 FIB_FORW_CHAIN_TYPE_UNICAST_IP4 : FIB_FORW_CHAIN_TYPE_UNICAST_IP6;
186 fib_entry_contribute_forwarding (t->fib_entry_index, forw_type, &dpo);
187 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
191 static vxlan_gpe_tunnel_t *
192 vxlan_gpe_tunnel_from_fib_node (fib_node_t * node)
194 ASSERT (FIB_NODE_TYPE_VXLAN_GPE_TUNNEL == node->fn_type);
195 return ((vxlan_gpe_tunnel_t *) (((char *) node) -
196 STRUCT_OFFSET_OF (vxlan_gpe_tunnel_t,
201 * Function definition to backwalk a FIB node -
202 * Here we will restack the new dpo of VXLAN_GPE DIP to encap node.
204 static fib_node_back_walk_rc_t
205 vxlan_gpe_tunnel_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
207 vxlan_gpe_tunnel_restack_dpo (vxlan_gpe_tunnel_from_fib_node (node));
208 return (FIB_NODE_BACK_WALK_CONTINUE);
212 * Function definition to get a FIB node from its index
215 vxlan_gpe_tunnel_fib_node_get (fib_node_index_t index)
217 vxlan_gpe_tunnel_t *t;
218 vxlan_gpe_main_t *ngm = &vxlan_gpe_main;
220 t = pool_elt_at_index (ngm->tunnels, index);
226 * Function definition to inform the FIB node that its last lock has gone.
229 vxlan_gpe_tunnel_last_lock_gone (fib_node_t * node)
232 * The VXLAN_GPE tunnel is a root of the graph. As such
233 * it never has children and thus is never locked.
239 * Virtual function table registered by VXLAN_GPE tunnels
240 * for participation in the FIB object graph.
242 const static fib_node_vft_t vxlan_gpe_vft = {
243 .fnv_get = vxlan_gpe_tunnel_fib_node_get,
244 .fnv_last_lock = vxlan_gpe_tunnel_last_lock_gone,
245 .fnv_back_walk = vxlan_gpe_tunnel_back_walk,
248 #define foreach_gpe_copy_field \
251 _ (mcast_sw_if_index) \
252 _ (encap_fib_index) \
253 _ (decap_fib_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 (t->local_port);
307 h0->udp.dst_port = clib_host_to_net_u16 (t->remote_port);
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 (t->local_port);
366 h0->udp.dst_port = clib_host_to_net_u16 (t->remote_port);
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;
387 typedef CLIB_PACKED(union {
389 fib_node_index_t mfib_entry_index;
390 adj_index_t mcast_adj_index;
395 static inline mcast_shared_t
396 mcast_shared_get (ip46_address_t * ip)
398 ASSERT (ip46_address_is_multicast (ip));
399 uword *p = hash_get_mem (vxlan_gpe_main.mcast_shared, ip);
401 return (mcast_shared_t)
407 mcast_shared_add (ip46_address_t * remote,
408 fib_node_index_t mfei, adj_index_t ai)
410 mcast_shared_t new_ep = {
411 .mcast_adj_index = ai,
412 .mfib_entry_index = mfei,
415 hash_set_mem_alloc (&vxlan_gpe_main.mcast_shared, remote, new_ep.as_u64);
419 mcast_shared_remove (ip46_address_t * remote)
421 mcast_shared_t ep = mcast_shared_get (remote);
423 adj_unlock (ep.mcast_adj_index);
424 mfib_table_entry_delete_index (ep.mfib_entry_index, MFIB_SOURCE_VXLAN_GPE);
426 hash_unset_mem_free (&vxlan_gpe_main.mcast_shared, remote);
430 * @brief Add or Del a VXLAN GPE tunnel
433 * @param *sw_if_index
438 int vnet_vxlan_gpe_add_del_tunnel
439 (vnet_vxlan_gpe_add_del_tunnel_args_t * a, u32 * sw_if_indexp)
441 vxlan_gpe_main_t *ngm = &vxlan_gpe_main;
442 vxlan_gpe_tunnel_t *t = 0;
443 vnet_main_t *vnm = ngm->vnet_main;
444 vnet_hw_interface_t *hi;
446 u32 hw_if_index = ~0;
447 u32 sw_if_index = ~0;
449 vxlan4_gpe_tunnel_key_t key4, *key4_copy;
450 vxlan6_gpe_tunnel_key_t key6, *key6_copy;
451 u32 is_ip6 = a->is_ip6;
454 if (a->local_port == 0)
455 a->local_port = is_ip6 ? UDP_DST_PORT_VXLAN6_GPE : UDP_DST_PORT_VXLAN_GPE;
457 if (a->remote_port == 0)
458 a->remote_port = is_ip6 ? UDP_DST_PORT_VXLAN6_GPE : UDP_DST_PORT_VXLAN_GPE;
462 key4.local = a->local.ip4.as_u32;
463 key4.remote = a->remote.ip4.as_u32;
464 key4.vni = clib_host_to_net_u32 (a->vni << 8);
465 key4.port = (u32) clib_host_to_net_u16 (a->local_port);
467 p = hash_get_mem (ngm->vxlan4_gpe_tunnel_by_key, &key4);
471 key6.local.as_u64[0] = a->local.ip6.as_u64[0];
472 key6.local.as_u64[1] = a->local.ip6.as_u64[1];
473 key6.remote.as_u64[0] = a->remote.ip6.as_u64[0];
474 key6.remote.as_u64[1] = a->remote.ip6.as_u64[1];
475 key6.vni = clib_host_to_net_u32 (a->vni << 8);
476 key6.port = (u32) clib_host_to_net_u16 (a->local_port);
478 p = hash_get_mem (ngm->vxlan6_gpe_tunnel_by_key, &key6);
483 l2input_main_t *l2im = &l2input_main;
485 /* adding a tunnel: tunnel must not already exist */
487 return VNET_API_ERROR_TUNNEL_EXIST;
489 pool_get_aligned (ngm->tunnels, t, CLIB_CACHE_LINE_BYTES);
490 clib_memset (t, 0, sizeof (*t));
492 /* copy from arg structure */
493 #define _(x) t->x = a->x;
494 foreach_gpe_copy_field;
502 t->flags |= VXLAN_GPE_TUNNEL_IS_IPV4;
506 rv = vxlan4_gpe_rewrite (t, 0, 0, VXLAN_GPE_ENCAP_NEXT_IP4_LOOKUP);
510 rv = vxlan6_gpe_rewrite (t, 0, 0, VXLAN_GPE_ENCAP_NEXT_IP6_LOOKUP);
515 pool_put (ngm->tunnels, t);
521 key4_copy = clib_mem_alloc (sizeof (*key4_copy));
522 clib_memcpy_fast (key4_copy, &key4, sizeof (*key4_copy));
523 hash_set_mem (ngm->vxlan4_gpe_tunnel_by_key, key4_copy,
528 key6_copy = clib_mem_alloc (sizeof (*key6_copy));
529 clib_memcpy_fast (key6_copy, &key6, sizeof (*key6_copy));
530 hash_set_mem (ngm->vxlan6_gpe_tunnel_by_key, key6_copy,
534 if (vec_len (ngm->free_vxlan_gpe_tunnel_hw_if_indices) > 0)
536 vnet_interface_main_t *im = &vnm->interface_main;
537 hw_if_index = ngm->free_vxlan_gpe_tunnel_hw_if_indices
538 [vec_len (ngm->free_vxlan_gpe_tunnel_hw_if_indices) - 1];
539 vec_dec_len (ngm->free_vxlan_gpe_tunnel_hw_if_indices, 1);
541 hi = vnet_get_hw_interface (vnm, hw_if_index);
542 hi->dev_instance = t - ngm->tunnels;
543 hi->hw_instance = hi->dev_instance;
544 /* clear old stats of freed tunnel before reuse */
545 sw_if_index = hi->sw_if_index;
546 vnet_interface_counter_lock (im);
547 vlib_zero_combined_counter
548 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX],
550 vlib_zero_combined_counter (&im->combined_sw_if_counters
551 [VNET_INTERFACE_COUNTER_RX],
553 vlib_zero_simple_counter (&im->sw_if_counters
554 [VNET_INTERFACE_COUNTER_DROP],
556 vnet_interface_counter_unlock (im);
560 hw_if_index = vnet_register_interface
561 (vnm, vxlan_gpe_device_class.index, t - ngm->tunnels,
562 vxlan_gpe_hw_class.index, t - ngm->tunnels);
563 hi = vnet_get_hw_interface (vnm, hw_if_index);
566 /* Set vxlan-gpe tunnel output node */
567 u32 encap_index = vxlan_gpe_encap_node.index;
568 vnet_set_interface_output_node (vnm, hw_if_index, encap_index);
570 t->hw_if_index = hw_if_index;
571 t->sw_if_index = sw_if_index = hi->sw_if_index;
572 vec_validate_init_empty (ngm->tunnel_index_by_sw_if_index, sw_if_index,
574 ngm->tunnel_index_by_sw_if_index[sw_if_index] = t - ngm->tunnels;
576 /* setup l2 input config with l2 feature and bd 0 to drop packet */
577 vec_validate (l2im->configs, sw_if_index);
578 l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
579 l2im->configs[sw_if_index].bd_index = 0;
581 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
582 si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
583 vnet_sw_interface_set_flags (vnm, hi->sw_if_index,
584 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
585 fib_node_init (&t->node, FIB_NODE_TYPE_VXLAN_GPE_TUNNEL);
586 fib_prefix_t tun_remote_pfx;
587 vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
589 fib_protocol_t fp = fib_ip_proto (is_ip6);
590 fib_prefix_from_ip46_addr (fp, &t->remote, &tun_remote_pfx);
591 if (!ip46_address_is_multicast (&t->remote))
594 * source the FIB entry for the tunnel's destination
595 * and become a child thereof. The tunnel will then get poked
596 * when the forwarding for the entry updates, and the tunnel can
597 * re-stack accordingly
599 vtep_addr_ref (&ngm->vtep_table, t->encap_fib_index, &t->local);
600 t->fib_entry_index = fib_entry_track (t->encap_fib_index,
602 FIB_NODE_TYPE_VXLAN_GPE_TUNNEL,
605 vxlan_gpe_tunnel_restack_dpo (t);
609 /* Multicast tunnel -
610 * as the same mcast group can be used for multiple mcast tunnels
611 * with different VNIs, create the output fib adjacency only if
612 * it does not already exist
614 if (vtep_addr_ref (&ngm->vtep_table,
615 t->encap_fib_index, &t->remote) == 1)
617 fib_node_index_t mfei;
619 fib_route_path_t path = {
620 .frp_proto = fib_proto_to_dpo (fp),
621 .frp_addr = zero_addr,
622 .frp_sw_if_index = 0xffffffff,
625 .frp_flags = FIB_ROUTE_PATH_LOCAL,
626 .frp_mitf_flags = MFIB_ITF_FLAG_FORWARD,
628 const mfib_prefix_t mpfx = {
630 .fp_len = (is_ip6 ? 128 : 32),
631 .fp_grp_addr = tun_remote_pfx.fp_addr,
635 * Setup the (*,G) to receive traffic on the mcast group
636 * - the forwarding interface is for-us
637 * - the accepting interface is that from the API
639 mfib_table_entry_path_update (t->encap_fib_index, &mpfx,
640 MFIB_SOURCE_VXLAN_GPE,
641 MFIB_ENTRY_FLAG_NONE, &path);
643 path.frp_sw_if_index = a->mcast_sw_if_index;
644 path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
645 path.frp_mitf_flags = MFIB_ITF_FLAG_ACCEPT;
646 mfei = mfib_table_entry_path_update (
647 t->encap_fib_index, &mpfx, MFIB_SOURCE_VXLAN_GPE,
648 MFIB_ENTRY_FLAG_NONE, &path);
651 * Create the mcast adjacency to send traffic to the group
653 ai = adj_mcast_add_or_lock (fp,
654 fib_proto_to_link (fp),
655 a->mcast_sw_if_index);
658 * create a new end-point
660 mcast_shared_add (&t->remote, mfei, ai);
663 dpo_id_t dpo = DPO_INVALID;
664 mcast_shared_t ep = mcast_shared_get (&t->remote);
666 /* Stack shared mcast remote mac addr rewrite on encap */
667 dpo_set (&dpo, DPO_ADJACENCY_MCAST,
668 fib_proto_to_dpo (fp), ep.mcast_adj_index);
670 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
672 flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
675 vnet_get_sw_interface (vnet_get_main (), sw_if_index)->flood_class =
680 /* deleting a tunnel: tunnel must exist */
682 return VNET_API_ERROR_NO_SUCH_ENTRY;
684 t = pool_elt_at_index (ngm->tunnels, p[0]);
686 sw_if_index = t->sw_if_index;
687 vnet_sw_interface_set_flags (vnm, t->sw_if_index, 0 /* down */ );
688 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, t->sw_if_index);
689 si->flags |= VNET_SW_INTERFACE_FLAG_HIDDEN;
690 set_int_l2_mode (ngm->vlib_main, vnm, MODE_L3, t->sw_if_index, 0,
691 L2_BD_PORT_TYPE_NORMAL, 0, 0);
692 vec_add1 (ngm->free_vxlan_gpe_tunnel_hw_if_indices, t->hw_if_index);
694 ngm->tunnel_index_by_sw_if_index[t->sw_if_index] = ~0;
697 hash_unset (ngm->vxlan4_gpe_tunnel_by_key, key4.as_u64);
699 hash_unset_mem_free (&ngm->vxlan6_gpe_tunnel_by_key, &key6);
701 if (!ip46_address_is_multicast (&t->remote))
703 vtep_addr_unref (&ngm->vtep_table, t->encap_fib_index, &t->local);
704 fib_entry_untrack (t->fib_entry_index, t->sibling_index);
706 else if (vtep_addr_unref (&ngm->vtep_table,
707 t->encap_fib_index, &t->remote) == 0)
709 mcast_shared_remove (&t->remote);
712 fib_node_deinit (&t->node);
713 vec_free (t->rewrite);
714 pool_put (ngm->tunnels, t);
718 *sw_if_indexp = sw_if_index;
722 /* register udp ports */
723 if (!is_ip6 && !udp_is_valid_dst_port (a->local_port, 1))
724 udp_register_dst_port (ngm->vlib_main, a->local_port,
725 vxlan4_gpe_input_node.index, 1 /* is_ip4 */);
726 if (is_ip6 && !udp_is_valid_dst_port (a->remote_port, 0))
727 udp_register_dst_port (ngm->vlib_main, a->remote_port,
728 vxlan6_gpe_input_node.index, 0 /* is_ip4 */);
734 static clib_error_t *
735 vxlan_gpe_add_del_tunnel_command_fn (vlib_main_t * vm,
736 unformat_input_t * input,
737 vlib_cli_command_t * cmd)
739 unformat_input_t _line_input, *line_input = &_line_input;
741 ip46_address_t local, remote;
747 u32 mcast_sw_if_index = ~0;
748 u32 encap_fib_index = 0;
749 u32 decap_fib_index = 0;
750 u8 protocol = VXLAN_GPE_PROTOCOL_IP4;
757 vnet_vxlan_gpe_add_del_tunnel_args_t _a, *a = &_a;
759 clib_error_t *error = NULL;
761 /* Get a line of input. */
762 if (!unformat_user (input, unformat_line_input, line_input))
765 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
767 if (unformat (line_input, "del"))
769 else if (unformat (line_input, "local %U",
770 unformat_ip4_address, &local.ip4))
775 else if (unformat (line_input, "remote %U",
776 unformat_ip4_address, &remote.ip4))
781 else if (unformat (line_input, "local %U",
782 unformat_ip6_address, &local.ip6))
787 else if (unformat (line_input, "remote %U",
788 unformat_ip6_address, &remote.ip6))
793 else if (unformat (line_input, "group %U %U",
794 unformat_ip4_address, &remote.ip4,
795 unformat_vnet_sw_interface,
796 vnet_get_main (), &mcast_sw_if_index))
798 grp_set = remote_set = 1;
801 else if (unformat (line_input, "group %U %U",
802 unformat_ip6_address, &remote.ip6,
803 unformat_vnet_sw_interface,
804 vnet_get_main (), &mcast_sw_if_index))
806 grp_set = remote_set = 1;
809 else if (unformat (line_input, "encap-vrf-id %d", &tmp))
812 encap_fib_index = fib_table_find (FIB_PROTOCOL_IP6, tmp);
814 encap_fib_index = fib_table_find (FIB_PROTOCOL_IP4, tmp);
816 if (encap_fib_index == ~0)
819 clib_error_return (0, "nonexistent encap fib id %d", tmp);
823 else if (unformat (line_input, "decap-vrf-id %d", &tmp))
826 decap_fib_index = fib_table_find (FIB_PROTOCOL_IP6, tmp);
828 decap_fib_index = fib_table_find (FIB_PROTOCOL_IP4, tmp);
830 if (decap_fib_index == ~0)
833 clib_error_return (0, "nonexistent decap fib id %d", tmp);
837 else if (unformat (line_input, "vni %d", &vni))
839 else if (unformat (line_input, "local_port %d", &local_port))
841 else if (unformat (line_input, "remote_port %d", &remote_port))
843 else if (unformat (line_input, "next-ip4"))
844 protocol = VXLAN_GPE_PROTOCOL_IP4;
845 else if (unformat (line_input, "next-ip6"))
846 protocol = VXLAN_GPE_PROTOCOL_IP6;
847 else if (unformat (line_input, "next-ethernet"))
848 protocol = VXLAN_GPE_PROTOCOL_ETHERNET;
849 else if (unformat (line_input, "next-nsh"))
850 protocol = VXLAN_GPE_PROTOCOL_NSH;
853 error = clib_error_return (0, "parse error: '%U'",
854 format_unformat_error, line_input);
861 error = clib_error_return (0, "tunnel local address not specified");
867 error = clib_error_return (0, "tunnel remote address not specified");
871 if (grp_set && !ip46_address_is_multicast (&remote))
873 error = clib_error_return (0, "tunnel group address not multicast");
877 if (grp_set == 0 && ip46_address_is_multicast (&remote))
879 error = clib_error_return (0, "remote address must be unicast");
883 if (grp_set && mcast_sw_if_index == ~0)
885 error = clib_error_return (0, "tunnel nonexistent multicast device");
888 if (ipv4_set && ipv6_set)
890 error = clib_error_return (0, "both IPv4 and IPv6 addresses specified");
894 if ((ipv4_set && memcmp (&local.ip4, &remote.ip4, sizeof (local.ip4)) == 0)
896 && memcmp (&local.ip6, &remote.ip6, sizeof (local.ip6)) == 0))
898 error = clib_error_return (0, "src and remote addresses are identical");
904 error = clib_error_return (0, "vni not specified");
908 clib_memset (a, 0, sizeof (*a));
911 a->is_ip6 = ipv6_set;
913 #define _(x) a->x = x;
914 foreach_gpe_copy_field;
921 rv = vnet_vxlan_gpe_add_del_tunnel (a, &sw_if_index);
926 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
927 vnet_get_main (), sw_if_index);
929 case VNET_API_ERROR_INVALID_DECAP_NEXT:
930 error = clib_error_return (0, "invalid decap-next...");
933 case VNET_API_ERROR_TUNNEL_EXIST:
934 error = clib_error_return (0, "tunnel already exists...");
937 case VNET_API_ERROR_NO_SUCH_ENTRY:
938 error = clib_error_return (0, "tunnel does not exist...");
942 error = clib_error_return
943 (0, "vnet_vxlan_gpe_add_del_tunnel returned %d", rv);
948 unformat_free (line_input);
954 * Add or delete a VXLAN-GPE Tunnel.
956 * VXLAN-GPE provides the features needed to allow L2 bridge domains (BDs)
957 * to span multiple servers. This is done by building an L2 overlay on
958 * top of an L3 network underlay using VXLAN-GPE tunnels.
960 * This makes it possible for servers to be co-located in the same data
961 * center or be separated geographically as long as they are reachable
962 * through the underlay L3 network.
964 * You can refer to this kind of L2 overlay bridge domain as a VXLAN-GPE segment.
967 * Example of how to create a VXLAN-GPE Tunnel:
968 * @cliexcmd{create vxlan-gpe tunnel local 10.0.3.1 remote 10.0.3.3 vni 13 encap-vrf-id 7}
969 * Example of how to delete a VXLAN-GPE Tunnel:
970 * @cliexcmd{create vxlan-gpe tunnel local 10.0.3.1 remote 10.0.3.3 vni 13 del}
972 VLIB_CLI_COMMAND (create_vxlan_gpe_tunnel_command, static) = {
973 .path = "create vxlan-gpe tunnel",
975 "create vxlan-gpe tunnel local <local-addr> "
976 " {remote <remote-addr>|group <mcast-addr> <intf-name>}"
977 " vni <nn> [next-ip4][next-ip6][next-ethernet][next-nsh]"
978 " [encap-vrf-id <nn>] [decap-vrf-id <nn>] [del]\n",
979 .function = vxlan_gpe_add_del_tunnel_command_fn,
983 * @brief CLI function for showing VXLAN GPE tunnels
992 static clib_error_t *
993 show_vxlan_gpe_tunnel_command_fn (vlib_main_t * vm,
994 unformat_input_t * input,
995 vlib_cli_command_t * cmd)
997 vxlan_gpe_main_t *ngm = &vxlan_gpe_main;
998 vxlan_gpe_tunnel_t *t;
1000 if (pool_elts (ngm->tunnels) == 0)
1001 vlib_cli_output (vm, "No vxlan-gpe tunnels configured.");
1003 pool_foreach (t, ngm->tunnels)
1005 vlib_cli_output (vm, "%U", format_vxlan_gpe_tunnel, t);
1012 * Display all the VXLAN-GPE Tunnel entries.
1015 * Example of how to display the VXLAN-GPE Tunnel entries:
1016 * @cliexstart{show vxlan-gpe tunnel}
1017 * [0] local 10.0.3.1 remote 10.0.3.3 vni 13 encap_fib_index 0 sw_if_index 5 decap_next l2
1020 VLIB_CLI_COMMAND (show_vxlan_gpe_tunnel_command, static) = {
1021 .path = "show vxlan-gpe",
1022 .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
1090 * interface. By adding the IPv4 vxlan-gpe-bypass graph node to an interface,
1091 * the node checks for and validate input vxlan_gpe packet and bypass
1092 * ip4-lookup, ip4-local, ip4-udp-lookup nodes to speedup vxlan_gpe packet
1093 * forwarding. This node will cause extra overhead to for non-vxlan_gpe
1094 * packets which is kept at a minimum.
1098 * Example of graph node before ip4-vxlan-gpe-bypass is enabled:
1099 * @cliexstart{show vlib graph ip4-vxlan-gpe-bypass}
1100 * Name Next Previous
1101 * ip4-vxlan-gpe-bypass error-drop [0]
1102 * vxlan4-gpe-input [1]
1106 * Example of how to enable ip4-vxlan-gpe-bypass on an interface:
1107 * @cliexcmd{set interface ip vxlan-gpe-bypass GigabitEthernet2/0/0}
1109 * Example of graph node after ip4-vxlan-gpe-bypass is enabled:
1110 * @cliexstart{show vlib graph ip4-vxlan-gpe-bypass}
1111 * Name Next Previous
1112 * ip4-vxlan-gpe-bypass error-drop [0] ip4-input
1113 * vxlan4-gpe-input [1] ip4-input-no-checksum
1117 * Example of how to display the feature enabled on an interface:
1118 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1119 * IP feature paths configured on GigabitEthernet2/0/0...
1122 * ip4-vxlan-gpe-bypass
1127 * Example of how to disable ip4-vxlan-gpe-bypass on an interface:
1128 * @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]",
1137 static clib_error_t *
1138 set_ip6_vxlan_gpe_bypass (vlib_main_t * vm,
1139 unformat_input_t * input, vlib_cli_command_t * cmd)
1141 return set_ip_vxlan_gpe_bypass (1, input, cmd);
1145 * This command adds the 'ip6-vxlan-gpe-bypass' graph node for a given
1146 * interface. By adding the IPv6 vxlan-gpe-bypass graph node to an interface,
1147 * the node checks for and validate input vxlan_gpe packet and bypass
1148 * ip6-lookup, ip6-local, ip6-udp-lookup nodes to speedup vxlan_gpe packet
1149 * forwarding. This node will cause extra overhead to for non-vxlan_gpe packets
1150 * 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}
1187 VLIB_CLI_COMMAND (set_interface_ip6_vxlan_gpe_bypass_command, static) = {
1188 .path = "set interface ip6 vxlan-gpe-bypass",
1189 .function = set_ip6_vxlan_gpe_bypass,
1190 .short_help = "set interface ip6 vxlan-gpe-bypass <interface> [del]",
1193 VNET_FEATURE_INIT (ip4_vxlan_gpe_bypass, static) =
1195 .arc_name = "ip4-unicast",
1196 .node_name = "ip4-vxlan-gpe-bypass",
1197 .runs_before = VNET_FEATURES ("ip4-lookup"),
1200 VNET_FEATURE_INIT (ip6_vxlan_gpe_bypass, static) =
1202 .arc_name = "ip6-unicast",
1203 .node_name = "ip6-vxlan-gpe-bypass",
1204 .runs_before = VNET_FEATURES ("ip6-lookup"),
1208 * @brief Feature init function for VXLAN GPE
1216 vxlan_gpe_init (vlib_main_t * vm)
1218 vxlan_gpe_main_t *ngm = &vxlan_gpe_main;
1220 ngm->vnet_main = vnet_get_main ();
1221 ngm->vlib_main = vm;
1223 ngm->vxlan4_gpe_tunnel_by_key
1224 = hash_create_mem (0, sizeof (vxlan4_gpe_tunnel_key_t), sizeof (uword));
1226 ngm->vxlan6_gpe_tunnel_by_key
1227 = hash_create_mem (0, sizeof (vxlan6_gpe_tunnel_key_t), sizeof (uword));
1230 ngm->mcast_shared = hash_create_mem (0,
1231 sizeof (ip46_address_t),
1232 sizeof (mcast_shared_t));
1233 ngm->vtep_table = vtep_table_create ();
1235 /* Register the list of standard decap protocols supported */
1236 vxlan_gpe_register_decap_protocol (VXLAN_GPE_PROTOCOL_IP4,
1237 VXLAN_GPE_INPUT_NEXT_IP4_INPUT);
1238 vxlan_gpe_register_decap_protocol (VXLAN_GPE_PROTOCOL_IP6,
1239 VXLAN_GPE_INPUT_NEXT_IP6_INPUT);
1240 vxlan_gpe_register_decap_protocol (VXLAN_GPE_PROTOCOL_ETHERNET,
1241 VXLAN_GPE_INPUT_NEXT_L2_INPUT);
1243 fib_node_register_type (FIB_NODE_TYPE_VXLAN_GPE_TUNNEL, &vxlan_gpe_vft);
1248 VLIB_INIT_FUNCTION (vxlan_gpe_init);
1252 * fd.io coding-style-patch-verification: ON
1255 * eval: (c-set-style "gnu")