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;
295 typedef CLIB_PACKED (union
299 fib_node_index_t mfib_entry_index;
300 adj_index_t mcast_adj_index;
304 static inline mcast_shared_t
305 mcast_shared_get (ip46_address_t * ip)
307 ASSERT (ip46_address_is_multicast (ip));
308 uword *p = hash_get_mem (geneve_main.mcast_shared, ip);
310 return (mcast_shared_t)
316 mcast_shared_add (ip46_address_t * remote,
317 fib_node_index_t mfei, adj_index_t ai)
319 mcast_shared_t new_ep = {
320 .mcast_adj_index = ai,
321 .mfib_entry_index = mfei,
324 hash_set_mem_alloc (&geneve_main.mcast_shared, remote, new_ep.as_u64);
328 mcast_shared_remove (ip46_address_t * remote)
330 mcast_shared_t ep = mcast_shared_get (remote);
332 adj_unlock (ep.mcast_adj_index);
333 mfib_table_entry_delete_index (ep.mfib_entry_index, MFIB_SOURCE_GENEVE);
335 hash_unset_mem_free (&geneve_main.mcast_shared, remote);
338 int vnet_geneve_add_del_tunnel
339 (vnet_geneve_add_del_tunnel_args_t * a, u32 * sw_if_indexp)
341 geneve_main_t *vxm = &geneve_main;
342 geneve_tunnel_t *t = 0;
343 vnet_main_t *vnm = vxm->vnet_main;
345 u32 hw_if_index = ~0;
346 u32 sw_if_index = ~0;
348 geneve4_tunnel_key_t key4;
349 geneve6_tunnel_key_t key6;
350 u32 is_ip6 = a->is_ip6;
354 key4.remote = a->remote.ip4.as_u32;
356 clib_host_to_net_u32 ((a->vni << GENEVE_VNI_SHIFT) & GENEVE_VNI_MASK);
357 p = hash_get (vxm->geneve4_tunnel_by_key, key4.as_u64);
361 key6.remote = a->remote.ip6;
363 clib_host_to_net_u32 ((a->vni << GENEVE_VNI_SHIFT) & GENEVE_VNI_MASK);
364 p = hash_get_mem (vxm->geneve6_tunnel_by_key, &key6);
369 l2input_main_t *l2im = &l2input_main;
371 /* adding a tunnel: tunnel must not already exist */
373 return VNET_API_ERROR_TUNNEL_EXIST;
375 /*if not set explicitly, default to l2 */
376 if (a->decap_next_index == ~0)
377 a->decap_next_index = GENEVE_INPUT_NEXT_L2_INPUT;
378 if (!geneve_decap_next_is_valid (vxm, is_ip6, a->decap_next_index))
379 return VNET_API_ERROR_INVALID_DECAP_NEXT;
381 pool_get_aligned (vxm->tunnels, t, CLIB_CACHE_LINE_BYTES);
382 clib_memset (t, 0, sizeof (*t));
384 /* copy from arg structure */
385 #define _(x) t->x = a->x;
389 rv = geneve_rewrite (t, is_ip6);
392 pool_put (vxm->tunnels, t);
398 hash_set_mem_alloc (&vxm->geneve6_tunnel_by_key, &key6,
401 hash_set (vxm->geneve4_tunnel_by_key, key4.as_u64, t - vxm->tunnels);
403 vnet_hw_interface_t *hi;
404 if (vec_len (vxm->free_geneve_tunnel_hw_if_indices) > 0)
406 vnet_interface_main_t *im = &vnm->interface_main;
407 hw_if_index = vxm->free_geneve_tunnel_hw_if_indices
408 [vec_len (vxm->free_geneve_tunnel_hw_if_indices) - 1];
409 _vec_len (vxm->free_geneve_tunnel_hw_if_indices) -= 1;
411 hi = vnet_get_hw_interface (vnm, hw_if_index);
412 hi->dev_instance = t - vxm->tunnels;
413 hi->hw_instance = hi->dev_instance;
415 /* clear old stats of freed tunnel before reuse */
416 sw_if_index = hi->sw_if_index;
417 vnet_interface_counter_lock (im);
418 vlib_zero_combined_counter
419 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX],
421 vlib_zero_combined_counter (&im->combined_sw_if_counters
422 [VNET_INTERFACE_COUNTER_RX],
424 vlib_zero_simple_counter (&im->sw_if_counters
425 [VNET_INTERFACE_COUNTER_DROP],
427 vnet_interface_counter_unlock (im);
431 hw_if_index = vnet_register_interface
432 (vnm, geneve_device_class.index, t - vxm->tunnels,
433 geneve_hw_class.index, t - vxm->tunnels);
434 hi = vnet_get_hw_interface (vnm, hw_if_index);
437 /* Set geneve tunnel output node */
438 u32 encap_index = !is_ip6 ?
439 geneve4_encap_node.index : geneve6_encap_node.index;
440 vnet_set_interface_output_node (vnm, hw_if_index, encap_index);
442 t->hw_if_index = hw_if_index;
443 t->sw_if_index = sw_if_index = hi->sw_if_index;
445 vec_validate_init_empty (vxm->tunnel_index_by_sw_if_index, sw_if_index,
447 vxm->tunnel_index_by_sw_if_index[sw_if_index] = t - vxm->tunnels;
449 /* setup l2 input config with l2 feature and bd 0 to drop packet */
450 vec_validate (l2im->configs, sw_if_index);
451 l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
452 l2im->configs[sw_if_index].bd_index = 0;
454 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
455 si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
456 vnet_sw_interface_set_flags (vnm, sw_if_index,
457 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
459 fib_node_init (&t->node, FIB_NODE_TYPE_GENEVE_TUNNEL);
460 fib_prefix_t tun_remote_pfx;
461 vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
463 fib_prefix_from_ip46_addr (&t->remote, &tun_remote_pfx);
464 if (!ip46_address_is_multicast (&t->remote))
467 * source the FIB entry for the tunnel's destination
468 * and become a child thereof. The tunnel will then get poked
469 * when the forwarding for the entry updates, and the tunnel can
470 * re-stack accordingly
472 vtep_addr_ref (&vxm->vtep_table, t->encap_fib_index, &t->local);
473 t->fib_entry_index = fib_entry_track (t->encap_fib_index,
475 FIB_NODE_TYPE_GENEVE_TUNNEL,
478 geneve_tunnel_restack_dpo (t);
482 /* Multicast tunnel -
483 * as the same mcast group can be used for mutiple mcast tunnels
484 * with different VNIs, create the output fib adjecency only if
485 * it does not already exist
487 fib_protocol_t fp = fib_ip_proto (is_ip6);
489 if (vtep_addr_ref (&vxm->vtep_table,
490 t->encap_fib_index, &t->remote) == 1)
492 fib_node_index_t mfei;
494 fib_route_path_t path = {
495 .frp_proto = fib_proto_to_dpo (fp),
496 .frp_addr = zero_addr,
497 .frp_sw_if_index = 0xffffffff,
500 .frp_flags = FIB_ROUTE_PATH_LOCAL,
501 .frp_mitf_flags = MFIB_ITF_FLAG_FORWARD,
503 const mfib_prefix_t mpfx = {
505 .fp_len = (is_ip6 ? 128 : 32),
506 .fp_grp_addr = tun_remote_pfx.fp_addr,
510 * Setup the (*,G) to receive traffic on the mcast group
511 * - the forwarding interface is for-us
512 * - the accepting interface is that from the API
514 mfib_table_entry_path_update (t->encap_fib_index,
515 &mpfx, MFIB_SOURCE_GENEVE, &path);
517 path.frp_sw_if_index = a->mcast_sw_if_index;
518 path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
519 path.frp_mitf_flags = MFIB_ITF_FLAG_ACCEPT;
520 mfei = mfib_table_entry_path_update (t->encap_fib_index,
522 MFIB_SOURCE_GENEVE, &path);
525 * Create the mcast adjacency to send traffic to the group
527 ai = adj_mcast_add_or_lock (fp,
528 fib_proto_to_link (fp),
529 a->mcast_sw_if_index);
532 * create a new end-point
534 mcast_shared_add (&t->remote, mfei, ai);
537 dpo_id_t dpo = DPO_INVALID;
538 mcast_shared_t ep = mcast_shared_get (&t->remote);
540 /* Stack shared mcast remote mac addr rewrite on encap */
541 dpo_set (&dpo, DPO_ADJACENCY_MCAST,
542 fib_proto_to_dpo (fp), ep.mcast_adj_index);
544 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
546 flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
549 vnet_get_sw_interface (vnet_get_main (), sw_if_index)->flood_class =
554 /* deleting a tunnel: tunnel must exist */
556 return VNET_API_ERROR_NO_SUCH_ENTRY;
558 t = pool_elt_at_index (vxm->tunnels, p[0]);
560 sw_if_index = t->sw_if_index;
561 vnet_sw_interface_set_flags (vnm, t->sw_if_index, 0 /* down */ );
562 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, t->sw_if_index);
563 si->flags |= VNET_SW_INTERFACE_FLAG_HIDDEN;
565 /* make sure tunnel is removed from l2 bd or xconnect */
566 set_int_l2_mode (vxm->vlib_main, vnm, MODE_L3, t->sw_if_index, 0,
567 L2_BD_PORT_TYPE_NORMAL, 0, 0);
568 vec_add1 (vxm->free_geneve_tunnel_hw_if_indices, t->hw_if_index);
570 vxm->tunnel_index_by_sw_if_index[t->sw_if_index] = ~0;
573 hash_unset (vxm->geneve4_tunnel_by_key, key4.as_u64);
575 hash_unset_mem_free (&vxm->geneve6_tunnel_by_key, &key6);
577 if (!ip46_address_is_multicast (&t->remote))
579 vtep_addr_unref (&vxm->vtep_table, t->encap_fib_index, &t->local);
580 fib_entry_untrack (t->fib_entry_index, t->sibling_index);
582 else if (vtep_addr_unref (&vxm->vtep_table,
583 t->encap_fib_index, &t->remote) == 0)
585 mcast_shared_remove (&t->remote);
588 fib_node_deinit (&t->node);
589 vec_free (t->rewrite);
590 pool_put (vxm->tunnels, t);
594 *sw_if_indexp = sw_if_index;
598 /* register udp ports */
599 if (!is_ip6 && !udp_is_valid_dst_port (UDP_DST_PORT_geneve, 1))
600 udp_register_dst_port (vxm->vlib_main, UDP_DST_PORT_geneve,
601 geneve4_input_node.index, 1);
602 if (is_ip6 && !udp_is_valid_dst_port (UDP_DST_PORT_geneve6, 0))
603 udp_register_dst_port (vxm->vlib_main, UDP_DST_PORT_geneve6,
604 geneve6_input_node.index, 0);
611 get_decap_next_for_node (u32 node_index, u32 ipv4_set)
613 geneve_main_t *vxm = &geneve_main;
614 vlib_main_t *vm = vxm->vlib_main;
615 uword input_node = (ipv4_set) ? geneve4_input_node.index :
616 geneve6_input_node.index;
618 return vlib_node_add_next (vm, input_node, node_index);
622 unformat_decap_next (unformat_input_t * input, va_list * args)
624 u32 *result = va_arg (*args, u32 *);
625 u32 ipv4_set = va_arg (*args, int);
626 geneve_main_t *vxm = &geneve_main;
627 vlib_main_t *vm = vxm->vlib_main;
631 if (unformat (input, "l2"))
632 *result = GENEVE_INPUT_NEXT_L2_INPUT;
633 else if (unformat (input, "node %U", unformat_vlib_node, vm, &node_index))
634 *result = get_decap_next_for_node (node_index, ipv4_set);
635 else if (unformat (input, "%d", &tmp))
642 static clib_error_t *
643 geneve_add_del_tunnel_command_fn (vlib_main_t * vm,
644 unformat_input_t * input,
645 vlib_cli_command_t * cmd)
647 unformat_input_t _line_input, *line_input = &_line_input;
648 ip46_address_t local, remote;
655 u32 encap_fib_index = 0;
656 u32 mcast_sw_if_index = ~0;
657 u32 decap_next_index = GENEVE_INPUT_NEXT_L2_INPUT;
661 vnet_geneve_add_del_tunnel_args_t _a, *a = &_a;
662 u32 tunnel_sw_if_index;
663 clib_error_t *error = NULL;
665 /* Cant "universally zero init" (={0}) due to GCC bug 53119 */
666 clib_memset (&local, 0, sizeof local);
667 clib_memset (&remote, 0, sizeof remote);
669 /* Get a line of input. */
670 if (!unformat_user (input, unformat_line_input, line_input))
673 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
675 if (unformat (line_input, "del"))
679 else if (unformat (line_input, "local %U",
680 unformat_ip4_address, &local.ip4))
685 else if (unformat (line_input, "remote %U",
686 unformat_ip4_address, &remote.ip4))
691 else if (unformat (line_input, "local %U",
692 unformat_ip6_address, &local.ip6))
697 else if (unformat (line_input, "remote %U",
698 unformat_ip6_address, &remote.ip6))
703 else if (unformat (line_input, "group %U %U",
704 unformat_ip4_address, &remote.ip4,
705 unformat_vnet_sw_interface,
706 vnet_get_main (), &mcast_sw_if_index))
708 grp_set = remote_set = 1;
711 else if (unformat (line_input, "group %U %U",
712 unformat_ip6_address, &remote.ip6,
713 unformat_vnet_sw_interface,
714 vnet_get_main (), &mcast_sw_if_index))
716 grp_set = remote_set = 1;
719 else if (unformat (line_input, "encap-vrf-id %d", &tmp))
721 encap_fib_index = fib_table_find (fib_ip_proto (ipv6_set), tmp);
722 if (encap_fib_index == ~0)
725 clib_error_return (0, "nonexistent encap-vrf-id %d", tmp);
729 else if (unformat (line_input, "decap-next %U", unformat_decap_next,
730 &decap_next_index, ipv4_set))
732 else if (unformat (line_input, "vni %d", &vni))
736 error = clib_error_return (0, "vni %d out of range", vni);
742 error = clib_error_return (0, "parse error: '%U'",
743 format_unformat_error, line_input);
750 error = clib_error_return (0, "tunnel local address not specified");
756 error = clib_error_return (0, "tunnel remote address not specified");
760 if (grp_set && !ip46_address_is_multicast (&remote))
762 error = clib_error_return (0, "tunnel group address not multicast");
766 if (grp_set == 0 && ip46_address_is_multicast (&remote))
768 error = clib_error_return (0, "remote address must be unicast");
772 if (grp_set && mcast_sw_if_index == ~0)
774 error = clib_error_return (0, "tunnel nonexistent multicast device");
778 if (ipv4_set && ipv6_set)
780 error = clib_error_return (0, "both IPv4 and IPv6 addresses specified");
784 if (ip46_address_cmp (&local, &remote) == 0)
787 clib_error_return (0, "local and remote addresses are identical");
791 if (decap_next_index == ~0)
793 error = clib_error_return (0, "next node not found");
799 error = clib_error_return (0, "vni not specified");
803 clib_memset (a, 0, sizeof (*a));
806 a->is_ip6 = ipv6_set;
808 #define _(x) a->x = x;
812 rv = vnet_geneve_add_del_tunnel (a, &tunnel_sw_if_index);
818 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
819 vnet_get_main (), tunnel_sw_if_index);
822 case VNET_API_ERROR_TUNNEL_EXIST:
823 error = clib_error_return (0, "tunnel already exists...");
826 case VNET_API_ERROR_NO_SUCH_ENTRY:
827 error = clib_error_return (0, "tunnel does not exist...");
831 error = clib_error_return
832 (0, "vnet_geneve_add_del_tunnel returned %d", rv);
837 unformat_free (line_input);
843 * Add or delete a GENEVE Tunnel.
845 * GENEVE provides the features needed to allow L2 bridge domains (BDs)
846 * to span multiple servers. This is done by building an L2 overlay on
847 * top of an L3 network underlay using GENEVE tunnels.
849 * This makes it possible for servers to be co-located in the same data
850 * center or be separated geographically as long as they are reachable
851 * through the underlay L3 network.
853 * You can refer to this kind of L2 overlay bridge domain as a GENEVE
857 * Example of how to create a GENEVE Tunnel:
858 * @cliexcmd{create geneve tunnel local 10.0.3.1 remote 10.0.3.3 vni 13 encap-vrf-id 7}
859 * Example of how to delete a GENEVE Tunnel:
860 * @cliexcmd{create geneve tunnel local 10.0.3.1 remote 10.0.3.3 vni 13 del}
863 VLIB_CLI_COMMAND (create_geneve_tunnel_command, static) = {
864 .path = "create geneve tunnel",
866 "create geneve tunnel local <local-vtep-addr>"
867 " {remote <remote-vtep-addr>|group <mcast-vtep-addr> <intf-name>} vni <nn>"
868 " [encap-vrf-id <nn>] [decap-next [l2|node <name>]] [del]",
869 .function = geneve_add_del_tunnel_command_fn,
873 static clib_error_t *
874 show_geneve_tunnel_command_fn (vlib_main_t * vm,
875 unformat_input_t * input,
876 vlib_cli_command_t * cmd)
878 geneve_main_t *vxm = &geneve_main;
881 if (pool_elts (vxm->tunnels) == 0)
882 vlib_cli_output (vm, "No geneve tunnels configured...");
884 pool_foreach (t, vxm->tunnels, (
886 vlib_cli_output (vm, "%U",
887 format_geneve_tunnel, t);
895 * Display all the GENEVE Tunnel entries.
898 * Example of how to display the GENEVE Tunnel entries:
899 * @cliexstart{show geneve tunnel}
900 * [0] local 10.0.3.1 remote 10.0.3.3 vni 13 encap_fib_index 0 sw_if_index 5 decap_next l2
904 VLIB_CLI_COMMAND (show_geneve_tunnel_command, static) = {
905 .path = "show geneve tunnel",
906 .short_help = "show geneve tunnel",
907 .function = show_geneve_tunnel_command_fn,
913 vnet_int_geneve_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable)
916 vnet_feature_enable_disable ("ip6-unicast", "ip6-geneve-bypass",
917 sw_if_index, is_enable, 0, 0);
919 vnet_feature_enable_disable ("ip4-unicast", "ip4-geneve-bypass",
920 sw_if_index, is_enable, 0, 0);
924 static clib_error_t *
925 set_ip_geneve_bypass (u32 is_ip6,
926 unformat_input_t * input, vlib_cli_command_t * cmd)
928 unformat_input_t _line_input, *line_input = &_line_input;
929 vnet_main_t *vnm = vnet_get_main ();
930 clib_error_t *error = 0;
931 u32 sw_if_index, is_enable;
936 if (!unformat_user (input, unformat_line_input, line_input))
939 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
942 (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
944 else if (unformat (line_input, "del"))
948 error = unformat_parse_error (line_input);
953 if (~0 == sw_if_index)
955 error = clib_error_return (0, "unknown interface `%U'",
956 format_unformat_error, line_input);
960 vnet_int_geneve_bypass_mode (sw_if_index, is_ip6, is_enable);
963 unformat_free (line_input);
968 static clib_error_t *
969 set_ip4_geneve_bypass (vlib_main_t * vm,
970 unformat_input_t * input, vlib_cli_command_t * cmd)
972 return set_ip_geneve_bypass (0, input, cmd);
976 * This command adds the 'ip4-geneve-bypass' graph node for a given interface.
977 * By adding the IPv4 geneve-bypass graph node to an interface, the node checks
978 * for and validate input geneve packet and bypass ip4-lookup, ip4-local,
979 * ip4-udp-lookup nodes to speedup geneve packet forwarding. This node will
980 * cause extra overhead to for non-geneve packets which is kept at a minimum.
984 * Example of graph node before ip4-geneve-bypass is enabled:
985 * @cliexstart{show vlib graph ip4-geneve-bypass}
987 * ip4-geneve-bypass error-drop [0]
992 * Example of how to enable ip4-geneve-bypass on an interface:
993 * @cliexcmd{set interface ip geneve-bypass GigabitEthernet2/0/0}
995 * Example of graph node after ip4-geneve-bypass is enabled:
996 * @cliexstart{show vlib graph ip4-geneve-bypass}
998 * ip4-geneve-bypass error-drop [0] ip4-input
999 * geneve4-input [1] ip4-input-no-checksum
1003 * Example of how to display the feature enabed on an interface:
1004 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1005 * IP feature paths configured on GigabitEthernet2/0/0...
1013 * Example of how to disable ip4-geneve-bypass on an interface:
1014 * @cliexcmd{set interface ip geneve-bypass GigabitEthernet2/0/0 del}
1018 VLIB_CLI_COMMAND (set_interface_ip_geneve_bypass_command, static) = {
1019 .path = "set interface ip geneve-bypass",
1020 .function = set_ip4_geneve_bypass,
1021 .short_help = "set interface ip geneve-bypass <interface> [del]",
1025 static clib_error_t *
1026 set_ip6_geneve_bypass (vlib_main_t * vm,
1027 unformat_input_t * input, vlib_cli_command_t * cmd)
1029 return set_ip_geneve_bypass (1, input, cmd);
1033 * This command adds the 'ip6-geneve-bypass' graph node for a given interface.
1034 * By adding the IPv6 geneve-bypass graph node to an interface, the node checks
1035 * for and validate input geneve packet and bypass ip6-lookup, ip6-local,
1036 * ip6-udp-lookup nodes to speedup geneve packet forwarding. This node will
1037 * cause extra overhead to for non-geneve packets which is kept at a minimum.
1041 * Example of graph node before ip6-geneve-bypass is enabled:
1042 * @cliexstart{show vlib graph ip6-geneve-bypass}
1043 * Name Next Previous
1044 * ip6-geneve-bypass error-drop [0]
1049 * Example of how to enable ip6-geneve-bypass on an interface:
1050 * @cliexcmd{set interface ip6 geneve-bypass GigabitEthernet2/0/0}
1052 * Example of graph node after ip6-geneve-bypass is enabled:
1053 * @cliexstart{show vlib graph ip6-geneve-bypass}
1054 * Name Next Previous
1055 * ip6-geneve-bypass error-drop [0] ip6-input
1056 * geneve6-input [1] ip4-input-no-checksum
1060 * Example of how to display the feature enabed on an interface:
1061 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1062 * IP feature paths configured on GigabitEthernet2/0/0...
1070 * Example of how to disable ip6-geneve-bypass on an interface:
1071 * @cliexcmd{set interface ip6 geneve-bypass GigabitEthernet2/0/0 del}
1075 VLIB_CLI_COMMAND (set_interface_ip6_geneve_bypass_command, static) = {
1076 .path = "set interface ip6 geneve-bypass",
1077 .function = set_ip6_geneve_bypass,
1078 .short_help = "set interface ip6 geneve-bypass <interface> [del]",
1083 geneve_init (vlib_main_t * vm)
1085 geneve_main_t *vxm = &geneve_main;
1087 vxm->vnet_main = vnet_get_main ();
1088 vxm->vlib_main = vm;
1090 /* initialize the ip6 hash */
1091 vxm->geneve6_tunnel_by_key = hash_create_mem (0,
1092 sizeof (geneve6_tunnel_key_t),
1094 vxm->vtep_table = vtep_table_create ();
1095 vxm->mcast_shared = hash_create_mem (0,
1096 sizeof (ip46_address_t),
1097 sizeof (mcast_shared_t));
1099 fib_node_register_type (FIB_NODE_TYPE_GENEVE_TUNNEL, &geneve_vft);
1104 VLIB_INIT_FUNCTION (geneve_init);
1107 * fd.io coding-style-patch-verification: ON
1110 * eval: (c-set-style "gnu")