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_decap_next (u8 * s, va_list * args)
43 u32 next_index = va_arg (*args, u32);
47 case GENEVE_INPUT_NEXT_DROP:
48 return format (s, "drop");
49 case GENEVE_INPUT_NEXT_L2_INPUT:
50 return format (s, "l2");
52 return format (s, "index %d", next_index);
58 format_geneve_tunnel (u8 * s, va_list * args)
60 geneve_tunnel_t *t = va_arg (*args, geneve_tunnel_t *);
61 geneve_main_t *ngm = &geneve_main;
63 s = format (s, "[%d] lcl %U rmt %U vni %d fib-idx %d sw-if-idx %d ",
65 format_ip46_address, &t->local, IP46_TYPE_ANY,
66 format_ip46_address, &t->remote, IP46_TYPE_ANY,
67 t->vni, t->encap_fib_index, t->sw_if_index);
69 s = format (s, "encap-dpo-idx %d ", t->next_dpo.dpoi_index);
70 s = format (s, "decap-next-%U ", format_decap_next, t->decap_next_index);
72 if (PREDICT_FALSE (ip46_address_is_multicast (&t->remote)))
73 s = format (s, "mcast-sw-if-idx %d ", t->mcast_sw_if_index);
79 format_geneve_name (u8 * s, va_list * args)
81 u32 dev_instance = va_arg (*args, u32);
82 return format (s, "geneve_tunnel%d", dev_instance);
86 geneve_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
88 u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
89 VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
90 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
92 return /* no error */ 0;
96 VNET_DEVICE_CLASS (geneve_device_class, static) = {
98 .format_device_name = format_geneve_name,
99 .format_tx_trace = format_geneve_encap_trace,
100 .admin_up_down_function = geneve_interface_admin_up_down,
105 format_geneve_header_with_length (u8 * s, va_list * args)
107 u32 dev_instance = va_arg (*args, u32);
108 s = format (s, "unimplemented dev %u", dev_instance);
113 VNET_HW_INTERFACE_CLASS (geneve_hw_class) = {
115 .format_header = format_geneve_header_with_length,
116 .build_rewrite = default_build_rewrite,
121 geneve_tunnel_restack_dpo (geneve_tunnel_t * t)
123 dpo_id_t dpo = DPO_INVALID;
124 u32 encap_index = ip46_address_is_ip4 (&t->remote) ?
125 geneve4_encap_node.index : geneve6_encap_node.index;
126 fib_forward_chain_type_t forw_type = ip46_address_is_ip4 (&t->remote) ?
127 FIB_FORW_CHAIN_TYPE_UNICAST_IP4 : FIB_FORW_CHAIN_TYPE_UNICAST_IP6;
129 fib_entry_contribute_forwarding (t->fib_entry_index, forw_type, &dpo);
130 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
134 static geneve_tunnel_t *
135 geneve_tunnel_from_fib_node (fib_node_t * node)
137 ASSERT (FIB_NODE_TYPE_GENEVE_TUNNEL == node->fn_type);
138 return ((geneve_tunnel_t *) (((char *) node) -
139 STRUCT_OFFSET_OF (geneve_tunnel_t, node)));
143 * Function definition to backwalk a FIB node -
144 * Here we will restack the new dpo of GENEVE DIP to encap node.
146 static fib_node_back_walk_rc_t
147 geneve_tunnel_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
149 geneve_tunnel_restack_dpo (geneve_tunnel_from_fib_node (node));
150 return (FIB_NODE_BACK_WALK_CONTINUE);
154 * Function definition to get a FIB node from its index
157 geneve_tunnel_fib_node_get (fib_node_index_t index)
160 geneve_main_t *vxm = &geneve_main;
162 t = pool_elt_at_index (vxm->tunnels, index);
168 * Function definition to inform the FIB node that its last lock has gone.
171 geneve_tunnel_last_lock_gone (fib_node_t * node)
174 * The GENEVE tunnel is a root of the graph. As such
175 * it never has children and thus is never locked.
181 * Virtual function table registered by GENEVE tunnels
182 * for participation in the FIB object graph.
184 const static fib_node_vft_t geneve_vft = {
185 .fnv_get = geneve_tunnel_fib_node_get,
186 .fnv_last_lock = geneve_tunnel_last_lock_gone,
187 .fnv_back_walk = geneve_tunnel_back_walk,
191 #define foreach_copy_field \
193 _(mcast_sw_if_index) \
195 _(decap_next_index) \
200 geneve_rewrite (geneve_tunnel_t * t, bool is_ip6)
204 ip4_geneve_header_t *h4;
205 ip6_geneve_header_t *h6;
210 int len = is_ip6 ? sizeof *r.h6 : sizeof *r.h4;
211 #if SUPPORT_OPTIONS_HEADER==1
212 len += t->options_len;
215 vec_validate_aligned (r.rw, len - 1, CLIB_CACHE_LINE_BYTES);
218 geneve_header_t *geneve;
219 /* Fixed portion of the (outer) ip header */
222 ip4_header_t *ip = &r.h4->ip4;
223 udp = &r.h4->udp, geneve = &r.h4->geneve;
224 ip->ip_version_and_header_length = 0x45;
226 ip->protocol = IP_PROTOCOL_UDP;
228 ip->src_address = t->local.ip4;
229 ip->dst_address = t->remote.ip4;
231 /* we fix up the ip4 header length and checksum after-the-fact */
232 ip->checksum = ip4_header_checksum (ip);
236 ip6_header_t *ip = &r.h6->ip6;
237 udp = &r.h6->udp, geneve = &r.h6->geneve;
238 ip->ip_version_traffic_class_and_flow_label =
239 clib_host_to_net_u32 (6 << 28);
241 ip->protocol = IP_PROTOCOL_UDP;
243 ip->src_address = t->local.ip6;
244 ip->dst_address = t->remote.ip6;
247 /* UDP header, randomize local port on something, maybe? */
248 udp->src_port = clib_host_to_net_u16 (5251);
249 udp->dst_port = clib_host_to_net_u16 (UDP_DST_PORT_geneve);
252 vnet_set_geneve_version (geneve, GENEVE_VERSION);
253 #if SUPPORT_OPTIONS_HEADER==1
254 vnet_set_geneve_options_len (geneve, t->options_len);
256 vnet_set_geneve_options_len (geneve, 0);
258 vnet_set_geneve_oamframe_bit (geneve, 0);
259 vnet_set_geneve_critical_bit (geneve, 0);
260 vnet_set_geneve_protocol (geneve, GENEVE_ETH_PROTOCOL);
262 vnet_geneve_hdr_1word_hton (geneve);
264 vnet_set_geneve_vni (geneve, t->vni);
271 geneve_decap_next_is_valid (geneve_main_t * vxm, u32 is_ip6,
272 u32 decap_next_index)
274 vlib_main_t *vm = vxm->vlib_main;
276 (!is_ip6) ? geneve4_input_node.index : geneve6_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 (geneve_main.vtep4, ip->ip4.as_u32) :
287 hash_get_mem (geneve_main.vtep6, &ip->ip6);
290 ip46_address_is_ip4 (ip) ?
291 hash_set (geneve_main.vtep4, ip->ip4.as_u32, 1) :
292 hash_set_mem_alloc (&geneve_main.vtep6, &ip->ip6, 1);
297 vtep_addr_unref (ip46_address_t * ip)
299 uword *vtep = ip46_address_is_ip4 (ip) ?
300 hash_get (geneve_main.vtep4, ip->ip4.as_u32) :
301 hash_get_mem (geneve_main.vtep6, &ip->ip6);
305 ip46_address_is_ip4 (ip) ?
306 hash_unset (geneve_main.vtep4, ip->ip4.as_u32) :
307 hash_unset_mem_free (&geneve_main.vtep6, &ip->ip6);
311 typedef CLIB_PACKED (union
315 fib_node_index_t mfib_entry_index;
316 adj_index_t mcast_adj_index;
320 static inline mcast_shared_t
321 mcast_shared_get (ip46_address_t * ip)
323 ASSERT (ip46_address_is_multicast (ip));
324 uword *p = hash_get_mem (geneve_main.mcast_shared, ip);
326 return (mcast_shared_t)
332 mcast_shared_add (ip46_address_t * remote,
333 fib_node_index_t mfei, adj_index_t ai)
335 mcast_shared_t new_ep = {
336 .mcast_adj_index = ai,
337 .mfib_entry_index = mfei,
340 hash_set_mem_alloc (&geneve_main.mcast_shared, remote, new_ep.as_u64);
344 mcast_shared_remove (ip46_address_t * remote)
346 mcast_shared_t ep = mcast_shared_get (remote);
348 adj_unlock (ep.mcast_adj_index);
349 mfib_table_entry_delete_index (ep.mfib_entry_index, MFIB_SOURCE_GENEVE);
351 hash_unset_mem_free (&geneve_main.mcast_shared, remote);
354 int vnet_geneve_add_del_tunnel
355 (vnet_geneve_add_del_tunnel_args_t * a, u32 * sw_if_indexp)
357 geneve_main_t *vxm = &geneve_main;
358 geneve_tunnel_t *t = 0;
359 vnet_main_t *vnm = vxm->vnet_main;
361 u32 hw_if_index = ~0;
362 u32 sw_if_index = ~0;
364 geneve4_tunnel_key_t key4;
365 geneve6_tunnel_key_t key6;
366 u32 is_ip6 = a->is_ip6;
370 key4.remote = a->remote.ip4.as_u32;
372 clib_host_to_net_u32 ((a->vni << GENEVE_VNI_SHIFT) & GENEVE_VNI_MASK);
373 p = hash_get (vxm->geneve4_tunnel_by_key, key4.as_u64);
377 key6.remote = a->remote.ip6;
379 clib_host_to_net_u32 ((a->vni << GENEVE_VNI_SHIFT) & GENEVE_VNI_MASK);
380 p = hash_get_mem (vxm->geneve6_tunnel_by_key, &key6);
385 l2input_main_t *l2im = &l2input_main;
387 /* adding a tunnel: tunnel must not already exist */
389 return VNET_API_ERROR_TUNNEL_EXIST;
391 /*if not set explicitly, default to l2 */
392 if (a->decap_next_index == ~0)
393 a->decap_next_index = GENEVE_INPUT_NEXT_L2_INPUT;
394 if (!geneve_decap_next_is_valid (vxm, is_ip6, a->decap_next_index))
395 return VNET_API_ERROR_INVALID_DECAP_NEXT;
397 pool_get_aligned (vxm->tunnels, t, CLIB_CACHE_LINE_BYTES);
398 clib_memset (t, 0, sizeof (*t));
400 /* copy from arg structure */
401 #define _(x) t->x = a->x;
405 rv = geneve_rewrite (t, is_ip6);
408 pool_put (vxm->tunnels, t);
414 hash_set_mem_alloc (&vxm->geneve6_tunnel_by_key, &key6,
417 hash_set (vxm->geneve4_tunnel_by_key, key4.as_u64, t - vxm->tunnels);
419 vnet_hw_interface_t *hi;
420 if (vec_len (vxm->free_geneve_tunnel_hw_if_indices) > 0)
422 vnet_interface_main_t *im = &vnm->interface_main;
423 hw_if_index = vxm->free_geneve_tunnel_hw_if_indices
424 [vec_len (vxm->free_geneve_tunnel_hw_if_indices) - 1];
425 _vec_len (vxm->free_geneve_tunnel_hw_if_indices) -= 1;
427 hi = vnet_get_hw_interface (vnm, hw_if_index);
428 hi->dev_instance = t - vxm->tunnels;
429 hi->hw_instance = hi->dev_instance;
431 /* clear old stats of freed tunnel before reuse */
432 sw_if_index = hi->sw_if_index;
433 vnet_interface_counter_lock (im);
434 vlib_zero_combined_counter
435 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX],
437 vlib_zero_combined_counter (&im->combined_sw_if_counters
438 [VNET_INTERFACE_COUNTER_RX],
440 vlib_zero_simple_counter (&im->sw_if_counters
441 [VNET_INTERFACE_COUNTER_DROP],
443 vnet_interface_counter_unlock (im);
447 hw_if_index = vnet_register_interface
448 (vnm, geneve_device_class.index, t - vxm->tunnels,
449 geneve_hw_class.index, t - vxm->tunnels);
450 hi = vnet_get_hw_interface (vnm, hw_if_index);
453 /* Set geneve tunnel output node */
454 u32 encap_index = !is_ip6 ?
455 geneve4_encap_node.index : geneve6_encap_node.index;
456 vnet_set_interface_output_node (vnm, hw_if_index, encap_index);
458 t->hw_if_index = hw_if_index;
459 t->sw_if_index = sw_if_index = hi->sw_if_index;
461 vec_validate_init_empty (vxm->tunnel_index_by_sw_if_index, sw_if_index,
463 vxm->tunnel_index_by_sw_if_index[sw_if_index] = t - vxm->tunnels;
465 /* setup l2 input config with l2 feature and bd 0 to drop packet */
466 vec_validate (l2im->configs, sw_if_index);
467 l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
468 l2im->configs[sw_if_index].bd_index = 0;
470 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
471 si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
472 vnet_sw_interface_set_flags (vnm, sw_if_index,
473 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
475 fib_node_init (&t->node, FIB_NODE_TYPE_GENEVE_TUNNEL);
476 fib_prefix_t tun_remote_pfx;
477 vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
479 fib_prefix_from_ip46_addr (&t->remote, &tun_remote_pfx);
480 if (!ip46_address_is_multicast (&t->remote))
483 * source the FIB entry for the tunnel's destination
484 * and become a child thereof. The tunnel will then get poked
485 * when the forwarding for the entry updates, and the tunnel can
486 * re-stack accordingly
488 vtep_addr_ref (&t->local);
489 t->fib_entry_index = fib_table_entry_special_add
490 (t->encap_fib_index, &tun_remote_pfx, FIB_SOURCE_RR,
491 FIB_ENTRY_FLAG_NONE);
492 t->sibling_index = fib_entry_child_add
493 (t->fib_entry_index, FIB_NODE_TYPE_GENEVE_TUNNEL,
495 geneve_tunnel_restack_dpo (t);
499 /* Multicast tunnel -
500 * as the same mcast group can be used for mutiple mcast tunnels
501 * with different VNIs, create the output fib adjecency only if
502 * it does not already exist
504 fib_protocol_t fp = fib_ip_proto (is_ip6);
506 if (vtep_addr_ref (&t->remote) == 1)
508 fib_node_index_t mfei;
510 fib_route_path_t path = {
511 .frp_proto = fib_proto_to_dpo (fp),
512 .frp_addr = zero_addr,
513 .frp_sw_if_index = 0xffffffff,
516 .frp_flags = FIB_ROUTE_PATH_LOCAL,
518 const mfib_prefix_t mpfx = {
520 .fp_len = (is_ip6 ? 128 : 32),
521 .fp_grp_addr = tun_remote_pfx.fp_addr,
525 * Setup the (*,G) to receive traffic on the mcast group
526 * - the forwarding interface is for-us
527 * - the accepting interface is that from the API
529 mfib_table_entry_path_update (t->encap_fib_index,
532 &path, MFIB_ITF_FLAG_FORWARD);
534 path.frp_sw_if_index = a->mcast_sw_if_index;
535 path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
536 mfei = mfib_table_entry_path_update (t->encap_fib_index,
540 MFIB_ITF_FLAG_ACCEPT);
543 * Create the mcast adjacency to send traffic to the group
545 ai = adj_mcast_add_or_lock (fp,
546 fib_proto_to_link (fp),
547 a->mcast_sw_if_index);
550 * create a new end-point
552 mcast_shared_add (&t->remote, mfei, ai);
555 dpo_id_t dpo = DPO_INVALID;
556 mcast_shared_t ep = mcast_shared_get (&t->remote);
558 /* Stack shared mcast remote mac addr rewrite on encap */
559 dpo_set (&dpo, DPO_ADJACENCY_MCAST,
560 fib_proto_to_dpo (fp), ep.mcast_adj_index);
562 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
564 flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
567 vnet_get_sw_interface (vnet_get_main (), sw_if_index)->flood_class =
572 /* deleting a tunnel: tunnel must exist */
574 return VNET_API_ERROR_NO_SUCH_ENTRY;
576 t = pool_elt_at_index (vxm->tunnels, p[0]);
578 sw_if_index = t->sw_if_index;
579 vnet_sw_interface_set_flags (vnm, t->sw_if_index, 0 /* down */ );
580 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, t->sw_if_index);
581 si->flags |= VNET_SW_INTERFACE_FLAG_HIDDEN;
583 /* make sure tunnel is removed from l2 bd or xconnect */
584 set_int_l2_mode (vxm->vlib_main, vnm, MODE_L3, t->sw_if_index, 0,
585 L2_BD_PORT_TYPE_NORMAL, 0, 0);
586 vec_add1 (vxm->free_geneve_tunnel_hw_if_indices, t->hw_if_index);
588 vxm->tunnel_index_by_sw_if_index[t->sw_if_index] = ~0;
591 hash_unset (vxm->geneve4_tunnel_by_key, key4.as_u64);
593 hash_unset_mem_free (&vxm->geneve6_tunnel_by_key, &key6);
595 if (!ip46_address_is_multicast (&t->remote))
597 vtep_addr_unref (&t->local);
598 fib_entry_child_remove (t->fib_entry_index, t->sibling_index);
599 fib_table_entry_delete_index (t->fib_entry_index, FIB_SOURCE_RR);
601 else if (vtep_addr_unref (&t->remote) == 0)
603 mcast_shared_remove (&t->remote);
606 fib_node_deinit (&t->node);
607 vec_free (t->rewrite);
608 pool_put (vxm->tunnels, t);
612 *sw_if_indexp = sw_if_index;
618 get_decap_next_for_node (u32 node_index, u32 ipv4_set)
620 geneve_main_t *vxm = &geneve_main;
621 vlib_main_t *vm = vxm->vlib_main;
622 uword input_node = (ipv4_set) ? geneve4_input_node.index :
623 geneve6_input_node.index;
625 return vlib_node_add_next (vm, input_node, node_index);
629 unformat_decap_next (unformat_input_t * input, va_list * args)
631 u32 *result = va_arg (*args, u32 *);
632 u32 ipv4_set = va_arg (*args, int);
633 geneve_main_t *vxm = &geneve_main;
634 vlib_main_t *vm = vxm->vlib_main;
638 if (unformat (input, "l2"))
639 *result = GENEVE_INPUT_NEXT_L2_INPUT;
640 else if (unformat (input, "node %U", unformat_vlib_node, vm, &node_index))
641 *result = get_decap_next_for_node (node_index, ipv4_set);
642 else if (unformat (input, "%d", &tmp))
649 static clib_error_t *
650 geneve_add_del_tunnel_command_fn (vlib_main_t * vm,
651 unformat_input_t * input,
652 vlib_cli_command_t * cmd)
654 unformat_input_t _line_input, *line_input = &_line_input;
655 ip46_address_t local, remote;
662 u32 encap_fib_index = 0;
663 u32 mcast_sw_if_index = ~0;
664 u32 decap_next_index = GENEVE_INPUT_NEXT_L2_INPUT;
668 vnet_geneve_add_del_tunnel_args_t _a, *a = &_a;
669 u32 tunnel_sw_if_index;
670 clib_error_t *error = NULL;
672 /* Cant "universally zero init" (={0}) due to GCC bug 53119 */
673 clib_memset (&local, 0, sizeof local);
674 clib_memset (&remote, 0, sizeof remote);
676 /* Get a line of input. */
677 if (!unformat_user (input, unformat_line_input, line_input))
680 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
682 if (unformat (line_input, "del"))
686 else if (unformat (line_input, "local %U",
687 unformat_ip4_address, &local.ip4))
692 else if (unformat (line_input, "remote %U",
693 unformat_ip4_address, &remote.ip4))
698 else if (unformat (line_input, "local %U",
699 unformat_ip6_address, &local.ip6))
704 else if (unformat (line_input, "remote %U",
705 unformat_ip6_address, &remote.ip6))
710 else if (unformat (line_input, "group %U %U",
711 unformat_ip4_address, &remote.ip4,
712 unformat_vnet_sw_interface,
713 vnet_get_main (), &mcast_sw_if_index))
715 grp_set = remote_set = 1;
718 else if (unformat (line_input, "group %U %U",
719 unformat_ip6_address, &remote.ip6,
720 unformat_vnet_sw_interface,
721 vnet_get_main (), &mcast_sw_if_index))
723 grp_set = remote_set = 1;
726 else if (unformat (line_input, "encap-vrf-id %d", &tmp))
728 encap_fib_index = fib_table_find (fib_ip_proto (ipv6_set), tmp);
729 if (encap_fib_index == ~0)
732 clib_error_return (0, "nonexistent encap-vrf-id %d", tmp);
736 else if (unformat (line_input, "decap-next %U", unformat_decap_next,
737 &decap_next_index, ipv4_set))
739 else if (unformat (line_input, "vni %d", &vni))
743 error = clib_error_return (0, "vni %d out of range", vni);
749 error = clib_error_return (0, "parse error: '%U'",
750 format_unformat_error, line_input);
757 error = clib_error_return (0, "tunnel local address not specified");
763 error = clib_error_return (0, "tunnel remote address not specified");
767 if (grp_set && !ip46_address_is_multicast (&remote))
769 error = clib_error_return (0, "tunnel group address not multicast");
773 if (grp_set == 0 && ip46_address_is_multicast (&remote))
775 error = clib_error_return (0, "remote address must be unicast");
779 if (grp_set && mcast_sw_if_index == ~0)
781 error = clib_error_return (0, "tunnel nonexistent multicast device");
785 if (ipv4_set && ipv6_set)
787 error = clib_error_return (0, "both IPv4 and IPv6 addresses specified");
791 if (ip46_address_cmp (&local, &remote) == 0)
794 clib_error_return (0, "local and remote addresses are identical");
798 if (decap_next_index == ~0)
800 error = clib_error_return (0, "next node not found");
806 error = clib_error_return (0, "vni not specified");
810 clib_memset (a, 0, sizeof (*a));
813 a->is_ip6 = ipv6_set;
815 #define _(x) a->x = x;
819 rv = vnet_geneve_add_del_tunnel (a, &tunnel_sw_if_index);
825 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
826 vnet_get_main (), tunnel_sw_if_index);
829 case VNET_API_ERROR_TUNNEL_EXIST:
830 error = clib_error_return (0, "tunnel already exists...");
833 case VNET_API_ERROR_NO_SUCH_ENTRY:
834 error = clib_error_return (0, "tunnel does not exist...");
838 error = clib_error_return
839 (0, "vnet_geneve_add_del_tunnel returned %d", rv);
844 unformat_free (line_input);
850 * Add or delete a GENEVE Tunnel.
852 * GENEVE provides the features needed to allow L2 bridge domains (BDs)
853 * to span multiple servers. This is done by building an L2 overlay on
854 * top of an L3 network underlay using GENEVE tunnels.
856 * This makes it possible for servers to be co-located in the same data
857 * center or be separated geographically as long as they are reachable
858 * through the underlay L3 network.
860 * You can refer to this kind of L2 overlay bridge domain as a GENEVE
864 * Example of how to create a GENEVE Tunnel:
865 * @cliexcmd{create geneve tunnel local 10.0.3.1 remote 10.0.3.3 vni 13 encap-vrf-id 7}
866 * Example of how to delete a GENEVE Tunnel:
867 * @cliexcmd{create geneve tunnel local 10.0.3.1 remote 10.0.3.3 vni 13 del}
870 VLIB_CLI_COMMAND (create_geneve_tunnel_command, static) = {
871 .path = "create geneve tunnel",
873 "create geneve tunnel local <local-vtep-addr>"
874 " {remote <remote-vtep-addr>|group <mcast-vtep-addr> <intf-name>} vni <nn>"
875 " [encap-vrf-id <nn>] [decap-next [l2|node <name>]] [del]",
876 .function = geneve_add_del_tunnel_command_fn,
880 static clib_error_t *
881 show_geneve_tunnel_command_fn (vlib_main_t * vm,
882 unformat_input_t * input,
883 vlib_cli_command_t * cmd)
885 geneve_main_t *vxm = &geneve_main;
888 if (pool_elts (vxm->tunnels) == 0)
889 vlib_cli_output (vm, "No geneve tunnels configured...");
891 pool_foreach (t, vxm->tunnels, (
893 vlib_cli_output (vm, "%U",
894 format_geneve_tunnel, t);
902 * Display all the GENEVE Tunnel entries.
905 * Example of how to display the GENEVE Tunnel entries:
906 * @cliexstart{show geneve tunnel}
907 * [0] local 10.0.3.1 remote 10.0.3.3 vni 13 encap_fib_index 0 sw_if_index 5 decap_next l2
911 VLIB_CLI_COMMAND (show_geneve_tunnel_command, static) = {
912 .path = "show geneve tunnel",
913 .short_help = "show geneve tunnel",
914 .function = show_geneve_tunnel_command_fn,
920 vnet_int_geneve_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable)
923 vnet_feature_enable_disable ("ip6-unicast", "ip6-geneve-bypass",
924 sw_if_index, is_enable, 0, 0);
926 vnet_feature_enable_disable ("ip4-unicast", "ip4-geneve-bypass",
927 sw_if_index, is_enable, 0, 0);
931 static clib_error_t *
932 set_ip_geneve_bypass (u32 is_ip6,
933 unformat_input_t * input, vlib_cli_command_t * cmd)
935 unformat_input_t _line_input, *line_input = &_line_input;
936 vnet_main_t *vnm = vnet_get_main ();
937 clib_error_t *error = 0;
938 u32 sw_if_index, is_enable;
943 if (!unformat_user (input, unformat_line_input, line_input))
946 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
949 (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
951 else if (unformat (line_input, "del"))
955 error = unformat_parse_error (line_input);
960 if (~0 == sw_if_index)
962 error = clib_error_return (0, "unknown interface `%U'",
963 format_unformat_error, line_input);
967 vnet_int_geneve_bypass_mode (sw_if_index, is_ip6, is_enable);
970 unformat_free (line_input);
975 static clib_error_t *
976 set_ip4_geneve_bypass (vlib_main_t * vm,
977 unformat_input_t * input, vlib_cli_command_t * cmd)
979 return set_ip_geneve_bypass (0, input, cmd);
983 * This command adds the 'ip4-geneve-bypass' graph node for a given interface.
984 * By adding the IPv4 geneve-bypass graph node to an interface, the node checks
985 * for and validate input geneve packet and bypass ip4-lookup, ip4-local,
986 * ip4-udp-lookup nodes to speedup geneve packet forwarding. This node will
987 * cause extra overhead to for non-geneve packets which is kept at a minimum.
991 * Example of graph node before ip4-geneve-bypass is enabled:
992 * @cliexstart{show vlib graph ip4-geneve-bypass}
994 * ip4-geneve-bypass error-drop [0]
999 * Example of how to enable ip4-geneve-bypass on an interface:
1000 * @cliexcmd{set interface ip geneve-bypass GigabitEthernet2/0/0}
1002 * Example of graph node after ip4-geneve-bypass is enabled:
1003 * @cliexstart{show vlib graph ip4-geneve-bypass}
1004 * Name Next Previous
1005 * ip4-geneve-bypass error-drop [0] ip4-input
1006 * geneve4-input [1] ip4-input-no-checksum
1010 * Example of how to display the feature enabed on an interface:
1011 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1012 * IP feature paths configured on GigabitEthernet2/0/0...
1020 * Example of how to disable ip4-geneve-bypass on an interface:
1021 * @cliexcmd{set interface ip geneve-bypass GigabitEthernet2/0/0 del}
1025 VLIB_CLI_COMMAND (set_interface_ip_geneve_bypass_command, static) = {
1026 .path = "set interface ip geneve-bypass",
1027 .function = set_ip4_geneve_bypass,
1028 .short_help = "set interface ip geneve-bypass <interface> [del]",
1032 static clib_error_t *
1033 set_ip6_geneve_bypass (vlib_main_t * vm,
1034 unformat_input_t * input, vlib_cli_command_t * cmd)
1036 return set_ip_geneve_bypass (1, input, cmd);
1040 * This command adds the 'ip6-geneve-bypass' graph node for a given interface.
1041 * By adding the IPv6 geneve-bypass graph node to an interface, the node checks
1042 * for and validate input geneve packet and bypass ip6-lookup, ip6-local,
1043 * ip6-udp-lookup nodes to speedup geneve packet forwarding. This node will
1044 * cause extra overhead to for non-geneve packets which is kept at a minimum.
1048 * Example of graph node before ip6-geneve-bypass is enabled:
1049 * @cliexstart{show vlib graph ip6-geneve-bypass}
1050 * Name Next Previous
1051 * ip6-geneve-bypass error-drop [0]
1056 * Example of how to enable ip6-geneve-bypass on an interface:
1057 * @cliexcmd{set interface ip6 geneve-bypass GigabitEthernet2/0/0}
1059 * Example of graph node after ip6-geneve-bypass is enabled:
1060 * @cliexstart{show vlib graph ip6-geneve-bypass}
1061 * Name Next Previous
1062 * ip6-geneve-bypass error-drop [0] ip6-input
1063 * geneve6-input [1] ip4-input-no-checksum
1067 * Example of how to display the feature enabed on an interface:
1068 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1069 * IP feature paths configured on GigabitEthernet2/0/0...
1077 * Example of how to disable ip6-geneve-bypass on an interface:
1078 * @cliexcmd{set interface ip6 geneve-bypass GigabitEthernet2/0/0 del}
1082 VLIB_CLI_COMMAND (set_interface_ip6_geneve_bypass_command, static) = {
1083 .path = "set interface ip6 geneve-bypass",
1084 .function = set_ip6_geneve_bypass,
1085 .short_help = "set interface ip geneve-bypass <interface> [del]",
1090 geneve_init (vlib_main_t * vm)
1092 geneve_main_t *vxm = &geneve_main;
1094 vxm->vnet_main = vnet_get_main ();
1095 vxm->vlib_main = vm;
1097 /* initialize the ip6 hash */
1098 vxm->geneve6_tunnel_by_key = hash_create_mem (0,
1099 sizeof (geneve6_tunnel_key_t),
1101 vxm->vtep6 = hash_create_mem (0, sizeof (ip6_address_t), sizeof (uword));
1102 vxm->mcast_shared = hash_create_mem (0,
1103 sizeof (ip46_address_t),
1104 sizeof (mcast_shared_t));
1106 udp_register_dst_port (vm, UDP_DST_PORT_geneve,
1107 geneve4_input_node.index, /* is_ip4 */ 1);
1108 udp_register_dst_port (vm, UDP_DST_PORT_geneve6,
1109 geneve6_input_node.index, /* is_ip4 */ 0);
1111 fib_node_register_type (FIB_NODE_TYPE_GENEVE_TUNNEL, &geneve_vft);
1116 VLIB_INIT_FUNCTION (geneve_init);
1119 * fd.io coding-style-patch-verification: ON
1122 * eval: (c-set-style "gnu")