2 * Copyright (c) 2017 SUSE LLC.
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/geneve/geneve.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/interface.h>
23 #include <vlib/vlib.h>
29 * GENEVE provides the features needed to allow L2 bridge domains (BDs)
30 * to span multiple servers. This is done by building an L2 overlay on
31 * top of an L3 network underlay using GENEVE tunnels.
33 * This makes it possible for servers to be co-located in the same data
34 * center or be separated geographically as long as they are reachable
35 * through the underlay L3 network.
39 geneve_main_t geneve_main;
42 format_geneve_encap_trace (u8 * s, va_list * args)
44 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
45 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
46 geneve_encap_trace_t *t = va_arg (*args, geneve_encap_trace_t *);
48 s = format (s, "GENEVE encap to geneve_tunnel%d vni %d",
49 t->tunnel_index, t->vni);
54 format_decap_next (u8 * s, va_list * args)
56 u32 next_index = va_arg (*args, u32);
60 case GENEVE_INPUT_NEXT_DROP:
61 return format (s, "drop");
62 case GENEVE_INPUT_NEXT_L2_INPUT:
63 return format (s, "l2");
65 return format (s, "index %d", next_index);
71 format_geneve_tunnel (u8 * s, va_list * args)
73 geneve_tunnel_t *t = va_arg (*args, geneve_tunnel_t *);
74 geneve_main_t *ngm = &geneve_main;
76 s = format (s, "[%d] lcl %U rmt %U vni %d fib-idx %d sw-if-idx %d ",
78 format_ip46_address, &t->local, IP46_TYPE_ANY,
79 format_ip46_address, &t->remote, IP46_TYPE_ANY,
80 t->vni, t->encap_fib_index, t->sw_if_index);
82 s = format (s, "encap-dpo-idx %d ", t->next_dpo.dpoi_index);
83 s = format (s, "decap-next-%U ", format_decap_next, t->decap_next_index);
85 if (PREDICT_FALSE (ip46_address_is_multicast (&t->remote)))
86 s = format (s, "mcast-sw-if-idx %d ", t->mcast_sw_if_index);
92 format_geneve_name (u8 * s, va_list * args)
94 u32 dev_instance = va_arg (*args, u32);
95 return format (s, "geneve_tunnel%d", dev_instance);
99 geneve_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
101 u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
102 VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
103 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
105 return /* no error */ 0;
109 VNET_DEVICE_CLASS (geneve_device_class, static) = {
111 .format_device_name = format_geneve_name,
112 .format_tx_trace = format_geneve_encap_trace,
113 .admin_up_down_function = geneve_interface_admin_up_down,
118 format_geneve_header_with_length (u8 * s, va_list * args)
120 u32 dev_instance = va_arg (*args, u32);
121 s = format (s, "unimplemented dev %u", dev_instance);
126 VNET_HW_INTERFACE_CLASS (geneve_hw_class) = {
128 .format_header = format_geneve_header_with_length,
129 .build_rewrite = default_build_rewrite,
134 geneve_tunnel_restack_dpo (geneve_tunnel_t * t)
136 dpo_id_t dpo = DPO_INVALID;
137 u32 encap_index = ip46_address_is_ip4 (&t->remote) ?
138 geneve4_encap_node.index : geneve6_encap_node.index;
139 fib_forward_chain_type_t forw_type = ip46_address_is_ip4 (&t->remote) ?
140 FIB_FORW_CHAIN_TYPE_UNICAST_IP4 : FIB_FORW_CHAIN_TYPE_UNICAST_IP6;
142 fib_entry_contribute_forwarding (t->fib_entry_index, forw_type, &dpo);
143 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
147 static geneve_tunnel_t *
148 geneve_tunnel_from_fib_node (fib_node_t * node)
150 ASSERT (FIB_NODE_TYPE_GENEVE_TUNNEL == node->fn_type);
151 return ((geneve_tunnel_t *) (((char *) node) -
152 STRUCT_OFFSET_OF (geneve_tunnel_t, node)));
156 * Function definition to backwalk a FIB node -
157 * Here we will restack the new dpo of GENEVE DIP to encap node.
159 static fib_node_back_walk_rc_t
160 geneve_tunnel_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
162 geneve_tunnel_restack_dpo (geneve_tunnel_from_fib_node (node));
163 return (FIB_NODE_BACK_WALK_CONTINUE);
167 * Function definition to get a FIB node from its index
170 geneve_tunnel_fib_node_get (fib_node_index_t index)
173 geneve_main_t *vxm = &geneve_main;
175 t = pool_elt_at_index (vxm->tunnels, index);
181 * Function definition to inform the FIB node that its last lock has gone.
184 geneve_tunnel_last_lock_gone (fib_node_t * node)
187 * The GENEVE tunnel is a root of the graph. As such
188 * it never has children and thus is never locked.
194 * Virtual function table registered by GENEVE tunnels
195 * for participation in the FIB object graph.
197 const static fib_node_vft_t geneve_vft = {
198 .fnv_get = geneve_tunnel_fib_node_get,
199 .fnv_last_lock = geneve_tunnel_last_lock_gone,
200 .fnv_back_walk = geneve_tunnel_back_walk,
204 #define foreach_copy_field \
206 _(mcast_sw_if_index) \
208 _(decap_next_index) \
213 geneve_rewrite (geneve_tunnel_t * t, bool is_ip6)
217 ip4_geneve_header_t *h4;
218 ip6_geneve_header_t *h6;
223 int len = is_ip6 ? sizeof *r.h6 : sizeof *r.h4;
224 #if SUPPORT_OPTIONS_HEADER==1
225 len += t->options_len;
228 vec_validate_aligned (r.rw, len - 1, CLIB_CACHE_LINE_BYTES);
231 geneve_header_t *geneve;
232 /* Fixed portion of the (outer) ip header */
235 ip4_header_t *ip = &r.h4->ip4;
236 udp = &r.h4->udp, geneve = &r.h4->geneve;
237 ip->ip_version_and_header_length = 0x45;
239 ip->protocol = IP_PROTOCOL_UDP;
241 ip->src_address = t->local.ip4;
242 ip->dst_address = t->remote.ip4;
244 /* we fix up the ip4 header length and checksum after-the-fact */
245 ip->checksum = ip4_header_checksum (ip);
249 ip6_header_t *ip = &r.h6->ip6;
250 udp = &r.h6->udp, geneve = &r.h6->geneve;
251 ip->ip_version_traffic_class_and_flow_label =
252 clib_host_to_net_u32 (6 << 28);
254 ip->protocol = IP_PROTOCOL_UDP;
256 ip->src_address = t->local.ip6;
257 ip->dst_address = t->remote.ip6;
260 /* UDP header, randomize local port on something, maybe? */
261 udp->src_port = clib_host_to_net_u16 (5251);
262 udp->dst_port = clib_host_to_net_u16 (UDP_DST_PORT_geneve);
265 vnet_set_geneve_version (geneve, GENEVE_VERSION);
266 #if SUPPORT_OPTIONS_HEADER==1
267 vnet_set_geneve_options_len (geneve, t->options_len);
269 vnet_set_geneve_options_len (geneve, 0);
271 vnet_set_geneve_oamframe_bit (geneve, 0);
272 vnet_set_geneve_critical_bit (geneve, 0);
273 vnet_set_geneve_protocol (geneve, GENEVE_ETH_PROTOCOL);
275 vnet_geneve_hdr_1word_hton (geneve);
277 vnet_set_geneve_vni (geneve, t->vni);
284 geneve_decap_next_is_valid (geneve_main_t * vxm, u32 is_ip6,
285 u32 decap_next_index)
287 vlib_main_t *vm = vxm->vlib_main;
289 (!is_ip6) ? geneve4_input_node.index : geneve6_input_node.index;
290 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, input_idx);
292 return decap_next_index < r->n_next_nodes;
296 vtep_addr_ref (ip46_address_t * ip)
298 uword *vtep = ip46_address_is_ip4 (ip) ?
299 hash_get (geneve_main.vtep4, ip->ip4.as_u32) :
300 hash_get_mem (geneve_main.vtep6, &ip->ip6);
303 ip46_address_is_ip4 (ip) ?
304 hash_set (geneve_main.vtep4, ip->ip4.as_u32, 1) :
305 hash_set_mem_alloc (&geneve_main.vtep6, &ip->ip6, 1);
310 vtep_addr_unref (ip46_address_t * ip)
312 uword *vtep = ip46_address_is_ip4 (ip) ?
313 hash_get (geneve_main.vtep4, ip->ip4.as_u32) :
314 hash_get_mem (geneve_main.vtep6, &ip->ip6);
318 ip46_address_is_ip4 (ip) ?
319 hash_unset (geneve_main.vtep4, ip->ip4.as_u32) :
320 hash_unset_mem_free (&geneve_main.vtep6, &ip->ip6);
324 typedef CLIB_PACKED (union
328 fib_node_index_t mfib_entry_index;
329 adj_index_t mcast_adj_index;
333 static inline mcast_shared_t
334 mcast_shared_get (ip46_address_t * ip)
336 ASSERT (ip46_address_is_multicast (ip));
337 uword *p = hash_get_mem (geneve_main.mcast_shared, ip);
339 return (mcast_shared_t)
345 mcast_shared_add (ip46_address_t * remote,
346 fib_node_index_t mfei, adj_index_t ai)
348 mcast_shared_t new_ep = {
349 .mcast_adj_index = ai,
350 .mfib_entry_index = mfei,
353 hash_set_mem_alloc (&geneve_main.mcast_shared, remote, new_ep.as_u64);
357 mcast_shared_remove (ip46_address_t * remote)
359 mcast_shared_t ep = mcast_shared_get (remote);
361 adj_unlock (ep.mcast_adj_index);
362 mfib_table_entry_delete_index (ep.mfib_entry_index, MFIB_SOURCE_GENEVE);
364 hash_unset_mem_free (&geneve_main.mcast_shared, remote);
367 int vnet_geneve_add_del_tunnel
368 (vnet_geneve_add_del_tunnel_args_t * a, u32 * sw_if_indexp)
370 geneve_main_t *vxm = &geneve_main;
371 geneve_tunnel_t *t = 0;
372 vnet_main_t *vnm = vxm->vnet_main;
374 u32 hw_if_index = ~0;
375 u32 sw_if_index = ~0;
377 geneve4_tunnel_key_t key4;
378 geneve6_tunnel_key_t key6;
379 u32 is_ip6 = a->is_ip6;
383 key4.remote = a->remote.ip4.as_u32;
385 clib_host_to_net_u32 ((a->vni << GENEVE_VNI_SHIFT) & GENEVE_VNI_MASK);
386 p = hash_get (vxm->geneve4_tunnel_by_key, key4.as_u64);
390 key6.remote = a->remote.ip6;
392 clib_host_to_net_u32 ((a->vni << GENEVE_VNI_SHIFT) & GENEVE_VNI_MASK);
393 p = hash_get_mem (vxm->geneve6_tunnel_by_key, &key6);
398 l2input_main_t *l2im = &l2input_main;
400 /* adding a tunnel: tunnel must not already exist */
402 return VNET_API_ERROR_TUNNEL_EXIST;
404 /*if not set explicitly, default to l2 */
405 if (a->decap_next_index == ~0)
406 a->decap_next_index = GENEVE_INPUT_NEXT_L2_INPUT;
407 if (!geneve_decap_next_is_valid (vxm, is_ip6, a->decap_next_index))
408 return VNET_API_ERROR_INVALID_DECAP_NEXT;
410 pool_get_aligned (vxm->tunnels, t, CLIB_CACHE_LINE_BYTES);
411 clib_memset (t, 0, sizeof (*t));
413 /* copy from arg structure */
414 #define _(x) t->x = a->x;
418 rv = geneve_rewrite (t, is_ip6);
421 pool_put (vxm->tunnels, t);
427 hash_set_mem_alloc (&vxm->geneve6_tunnel_by_key, &key6,
430 hash_set (vxm->geneve4_tunnel_by_key, key4.as_u64, t - vxm->tunnels);
432 vnet_hw_interface_t *hi;
433 if (vec_len (vxm->free_geneve_tunnel_hw_if_indices) > 0)
435 vnet_interface_main_t *im = &vnm->interface_main;
436 hw_if_index = vxm->free_geneve_tunnel_hw_if_indices
437 [vec_len (vxm->free_geneve_tunnel_hw_if_indices) - 1];
438 _vec_len (vxm->free_geneve_tunnel_hw_if_indices) -= 1;
440 hi = vnet_get_hw_interface (vnm, hw_if_index);
441 hi->dev_instance = t - vxm->tunnels;
442 hi->hw_instance = hi->dev_instance;
444 /* clear old stats of freed tunnel before reuse */
445 sw_if_index = hi->sw_if_index;
446 vnet_interface_counter_lock (im);
447 vlib_zero_combined_counter
448 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX],
450 vlib_zero_combined_counter (&im->combined_sw_if_counters
451 [VNET_INTERFACE_COUNTER_RX],
453 vlib_zero_simple_counter (&im->sw_if_counters
454 [VNET_INTERFACE_COUNTER_DROP],
456 vnet_interface_counter_unlock (im);
460 hw_if_index = vnet_register_interface
461 (vnm, geneve_device_class.index, t - vxm->tunnels,
462 geneve_hw_class.index, t - vxm->tunnels);
463 hi = vnet_get_hw_interface (vnm, hw_if_index);
466 /* Set geneve tunnel output node */
467 u32 encap_index = !is_ip6 ?
468 geneve4_encap_node.index : geneve6_encap_node.index;
469 vnet_set_interface_output_node (vnm, hw_if_index, encap_index);
471 t->hw_if_index = hw_if_index;
472 t->sw_if_index = sw_if_index = hi->sw_if_index;
474 vec_validate_init_empty (vxm->tunnel_index_by_sw_if_index, sw_if_index,
476 vxm->tunnel_index_by_sw_if_index[sw_if_index] = t - vxm->tunnels;
478 /* setup l2 input config with l2 feature and bd 0 to drop packet */
479 vec_validate (l2im->configs, sw_if_index);
480 l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
481 l2im->configs[sw_if_index].bd_index = 0;
483 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
484 si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
485 vnet_sw_interface_set_flags (vnm, sw_if_index,
486 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
488 fib_node_init (&t->node, FIB_NODE_TYPE_GENEVE_TUNNEL);
489 fib_prefix_t tun_remote_pfx;
490 vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
492 fib_prefix_from_ip46_addr (&t->remote, &tun_remote_pfx);
493 if (!ip46_address_is_multicast (&t->remote))
496 * source the FIB entry for the tunnel's destination
497 * and become a child thereof. The tunnel will then get poked
498 * when the forwarding for the entry updates, and the tunnel can
499 * re-stack accordingly
501 vtep_addr_ref (&t->local);
502 t->fib_entry_index = fib_entry_track (t->encap_fib_index,
504 FIB_NODE_TYPE_GENEVE_TUNNEL,
507 geneve_tunnel_restack_dpo (t);
511 /* Multicast tunnel -
512 * as the same mcast group can be used for mutiple mcast tunnels
513 * with different VNIs, create the output fib adjecency only if
514 * it does not already exist
516 fib_protocol_t fp = fib_ip_proto (is_ip6);
518 if (vtep_addr_ref (&t->remote) == 1)
520 fib_node_index_t mfei;
522 fib_route_path_t path = {
523 .frp_proto = fib_proto_to_dpo (fp),
524 .frp_addr = zero_addr,
525 .frp_sw_if_index = 0xffffffff,
528 .frp_flags = FIB_ROUTE_PATH_LOCAL,
529 .frp_mitf_flags = MFIB_ITF_FLAG_FORWARD,
531 const mfib_prefix_t mpfx = {
533 .fp_len = (is_ip6 ? 128 : 32),
534 .fp_grp_addr = tun_remote_pfx.fp_addr,
538 * Setup the (*,G) to receive traffic on the mcast group
539 * - the forwarding interface is for-us
540 * - the accepting interface is that from the API
542 mfib_table_entry_path_update (t->encap_fib_index,
543 &mpfx, MFIB_SOURCE_GENEVE, &path);
545 path.frp_sw_if_index = a->mcast_sw_if_index;
546 path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
547 path.frp_mitf_flags = MFIB_ITF_FLAG_ACCEPT;
548 mfei = mfib_table_entry_path_update (t->encap_fib_index,
550 MFIB_SOURCE_GENEVE, &path);
553 * Create the mcast adjacency to send traffic to the group
555 ai = adj_mcast_add_or_lock (fp,
556 fib_proto_to_link (fp),
557 a->mcast_sw_if_index);
560 * create a new end-point
562 mcast_shared_add (&t->remote, mfei, ai);
565 dpo_id_t dpo = DPO_INVALID;
566 mcast_shared_t ep = mcast_shared_get (&t->remote);
568 /* Stack shared mcast remote mac addr rewrite on encap */
569 dpo_set (&dpo, DPO_ADJACENCY_MCAST,
570 fib_proto_to_dpo (fp), ep.mcast_adj_index);
572 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
574 flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
577 vnet_get_sw_interface (vnet_get_main (), sw_if_index)->flood_class =
582 /* deleting a tunnel: tunnel must exist */
584 return VNET_API_ERROR_NO_SUCH_ENTRY;
586 t = pool_elt_at_index (vxm->tunnels, p[0]);
588 sw_if_index = t->sw_if_index;
589 vnet_sw_interface_set_flags (vnm, t->sw_if_index, 0 /* down */ );
590 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, t->sw_if_index);
591 si->flags |= VNET_SW_INTERFACE_FLAG_HIDDEN;
593 /* make sure tunnel is removed from l2 bd or xconnect */
594 set_int_l2_mode (vxm->vlib_main, vnm, MODE_L3, t->sw_if_index, 0,
595 L2_BD_PORT_TYPE_NORMAL, 0, 0);
596 vec_add1 (vxm->free_geneve_tunnel_hw_if_indices, t->hw_if_index);
598 vxm->tunnel_index_by_sw_if_index[t->sw_if_index] = ~0;
601 hash_unset (vxm->geneve4_tunnel_by_key, key4.as_u64);
603 hash_unset_mem_free (&vxm->geneve6_tunnel_by_key, &key6);
605 if (!ip46_address_is_multicast (&t->remote))
607 vtep_addr_unref (&t->local);
608 fib_entry_untrack (t->fib_entry_index, t->sibling_index);
610 else if (vtep_addr_unref (&t->remote) == 0)
612 mcast_shared_remove (&t->remote);
615 fib_node_deinit (&t->node);
616 vec_free (t->rewrite);
617 pool_put (vxm->tunnels, t);
621 *sw_if_indexp = sw_if_index;
625 /* register udp ports */
626 if (!is_ip6 && !udp_is_valid_dst_port (UDP_DST_PORT_geneve, 1))
627 udp_register_dst_port (vxm->vlib_main, UDP_DST_PORT_geneve,
628 geneve4_input_node.index, 1);
629 if (is_ip6 && !udp_is_valid_dst_port (UDP_DST_PORT_geneve6, 0))
630 udp_register_dst_port (vxm->vlib_main, UDP_DST_PORT_geneve6,
631 geneve6_input_node.index, 0);
638 get_decap_next_for_node (u32 node_index, u32 ipv4_set)
640 geneve_main_t *vxm = &geneve_main;
641 vlib_main_t *vm = vxm->vlib_main;
642 uword input_node = (ipv4_set) ? geneve4_input_node.index :
643 geneve6_input_node.index;
645 return vlib_node_add_next (vm, input_node, node_index);
649 unformat_decap_next (unformat_input_t * input, va_list * args)
651 u32 *result = va_arg (*args, u32 *);
652 u32 ipv4_set = va_arg (*args, int);
653 geneve_main_t *vxm = &geneve_main;
654 vlib_main_t *vm = vxm->vlib_main;
658 if (unformat (input, "l2"))
659 *result = GENEVE_INPUT_NEXT_L2_INPUT;
660 else if (unformat (input, "node %U", unformat_vlib_node, vm, &node_index))
661 *result = get_decap_next_for_node (node_index, ipv4_set);
662 else if (unformat (input, "%d", &tmp))
669 static clib_error_t *
670 geneve_add_del_tunnel_command_fn (vlib_main_t * vm,
671 unformat_input_t * input,
672 vlib_cli_command_t * cmd)
674 unformat_input_t _line_input, *line_input = &_line_input;
675 ip46_address_t local, remote;
682 u32 encap_fib_index = 0;
683 u32 mcast_sw_if_index = ~0;
684 u32 decap_next_index = GENEVE_INPUT_NEXT_L2_INPUT;
688 vnet_geneve_add_del_tunnel_args_t _a, *a = &_a;
689 u32 tunnel_sw_if_index;
690 clib_error_t *error = NULL;
692 /* Cant "universally zero init" (={0}) due to GCC bug 53119 */
693 clib_memset (&local, 0, sizeof local);
694 clib_memset (&remote, 0, sizeof remote);
696 /* Get a line of input. */
697 if (!unformat_user (input, unformat_line_input, line_input))
700 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
702 if (unformat (line_input, "del"))
706 else if (unformat (line_input, "local %U",
707 unformat_ip4_address, &local.ip4))
712 else if (unformat (line_input, "remote %U",
713 unformat_ip4_address, &remote.ip4))
718 else if (unformat (line_input, "local %U",
719 unformat_ip6_address, &local.ip6))
724 else if (unformat (line_input, "remote %U",
725 unformat_ip6_address, &remote.ip6))
730 else if (unformat (line_input, "group %U %U",
731 unformat_ip4_address, &remote.ip4,
732 unformat_vnet_sw_interface,
733 vnet_get_main (), &mcast_sw_if_index))
735 grp_set = remote_set = 1;
738 else if (unformat (line_input, "group %U %U",
739 unformat_ip6_address, &remote.ip6,
740 unformat_vnet_sw_interface,
741 vnet_get_main (), &mcast_sw_if_index))
743 grp_set = remote_set = 1;
746 else if (unformat (line_input, "encap-vrf-id %d", &tmp))
748 encap_fib_index = fib_table_find (fib_ip_proto (ipv6_set), tmp);
749 if (encap_fib_index == ~0)
752 clib_error_return (0, "nonexistent encap-vrf-id %d", tmp);
756 else if (unformat (line_input, "decap-next %U", unformat_decap_next,
757 &decap_next_index, ipv4_set))
759 else if (unformat (line_input, "vni %d", &vni))
763 error = clib_error_return (0, "vni %d out of range", vni);
769 error = clib_error_return (0, "parse error: '%U'",
770 format_unformat_error, line_input);
777 error = clib_error_return (0, "tunnel local address not specified");
783 error = clib_error_return (0, "tunnel remote address not specified");
787 if (grp_set && !ip46_address_is_multicast (&remote))
789 error = clib_error_return (0, "tunnel group address not multicast");
793 if (grp_set == 0 && ip46_address_is_multicast (&remote))
795 error = clib_error_return (0, "remote address must be unicast");
799 if (grp_set && mcast_sw_if_index == ~0)
801 error = clib_error_return (0, "tunnel nonexistent multicast device");
805 if (ipv4_set && ipv6_set)
807 error = clib_error_return (0, "both IPv4 and IPv6 addresses specified");
811 if (ip46_address_cmp (&local, &remote) == 0)
814 clib_error_return (0, "local and remote addresses are identical");
818 if (decap_next_index == ~0)
820 error = clib_error_return (0, "next node not found");
826 error = clib_error_return (0, "vni not specified");
830 clib_memset (a, 0, sizeof (*a));
833 a->is_ip6 = ipv6_set;
835 #define _(x) a->x = x;
839 rv = vnet_geneve_add_del_tunnel (a, &tunnel_sw_if_index);
845 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
846 vnet_get_main (), tunnel_sw_if_index);
849 case VNET_API_ERROR_TUNNEL_EXIST:
850 error = clib_error_return (0, "tunnel already exists...");
853 case VNET_API_ERROR_NO_SUCH_ENTRY:
854 error = clib_error_return (0, "tunnel does not exist...");
858 error = clib_error_return
859 (0, "vnet_geneve_add_del_tunnel returned %d", rv);
864 unformat_free (line_input);
870 * Add or delete a GENEVE Tunnel.
872 * GENEVE provides the features needed to allow L2 bridge domains (BDs)
873 * to span multiple servers. This is done by building an L2 overlay on
874 * top of an L3 network underlay using GENEVE tunnels.
876 * This makes it possible for servers to be co-located in the same data
877 * center or be separated geographically as long as they are reachable
878 * through the underlay L3 network.
880 * You can refer to this kind of L2 overlay bridge domain as a GENEVE
884 * Example of how to create a GENEVE Tunnel:
885 * @cliexcmd{create geneve tunnel local 10.0.3.1 remote 10.0.3.3 vni 13 encap-vrf-id 7}
886 * Example of how to delete a GENEVE Tunnel:
887 * @cliexcmd{create geneve tunnel local 10.0.3.1 remote 10.0.3.3 vni 13 del}
890 VLIB_CLI_COMMAND (create_geneve_tunnel_command, static) = {
891 .path = "create geneve tunnel",
893 "create geneve tunnel local <local-vtep-addr>"
894 " {remote <remote-vtep-addr>|group <mcast-vtep-addr> <intf-name>} vni <nn>"
895 " [encap-vrf-id <nn>] [decap-next [l2|node <name>]] [del]",
896 .function = geneve_add_del_tunnel_command_fn,
900 static clib_error_t *
901 show_geneve_tunnel_command_fn (vlib_main_t * vm,
902 unformat_input_t * input,
903 vlib_cli_command_t * cmd)
905 geneve_main_t *vxm = &geneve_main;
908 if (pool_elts (vxm->tunnels) == 0)
909 vlib_cli_output (vm, "No geneve tunnels configured...");
911 pool_foreach (t, vxm->tunnels, (
913 vlib_cli_output (vm, "%U",
914 format_geneve_tunnel, t);
922 * Display all the GENEVE Tunnel entries.
925 * Example of how to display the GENEVE Tunnel entries:
926 * @cliexstart{show geneve tunnel}
927 * [0] local 10.0.3.1 remote 10.0.3.3 vni 13 encap_fib_index 0 sw_if_index 5 decap_next l2
931 VLIB_CLI_COMMAND (show_geneve_tunnel_command, static) = {
932 .path = "show geneve tunnel",
933 .short_help = "show geneve tunnel",
934 .function = show_geneve_tunnel_command_fn,
940 vnet_int_geneve_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable)
943 vnet_feature_enable_disable ("ip6-unicast", "ip6-geneve-bypass",
944 sw_if_index, is_enable, 0, 0);
946 vnet_feature_enable_disable ("ip4-unicast", "ip4-geneve-bypass",
947 sw_if_index, is_enable, 0, 0);
951 static clib_error_t *
952 set_ip_geneve_bypass (u32 is_ip6,
953 unformat_input_t * input, vlib_cli_command_t * cmd)
955 unformat_input_t _line_input, *line_input = &_line_input;
956 vnet_main_t *vnm = vnet_get_main ();
957 clib_error_t *error = 0;
958 u32 sw_if_index, is_enable;
963 if (!unformat_user (input, unformat_line_input, line_input))
966 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
969 (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
971 else if (unformat (line_input, "del"))
975 error = unformat_parse_error (line_input);
980 if (~0 == sw_if_index)
982 error = clib_error_return (0, "unknown interface `%U'",
983 format_unformat_error, line_input);
987 vnet_int_geneve_bypass_mode (sw_if_index, is_ip6, is_enable);
990 unformat_free (line_input);
995 static clib_error_t *
996 set_ip4_geneve_bypass (vlib_main_t * vm,
997 unformat_input_t * input, vlib_cli_command_t * cmd)
999 return set_ip_geneve_bypass (0, input, cmd);
1003 * This command adds the 'ip4-geneve-bypass' graph node for a given interface.
1004 * By adding the IPv4 geneve-bypass graph node to an interface, the node checks
1005 * for and validate input geneve packet and bypass ip4-lookup, ip4-local,
1006 * ip4-udp-lookup nodes to speedup geneve packet forwarding. This node will
1007 * cause extra overhead to for non-geneve packets which is kept at a minimum.
1011 * Example of graph node before ip4-geneve-bypass is enabled:
1012 * @cliexstart{show vlib graph ip4-geneve-bypass}
1013 * Name Next Previous
1014 * ip4-geneve-bypass error-drop [0]
1019 * Example of how to enable ip4-geneve-bypass on an interface:
1020 * @cliexcmd{set interface ip geneve-bypass GigabitEthernet2/0/0}
1022 * Example of graph node after ip4-geneve-bypass is enabled:
1023 * @cliexstart{show vlib graph ip4-geneve-bypass}
1024 * Name Next Previous
1025 * ip4-geneve-bypass error-drop [0] ip4-input
1026 * geneve4-input [1] ip4-input-no-checksum
1030 * Example of how to display the feature enabed on an interface:
1031 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1032 * IP feature paths configured on GigabitEthernet2/0/0...
1040 * Example of how to disable ip4-geneve-bypass on an interface:
1041 * @cliexcmd{set interface ip geneve-bypass GigabitEthernet2/0/0 del}
1045 VLIB_CLI_COMMAND (set_interface_ip_geneve_bypass_command, static) = {
1046 .path = "set interface ip geneve-bypass",
1047 .function = set_ip4_geneve_bypass,
1048 .short_help = "set interface ip geneve-bypass <interface> [del]",
1052 static clib_error_t *
1053 set_ip6_geneve_bypass (vlib_main_t * vm,
1054 unformat_input_t * input, vlib_cli_command_t * cmd)
1056 return set_ip_geneve_bypass (1, input, cmd);
1060 * This command adds the 'ip6-geneve-bypass' graph node for a given interface.
1061 * By adding the IPv6 geneve-bypass graph node to an interface, the node checks
1062 * for and validate input geneve packet and bypass ip6-lookup, ip6-local,
1063 * ip6-udp-lookup nodes to speedup geneve packet forwarding. This node will
1064 * cause extra overhead to for non-geneve packets which is kept at a minimum.
1068 * Example of graph node before ip6-geneve-bypass is enabled:
1069 * @cliexstart{show vlib graph ip6-geneve-bypass}
1070 * Name Next Previous
1071 * ip6-geneve-bypass error-drop [0]
1076 * Example of how to enable ip6-geneve-bypass on an interface:
1077 * @cliexcmd{set interface ip6 geneve-bypass GigabitEthernet2/0/0}
1079 * Example of graph node after ip6-geneve-bypass is enabled:
1080 * @cliexstart{show vlib graph ip6-geneve-bypass}
1081 * Name Next Previous
1082 * ip6-geneve-bypass error-drop [0] ip6-input
1083 * geneve6-input [1] ip4-input-no-checksum
1087 * Example of how to display the feature enabed on an interface:
1088 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1089 * IP feature paths configured on GigabitEthernet2/0/0...
1097 * Example of how to disable ip6-geneve-bypass on an interface:
1098 * @cliexcmd{set interface ip6 geneve-bypass GigabitEthernet2/0/0 del}
1102 VLIB_CLI_COMMAND (set_interface_ip6_geneve_bypass_command, static) = {
1103 .path = "set interface ip6 geneve-bypass",
1104 .function = set_ip6_geneve_bypass,
1105 .short_help = "set interface ip6 geneve-bypass <interface> [del]",
1110 geneve_init (vlib_main_t * vm)
1112 geneve_main_t *vxm = &geneve_main;
1114 vxm->vnet_main = vnet_get_main ();
1115 vxm->vlib_main = vm;
1117 /* initialize the ip6 hash */
1118 vxm->geneve6_tunnel_by_key = hash_create_mem (0,
1119 sizeof (geneve6_tunnel_key_t),
1121 vxm->vtep6 = hash_create_mem (0, sizeof (ip6_address_t), sizeof (uword));
1122 vxm->mcast_shared = hash_create_mem (0,
1123 sizeof (ip46_address_t),
1124 sizeof (mcast_shared_t));
1126 fib_node_register_type (FIB_NODE_TYPE_GENEVE_TUNNEL, &geneve_vft);
1131 VLIB_INIT_FUNCTION (geneve_init);
1134 * fd.io coding-style-patch-verification: ON
1137 * eval: (c-set-style "gnu")