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 vtep_addr_ref (ip46_address_t * ip)
390 uword *vtep = ip46_address_is_ip4 (ip) ?
391 hash_get (vxlan_gpe_main.vtep4, ip->ip4.as_u32) :
392 hash_get_mem (vxlan_gpe_main.vtep6, &ip->ip6);
395 ip46_address_is_ip4 (ip) ?
396 hash_set (vxlan_gpe_main.vtep4, ip->ip4.as_u32, 1) :
397 hash_set_mem_alloc (&vxlan_gpe_main.vtep6, &ip->ip6, 1);
402 vtep_addr_unref (ip46_address_t * ip)
404 uword *vtep = ip46_address_is_ip4 (ip) ?
405 hash_get (vxlan_gpe_main.vtep4, ip->ip4.as_u32) :
406 hash_get_mem (vxlan_gpe_main.vtep6, &ip->ip6);
407 ALWAYS_ASSERT (vtep);
410 ip46_address_is_ip4 (ip) ?
411 hash_unset (vxlan_gpe_main.vtep4, ip->ip4.as_u32) :
412 hash_unset_mem_free (&vxlan_gpe_main.vtep6, &ip->ip6);
417 typedef CLIB_PACKED(union {
419 fib_node_index_t mfib_entry_index;
420 adj_index_t mcast_adj_index;
426 static inline mcast_shared_t
427 mcast_shared_get (ip46_address_t * ip)
429 ASSERT (ip46_address_is_multicast (ip));
430 uword *p = hash_get_mem (vxlan_gpe_main.mcast_shared, ip);
432 return (mcast_shared_t)
438 mcast_shared_add (ip46_address_t * remote,
439 fib_node_index_t mfei, adj_index_t ai)
441 mcast_shared_t new_ep = {
442 .mcast_adj_index = ai,
443 .mfib_entry_index = mfei,
446 hash_set_mem_alloc (&vxlan_gpe_main.mcast_shared, remote, new_ep.as_u64);
450 mcast_shared_remove (ip46_address_t * remote)
452 mcast_shared_t ep = mcast_shared_get (remote);
454 adj_unlock (ep.mcast_adj_index);
455 mfib_table_entry_delete_index (ep.mfib_entry_index, MFIB_SOURCE_VXLAN_GPE);
457 hash_unset_mem_free (&vxlan_gpe_main.mcast_shared, remote);
461 * @brief Add or Del a VXLAN GPE tunnel
464 * @param *sw_if_index
469 int vnet_vxlan_gpe_add_del_tunnel
470 (vnet_vxlan_gpe_add_del_tunnel_args_t * a, u32 * sw_if_indexp)
472 vxlan_gpe_main_t *ngm = &vxlan_gpe_main;
473 vxlan_gpe_tunnel_t *t = 0;
474 vnet_main_t *vnm = ngm->vnet_main;
475 vnet_hw_interface_t *hi;
477 u32 hw_if_index = ~0;
478 u32 sw_if_index = ~0;
480 vxlan4_gpe_tunnel_key_t key4, *key4_copy;
481 vxlan6_gpe_tunnel_key_t key6, *key6_copy;
482 u32 is_ip6 = a->is_ip6;
486 key4.local = a->local.ip4.as_u32;
487 key4.remote = a->remote.ip4.as_u32;
488 key4.vni = clib_host_to_net_u32 (a->vni << 8);
491 p = hash_get_mem (ngm->vxlan4_gpe_tunnel_by_key, &key4);
495 key6.local.as_u64[0] = a->local.ip6.as_u64[0];
496 key6.local.as_u64[1] = a->local.ip6.as_u64[1];
497 key6.remote.as_u64[0] = a->remote.ip6.as_u64[0];
498 key6.remote.as_u64[1] = a->remote.ip6.as_u64[1];
499 key6.vni = clib_host_to_net_u32 (a->vni << 8);
501 p = hash_get_mem (ngm->vxlan6_gpe_tunnel_by_key, &key6);
506 l2input_main_t *l2im = &l2input_main;
508 /* adding a tunnel: tunnel must not already exist */
510 return VNET_API_ERROR_TUNNEL_EXIST;
512 pool_get_aligned (ngm->tunnels, t, CLIB_CACHE_LINE_BYTES);
513 clib_memset (t, 0, sizeof (*t));
515 /* copy from arg structure */
517 #define _(x) t->x = a->x;
518 foreach_gpe_copy_field;
527 t->flags |= VXLAN_GPE_TUNNEL_IS_IPV4;
531 rv = vxlan4_gpe_rewrite (t, 0, 0, VXLAN_GPE_ENCAP_NEXT_IP4_LOOKUP);
535 rv = vxlan6_gpe_rewrite (t, 0, 0, VXLAN_GPE_ENCAP_NEXT_IP6_LOOKUP);
540 pool_put (ngm->tunnels, t);
546 key4_copy = clib_mem_alloc (sizeof (*key4_copy));
547 clib_memcpy_fast (key4_copy, &key4, sizeof (*key4_copy));
548 hash_set_mem (ngm->vxlan4_gpe_tunnel_by_key, key4_copy,
553 key6_copy = clib_mem_alloc (sizeof (*key6_copy));
554 clib_memcpy_fast (key6_copy, &key6, sizeof (*key6_copy));
555 hash_set_mem (ngm->vxlan6_gpe_tunnel_by_key, key6_copy,
559 if (vec_len (ngm->free_vxlan_gpe_tunnel_hw_if_indices) > 0)
561 vnet_interface_main_t *im = &vnm->interface_main;
562 hw_if_index = ngm->free_vxlan_gpe_tunnel_hw_if_indices
563 [vec_len (ngm->free_vxlan_gpe_tunnel_hw_if_indices) - 1];
564 _vec_len (ngm->free_vxlan_gpe_tunnel_hw_if_indices) -= 1;
566 hi = vnet_get_hw_interface (vnm, hw_if_index);
567 hi->dev_instance = t - ngm->tunnels;
568 hi->hw_instance = hi->dev_instance;
569 /* clear old stats of freed tunnel before reuse */
570 sw_if_index = hi->sw_if_index;
571 vnet_interface_counter_lock (im);
572 vlib_zero_combined_counter
573 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX],
575 vlib_zero_combined_counter (&im->combined_sw_if_counters
576 [VNET_INTERFACE_COUNTER_RX],
578 vlib_zero_simple_counter (&im->sw_if_counters
579 [VNET_INTERFACE_COUNTER_DROP],
581 vnet_interface_counter_unlock (im);
585 hw_if_index = vnet_register_interface
586 (vnm, vxlan_gpe_device_class.index, t - ngm->tunnels,
587 vxlan_gpe_hw_class.index, t - ngm->tunnels);
588 hi = vnet_get_hw_interface (vnm, hw_if_index);
591 /* Set vxlan-gpe tunnel output node */
592 u32 encap_index = vxlan_gpe_encap_node.index;
593 vnet_set_interface_output_node (vnm, hw_if_index, encap_index);
595 t->hw_if_index = hw_if_index;
596 t->sw_if_index = sw_if_index = hi->sw_if_index;
597 vec_validate_init_empty (ngm->tunnel_index_by_sw_if_index, sw_if_index,
599 ngm->tunnel_index_by_sw_if_index[sw_if_index] = t - ngm->tunnels;
601 /* setup l2 input config with l2 feature and bd 0 to drop packet */
602 vec_validate (l2im->configs, sw_if_index);
603 l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
604 l2im->configs[sw_if_index].bd_index = 0;
606 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
607 si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
608 vnet_sw_interface_set_flags (vnm, hi->sw_if_index,
609 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
610 fib_node_init (&t->node, FIB_NODE_TYPE_VXLAN_GPE_TUNNEL);
611 fib_prefix_t tun_remote_pfx;
612 vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
614 fib_prefix_from_ip46_addr (&t->remote, &tun_remote_pfx);
615 if (!ip46_address_is_multicast (&t->remote))
618 * source the FIB entry for the tunnel's destination
619 * and become a child thereof. The tunnel will then get poked
620 * when the forwarding for the entry updates, and the tunnel can
621 * re-stack accordingly
623 vtep_addr_ref (&t->local);
624 t->fib_entry_index = fib_entry_track (t->encap_fib_index,
626 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,
651 .frp_mitf_flags = MFIB_ITF_FLAG_FORWARD,
653 const mfib_prefix_t mpfx = {
655 .fp_len = (is_ip6 ? 128 : 32),
656 .fp_grp_addr = tun_remote_pfx.fp_addr,
660 * Setup the (*,G) to receive traffic on the mcast group
661 * - the forwarding interface is for-us
662 * - the accepting interface is that from the API
664 mfib_table_entry_path_update (t->encap_fib_index,
666 MFIB_SOURCE_VXLAN_GPE, &path);
668 path.frp_sw_if_index = a->mcast_sw_if_index;
669 path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
670 path.frp_mitf_flags = MFIB_ITF_FLAG_ACCEPT;
671 mfei = mfib_table_entry_path_update (t->encap_fib_index,
673 MFIB_SOURCE_VXLAN_GPE,
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_untrack (t->fib_entry_index, t->sibling_index);
732 else if (vtep_addr_unref (&t->remote) == 0)
734 mcast_shared_remove (&t->remote);
737 fib_node_deinit (&t->node);
738 vec_free (t->rewrite);
739 pool_put (ngm->tunnels, t);
743 *sw_if_indexp = sw_if_index;
747 /* register udp ports */
748 if (!is_ip6 && !udp_is_valid_dst_port (UDP_DST_PORT_VXLAN_GPE, 1))
749 udp_register_dst_port (ngm->vlib_main, UDP_DST_PORT_VXLAN_GPE,
750 vxlan4_gpe_input_node.index, 1 /* is_ip4 */ );
751 if (is_ip6 && !udp_is_valid_dst_port (UDP_DST_PORT_VXLAN6_GPE, 0))
752 udp_register_dst_port (ngm->vlib_main, UDP_DST_PORT_VXLAN6_GPE,
753 vxlan6_gpe_input_node.index, 0 /* is_ip4 */ );
759 static clib_error_t *
760 vxlan_gpe_add_del_tunnel_command_fn (vlib_main_t * vm,
761 unformat_input_t * input,
762 vlib_cli_command_t * cmd)
764 unformat_input_t _line_input, *line_input = &_line_input;
766 ip46_address_t local, remote;
772 u32 mcast_sw_if_index = ~0;
773 u32 encap_fib_index = 0;
774 u32 decap_fib_index = 0;
775 u8 protocol = VXLAN_GPE_PROTOCOL_IP4;
780 vnet_vxlan_gpe_add_del_tunnel_args_t _a, *a = &_a;
782 clib_error_t *error = NULL;
784 /* Get a line of input. */
785 if (!unformat_user (input, unformat_line_input, line_input))
788 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
790 if (unformat (line_input, "del"))
792 else if (unformat (line_input, "local %U",
793 unformat_ip4_address, &local.ip4))
798 else if (unformat (line_input, "remote %U",
799 unformat_ip4_address, &remote.ip4))
804 else if (unformat (line_input, "local %U",
805 unformat_ip6_address, &local.ip6))
810 else if (unformat (line_input, "remote %U",
811 unformat_ip6_address, &remote.ip6))
816 else if (unformat (line_input, "group %U %U",
817 unformat_ip4_address, &remote.ip4,
818 unformat_vnet_sw_interface,
819 vnet_get_main (), &mcast_sw_if_index))
821 grp_set = remote_set = 1;
824 else if (unformat (line_input, "group %U %U",
825 unformat_ip6_address, &remote.ip6,
826 unformat_vnet_sw_interface,
827 vnet_get_main (), &mcast_sw_if_index))
829 grp_set = remote_set = 1;
832 else if (unformat (line_input, "encap-vrf-id %d", &tmp))
835 encap_fib_index = fib_table_find (FIB_PROTOCOL_IP6, tmp);
837 encap_fib_index = fib_table_find (FIB_PROTOCOL_IP4, tmp);
839 if (encap_fib_index == ~0)
842 clib_error_return (0, "nonexistent encap fib id %d", tmp);
846 else if (unformat (line_input, "decap-vrf-id %d", &tmp))
849 decap_fib_index = fib_table_find (FIB_PROTOCOL_IP6, tmp);
851 decap_fib_index = fib_table_find (FIB_PROTOCOL_IP4, tmp);
853 if (decap_fib_index == ~0)
856 clib_error_return (0, "nonexistent decap fib id %d", tmp);
860 else if (unformat (line_input, "vni %d", &vni))
862 else if (unformat (line_input, "next-ip4"))
863 protocol = VXLAN_GPE_PROTOCOL_IP4;
864 else if (unformat (line_input, "next-ip6"))
865 protocol = VXLAN_GPE_PROTOCOL_IP6;
866 else if (unformat (line_input, "next-ethernet"))
867 protocol = VXLAN_GPE_PROTOCOL_ETHERNET;
868 else if (unformat (line_input, "next-nsh"))
869 protocol = VXLAN_GPE_PROTOCOL_NSH;
872 error = clib_error_return (0, "parse error: '%U'",
873 format_unformat_error, line_input);
880 error = clib_error_return (0, "tunnel local address not specified");
886 error = clib_error_return (0, "tunnel remote address not specified");
890 if (grp_set && !ip46_address_is_multicast (&remote))
892 error = clib_error_return (0, "tunnel group address not multicast");
896 if (grp_set == 0 && ip46_address_is_multicast (&remote))
898 error = clib_error_return (0, "remote address must be unicast");
902 if (grp_set && mcast_sw_if_index == ~0)
904 error = clib_error_return (0, "tunnel nonexistent multicast device");
907 if (ipv4_set && ipv6_set)
909 error = clib_error_return (0, "both IPv4 and IPv6 addresses specified");
913 if ((ipv4_set && memcmp (&local.ip4, &remote.ip4, sizeof (local.ip4)) == 0)
915 && memcmp (&local.ip6, &remote.ip6, sizeof (local.ip6)) == 0))
917 error = clib_error_return (0, "src and remote addresses are identical");
923 error = clib_error_return (0, "vni not specified");
927 clib_memset (a, 0, sizeof (*a));
930 a->is_ip6 = ipv6_set;
933 #define _(x) a->x = x;
934 foreach_gpe_copy_field;
942 rv = vnet_vxlan_gpe_add_del_tunnel (a, &sw_if_index);
947 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
948 vnet_get_main (), sw_if_index);
950 case VNET_API_ERROR_INVALID_DECAP_NEXT:
951 error = clib_error_return (0, "invalid decap-next...");
954 case VNET_API_ERROR_TUNNEL_EXIST:
955 error = clib_error_return (0, "tunnel already exists...");
958 case VNET_API_ERROR_NO_SUCH_ENTRY:
959 error = clib_error_return (0, "tunnel does not exist...");
963 error = clib_error_return
964 (0, "vnet_vxlan_gpe_add_del_tunnel returned %d", rv);
969 unformat_free (line_input);
975 * Add or delete a VXLAN-GPE Tunnel.
977 * VXLAN-GPE provides the features needed to allow L2 bridge domains (BDs)
978 * to span multiple servers. This is done by building an L2 overlay on
979 * top of an L3 network underlay using VXLAN-GPE tunnels.
981 * This makes it possible for servers to be co-located in the same data
982 * center or be separated geographically as long as they are reachable
983 * through the underlay L3 network.
985 * You can refer to this kind of L2 overlay bridge domain as a VXLAN-GPE segment.
988 * Example of how to create a VXLAN-GPE Tunnel:
989 * @cliexcmd{create vxlan-gpe tunnel local 10.0.3.1 remote 10.0.3.3 vni 13 encap-vrf-id 7}
990 * Example of how to delete a VXLAN-GPE Tunnel:
991 * @cliexcmd{create vxlan-gpe tunnel local 10.0.3.1 remote 10.0.3.3 vni 13 del}
994 VLIB_CLI_COMMAND (create_vxlan_gpe_tunnel_command, static) = {
995 .path = "create vxlan-gpe tunnel",
997 "create vxlan-gpe tunnel local <local-addr> "
998 " {remote <remote-addr>|group <mcast-addr> <intf-name>}"
999 " vni <nn> [next-ip4][next-ip6][next-ethernet][next-nsh]"
1000 " [encap-vrf-id <nn>] [decap-vrf-id <nn>] [del]\n",
1001 .function = vxlan_gpe_add_del_tunnel_command_fn,
1006 * @brief CLI function for showing VXLAN GPE tunnels
1015 static clib_error_t *
1016 show_vxlan_gpe_tunnel_command_fn (vlib_main_t * vm,
1017 unformat_input_t * input,
1018 vlib_cli_command_t * cmd)
1020 vxlan_gpe_main_t *ngm = &vxlan_gpe_main;
1021 vxlan_gpe_tunnel_t *t;
1023 if (pool_elts (ngm->tunnels) == 0)
1024 vlib_cli_output (vm, "No vxlan-gpe tunnels configured.");
1027 pool_foreach (t, ngm->tunnels,
1029 vlib_cli_output (vm, "%U", format_vxlan_gpe_tunnel, t);
1037 * Display all the VXLAN-GPE Tunnel entries.
1040 * Example of how to display the VXLAN-GPE Tunnel entries:
1041 * @cliexstart{show vxlan-gpe tunnel}
1042 * [0] local 10.0.3.1 remote 10.0.3.3 vni 13 encap_fib_index 0 sw_if_index 5 decap_next l2
1046 VLIB_CLI_COMMAND (show_vxlan_gpe_tunnel_command, static) = {
1047 .path = "show vxlan-gpe",
1048 .function = show_vxlan_gpe_tunnel_command_fn,
1053 vnet_int_vxlan_gpe_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable)
1056 vnet_feature_enable_disable ("ip6-unicast", "ip6-vxlan-gpe-bypass",
1057 sw_if_index, is_enable, 0, 0);
1059 vnet_feature_enable_disable ("ip4-unicast", "ip4-vxlan-gpe-bypass",
1060 sw_if_index, is_enable, 0, 0);
1064 static clib_error_t *
1065 set_ip_vxlan_gpe_bypass (u32 is_ip6,
1066 unformat_input_t * input, vlib_cli_command_t * cmd)
1068 unformat_input_t _line_input, *line_input = &_line_input;
1069 vnet_main_t *vnm = vnet_get_main ();
1070 clib_error_t *error = 0;
1071 u32 sw_if_index, is_enable;
1076 if (!unformat_user (input, unformat_line_input, line_input))
1079 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1082 (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
1084 else if (unformat (line_input, "del"))
1088 error = unformat_parse_error (line_input);
1093 if (~0 == sw_if_index)
1095 error = clib_error_return (0, "unknown interface `%U'",
1096 format_unformat_error, line_input);
1100 vnet_int_vxlan_gpe_bypass_mode (sw_if_index, is_ip6, is_enable);
1103 unformat_free (line_input);
1108 static clib_error_t *
1109 set_ip4_vxlan_gpe_bypass (vlib_main_t * vm,
1110 unformat_input_t * input, vlib_cli_command_t * cmd)
1112 return set_ip_vxlan_gpe_bypass (0, input, cmd);
1116 * This command adds the 'ip4-vxlan-gpe-bypass' graph node for a given interface.
1117 * By adding the IPv4 vxlan-gpe-bypass graph node to an interface, the node checks
1118 * for and validate input vxlan_gpe packet and bypass ip4-lookup, ip4-local,
1119 * ip4-udp-lookup nodes to speedup vxlan_gpe packet forwarding. This node will
1120 * cause extra overhead to for non-vxlan_gpe packets which is kept at a minimum.
1124 * Example of graph node before ip4-vxlan-gpe-bypass is enabled:
1125 * @cliexstart{show vlib graph ip4-vxlan-gpe-bypass}
1126 * Name Next Previous
1127 * ip4-vxlan-gpe-bypass error-drop [0]
1128 * vxlan4-gpe-input [1]
1132 * Example of how to enable ip4-vxlan-gpe-bypass on an interface:
1133 * @cliexcmd{set interface ip vxlan-gpe-bypass GigabitEthernet2/0/0}
1135 * Example of graph node after ip4-vxlan-gpe-bypass is enabled:
1136 * @cliexstart{show vlib graph ip4-vxlan-gpe-bypass}
1137 * Name Next Previous
1138 * ip4-vxlan-gpe-bypass error-drop [0] ip4-input
1139 * vxlan4-gpe-input [1] ip4-input-no-checksum
1143 * Example of how to display the feature enabled on an interface:
1144 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1145 * IP feature paths configured on GigabitEthernet2/0/0...
1148 * ip4-vxlan-gpe-bypass
1153 * Example of how to disable ip4-vxlan-gpe-bypass on an interface:
1154 * @cliexcmd{set interface ip vxlan-gpe-bypass GigabitEthernet2/0/0 del}
1158 VLIB_CLI_COMMAND (set_interface_ip_vxlan_gpe_bypass_command, static) = {
1159 .path = "set interface ip vxlan-gpe-bypass",
1160 .function = set_ip4_vxlan_gpe_bypass,
1161 .short_help = "set interface ip vxlan-gpe-bypass <interface> [del]",
1165 static clib_error_t *
1166 set_ip6_vxlan_gpe_bypass (vlib_main_t * vm,
1167 unformat_input_t * input, vlib_cli_command_t * cmd)
1169 return set_ip_vxlan_gpe_bypass (1, input, cmd);
1173 * This command adds the 'ip6-vxlan-gpe-bypass' graph node for a given interface.
1174 * By adding the IPv6 vxlan-gpe-bypass graph node to an interface, the node checks
1175 * for and validate input vxlan_gpe packet and bypass ip6-lookup, ip6-local,
1176 * ip6-udp-lookup nodes to speedup vxlan_gpe packet forwarding. This node will
1177 * cause extra overhead to for non-vxlan_gpe packets which is kept at a minimum.
1181 * Example of graph node before ip6-vxlan-gpe-bypass is enabled:
1182 * @cliexstart{show vlib graph ip6-vxlan-gpe-bypass}
1183 * Name Next Previous
1184 * ip6-vxlan-gpe-bypass error-drop [0]
1185 * vxlan6-gpe-input [1]
1189 * Example of how to enable ip6-vxlan-gpe-bypass on an interface:
1190 * @cliexcmd{set interface ip6 vxlan-gpe-bypass GigabitEthernet2/0/0}
1192 * Example of graph node after ip6-vxlan-gpe-bypass is enabled:
1193 * @cliexstart{show vlib graph ip6-vxlan-gpe-bypass}
1194 * Name Next Previous
1195 * ip6-vxlan-gpe-bypass error-drop [0] ip6-input
1196 * vxlan6-gpe-input [1] ip4-input-no-checksum
1200 * Example of how to display the feature enabled on an interface:
1201 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1202 * IP feature paths configured on GigabitEthernet2/0/0...
1205 * ip6-vxlan-gpe-bypass
1210 * Example of how to disable ip6-vxlan-gpe-bypass on an interface:
1211 * @cliexcmd{set interface ip6 vxlan-gpe-bypass GigabitEthernet2/0/0 del}
1215 VLIB_CLI_COMMAND (set_interface_ip6_vxlan_gpe_bypass_command, static) = {
1216 .path = "set interface ip6 vxlan-gpe-bypass",
1217 .function = set_ip6_vxlan_gpe_bypass,
1218 .short_help = "set interface ip6 vxlan-gpe-bypass <interface> [del]",
1223 VNET_FEATURE_INIT (ip4_vxlan_gpe_bypass, static) =
1225 .arc_name = "ip4-unicast",
1226 .node_name = "ip4-vxlan-gpe-bypass",
1227 .runs_before = VNET_FEATURES ("ip4-lookup"),
1230 VNET_FEATURE_INIT (ip6_vxlan_gpe_bypass, static) =
1232 .arc_name = "ip6-unicast",
1233 .node_name = "ip6-vxlan-gpe-bypass",
1234 .runs_before = VNET_FEATURES ("ip6-lookup"),
1239 * @brief Feature init function for VXLAN GPE
1247 vxlan_gpe_init (vlib_main_t * vm)
1249 vxlan_gpe_main_t *ngm = &vxlan_gpe_main;
1251 ngm->vnet_main = vnet_get_main ();
1252 ngm->vlib_main = vm;
1254 ngm->vxlan4_gpe_tunnel_by_key
1255 = hash_create_mem (0, sizeof (vxlan4_gpe_tunnel_key_t), sizeof (uword));
1257 ngm->vxlan6_gpe_tunnel_by_key
1258 = hash_create_mem (0, sizeof (vxlan6_gpe_tunnel_key_t), sizeof (uword));
1261 ngm->mcast_shared = hash_create_mem (0,
1262 sizeof (ip46_address_t),
1263 sizeof (mcast_shared_t));
1264 ngm->vtep6 = hash_create_mem (0, sizeof (ip6_address_t), sizeof (uword));
1266 /* Register the list of standard decap protocols supported */
1267 vxlan_gpe_register_decap_protocol (VXLAN_GPE_PROTOCOL_IP4,
1268 VXLAN_GPE_INPUT_NEXT_IP4_INPUT);
1269 vxlan_gpe_register_decap_protocol (VXLAN_GPE_PROTOCOL_IP6,
1270 VXLAN_GPE_INPUT_NEXT_IP6_INPUT);
1271 vxlan_gpe_register_decap_protocol (VXLAN_GPE_PROTOCOL_ETHERNET,
1272 VXLAN_GPE_INPUT_NEXT_L2_INPUT);
1274 fib_node_register_type (FIB_NODE_TYPE_VXLAN_GPE_TUNNEL, &vxlan_gpe_vft);
1279 VLIB_INIT_FUNCTION (vxlan_gpe_init);
1283 * fd.io coding-style-patch-verification: ON
1286 * eval: (c-set-style "gnu")