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_decap_next (u8 * s, va_list * args)
38 u32 next_index = va_arg (*args, u32);
40 if (next_index == VXLAN_GBP_INPUT_NEXT_DROP)
41 return format (s, "drop");
43 return format (s, "index %d", next_index);
48 format_vxlan_gbp_tunnel (u8 * s, va_list * args)
50 vxlan_gbp_tunnel_t *t = va_arg (*args, vxlan_gbp_tunnel_t *);
53 "[%d] instance %d src %U dst %U vni %d fib-idx %d"
55 t->dev_instance, t->user_instance,
56 format_ip46_address, &t->src, IP46_TYPE_ANY,
57 format_ip46_address, &t->dst, IP46_TYPE_ANY,
58 t->vni, t->encap_fib_index, t->sw_if_index);
60 s = format (s, "encap-dpo-idx %d ", t->next_dpo.dpoi_index);
62 if (PREDICT_FALSE (t->decap_next_index != VXLAN_GBP_INPUT_NEXT_L2_INPUT))
63 s = format (s, "decap-next-%U ", format_decap_next, t->decap_next_index);
65 if (PREDICT_FALSE (ip46_address_is_multicast (&t->dst)))
66 s = format (s, "mcast-sw-if-idx %d ", t->mcast_sw_if_index);
72 format_vxlan_gbp_name (u8 * s, va_list * args)
74 u32 dev_instance = va_arg (*args, u32);
75 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
76 vxlan_gbp_tunnel_t *t;
78 if (dev_instance == ~0)
79 return format (s, "<cached-unused>");
81 if (dev_instance >= vec_len (vxm->tunnels))
82 return format (s, "<improperly-referenced>");
84 t = pool_elt_at_index (vxm->tunnels, dev_instance);
86 return format (s, "vxlan_gbp_tunnel%d", t->user_instance);
90 vxlan_gbp_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index,
93 u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
94 VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
95 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
97 return /* no error */ 0;
101 VNET_DEVICE_CLASS (vxlan_gbp_device_class, static) = {
103 .format_device_name = format_vxlan_gbp_name,
104 .format_tx_trace = format_vxlan_gbp_encap_trace,
105 .admin_up_down_function = vxlan_gbp_interface_admin_up_down,
110 format_vxlan_gbp_header_with_length (u8 * s, va_list * args)
112 u32 dev_instance = va_arg (*args, u32);
113 s = format (s, "unimplemented dev %u", dev_instance);
118 VNET_HW_INTERFACE_CLASS (vxlan_gbp_hw_class) = {
120 .format_header = format_vxlan_gbp_header_with_length,
121 .build_rewrite = default_build_rewrite,
126 vxlan_gbp_tunnel_restack_dpo (vxlan_gbp_tunnel_t * t)
128 u8 is_ip4 = ip46_address_is_ip4 (&t->dst);
129 dpo_id_t dpo = DPO_INVALID;
130 fib_forward_chain_type_t forw_type = is_ip4 ?
131 FIB_FORW_CHAIN_TYPE_UNICAST_IP4 : FIB_FORW_CHAIN_TYPE_UNICAST_IP6;
133 fib_entry_contribute_forwarding (t->fib_entry_index, forw_type, &dpo);
135 /* vxlan_gbp uses the payload hash as the udp source port
136 * hence the packet's hash is unknown
137 * skip single bucket load balance dpo's */
138 while (DPO_LOAD_BALANCE == dpo.dpoi_type)
140 load_balance_t *lb = load_balance_get (dpo.dpoi_index);
141 if (lb->lb_n_buckets > 1)
144 dpo_copy (&dpo, load_balance_get_bucket_i (lb, 0));
147 u32 encap_index = is_ip4 ?
148 vxlan4_gbp_encap_node.index : vxlan6_gbp_encap_node.index;
149 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
153 static vxlan_gbp_tunnel_t *
154 vxlan_gbp_tunnel_from_fib_node (fib_node_t * node)
156 ASSERT (FIB_NODE_TYPE_VXLAN_GBP_TUNNEL == node->fn_type);
157 return ((vxlan_gbp_tunnel_t *) (((char *) node) -
158 STRUCT_OFFSET_OF (vxlan_gbp_tunnel_t,
163 * Function definition to backwalk a FIB node -
164 * Here we will restack the new dpo of VXLAN DIP to encap node.
166 static fib_node_back_walk_rc_t
167 vxlan_gbp_tunnel_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
169 vxlan_gbp_tunnel_restack_dpo (vxlan_gbp_tunnel_from_fib_node (node));
170 return (FIB_NODE_BACK_WALK_CONTINUE);
174 * Function definition to get a FIB node from its index
177 vxlan_gbp_tunnel_fib_node_get (fib_node_index_t index)
179 vxlan_gbp_tunnel_t *t;
180 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
182 t = pool_elt_at_index (vxm->tunnels, index);
188 * Function definition to inform the FIB node that its last lock has gone.
191 vxlan_gbp_tunnel_last_lock_gone (fib_node_t * node)
194 * The VXLAN GBP tunnel is a root of the graph. As such
195 * it never has children and thus is never locked.
201 * Virtual function table registered by VXLAN GBP tunnels
202 * for participation in the FIB object graph.
204 const static fib_node_vft_t vxlan_gbp_vft = {
205 .fnv_get = vxlan_gbp_tunnel_fib_node_get,
206 .fnv_last_lock = vxlan_gbp_tunnel_last_lock_gone,
207 .fnv_back_walk = vxlan_gbp_tunnel_back_walk,
211 #define foreach_copy_field \
213 _(mcast_sw_if_index) \
215 _(decap_next_index) \
220 vxlan_gbp_rewrite (vxlan_gbp_tunnel_t * t, bool is_ip6)
224 ip4_vxlan_gbp_header_t h4;
225 ip6_vxlan_gbp_header_t h6;
227 int len = is_ip6 ? sizeof h.h6 : sizeof h.h4;
230 vxlan_gbp_header_t *vxlan_gbp;
231 /* Fixed portion of the (outer) ip header */
233 memset (&h, 0, sizeof (h));
236 ip4_header_t *ip = &h.h4.ip4;
237 udp = &h.h4.udp, vxlan_gbp = &h.h4.vxlan_gbp;
238 ip->ip_version_and_header_length = 0x45;
240 ip->protocol = IP_PROTOCOL_UDP;
242 ip->src_address = t->src.ip4;
243 ip->dst_address = t->dst.ip4;
245 /* we fix up the ip4 header length and checksum after-the-fact */
246 ip->checksum = ip4_header_checksum (ip);
250 ip6_header_t *ip = &h.h6.ip6;
251 udp = &h.h6.udp, vxlan_gbp = &h.h6.vxlan_gbp;
252 ip->ip_version_traffic_class_and_flow_label =
253 clib_host_to_net_u32 (6 << 28);
255 ip->protocol = IP_PROTOCOL_UDP;
257 ip->src_address = t->src.ip6;
258 ip->dst_address = t->dst.ip6;
261 /* UDP header, randomize src port on something, maybe? */
262 udp->src_port = clib_host_to_net_u16 (47789);
263 udp->dst_port = clib_host_to_net_u16 (UDP_DST_PORT_vxlan_gbp);
266 vxlan_gbp_set_header (vxlan_gbp, t->vni);
267 vnet_rewrite_set_data (*t, &h, len);
271 vxlan_gbp_decap_next_is_valid (vxlan_gbp_main_t * vxm, u32 is_ip6,
272 u32 decap_next_index)
274 vlib_main_t *vm = vxm->vlib_main;
275 u32 input_idx = (!is_ip6) ?
276 vxlan4_gbp_input_node.index : vxlan6_gbp_input_node.index;
277 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, input_idx);
279 return decap_next_index < r->n_next_nodes;
283 vtep_addr_ref (ip46_address_t * ip)
285 uword *vtep = ip46_address_is_ip4 (ip) ?
286 hash_get (vxlan_gbp_main.vtep4, ip->ip4.as_u32) :
287 hash_get_mem (vxlan_gbp_main.vtep6, &ip->ip6);
290 ip46_address_is_ip4 (ip) ?
291 hash_set (vxlan_gbp_main.vtep4, ip->ip4.as_u32, 1) :
292 hash_set_mem_alloc (&vxlan_gbp_main.vtep6, &ip->ip6, 1);
297 vtep_addr_unref (ip46_address_t * ip)
299 uword *vtep = ip46_address_is_ip4 (ip) ?
300 hash_get (vxlan_gbp_main.vtep4, ip->ip4.as_u32) :
301 hash_get_mem (vxlan_gbp_main.vtep6, &ip->ip6);
305 ip46_address_is_ip4 (ip) ?
306 hash_unset (vxlan_gbp_main.vtep4, ip->ip4.as_u32) :
307 hash_unset_mem_free (&vxlan_gbp_main.vtep6, &ip->ip6);
312 typedef CLIB_PACKED(union
316 fib_node_index_t mfib_entry_index;
317 adj_index_t mcast_adj_index;
323 static inline mcast_shared_t
324 mcast_shared_get (ip46_address_t * ip)
326 ASSERT (ip46_address_is_multicast (ip));
327 uword *p = hash_get_mem (vxlan_gbp_main.mcast_shared, ip);
329 mcast_shared_t ret = {.as_u64 = *p };
334 mcast_shared_add (ip46_address_t * dst, fib_node_index_t mfei, adj_index_t ai)
336 mcast_shared_t new_ep = {
337 .mcast_adj_index = ai,
338 .mfib_entry_index = mfei,
341 hash_set_mem_alloc (&vxlan_gbp_main.mcast_shared, dst, new_ep.as_u64);
345 mcast_shared_remove (ip46_address_t * dst)
347 mcast_shared_t ep = mcast_shared_get (dst);
349 adj_unlock (ep.mcast_adj_index);
350 mfib_table_entry_delete_index (ep.mfib_entry_index, MFIB_SOURCE_VXLAN_GBP);
352 hash_unset_mem_free (&vxlan_gbp_main.mcast_shared, dst);
355 int vnet_vxlan_gbp_tunnel_add_del
356 (vnet_vxlan_gbp_tunnel_add_del_args_t * a, u32 * sw_if_indexp)
358 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
359 vxlan_gbp_tunnel_t *t = 0;
360 vnet_main_t *vnm = vxm->vnet_main;
362 u32 sw_if_index = ~0;
363 vxlan4_gbp_tunnel_key_t key4;
364 vxlan6_gbp_tunnel_key_t key6;
365 u32 is_ip6 = a->is_ip6;
370 key4.key[0] = a->dst.ip4.as_u32;
371 key4.key[1] = (((u64) a->encap_fib_index) << 32)
372 | clib_host_to_net_u32 (a->vni << 8);
374 clib_bihash_search_inline_16_8 (&vxm->vxlan4_gbp_tunnel_by_key,
380 key6.key[0] = a->dst.ip6.as_u64[0];
381 key6.key[1] = a->dst.ip6.as_u64[1];
382 key6.key[2] = (((u64) a->encap_fib_index) << 32)
383 | clib_host_to_net_u32 (a->vni << 8);
385 clib_bihash_search_inline_24_8 (&vxm->vxlan6_gbp_tunnel_by_key,
395 l2input_main_t *l2im = &l2input_main;
396 u32 dev_instance; /* real dev instance tunnel index */
397 u32 user_instance; /* request and actual instance number */
399 /* adding a tunnel: tunnel must not already exist */
401 return VNET_API_ERROR_TUNNEL_EXIST;
403 /* if not set explicitly, default to l2 */
404 if (a->decap_next_index == ~0)
405 a->decap_next_index = VXLAN_GBP_INPUT_NEXT_L2_INPUT;
406 if (!vxlan_gbp_decap_next_is_valid (vxm, is_ip6, a->decap_next_index))
407 return VNET_API_ERROR_INVALID_DECAP_NEXT;
409 pool_get_aligned (vxm->tunnels, t, CLIB_CACHE_LINE_BYTES);
410 memset (t, 0, sizeof (*t));
411 dev_instance = t - vxm->tunnels;
413 /* copy from arg structure */
414 #define _(x) t->x = a->x;
418 vxlan_gbp_rewrite (t, is_ip6);
420 * Reconcile the real dev_instance and a possible requested instance.
422 user_instance = a->instance;
423 if (user_instance == ~0)
424 user_instance = dev_instance;
425 if (hash_get (vxm->instance_used, user_instance))
427 pool_put (vxm->tunnels, t);
428 return VNET_API_ERROR_INSTANCE_IN_USE;
430 hash_set (vxm->instance_used, user_instance, 1);
432 t->dev_instance = dev_instance; /* actual */
433 t->user_instance = user_instance; /* name */
439 key6.value = (u64) dev_instance;
441 clib_bihash_add_del_24_8 (&vxm->vxlan6_gbp_tunnel_by_key, &key6,
446 key4.value = (u64) dev_instance;
448 clib_bihash_add_del_16_8 (&vxm->vxlan4_gbp_tunnel_by_key, &key4,
454 pool_put (vxm->tunnels, t);
455 return VNET_API_ERROR_INVALID_REGISTRATION;
458 t->hw_if_index = vnet_register_interface
459 (vnm, vxlan_gbp_device_class.index, dev_instance,
460 vxlan_gbp_hw_class.index, dev_instance);
461 vnet_hw_interface_t *hi = vnet_get_hw_interface (vnm, t->hw_if_index);
463 /* Set vxlan_gbp tunnel output node */
464 u32 encap_index = !is_ip6 ?
465 vxlan4_gbp_encap_node.index : vxlan6_gbp_encap_node.index;
466 vnet_set_interface_output_node (vnm, t->hw_if_index, encap_index);
468 t->sw_if_index = sw_if_index = hi->sw_if_index;
470 vec_validate_init_empty (vxm->tunnel_index_by_sw_if_index, sw_if_index,
472 vxm->tunnel_index_by_sw_if_index[sw_if_index] = dev_instance;
474 /* setup l2 input config with l2 feature and bd 0 to drop packet */
475 vec_validate (l2im->configs, sw_if_index);
476 l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
477 l2im->configs[sw_if_index].bd_index = 0;
479 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
480 si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
481 vnet_sw_interface_set_flags (vnm, sw_if_index,
482 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
484 fib_node_init (&t->node, FIB_NODE_TYPE_VXLAN_GBP_TUNNEL);
485 fib_prefix_t tun_dst_pfx;
486 vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
488 fib_prefix_from_ip46_addr (&t->dst, &tun_dst_pfx);
489 if (!ip46_address_is_multicast (&t->dst))
492 * source the FIB entry for the tunnel's destination
493 * and become a child thereof. The tunnel will then get poked
494 * when the forwarding for the entry updates, and the tunnel can
495 * re-stack accordingly
497 vtep_addr_ref (&t->src);
498 t->fib_entry_index = fib_table_entry_special_add
499 (t->encap_fib_index, &tun_dst_pfx, FIB_SOURCE_RR,
500 FIB_ENTRY_FLAG_NONE);
501 t->sibling_index = fib_entry_child_add
502 (t->fib_entry_index, FIB_NODE_TYPE_VXLAN_GBP_TUNNEL,
504 vxlan_gbp_tunnel_restack_dpo (t);
508 /* Multicast tunnel -
509 * as the same mcast group can be used for multiple mcast tunnels
510 * with different VNIs, create the output fib adjacency only if
511 * it does not already exist
513 fib_protocol_t fp = fib_ip_proto (is_ip6);
515 if (vtep_addr_ref (&t->dst) == 1)
517 fib_node_index_t mfei;
519 fib_route_path_t path = {
520 .frp_proto = fib_proto_to_dpo (fp),
521 .frp_addr = zero_addr,
522 .frp_sw_if_index = 0xffffffff,
525 .frp_flags = FIB_ROUTE_PATH_LOCAL,
527 const mfib_prefix_t mpfx = {
529 .fp_len = (is_ip6 ? 128 : 32),
530 .fp_grp_addr = tun_dst_pfx.fp_addr,
534 * Setup the (*,G) to receive traffic on the mcast group
535 * - the forwarding interface is for-us
536 * - the accepting interface is that from the API
538 mfib_table_entry_path_update (t->encap_fib_index,
540 MFIB_SOURCE_VXLAN_GBP,
541 &path, MFIB_ITF_FLAG_FORWARD);
543 path.frp_sw_if_index = a->mcast_sw_if_index;
544 path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
545 mfei = mfib_table_entry_path_update (t->encap_fib_index,
547 MFIB_SOURCE_VXLAN_GBP,
549 MFIB_ITF_FLAG_ACCEPT);
552 * Create the mcast adjacency to send traffic to the group
554 ai = adj_mcast_add_or_lock (fp,
555 fib_proto_to_link (fp),
556 a->mcast_sw_if_index);
559 * create a new end-point
561 mcast_shared_add (&t->dst, mfei, ai);
564 dpo_id_t dpo = DPO_INVALID;
565 mcast_shared_t ep = mcast_shared_get (&t->dst);
567 /* Stack shared mcast dst mac addr rewrite on encap */
568 dpo_set (&dpo, DPO_ADJACENCY_MCAST,
569 fib_proto_to_dpo (fp), ep.mcast_adj_index);
571 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
573 flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
576 vnet_get_sw_interface (vnet_get_main (), sw_if_index)->flood_class =
581 /* deleting a tunnel: tunnel must exist */
583 return VNET_API_ERROR_NO_SUCH_ENTRY;
586 t = pool_elt_at_index (vxm->tunnels, instance);
588 sw_if_index = t->sw_if_index;
589 vnet_sw_interface_set_flags (vnm, sw_if_index, 0 /* down */ );
591 vxm->tunnel_index_by_sw_if_index[sw_if_index] = ~0;
594 clib_bihash_add_del_16_8 (&vxm->vxlan4_gbp_tunnel_by_key, &key4,
597 clib_bihash_add_del_24_8 (&vxm->vxlan6_gbp_tunnel_by_key, &key6,
600 if (!ip46_address_is_multicast (&t->dst))
602 vtep_addr_unref (&t->src);
603 fib_entry_child_remove (t->fib_entry_index, t->sibling_index);
604 fib_table_entry_delete_index (t->fib_entry_index, FIB_SOURCE_RR);
606 else if (vtep_addr_unref (&t->dst) == 0)
608 mcast_shared_remove (&t->dst);
611 vnet_delete_hw_interface (vnm, t->hw_if_index);
612 hash_unset (vxm->instance_used, t->user_instance);
614 fib_node_deinit (&t->node);
615 pool_put (vxm->tunnels, t);
619 *sw_if_indexp = sw_if_index;
625 get_decap_next_for_node (u32 node_index, u32 ipv4_set)
627 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
628 vlib_main_t *vm = vxm->vlib_main;
629 uword input_node = (ipv4_set) ? vxlan4_gbp_input_node.index :
630 vxlan6_gbp_input_node.index;
632 return vlib_node_add_next (vm, input_node, node_index);
636 unformat_decap_next (unformat_input_t * input, va_list * args)
638 u32 *result = va_arg (*args, u32 *);
639 u32 ipv4_set = va_arg (*args, int);
640 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
641 vlib_main_t *vm = vxm->vlib_main;
645 if (unformat (input, "l2"))
646 *result = VXLAN_GBP_INPUT_NEXT_L2_INPUT;
647 else if (unformat (input, "node %U", unformat_vlib_node, vm, &node_index))
648 *result = get_decap_next_for_node (node_index, ipv4_set);
649 else if (unformat (input, "%d", &tmp))
656 static clib_error_t *
657 vxlan_gbp_tunnel_add_del_command_fn (vlib_main_t * vm,
658 unformat_input_t * input,
659 vlib_cli_command_t * cmd)
661 unformat_input_t _line_input, *line_input = &_line_input;
662 ip46_address_t src = ip46_address_initializer, dst =
663 ip46_address_initializer;
671 u32 encap_fib_index = 0;
672 u32 mcast_sw_if_index = ~0;
673 u32 decap_next_index = VXLAN_GBP_INPUT_NEXT_L2_INPUT;
676 clib_error_t *parse_error = NULL;
678 /* Get a line of input. */
679 if (!unformat_user (input, unformat_line_input, line_input))
682 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
684 if (unformat (line_input, "del"))
688 else if (unformat (line_input, "instance %d", &instance))
690 else if (unformat (line_input, "src %U",
691 unformat_ip46_address, &src, IP46_TYPE_ANY))
694 ip46_address_is_ip4 (&src) ? (ipv4_set = 1) : (ipv6_set = 1);
696 else if (unformat (line_input, "dst %U",
697 unformat_ip46_address, &dst, IP46_TYPE_ANY))
700 ip46_address_is_ip4 (&dst) ? (ipv4_set = 1) : (ipv6_set = 1);
702 else if (unformat (line_input, "group %U %U",
703 unformat_ip46_address, &dst, IP46_TYPE_ANY,
704 unformat_vnet_sw_interface,
705 vnet_get_main (), &mcast_sw_if_index))
707 grp_set = dst_set = 1;
708 ip46_address_is_ip4 (&dst) ? (ipv4_set = 1) : (ipv6_set = 1);
710 else if (unformat (line_input, "encap-vrf-id %d", &table_id))
713 fib_table_find (fib_ip_proto (ipv6_set), table_id);
715 else if (unformat (line_input, "decap-next %U", unformat_decap_next,
716 &decap_next_index, ipv4_set))
718 else if (unformat (line_input, "vni %d", &vni))
722 parse_error = clib_error_return (0, "parse error: '%U'",
723 format_unformat_error, line_input);
728 unformat_free (line_input);
733 if (encap_fib_index == ~0)
734 return clib_error_return (0, "nonexistent encap-vrf-id %d", table_id);
737 return clib_error_return (0, "tunnel src address not specified");
740 return clib_error_return (0, "tunnel dst address not specified");
742 if (grp_set && !ip46_address_is_multicast (&dst))
743 return clib_error_return (0, "tunnel group address not multicast");
745 if (grp_set == 0 && ip46_address_is_multicast (&dst))
746 return clib_error_return (0, "dst address must be unicast");
748 if (grp_set && mcast_sw_if_index == ~0)
749 return clib_error_return (0, "tunnel nonexistent multicast device");
751 if (ipv4_set && ipv6_set)
752 return clib_error_return (0, "both IPv4 and IPv6 addresses specified");
754 if (ip46_address_cmp (&src, &dst) == 0)
755 return clib_error_return (0, "src and dst addresses are identical");
757 if (decap_next_index == ~0)
758 return clib_error_return (0, "next node not found");
761 return clib_error_return (0, "vni not specified");
764 return clib_error_return (0, "vni %d out of range", vni);
766 vnet_vxlan_gbp_tunnel_add_del_args_t a = {
769 .instance = instance,
775 u32 tunnel_sw_if_index;
776 int rv = vnet_vxlan_gbp_tunnel_add_del (&a, &tunnel_sw_if_index);
782 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
783 vnet_get_main (), tunnel_sw_if_index);
786 case VNET_API_ERROR_TUNNEL_EXIST:
787 return clib_error_return (0, "tunnel already exists...");
789 case VNET_API_ERROR_NO_SUCH_ENTRY:
790 return clib_error_return (0, "tunnel does not exist...");
792 case VNET_API_ERROR_INSTANCE_IN_USE:
793 return clib_error_return (0, "Instance is in use");
796 return clib_error_return
797 (0, "vnet_vxlan_gbp_tunnel_add_del returned %d", rv);
804 * Add or delete a VXLAN Tunnel.
806 * VXLAN provides the features needed to allow L2 bridge domains (BDs)
807 * to span multiple servers. This is done by building an L2 overlay on
808 * top of an L3 network underlay using VXLAN tunnels.
810 * This makes it possible for servers to be co-located in the same data
811 * center or be separated geographically as long as they are reachable
812 * through the underlay L3 network.
814 * You can refer to this kind of L2 overlay bridge domain as a VXLAN
815 * (Virtual eXtensible VLAN) segment.
818 * Example of how to create a VXLAN Tunnel:
819 * @cliexcmd{create vxlan_gbp tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 encap-vrf-id 7}
820 * Example of how to create a VXLAN Tunnel with a known name, vxlan_gbp_tunnel42:
821 * @cliexcmd{create vxlan_gbp tunnel src 10.0.3.1 dst 10.0.3.3 instance 42}
822 * Example of how to create a multicast VXLAN Tunnel with a known name, vxlan_gbp_tunnel23:
823 * @cliexcmd{create vxlan_gbp tunnel src 10.0.3.1 group 239.1.1.1 GigabitEthernet0/8/0 instance 23}
824 * Example of how to delete a VXLAN Tunnel:
825 * @cliexcmd{create vxlan_gbp tunnel src 10.0.3.1 dst 10.0.3.3 vni 13 del}
828 VLIB_CLI_COMMAND (create_vxlan_gbp_tunnel_command, static) = {
829 .path = "create vxlan-gbp tunnel",
831 "create vxlan-gbp tunnel src <local-vtep-addr>"
832 " {dst <remote-vtep-addr>|group <mcast-vtep-addr> <intf-name>} vni <nn>"
834 " [encap-vrf-id <nn>] [decap-next [l2|node <name>]] [del]",
835 .function = vxlan_gbp_tunnel_add_del_command_fn,
839 static clib_error_t *
840 show_vxlan_gbp_tunnel_command_fn (vlib_main_t * vm,
841 unformat_input_t * input,
842 vlib_cli_command_t * cmd)
844 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
845 vxlan_gbp_tunnel_t *t;
848 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
850 if (unformat (input, "raw"))
853 return clib_error_return (0, "parse error: '%U'",
854 format_unformat_error, input);
857 if (pool_elts (vxm->tunnels) == 0)
858 vlib_cli_output (vm, "No vxlan-gbp tunnels configured...");
861 pool_foreach (t, vxm->tunnels,
863 vlib_cli_output (vm, "%U", format_vxlan_gbp_tunnel, t);
869 vlib_cli_output (vm, "Raw IPv4 Hash Table:\n%U\n",
870 format_bihash_16_8, &vxm->vxlan4_gbp_tunnel_by_key,
872 vlib_cli_output (vm, "Raw IPv6 Hash Table:\n%U\n",
873 format_bihash_24_8, &vxm->vxlan6_gbp_tunnel_by_key,
881 * Display all the VXLAN Tunnel entries.
884 * Example of how to display the VXLAN Tunnel entries:
885 * @cliexstart{show vxlan_gbp tunnel}
886 * [0] src 10.0.3.1 dst 10.0.3.3 vni 13 encap_fib_index 0 sw_if_index 5 decap_next l2
890 VLIB_CLI_COMMAND (show_vxlan_gbp_tunnel_command, static) = {
891 .path = "show vxlan-gbp tunnel",
892 .short_help = "show vxlan-gbp tunnel [raw]",
893 .function = show_vxlan_gbp_tunnel_command_fn,
899 vnet_int_vxlan_gbp_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable)
902 vnet_feature_enable_disable ("ip6-unicast", "ip6-vxlan-gbp-bypass",
903 sw_if_index, is_enable, 0, 0);
905 vnet_feature_enable_disable ("ip4-unicast", "ip4-vxlan-gbp-bypass",
906 sw_if_index, is_enable, 0, 0);
910 static clib_error_t *
911 set_ip_vxlan_gbp_bypass (u32 is_ip6,
912 unformat_input_t * input, vlib_cli_command_t * cmd)
914 unformat_input_t _line_input, *line_input = &_line_input;
915 vnet_main_t *vnm = vnet_get_main ();
916 clib_error_t *error = 0;
917 u32 sw_if_index, is_enable;
922 if (!unformat_user (input, unformat_line_input, line_input))
925 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
928 (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
930 else if (unformat (line_input, "del"))
934 error = unformat_parse_error (line_input);
939 if (~0 == sw_if_index)
941 error = clib_error_return (0, "unknown interface `%U'",
942 format_unformat_error, line_input);
946 vnet_int_vxlan_gbp_bypass_mode (sw_if_index, is_ip6, is_enable);
949 unformat_free (line_input);
954 static clib_error_t *
955 set_ip4_vxlan_gbp_bypass (vlib_main_t * vm,
956 unformat_input_t * input, vlib_cli_command_t * cmd)
958 return set_ip_vxlan_gbp_bypass (0, input, cmd);
962 * This command adds the 'ip4-vxlan-gbp-bypass' graph node for a given interface.
963 * By adding the IPv4 vxlan_gbp-bypass graph node to an interface, the node checks
964 * for and validate input vxlan_gbp packet and bypass ip4-lookup, ip4-local,
965 * ip4-udp-lookup nodes to speedup vxlan_gbp packet forwarding. This node will
966 * cause extra overhead to for non-vxlan_gbp packets which is kept at a minimum.
970 * Example of graph node before ip4-vxlan_gbp-bypass is enabled:
971 * @cliexstart{show vlib graph ip4-vxlan_gbp-bypass}
973 * ip4-vxlan-gbp-bypass error-drop [0]
974 * vxlan4-gbp-input [1]
978 * Example of how to enable ip4-vxlan-gbp-bypass on an interface:
979 * @cliexcmd{set interface ip vxlan-gbp-bypass GigabitEthernet2/0/0}
981 * Example of graph node after ip4-vxlan-gbp-bypass is enabled:
982 * @cliexstart{show vlib graph ip4-vxlan-gbp-bypass}
984 * ip4-vxlan-gbp-bypass error-drop [0] ip4-input
985 * vxlan4-gbp-input [1] ip4-input-no-checksum
989 * Example of how to display the feature enabled on an interface:
990 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
991 * IP feature paths configured on GigabitEthernet2/0/0...
994 * ip4-vxlan-gbp-bypass
999 * Example of how to disable ip4-vxlan-gbp-bypass on an interface:
1000 * @cliexcmd{set interface ip vxlan-gbp-bypass GigabitEthernet2/0/0 del}
1004 VLIB_CLI_COMMAND (set_interface_ip_vxlan_gbp_bypass_command, static) = {
1005 .path = "set interface ip vxlan-gbp-bypass",
1006 .function = set_ip4_vxlan_gbp_bypass,
1007 .short_help = "set interface ip vxlan-gbp-bypass <interface> [del]",
1011 static clib_error_t *
1012 set_ip6_vxlan_gbp_bypass (vlib_main_t * vm,
1013 unformat_input_t * input, vlib_cli_command_t * cmd)
1015 return set_ip_vxlan_gbp_bypass (1, input, cmd);
1019 * This command adds the 'ip6-vxlan-gbp-bypass' graph node for a given interface.
1020 * By adding the IPv6 vxlan-gbp-bypass graph node to an interface, the node checks
1021 * for and validate input vxlan_gbp packet and bypass ip6-lookup, ip6-local,
1022 * ip6-udp-lookup nodes to speedup vxlan_gbp packet forwarding. This node will
1023 * cause extra overhead to for non-vxlan packets which is kept at a minimum.
1027 * Example of graph node before ip6-vxlan-gbp-bypass is enabled:
1028 * @cliexstart{show vlib graph ip6-vxlan-gbp-bypass}
1029 * Name Next Previous
1030 * ip6-vxlan-gbp-bypass error-drop [0]
1031 * vxlan6-gbp-input [1]
1035 * Example of how to enable ip6-vxlan-gbp-bypass on an interface:
1036 * @cliexcmd{set interface ip6 vxlan-gbp-bypass GigabitEthernet2/0/0}
1038 * Example of graph node after ip6-vxlan-gbp-bypass is enabled:
1039 * @cliexstart{show vlib graph ip6-vxlan-gbp-bypass}
1040 * Name Next Previous
1041 * ip6-vxlan-gbp-bypass error-drop [0] ip6-input
1042 * vxlan6-gbp-input [1] ip4-input-no-checksum
1046 * Example of how to display the feature enabled on an interface:
1047 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1048 * IP feature paths configured on GigabitEthernet2/0/0...
1051 * ip6-vxlan-gbp-bypass
1056 * Example of how to disable ip6-vxlan-gbp-bypass on an interface:
1057 * @cliexcmd{set interface ip6 vxlan-gbp-bypass GigabitEthernet2/0/0 del}
1061 VLIB_CLI_COMMAND (set_interface_ip6_vxlan_gbp_bypass_command, static) = {
1062 .path = "set interface ip6 vxlan-gbp-bypass",
1063 .function = set_ip6_vxlan_gbp_bypass,
1064 .short_help = "set interface ip vxlan-gbp-bypass <interface> [del]",
1068 #define VXLAN_GBP_HASH_NUM_BUCKETS (2 * 1024)
1069 #define VXLAN_GBP_HASH_MEMORY_SIZE (1 << 20)
1072 vxlan_gbp_init (vlib_main_t * vm)
1074 vxlan_gbp_main_t *vxm = &vxlan_gbp_main;
1076 vxm->vnet_main = vnet_get_main ();
1077 vxm->vlib_main = vm;
1079 /* initialize the ip6 hash */
1080 clib_bihash_init_16_8 (&vxm->vxlan4_gbp_tunnel_by_key, "vxlan4-gbp",
1081 VXLAN_GBP_HASH_NUM_BUCKETS,
1082 VXLAN_GBP_HASH_MEMORY_SIZE);
1083 clib_bihash_init_24_8 (&vxm->vxlan6_gbp_tunnel_by_key, "vxlan6-gbp",
1084 VXLAN_GBP_HASH_NUM_BUCKETS,
1085 VXLAN_GBP_HASH_MEMORY_SIZE);
1086 vxm->vtep6 = hash_create_mem (0, sizeof (ip6_address_t), sizeof (uword));
1087 vxm->mcast_shared = hash_create_mem (0,
1088 sizeof (ip46_address_t),
1089 sizeof (mcast_shared_t));
1091 udp_register_dst_port (vm, UDP_DST_PORT_vxlan_gbp,
1092 vxlan4_gbp_input_node.index, /* is_ip4 */ 1);
1093 udp_register_dst_port (vm, UDP_DST_PORT_vxlan6_gbp,
1094 vxlan6_gbp_input_node.index, /* is_ip4 */ 0);
1096 fib_node_register_type (FIB_NODE_TYPE_VXLAN_GBP_TUNNEL, &vxlan_gbp_vft);
1101 VLIB_INIT_FUNCTION (vxlan_gbp_init);
1104 * fd.io coding-style-patch-verification: ON
1107 * eval: (c-set-style "gnu")