2 *------------------------------------------------------------------
3 * Copyright (c) 2017 Intel and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *------------------------------------------------------------------
19 #include <sys/ioctl.h>
22 #include <vlib/vlib.h>
23 #include <vlib/unix/unix.h>
24 #include <vnet/ethernet/ethernet.h>
25 #include <vnet/fib/fib_entry.h>
26 #include <vnet/fib/fib_table.h>
27 #include <vnet/mfib/mfib_table.h>
28 #include <vnet/adj/adj_mcast.h>
29 #include <vnet/dpo/dpo.h>
30 #include <vnet/plugin/plugin.h>
31 #include <vpp/app/version.h>
32 #include <gtpu/gtpu.h>
35 gtpu_main_t gtpu_main;
38 VNET_FEATURE_INIT (ip4_gtpu_bypass, static) = {
39 .arc_name = "ip4-unicast",
40 .node_name = "ip4-gtpu-bypass",
41 .runs_before = VNET_FEATURES ("ip4-lookup"),
44 VNET_FEATURE_INIT (ip6_gtpu_bypass, static) = {
45 .arc_name = "ip6-unicast",
46 .node_name = "ip6-gtpu-bypass",
47 .runs_before = VNET_FEATURES ("ip6-lookup"),
52 format_decap_next (u8 * s, va_list * args)
54 u32 next_index = va_arg (*args, u32);
58 case GTPU_INPUT_NEXT_DROP:
59 return format (s, "drop");
60 case GTPU_INPUT_NEXT_L2_INPUT:
61 return format (s, "l2");
62 case GTPU_INPUT_NEXT_IP4_INPUT:
63 return format (s, "ip4");
64 case GTPU_INPUT_NEXT_IP6_INPUT:
65 return format (s, "ip6");
67 return format (s, "index %d", next_index);
73 format_gtpu_tunnel (u8 * s, va_list * args)
75 gtpu_tunnel_t *t = va_arg (*args, gtpu_tunnel_t *);
76 gtpu_main_t *ngm = >pu_main;
78 s = format (s, "[%d] src %U dst %U teid %d fib-idx %d sw-if-idx %d ",
80 format_ip46_address, &t->src, IP46_TYPE_ANY,
81 format_ip46_address, &t->dst, IP46_TYPE_ANY,
82 t->teid, t->encap_fib_index, t->sw_if_index);
84 s = format (s, "encap-dpo-idx %d ", t->next_dpo.dpoi_index);
85 s = format (s, "decap-next-%U ", format_decap_next, t->decap_next_index);
87 if (PREDICT_FALSE (ip46_address_is_multicast (&t->dst)))
88 s = format (s, "mcast-sw-if-idx %d ", t->mcast_sw_if_index);
94 format_gtpu_name (u8 * s, va_list * args)
96 u32 dev_instance = va_arg (*args, u32);
97 return format (s, "gtpu_tunnel%d", dev_instance);
100 static clib_error_t *
101 gtpu_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
103 u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
104 VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
105 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
107 return /* no error */ 0;
111 VNET_DEVICE_CLASS (gtpu_device_class,static) = {
113 .format_device_name = format_gtpu_name,
114 .format_tx_trace = format_gtpu_encap_trace,
115 .admin_up_down_function = gtpu_interface_admin_up_down,
120 format_gtpu_header_with_length (u8 * s, va_list * args)
122 u32 dev_instance = va_arg (*args, u32);
123 s = format (s, "unimplemented dev %u", dev_instance);
128 VNET_HW_INTERFACE_CLASS (gtpu_hw_class) =
131 .format_header = format_gtpu_header_with_length,
132 .build_rewrite = default_build_rewrite,
133 .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
138 gtpu_tunnel_restack_dpo (gtpu_tunnel_t * t)
140 dpo_id_t dpo = DPO_INVALID;
141 u32 encap_index = ip46_address_is_ip4 (&t->dst) ?
142 gtpu4_encap_node.index : gtpu6_encap_node.index;
143 fib_forward_chain_type_t forw_type = ip46_address_is_ip4 (&t->dst) ?
144 FIB_FORW_CHAIN_TYPE_UNICAST_IP4 : FIB_FORW_CHAIN_TYPE_UNICAST_IP6;
146 fib_entry_contribute_forwarding (t->fib_entry_index, forw_type, &dpo);
147 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
151 static gtpu_tunnel_t *
152 gtpu_tunnel_from_fib_node (fib_node_t * node)
154 return ((gtpu_tunnel_t *) (((char *) node) -
155 STRUCT_OFFSET_OF (gtpu_tunnel_t, node)));
159 * Function definition to backwalk a FIB node -
160 * Here we will restack the new dpo of GTPU DIP to encap node.
162 static fib_node_back_walk_rc_t
163 gtpu_tunnel_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
165 gtpu_tunnel_restack_dpo (gtpu_tunnel_from_fib_node (node));
166 return (FIB_NODE_BACK_WALK_CONTINUE);
170 * Function definition to get a FIB node from its index
173 gtpu_tunnel_fib_node_get (fib_node_index_t index)
176 gtpu_main_t *gtm = >pu_main;
178 t = pool_elt_at_index (gtm->tunnels, index);
184 * Function definition to inform the FIB node that its last lock has gone.
187 gtpu_tunnel_last_lock_gone (fib_node_t * node)
190 * The GTPU tunnel is a root of the graph. As such
191 * it never has children and thus is never locked.
197 * Virtual function table registered by GTPU tunnels
198 * for participation in the FIB object graph.
200 const static fib_node_vft_t gtpu_vft = {
201 .fnv_get = gtpu_tunnel_fib_node_get,
202 .fnv_last_lock = gtpu_tunnel_last_lock_gone,
203 .fnv_back_walk = gtpu_tunnel_back_walk,
207 #define foreach_copy_field \
209 _(mcast_sw_if_index) \
211 _(decap_next_index) \
216 ip_udp_gtpu_rewrite (gtpu_tunnel_t * t, bool is_ip6)
220 ip4_gtpu_header_t *h4;
221 ip6_gtpu_header_t *h6;
226 int len = is_ip6 ? sizeof *r.h6 : sizeof *r.h4;
228 vec_validate_aligned (r.rw, len - 1, CLIB_CACHE_LINE_BYTES);
232 /* Fixed portion of the (outer) ip header */
235 ip4_header_t *ip = &r.h4->ip4;
238 ip->ip_version_and_header_length = 0x45;
240 ip->protocol = IP_PROTOCOL_UDP;
242 ip->src_address = t->src.ip4;
243 ip->dst_address = t->dst.ip4;
245 /* we fix up the ip4 header length and checksum after-the-fact */
246 ip->checksum = ip4_header_checksum (ip);
250 ip6_header_t *ip = &r.h6->ip6;
253 ip->ip_version_traffic_class_and_flow_label =
254 clib_host_to_net_u32 (6 << 28);
256 ip->protocol = IP_PROTOCOL_UDP;
258 ip->src_address = t->src.ip6;
259 ip->dst_address = t->dst.ip6;
262 /* UDP header, randomize src port on something, maybe? */
263 udp->src_port = clib_host_to_net_u16 (2152);
264 udp->dst_port = clib_host_to_net_u16 (UDP_DST_PORT_GTPU);
267 gtpu->ver_flags = GTPU_V1_VER | GTPU_PT_GTP;
268 gtpu->type = GTPU_TYPE_GTPU;
269 gtpu->teid = clib_host_to_net_u32 (t->teid);
272 /* Now only support 8-byte gtpu header. TBD */
273 _vec_len (t->rewrite) = sizeof (ip4_gtpu_header_t) - 4;
279 gtpu_decap_next_is_valid (gtpu_main_t * gtm, u32 is_ip6, u32 decap_next_index)
281 vlib_main_t *vm = gtm->vlib_main;
282 u32 input_idx = (!is_ip6) ? gtpu4_input_node.index : gtpu6_input_node.index;
283 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, input_idx);
285 return decap_next_index < r->n_next_nodes;
289 vtep_addr_ref (ip46_address_t * ip)
291 uword *vtep = ip46_address_is_ip4 (ip) ?
292 hash_get (gtpu_main.vtep4, ip->ip4.as_u32) :
293 hash_get_mem (gtpu_main.vtep6, &ip->ip6);
296 ip46_address_is_ip4 (ip) ?
297 hash_set (gtpu_main.vtep4, ip->ip4.as_u32, 1) :
298 hash_set_mem_alloc (>pu_main.vtep6, &ip->ip6, 1);
303 vtep_addr_unref (ip46_address_t * ip)
305 uword *vtep = ip46_address_is_ip4 (ip) ?
306 hash_get (gtpu_main.vtep4, ip->ip4.as_u32) :
307 hash_get_mem (gtpu_main.vtep6, &ip->ip6);
311 ip46_address_is_ip4 (ip) ?
312 hash_unset (gtpu_main.vtep4, ip->ip4.as_u32) :
313 hash_unset_mem_free (>pu_main.vtep6, &ip->ip6);
317 typedef CLIB_PACKED (union
321 fib_node_index_t mfib_entry_index;
322 adj_index_t mcast_adj_index;
326 static inline mcast_shared_t
327 mcast_shared_get (ip46_address_t * ip)
329 ASSERT (ip46_address_is_multicast (ip));
330 uword *p = hash_get_mem (gtpu_main.mcast_shared, ip);
332 return (mcast_shared_t)
338 mcast_shared_add (ip46_address_t * dst, fib_node_index_t mfei, adj_index_t ai)
340 mcast_shared_t new_ep = {
341 .mcast_adj_index = ai,
342 .mfib_entry_index = mfei,
345 hash_set_mem_alloc (>pu_main.mcast_shared, dst, new_ep.as_u64);
349 mcast_shared_remove (ip46_address_t * dst)
351 mcast_shared_t ep = mcast_shared_get (dst);
353 adj_unlock (ep.mcast_adj_index);
354 mfib_table_entry_delete_index (ep.mfib_entry_index, MFIB_SOURCE_GTPU);
356 hash_unset_mem_free (>pu_main.mcast_shared, dst);
359 int vnet_gtpu_add_del_tunnel
360 (vnet_gtpu_add_del_tunnel_args_t * a, u32 * sw_if_indexp)
362 gtpu_main_t *gtm = >pu_main;
363 gtpu_tunnel_t *t = 0;
364 vnet_main_t *vnm = gtm->vnet_main;
366 u32 hw_if_index = ~0;
367 u32 sw_if_index = ~0;
368 gtpu4_tunnel_key_t key4;
369 gtpu6_tunnel_key_t key6;
370 u32 is_ip6 = a->is_ip6;
374 key4.src = a->dst.ip4.as_u32; /* decap src in key is encap dst in config */
375 key4.teid = clib_host_to_net_u32 (a->teid);
376 p = hash_get (gtm->gtpu4_tunnel_by_key, key4.as_u64);
380 key6.src = a->dst.ip6;
381 key6.teid = clib_host_to_net_u32 (a->teid);
382 p = hash_get_mem (gtm->gtpu6_tunnel_by_key, &key6);
387 l2input_main_t *l2im = &l2input_main;
389 /* adding a tunnel: tunnel must not already exist */
391 return VNET_API_ERROR_TUNNEL_EXIST;
393 /*if not set explicitly, default to l2 */
394 if (a->decap_next_index == ~0)
395 a->decap_next_index = GTPU_INPUT_NEXT_L2_INPUT;
396 if (!gtpu_decap_next_is_valid (gtm, is_ip6, a->decap_next_index))
397 return VNET_API_ERROR_INVALID_DECAP_NEXT;
399 pool_get_aligned (gtm->tunnels, t, CLIB_CACHE_LINE_BYTES);
400 memset (t, 0, sizeof (*t));
402 /* copy from arg structure */
403 #define _(x) t->x = a->x;
407 ip_udp_gtpu_rewrite (t, is_ip6);
411 hash_set_mem_alloc (>m->gtpu6_tunnel_by_key, &key6,
414 hash_set (gtm->gtpu4_tunnel_by_key, key4.as_u64, t - gtm->tunnels);
416 vnet_hw_interface_t *hi;
417 if (vec_len (gtm->free_gtpu_tunnel_hw_if_indices) > 0)
419 vnet_interface_main_t *im = &vnm->interface_main;
420 hw_if_index = gtm->free_gtpu_tunnel_hw_if_indices
421 [vec_len (gtm->free_gtpu_tunnel_hw_if_indices) - 1];
422 _vec_len (gtm->free_gtpu_tunnel_hw_if_indices) -= 1;
424 hi = vnet_get_hw_interface (vnm, hw_if_index);
425 hi->dev_instance = t - gtm->tunnels;
426 hi->hw_instance = hi->dev_instance;
428 /* clear old stats of freed tunnel before reuse */
429 sw_if_index = hi->sw_if_index;
430 vnet_interface_counter_lock (im);
431 vlib_zero_combined_counter
432 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX],
434 vlib_zero_combined_counter (&im->combined_sw_if_counters
435 [VNET_INTERFACE_COUNTER_RX],
437 vlib_zero_simple_counter (&im->sw_if_counters
438 [VNET_INTERFACE_COUNTER_DROP],
440 vnet_interface_counter_unlock (im);
444 hw_if_index = vnet_register_interface
445 (vnm, gtpu_device_class.index, t - gtm->tunnels,
446 gtpu_hw_class.index, t - gtm->tunnels);
447 hi = vnet_get_hw_interface (vnm, hw_if_index);
450 /* Set gtpu tunnel output node */
451 u32 encap_index = !is_ip6 ?
452 gtpu4_encap_node.index : gtpu6_encap_node.index;
453 vnet_set_interface_output_node (vnm, hw_if_index, encap_index);
455 t->hw_if_index = hw_if_index;
456 t->sw_if_index = sw_if_index = hi->sw_if_index;
458 vec_validate_init_empty (gtm->tunnel_index_by_sw_if_index, sw_if_index,
460 gtm->tunnel_index_by_sw_if_index[sw_if_index] = t - gtm->tunnels;
462 /* setup l2 input config with l2 feature and bd 0 to drop packet */
463 vec_validate (l2im->configs, sw_if_index);
464 l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
465 l2im->configs[sw_if_index].bd_index = 0;
467 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
468 si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
469 vnet_sw_interface_set_flags (vnm, sw_if_index,
470 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
472 fib_node_init (&t->node, gtm->fib_node_type);
473 fib_prefix_t tun_dst_pfx;
474 vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
476 fib_prefix_from_ip46_addr (&t->dst, &tun_dst_pfx);
477 if (!ip46_address_is_multicast (&t->dst))
480 * source the FIB entry for the tunnel's destination
481 * and become a child thereof. The tunnel will then get poked
482 * when the forwarding for the entry updates, and the tunnel can
483 * re-stack accordingly
485 vtep_addr_ref (&t->src);
486 t->fib_entry_index = fib_table_entry_special_add
487 (t->encap_fib_index, &tun_dst_pfx, FIB_SOURCE_RR,
488 FIB_ENTRY_FLAG_NONE);
489 t->sibling_index = fib_entry_child_add
490 (t->fib_entry_index, gtm->fib_node_type, t - gtm->tunnels);
491 gtpu_tunnel_restack_dpo (t);
495 /* Multicast tunnel -
496 * as the same mcast group can be used for mutiple mcast tunnels
497 * with different VNIs, create the output fib adjecency only if
498 * it does not already exist
500 fib_protocol_t fp = fib_ip_proto (is_ip6);
502 if (vtep_addr_ref (&t->dst) == 1)
504 fib_node_index_t mfei;
506 fib_route_path_t path = {
507 .frp_proto = fib_proto_to_dpo (fp),
508 .frp_addr = zero_addr,
509 .frp_sw_if_index = 0xffffffff,
512 .frp_flags = FIB_ROUTE_PATH_LOCAL,
514 const mfib_prefix_t mpfx = {
516 .fp_len = (is_ip6 ? 128 : 32),
517 .fp_grp_addr = tun_dst_pfx.fp_addr,
521 * Setup the (*,G) to receive traffic on the mcast group
522 * - the forwarding interface is for-us
523 * - the accepting interface is that from the API
525 mfib_table_entry_path_update (t->encap_fib_index,
528 &path, MFIB_ITF_FLAG_FORWARD);
530 path.frp_sw_if_index = a->mcast_sw_if_index;
531 path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
532 mfei = mfib_table_entry_path_update (t->encap_fib_index,
536 MFIB_ITF_FLAG_ACCEPT);
539 * Create the mcast adjacency to send traffic to the group
541 ai = adj_mcast_add_or_lock (fp,
542 fib_proto_to_link (fp),
543 a->mcast_sw_if_index);
546 * create a new end-point
548 mcast_shared_add (&t->dst, mfei, ai);
551 dpo_id_t dpo = DPO_INVALID;
552 mcast_shared_t ep = mcast_shared_get (&t->dst);
554 /* Stack shared mcast dst mac addr rewrite on encap */
555 dpo_set (&dpo, DPO_ADJACENCY_MCAST,
556 fib_proto_to_dpo (fp), ep.mcast_adj_index);
558 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
561 flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
564 vnet_get_sw_interface (vnet_get_main (), sw_if_index)->flood_class =
569 /* deleting a tunnel: tunnel must exist */
571 return VNET_API_ERROR_NO_SUCH_ENTRY;
573 t = pool_elt_at_index (gtm->tunnels, p[0]);
574 sw_if_index = t->sw_if_index;
576 vnet_sw_interface_set_flags (vnm, t->sw_if_index, 0 /* down */ );
577 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, t->sw_if_index);
578 si->flags |= VNET_SW_INTERFACE_FLAG_HIDDEN;
580 /* make sure tunnel is removed from l2 bd or xconnect */
581 set_int_l2_mode (gtm->vlib_main, vnm, MODE_L3, t->sw_if_index, 0, 0, 0,
583 vec_add1 (gtm->free_gtpu_tunnel_hw_if_indices, t->hw_if_index);
585 gtm->tunnel_index_by_sw_if_index[t->sw_if_index] = ~0;
588 hash_unset (gtm->gtpu4_tunnel_by_key, key4.as_u64);
590 hash_unset_mem_free (>m->gtpu6_tunnel_by_key, &key6);
592 if (!ip46_address_is_multicast (&t->dst))
594 vtep_addr_unref (&t->src);
595 fib_entry_child_remove (t->fib_entry_index, t->sibling_index);
596 fib_table_entry_delete_index (t->fib_entry_index, FIB_SOURCE_RR);
598 else if (vtep_addr_unref (&t->dst) == 0)
600 mcast_shared_remove (&t->dst);
603 fib_node_deinit (&t->node);
604 vec_free (t->rewrite);
605 pool_put (gtm->tunnels, t);
609 *sw_if_indexp = sw_if_index;
615 get_decap_next_for_node (u32 node_index, u32 ipv4_set)
617 gtpu_main_t *gtm = >pu_main;
618 vlib_main_t *vm = gtm->vlib_main;
619 uword input_node = (ipv4_set) ? gtpu4_input_node.index :
620 gtpu6_input_node.index;
622 return vlib_node_add_next (vm, input_node, node_index);
626 unformat_decap_next (unformat_input_t * input, va_list * args)
628 u32 *result = va_arg (*args, u32 *);
629 u32 ipv4_set = va_arg (*args, int);
630 gtpu_main_t *gtm = >pu_main;
631 vlib_main_t *vm = gtm->vlib_main;
635 if (unformat (input, "l2"))
636 *result = GTPU_INPUT_NEXT_L2_INPUT;
637 else if (unformat (input, "ip4"))
638 *result = GTPU_INPUT_NEXT_IP4_INPUT;
639 else if (unformat (input, "ip6"))
640 *result = GTPU_INPUT_NEXT_IP6_INPUT;
641 else if (unformat (input, "node %U", unformat_vlib_node, vm, &node_index))
642 *result = get_decap_next_for_node (node_index, ipv4_set);
643 else if (unformat (input, "%d", &tmp))
651 static clib_error_t *
652 gtpu_add_del_tunnel_command_fn (vlib_main_t * vm,
653 unformat_input_t * input,
654 vlib_cli_command_t * cmd)
656 unformat_input_t _line_input, *line_input = &_line_input;
657 ip46_address_t src, dst;
664 u32 encap_fib_index = 0;
665 u32 mcast_sw_if_index = ~0;
666 u32 decap_next_index = GTPU_INPUT_NEXT_L2_INPUT;
670 vnet_gtpu_add_del_tunnel_args_t _a, *a = &_a;
671 u32 tunnel_sw_if_index;
672 clib_error_t *error = NULL;
674 /* Cant "universally zero init" (={0}) due to GCC bug 53119 */
675 memset (&src, 0, sizeof src);
676 memset (&dst, 0, sizeof dst);
678 /* Get a line of input. */
679 if (!unformat_user (input, unformat_line_input, line_input))
682 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
684 if (unformat (line_input, "del"))
688 else if (unformat (line_input, "src %U",
689 unformat_ip4_address, &src.ip4))
694 else if (unformat (line_input, "dst %U",
695 unformat_ip4_address, &dst.ip4))
700 else if (unformat (line_input, "src %U",
701 unformat_ip6_address, &src.ip6))
706 else if (unformat (line_input, "dst %U",
707 unformat_ip6_address, &dst.ip6))
712 else if (unformat (line_input, "group %U %U",
713 unformat_ip4_address, &dst.ip4,
714 unformat_vnet_sw_interface,
715 vnet_get_main (), &mcast_sw_if_index))
717 grp_set = dst_set = 1;
720 else if (unformat (line_input, "group %U %U",
721 unformat_ip6_address, &dst.ip6,
722 unformat_vnet_sw_interface,
723 vnet_get_main (), &mcast_sw_if_index))
725 grp_set = dst_set = 1;
728 else if (unformat (line_input, "encap-vrf-id %d", &tmp))
730 encap_fib_index = fib_table_find (fib_ip_proto (ipv6_set), tmp);
731 if (encap_fib_index == ~0)
734 clib_error_return (0, "nonexistent encap-vrf-id %d", tmp);
738 else if (unformat (line_input, "decap-next %U", unformat_decap_next,
739 &decap_next_index, ipv4_set))
741 else if (unformat (line_input, "teid %d", &teid))
745 error = clib_error_return (0, "parse error: '%U'",
746 format_unformat_error, line_input);
753 error = clib_error_return (0, "tunnel src address not specified");
759 error = clib_error_return (0, "tunnel dst address not specified");
763 if (grp_set && !ip46_address_is_multicast (&dst))
765 error = clib_error_return (0, "tunnel group address not multicast");
769 if (grp_set == 0 && ip46_address_is_multicast (&dst))
771 error = clib_error_return (0, "dst address must be unicast");
775 if (grp_set && mcast_sw_if_index == ~0)
777 error = clib_error_return (0, "tunnel nonexistent multicast device");
781 if (ipv4_set && ipv6_set)
783 error = clib_error_return (0, "both IPv4 and IPv6 addresses specified");
787 if (ip46_address_cmp (&src, &dst) == 0)
789 error = clib_error_return (0, "src and dst addresses are identical");
793 if (decap_next_index == ~0)
795 error = clib_error_return (0, "next node not found");
799 memset (a, 0, sizeof (*a));
802 a->is_ip6 = ipv6_set;
804 #define _(x) a->x = x;
808 rv = vnet_gtpu_add_del_tunnel (a, &tunnel_sw_if_index);
814 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
815 vnet_get_main (), tunnel_sw_if_index);
818 case VNET_API_ERROR_TUNNEL_EXIST:
819 error = clib_error_return (0, "tunnel already exists...");
822 case VNET_API_ERROR_NO_SUCH_ENTRY:
823 error = clib_error_return (0, "tunnel does not exist...");
827 error = clib_error_return
828 (0, "vnet_gtpu_add_del_tunnel returned %d", rv);
833 unformat_free (line_input);
839 * Add or delete a GTPU Tunnel.
841 * GTPU provides the features needed to allow L2 bridge domains (BDs)
842 * to span multiple servers. This is done by building an L2 overlay on
843 * top of an L3 network underlay using GTPU tunnels.
845 * This makes it possible for servers to be co-located in the same data
846 * center or be separated geographically as long as they are reachable
847 * through the underlay L3 network.
849 * You can refer to this kind of L2 overlay bridge domain as a GTPU
850 * (Virtual eXtensible VLAN) segment.
853 * Example of how to create a GTPU Tunnel:
854 * @cliexcmd{create gtpu tunnel src 10.0.3.1 dst 10.0.3.3 teid 13 encap-vrf-id 7}
855 * Example of how to delete a GTPU Tunnel:
856 * @cliexcmd{create gtpu tunnel src 10.0.3.1 dst 10.0.3.3 teid 13 del}
859 VLIB_CLI_COMMAND (create_gtpu_tunnel_command, static) = {
860 .path = "create gtpu tunnel",
862 "create gtpu tunnel src <local-vtep-addr>"
863 " {dst <remote-vtep-addr>|group <mcast-vtep-addr> <intf-name>} teid <nn>"
864 " [encap-vrf-id <nn>] [decap-next [l2|ip4|ip6|node <name>]] [del]",
865 .function = gtpu_add_del_tunnel_command_fn,
869 static clib_error_t *
870 show_gtpu_tunnel_command_fn (vlib_main_t * vm,
871 unformat_input_t * input,
872 vlib_cli_command_t * cmd)
874 gtpu_main_t *gtm = >pu_main;
877 if (pool_elts (gtm->tunnels) == 0)
878 vlib_cli_output (vm, "No gtpu tunnels configured...");
880 pool_foreach (t, gtm->tunnels, (
882 vlib_cli_output (vm, "%U",
883 format_gtpu_tunnel, t);
891 * Display all the GTPU Tunnel entries.
894 * Example of how to display the GTPU Tunnel entries:
895 * @cliexstart{show gtpu tunnel}
896 * [0] src 10.0.3.1 dst 10.0.3.3 teid 13 encap_fib_index 0 sw_if_index 5 decap_next l2
900 VLIB_CLI_COMMAND (show_gtpu_tunnel_command, static) = {
901 .path = "show gtpu tunnel",
902 .short_help = "show gtpu tunnel",
903 .function = show_gtpu_tunnel_command_fn,
908 vnet_int_gtpu_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable)
911 vnet_feature_enable_disable ("ip6-unicast", "ip6-gtpu-bypass",
912 sw_if_index, is_enable, 0, 0);
914 vnet_feature_enable_disable ("ip4-unicast", "ip4-gtpu-bypass",
915 sw_if_index, is_enable, 0, 0);
918 static clib_error_t *
919 set_ip_gtpu_bypass (u32 is_ip6,
920 unformat_input_t * input, vlib_cli_command_t * cmd)
922 unformat_input_t _line_input, *line_input = &_line_input;
923 vnet_main_t *vnm = vnet_get_main ();
924 clib_error_t *error = 0;
925 u32 sw_if_index, is_enable;
930 if (!unformat_user (input, unformat_line_input, line_input))
933 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
936 (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
938 else if (unformat (line_input, "del"))
942 error = unformat_parse_error (line_input);
947 if (~0 == sw_if_index)
949 error = clib_error_return (0, "unknown interface `%U'",
950 format_unformat_error, line_input);
954 vnet_int_gtpu_bypass_mode (sw_if_index, is_ip6, is_enable);
957 unformat_free (line_input);
962 static clib_error_t *
963 set_ip4_gtpu_bypass (vlib_main_t * vm,
964 unformat_input_t * input, vlib_cli_command_t * cmd)
966 return set_ip_gtpu_bypass (0, input, cmd);
970 * This command adds the 'ip4-gtpu-bypass' graph node for a given interface.
971 * By adding the IPv4 gtpu-bypass graph node to an interface, the node checks
972 * for and validate input gtpu packet and bypass ip4-lookup, ip4-local,
973 * ip4-udp-lookup nodes to speedup gtpu packet forwarding. This node will
974 * cause extra overhead to for non-gtpu packets which is kept at a minimum.
978 * Example of graph node before ip4-gtpu-bypass is enabled:
979 * @cliexstart{show vlib graph ip4-gtpu-bypass}
981 * ip4-gtpu-bypass error-drop [0]
986 * Example of how to enable ip4-gtpu-bypass on an interface:
987 * @cliexcmd{set interface ip gtpu-bypass GigabitEthernet2/0/0}
989 * Example of graph node after ip4-gtpu-bypass is enabled:
990 * @cliexstart{show vlib graph ip4-gtpu-bypass}
992 * ip4-gtpu-bypass error-drop [0] ip4-input
993 * gtpu4-input [1] ip4-input-no-checksum
997 * Example of how to display the feature enabed on an interface:
998 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
999 * IP feature paths configured on GigabitEthernet2/0/0...
1007 * Example of how to disable ip4-gtpu-bypass on an interface:
1008 * @cliexcmd{set interface ip gtpu-bypass GigabitEthernet2/0/0 del}
1012 VLIB_CLI_COMMAND (set_interface_ip_gtpu_bypass_command, static) = {
1013 .path = "set interface ip gtpu-bypass",
1014 .function = set_ip4_gtpu_bypass,
1015 .short_help = "set interface ip gtpu-bypass <interface> [del]",
1019 static clib_error_t *
1020 set_ip6_gtpu_bypass (vlib_main_t * vm,
1021 unformat_input_t * input, vlib_cli_command_t * cmd)
1023 return set_ip_gtpu_bypass (1, input, cmd);
1027 * This command adds the 'ip6-gtpu-bypass' graph node for a given interface.
1028 * By adding the IPv6 gtpu-bypass graph node to an interface, the node checks
1029 * for and validate input gtpu packet and bypass ip6-lookup, ip6-local,
1030 * ip6-udp-lookup nodes to speedup gtpu packet forwarding. This node will
1031 * cause extra overhead to for non-gtpu packets which is kept at a minimum.
1035 * Example of graph node before ip6-gtpu-bypass is enabled:
1036 * @cliexstart{show vlib graph ip6-gtpu-bypass}
1037 * Name Next Previous
1038 * ip6-gtpu-bypass error-drop [0]
1043 * Example of how to enable ip6-gtpu-bypass on an interface:
1044 * @cliexcmd{set interface ip6 gtpu-bypass GigabitEthernet2/0/0}
1046 * Example of graph node after ip6-gtpu-bypass is enabled:
1047 * @cliexstart{show vlib graph ip6-gtpu-bypass}
1048 * Name Next Previous
1049 * ip6-gtpu-bypass error-drop [0] ip6-input
1050 * gtpu6-input [1] ip4-input-no-checksum
1054 * Example of how to display the feature enabed on an interface:
1055 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1056 * IP feature paths configured on GigabitEthernet2/0/0...
1064 * Example of how to disable ip6-gtpu-bypass on an interface:
1065 * @cliexcmd{set interface ip6 gtpu-bypass GigabitEthernet2/0/0 del}
1069 VLIB_CLI_COMMAND (set_interface_ip6_gtpu_bypass_command, static) = {
1070 .path = "set interface ip6 gtpu-bypass",
1071 .function = set_ip6_gtpu_bypass,
1072 .short_help = "set interface ip gtpu-bypass <interface> [del]",
1077 gtpu_init (vlib_main_t * vm)
1079 gtpu_main_t *gtm = >pu_main;
1081 gtm->vnet_main = vnet_get_main ();
1082 gtm->vlib_main = vm;
1084 /* initialize the ip6 hash */
1085 gtm->gtpu6_tunnel_by_key = hash_create_mem (0,
1086 sizeof (gtpu6_tunnel_key_t),
1088 gtm->vtep6 = hash_create_mem (0, sizeof (ip6_address_t), sizeof (uword));
1089 gtm->mcast_shared = hash_create_mem (0,
1090 sizeof (ip46_address_t),
1091 sizeof (mcast_shared_t));
1093 udp_register_dst_port (vm, UDP_DST_PORT_GTPU,
1094 gtpu4_input_node.index, /* is_ip4 */ 1);
1095 udp_register_dst_port (vm, UDP_DST_PORT_GTPU6,
1096 gtpu6_input_node.index, /* is_ip4 */ 0);
1098 gtm->fib_node_type = fib_node_register_new_type (>pu_vft);
1103 VLIB_INIT_FUNCTION (gtpu_init);
1106 VLIB_PLUGIN_REGISTER () = {
1107 .version = VPP_BUILD_VER,
1108 .description = "GTPv1-U",
1113 * fd.io coding-style-patch-verification: ON
1116 * eval: (c-set-style "gnu")