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/fib/fib_entry_track.h>
20 #include <vnet/mfib/mfib_table.h>
21 #include <vnet/adj/adj_mcast.h>
22 #include <vnet/adj/rewrite.h>
23 #include <vnet/interface.h>
24 #include <vlib/vlib.h>
30 * VXLAN GBP provides the features of vxlan and carry group policy id.
32 static vlib_punt_hdl_t punt_hdl;
34 vxlan_gbp_main_t vxlan_gbp_main;
37 format_vxlan_gbp_tunnel_mode (u8 * s, va_list * args)
39 vxlan_gbp_tunnel_mode_t mode = va_arg (*args, vxlan_gbp_tunnel_mode_t);
43 case VXLAN_GBP_TUNNEL_MODE_L2:
46 case VXLAN_GBP_TUNNEL_MODE_L3:
54 format_vxlan_gbp_tunnel (u8 * s, va_list * args)
56 vxlan_gbp_tunnel_t *t = va_arg (*args, vxlan_gbp_tunnel_t *);
59 "[%d] instance %d src %U dst %U vni %d fib-idx %d"
60 " sw-if-idx %d mode %U ",
61 t->dev_instance, t->user_instance,
62 format_ip46_address, &t->src, IP46_TYPE_ANY,
63 format_ip46_address, &t->dst, IP46_TYPE_ANY,
64 t->vni, t->encap_fib_index, t->sw_if_index,
65 format_vxlan_gbp_tunnel_mode, t->mode);
67 s = format (s, "encap-dpo-idx %d ", t->next_dpo.dpoi_index);
69 if (PREDICT_FALSE (ip46_address_is_multicast (&t->dst)))
70 s = format (s, "mcast-sw-if-idx %d ", t->mcast_sw_if_index);
76 format_vxlan_gbp_name (u8 * s, va_list * args)
78 u32 dev_instance = va_arg (*args, u32);
79 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
80 vxlan_gbp_tunnel_t *t;
82 if (dev_instance == ~0)
83 return format (s, "<cached-unused>");
85 if (dev_instance >= vec_len (vxm->tunnels))
86 return format (s, "<improperly-referenced>");
88 t = pool_elt_at_index (vxm->tunnels, dev_instance);
90 return format (s, "vxlan_gbp_tunnel%d", t->user_instance);
94 vxlan_gbp_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index,
97 u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
98 VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
99 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
101 return /* no error */ 0;
105 VNET_DEVICE_CLASS (vxlan_gbp_device_class, static) = {
107 .format_device_name = format_vxlan_gbp_name,
108 .format_tx_trace = format_vxlan_gbp_encap_trace,
109 .admin_up_down_function = vxlan_gbp_interface_admin_up_down,
114 format_vxlan_gbp_header_with_length (u8 * s, va_list * args)
116 u32 dev_instance = va_arg (*args, u32);
117 s = format (s, "unimplemented dev %u", dev_instance);
122 VNET_HW_INTERFACE_CLASS (vxlan_gbp_hw_class) = {
124 .format_header = format_vxlan_gbp_header_with_length,
125 .build_rewrite = default_build_rewrite,
130 vxlan_gbp_tunnel_restack_dpo (vxlan_gbp_tunnel_t * t)
132 u8 is_ip4 = ip46_address_is_ip4 (&t->dst);
133 dpo_id_t dpo = DPO_INVALID;
134 fib_forward_chain_type_t forw_type = is_ip4 ?
135 FIB_FORW_CHAIN_TYPE_UNICAST_IP4 : FIB_FORW_CHAIN_TYPE_UNICAST_IP6;
137 fib_entry_contribute_forwarding (t->fib_entry_index, forw_type, &dpo);
139 /* vxlan_gbp uses the payload hash as the udp source port
140 * hence the packet's hash is unknown
141 * skip single bucket load balance dpo's */
142 while (DPO_LOAD_BALANCE == dpo.dpoi_type)
144 load_balance_t *lb = load_balance_get (dpo.dpoi_index);
145 if (lb->lb_n_buckets > 1)
148 dpo_copy (&dpo, load_balance_get_bucket_i (lb, 0));
151 u32 encap_index = is_ip4 ?
152 vxlan4_gbp_encap_node.index : vxlan6_gbp_encap_node.index;
153 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
157 static vxlan_gbp_tunnel_t *
158 vxlan_gbp_tunnel_from_fib_node (fib_node_t * node)
160 ASSERT (FIB_NODE_TYPE_VXLAN_GBP_TUNNEL == node->fn_type);
161 return ((vxlan_gbp_tunnel_t *) (((char *) node) -
162 STRUCT_OFFSET_OF (vxlan_gbp_tunnel_t,
167 * Function definition to backwalk a FIB node -
168 * Here we will restack the new dpo of VXLAN DIP to encap node.
170 static fib_node_back_walk_rc_t
171 vxlan_gbp_tunnel_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
173 vxlan_gbp_tunnel_restack_dpo (vxlan_gbp_tunnel_from_fib_node (node));
174 return (FIB_NODE_BACK_WALK_CONTINUE);
178 * Function definition to get a FIB node from its index
181 vxlan_gbp_tunnel_fib_node_get (fib_node_index_t index)
183 vxlan_gbp_tunnel_t *t;
184 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
186 t = pool_elt_at_index (vxm->tunnels, index);
192 * Function definition to inform the FIB node that its last lock has gone.
195 vxlan_gbp_tunnel_last_lock_gone (fib_node_t * node)
198 * The VXLAN GBP tunnel is a root of the graph. As such
199 * it never has children and thus is never locked.
205 * Virtual function table registered by VXLAN GBP tunnels
206 * for participation in the FIB object graph.
208 const static fib_node_vft_t vxlan_gbp_vft = {
209 .fnv_get = vxlan_gbp_tunnel_fib_node_get,
210 .fnv_last_lock = vxlan_gbp_tunnel_last_lock_gone,
211 .fnv_back_walk = vxlan_gbp_tunnel_back_walk,
215 #define foreach_copy_field \
218 _(mcast_sw_if_index) \
224 vxlan_gbp_rewrite (vxlan_gbp_tunnel_t * t, bool is_ip6)
228 ip4_vxlan_gbp_header_t h4;
229 ip6_vxlan_gbp_header_t h6;
231 int len = is_ip6 ? sizeof h.h6 : sizeof h.h4;
234 vxlan_gbp_header_t *vxlan_gbp;
235 /* Fixed portion of the (outer) ip header */
237 clib_memset (&h, 0, sizeof (h));
240 ip4_header_t *ip = &h.h4.ip4;
241 udp = &h.h4.udp, vxlan_gbp = &h.h4.vxlan_gbp;
242 ip->ip_version_and_header_length = 0x45;
244 ip->protocol = IP_PROTOCOL_UDP;
246 ip->src_address = t->src.ip4;
247 ip->dst_address = t->dst.ip4;
249 /* we fix up the ip4 header length and checksum after-the-fact */
250 ip->checksum = ip4_header_checksum (ip);
254 ip6_header_t *ip = &h.h6.ip6;
255 udp = &h.h6.udp, vxlan_gbp = &h.h6.vxlan_gbp;
256 ip->ip_version_traffic_class_and_flow_label =
257 clib_host_to_net_u32 (6 << 28);
259 ip->protocol = IP_PROTOCOL_UDP;
261 ip->src_address = t->src.ip6;
262 ip->dst_address = t->dst.ip6;
265 /* UDP header, randomize src port on something, maybe? */
266 udp->src_port = clib_host_to_net_u16 (47789);
267 udp->dst_port = clib_host_to_net_u16 (UDP_DST_PORT_vxlan_gbp);
270 vxlan_gbp_set_header (vxlan_gbp, t->vni);
271 vnet_rewrite_set_data (*t, &h, len);
275 vtep_addr_ref (ip46_address_t * ip)
277 uword *vtep = ip46_address_is_ip4 (ip) ?
278 hash_get (vxlan_gbp_main.vtep4, ip->ip4.as_u32) :
279 hash_get_mem (vxlan_gbp_main.vtep6, &ip->ip6);
282 ip46_address_is_ip4 (ip) ?
283 hash_set (vxlan_gbp_main.vtep4, ip->ip4.as_u32, 1) :
284 hash_set_mem_alloc (&vxlan_gbp_main.vtep6, &ip->ip6, 1);
289 vtep_addr_unref (ip46_address_t * ip)
291 uword *vtep = ip46_address_is_ip4 (ip) ?
292 hash_get (vxlan_gbp_main.vtep4, ip->ip4.as_u32) :
293 hash_get_mem (vxlan_gbp_main.vtep6, &ip->ip6);
297 ip46_address_is_ip4 (ip) ?
298 hash_unset (vxlan_gbp_main.vtep4, ip->ip4.as_u32) :
299 hash_unset_mem_free (&vxlan_gbp_main.vtep6, &ip->ip6);
304 typedef CLIB_PACKED(union
308 fib_node_index_t mfib_entry_index;
309 adj_index_t mcast_adj_index;
315 static inline mcast_shared_t
316 mcast_shared_get (ip46_address_t * ip)
318 ASSERT (ip46_address_is_multicast (ip));
319 uword *p = hash_get_mem (vxlan_gbp_main.mcast_shared, ip);
321 mcast_shared_t ret = {.as_u64 = *p };
326 mcast_shared_add (ip46_address_t * dst, fib_node_index_t mfei, adj_index_t ai)
328 mcast_shared_t new_ep = {
329 .mcast_adj_index = ai,
330 .mfib_entry_index = mfei,
333 hash_set_mem_alloc (&vxlan_gbp_main.mcast_shared, dst, new_ep.as_u64);
337 mcast_shared_remove (ip46_address_t * dst)
339 mcast_shared_t ep = mcast_shared_get (dst);
341 adj_unlock (ep.mcast_adj_index);
342 mfib_table_entry_delete_index (ep.mfib_entry_index, MFIB_SOURCE_VXLAN_GBP);
344 hash_unset_mem_free (&vxlan_gbp_main.mcast_shared, dst);
348 vxlan_gbp_register_udp_ports (void)
350 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
352 if (vxm->udp_ports_registered == 0)
354 udp_register_dst_port (vxm->vlib_main, UDP_DST_PORT_vxlan_gbp,
355 vxlan4_gbp_input_node.index, /* is_ip4 */ 1);
356 udp_register_dst_port (vxm->vlib_main, UDP_DST_PORT_vxlan6_gbp,
357 vxlan6_gbp_input_node.index, /* is_ip4 */ 0);
360 * Counts the number of vxlan_gbp tunnels
362 vxm->udp_ports_registered += 1;
366 vxlan_gbp_unregister_udp_ports (void)
368 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
370 ASSERT (vxm->udp_ports_registered != 0);
372 if (vxm->udp_ports_registered == 1)
374 udp_unregister_dst_port (vxm->vlib_main, UDP_DST_PORT_vxlan_gbp,
376 udp_unregister_dst_port (vxm->vlib_main, UDP_DST_PORT_vxlan6_gbp,
380 vxm->udp_ports_registered -= 1;
383 int vnet_vxlan_gbp_tunnel_add_del
384 (vnet_vxlan_gbp_tunnel_add_del_args_t * a, u32 * sw_if_indexp)
386 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
387 vxlan_gbp_tunnel_t *t = 0;
388 vnet_main_t *vnm = vxm->vnet_main;
390 u32 sw_if_index = ~0;
391 vxlan4_gbp_tunnel_key_t key4;
392 vxlan6_gbp_tunnel_key_t key6;
393 u32 is_ip6 = a->is_ip6;
398 key4.key[0] = ip46_address_is_multicast (&a->dst) ?
400 a->dst.ip4.as_u32 | (((u64) a->src.ip4.as_u32) << 32);
401 key4.key[1] = (((u64) a->encap_fib_index) << 32)
402 | clib_host_to_net_u32 (a->vni << 8);
404 clib_bihash_search_inline_16_8 (&vxm->vxlan4_gbp_tunnel_by_key,
410 key6.key[0] = a->dst.ip6.as_u64[0];
411 key6.key[1] = a->dst.ip6.as_u64[1];
412 key6.key[2] = (((u64) a->encap_fib_index) << 32)
413 | clib_host_to_net_u32 (a->vni << 8);
415 clib_bihash_search_inline_24_8 (&vxm->vxlan6_gbp_tunnel_by_key,
425 l2input_main_t *l2im = &l2input_main;
426 u32 dev_instance; /* real dev instance tunnel index */
427 u32 user_instance; /* request and actual instance number */
429 /* adding a tunnel: tunnel must not already exist */
432 t = pool_elt_at_index (vxm->tunnels, *p);
433 *sw_if_indexp = t->sw_if_index;
434 return VNET_API_ERROR_TUNNEL_EXIST;
436 pool_get_aligned (vxm->tunnels, t, CLIB_CACHE_LINE_BYTES);
437 clib_memset (t, 0, sizeof (*t));
438 dev_instance = t - vxm->tunnels;
440 /* copy from arg structure */
441 #define _(x) t->x = a->x;
445 vxlan_gbp_rewrite (t, is_ip6);
447 * Reconcile the real dev_instance and a possible requested instance.
449 user_instance = a->instance;
450 if (user_instance == ~0)
451 user_instance = dev_instance;
452 if (hash_get (vxm->instance_used, user_instance))
454 pool_put (vxm->tunnels, t);
455 return VNET_API_ERROR_INSTANCE_IN_USE;
457 hash_set (vxm->instance_used, user_instance, 1);
459 t->dev_instance = dev_instance; /* actual */
460 t->user_instance = user_instance; /* name */
466 key6.value = (u64) dev_instance;
468 clib_bihash_add_del_24_8 (&vxm->vxlan6_gbp_tunnel_by_key, &key6,
473 key4.value = (u64) dev_instance;
475 clib_bihash_add_del_16_8 (&vxm->vxlan4_gbp_tunnel_by_key, &key4,
481 pool_put (vxm->tunnels, t);
482 return VNET_API_ERROR_INVALID_REGISTRATION;
485 vxlan_gbp_register_udp_ports ();
487 t->hw_if_index = vnet_register_interface
488 (vnm, vxlan_gbp_device_class.index, dev_instance,
489 vxlan_gbp_hw_class.index, dev_instance);
490 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, t->hw_if_index);
492 /* Set vxlan_gbp tunnel output node */
493 u32 encap_index = !is_ip6 ?
494 vxlan4_gbp_encap_node.index : vxlan6_gbp_encap_node.index;
495 vnet_set_interface_output_node (vnm, t->hw_if_index, encap_index);
497 t->sw_if_index = sw_if_index = hi->sw_if_index;
499 if (VXLAN_GBP_TUNNEL_MODE_L3 == t->mode)
501 ip4_sw_interface_enable_disable (t->sw_if_index, 1);
502 ip6_sw_interface_enable_disable (t->sw_if_index, 1);
505 vec_validate_init_empty (vxm->tunnel_index_by_sw_if_index, sw_if_index,
507 vxm->tunnel_index_by_sw_if_index[sw_if_index] = dev_instance;
509 /* setup l2 input config with l2 feature and bd 0 to drop packet */
510 vec_validate (l2im->configs, sw_if_index);
511 l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
512 l2im->configs[sw_if_index].bd_index = 0;
514 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
515 si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
516 vnet_sw_interface_set_flags (vnm, sw_if_index,
517 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
519 fib_node_init (&t->node, FIB_NODE_TYPE_VXLAN_GBP_TUNNEL);
520 fib_prefix_t tun_dst_pfx;
521 vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
523 fib_prefix_from_ip46_addr (&t->dst, &tun_dst_pfx);
524 if (!ip46_address_is_multicast (&t->dst))
527 * source the FIB entry for the tunnel's destination
528 * and become a child thereof. The tunnel will then get poked
529 * when the forwarding for the entry updates, and the tunnel can
530 * re-stack accordingly
532 vtep_addr_ref (&t->src);
533 t->fib_entry_index = fib_entry_track (t->encap_fib_index,
535 FIB_NODE_TYPE_VXLAN_GBP_TUNNEL,
538 vxlan_gbp_tunnel_restack_dpo (t);
542 /* Multicast tunnel -
543 * as the same mcast group can be used for multiple mcast tunnels
544 * with different VNIs, create the output fib adjacency only if
545 * it does not already exist
547 fib_protocol_t fp = fib_ip_proto (is_ip6);
549 if (vtep_addr_ref (&t->dst) == 1)
551 fib_node_index_t mfei;
553 fib_route_path_t path = {
554 .frp_proto = fib_proto_to_dpo (fp),
555 .frp_addr = zero_addr,
556 .frp_sw_if_index = 0xffffffff,
559 .frp_flags = FIB_ROUTE_PATH_LOCAL,
560 .frp_mitf_flags = MFIB_ITF_FLAG_FORWARD,
562 const mfib_prefix_t mpfx = {
564 .fp_len = (is_ip6 ? 128 : 32),
565 .fp_grp_addr = tun_dst_pfx.fp_addr,
569 * Setup the (*,G) to receive traffic on the mcast group
570 * - the forwarding interface is for-us
571 * - the accepting interface is that from the API
573 mfib_table_entry_path_update (t->encap_fib_index,
575 MFIB_SOURCE_VXLAN_GBP, &path);
577 path.frp_sw_if_index = a->mcast_sw_if_index;
578 path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
579 path.frp_mitf_flags = MFIB_ITF_FLAG_ACCEPT;
580 mfei = mfib_table_entry_path_update (t->encap_fib_index,
582 MFIB_SOURCE_VXLAN_GBP,
586 * Create the mcast adjacency to send traffic to the group
588 ai = adj_mcast_add_or_lock (fp,
589 fib_proto_to_link (fp),
590 a->mcast_sw_if_index);
593 * create a new end-point
595 mcast_shared_add (&t->dst, mfei, ai);
598 dpo_id_t dpo = DPO_INVALID;
599 mcast_shared_t ep = mcast_shared_get (&t->dst);
601 /* Stack shared mcast dst mac addr rewrite on encap */
602 dpo_set (&dpo, DPO_ADJACENCY_MCAST,
603 fib_proto_to_dpo (fp), ep.mcast_adj_index);
605 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
607 flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
610 vnet_get_sw_interface (vnet_get_main (), sw_if_index)->flood_class =
615 /* deleting a tunnel: tunnel must exist */
617 return VNET_API_ERROR_NO_SUCH_ENTRY;
620 t = pool_elt_at_index (vxm->tunnels, instance);
622 sw_if_index = t->sw_if_index;
623 vnet_sw_interface_set_flags (vnm, sw_if_index, 0 /* down */ );
625 if (VXLAN_GBP_TUNNEL_MODE_L3 == t->mode)
627 ip4_sw_interface_enable_disable (t->sw_if_index, 0);
628 ip6_sw_interface_enable_disable (t->sw_if_index, 0);
631 vxm->tunnel_index_by_sw_if_index[sw_if_index] = ~0;
634 clib_bihash_add_del_16_8 (&vxm->vxlan4_gbp_tunnel_by_key, &key4,
637 clib_bihash_add_del_24_8 (&vxm->vxlan6_gbp_tunnel_by_key, &key6,
640 if (!ip46_address_is_multicast (&t->dst))
642 vtep_addr_unref (&t->src);
643 fib_entry_untrack (t->fib_entry_index, t->sibling_index);
645 else if (vtep_addr_unref (&t->dst) == 0)
647 mcast_shared_remove (&t->dst);
650 vxlan_gbp_unregister_udp_ports ();
651 vnet_delete_hw_interface (vnm, t->hw_if_index);
652 hash_unset (vxm->instance_used, t->user_instance);
654 fib_node_deinit (&t->node);
655 pool_put (vxm->tunnels, t);
659 *sw_if_indexp = sw_if_index;
665 vnet_vxlan_gbp_tunnel_del (u32 sw_if_index)
667 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
668 vxlan_gbp_tunnel_t *t = 0;
671 if (sw_if_index >= vec_len (vxm->tunnel_index_by_sw_if_index))
672 return VNET_API_ERROR_NO_SUCH_ENTRY;
674 ti = vxm->tunnel_index_by_sw_if_index[sw_if_index];
677 t = pool_elt_at_index (vxm->tunnels, ti);
679 vnet_vxlan_gbp_tunnel_add_del_args_t args = {
681 .is_ip6 = !ip46_address_is_ip4 (&t->src),
688 return (vnet_vxlan_gbp_tunnel_add_del (&args, NULL));
691 return VNET_API_ERROR_NO_SUCH_ENTRY;
695 get_decap_next_for_node (u32 node_index, u32 ipv4_set)
697 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
698 vlib_main_t *vm = vxm->vlib_main;
699 uword input_node = (ipv4_set) ? vxlan4_gbp_input_node.index :
700 vxlan6_gbp_input_node.index;
702 return vlib_node_add_next (vm, input_node, node_index);
706 unformat_decap_next (unformat_input_t * input, va_list * args)
708 u32 *result = va_arg (*args, u32 *);
709 u32 ipv4_set = va_arg (*args, int);
710 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
711 vlib_main_t *vm = vxm->vlib_main;
715 if (unformat (input, "l2"))
716 *result = VXLAN_GBP_INPUT_NEXT_L2_INPUT;
717 else if (unformat (input, "node %U", unformat_vlib_node, vm, &node_index))
718 *result = get_decap_next_for_node (node_index, ipv4_set);
719 else if (unformat (input, "%d", &tmp))
726 static clib_error_t *
727 vxlan_gbp_tunnel_add_del_command_fn (vlib_main_t * vm,
728 unformat_input_t * input,
729 vlib_cli_command_t * cmd)
731 unformat_input_t _line_input, *line_input = &_line_input;
732 ip46_address_t src = ip46_address_initializer, dst =
733 ip46_address_initializer;
734 vxlan_gbp_tunnel_mode_t mode = VXLAN_GBP_TUNNEL_MODE_L2;
742 u32 encap_fib_index = 0;
743 u32 mcast_sw_if_index = ~0;
744 u32 decap_next_index = VXLAN_GBP_INPUT_NEXT_L2_INPUT;
747 clib_error_t *parse_error = NULL;
749 /* Get a line of input. */
750 if (!unformat_user (input, unformat_line_input, line_input))
753 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
755 if (unformat (line_input, "del"))
759 else if (unformat (line_input, "instance %d", &instance))
761 else if (unformat (line_input, "src %U",
762 unformat_ip46_address, &src, IP46_TYPE_ANY))
765 ip46_address_is_ip4 (&src) ? (ipv4_set = 1) : (ipv6_set = 1);
767 else if (unformat (line_input, "dst %U",
768 unformat_ip46_address, &dst, IP46_TYPE_ANY))
771 ip46_address_is_ip4 (&dst) ? (ipv4_set = 1) : (ipv6_set = 1);
773 else if (unformat (line_input, "group %U %U",
774 unformat_ip46_address, &dst, IP46_TYPE_ANY,
775 unformat_vnet_sw_interface,
776 vnet_get_main (), &mcast_sw_if_index))
778 grp_set = dst_set = 1;
779 ip46_address_is_ip4 (&dst) ? (ipv4_set = 1) : (ipv6_set = 1);
781 else if (unformat (line_input, "encap-vrf-id %d", &table_id))
784 fib_table_find (fib_ip_proto (ipv6_set), table_id);
786 else if (unformat (line_input, "decap-next %U", unformat_decap_next,
787 &decap_next_index, ipv4_set))
789 else if (unformat (line_input, "vni %d", &vni))
793 parse_error = clib_error_return (0, "parse error: '%U'",
794 format_unformat_error, line_input);
799 unformat_free (line_input);
804 if (encap_fib_index == ~0)
805 return clib_error_return (0, "nonexistent encap-vrf-id %d", table_id);
808 return clib_error_return (0, "tunnel src address not specified");
811 return clib_error_return (0, "tunnel dst address not specified");
813 if (grp_set && !ip46_address_is_multicast (&dst))
814 return clib_error_return (0, "tunnel group address not multicast");
816 if (grp_set == 0 && ip46_address_is_multicast (&dst))
817 return clib_error_return (0, "dst address must be unicast");
819 if (grp_set && mcast_sw_if_index == ~0)
820 return clib_error_return (0, "tunnel nonexistent multicast device");
822 if (ipv4_set && ipv6_set)
823 return clib_error_return (0, "both IPv4 and IPv6 addresses specified");
825 if (ip46_address_cmp (&src, &dst) == 0)
826 return clib_error_return (0, "src and dst addresses are identical");
828 if (decap_next_index == ~0)
829 return clib_error_return (0, "next node not found");
832 return clib_error_return (0, "vni not specified");
835 return clib_error_return (0, "vni %d out of range", vni);
837 vnet_vxlan_gbp_tunnel_add_del_args_t a = {
840 .instance = instance,
846 u32 tunnel_sw_if_index;
847 int rv = vnet_vxlan_gbp_tunnel_add_del (&a, &tunnel_sw_if_index);
853 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
854 vnet_get_main (), tunnel_sw_if_index);
857 case VNET_API_ERROR_TUNNEL_EXIST:
858 return clib_error_return (0, "tunnel already exists...");
860 case VNET_API_ERROR_NO_SUCH_ENTRY:
861 return clib_error_return (0, "tunnel does not exist...");
863 case VNET_API_ERROR_INSTANCE_IN_USE:
864 return clib_error_return (0, "Instance is in use");
867 return clib_error_return
868 (0, "vnet_vxlan_gbp_tunnel_add_del returned %d", rv);
875 * Add or delete a VXLAN Tunnel.
877 * VXLAN provides the features needed to allow L2 bridge domains (BDs)
878 * to span multiple servers. This is done by building an L2 overlay on
879 * top of an L3 network underlay using VXLAN tunnels.
881 * This makes it possible for servers to be co-located in the same data
882 * center or be separated geographically as long as they are reachable
883 * through the underlay L3 network.
885 * You can refer to this kind of L2 overlay bridge domain as a VXLAN
886 * (Virtual eXtensible VLAN) segment.
889 * Example of how to create a VXLAN Tunnel:
890 * @cliexcmd{create vxlan_gbp tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 encap-vrf-id 7}
891 * Example of how to create a VXLAN Tunnel with a known name, vxlan_gbp_tunnel42:
892 * @cliexcmd{create vxlan_gbp tunnel src 10.0.3.1 dst 10.0.3.3 instance 42}
893 * Example of how to create a multicast VXLAN Tunnel with a known name, vxlan_gbp_tunnel23:
894 * @cliexcmd{create vxlan_gbp tunnel src 10.0.3.1 group 239.1.1.1 GigabitEthernet0/8/0 instance 23}
895 * Example of how to delete a VXLAN Tunnel:
896 * @cliexcmd{create vxlan_gbp tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 del}
899 VLIB_CLI_COMMAND (create_vxlan_gbp_tunnel_command, static) = {
900 .path = "create vxlan-gbp tunnel",
902 "create vxlan-gbp tunnel src <local-vtep-addr>"
903 " {dst <remote-vtep-addr>|group <mcast-vtep-addr> <intf-name>} vni <nn>"
905 " [encap-vrf-id <nn>] [decap-next [l2|node <name>]] [del]",
906 .function = vxlan_gbp_tunnel_add_del_command_fn,
910 static clib_error_t *
911 show_vxlan_gbp_tunnel_command_fn (vlib_main_t * vm,
912 unformat_input_t * input,
913 vlib_cli_command_t * cmd)
915 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
916 vxlan_gbp_tunnel_t *t;
919 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
921 if (unformat (input, "raw"))
924 return clib_error_return (0, "parse error: '%U'",
925 format_unformat_error, input);
928 if (pool_elts (vxm->tunnels) == 0)
929 vlib_cli_output (vm, "No vxlan-gbp tunnels configured...");
932 pool_foreach (t, vxm->tunnels,
934 vlib_cli_output (vm, "%U", format_vxlan_gbp_tunnel, t);
940 vlib_cli_output (vm, "Raw IPv4 Hash Table:\n%U\n",
941 format_bihash_16_8, &vxm->vxlan4_gbp_tunnel_by_key,
943 vlib_cli_output (vm, "Raw IPv6 Hash Table:\n%U\n",
944 format_bihash_24_8, &vxm->vxlan6_gbp_tunnel_by_key,
952 * Display all the VXLAN Tunnel entries.
955 * Example of how to display the VXLAN Tunnel entries:
956 * @cliexstart{show vxlan_gbp tunnel}
957 * [0] src 10.0.3.1 dst 10.0.3.3 vni 13 encap_fib_index 0 sw_if_index 5 decap_next l2
961 VLIB_CLI_COMMAND (show_vxlan_gbp_tunnel_command, static) = {
962 .path = "show vxlan-gbp tunnel",
963 .short_help = "show vxlan-gbp tunnel [raw]",
964 .function = show_vxlan_gbp_tunnel_command_fn,
970 vnet_int_vxlan_gbp_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable)
973 vnet_feature_enable_disable ("ip6-unicast", "ip6-vxlan-gbp-bypass",
974 sw_if_index, is_enable, 0, 0);
976 vnet_feature_enable_disable ("ip4-unicast", "ip4-vxlan-gbp-bypass",
977 sw_if_index, is_enable, 0, 0);
981 static clib_error_t *
982 set_ip_vxlan_gbp_bypass (u32 is_ip6,
983 unformat_input_t * input, vlib_cli_command_t * cmd)
985 unformat_input_t _line_input, *line_input = &_line_input;
986 vnet_main_t *vnm = vnet_get_main ();
987 clib_error_t *error = 0;
988 u32 sw_if_index, is_enable;
993 if (!unformat_user (input, unformat_line_input, line_input))
996 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
999 (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
1001 else if (unformat (line_input, "del"))
1005 error = unformat_parse_error (line_input);
1010 if (~0 == sw_if_index)
1012 error = clib_error_return (0, "unknown interface `%U'",
1013 format_unformat_error, line_input);
1017 vnet_int_vxlan_gbp_bypass_mode (sw_if_index, is_ip6, is_enable);
1020 unformat_free (line_input);
1025 static clib_error_t *
1026 set_ip4_vxlan_gbp_bypass (vlib_main_t * vm,
1027 unformat_input_t * input, vlib_cli_command_t * cmd)
1029 return set_ip_vxlan_gbp_bypass (0, input, cmd);
1033 * This command adds the 'ip4-vxlan-gbp-bypass' graph node for a given interface.
1034 * By adding the IPv4 vxlan_gbp-bypass graph node to an interface, the node checks
1035 * for and validate input vxlan_gbp packet and bypass ip4-lookup, ip4-local,
1036 * ip4-udp-lookup nodes to speedup vxlan_gbp packet forwarding. This node will
1037 * cause extra overhead to for non-vxlan_gbp packets which is kept at a minimum.
1041 * Example of graph node before ip4-vxlan_gbp-bypass is enabled:
1042 * @cliexstart{show vlib graph ip4-vxlan_gbp-bypass}
1043 * Name Next Previous
1044 * ip4-vxlan-gbp-bypass error-drop [0]
1045 * vxlan4-gbp-input [1]
1049 * Example of how to enable ip4-vxlan-gbp-bypass on an interface:
1050 * @cliexcmd{set interface ip vxlan-gbp-bypass GigabitEthernet2/0/0}
1052 * Example of graph node after ip4-vxlan-gbp-bypass is enabled:
1053 * @cliexstart{show vlib graph ip4-vxlan-gbp-bypass}
1054 * Name Next Previous
1055 * ip4-vxlan-gbp-bypass error-drop [0] ip4-input
1056 * vxlan4-gbp-input [1] ip4-input-no-checksum
1060 * Example of how to display the feature enabled on an interface:
1061 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1062 * IP feature paths configured on GigabitEthernet2/0/0...
1065 * ip4-vxlan-gbp-bypass
1070 * Example of how to disable ip4-vxlan-gbp-bypass on an interface:
1071 * @cliexcmd{set interface ip vxlan-gbp-bypass GigabitEthernet2/0/0 del}
1075 VLIB_CLI_COMMAND (set_interface_ip_vxlan_gbp_bypass_command, static) = {
1076 .path = "set interface ip vxlan-gbp-bypass",
1077 .function = set_ip4_vxlan_gbp_bypass,
1078 .short_help = "set interface ip vxlan-gbp-bypass <interface> [del]",
1082 static clib_error_t *
1083 set_ip6_vxlan_gbp_bypass (vlib_main_t * vm,
1084 unformat_input_t * input, vlib_cli_command_t * cmd)
1086 return set_ip_vxlan_gbp_bypass (1, input, cmd);
1090 * This command adds the 'ip6-vxlan-gbp-bypass' graph node for a given interface.
1091 * By adding the IPv6 vxlan-gbp-bypass graph node to an interface, the node checks
1092 * for and validate input vxlan_gbp packet and bypass ip6-lookup, ip6-local,
1093 * ip6-udp-lookup nodes to speedup vxlan_gbp packet forwarding. This node will
1094 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
1098 * Example of graph node before ip6-vxlan-gbp-bypass is enabled:
1099 * @cliexstart{show vlib graph ip6-vxlan-gbp-bypass}
1100 * Name Next Previous
1101 * ip6-vxlan-gbp-bypass error-drop [0]
1102 * vxlan6-gbp-input [1]
1106 * Example of how to enable ip6-vxlan-gbp-bypass on an interface:
1107 * @cliexcmd{set interface ip6 vxlan-gbp-bypass GigabitEthernet2/0/0}
1109 * Example of graph node after ip6-vxlan-gbp-bypass is enabled:
1110 * @cliexstart{show vlib graph ip6-vxlan-gbp-bypass}
1111 * Name Next Previous
1112 * ip6-vxlan-gbp-bypass error-drop [0] ip6-input
1113 * vxlan6-gbp-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 * ip6-vxlan-gbp-bypass
1127 * Example of how to disable ip6-vxlan-gbp-bypass on an interface:
1128 * @cliexcmd{set interface ip6 vxlan-gbp-bypass GigabitEthernet2/0/0 del}
1132 VLIB_CLI_COMMAND (set_interface_ip6_vxlan_gbp_bypass_command, static) = {
1133 .path = "set interface ip6 vxlan-gbp-bypass",
1134 .function = set_ip6_vxlan_gbp_bypass,
1135 .short_help = "set interface ip vxlan-gbp-bypass <interface> [del]",
1139 #define VXLAN_GBP_HASH_NUM_BUCKETS (2 * 1024)
1140 #define VXLAN_GBP_HASH_MEMORY_SIZE (1 << 20)
1143 vxlan_gbp_init (vlib_main_t * vm)
1145 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
1147 vxm->vnet_main = vnet_get_main ();
1148 vxm->vlib_main = vm;
1150 /* initialize the ip6 hash */
1151 clib_bihash_init_16_8 (&vxm->vxlan4_gbp_tunnel_by_key, "vxlan4-gbp",
1152 VXLAN_GBP_HASH_NUM_BUCKETS,
1153 VXLAN_GBP_HASH_MEMORY_SIZE);
1154 clib_bihash_init_24_8 (&vxm->vxlan6_gbp_tunnel_by_key, "vxlan6-gbp",
1155 VXLAN_GBP_HASH_NUM_BUCKETS,
1156 VXLAN_GBP_HASH_MEMORY_SIZE);
1157 vxm->vtep6 = hash_create_mem (0, sizeof (ip6_address_t), sizeof (uword));
1158 vxm->mcast_shared = hash_create_mem (0,
1159 sizeof (ip46_address_t),
1160 sizeof (mcast_shared_t));
1162 fib_node_register_type (FIB_NODE_TYPE_VXLAN_GBP_TUNNEL, &vxlan_gbp_vft);
1164 punt_hdl = vlib_punt_client_register ("vxlan-gbp");
1166 vlib_punt_reason_alloc (punt_hdl,
1167 "VXLAN-GBP-no-such-v4-tunnel",
1168 &vxm->punt_no_such_tunnel[FIB_PROTOCOL_IP4]);
1169 vlib_punt_reason_alloc (punt_hdl,
1170 "VXLAN-GBP-no-such-v6-tunnel",
1171 &vxm->punt_no_such_tunnel[FIB_PROTOCOL_IP6]);
1177 VLIB_INIT_FUNCTION (vxlan_gbp_init) =
1179 .runs_after = VLIB_INITS("punt_init"),
1184 * fd.io coding-style-patch-verification: ON
1187 * eval: (c-set-style "gnu")