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/ip/punt.h>
18 #include <vnet/fib/fib_entry.h>
19 #include <vnet/fib/fib_table.h>
20 #include <vnet/fib/fib_entry_track.h>
21 #include <vnet/mfib/mfib_table.h>
22 #include <vnet/adj/adj_mcast.h>
23 #include <vnet/adj/rewrite.h>
24 #include <vnet/interface.h>
25 #include <vlib/vlib.h>
31 * VXLAN GBP provides the features of vxlan and carry group policy id.
33 static vlib_punt_hdl_t punt_hdl;
35 vxlan_gbp_main_t vxlan_gbp_main;
38 format_vxlan_gbp_tunnel_mode (u8 * s, va_list * args)
40 vxlan_gbp_tunnel_mode_t mode = va_arg (*args, vxlan_gbp_tunnel_mode_t);
44 case VXLAN_GBP_TUNNEL_MODE_L2:
47 case VXLAN_GBP_TUNNEL_MODE_L3:
55 format_vxlan_gbp_tunnel (u8 * s, va_list * args)
57 vxlan_gbp_tunnel_t *t = va_arg (*args, vxlan_gbp_tunnel_t *);
60 "[%d] instance %d src %U dst %U vni %d fib-idx %d"
61 " sw-if-idx %d mode %U ",
62 t->dev_instance, t->user_instance,
63 format_ip46_address, &t->src, IP46_TYPE_ANY,
64 format_ip46_address, &t->dst, IP46_TYPE_ANY,
65 t->vni, t->encap_fib_index, t->sw_if_index,
66 format_vxlan_gbp_tunnel_mode, t->mode);
68 s = format (s, "encap-dpo-idx %d ", t->next_dpo.dpoi_index);
70 if (PREDICT_FALSE (ip46_address_is_multicast (&t->dst)))
71 s = format (s, "mcast-sw-if-idx %d ", t->mcast_sw_if_index);
77 format_vxlan_gbp_name (u8 * s, va_list * args)
79 u32 dev_instance = va_arg (*args, u32);
80 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
81 vxlan_gbp_tunnel_t *t;
83 if (dev_instance == ~0)
84 return format (s, "<cached-unused>");
86 if (dev_instance >= vec_len (vxm->tunnels))
87 return format (s, "<improperly-referenced>");
89 t = pool_elt_at_index (vxm->tunnels, dev_instance);
91 return format (s, "vxlan_gbp_tunnel%d", t->user_instance);
95 vxlan_gbp_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index,
98 u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
99 VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
100 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
102 return /* no error */ 0;
106 VNET_DEVICE_CLASS (vxlan_gbp_device_class, static) = {
108 .format_device_name = format_vxlan_gbp_name,
109 .format_tx_trace = format_vxlan_gbp_encap_trace,
110 .admin_up_down_function = vxlan_gbp_interface_admin_up_down,
115 format_vxlan_gbp_header_with_length (u8 * s, va_list * args)
117 u32 dev_instance = va_arg (*args, u32);
118 s = format (s, "unimplemented dev %u", dev_instance);
123 VNET_HW_INTERFACE_CLASS (vxlan_gbp_hw_class) = {
125 .format_header = format_vxlan_gbp_header_with_length,
126 .build_rewrite = default_build_rewrite,
131 vxlan_gbp_tunnel_restack_dpo (vxlan_gbp_tunnel_t * t)
133 u8 is_ip4 = ip46_address_is_ip4 (&t->dst);
134 dpo_id_t dpo = DPO_INVALID;
135 fib_forward_chain_type_t forw_type = is_ip4 ?
136 FIB_FORW_CHAIN_TYPE_UNICAST_IP4 : FIB_FORW_CHAIN_TYPE_UNICAST_IP6;
138 fib_entry_contribute_forwarding (t->fib_entry_index, forw_type, &dpo);
140 /* vxlan_gbp uses the payload hash as the udp source port
141 * hence the packet's hash is unknown
142 * skip single bucket load balance dpo's */
143 while (DPO_LOAD_BALANCE == dpo.dpoi_type)
145 load_balance_t *lb = load_balance_get (dpo.dpoi_index);
146 if (lb->lb_n_buckets > 1)
149 dpo_copy (&dpo, load_balance_get_bucket_i (lb, 0));
152 u32 encap_index = is_ip4 ?
153 vxlan4_gbp_encap_node.index : vxlan6_gbp_encap_node.index;
154 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
158 static vxlan_gbp_tunnel_t *
159 vxlan_gbp_tunnel_from_fib_node (fib_node_t * node)
161 ASSERT (FIB_NODE_TYPE_VXLAN_GBP_TUNNEL == node->fn_type);
162 return ((vxlan_gbp_tunnel_t *) (((char *) node) -
163 STRUCT_OFFSET_OF (vxlan_gbp_tunnel_t,
168 * Function definition to backwalk a FIB node -
169 * Here we will restack the new dpo of VXLAN DIP to encap node.
171 static fib_node_back_walk_rc_t
172 vxlan_gbp_tunnel_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
174 vxlan_gbp_tunnel_restack_dpo (vxlan_gbp_tunnel_from_fib_node (node));
175 return (FIB_NODE_BACK_WALK_CONTINUE);
179 * Function definition to get a FIB node from its index
182 vxlan_gbp_tunnel_fib_node_get (fib_node_index_t index)
184 vxlan_gbp_tunnel_t *t;
185 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
187 t = pool_elt_at_index (vxm->tunnels, index);
193 * Function definition to inform the FIB node that its last lock has gone.
196 vxlan_gbp_tunnel_last_lock_gone (fib_node_t * node)
199 * The VXLAN GBP tunnel is a root of the graph. As such
200 * it never has children and thus is never locked.
206 * Virtual function table registered by VXLAN GBP tunnels
207 * for participation in the FIB object graph.
209 const static fib_node_vft_t vxlan_gbp_vft = {
210 .fnv_get = vxlan_gbp_tunnel_fib_node_get,
211 .fnv_last_lock = vxlan_gbp_tunnel_last_lock_gone,
212 .fnv_back_walk = vxlan_gbp_tunnel_back_walk,
216 #define foreach_copy_field \
219 _(mcast_sw_if_index) \
225 vxlan_gbp_rewrite (vxlan_gbp_tunnel_t * t, bool is_ip6)
229 ip4_vxlan_gbp_header_t h4;
230 ip6_vxlan_gbp_header_t h6;
232 int len = is_ip6 ? sizeof h.h6 : sizeof h.h4;
235 vxlan_gbp_header_t *vxlan_gbp;
236 /* Fixed portion of the (outer) ip header */
238 clib_memset (&h, 0, sizeof (h));
241 ip4_header_t *ip = &h.h4.ip4;
242 udp = &h.h4.udp, vxlan_gbp = &h.h4.vxlan_gbp;
243 ip->ip_version_and_header_length = 0x45;
245 ip->protocol = IP_PROTOCOL_UDP;
247 ip->src_address = t->src.ip4;
248 ip->dst_address = t->dst.ip4;
250 /* we fix up the ip4 header length and checksum after-the-fact */
251 ip->checksum = ip4_header_checksum (ip);
255 ip6_header_t *ip = &h.h6.ip6;
256 udp = &h.h6.udp, vxlan_gbp = &h.h6.vxlan_gbp;
257 ip->ip_version_traffic_class_and_flow_label =
258 clib_host_to_net_u32 (6 << 28);
260 ip->protocol = IP_PROTOCOL_UDP;
262 ip->src_address = t->src.ip6;
263 ip->dst_address = t->dst.ip6;
266 /* UDP header, randomize src port on something, maybe? */
267 udp->src_port = clib_host_to_net_u16 (47789);
268 udp->dst_port = clib_host_to_net_u16 (UDP_DST_PORT_vxlan_gbp);
271 vxlan_gbp_set_header (vxlan_gbp, t->vni);
272 vnet_rewrite_set_data (*t, &h, len);
276 vtep_addr_ref (ip46_address_t * ip)
278 uword *vtep = ip46_address_is_ip4 (ip) ?
279 hash_get (vxlan_gbp_main.vtep4, ip->ip4.as_u32) :
280 hash_get_mem (vxlan_gbp_main.vtep6, &ip->ip6);
283 ip46_address_is_ip4 (ip) ?
284 hash_set (vxlan_gbp_main.vtep4, ip->ip4.as_u32, 1) :
285 hash_set_mem_alloc (&vxlan_gbp_main.vtep6, &ip->ip6, 1);
290 vtep_addr_unref (ip46_address_t * ip)
292 uword *vtep = ip46_address_is_ip4 (ip) ?
293 hash_get (vxlan_gbp_main.vtep4, ip->ip4.as_u32) :
294 hash_get_mem (vxlan_gbp_main.vtep6, &ip->ip6);
295 ALWAYS_ASSERT (vtep);
298 ip46_address_is_ip4 (ip) ?
299 hash_unset (vxlan_gbp_main.vtep4, ip->ip4.as_u32) :
300 hash_unset_mem_free (&vxlan_gbp_main.vtep6, &ip->ip6);
305 typedef CLIB_PACKED(union
309 fib_node_index_t mfib_entry_index;
310 adj_index_t mcast_adj_index;
316 static inline mcast_shared_t
317 mcast_shared_get (ip46_address_t * ip)
319 ASSERT (ip46_address_is_multicast (ip));
320 uword *p = hash_get_mem (vxlan_gbp_main.mcast_shared, ip);
322 mcast_shared_t ret = {.as_u64 = *p };
327 mcast_shared_add (ip46_address_t * dst, fib_node_index_t mfei, adj_index_t ai)
329 mcast_shared_t new_ep = {
330 .mcast_adj_index = ai,
331 .mfib_entry_index = mfei,
334 hash_set_mem_alloc (&vxlan_gbp_main.mcast_shared, dst, new_ep.as_u64);
338 mcast_shared_remove (ip46_address_t * dst)
340 mcast_shared_t ep = mcast_shared_get (dst);
342 adj_unlock (ep.mcast_adj_index);
343 mfib_table_entry_delete_index (ep.mfib_entry_index, MFIB_SOURCE_VXLAN_GBP);
345 hash_unset_mem_free (&vxlan_gbp_main.mcast_shared, dst);
349 vxlan_gbp_register_udp_ports (void)
351 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
353 if (vxm->udp_ports_registered == 0)
355 udp_register_dst_port (vxm->vlib_main, UDP_DST_PORT_vxlan_gbp,
356 vxlan4_gbp_input_node.index, /* is_ip4 */ 1);
357 udp_register_dst_port (vxm->vlib_main, UDP_DST_PORT_vxlan6_gbp,
358 vxlan6_gbp_input_node.index, /* is_ip4 */ 0);
361 * Counts the number of vxlan_gbp tunnels
363 vxm->udp_ports_registered += 1;
367 vxlan_gbp_unregister_udp_ports (void)
369 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
371 ASSERT (vxm->udp_ports_registered != 0);
373 if (vxm->udp_ports_registered == 1)
375 udp_unregister_dst_port (vxm->vlib_main, UDP_DST_PORT_vxlan_gbp,
377 udp_unregister_dst_port (vxm->vlib_main, UDP_DST_PORT_vxlan6_gbp,
381 vxm->udp_ports_registered -= 1;
384 int vnet_vxlan_gbp_tunnel_add_del
385 (vnet_vxlan_gbp_tunnel_add_del_args_t * a, u32 * sw_if_indexp)
387 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
388 vxlan_gbp_tunnel_t *t = 0;
389 vnet_main_t *vnm = vxm->vnet_main;
391 u32 sw_if_index = ~0;
392 vxlan4_gbp_tunnel_key_t key4;
393 vxlan6_gbp_tunnel_key_t key6;
394 u32 is_ip6 = a->is_ip6;
399 key4.key[0] = ip46_address_is_multicast (&a->dst) ?
401 a->dst.ip4.as_u32 | (((u64) a->src.ip4.as_u32) << 32);
402 key4.key[1] = (((u64) a->encap_fib_index) << 32)
403 | clib_host_to_net_u32 (a->vni << 8);
405 clib_bihash_search_inline_16_8 (&vxm->vxlan4_gbp_tunnel_by_key,
411 key6.key[0] = a->dst.ip6.as_u64[0];
412 key6.key[1] = a->dst.ip6.as_u64[1];
413 key6.key[2] = (((u64) a->encap_fib_index) << 32)
414 | clib_host_to_net_u32 (a->vni << 8);
416 clib_bihash_search_inline_24_8 (&vxm->vxlan6_gbp_tunnel_by_key,
426 l2input_main_t *l2im = &l2input_main;
427 u32 dev_instance; /* real dev instance tunnel index */
428 u32 user_instance; /* request and actual instance number */
430 /* adding a tunnel: tunnel must not already exist */
433 t = pool_elt_at_index (vxm->tunnels, *p);
434 *sw_if_indexp = t->sw_if_index;
435 return VNET_API_ERROR_TUNNEL_EXIST;
437 pool_get_aligned (vxm->tunnels, t, CLIB_CACHE_LINE_BYTES);
438 clib_memset (t, 0, sizeof (*t));
439 dev_instance = t - vxm->tunnels;
441 /* copy from arg structure */
442 #define _(x) t->x = a->x;
446 vxlan_gbp_rewrite (t, is_ip6);
448 * Reconcile the real dev_instance and a possible requested instance.
450 user_instance = a->instance;
451 if (user_instance == ~0)
452 user_instance = dev_instance;
453 if (hash_get (vxm->instance_used, user_instance))
455 pool_put (vxm->tunnels, t);
456 return VNET_API_ERROR_INSTANCE_IN_USE;
458 hash_set (vxm->instance_used, user_instance, 1);
460 t->dev_instance = dev_instance; /* actual */
461 t->user_instance = user_instance; /* name */
467 key6.value = (u64) dev_instance;
469 clib_bihash_add_del_24_8 (&vxm->vxlan6_gbp_tunnel_by_key, &key6,
474 key4.value = (u64) dev_instance;
476 clib_bihash_add_del_16_8 (&vxm->vxlan4_gbp_tunnel_by_key, &key4,
482 pool_put (vxm->tunnels, t);
483 return VNET_API_ERROR_INVALID_REGISTRATION;
486 vxlan_gbp_register_udp_ports ();
488 t->hw_if_index = vnet_register_interface
489 (vnm, vxlan_gbp_device_class.index, dev_instance,
490 vxlan_gbp_hw_class.index, dev_instance);
491 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, t->hw_if_index);
493 /* Set vxlan_gbp tunnel output node */
494 u32 encap_index = !is_ip6 ?
495 vxlan4_gbp_encap_node.index : vxlan6_gbp_encap_node.index;
496 vnet_set_interface_output_node (vnm, t->hw_if_index, encap_index);
498 t->sw_if_index = sw_if_index = hi->sw_if_index;
500 if (VXLAN_GBP_TUNNEL_MODE_L3 == t->mode)
502 ip4_sw_interface_enable_disable (t->sw_if_index, 1);
503 ip6_sw_interface_enable_disable (t->sw_if_index, 1);
506 vec_validate_init_empty (vxm->tunnel_index_by_sw_if_index, sw_if_index,
508 vxm->tunnel_index_by_sw_if_index[sw_if_index] = dev_instance;
510 /* setup l2 input config with l2 feature and bd 0 to drop packet */
511 vec_validate (l2im->configs, sw_if_index);
512 l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
513 l2im->configs[sw_if_index].bd_index = 0;
515 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
516 si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
517 vnet_sw_interface_set_flags (vnm, sw_if_index,
518 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
520 fib_node_init (&t->node, FIB_NODE_TYPE_VXLAN_GBP_TUNNEL);
521 fib_prefix_t tun_dst_pfx;
522 vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
524 fib_prefix_from_ip46_addr (&t->dst, &tun_dst_pfx);
525 if (!ip46_address_is_multicast (&t->dst))
528 * source the FIB entry for the tunnel's destination
529 * and become a child thereof. The tunnel will then get poked
530 * when the forwarding for the entry updates, and the tunnel can
531 * re-stack accordingly
533 vtep_addr_ref (&t->src);
534 t->fib_entry_index = fib_entry_track (t->encap_fib_index,
536 FIB_NODE_TYPE_VXLAN_GBP_TUNNEL,
539 vxlan_gbp_tunnel_restack_dpo (t);
543 /* Multicast tunnel -
544 * as the same mcast group can be used for multiple mcast tunnels
545 * with different VNIs, create the output fib adjacency only if
546 * it does not already exist
548 fib_protocol_t fp = fib_ip_proto (is_ip6);
550 if (vtep_addr_ref (&t->dst) == 1)
552 fib_node_index_t mfei;
554 fib_route_path_t path = {
555 .frp_proto = fib_proto_to_dpo (fp),
556 .frp_addr = zero_addr,
557 .frp_sw_if_index = 0xffffffff,
560 .frp_flags = FIB_ROUTE_PATH_LOCAL,
561 .frp_mitf_flags = MFIB_ITF_FLAG_FORWARD,
563 const mfib_prefix_t mpfx = {
565 .fp_len = (is_ip6 ? 128 : 32),
566 .fp_grp_addr = tun_dst_pfx.fp_addr,
570 * Setup the (*,G) to receive traffic on the mcast group
571 * - the forwarding interface is for-us
572 * - the accepting interface is that from the API
574 mfib_table_entry_path_update (t->encap_fib_index,
576 MFIB_SOURCE_VXLAN_GBP, &path);
578 path.frp_sw_if_index = a->mcast_sw_if_index;
579 path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
580 path.frp_mitf_flags = MFIB_ITF_FLAG_ACCEPT;
581 mfei = mfib_table_entry_path_update (t->encap_fib_index,
583 MFIB_SOURCE_VXLAN_GBP,
587 * Create the mcast adjacency to send traffic to the group
589 ai = adj_mcast_add_or_lock (fp,
590 fib_proto_to_link (fp),
591 a->mcast_sw_if_index);
594 * create a new end-point
596 mcast_shared_add (&t->dst, mfei, ai);
599 dpo_id_t dpo = DPO_INVALID;
600 mcast_shared_t ep = mcast_shared_get (&t->dst);
602 /* Stack shared mcast dst mac addr rewrite on encap */
603 dpo_set (&dpo, DPO_ADJACENCY_MCAST,
604 fib_proto_to_dpo (fp), ep.mcast_adj_index);
606 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
608 flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
611 vnet_get_sw_interface (vnet_get_main (), sw_if_index)->flood_class =
616 /* deleting a tunnel: tunnel must exist */
618 return VNET_API_ERROR_NO_SUCH_ENTRY;
621 t = pool_elt_at_index (vxm->tunnels, instance);
623 sw_if_index = t->sw_if_index;
624 vnet_sw_interface_set_flags (vnm, sw_if_index, 0 /* down */ );
626 if (VXLAN_GBP_TUNNEL_MODE_L3 == t->mode)
628 ip4_sw_interface_enable_disable (t->sw_if_index, 0);
629 ip6_sw_interface_enable_disable (t->sw_if_index, 0);
632 vxm->tunnel_index_by_sw_if_index[sw_if_index] = ~0;
635 clib_bihash_add_del_16_8 (&vxm->vxlan4_gbp_tunnel_by_key, &key4,
638 clib_bihash_add_del_24_8 (&vxm->vxlan6_gbp_tunnel_by_key, &key6,
641 if (!ip46_address_is_multicast (&t->dst))
643 vtep_addr_unref (&t->src);
644 fib_entry_untrack (t->fib_entry_index, t->sibling_index);
646 else if (vtep_addr_unref (&t->dst) == 0)
648 mcast_shared_remove (&t->dst);
651 vxlan_gbp_unregister_udp_ports ();
652 vnet_delete_hw_interface (vnm, t->hw_if_index);
653 hash_unset (vxm->instance_used, t->user_instance);
655 fib_node_deinit (&t->node);
656 pool_put (vxm->tunnels, t);
660 *sw_if_indexp = sw_if_index;
666 vnet_vxlan_gbp_tunnel_del (u32 sw_if_index)
668 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
669 vxlan_gbp_tunnel_t *t = 0;
672 if (sw_if_index >= vec_len (vxm->tunnel_index_by_sw_if_index))
673 return VNET_API_ERROR_NO_SUCH_ENTRY;
675 ti = vxm->tunnel_index_by_sw_if_index[sw_if_index];
678 t = pool_elt_at_index (vxm->tunnels, ti);
680 vnet_vxlan_gbp_tunnel_add_del_args_t args = {
682 .is_ip6 = !ip46_address_is_ip4 (&t->src),
689 return (vnet_vxlan_gbp_tunnel_add_del (&args, NULL));
692 return VNET_API_ERROR_NO_SUCH_ENTRY;
696 get_decap_next_for_node (u32 node_index, u32 ipv4_set)
698 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
699 vlib_main_t *vm = vxm->vlib_main;
700 uword input_node = (ipv4_set) ? vxlan4_gbp_input_node.index :
701 vxlan6_gbp_input_node.index;
703 return vlib_node_add_next (vm, input_node, node_index);
707 unformat_decap_next (unformat_input_t * input, va_list * args)
709 u32 *result = va_arg (*args, u32 *);
710 u32 ipv4_set = va_arg (*args, int);
711 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
712 vlib_main_t *vm = vxm->vlib_main;
716 if (unformat (input, "l2"))
717 *result = VXLAN_GBP_INPUT_NEXT_L2_INPUT;
718 else if (unformat (input, "node %U", unformat_vlib_node, vm, &node_index))
719 *result = get_decap_next_for_node (node_index, ipv4_set);
720 else if (unformat (input, "%d", &tmp))
727 static clib_error_t *
728 vxlan_gbp_tunnel_add_del_command_fn (vlib_main_t * vm,
729 unformat_input_t * input,
730 vlib_cli_command_t * cmd)
732 unformat_input_t _line_input, *line_input = &_line_input;
733 ip46_address_t src = ip46_address_initializer, dst =
734 ip46_address_initializer;
735 vxlan_gbp_tunnel_mode_t mode = VXLAN_GBP_TUNNEL_MODE_L2;
743 u32 encap_fib_index = 0;
744 u32 mcast_sw_if_index = ~0;
745 u32 decap_next_index = VXLAN_GBP_INPUT_NEXT_L2_INPUT;
748 clib_error_t *parse_error = NULL;
750 /* Get a line of input. */
751 if (!unformat_user (input, unformat_line_input, line_input))
754 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
756 if (unformat (line_input, "del"))
760 else if (unformat (line_input, "instance %d", &instance))
762 else if (unformat (line_input, "src %U",
763 unformat_ip46_address, &src, IP46_TYPE_ANY))
766 ip46_address_is_ip4 (&src) ? (ipv4_set = 1) : (ipv6_set = 1);
768 else if (unformat (line_input, "dst %U",
769 unformat_ip46_address, &dst, IP46_TYPE_ANY))
772 ip46_address_is_ip4 (&dst) ? (ipv4_set = 1) : (ipv6_set = 1);
774 else if (unformat (line_input, "group %U %U",
775 unformat_ip46_address, &dst, IP46_TYPE_ANY,
776 unformat_vnet_sw_interface,
777 vnet_get_main (), &mcast_sw_if_index))
779 grp_set = dst_set = 1;
780 ip46_address_is_ip4 (&dst) ? (ipv4_set = 1) : (ipv6_set = 1);
782 else if (unformat (line_input, "encap-vrf-id %d", &table_id))
785 fib_table_find (fib_ip_proto (ipv6_set), table_id);
787 else if (unformat (line_input, "decap-next %U", unformat_decap_next,
788 &decap_next_index, ipv4_set))
790 else if (unformat (line_input, "vni %d", &vni))
794 parse_error = clib_error_return (0, "parse error: '%U'",
795 format_unformat_error, line_input);
800 unformat_free (line_input);
805 if (encap_fib_index == ~0)
806 return clib_error_return (0, "nonexistent encap-vrf-id %d", table_id);
809 return clib_error_return (0, "tunnel src address not specified");
812 return clib_error_return (0, "tunnel dst address not specified");
814 if (grp_set && !ip46_address_is_multicast (&dst))
815 return clib_error_return (0, "tunnel group address not multicast");
817 if (grp_set == 0 && ip46_address_is_multicast (&dst))
818 return clib_error_return (0, "dst address must be unicast");
820 if (grp_set && mcast_sw_if_index == ~0)
821 return clib_error_return (0, "tunnel nonexistent multicast device");
823 if (ipv4_set && ipv6_set)
824 return clib_error_return (0, "both IPv4 and IPv6 addresses specified");
826 if (ip46_address_cmp (&src, &dst) == 0)
827 return clib_error_return (0, "src and dst addresses are identical");
829 if (decap_next_index == ~0)
830 return clib_error_return (0, "next node not found");
833 return clib_error_return (0, "vni not specified");
836 return clib_error_return (0, "vni %d out of range", vni);
838 vnet_vxlan_gbp_tunnel_add_del_args_t a = {
841 .instance = instance,
847 u32 tunnel_sw_if_index;
848 int rv = vnet_vxlan_gbp_tunnel_add_del (&a, &tunnel_sw_if_index);
854 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
855 vnet_get_main (), tunnel_sw_if_index);
858 case VNET_API_ERROR_TUNNEL_EXIST:
859 return clib_error_return (0, "tunnel already exists...");
861 case VNET_API_ERROR_NO_SUCH_ENTRY:
862 return clib_error_return (0, "tunnel does not exist...");
864 case VNET_API_ERROR_INSTANCE_IN_USE:
865 return clib_error_return (0, "Instance is in use");
868 return clib_error_return
869 (0, "vnet_vxlan_gbp_tunnel_add_del returned %d", rv);
876 * Add or delete a VXLAN Tunnel.
878 * VXLAN provides the features needed to allow L2 bridge domains (BDs)
879 * to span multiple servers. This is done by building an L2 overlay on
880 * top of an L3 network underlay using VXLAN tunnels.
882 * This makes it possible for servers to be co-located in the same data
883 * center or be separated geographically as long as they are reachable
884 * through the underlay L3 network.
886 * You can refer to this kind of L2 overlay bridge domain as a VXLAN
887 * (Virtual eXtensible VLAN) segment.
890 * Example of how to create a VXLAN Tunnel:
891 * @cliexcmd{create vxlan_gbp tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 encap-vrf-id 7}
892 * Example of how to create a VXLAN Tunnel with a known name, vxlan_gbp_tunnel42:
893 * @cliexcmd{create vxlan_gbp tunnel src 10.0.3.1 dst 10.0.3.3 instance 42}
894 * Example of how to create a multicast VXLAN Tunnel with a known name, vxlan_gbp_tunnel23:
895 * @cliexcmd{create vxlan_gbp tunnel src 10.0.3.1 group 239.1.1.1 GigabitEthernet0/8/0 instance 23}
896 * Example of how to delete a VXLAN Tunnel:
897 * @cliexcmd{create vxlan_gbp tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 del}
900 VLIB_CLI_COMMAND (create_vxlan_gbp_tunnel_command, static) = {
901 .path = "create vxlan-gbp tunnel",
903 "create vxlan-gbp tunnel src <local-vtep-addr>"
904 " {dst <remote-vtep-addr>|group <mcast-vtep-addr> <intf-name>} vni <nn>"
906 " [encap-vrf-id <nn>] [decap-next [l2|node <name>]] [del]",
907 .function = vxlan_gbp_tunnel_add_del_command_fn,
911 static clib_error_t *
912 show_vxlan_gbp_tunnel_command_fn (vlib_main_t * vm,
913 unformat_input_t * input,
914 vlib_cli_command_t * cmd)
916 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
917 vxlan_gbp_tunnel_t *t;
920 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
922 if (unformat (input, "raw"))
925 return clib_error_return (0, "parse error: '%U'",
926 format_unformat_error, input);
929 if (pool_elts (vxm->tunnels) == 0)
930 vlib_cli_output (vm, "No vxlan-gbp tunnels configured...");
933 pool_foreach (t, vxm->tunnels)
935 vlib_cli_output (vm, "%U", format_vxlan_gbp_tunnel, t);
941 vlib_cli_output (vm, "Raw IPv4 Hash Table:\n%U\n",
942 format_bihash_16_8, &vxm->vxlan4_gbp_tunnel_by_key,
944 vlib_cli_output (vm, "Raw IPv6 Hash Table:\n%U\n",
945 format_bihash_24_8, &vxm->vxlan6_gbp_tunnel_by_key,
953 * Display all the VXLAN Tunnel entries.
956 * Example of how to display the VXLAN Tunnel entries:
957 * @cliexstart{show vxlan_gbp tunnel}
958 * [0] src 10.0.3.1 dst 10.0.3.3 vni 13 encap_fib_index 0 sw_if_index 5 decap_next l2
962 VLIB_CLI_COMMAND (show_vxlan_gbp_tunnel_command, static) = {
963 .path = "show vxlan-gbp tunnel",
964 .short_help = "show vxlan-gbp tunnel [raw]",
965 .function = show_vxlan_gbp_tunnel_command_fn,
971 vnet_int_vxlan_gbp_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable)
974 vnet_feature_enable_disable ("ip6-unicast", "ip6-vxlan-gbp-bypass",
975 sw_if_index, is_enable, 0, 0);
977 vnet_feature_enable_disable ("ip4-unicast", "ip4-vxlan-gbp-bypass",
978 sw_if_index, is_enable, 0, 0);
982 static clib_error_t *
983 set_ip_vxlan_gbp_bypass (u32 is_ip6,
984 unformat_input_t * input, vlib_cli_command_t * cmd)
986 unformat_input_t _line_input, *line_input = &_line_input;
987 vnet_main_t *vnm = vnet_get_main ();
988 clib_error_t *error = 0;
989 u32 sw_if_index, is_enable;
994 if (!unformat_user (input, unformat_line_input, line_input))
997 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1000 (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
1002 else if (unformat (line_input, "del"))
1006 error = unformat_parse_error (line_input);
1011 if (~0 == sw_if_index)
1013 error = clib_error_return (0, "unknown interface `%U'",
1014 format_unformat_error, line_input);
1018 vnet_int_vxlan_gbp_bypass_mode (sw_if_index, is_ip6, is_enable);
1021 unformat_free (line_input);
1026 static clib_error_t *
1027 set_ip4_vxlan_gbp_bypass (vlib_main_t * vm,
1028 unformat_input_t * input, vlib_cli_command_t * cmd)
1030 return set_ip_vxlan_gbp_bypass (0, input, cmd);
1034 * This command adds the 'ip4-vxlan-gbp-bypass' graph node for a given interface.
1035 * By adding the IPv4 vxlan_gbp-bypass graph node to an interface, the node checks
1036 * for and validate input vxlan_gbp packet and bypass ip4-lookup, ip4-local,
1037 * ip4-udp-lookup nodes to speedup vxlan_gbp packet forwarding. This node will
1038 * cause extra overhead to for non-vxlan_gbp packets which is kept at a minimum.
1042 * Example of graph node before ip4-vxlan_gbp-bypass is enabled:
1043 * @cliexstart{show vlib graph ip4-vxlan_gbp-bypass}
1044 * Name Next Previous
1045 * ip4-vxlan-gbp-bypass error-drop [0]
1046 * vxlan4-gbp-input [1]
1050 * Example of how to enable ip4-vxlan-gbp-bypass on an interface:
1051 * @cliexcmd{set interface ip vxlan-gbp-bypass GigabitEthernet2/0/0}
1053 * Example of graph node after ip4-vxlan-gbp-bypass is enabled:
1054 * @cliexstart{show vlib graph ip4-vxlan-gbp-bypass}
1055 * Name Next Previous
1056 * ip4-vxlan-gbp-bypass error-drop [0] ip4-input
1057 * vxlan4-gbp-input [1] ip4-input-no-checksum
1061 * Example of how to display the feature enabled on an interface:
1062 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1063 * IP feature paths configured on GigabitEthernet2/0/0...
1066 * ip4-vxlan-gbp-bypass
1071 * Example of how to disable ip4-vxlan-gbp-bypass on an interface:
1072 * @cliexcmd{set interface ip vxlan-gbp-bypass GigabitEthernet2/0/0 del}
1076 VLIB_CLI_COMMAND (set_interface_ip_vxlan_gbp_bypass_command, static) = {
1077 .path = "set interface ip vxlan-gbp-bypass",
1078 .function = set_ip4_vxlan_gbp_bypass,
1079 .short_help = "set interface ip vxlan-gbp-bypass <interface> [del]",
1083 static clib_error_t *
1084 set_ip6_vxlan_gbp_bypass (vlib_main_t * vm,
1085 unformat_input_t * input, vlib_cli_command_t * cmd)
1087 return set_ip_vxlan_gbp_bypass (1, input, cmd);
1091 * This command adds the 'ip6-vxlan-gbp-bypass' graph node for a given interface.
1092 * By adding the IPv6 vxlan-gbp-bypass graph node to an interface, the node checks
1093 * for and validate input vxlan_gbp packet and bypass ip6-lookup, ip6-local,
1094 * ip6-udp-lookup nodes to speedup vxlan_gbp packet forwarding. This node will
1095 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
1099 * Example of graph node before ip6-vxlan-gbp-bypass is enabled:
1100 * @cliexstart{show vlib graph ip6-vxlan-gbp-bypass}
1101 * Name Next Previous
1102 * ip6-vxlan-gbp-bypass error-drop [0]
1103 * vxlan6-gbp-input [1]
1107 * Example of how to enable ip6-vxlan-gbp-bypass on an interface:
1108 * @cliexcmd{set interface ip6 vxlan-gbp-bypass GigabitEthernet2/0/0}
1110 * Example of graph node after ip6-vxlan-gbp-bypass is enabled:
1111 * @cliexstart{show vlib graph ip6-vxlan-gbp-bypass}
1112 * Name Next Previous
1113 * ip6-vxlan-gbp-bypass error-drop [0] ip6-input
1114 * vxlan6-gbp-input [1] ip4-input-no-checksum
1118 * Example of how to display the feature enabled on an interface:
1119 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1120 * IP feature paths configured on GigabitEthernet2/0/0...
1123 * ip6-vxlan-gbp-bypass
1128 * Example of how to disable ip6-vxlan-gbp-bypass on an interface:
1129 * @cliexcmd{set interface ip6 vxlan-gbp-bypass GigabitEthernet2/0/0 del}
1133 VLIB_CLI_COMMAND (set_interface_ip6_vxlan_gbp_bypass_command, static) = {
1134 .path = "set interface ip6 vxlan-gbp-bypass",
1135 .function = set_ip6_vxlan_gbp_bypass,
1136 .short_help = "set interface ip6 vxlan-gbp-bypass <interface> [del]",
1140 #define VXLAN_GBP_HASH_NUM_BUCKETS (2 * 1024)
1141 #define VXLAN_GBP_HASH_MEMORY_SIZE (1 << 20)
1144 vxlan_gbp_init (vlib_main_t * vm)
1146 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
1148 vxm->vnet_main = vnet_get_main ();
1149 vxm->vlib_main = vm;
1151 /* initialize the ip6 hash */
1152 clib_bihash_init_16_8 (&vxm->vxlan4_gbp_tunnel_by_key, "vxlan4-gbp",
1153 VXLAN_GBP_HASH_NUM_BUCKETS,
1154 VXLAN_GBP_HASH_MEMORY_SIZE);
1155 clib_bihash_init_24_8 (&vxm->vxlan6_gbp_tunnel_by_key, "vxlan6-gbp",
1156 VXLAN_GBP_HASH_NUM_BUCKETS,
1157 VXLAN_GBP_HASH_MEMORY_SIZE);
1158 vxm->vtep6 = hash_create_mem (0, sizeof (ip6_address_t), sizeof (uword));
1159 vxm->mcast_shared = hash_create_mem (0,
1160 sizeof (ip46_address_t),
1161 sizeof (mcast_shared_t));
1163 fib_node_register_type (FIB_NODE_TYPE_VXLAN_GBP_TUNNEL, &vxlan_gbp_vft);
1165 punt_hdl = vlib_punt_client_register ("vxlan-gbp");
1167 vlib_punt_reason_alloc (punt_hdl, "VXLAN-GBP-no-such-v4-tunnel", NULL, NULL,
1168 &vxm->punt_no_such_tunnel[FIB_PROTOCOL_IP4],
1169 VNET_PUNT_REASON_F_IP4_PACKET,
1170 format_vnet_punt_reason_flags);
1171 vlib_punt_reason_alloc (punt_hdl, "VXLAN-GBP-no-such-v6-tunnel", NULL, NULL,
1172 &vxm->punt_no_such_tunnel[FIB_PROTOCOL_IP6],
1173 VNET_PUNT_REASON_F_IP6_PACKET,
1174 format_vnet_punt_reason_flags);
1180 VLIB_INIT_FUNCTION (vxlan_gbp_init) =
1182 .runs_after = VLIB_INITS("punt_init"),
1187 * fd.io coding-style-patch-verification: ON
1190 * eval: (c-set-style "gnu")