2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
17 * @brief Common utility functions for IPv4 and IPv6 VXLAN GPE tunnels
20 #include <vnet/vxlan-gpe/vxlan_gpe.h>
21 #include <vnet/fib/fib.h>
22 #include <vnet/ip/format.h>
23 #include <vnet/fib/fib_entry.h>
24 #include <vnet/fib/fib_table.h>
25 #include <vnet/mfib/mfib_table.h>
26 #include <vnet/adj/adj_mcast.h>
27 #include <vnet/interface.h>
28 #include <vlib/vlib.h>
34 * VXLAN-GPE provides the features needed to allow L2 bridge domains (BDs)
35 * to span multiple servers. This is done by building an L2 overlay on
36 * top of an L3 network underlay using VXLAN-GPE tunnels.
38 * This makes it possible for servers to be co-located in the same data
39 * center or be separated geographically as long as they are reachable
40 * through the underlay L3 network.
42 * You can refer to this kind of L2 overlay bridge domain as a VXLAN-GPE segment.
45 vxlan_gpe_main_t vxlan_gpe_main;
48 * @brief Tracing function for VXLAN GPE tunnel packets
50 * @param *s formatting string
53 * @return *s formatted string
56 u8 * format_vxlan_gpe_tunnel (u8 * s, va_list * args)
58 vxlan_gpe_tunnel_t * t = va_arg (*args, vxlan_gpe_tunnel_t *);
59 vxlan_gpe_main_t * ngm = &vxlan_gpe_main;
61 s = format (s, "[%d] local: %U remote: %U ",
63 format_ip46_address, &t->local, IP46_TYPE_ANY,
64 format_ip46_address, &t->remote, IP46_TYPE_ANY);
66 s = format (s, " vxlan VNI %d ", t->vni);
70 case VXLAN_GPE_PROTOCOL_IP4:
71 s = format (s, "next-protocol ip4");
73 case VXLAN_GPE_PROTOCOL_IP6:
74 s = format (s, "next-protocol ip6");
76 case VXLAN_GPE_PROTOCOL_ETHERNET:
77 s = format (s, "next-protocol ethernet");
79 case VXLAN_GPE_PROTOCOL_NSH:
80 s = format (s, "next-protocol nsh");
83 s = format (s, "next-protocol unknown %d", t->protocol);
86 s = format (s, " fibs: (encap %d, decap %d)",
94 * @brief Naming for VXLAN GPE tunnel
96 * @param *s formatting string
99 * @return *s formatted string
102 static u8 * format_vxlan_gpe_name (u8 * s, va_list * args)
104 u32 dev_instance = va_arg (*args, u32);
105 return format (s, "vxlan_gpe_tunnel%d", dev_instance);
108 static uword dummy_interface_tx (vlib_main_t * vm,
109 vlib_node_runtime_t * node,
110 vlib_frame_t * frame)
112 clib_warning ("you shouldn't be here, leaking buffers...");
113 return frame->n_vectors;
117 * @brief CLI function for VXLAN GPE admin up/down
126 static clib_error_t *
127 vxlan_gpe_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
129 u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
130 VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
131 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
136 VNET_DEVICE_CLASS (vxlan_gpe_device_class,static) = {
138 .format_device_name = format_vxlan_gpe_name,
139 .format_tx_trace = format_vxlan_gpe_encap_trace,
140 .tx_function = dummy_interface_tx,
141 .admin_up_down_function = vxlan_gpe_interface_admin_up_down,
146 * @brief Formatting function for tracing VXLAN GPE with length
154 static u8 * format_vxlan_gpe_header_with_length (u8 * s, va_list * args)
156 u32 dev_instance = va_arg (*args, u32);
157 s = format (s, "unimplemented dev %u", dev_instance);
161 VNET_HW_INTERFACE_CLASS (vxlan_gpe_hw_class) = {
163 .format_header = format_vxlan_gpe_header_with_length,
164 .build_rewrite = default_build_rewrite,
168 vxlan_gpe_tunnel_restack_dpo(vxlan_gpe_tunnel_t * t)
170 dpo_id_t dpo = DPO_INVALID;
171 u32 encap_index = vxlan_gpe_encap_node.index;
172 fib_forward_chain_type_t forw_type = ip46_address_is_ip4(&t->remote) ?
173 FIB_FORW_CHAIN_TYPE_UNICAST_IP4 : FIB_FORW_CHAIN_TYPE_UNICAST_IP6;
175 fib_entry_contribute_forwarding (t->fib_entry_index, forw_type, &dpo);
176 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
180 static vxlan_gpe_tunnel_t *
181 vxlan_gpe_tunnel_from_fib_node (fib_node_t *node)
184 ASSERT(FIB_NODE_TYPE_VXLAN_GPE_TUNNEL == node->fn_type);
186 return ((vxlan_gpe_tunnel_t*) (((char*)node) -
187 STRUCT_OFFSET_OF(vxlan_gpe_tunnel_t, node)));
191 * Function definition to backwalk a FIB node -
192 * Here we will restack the new dpo of VXLAN_GPE DIP to encap node.
194 static fib_node_back_walk_rc_t
195 vxlan_gpe_tunnel_back_walk (fib_node_t *node,
196 fib_node_back_walk_ctx_t *ctx)
198 vxlan_gpe_tunnel_restack_dpo(vxlan_gpe_tunnel_from_fib_node(node));
199 return (FIB_NODE_BACK_WALK_CONTINUE);
203 * Function definition to get a FIB node from its index
206 vxlan_gpe_tunnel_fib_node_get (fib_node_index_t index)
208 vxlan_gpe_tunnel_t * t;
209 vxlan_gpe_main_t * ngm = &vxlan_gpe_main;
211 t = pool_elt_at_index(ngm->tunnels, index);
217 * Function definition to inform the FIB node that its last lock has gone.
220 vxlan_gpe_tunnel_last_lock_gone (fib_node_t *node)
223 * The VXLAN_GPE tunnel is a root of the graph. As such
224 * it never has children and thus is never locked.
230 * Virtual function table registered by VXLAN_GPE tunnels
231 * for participation in the FIB object graph.
233 const static fib_node_vft_t vxlan_gpe_vft = {
234 .fnv_get = vxlan_gpe_tunnel_fib_node_get,
235 .fnv_last_lock = vxlan_gpe_tunnel_last_lock_gone,
236 .fnv_back_walk = vxlan_gpe_tunnel_back_walk,
239 #define foreach_gpe_copy_field \
242 _(mcast_sw_if_index) \
246 #define foreach_copy_ipv4 { \
247 _(local.ip4.as_u32) \
248 _(remote.ip4.as_u32) \
251 #define foreach_copy_ipv6 { \
252 _(local.ip6.as_u64[0]) \
253 _(local.ip6.as_u64[1]) \
254 _(remote.ip6.as_u64[0]) \
255 _(remote.ip6.as_u64[1]) \
260 * @brief Calculate IPv4 VXLAN GPE rewrite header
267 int vxlan4_gpe_rewrite (vxlan_gpe_tunnel_t * t, u32 extension_size,
268 u8 protocol_override, uword encap_next_node)
272 ip4_vxlan_gpe_header_t * h0;
275 len = sizeof (*h0) + extension_size;
277 vec_free(t->rewrite);
278 vec_validate_aligned (rw, len-1, CLIB_CACHE_LINE_BYTES);
280 h0 = (ip4_vxlan_gpe_header_t *) rw;
282 /* Fixed portion of the (outer) ip4 header */
284 ip0->ip_version_and_header_length = 0x45;
286 ip0->protocol = IP_PROTOCOL_UDP;
288 /* we fix up the ip4 header length and checksum after-the-fact */
289 ip0->src_address.as_u32 = t->local.ip4.as_u32;
290 ip0->dst_address.as_u32 = t->remote.ip4.as_u32;
291 ip0->checksum = ip4_header_checksum (ip0);
293 /* UDP header, randomize src port on something, maybe? */
294 h0->udp.src_port = clib_host_to_net_u16 (4790);
295 h0->udp.dst_port = clib_host_to_net_u16 (UDP_DST_PORT_VXLAN_GPE);
297 /* VXLAN header. Are we having fun yet? */
298 h0->vxlan.flags = VXLAN_GPE_FLAGS_I | VXLAN_GPE_FLAGS_P;
299 h0->vxlan.ver_res = VXLAN_GPE_VERSION;
300 if (protocol_override)
302 h0->vxlan.protocol = protocol_override;
306 h0->vxlan.protocol = t->protocol;
308 t->rewrite_size = sizeof(ip4_vxlan_gpe_header_t) + extension_size;
309 h0->vxlan.vni_res = clib_host_to_net_u32 (t->vni<<8);
312 t->encap_next_node = encap_next_node;
317 * @brief Calculate IPv6 VXLAN GPE rewrite header
324 int vxlan6_gpe_rewrite (vxlan_gpe_tunnel_t * t, u32 extension_size,
325 u8 protocol_override, uword encap_next_node)
329 ip6_vxlan_gpe_header_t * h0;
332 len = sizeof (*h0) + extension_size;
334 vec_free(t->rewrite);
335 vec_validate_aligned (rw, len-1, CLIB_CACHE_LINE_BYTES);
337 h0 = (ip6_vxlan_gpe_header_t *) rw;
339 /* Fixed portion of the (outer) ip4 header */
341 ip0->ip_version_traffic_class_and_flow_label = clib_host_to_net_u32(6 << 28);
342 ip0->hop_limit = 255;
343 ip0->protocol = IP_PROTOCOL_UDP;
345 ip0->src_address.as_u64[0] = t->local.ip6.as_u64[0];
346 ip0->src_address.as_u64[1] = t->local.ip6.as_u64[1];
347 ip0->dst_address.as_u64[0] = t->remote.ip6.as_u64[0];
348 ip0->dst_address.as_u64[1] = t->remote.ip6.as_u64[1];
350 /* UDP header, randomize src port on something, maybe? */
351 h0->udp.src_port = clib_host_to_net_u16 (4790);
352 h0->udp.dst_port = clib_host_to_net_u16 (UDP_DST_PORT_VXLAN_GPE);
354 /* VXLAN header. Are we having fun yet? */
355 h0->vxlan.flags = VXLAN_GPE_FLAGS_I | VXLAN_GPE_FLAGS_P;
356 h0->vxlan.ver_res = VXLAN_GPE_VERSION;
357 if (protocol_override)
359 h0->vxlan.protocol = t->protocol;
363 h0->vxlan.protocol = protocol_override;
365 t->rewrite_size = sizeof(ip4_vxlan_gpe_header_t) + extension_size;
366 h0->vxlan.vni_res = clib_host_to_net_u32 (t->vni<<8);
369 t->encap_next_node = encap_next_node;
374 hash_set_key_copy (uword ** h, void * key, uword v) {
375 size_t ksz = hash_header(*h)->user;
376 void * copy = clib_mem_alloc (ksz);
377 clib_memcpy (copy, key, ksz);
378 hash_set_mem (*h, copy, v);
382 hash_unset_key_free (uword ** h, void * key) {
383 hash_pair_t * hp = hash_get_pair_mem (*h, key);
385 key = uword_to_pointer (hp->key, void *);
386 hash_unset_mem (*h, key);
391 vtep_addr_ref(ip46_address_t *ip)
393 uword *vtep = ip46_address_is_ip4(ip) ?
394 hash_get (vxlan_gpe_main.vtep4, ip->ip4.as_u32) :
395 hash_get_mem (vxlan_gpe_main.vtep6, &ip->ip6);
398 ip46_address_is_ip4(ip) ?
399 hash_set (vxlan_gpe_main.vtep4, ip->ip4.as_u32, 1) :
400 hash_set_key_copy (&vxlan_gpe_main.vtep6, &ip->ip6, 1);
405 vtep_addr_unref(ip46_address_t *ip)
407 uword *vtep = ip46_address_is_ip4(ip) ?
408 hash_get (vxlan_gpe_main.vtep4, ip->ip4.as_u32) :
409 hash_get_mem (vxlan_gpe_main.vtep6, &ip->ip6);
413 ip46_address_is_ip4(ip) ?
414 hash_unset (vxlan_gpe_main.vtep4, ip->ip4.as_u32) :
415 hash_unset_key_free (&vxlan_gpe_main.vtep6, &ip->ip6);
419 typedef CLIB_PACKED(union {
421 fib_node_index_t mfib_entry_index;
422 adj_index_t mcast_adj_index;
427 static inline mcast_shared_t
428 mcast_shared_get(ip46_address_t * ip)
430 ASSERT(ip46_address_is_multicast(ip));
431 uword * p = hash_get_mem (vxlan_gpe_main.mcast_shared, ip);
433 return (mcast_shared_t) { .as_u64 = *p };
437 mcast_shared_add(ip46_address_t *remote,
438 fib_node_index_t mfei,
441 mcast_shared_t new_ep = {
442 .mcast_adj_index = ai,
443 .mfib_entry_index = mfei,
446 hash_set_key_copy (&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,
456 MFIB_SOURCE_VXLAN_GPE);
458 hash_unset_key_free (&vxlan_gpe_main.mcast_shared, remote);
461 static inline fib_protocol_t
462 fib_ip_proto(bool is_ip6)
464 return (is_ip6) ? FIB_PROTOCOL_IP6 : FIB_PROTOCOL_IP4;
468 * @brief Add or Del a VXLAN GPE tunnel
471 * @param *sw_if_index
476 int vnet_vxlan_gpe_add_del_tunnel
477 (vnet_vxlan_gpe_add_del_tunnel_args_t *a, u32 * sw_if_indexp)
479 vxlan_gpe_main_t * ngm = &vxlan_gpe_main;
480 vxlan_gpe_tunnel_t *t = 0;
481 vnet_main_t * vnm = ngm->vnet_main;
482 vnet_hw_interface_t * hi;
484 u32 hw_if_index = ~0;
485 u32 sw_if_index = ~0;
487 vxlan4_gpe_tunnel_key_t key4, *key4_copy;
488 vxlan6_gpe_tunnel_key_t key6, *key6_copy;
489 u32 is_ip6 = a->is_ip6;
493 key4.local = a->local.ip4.as_u32;
494 key4.remote = a->remote.ip4.as_u32;
495 key4.vni = clib_host_to_net_u32 (a->vni << 8);
498 p = hash_get_mem(ngm->vxlan4_gpe_tunnel_by_key, &key4);
502 key6.local.as_u64[0] = a->local.ip6.as_u64[0];
503 key6.local.as_u64[1] = a->local.ip6.as_u64[1];
504 key6.remote.as_u64[0] = a->remote.ip6.as_u64[0];
505 key6.remote.as_u64[1] = a->remote.ip6.as_u64[1];
506 key6.vni = clib_host_to_net_u32 (a->vni << 8);
508 p = hash_get_mem(ngm->vxlan6_gpe_tunnel_by_key, &key6);
513 l2input_main_t * l2im = &l2input_main;
515 /* adding a tunnel: tunnel must not already exist */
517 return VNET_API_ERROR_TUNNEL_EXIST;
519 pool_get_aligned (ngm->tunnels, t, CLIB_CACHE_LINE_BYTES);
520 memset (t, 0, sizeof (*t));
522 /* copy from arg structure */
523 #define _(x) t->x = a->x;
524 foreach_gpe_copy_field;
525 if (!a->is_ip6) foreach_copy_ipv4
526 else foreach_copy_ipv6
529 if (!a->is_ip6) t->flags |= VXLAN_GPE_TUNNEL_IS_IPV4;
532 rv = vxlan4_gpe_rewrite (t, 0, 0, VXLAN_GPE_ENCAP_NEXT_IP4_LOOKUP);
534 rv = vxlan6_gpe_rewrite (t, 0, 0, VXLAN_GPE_ENCAP_NEXT_IP6_LOOKUP);
539 pool_put (ngm->tunnels, t);
545 key4_copy = clib_mem_alloc (sizeof (*key4_copy));
546 clib_memcpy (key4_copy, &key4, sizeof (*key4_copy));
547 hash_set_mem (ngm->vxlan4_gpe_tunnel_by_key, key4_copy,
552 key6_copy = clib_mem_alloc (sizeof (*key6_copy));
553 clib_memcpy (key6_copy, &key6, sizeof (*key6_copy));
554 hash_set_mem (ngm->vxlan6_gpe_tunnel_by_key, key6_copy,
558 if (vec_len (ngm->free_vxlan_gpe_tunnel_hw_if_indices) > 0)
560 vnet_interface_main_t * im = &vnm->interface_main;
561 hw_if_index = ngm->free_vxlan_gpe_tunnel_hw_if_indices
562 [vec_len (ngm->free_vxlan_gpe_tunnel_hw_if_indices)-1];
563 _vec_len (ngm->free_vxlan_gpe_tunnel_hw_if_indices) -= 1;
565 hi = vnet_get_hw_interface (vnm, hw_if_index);
566 hi->dev_instance = t - ngm->tunnels;
567 hi->hw_instance = hi->dev_instance;
568 /* clear old stats of freed tunnel before reuse */
569 sw_if_index = hi->sw_if_index;
570 vnet_interface_counter_lock(im);
571 vlib_zero_combined_counter
572 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX], sw_if_index);
573 vlib_zero_combined_counter
574 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_RX], sw_if_index);
575 vlib_zero_simple_counter
576 (&im->sw_if_counters[VNET_INTERFACE_COUNTER_DROP], sw_if_index);
577 vnet_interface_counter_unlock(im);
581 hw_if_index = vnet_register_interface
582 (vnm, vxlan_gpe_device_class.index, t - ngm->tunnels,
583 vxlan_gpe_hw_class.index, t - ngm->tunnels);
584 hi = vnet_get_hw_interface (vnm, hw_if_index);
585 hi->output_node_index = vxlan_gpe_encap_node.index;
588 t->hw_if_index = hw_if_index;
589 t->sw_if_index = sw_if_index = hi->sw_if_index;
590 vec_validate_init_empty (ngm->tunnel_index_by_sw_if_index, sw_if_index, ~0);
591 ngm->tunnel_index_by_sw_if_index[sw_if_index] = t - ngm->tunnels;
593 /* setup l2 input config with l2 feature and bd 0 to drop packet */
594 vec_validate (l2im->configs, sw_if_index);
595 l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
596 l2im->configs[sw_if_index].bd_index = 0;
598 vnet_sw_interface_t * si = vnet_get_sw_interface (vnm, sw_if_index);
599 si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
600 vnet_sw_interface_set_flags (vnm, hi->sw_if_index,
601 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
602 fib_node_init(&t->node, FIB_NODE_TYPE_VXLAN_GPE_TUNNEL);
603 fib_prefix_t tun_remote_pfx;
604 u32 encap_index = vxlan_gpe_encap_node.index;
605 vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
607 fib_prefix_from_ip46_addr(&t->remote, &tun_remote_pfx);
608 if (!ip46_address_is_multicast(&t->remote))
611 * source the FIB entry for the tunnel's destination
612 * and become a child thereof. The tunnel will then get poked
613 * when the forwarding for the entry updates, and the tunnel can
614 * re-stack accordingly
616 vtep_addr_ref(&t->local);
617 t->fib_entry_index = fib_table_entry_special_add
618 (t->encap_fib_index, &tun_remote_pfx, FIB_SOURCE_RR,
619 FIB_ENTRY_FLAG_NONE);
620 t->sibling_index = fib_entry_child_add
621 (t->fib_entry_index, FIB_NODE_TYPE_VXLAN_GPE_TUNNEL, t - ngm->tunnels);
622 vxlan_gpe_tunnel_restack_dpo(t);
626 /* Multicast tunnel -
627 * as the same mcast group can be used for mutiple mcast tunnels
628 * with different VNIs, create the output fib adjecency only if
629 * it does not already exist
631 fib_protocol_t fp = fib_ip_proto(is_ip6);
633 if (vtep_addr_ref(&t->remote) == 1)
635 fib_node_index_t mfei;
637 fib_route_path_t path = {
639 .frp_addr = zero_addr,
640 .frp_sw_if_index = 0xffffffff,
643 .frp_flags = FIB_ROUTE_PATH_LOCAL,
645 const mfib_prefix_t mpfx = {
647 .fp_len = (is_ip6 ? 128 : 32),
648 .fp_grp_addr = tun_remote_pfx.fp_addr,
652 * Setup the (*,G) to receive traffic on the mcast group
653 * - the forwarding interface is for-us
654 * - the accepting interface is that from the API
656 mfib_table_entry_path_update(t->encap_fib_index,
658 MFIB_SOURCE_VXLAN_GPE,
660 MFIB_ITF_FLAG_FORWARD);
662 path.frp_sw_if_index = a->mcast_sw_if_index;
663 path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
664 mfei = mfib_table_entry_path_update(t->encap_fib_index,
666 MFIB_SOURCE_VXLAN_GPE,
668 MFIB_ITF_FLAG_ACCEPT);
671 * Create the mcast adjacency to send traffic to the group
673 ai = adj_mcast_add_or_lock(fp,
674 fib_proto_to_link(fp),
675 a->mcast_sw_if_index);
678 * create a new end-point
680 mcast_shared_add(&t->remote, mfei, ai);
683 dpo_id_t dpo = DPO_INVALID;
684 mcast_shared_t ep = mcast_shared_get(&t->remote);
686 /* Stack shared mcast remote mac addr rewrite on encap */
687 dpo_set (&dpo, DPO_ADJACENCY_MCAST,
688 fib_proto_to_dpo(fp),
691 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
693 flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
696 /* Set vxlan tunnel output node */
697 hi->output_node_index = encap_index;
699 vnet_get_sw_interface (vnet_get_main(), sw_if_index)->flood_class = flood_class;
703 /* deleting a tunnel: tunnel must exist */
705 return VNET_API_ERROR_NO_SUCH_ENTRY;
707 t = pool_elt_at_index (ngm->tunnels, p[0]);
709 sw_if_index = t->sw_if_index;
710 vnet_sw_interface_set_flags (vnm, t->sw_if_index, 0 /* down */);
711 vnet_sw_interface_t * si = vnet_get_sw_interface (vnm, t->sw_if_index);
712 si->flags |= VNET_SW_INTERFACE_FLAG_HIDDEN;
713 set_int_l2_mode(ngm->vlib_main, vnm, MODE_L3, t->sw_if_index, 0, 0, 0, 0);
714 vec_add1 (ngm->free_vxlan_gpe_tunnel_hw_if_indices, t->hw_if_index);
716 ngm->tunnel_index_by_sw_if_index[t->sw_if_index] = ~0;
719 hash_unset (ngm->vxlan4_gpe_tunnel_by_key, key4.as_u64);
721 hash_unset_key_free (&ngm->vxlan6_gpe_tunnel_by_key, &key6);
723 if (!ip46_address_is_multicast(&t->remote))
725 vtep_addr_unref(&t->local);
726 fib_entry_child_remove(t->fib_entry_index, t->sibling_index);
727 fib_table_entry_delete_index(t->fib_entry_index, FIB_SOURCE_RR);
729 else if (vtep_addr_unref(&t->remote) == 0)
731 mcast_shared_remove(&t->remote);
734 fib_node_deinit(&t->node);
735 vec_free (t->rewrite);
736 pool_put (ngm->tunnels, t);
740 *sw_if_indexp = sw_if_index;
745 static clib_error_t *
746 vxlan_gpe_add_del_tunnel_command_fn (vlib_main_t * vm,
747 unformat_input_t * input,
748 vlib_cli_command_t * cmd)
750 unformat_input_t _line_input, * line_input = &_line_input;
752 ip46_address_t local, remote;
758 u32 mcast_sw_if_index = ~0;
759 u32 encap_fib_index = 0;
760 u32 decap_fib_index = 0;
761 u8 protocol = VXLAN_GPE_PROTOCOL_IP4;
766 vnet_vxlan_gpe_add_del_tunnel_args_t _a, * a = &_a;
768 clib_error_t *error = NULL;
770 /* Get a line of input. */
771 if (! unformat_user (input, unformat_line_input, line_input))
774 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) {
775 if (unformat (line_input, "del"))
777 else if (unformat (line_input, "local %U",
778 unformat_ip4_address, &local.ip4))
783 else if (unformat (line_input, "remote %U",
784 unformat_ip4_address, &remote.ip4))
789 else if (unformat (line_input, "local %U",
790 unformat_ip6_address, &local.ip6))
795 else if (unformat (line_input, "remote %U",
796 unformat_ip6_address, &remote.ip6))
801 else if (unformat (line_input, "group %U %U",
802 unformat_ip4_address, &remote.ip4,
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, "group %U %U",
810 unformat_ip6_address, &remote.ip6,
811 unformat_vnet_sw_interface,
812 vnet_get_main(), &mcast_sw_if_index))
814 grp_set = remote_set = 1;
817 else if (unformat (line_input, "encap-vrf-id %d", &tmp))
820 encap_fib_index = fib_table_find (FIB_PROTOCOL_IP6, tmp);
822 encap_fib_index = fib_table_find (FIB_PROTOCOL_IP4, tmp);
824 if (encap_fib_index == ~0)
826 error = clib_error_return (0, "nonexistent encap fib id %d", tmp);
830 else if (unformat (line_input, "decap-vrf-id %d", &tmp))
833 decap_fib_index = fib_table_find (FIB_PROTOCOL_IP6, tmp);
835 decap_fib_index = fib_table_find (FIB_PROTOCOL_IP4, tmp);
837 if (decap_fib_index == ~0)
839 error = clib_error_return (0, "nonexistent decap fib id %d", tmp);
843 else if (unformat (line_input, "vni %d", &vni))
845 else if (unformat(line_input, "next-ip4"))
846 protocol = VXLAN_GPE_PROTOCOL_IP4;
847 else if (unformat(line_input, "next-ip6"))
848 protocol = VXLAN_GPE_PROTOCOL_IP6;
849 else if (unformat(line_input, "next-ethernet"))
850 protocol = VXLAN_GPE_PROTOCOL_ETHERNET;
851 else if (unformat(line_input, "next-nsh"))
852 protocol = VXLAN_GPE_PROTOCOL_NSH;
855 error = clib_error_return (0, "parse error: '%U'",
856 format_unformat_error, line_input);
863 error = clib_error_return (0, "tunnel local address not specified");
869 error = clib_error_return (0, "tunnel remote address not specified");
873 if (grp_set && !ip46_address_is_multicast(&remote))
875 error = clib_error_return (0, "tunnel group address not multicast");
879 if (grp_set == 0 && ip46_address_is_multicast(&remote))
881 error = clib_error_return (0, "remote address must be unicast");
885 if (grp_set && mcast_sw_if_index == ~0)
887 error = clib_error_return (0, "tunnel nonexistent multicast device");
890 if (ipv4_set && ipv6_set)
892 error = clib_error_return (0, "both IPv4 and IPv6 addresses specified");
896 if ((ipv4_set && memcmp(&local.ip4, &remote.ip4, sizeof(local.ip4)) == 0) ||
897 (ipv6_set && memcmp(&local.ip6, &remote.ip6, sizeof(local.ip6)) == 0))
899 error = clib_error_return (0, "src and remote addresses are identical");
905 error = clib_error_return (0, "vni not specified");
909 memset (a, 0, sizeof (*a));
912 a->is_ip6 = ipv6_set;
914 #define _(x) a->x = x;
915 foreach_gpe_copy_field;
916 if (ipv4_set) foreach_copy_ipv4
917 else foreach_copy_ipv6
920 rv = vnet_vxlan_gpe_add_del_tunnel (a, &sw_if_index);
925 vlib_cli_output(vm, "%U\n", format_vnet_sw_if_index_name, vnet_get_main(), sw_if_index);
927 case VNET_API_ERROR_INVALID_DECAP_NEXT:
928 error = clib_error_return (0, "invalid decap-next...");
931 case VNET_API_ERROR_TUNNEL_EXIST:
932 error = clib_error_return (0, "tunnel already exists...");
935 case VNET_API_ERROR_NO_SUCH_ENTRY:
936 error = clib_error_return (0, "tunnel does not exist...");
940 error = clib_error_return
941 (0, "vnet_vxlan_gpe_add_del_tunnel returned %d", rv);
946 unformat_free (line_input);
952 * Add or delete a VXLAN-GPE Tunnel.
954 * VXLAN-GPE provides the features needed to allow L2 bridge domains (BDs)
955 * to span multiple servers. This is done by building an L2 overlay on
956 * top of an L3 network underlay using VXLAN-GPE tunnels.
958 * This makes it possible for servers to be co-located in the same data
959 * center or be separated geographically as long as they are reachable
960 * through the underlay L3 network.
962 * You can refer to this kind of L2 overlay bridge domain as a VXLAN-GPE sengment.
965 * Example of how to create a VXLAN-GPE Tunnel:
966 * @cliexcmd{create vxlan-gpe tunnel local 10.0.3.1 local 10.0.3.3 vni 13 encap-vrf-id 7}
967 * Example of how to delete a VXLAN Tunnel:
968 * @cliexcmd{create vxlan tunnel src 10.0.3.1 remote 10.0.3.3 vni 13 del}
971 VLIB_CLI_COMMAND (create_vxlan_gpe_tunnel_command, static) = {
972 .path = "create vxlan-gpe tunnel",
974 "create vxlan-gpe tunnel local <local-addr> "
975 " {remote <remote-addr>|group <mcast-addr> <intf-name>}"
976 " vni <nn> [next-ip4][next-ip6][next-ethernet][next-nsh]"
977 " [encap-vrf-id <nn>] [decap-vrf-id <nn>] [del]\n",
978 .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
1021 VLIB_CLI_COMMAND (show_vxlan_gpe_tunnel_command, static) = {
1022 .path = "show vxlan-gpe",
1023 .function = show_vxlan_gpe_tunnel_command_fn,
1027 void vnet_int_vxlan_gpe_bypass_mode (u32 sw_if_index,
1032 vnet_feature_enable_disable ("ip6-unicast", "ip6-vxlan-gpe-bypass",
1033 sw_if_index, is_enable, 0, 0);
1035 vnet_feature_enable_disable ("ip4-unicast", "ip4-vxlan-gpe-bypass",
1036 sw_if_index, is_enable, 0, 0);
1040 static clib_error_t *
1041 set_ip_vxlan_gpe_bypass (u32 is_ip6,
1042 unformat_input_t * input,
1043 vlib_cli_command_t * cmd)
1045 unformat_input_t _line_input, * line_input = &_line_input;
1046 vnet_main_t * vnm = vnet_get_main();
1047 clib_error_t * error = 0;
1048 u32 sw_if_index, is_enable;
1053 if (! unformat_user (input, unformat_line_input, line_input))
1056 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1058 if (unformat_user (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
1060 else if (unformat (line_input, "del"))
1064 error = unformat_parse_error (line_input);
1069 if (~0 == sw_if_index)
1071 error = clib_error_return (0, "unknown interface `%U'",
1072 format_unformat_error, line_input);
1076 vnet_int_vxlan_gpe_bypass_mode (sw_if_index, is_ip6, is_enable);
1079 unformat_free (line_input);
1084 static clib_error_t *
1085 set_ip4_vxlan_gpe_bypass (vlib_main_t * vm,
1086 unformat_input_t * input,
1087 vlib_cli_command_t * cmd)
1089 return set_ip_vxlan_gpe_bypass (0, input, cmd);
1093 * This command adds the 'ip4-vxlan-gpe-bypass' graph node for a given interface.
1094 * By adding the IPv4 vxlan-gpe-bypass graph node to an interface, the node checks
1095 * for and validate input vxlan_gpe packet and bypass ip4-lookup, ip4-local,
1096 * ip4-udp-lookup nodes to speedup vxlan_gpe packet forwarding. This node will
1097 * cause extra overhead to for non-vxlan_gpe packets which is kept at a minimum.
1101 * Example of graph node before ip4-vxlan-gpe-bypass is enabled:
1102 * @cliexstart{show vlib graph ip4-vxlan-gpe-bypass}
1103 * Name Next Previous
1104 * ip4-vxlan-gpe-bypass error-drop [0]
1105 * vxlan4-gpe-input [1]
1109 * Example of how to enable ip4-vxlan-gpe-bypass on an interface:
1110 * @cliexcmd{set interface ip vxlan-gpe-bypass GigabitEthernet2/0/0}
1112 * Example of graph node after ip4-vxlan-gpe-bypass is enabled:
1113 * @cliexstart{show vlib graph ip4-vxlan-gpe-bypass}
1114 * Name Next Previous
1115 * ip4-vxlan-gpe-bypass error-drop [0] ip4-input
1116 * vxlan4-gpe-input [1] ip4-input-no-checksum
1120 * Example of how to display the feature enabed on an interface:
1121 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1122 * IP feature paths configured on GigabitEthernet2/0/0...
1125 * ip4-vxlan-gpe-bypass
1130 * Example of how to disable ip4-vxlan-gpe-bypass on an interface:
1131 * @cliexcmd{set interface ip vxlan-gpe-bypass GigabitEthernet2/0/0 del}
1135 VLIB_CLI_COMMAND (set_interface_ip_vxlan_gpe_bypass_command, static) = {
1136 .path = "set interface ip vxlan-gpe-bypass",
1137 .function = set_ip4_vxlan_gpe_bypass,
1138 .short_help = "set interface ip vxlan-gpe-bypass <interface> [del]",
1142 static clib_error_t *
1143 set_ip6_vxlan_gpe_bypass (vlib_main_t * vm,
1144 unformat_input_t * input,
1145 vlib_cli_command_t * cmd)
1147 return set_ip_vxlan_gpe_bypass (1, input, cmd);
1151 * This command adds the 'ip6-vxlan-gpe-bypass' graph node for a given interface.
1152 * By adding the IPv6 vxlan-gpe-bypass graph node to an interface, the node checks
1153 * for and validate input vxlan_gpe packet and bypass ip6-lookup, ip6-local,
1154 * ip6-udp-lookup nodes to speedup vxlan_gpe packet forwarding. This node will
1155 * cause extra overhead to for non-vxlan_gpe packets which is kept at a minimum.
1159 * Example of graph node before ip6-vxlan-gpe-bypass is enabled:
1160 * @cliexstart{show vlib graph ip6-vxlan-gpe-bypass}
1161 * Name Next Previous
1162 * ip6-vxlan-gpe-bypass error-drop [0]
1163 * vxlan6-gpe-input [1]
1167 * Example of how to enable ip6-vxlan-gpe-bypass on an interface:
1168 * @cliexcmd{set interface ip6 vxlan-gpe-bypass GigabitEthernet2/0/0}
1170 * Example of graph node after ip6-vxlan-gpe-bypass is enabled:
1171 * @cliexstart{show vlib graph ip6-vxlan-gpe-bypass}
1172 * Name Next Previous
1173 * ip6-vxlan-gpe-bypass error-drop [0] ip6-input
1174 * vxlan6-gpe-input [1] ip4-input-no-checksum
1178 * Example of how to display the feature enabed on an interface:
1179 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1180 * IP feature paths configured on GigabitEthernet2/0/0...
1183 * ip6-vxlan-gpe-bypass
1188 * Example of how to disable ip6-vxlan-gpe-bypass on an interface:
1189 * @cliexcmd{set interface ip6 vxlan-gpe-bypass GigabitEthernet2/0/0 del}
1193 VLIB_CLI_COMMAND (set_interface_ip6_vxlan_gpe_bypass_command, static) = {
1194 .path = "set interface ip6 vxlan-gpe-bypass",
1195 .function = set_ip6_vxlan_gpe_bypass,
1196 .short_help = "set interface ip vxlan-gpe-bypass <interface> [del]",
1201 * @brief Feature init function for VXLAN GPE
1208 clib_error_t *vxlan_gpe_init (vlib_main_t *vm)
1210 vxlan_gpe_main_t *ngm = &vxlan_gpe_main;
1212 ngm->vnet_main = vnet_get_main();
1213 ngm->vlib_main = vm;
1215 ngm->vxlan4_gpe_tunnel_by_key
1216 = hash_create_mem (0, sizeof(vxlan4_gpe_tunnel_key_t), sizeof (uword));
1218 ngm->vxlan6_gpe_tunnel_by_key
1219 = hash_create_mem (0, sizeof(vxlan6_gpe_tunnel_key_t), sizeof (uword));
1222 ngm->mcast_shared = hash_create_mem(0,
1223 sizeof(ip46_address_t),
1224 sizeof(mcast_shared_t));
1226 udp_register_dst_port (vm, UDP_DST_PORT_VXLAN_GPE,
1227 vxlan4_gpe_input_node.index, 1 /* is_ip4 */);
1228 udp_register_dst_port (vm, UDP_DST_PORT_VXLAN6_GPE,
1229 vxlan6_gpe_input_node.index, 0 /* is_ip4 */);
1231 /* Register the list of standard decap protocols supported */
1232 vxlan_gpe_register_decap_protocol (VXLAN_GPE_PROTOCOL_IP4,
1233 VXLAN_GPE_INPUT_NEXT_IP4_INPUT);
1234 vxlan_gpe_register_decap_protocol (VXLAN_GPE_PROTOCOL_IP6,
1235 VXLAN_GPE_INPUT_NEXT_IP6_INPUT);
1236 vxlan_gpe_register_decap_protocol (VXLAN_GPE_PROTOCOL_ETHERNET,
1237 VXLAN_GPE_INPUT_NEXT_ETHERNET_INPUT);
1239 fib_node_register_type(FIB_NODE_TYPE_VXLAN_GPE_TUNNEL, &vxlan_gpe_vft);
1244 VLIB_INIT_FUNCTION(vxlan_gpe_init);