2 * Copyright (c) 2018 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.
15 #include <vnet/vxlan-gbp/vxlan_gbp.h>
16 #include <vnet/ip/format.h>
17 #include <vnet/fib/fib_entry.h>
18 #include <vnet/fib/fib_table.h>
19 #include <vnet/mfib/mfib_table.h>
20 #include <vnet/adj/adj_mcast.h>
21 #include <vnet/adj/rewrite.h>
22 #include <vnet/interface.h>
23 #include <vlib/vlib.h>
29 * VXLAN GBP provides the features of vxlan and carry group policy id.
33 vxlan_gbp_main_t vxlan_gbp_main;
36 format_vxlan_gbp_tunnel_mode (u8 * s, va_list * args)
38 vxlan_gbp_tunnel_mode_t mode = va_arg (*args, vxlan_gbp_tunnel_mode_t);
42 case VXLAN_GBP_TUNNEL_MODE_L2:
45 case VXLAN_GBP_TUNNEL_MODE_L3:
53 format_vxlan_gbp_tunnel (u8 * s, va_list * args)
55 vxlan_gbp_tunnel_t *t = va_arg (*args, vxlan_gbp_tunnel_t *);
58 "[%d] instance %d src %U dst %U vni %d fib-idx %d"
59 " sw-if-idx %d mode %U ",
60 t->dev_instance, t->user_instance,
61 format_ip46_address, &t->src, IP46_TYPE_ANY,
62 format_ip46_address, &t->dst, IP46_TYPE_ANY,
63 t->vni, t->encap_fib_index, t->sw_if_index,
64 format_vxlan_gbp_tunnel_mode, t->mode);
66 s = format (s, "encap-dpo-idx %d ", t->next_dpo.dpoi_index);
68 if (PREDICT_FALSE (ip46_address_is_multicast (&t->dst)))
69 s = format (s, "mcast-sw-if-idx %d ", t->mcast_sw_if_index);
75 format_vxlan_gbp_name (u8 * s, va_list * args)
77 u32 dev_instance = va_arg (*args, u32);
78 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
79 vxlan_gbp_tunnel_t *t;
81 if (dev_instance == ~0)
82 return format (s, "<cached-unused>");
84 if (dev_instance >= vec_len (vxm->tunnels))
85 return format (s, "<improperly-referenced>");
87 t = pool_elt_at_index (vxm->tunnels, dev_instance);
89 return format (s, "vxlan_gbp_tunnel%d", t->user_instance);
93 vxlan_gbp_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index,
96 u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
97 VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
98 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
100 return /* no error */ 0;
104 VNET_DEVICE_CLASS (vxlan_gbp_device_class, static) = {
106 .format_device_name = format_vxlan_gbp_name,
107 .format_tx_trace = format_vxlan_gbp_encap_trace,
108 .admin_up_down_function = vxlan_gbp_interface_admin_up_down,
113 format_vxlan_gbp_header_with_length (u8 * s, va_list * args)
115 u32 dev_instance = va_arg (*args, u32);
116 s = format (s, "unimplemented dev %u", dev_instance);
121 VNET_HW_INTERFACE_CLASS (vxlan_gbp_hw_class) = {
123 .format_header = format_vxlan_gbp_header_with_length,
124 .build_rewrite = default_build_rewrite,
129 vxlan_gbp_tunnel_restack_dpo (vxlan_gbp_tunnel_t * t)
131 u8 is_ip4 = ip46_address_is_ip4 (&t->dst);
132 dpo_id_t dpo = DPO_INVALID;
133 fib_forward_chain_type_t forw_type = is_ip4 ?
134 FIB_FORW_CHAIN_TYPE_UNICAST_IP4 : FIB_FORW_CHAIN_TYPE_UNICAST_IP6;
136 fib_entry_contribute_forwarding (t->fib_entry_index, forw_type, &dpo);
138 /* vxlan_gbp uses the payload hash as the udp source port
139 * hence the packet's hash is unknown
140 * skip single bucket load balance dpo's */
141 while (DPO_LOAD_BALANCE == dpo.dpoi_type)
143 load_balance_t *lb = load_balance_get (dpo.dpoi_index);
144 if (lb->lb_n_buckets > 1)
147 dpo_copy (&dpo, load_balance_get_bucket_i (lb, 0));
150 u32 encap_index = is_ip4 ?
151 vxlan4_gbp_encap_node.index : vxlan6_gbp_encap_node.index;
152 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
156 static vxlan_gbp_tunnel_t *
157 vxlan_gbp_tunnel_from_fib_node (fib_node_t * node)
159 ASSERT (FIB_NODE_TYPE_VXLAN_GBP_TUNNEL == node->fn_type);
160 return ((vxlan_gbp_tunnel_t *) (((char *) node) -
161 STRUCT_OFFSET_OF (vxlan_gbp_tunnel_t,
166 * Function definition to backwalk a FIB node -
167 * Here we will restack the new dpo of VXLAN DIP to encap node.
169 static fib_node_back_walk_rc_t
170 vxlan_gbp_tunnel_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
172 vxlan_gbp_tunnel_restack_dpo (vxlan_gbp_tunnel_from_fib_node (node));
173 return (FIB_NODE_BACK_WALK_CONTINUE);
177 * Function definition to get a FIB node from its index
180 vxlan_gbp_tunnel_fib_node_get (fib_node_index_t index)
182 vxlan_gbp_tunnel_t *t;
183 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
185 t = pool_elt_at_index (vxm->tunnels, index);
191 * Function definition to inform the FIB node that its last lock has gone.
194 vxlan_gbp_tunnel_last_lock_gone (fib_node_t * node)
197 * The VXLAN GBP tunnel is a root of the graph. As such
198 * it never has children and thus is never locked.
204 * Virtual function table registered by VXLAN GBP tunnels
205 * for participation in the FIB object graph.
207 const static fib_node_vft_t vxlan_gbp_vft = {
208 .fnv_get = vxlan_gbp_tunnel_fib_node_get,
209 .fnv_last_lock = vxlan_gbp_tunnel_last_lock_gone,
210 .fnv_back_walk = vxlan_gbp_tunnel_back_walk,
214 #define foreach_copy_field \
217 _(mcast_sw_if_index) \
223 vxlan_gbp_rewrite (vxlan_gbp_tunnel_t * t, bool is_ip6)
227 ip4_vxlan_gbp_header_t h4;
228 ip6_vxlan_gbp_header_t h6;
230 int len = is_ip6 ? sizeof h.h6 : sizeof h.h4;
233 vxlan_gbp_header_t *vxlan_gbp;
234 /* Fixed portion of the (outer) ip header */
236 clib_memset (&h, 0, sizeof (h));
239 ip4_header_t *ip = &h.h4.ip4;
240 udp = &h.h4.udp, vxlan_gbp = &h.h4.vxlan_gbp;
241 ip->ip_version_and_header_length = 0x45;
243 ip->protocol = IP_PROTOCOL_UDP;
245 ip->src_address = t->src.ip4;
246 ip->dst_address = t->dst.ip4;
248 /* we fix up the ip4 header length and checksum after-the-fact */
249 ip->checksum = ip4_header_checksum (ip);
253 ip6_header_t *ip = &h.h6.ip6;
254 udp = &h.h6.udp, vxlan_gbp = &h.h6.vxlan_gbp;
255 ip->ip_version_traffic_class_and_flow_label =
256 clib_host_to_net_u32 (6 << 28);
258 ip->protocol = IP_PROTOCOL_UDP;
260 ip->src_address = t->src.ip6;
261 ip->dst_address = t->dst.ip6;
264 /* UDP header, randomize src port on something, maybe? */
265 udp->src_port = clib_host_to_net_u16 (47789);
266 udp->dst_port = clib_host_to_net_u16 (UDP_DST_PORT_vxlan_gbp);
269 vxlan_gbp_set_header (vxlan_gbp, t->vni);
270 vnet_rewrite_set_data (*t, &h, len);
274 vtep_addr_ref (ip46_address_t * ip)
276 uword *vtep = ip46_address_is_ip4 (ip) ?
277 hash_get (vxlan_gbp_main.vtep4, ip->ip4.as_u32) :
278 hash_get_mem (vxlan_gbp_main.vtep6, &ip->ip6);
281 ip46_address_is_ip4 (ip) ?
282 hash_set (vxlan_gbp_main.vtep4, ip->ip4.as_u32, 1) :
283 hash_set_mem_alloc (&vxlan_gbp_main.vtep6, &ip->ip6, 1);
288 vtep_addr_unref (ip46_address_t * ip)
290 uword *vtep = ip46_address_is_ip4 (ip) ?
291 hash_get (vxlan_gbp_main.vtep4, ip->ip4.as_u32) :
292 hash_get_mem (vxlan_gbp_main.vtep6, &ip->ip6);
296 ip46_address_is_ip4 (ip) ?
297 hash_unset (vxlan_gbp_main.vtep4, ip->ip4.as_u32) :
298 hash_unset_mem_free (&vxlan_gbp_main.vtep6, &ip->ip6);
303 typedef CLIB_PACKED(union
307 fib_node_index_t mfib_entry_index;
308 adj_index_t mcast_adj_index;
314 static inline mcast_shared_t
315 mcast_shared_get (ip46_address_t * ip)
317 ASSERT (ip46_address_is_multicast (ip));
318 uword *p = hash_get_mem (vxlan_gbp_main.mcast_shared, ip);
320 mcast_shared_t ret = {.as_u64 = *p };
325 mcast_shared_add (ip46_address_t * dst, fib_node_index_t mfei, adj_index_t ai)
327 mcast_shared_t new_ep = {
328 .mcast_adj_index = ai,
329 .mfib_entry_index = mfei,
332 hash_set_mem_alloc (&vxlan_gbp_main.mcast_shared, dst, new_ep.as_u64);
336 mcast_shared_remove (ip46_address_t * dst)
338 mcast_shared_t ep = mcast_shared_get (dst);
340 adj_unlock (ep.mcast_adj_index);
341 mfib_table_entry_delete_index (ep.mfib_entry_index, MFIB_SOURCE_VXLAN_GBP);
343 hash_unset_mem_free (&vxlan_gbp_main.mcast_shared, dst);
347 vxlan_gbp_register_udp_ports (void)
349 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
351 if (vxm->udp_ports_registered == 0)
353 udp_register_dst_port (vxm->vlib_main, UDP_DST_PORT_vxlan_gbp,
354 vxlan4_gbp_input_node.index, /* is_ip4 */ 1);
355 udp_register_dst_port (vxm->vlib_main, UDP_DST_PORT_vxlan6_gbp,
356 vxlan6_gbp_input_node.index, /* is_ip4 */ 0);
359 * Counts the number of vxlan_gbp tunnels
361 vxm->udp_ports_registered += 1;
365 vxlan_gbp_unregister_udp_ports (void)
367 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
369 ASSERT (vxm->udp_ports_registered != 0);
371 if (vxm->udp_ports_registered == 1)
373 udp_unregister_dst_port (vxm->vlib_main, UDP_DST_PORT_vxlan_gbp,
375 udp_unregister_dst_port (vxm->vlib_main, UDP_DST_PORT_vxlan6_gbp,
379 vxm->udp_ports_registered -= 1;
382 int vnet_vxlan_gbp_tunnel_add_del
383 (vnet_vxlan_gbp_tunnel_add_del_args_t * a, u32 * sw_if_indexp)
385 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
386 vxlan_gbp_tunnel_t *t = 0;
387 vnet_main_t *vnm = vxm->vnet_main;
389 u32 sw_if_index = ~0;
390 vxlan4_gbp_tunnel_key_t key4;
391 vxlan6_gbp_tunnel_key_t key6;
392 u32 is_ip6 = a->is_ip6;
397 key4.key[0] = a->dst.ip4.as_u32;
398 key4.key[1] = (((u64) a->encap_fib_index) << 32)
399 | clib_host_to_net_u32 (a->vni << 8);
401 clib_bihash_search_inline_16_8 (&vxm->vxlan4_gbp_tunnel_by_key,
407 key6.key[0] = a->dst.ip6.as_u64[0];
408 key6.key[1] = a->dst.ip6.as_u64[1];
409 key6.key[2] = (((u64) a->encap_fib_index) << 32)
410 | clib_host_to_net_u32 (a->vni << 8);
412 clib_bihash_search_inline_24_8 (&vxm->vxlan6_gbp_tunnel_by_key,
422 l2input_main_t *l2im = &l2input_main;
423 u32 dev_instance; /* real dev instance tunnel index */
424 u32 user_instance; /* request and actual instance number */
426 /* adding a tunnel: tunnel must not already exist */
429 t = pool_elt_at_index (vxm->tunnels, *p);
430 *sw_if_indexp = t->sw_if_index;
431 return VNET_API_ERROR_TUNNEL_EXIST;
433 pool_get_aligned (vxm->tunnels, t, CLIB_CACHE_LINE_BYTES);
434 clib_memset (t, 0, sizeof (*t));
435 dev_instance = t - vxm->tunnels;
437 /* copy from arg structure */
438 #define _(x) t->x = a->x;
442 vxlan_gbp_rewrite (t, is_ip6);
444 * Reconcile the real dev_instance and a possible requested instance.
446 user_instance = a->instance;
447 if (user_instance == ~0)
448 user_instance = dev_instance;
449 if (hash_get (vxm->instance_used, user_instance))
451 pool_put (vxm->tunnels, t);
452 return VNET_API_ERROR_INSTANCE_IN_USE;
454 hash_set (vxm->instance_used, user_instance, 1);
456 t->dev_instance = dev_instance; /* actual */
457 t->user_instance = user_instance; /* name */
463 key6.value = (u64) dev_instance;
465 clib_bihash_add_del_24_8 (&vxm->vxlan6_gbp_tunnel_by_key, &key6,
470 key4.value = (u64) dev_instance;
472 clib_bihash_add_del_16_8 (&vxm->vxlan4_gbp_tunnel_by_key, &key4,
478 pool_put (vxm->tunnels, t);
479 return VNET_API_ERROR_INVALID_REGISTRATION;
482 vxlan_gbp_register_udp_ports ();
484 t->hw_if_index = vnet_register_interface
485 (vnm, vxlan_gbp_device_class.index, dev_instance,
486 vxlan_gbp_hw_class.index, dev_instance);
487 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, t->hw_if_index);
489 /* Set vxlan_gbp tunnel output node */
490 u32 encap_index = !is_ip6 ?
491 vxlan4_gbp_encap_node.index : vxlan6_gbp_encap_node.index;
492 vnet_set_interface_output_node (vnm, t->hw_if_index, encap_index);
494 t->sw_if_index = sw_if_index = hi->sw_if_index;
496 if (VXLAN_GBP_TUNNEL_MODE_L3 == t->mode)
498 ip4_sw_interface_enable_disable (t->sw_if_index, 1);
499 ip6_sw_interface_enable_disable (t->sw_if_index, 1);
502 vec_validate_init_empty (vxm->tunnel_index_by_sw_if_index, sw_if_index,
504 vxm->tunnel_index_by_sw_if_index[sw_if_index] = dev_instance;
506 /* setup l2 input config with l2 feature and bd 0 to drop packet */
507 vec_validate (l2im->configs, sw_if_index);
508 l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
509 l2im->configs[sw_if_index].bd_index = 0;
511 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
512 si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
513 vnet_sw_interface_set_flags (vnm, sw_if_index,
514 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
516 fib_node_init (&t->node, FIB_NODE_TYPE_VXLAN_GBP_TUNNEL);
517 fib_prefix_t tun_dst_pfx;
518 vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
520 fib_prefix_from_ip46_addr (&t->dst, &tun_dst_pfx);
521 if (!ip46_address_is_multicast (&t->dst))
524 * source the FIB entry for the tunnel's destination
525 * and become a child thereof. The tunnel will then get poked
526 * when the forwarding for the entry updates, and the tunnel can
527 * re-stack accordingly
529 vtep_addr_ref (&t->src);
530 t->fib_entry_index = fib_table_entry_special_add
531 (t->encap_fib_index, &tun_dst_pfx, FIB_SOURCE_RR,
532 FIB_ENTRY_FLAG_NONE);
533 t->sibling_index = fib_entry_child_add
534 (t->fib_entry_index, FIB_NODE_TYPE_VXLAN_GBP_TUNNEL,
536 vxlan_gbp_tunnel_restack_dpo (t);
540 /* Multicast tunnel -
541 * as the same mcast group can be used for multiple mcast tunnels
542 * with different VNIs, create the output fib adjacency only if
543 * it does not already exist
545 fib_protocol_t fp = fib_ip_proto (is_ip6);
547 if (vtep_addr_ref (&t->dst) == 1)
549 fib_node_index_t mfei;
551 fib_route_path_t path = {
552 .frp_proto = fib_proto_to_dpo (fp),
553 .frp_addr = zero_addr,
554 .frp_sw_if_index = 0xffffffff,
557 .frp_flags = FIB_ROUTE_PATH_LOCAL,
559 const mfib_prefix_t mpfx = {
561 .fp_len = (is_ip6 ? 128 : 32),
562 .fp_grp_addr = tun_dst_pfx.fp_addr,
566 * Setup the (*,G) to receive traffic on the mcast group
567 * - the forwarding interface is for-us
568 * - the accepting interface is that from the API
570 mfib_table_entry_path_update (t->encap_fib_index,
572 MFIB_SOURCE_VXLAN_GBP,
573 &path, MFIB_ITF_FLAG_FORWARD);
575 path.frp_sw_if_index = a->mcast_sw_if_index;
576 path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
577 mfei = mfib_table_entry_path_update (t->encap_fib_index,
579 MFIB_SOURCE_VXLAN_GBP,
581 MFIB_ITF_FLAG_ACCEPT);
584 * Create the mcast adjacency to send traffic to the group
586 ai = adj_mcast_add_or_lock (fp,
587 fib_proto_to_link (fp),
588 a->mcast_sw_if_index);
591 * create a new end-point
593 mcast_shared_add (&t->dst, mfei, ai);
596 dpo_id_t dpo = DPO_INVALID;
597 mcast_shared_t ep = mcast_shared_get (&t->dst);
599 /* Stack shared mcast dst mac addr rewrite on encap */
600 dpo_set (&dpo, DPO_ADJACENCY_MCAST,
601 fib_proto_to_dpo (fp), ep.mcast_adj_index);
603 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
605 flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
608 vnet_get_sw_interface (vnet_get_main (), sw_if_index)->flood_class =
613 /* deleting a tunnel: tunnel must exist */
615 return VNET_API_ERROR_NO_SUCH_ENTRY;
618 t = pool_elt_at_index (vxm->tunnels, instance);
620 sw_if_index = t->sw_if_index;
621 vnet_sw_interface_set_flags (vnm, sw_if_index, 0 /* down */ );
623 if (VXLAN_GBP_TUNNEL_MODE_L3 == t->mode)
625 ip4_sw_interface_enable_disable (t->sw_if_index, 0);
626 ip6_sw_interface_enable_disable (t->sw_if_index, 0);
629 vxm->tunnel_index_by_sw_if_index[sw_if_index] = ~0;
632 clib_bihash_add_del_16_8 (&vxm->vxlan4_gbp_tunnel_by_key, &key4,
635 clib_bihash_add_del_24_8 (&vxm->vxlan6_gbp_tunnel_by_key, &key6,
638 if (!ip46_address_is_multicast (&t->dst))
640 vtep_addr_unref (&t->src);
641 fib_entry_child_remove (t->fib_entry_index, t->sibling_index);
642 fib_table_entry_delete_index (t->fib_entry_index, FIB_SOURCE_RR);
644 else if (vtep_addr_unref (&t->dst) == 0)
646 mcast_shared_remove (&t->dst);
649 vxlan_gbp_unregister_udp_ports ();
650 vnet_delete_hw_interface (vnm, t->hw_if_index);
651 hash_unset (vxm->instance_used, t->user_instance);
653 fib_node_deinit (&t->node);
654 pool_put (vxm->tunnels, t);
658 *sw_if_indexp = sw_if_index;
664 vnet_vxlan_gbp_tunnel_del (u32 sw_if_index)
666 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
667 vxlan_gbp_tunnel_t *t = 0;
670 if (sw_if_index >= vec_len (vxm->tunnel_index_by_sw_if_index))
671 return VNET_API_ERROR_NO_SUCH_ENTRY;
673 ti = vxm->tunnel_index_by_sw_if_index[sw_if_index];
676 t = pool_elt_at_index (vxm->tunnels, ti);
678 vnet_vxlan_gbp_tunnel_add_del_args_t args = {
680 .is_ip6 = !ip46_address_is_ip4 (&t->src),
687 return (vnet_vxlan_gbp_tunnel_add_del (&args, NULL));
690 return VNET_API_ERROR_NO_SUCH_ENTRY;
694 get_decap_next_for_node (u32 node_index, u32 ipv4_set)
696 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
697 vlib_main_t *vm = vxm->vlib_main;
698 uword input_node = (ipv4_set) ? vxlan4_gbp_input_node.index :
699 vxlan6_gbp_input_node.index;
701 return vlib_node_add_next (vm, input_node, node_index);
705 unformat_decap_next (unformat_input_t * input, va_list * args)
707 u32 *result = va_arg (*args, u32 *);
708 u32 ipv4_set = va_arg (*args, int);
709 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
710 vlib_main_t *vm = vxm->vlib_main;
714 if (unformat (input, "l2"))
715 *result = VXLAN_GBP_INPUT_NEXT_L2_INPUT;
716 else if (unformat (input, "node %U", unformat_vlib_node, vm, &node_index))
717 *result = get_decap_next_for_node (node_index, ipv4_set);
718 else if (unformat (input, "%d", &tmp))
725 static clib_error_t *
726 vxlan_gbp_tunnel_add_del_command_fn (vlib_main_t * vm,
727 unformat_input_t * input,
728 vlib_cli_command_t * cmd)
730 unformat_input_t _line_input, *line_input = &_line_input;
731 ip46_address_t src = ip46_address_initializer, dst =
732 ip46_address_initializer;
733 vxlan_gbp_tunnel_mode_t mode = VXLAN_GBP_TUNNEL_MODE_L2;
741 u32 encap_fib_index = 0;
742 u32 mcast_sw_if_index = ~0;
743 u32 decap_next_index = VXLAN_GBP_INPUT_NEXT_L2_INPUT;
746 clib_error_t *parse_error = NULL;
748 /* Get a line of input. */
749 if (!unformat_user (input, unformat_line_input, line_input))
752 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
754 if (unformat (line_input, "del"))
758 else if (unformat (line_input, "instance %d", &instance))
760 else if (unformat (line_input, "src %U",
761 unformat_ip46_address, &src, IP46_TYPE_ANY))
764 ip46_address_is_ip4 (&src) ? (ipv4_set = 1) : (ipv6_set = 1);
766 else if (unformat (line_input, "dst %U",
767 unformat_ip46_address, &dst, IP46_TYPE_ANY))
770 ip46_address_is_ip4 (&dst) ? (ipv4_set = 1) : (ipv6_set = 1);
772 else if (unformat (line_input, "group %U %U",
773 unformat_ip46_address, &dst, IP46_TYPE_ANY,
774 unformat_vnet_sw_interface,
775 vnet_get_main (), &mcast_sw_if_index))
777 grp_set = dst_set = 1;
778 ip46_address_is_ip4 (&dst) ? (ipv4_set = 1) : (ipv6_set = 1);
780 else if (unformat (line_input, "encap-vrf-id %d", &table_id))
783 fib_table_find (fib_ip_proto (ipv6_set), table_id);
785 else if (unformat (line_input, "decap-next %U", unformat_decap_next,
786 &decap_next_index, ipv4_set))
788 else if (unformat (line_input, "vni %d", &vni))
792 parse_error = clib_error_return (0, "parse error: '%U'",
793 format_unformat_error, line_input);
798 unformat_free (line_input);
803 if (encap_fib_index == ~0)
804 return clib_error_return (0, "nonexistent encap-vrf-id %d", table_id);
807 return clib_error_return (0, "tunnel src address not specified");
810 return clib_error_return (0, "tunnel dst address not specified");
812 if (grp_set && !ip46_address_is_multicast (&dst))
813 return clib_error_return (0, "tunnel group address not multicast");
815 if (grp_set == 0 && ip46_address_is_multicast (&dst))
816 return clib_error_return (0, "dst address must be unicast");
818 if (grp_set && mcast_sw_if_index == ~0)
819 return clib_error_return (0, "tunnel nonexistent multicast device");
821 if (ipv4_set && ipv6_set)
822 return clib_error_return (0, "both IPv4 and IPv6 addresses specified");
824 if (ip46_address_cmp (&src, &dst) == 0)
825 return clib_error_return (0, "src and dst addresses are identical");
827 if (decap_next_index == ~0)
828 return clib_error_return (0, "next node not found");
831 return clib_error_return (0, "vni not specified");
834 return clib_error_return (0, "vni %d out of range", vni);
836 vnet_vxlan_gbp_tunnel_add_del_args_t a = {
839 .instance = instance,
845 u32 tunnel_sw_if_index;
846 int rv = vnet_vxlan_gbp_tunnel_add_del (&a, &tunnel_sw_if_index);
852 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
853 vnet_get_main (), tunnel_sw_if_index);
856 case VNET_API_ERROR_TUNNEL_EXIST:
857 return clib_error_return (0, "tunnel already exists...");
859 case VNET_API_ERROR_NO_SUCH_ENTRY:
860 return clib_error_return (0, "tunnel does not exist...");
862 case VNET_API_ERROR_INSTANCE_IN_USE:
863 return clib_error_return (0, "Instance is in use");
866 return clib_error_return
867 (0, "vnet_vxlan_gbp_tunnel_add_del returned %d", rv);
874 * Add or delete a VXLAN Tunnel.
876 * VXLAN provides the features needed to allow L2 bridge domains (BDs)
877 * to span multiple servers. This is done by building an L2 overlay on
878 * top of an L3 network underlay using VXLAN tunnels.
880 * This makes it possible for servers to be co-located in the same data
881 * center or be separated geographically as long as they are reachable
882 * through the underlay L3 network.
884 * You can refer to this kind of L2 overlay bridge domain as a VXLAN
885 * (Virtual eXtensible VLAN) segment.
888 * Example of how to create a VXLAN Tunnel:
889 * @cliexcmd{create vxlan_gbp tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 encap-vrf-id 7}
890 * Example of how to create a VXLAN Tunnel with a known name, vxlan_gbp_tunnel42:
891 * @cliexcmd{create vxlan_gbp tunnel src 10.0.3.1 dst 10.0.3.3 instance 42}
892 * Example of how to create a multicast VXLAN Tunnel with a known name, vxlan_gbp_tunnel23:
893 * @cliexcmd{create vxlan_gbp tunnel src 10.0.3.1 group 239.1.1.1 GigabitEthernet0/8/0 instance 23}
894 * Example of how to delete a VXLAN Tunnel:
895 * @cliexcmd{create vxlan_gbp tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 del}
898 VLIB_CLI_COMMAND (create_vxlan_gbp_tunnel_command, static) = {
899 .path = "create vxlan-gbp tunnel",
901 "create vxlan-gbp tunnel src <local-vtep-addr>"
902 " {dst <remote-vtep-addr>|group <mcast-vtep-addr> <intf-name>} vni <nn>"
904 " [encap-vrf-id <nn>] [decap-next [l2|node <name>]] [del]",
905 .function = vxlan_gbp_tunnel_add_del_command_fn,
909 static clib_error_t *
910 show_vxlan_gbp_tunnel_command_fn (vlib_main_t * vm,
911 unformat_input_t * input,
912 vlib_cli_command_t * cmd)
914 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
915 vxlan_gbp_tunnel_t *t;
918 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
920 if (unformat (input, "raw"))
923 return clib_error_return (0, "parse error: '%U'",
924 format_unformat_error, input);
927 if (pool_elts (vxm->tunnels) == 0)
928 vlib_cli_output (vm, "No vxlan-gbp tunnels configured...");
931 pool_foreach (t, vxm->tunnels,
933 vlib_cli_output (vm, "%U", format_vxlan_gbp_tunnel, t);
939 vlib_cli_output (vm, "Raw IPv4 Hash Table:\n%U\n",
940 format_bihash_16_8, &vxm->vxlan4_gbp_tunnel_by_key,
942 vlib_cli_output (vm, "Raw IPv6 Hash Table:\n%U\n",
943 format_bihash_24_8, &vxm->vxlan6_gbp_tunnel_by_key,
951 * Display all the VXLAN Tunnel entries.
954 * Example of how to display the VXLAN Tunnel entries:
955 * @cliexstart{show vxlan_gbp tunnel}
956 * [0] src 10.0.3.1 dst 10.0.3.3 vni 13 encap_fib_index 0 sw_if_index 5 decap_next l2
960 VLIB_CLI_COMMAND (show_vxlan_gbp_tunnel_command, static) = {
961 .path = "show vxlan-gbp tunnel",
962 .short_help = "show vxlan-gbp tunnel [raw]",
963 .function = show_vxlan_gbp_tunnel_command_fn,
969 vnet_int_vxlan_gbp_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable)
972 vnet_feature_enable_disable ("ip6-unicast", "ip6-vxlan-gbp-bypass",
973 sw_if_index, is_enable, 0, 0);
975 vnet_feature_enable_disable ("ip4-unicast", "ip4-vxlan-gbp-bypass",
976 sw_if_index, is_enable, 0, 0);
980 static clib_error_t *
981 set_ip_vxlan_gbp_bypass (u32 is_ip6,
982 unformat_input_t * input, vlib_cli_command_t * cmd)
984 unformat_input_t _line_input, *line_input = &_line_input;
985 vnet_main_t *vnm = vnet_get_main ();
986 clib_error_t *error = 0;
987 u32 sw_if_index, is_enable;
992 if (!unformat_user (input, unformat_line_input, line_input))
995 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
998 (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
1000 else if (unformat (line_input, "del"))
1004 error = unformat_parse_error (line_input);
1009 if (~0 == sw_if_index)
1011 error = clib_error_return (0, "unknown interface `%U'",
1012 format_unformat_error, line_input);
1016 vnet_int_vxlan_gbp_bypass_mode (sw_if_index, is_ip6, is_enable);
1019 unformat_free (line_input);
1024 static clib_error_t *
1025 set_ip4_vxlan_gbp_bypass (vlib_main_t * vm,
1026 unformat_input_t * input, vlib_cli_command_t * cmd)
1028 return set_ip_vxlan_gbp_bypass (0, input, cmd);
1032 * This command adds the 'ip4-vxlan-gbp-bypass' graph node for a given interface.
1033 * By adding the IPv4 vxlan_gbp-bypass graph node to an interface, the node checks
1034 * for and validate input vxlan_gbp packet and bypass ip4-lookup, ip4-local,
1035 * ip4-udp-lookup nodes to speedup vxlan_gbp packet forwarding. This node will
1036 * cause extra overhead to for non-vxlan_gbp packets which is kept at a minimum.
1040 * Example of graph node before ip4-vxlan_gbp-bypass is enabled:
1041 * @cliexstart{show vlib graph ip4-vxlan_gbp-bypass}
1042 * Name Next Previous
1043 * ip4-vxlan-gbp-bypass error-drop [0]
1044 * vxlan4-gbp-input [1]
1048 * Example of how to enable ip4-vxlan-gbp-bypass on an interface:
1049 * @cliexcmd{set interface ip vxlan-gbp-bypass GigabitEthernet2/0/0}
1051 * Example of graph node after ip4-vxlan-gbp-bypass is enabled:
1052 * @cliexstart{show vlib graph ip4-vxlan-gbp-bypass}
1053 * Name Next Previous
1054 * ip4-vxlan-gbp-bypass error-drop [0] ip4-input
1055 * vxlan4-gbp-input [1] ip4-input-no-checksum
1059 * Example of how to display the feature enabled on an interface:
1060 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1061 * IP feature paths configured on GigabitEthernet2/0/0...
1064 * ip4-vxlan-gbp-bypass
1069 * Example of how to disable ip4-vxlan-gbp-bypass on an interface:
1070 * @cliexcmd{set interface ip vxlan-gbp-bypass GigabitEthernet2/0/0 del}
1074 VLIB_CLI_COMMAND (set_interface_ip_vxlan_gbp_bypass_command, static) = {
1075 .path = "set interface ip vxlan-gbp-bypass",
1076 .function = set_ip4_vxlan_gbp_bypass,
1077 .short_help = "set interface ip vxlan-gbp-bypass <interface> [del]",
1081 static clib_error_t *
1082 set_ip6_vxlan_gbp_bypass (vlib_main_t * vm,
1083 unformat_input_t * input, vlib_cli_command_t * cmd)
1085 return set_ip_vxlan_gbp_bypass (1, input, cmd);
1089 * This command adds the 'ip6-vxlan-gbp-bypass' graph node for a given interface.
1090 * By adding the IPv6 vxlan-gbp-bypass graph node to an interface, the node checks
1091 * for and validate input vxlan_gbp packet and bypass ip6-lookup, ip6-local,
1092 * ip6-udp-lookup nodes to speedup vxlan_gbp packet forwarding. This node will
1093 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
1097 * Example of graph node before ip6-vxlan-gbp-bypass is enabled:
1098 * @cliexstart{show vlib graph ip6-vxlan-gbp-bypass}
1099 * Name Next Previous
1100 * ip6-vxlan-gbp-bypass error-drop [0]
1101 * vxlan6-gbp-input [1]
1105 * Example of how to enable ip6-vxlan-gbp-bypass on an interface:
1106 * @cliexcmd{set interface ip6 vxlan-gbp-bypass GigabitEthernet2/0/0}
1108 * Example of graph node after ip6-vxlan-gbp-bypass is enabled:
1109 * @cliexstart{show vlib graph ip6-vxlan-gbp-bypass}
1110 * Name Next Previous
1111 * ip6-vxlan-gbp-bypass error-drop [0] ip6-input
1112 * vxlan6-gbp-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 * ip6-vxlan-gbp-bypass
1126 * Example of how to disable ip6-vxlan-gbp-bypass on an interface:
1127 * @cliexcmd{set interface ip6 vxlan-gbp-bypass GigabitEthernet2/0/0 del}
1131 VLIB_CLI_COMMAND (set_interface_ip6_vxlan_gbp_bypass_command, static) = {
1132 .path = "set interface ip6 vxlan-gbp-bypass",
1133 .function = set_ip6_vxlan_gbp_bypass,
1134 .short_help = "set interface ip vxlan-gbp-bypass <interface> [del]",
1138 #define VXLAN_GBP_HASH_NUM_BUCKETS (2 * 1024)
1139 #define VXLAN_GBP_HASH_MEMORY_SIZE (1 << 20)
1142 vxlan_gbp_init (vlib_main_t * vm)
1144 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
1146 vxm->vnet_main = vnet_get_main ();
1147 vxm->vlib_main = vm;
1149 /* initialize the ip6 hash */
1150 clib_bihash_init_16_8 (&vxm->vxlan4_gbp_tunnel_by_key, "vxlan4-gbp",
1151 VXLAN_GBP_HASH_NUM_BUCKETS,
1152 VXLAN_GBP_HASH_MEMORY_SIZE);
1153 clib_bihash_init_24_8 (&vxm->vxlan6_gbp_tunnel_by_key, "vxlan6-gbp",
1154 VXLAN_GBP_HASH_NUM_BUCKETS,
1155 VXLAN_GBP_HASH_MEMORY_SIZE);
1156 vxm->vtep6 = hash_create_mem (0, sizeof (ip6_address_t), sizeof (uword));
1157 vxm->mcast_shared = hash_create_mem (0,
1158 sizeof (ip46_address_t),
1159 sizeof (mcast_shared_t));
1161 fib_node_register_type (FIB_NODE_TYPE_VXLAN_GBP_TUNNEL, &vxlan_gbp_vft);
1166 VLIB_INIT_FUNCTION (vxlan_gbp_init);
1169 * fd.io coding-style-patch-verification: ON
1172 * eval: (c-set-style "gnu")