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/mfib/mfib_table.h>
20 #include <vnet/adj/adj_mcast.h>
21 #include <vnet/interface.h>
22 #include <vlib/vlib.h>
28 * GENEVE provides the features needed to allow L2 bridge domains (BDs)
29 * to span multiple servers. This is done by building an L2 overlay on
30 * top of an L3 network underlay using GENEVE tunnels.
32 * This makes it possible for servers to be co-located in the same data
33 * center or be separated geographically as long as they are reachable
34 * through the underlay L3 network.
38 geneve_main_t geneve_main;
41 format_geneve_encap_trace (u8 * s, va_list * args)
43 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
44 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
45 geneve_encap_trace_t *t = va_arg (*args, geneve_encap_trace_t *);
47 s = format (s, "GENEVE encap to geneve_tunnel%d vni %d",
48 t->tunnel_index, t->vni);
53 format_decap_next (u8 * s, va_list * args)
55 u32 next_index = va_arg (*args, u32);
59 case GENEVE_INPUT_NEXT_DROP:
60 return format (s, "drop");
61 case GENEVE_INPUT_NEXT_L2_INPUT:
62 return format (s, "l2");
64 return format (s, "index %d", next_index);
70 format_geneve_tunnel (u8 * s, va_list * args)
72 geneve_tunnel_t *t = va_arg (*args, geneve_tunnel_t *);
73 geneve_main_t *ngm = &geneve_main;
75 s = format (s, "[%d] lcl %U rmt %U vni %d fib-idx %d sw-if-idx %d ",
77 format_ip46_address, &t->local, IP46_TYPE_ANY,
78 format_ip46_address, &t->remote, IP46_TYPE_ANY,
79 t->vni, t->encap_fib_index, t->sw_if_index);
81 s = format (s, "encap-dpo-idx %d ", t->next_dpo.dpoi_index);
82 s = format (s, "decap-next-%U ", format_decap_next, t->decap_next_index);
84 if (PREDICT_FALSE (ip46_address_is_multicast (&t->remote)))
85 s = format (s, "mcast-sw-if-idx %d ", t->mcast_sw_if_index);
91 format_geneve_name (u8 * s, va_list * args)
93 u32 dev_instance = va_arg (*args, u32);
94 return format (s, "geneve_tunnel%d", dev_instance);
98 geneve_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
100 u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
101 VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
102 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
104 return /* no error */ 0;
108 VNET_DEVICE_CLASS (geneve_device_class, static) = {
110 .format_device_name = format_geneve_name,
111 .format_tx_trace = format_geneve_encap_trace,
112 .admin_up_down_function = geneve_interface_admin_up_down,
117 format_geneve_header_with_length (u8 * s, va_list * args)
119 u32 dev_instance = va_arg (*args, u32);
120 s = format (s, "unimplemented dev %u", dev_instance);
125 VNET_HW_INTERFACE_CLASS (geneve_hw_class) = {
127 .format_header = format_geneve_header_with_length,
128 .build_rewrite = default_build_rewrite,
133 geneve_tunnel_restack_dpo (geneve_tunnel_t * t)
135 dpo_id_t dpo = DPO_INVALID;
136 u32 encap_index = ip46_address_is_ip4 (&t->remote) ?
137 geneve4_encap_node.index : geneve6_encap_node.index;
138 fib_forward_chain_type_t forw_type = ip46_address_is_ip4 (&t->remote) ?
139 FIB_FORW_CHAIN_TYPE_UNICAST_IP4 : FIB_FORW_CHAIN_TYPE_UNICAST_IP6;
141 fib_entry_contribute_forwarding (t->fib_entry_index, forw_type, &dpo);
142 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
146 static geneve_tunnel_t *
147 geneve_tunnel_from_fib_node (fib_node_t * node)
149 ASSERT (FIB_NODE_TYPE_GENEVE_TUNNEL == node->fn_type);
150 return ((geneve_tunnel_t *) (((char *) node) -
151 STRUCT_OFFSET_OF (geneve_tunnel_t, node)));
155 * Function definition to backwalk a FIB node -
156 * Here we will restack the new dpo of GENEVE DIP to encap node.
158 static fib_node_back_walk_rc_t
159 geneve_tunnel_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
161 geneve_tunnel_restack_dpo (geneve_tunnel_from_fib_node (node));
162 return (FIB_NODE_BACK_WALK_CONTINUE);
166 * Function definition to get a FIB node from its index
169 geneve_tunnel_fib_node_get (fib_node_index_t index)
172 geneve_main_t *vxm = &geneve_main;
174 t = pool_elt_at_index (vxm->tunnels, index);
180 * Function definition to inform the FIB node that its last lock has gone.
183 geneve_tunnel_last_lock_gone (fib_node_t * node)
186 * The GENEVE tunnel is a root of the graph. As such
187 * it never has children and thus is never locked.
193 * Virtual function table registered by GENEVE tunnels
194 * for participation in the FIB object graph.
196 const static fib_node_vft_t geneve_vft = {
197 .fnv_get = geneve_tunnel_fib_node_get,
198 .fnv_last_lock = geneve_tunnel_last_lock_gone,
199 .fnv_back_walk = geneve_tunnel_back_walk,
203 #define foreach_copy_field \
205 _(mcast_sw_if_index) \
207 _(decap_next_index) \
212 geneve_rewrite (geneve_tunnel_t * t, bool is_ip6)
216 ip4_geneve_header_t *h4;
217 ip6_geneve_header_t *h6;
222 int len = is_ip6 ? sizeof *r.h6 : sizeof *r.h4;
223 #if SUPPORT_OPTIONS_HEADER==1
224 len += t->options_len;
227 vec_validate_aligned (r.rw, len - 1, CLIB_CACHE_LINE_BYTES);
230 geneve_header_t *geneve;
231 /* Fixed portion of the (outer) ip header */
234 ip4_header_t *ip = &r.h4->ip4;
235 udp = &r.h4->udp, geneve = &r.h4->geneve;
236 ip->ip_version_and_header_length = 0x45;
238 ip->protocol = IP_PROTOCOL_UDP;
240 ip->src_address = t->local.ip4;
241 ip->dst_address = t->remote.ip4;
243 /* we fix up the ip4 header length and checksum after-the-fact */
244 ip->checksum = ip4_header_checksum (ip);
248 ip6_header_t *ip = &r.h6->ip6;
249 udp = &r.h6->udp, geneve = &r.h6->geneve;
250 ip->ip_version_traffic_class_and_flow_label =
251 clib_host_to_net_u32 (6 << 28);
253 ip->protocol = IP_PROTOCOL_UDP;
255 ip->src_address = t->local.ip6;
256 ip->dst_address = t->remote.ip6;
259 /* UDP header, randomize local port on something, maybe? */
260 udp->src_port = clib_host_to_net_u16 (5251);
261 udp->dst_port = clib_host_to_net_u16 (UDP_DST_PORT_geneve);
264 vnet_set_geneve_version (geneve, GENEVE_VERSION);
265 #if SUPPORT_OPTIONS_HEADER==1
266 vnet_set_geneve_options_len (geneve, t->options_len);
268 vnet_set_geneve_options_len (geneve, 0);
270 vnet_set_geneve_oamframe_bit (geneve, 0);
271 vnet_set_geneve_critical_bit (geneve, 0);
272 vnet_set_geneve_protocol (geneve, GENEVE_ETH_PROTOCOL);
274 vnet_geneve_hdr_1word_hton (geneve);
276 vnet_set_geneve_vni (geneve, t->vni);
283 geneve_decap_next_is_valid (geneve_main_t * vxm, u32 is_ip6,
284 u32 decap_next_index)
286 vlib_main_t *vm = vxm->vlib_main;
288 (!is_ip6) ? geneve4_input_node.index : geneve6_input_node.index;
289 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, input_idx);
291 return decap_next_index < r->n_next_nodes;
295 vtep_addr_ref (ip46_address_t * ip)
297 uword *vtep = ip46_address_is_ip4 (ip) ?
298 hash_get (geneve_main.vtep4, ip->ip4.as_u32) :
299 hash_get_mem (geneve_main.vtep6, &ip->ip6);
302 ip46_address_is_ip4 (ip) ?
303 hash_set (geneve_main.vtep4, ip->ip4.as_u32, 1) :
304 hash_set_mem_alloc (&geneve_main.vtep6, &ip->ip6, 1);
309 vtep_addr_unref (ip46_address_t * ip)
311 uword *vtep = ip46_address_is_ip4 (ip) ?
312 hash_get (geneve_main.vtep4, ip->ip4.as_u32) :
313 hash_get_mem (geneve_main.vtep6, &ip->ip6);
317 ip46_address_is_ip4 (ip) ?
318 hash_unset (geneve_main.vtep4, ip->ip4.as_u32) :
319 hash_unset_mem_free (&geneve_main.vtep6, &ip->ip6);
323 typedef CLIB_PACKED (union
327 fib_node_index_t mfib_entry_index;
328 adj_index_t mcast_adj_index;
332 static inline mcast_shared_t
333 mcast_shared_get (ip46_address_t * ip)
335 ASSERT (ip46_address_is_multicast (ip));
336 uword *p = hash_get_mem (geneve_main.mcast_shared, ip);
338 return (mcast_shared_t)
344 mcast_shared_add (ip46_address_t * remote,
345 fib_node_index_t mfei, adj_index_t ai)
347 mcast_shared_t new_ep = {
348 .mcast_adj_index = ai,
349 .mfib_entry_index = mfei,
352 hash_set_mem_alloc (&geneve_main.mcast_shared, remote, new_ep.as_u64);
356 mcast_shared_remove (ip46_address_t * remote)
358 mcast_shared_t ep = mcast_shared_get (remote);
360 adj_unlock (ep.mcast_adj_index);
361 mfib_table_entry_delete_index (ep.mfib_entry_index, MFIB_SOURCE_GENEVE);
363 hash_unset_mem_free (&geneve_main.mcast_shared, remote);
366 int vnet_geneve_add_del_tunnel
367 (vnet_geneve_add_del_tunnel_args_t * a, u32 * sw_if_indexp)
369 geneve_main_t *vxm = &geneve_main;
370 geneve_tunnel_t *t = 0;
371 vnet_main_t *vnm = vxm->vnet_main;
373 u32 hw_if_index = ~0;
374 u32 sw_if_index = ~0;
376 geneve4_tunnel_key_t key4;
377 geneve6_tunnel_key_t key6;
378 u32 is_ip6 = a->is_ip6;
382 key4.remote = a->remote.ip4.as_u32;
384 clib_host_to_net_u32 ((a->vni << GENEVE_VNI_SHIFT) & GENEVE_VNI_MASK);
385 p = hash_get (vxm->geneve4_tunnel_by_key, key4.as_u64);
389 key6.remote = a->remote.ip6;
391 clib_host_to_net_u32 ((a->vni << GENEVE_VNI_SHIFT) & GENEVE_VNI_MASK);
392 p = hash_get_mem (vxm->geneve6_tunnel_by_key, &key6);
397 l2input_main_t *l2im = &l2input_main;
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 = GENEVE_INPUT_NEXT_L2_INPUT;
406 if (!geneve_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 clib_memset (t, 0, sizeof (*t));
412 /* copy from arg structure */
413 #define _(x) t->x = a->x;
417 rv = geneve_rewrite (t, is_ip6);
420 pool_put (vxm->tunnels, t);
426 hash_set_mem_alloc (&vxm->geneve6_tunnel_by_key, &key6,
429 hash_set (vxm->geneve4_tunnel_by_key, key4.as_u64, t - vxm->tunnels);
431 vnet_hw_interface_t *hi;
432 if (vec_len (vxm->free_geneve_tunnel_hw_if_indices) > 0)
434 vnet_interface_main_t *im = &vnm->interface_main;
435 hw_if_index = vxm->free_geneve_tunnel_hw_if_indices
436 [vec_len (vxm->free_geneve_tunnel_hw_if_indices) - 1];
437 _vec_len (vxm->free_geneve_tunnel_hw_if_indices) -= 1;
439 hi = vnet_get_hw_interface (vnm, hw_if_index);
440 hi->dev_instance = t - vxm->tunnels;
441 hi->hw_instance = hi->dev_instance;
443 /* clear old stats of freed tunnel before reuse */
444 sw_if_index = hi->sw_if_index;
445 vnet_interface_counter_lock (im);
446 vlib_zero_combined_counter
447 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX],
449 vlib_zero_combined_counter (&im->combined_sw_if_counters
450 [VNET_INTERFACE_COUNTER_RX],
452 vlib_zero_simple_counter (&im->sw_if_counters
453 [VNET_INTERFACE_COUNTER_DROP],
455 vnet_interface_counter_unlock (im);
459 hw_if_index = vnet_register_interface
460 (vnm, geneve_device_class.index, t - vxm->tunnels,
461 geneve_hw_class.index, t - vxm->tunnels);
462 hi = vnet_get_hw_interface (vnm, hw_if_index);
465 /* Set geneve tunnel output node */
466 u32 encap_index = !is_ip6 ?
467 geneve4_encap_node.index : geneve6_encap_node.index;
468 vnet_set_interface_output_node (vnm, hw_if_index, encap_index);
470 t->hw_if_index = hw_if_index;
471 t->sw_if_index = sw_if_index = hi->sw_if_index;
473 vec_validate_init_empty (vxm->tunnel_index_by_sw_if_index, sw_if_index,
475 vxm->tunnel_index_by_sw_if_index[sw_if_index] = t - vxm->tunnels;
477 /* setup l2 input config with l2 feature and bd 0 to drop packet */
478 vec_validate (l2im->configs, sw_if_index);
479 l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
480 l2im->configs[sw_if_index].bd_index = 0;
482 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
483 si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
484 vnet_sw_interface_set_flags (vnm, sw_if_index,
485 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
487 fib_node_init (&t->node, FIB_NODE_TYPE_GENEVE_TUNNEL);
488 fib_prefix_t tun_remote_pfx;
489 vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
491 fib_prefix_from_ip46_addr (&t->remote, &tun_remote_pfx);
492 if (!ip46_address_is_multicast (&t->remote))
495 * source the FIB entry for the tunnel's destination
496 * and become a child thereof. The tunnel will then get poked
497 * when the forwarding for the entry updates, and the tunnel can
498 * re-stack accordingly
500 vtep_addr_ref (&t->local);
501 t->fib_entry_index = fib_table_entry_special_add
502 (t->encap_fib_index, &tun_remote_pfx, FIB_SOURCE_RR,
503 FIB_ENTRY_FLAG_NONE);
504 t->sibling_index = fib_entry_child_add
505 (t->fib_entry_index, 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_child_remove (t->fib_entry_index, t->sibling_index);
609 fib_table_entry_delete_index (t->fib_entry_index, FIB_SOURCE_RR);
611 else if (vtep_addr_unref (&t->remote) == 0)
613 mcast_shared_remove (&t->remote);
616 fib_node_deinit (&t->node);
617 vec_free (t->rewrite);
618 pool_put (vxm->tunnels, t);
622 *sw_if_indexp = sw_if_index;
626 /* register udp ports */
627 if (!is_ip6 && !udp_is_valid_dst_port (UDP_DST_PORT_geneve, 1))
628 udp_register_dst_port (vxm->vlib_main, UDP_DST_PORT_geneve,
629 geneve4_input_node.index, 1);
630 if (is_ip6 && !udp_is_valid_dst_port (UDP_DST_PORT_geneve6, 0))
631 udp_register_dst_port (vxm->vlib_main, UDP_DST_PORT_geneve6,
632 geneve6_input_node.index, 0);
639 get_decap_next_for_node (u32 node_index, u32 ipv4_set)
641 geneve_main_t *vxm = &geneve_main;
642 vlib_main_t *vm = vxm->vlib_main;
643 uword input_node = (ipv4_set) ? geneve4_input_node.index :
644 geneve6_input_node.index;
646 return vlib_node_add_next (vm, input_node, node_index);
650 unformat_decap_next (unformat_input_t * input, va_list * args)
652 u32 *result = va_arg (*args, u32 *);
653 u32 ipv4_set = va_arg (*args, int);
654 geneve_main_t *vxm = &geneve_main;
655 vlib_main_t *vm = vxm->vlib_main;
659 if (unformat (input, "l2"))
660 *result = GENEVE_INPUT_NEXT_L2_INPUT;
661 else if (unformat (input, "node %U", unformat_vlib_node, vm, &node_index))
662 *result = get_decap_next_for_node (node_index, ipv4_set);
663 else if (unformat (input, "%d", &tmp))
670 static clib_error_t *
671 geneve_add_del_tunnel_command_fn (vlib_main_t * vm,
672 unformat_input_t * input,
673 vlib_cli_command_t * cmd)
675 unformat_input_t _line_input, *line_input = &_line_input;
676 ip46_address_t local, remote;
683 u32 encap_fib_index = 0;
684 u32 mcast_sw_if_index = ~0;
685 u32 decap_next_index = GENEVE_INPUT_NEXT_L2_INPUT;
689 vnet_geneve_add_del_tunnel_args_t _a, *a = &_a;
690 u32 tunnel_sw_if_index;
691 clib_error_t *error = NULL;
693 /* Cant "universally zero init" (={0}) due to GCC bug 53119 */
694 clib_memset (&local, 0, sizeof local);
695 clib_memset (&remote, 0, sizeof remote);
697 /* Get a line of input. */
698 if (!unformat_user (input, unformat_line_input, line_input))
701 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
703 if (unformat (line_input, "del"))
707 else if (unformat (line_input, "local %U",
708 unformat_ip4_address, &local.ip4))
713 else if (unformat (line_input, "remote %U",
714 unformat_ip4_address, &remote.ip4))
719 else if (unformat (line_input, "local %U",
720 unformat_ip6_address, &local.ip6))
725 else if (unformat (line_input, "remote %U",
726 unformat_ip6_address, &remote.ip6))
731 else if (unformat (line_input, "group %U %U",
732 unformat_ip4_address, &remote.ip4,
733 unformat_vnet_sw_interface,
734 vnet_get_main (), &mcast_sw_if_index))
736 grp_set = remote_set = 1;
739 else if (unformat (line_input, "group %U %U",
740 unformat_ip6_address, &remote.ip6,
741 unformat_vnet_sw_interface,
742 vnet_get_main (), &mcast_sw_if_index))
744 grp_set = remote_set = 1;
747 else if (unformat (line_input, "encap-vrf-id %d", &tmp))
749 encap_fib_index = fib_table_find (fib_ip_proto (ipv6_set), tmp);
750 if (encap_fib_index == ~0)
753 clib_error_return (0, "nonexistent encap-vrf-id %d", tmp);
757 else if (unformat (line_input, "decap-next %U", unformat_decap_next,
758 &decap_next_index, ipv4_set))
760 else if (unformat (line_input, "vni %d", &vni))
764 error = clib_error_return (0, "vni %d out of range", vni);
770 error = clib_error_return (0, "parse error: '%U'",
771 format_unformat_error, line_input);
778 error = clib_error_return (0, "tunnel local address not specified");
784 error = clib_error_return (0, "tunnel remote address not specified");
788 if (grp_set && !ip46_address_is_multicast (&remote))
790 error = clib_error_return (0, "tunnel group address not multicast");
794 if (grp_set == 0 && ip46_address_is_multicast (&remote))
796 error = clib_error_return (0, "remote address must be unicast");
800 if (grp_set && mcast_sw_if_index == ~0)
802 error = clib_error_return (0, "tunnel nonexistent multicast device");
806 if (ipv4_set && ipv6_set)
808 error = clib_error_return (0, "both IPv4 and IPv6 addresses specified");
812 if (ip46_address_cmp (&local, &remote) == 0)
815 clib_error_return (0, "local and remote addresses are identical");
819 if (decap_next_index == ~0)
821 error = clib_error_return (0, "next node not found");
827 error = clib_error_return (0, "vni not specified");
831 clib_memset (a, 0, sizeof (*a));
834 a->is_ip6 = ipv6_set;
836 #define _(x) a->x = x;
840 rv = vnet_geneve_add_del_tunnel (a, &tunnel_sw_if_index);
846 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
847 vnet_get_main (), tunnel_sw_if_index);
850 case VNET_API_ERROR_TUNNEL_EXIST:
851 error = clib_error_return (0, "tunnel already exists...");
854 case VNET_API_ERROR_NO_SUCH_ENTRY:
855 error = clib_error_return (0, "tunnel does not exist...");
859 error = clib_error_return
860 (0, "vnet_geneve_add_del_tunnel returned %d", rv);
865 unformat_free (line_input);
871 * Add or delete a GENEVE Tunnel.
873 * GENEVE provides the features needed to allow L2 bridge domains (BDs)
874 * to span multiple servers. This is done by building an L2 overlay on
875 * top of an L3 network underlay using GENEVE tunnels.
877 * This makes it possible for servers to be co-located in the same data
878 * center or be separated geographically as long as they are reachable
879 * through the underlay L3 network.
881 * You can refer to this kind of L2 overlay bridge domain as a GENEVE
885 * Example of how to create a GENEVE Tunnel:
886 * @cliexcmd{create geneve tunnel local 10.0.3.1 remote 10.0.3.3 vni 13 encap-vrf-id 7}
887 * Example of how to delete a GENEVE Tunnel:
888 * @cliexcmd{create geneve tunnel local 10.0.3.1 remote 10.0.3.3 vni 13 del}
891 VLIB_CLI_COMMAND (create_geneve_tunnel_command, static) = {
892 .path = "create geneve tunnel",
894 "create geneve tunnel local <local-vtep-addr>"
895 " {remote <remote-vtep-addr>|group <mcast-vtep-addr> <intf-name>} vni <nn>"
896 " [encap-vrf-id <nn>] [decap-next [l2|node <name>]] [del]",
897 .function = geneve_add_del_tunnel_command_fn,
901 static clib_error_t *
902 show_geneve_tunnel_command_fn (vlib_main_t * vm,
903 unformat_input_t * input,
904 vlib_cli_command_t * cmd)
906 geneve_main_t *vxm = &geneve_main;
909 if (pool_elts (vxm->tunnels) == 0)
910 vlib_cli_output (vm, "No geneve tunnels configured...");
912 pool_foreach (t, vxm->tunnels, (
914 vlib_cli_output (vm, "%U",
915 format_geneve_tunnel, t);
923 * Display all the GENEVE Tunnel entries.
926 * Example of how to display the GENEVE Tunnel entries:
927 * @cliexstart{show geneve tunnel}
928 * [0] local 10.0.3.1 remote 10.0.3.3 vni 13 encap_fib_index 0 sw_if_index 5 decap_next l2
932 VLIB_CLI_COMMAND (show_geneve_tunnel_command, static) = {
933 .path = "show geneve tunnel",
934 .short_help = "show geneve tunnel",
935 .function = show_geneve_tunnel_command_fn,
941 vnet_int_geneve_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable)
944 vnet_feature_enable_disable ("ip6-unicast", "ip6-geneve-bypass",
945 sw_if_index, is_enable, 0, 0);
947 vnet_feature_enable_disable ("ip4-unicast", "ip4-geneve-bypass",
948 sw_if_index, is_enable, 0, 0);
952 static clib_error_t *
953 set_ip_geneve_bypass (u32 is_ip6,
954 unformat_input_t * input, vlib_cli_command_t * cmd)
956 unformat_input_t _line_input, *line_input = &_line_input;
957 vnet_main_t *vnm = vnet_get_main ();
958 clib_error_t *error = 0;
959 u32 sw_if_index, is_enable;
964 if (!unformat_user (input, unformat_line_input, line_input))
967 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
970 (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
972 else if (unformat (line_input, "del"))
976 error = unformat_parse_error (line_input);
981 if (~0 == sw_if_index)
983 error = clib_error_return (0, "unknown interface `%U'",
984 format_unformat_error, line_input);
988 vnet_int_geneve_bypass_mode (sw_if_index, is_ip6, is_enable);
991 unformat_free (line_input);
996 static clib_error_t *
997 set_ip4_geneve_bypass (vlib_main_t * vm,
998 unformat_input_t * input, vlib_cli_command_t * cmd)
1000 return set_ip_geneve_bypass (0, input, cmd);
1004 * This command adds the 'ip4-geneve-bypass' graph node for a given interface.
1005 * By adding the IPv4 geneve-bypass graph node to an interface, the node checks
1006 * for and validate input geneve packet and bypass ip4-lookup, ip4-local,
1007 * ip4-udp-lookup nodes to speedup geneve packet forwarding. This node will
1008 * cause extra overhead to for non-geneve packets which is kept at a minimum.
1012 * Example of graph node before ip4-geneve-bypass is enabled:
1013 * @cliexstart{show vlib graph ip4-geneve-bypass}
1014 * Name Next Previous
1015 * ip4-geneve-bypass error-drop [0]
1020 * Example of how to enable ip4-geneve-bypass on an interface:
1021 * @cliexcmd{set interface ip geneve-bypass GigabitEthernet2/0/0}
1023 * Example of graph node after ip4-geneve-bypass is enabled:
1024 * @cliexstart{show vlib graph ip4-geneve-bypass}
1025 * Name Next Previous
1026 * ip4-geneve-bypass error-drop [0] ip4-input
1027 * geneve4-input [1] ip4-input-no-checksum
1031 * Example of how to display the feature enabed on an interface:
1032 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1033 * IP feature paths configured on GigabitEthernet2/0/0...
1041 * Example of how to disable ip4-geneve-bypass on an interface:
1042 * @cliexcmd{set interface ip geneve-bypass GigabitEthernet2/0/0 del}
1046 VLIB_CLI_COMMAND (set_interface_ip_geneve_bypass_command, static) = {
1047 .path = "set interface ip geneve-bypass",
1048 .function = set_ip4_geneve_bypass,
1049 .short_help = "set interface ip geneve-bypass <interface> [del]",
1053 static clib_error_t *
1054 set_ip6_geneve_bypass (vlib_main_t * vm,
1055 unformat_input_t * input, vlib_cli_command_t * cmd)
1057 return set_ip_geneve_bypass (1, input, cmd);
1061 * This command adds the 'ip6-geneve-bypass' graph node for a given interface.
1062 * By adding the IPv6 geneve-bypass graph node to an interface, the node checks
1063 * for and validate input geneve packet and bypass ip6-lookup, ip6-local,
1064 * ip6-udp-lookup nodes to speedup geneve packet forwarding. This node will
1065 * cause extra overhead to for non-geneve packets which is kept at a minimum.
1069 * Example of graph node before ip6-geneve-bypass is enabled:
1070 * @cliexstart{show vlib graph ip6-geneve-bypass}
1071 * Name Next Previous
1072 * ip6-geneve-bypass error-drop [0]
1077 * Example of how to enable ip6-geneve-bypass on an interface:
1078 * @cliexcmd{set interface ip6 geneve-bypass GigabitEthernet2/0/0}
1080 * Example of graph node after ip6-geneve-bypass is enabled:
1081 * @cliexstart{show vlib graph ip6-geneve-bypass}
1082 * Name Next Previous
1083 * ip6-geneve-bypass error-drop [0] ip6-input
1084 * geneve6-input [1] ip4-input-no-checksum
1088 * Example of how to display the feature enabed on an interface:
1089 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1090 * IP feature paths configured on GigabitEthernet2/0/0...
1098 * Example of how to disable ip6-geneve-bypass on an interface:
1099 * @cliexcmd{set interface ip6 geneve-bypass GigabitEthernet2/0/0 del}
1103 VLIB_CLI_COMMAND (set_interface_ip6_geneve_bypass_command, static) = {
1104 .path = "set interface ip6 geneve-bypass",
1105 .function = set_ip6_geneve_bypass,
1106 .short_help = "set interface ip geneve-bypass <interface> [del]",
1111 geneve_init (vlib_main_t * vm)
1113 geneve_main_t *vxm = &geneve_main;
1115 vxm->vnet_main = vnet_get_main ();
1116 vxm->vlib_main = vm;
1118 /* initialize the ip6 hash */
1119 vxm->geneve6_tunnel_by_key = hash_create_mem (0,
1120 sizeof (geneve6_tunnel_key_t),
1122 vxm->vtep6 = hash_create_mem (0, sizeof (ip6_address_t), sizeof (uword));
1123 vxm->mcast_shared = hash_create_mem (0,
1124 sizeof (ip46_address_t),
1125 sizeof (mcast_shared_t));
1127 fib_node_register_type (FIB_NODE_TYPE_GENEVE_TUNNEL, &geneve_vft);
1132 VLIB_INIT_FUNCTION (geneve_init);
1135 * fd.io coding-style-patch-verification: ON
1138 * eval: (c-set-style "gnu")