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/fib/fib_entry_track.h>
28 #include <vnet/mfib/mfib_table.h>
29 #include <vnet/adj/adj_mcast.h>
30 #include <vnet/dpo/dpo.h>
31 #include <vnet/plugin/plugin.h>
32 #include <vpp/app/version.h>
33 #include <gtpu/gtpu.h>
34 #include <vnet/flow/flow.h>
36 gtpu_main_t gtpu_main;
39 VNET_FEATURE_INIT (ip4_gtpu_bypass, static) = {
40 .arc_name = "ip4-unicast",
41 .node_name = "ip4-gtpu-bypass",
42 .runs_before = VNET_FEATURES ("ip4-lookup"),
45 VNET_FEATURE_INIT (ip6_gtpu_bypass, static) = {
46 .arc_name = "ip6-unicast",
47 .node_name = "ip6-gtpu-bypass",
48 .runs_before = VNET_FEATURES ("ip6-lookup"),
52 u8 * format_gtpu_encap_trace (u8 * s, va_list * args)
54 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
55 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
56 gtpu_encap_trace_t * t
57 = va_arg (*args, gtpu_encap_trace_t *);
59 s = format (s, "GTPU encap to gtpu_tunnel%d tteid %d",
60 t->tunnel_index, t->tteid);
65 format_decap_next (u8 * s, va_list * args)
67 u32 next_index = va_arg (*args, u32);
71 case GTPU_INPUT_NEXT_DROP:
72 return format (s, "drop");
73 case GTPU_INPUT_NEXT_L2_INPUT:
74 return format (s, "l2");
75 case GTPU_INPUT_NEXT_IP4_INPUT:
76 return format (s, "ip4");
77 case GTPU_INPUT_NEXT_IP6_INPUT:
78 return format (s, "ip6");
80 return format (s, "index %d", next_index);
86 format_gtpu_tunnel (u8 * s, va_list * args)
88 gtpu_tunnel_t *t = va_arg (*args, gtpu_tunnel_t *);
89 gtpu_main_t *ngm = >pu_main;
90 ip4_main_t *im4 = &ip4_main;
91 ip6_main_t *im6 = &ip6_main;
92 u8 is_ipv6 = !ip46_address_is_ip4 (&t->dst);
95 is_ipv6 ? im6->fibs[t->encap_fib_index].ft_table_id :
96 im4->fibs[t->encap_fib_index].ft_table_id;
98 s = format (s, "[%d] src %U dst %U teid %d tteid %d "
99 "encap-vrf-id %d sw-if-idx %d ",
101 format_ip46_address, &t->src, IP46_TYPE_ANY,
102 format_ip46_address, &t->dst, IP46_TYPE_ANY,
103 t->teid, t->tteid, encap_vrf_id, t->sw_if_index);
105 s = format (s, "encap-dpo-idx %d ", t->next_dpo.dpoi_index);
106 s = format (s, "decap-next-%U ", format_decap_next, t->decap_next_index);
108 if (PREDICT_FALSE (ip46_address_is_multicast (&t->dst)))
109 s = format (s, "mcast-sw-if-idx %d ", t->mcast_sw_if_index);
115 format_gtpu_name (u8 * s, va_list * args)
117 u32 dev_instance = va_arg (*args, u32);
118 return format (s, "gtpu_tunnel%d", dev_instance);
121 static clib_error_t *
122 gtpu_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
124 u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
125 VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
126 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
128 return /* no error */ 0;
132 VNET_DEVICE_CLASS (gtpu_device_class,static) = {
134 .format_device_name = format_gtpu_name,
135 .format_tx_trace = format_gtpu_encap_trace,
136 .admin_up_down_function = gtpu_interface_admin_up_down,
141 format_gtpu_header_with_length (u8 * s, va_list * args)
143 u32 dev_instance = va_arg (*args, u32);
144 s = format (s, "unimplemented dev %u", dev_instance);
149 VNET_HW_INTERFACE_CLASS (gtpu_hw_class) =
152 .format_header = format_gtpu_header_with_length,
153 .build_rewrite = default_build_rewrite,
154 .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
159 gtpu_tunnel_restack_dpo (gtpu_tunnel_t * t)
161 dpo_id_t dpo = DPO_INVALID;
162 u32 encap_index = ip46_address_is_ip4 (&t->dst) ?
163 gtpu4_encap_node.index : gtpu6_encap_node.index;
164 fib_forward_chain_type_t forw_type = ip46_address_is_ip4 (&t->dst) ?
165 FIB_FORW_CHAIN_TYPE_UNICAST_IP4 : FIB_FORW_CHAIN_TYPE_UNICAST_IP6;
167 fib_entry_contribute_forwarding (t->fib_entry_index, forw_type, &dpo);
168 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
172 static gtpu_tunnel_t *
173 gtpu_tunnel_from_fib_node (fib_node_t * node)
175 return ((gtpu_tunnel_t *) (((char *) node) -
176 STRUCT_OFFSET_OF (gtpu_tunnel_t, node)));
180 * Function definition to backwalk a FIB node -
181 * Here we will restack the new dpo of GTPU DIP to encap node.
183 static fib_node_back_walk_rc_t
184 gtpu_tunnel_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
186 gtpu_tunnel_restack_dpo (gtpu_tunnel_from_fib_node (node));
187 return (FIB_NODE_BACK_WALK_CONTINUE);
191 * Function definition to get a FIB node from its index
194 gtpu_tunnel_fib_node_get (fib_node_index_t index)
197 gtpu_main_t *gtm = >pu_main;
199 t = pool_elt_at_index (gtm->tunnels, index);
205 * Function definition to inform the FIB node that its last lock has gone.
208 gtpu_tunnel_last_lock_gone (fib_node_t * node)
211 * The GTPU tunnel is a root of the graph. As such
212 * it never has children and thus is never locked.
218 * Virtual function table registered by GTPU tunnels
219 * for participation in the FIB object graph.
221 const static fib_node_vft_t gtpu_vft = {
222 .fnv_get = gtpu_tunnel_fib_node_get,
223 .fnv_last_lock = gtpu_tunnel_last_lock_gone,
224 .fnv_back_walk = gtpu_tunnel_back_walk,
228 #define foreach_copy_field \
231 _(mcast_sw_if_index) \
233 _(decap_next_index) \
238 ip_udp_gtpu_rewrite (gtpu_tunnel_t * t, bool is_ip6)
242 ip4_gtpu_header_t *h4;
243 ip6_gtpu_header_t *h6;
248 int len = is_ip6 ? sizeof *r.h6 : sizeof *r.h4;
250 vec_validate_aligned (r.rw, len - 1, CLIB_CACHE_LINE_BYTES);
254 /* Fixed portion of the (outer) ip header */
257 ip4_header_t *ip = &r.h4->ip4;
260 ip->ip_version_and_header_length = 0x45;
262 ip->protocol = IP_PROTOCOL_UDP;
264 ip->src_address = t->src.ip4;
265 ip->dst_address = t->dst.ip4;
267 /* we fix up the ip4 header length and checksum after-the-fact */
268 ip->checksum = ip4_header_checksum (ip);
272 ip6_header_t *ip = &r.h6->ip6;
275 ip->ip_version_traffic_class_and_flow_label =
276 clib_host_to_net_u32 (6 << 28);
278 ip->protocol = IP_PROTOCOL_UDP;
280 ip->src_address = t->src.ip6;
281 ip->dst_address = t->dst.ip6;
284 /* UDP header, randomize src port on something, maybe? */
285 udp->src_port = clib_host_to_net_u16 (2152);
286 udp->dst_port = clib_host_to_net_u16 (UDP_DST_PORT_GTPU);
289 gtpu->ver_flags = GTPU_V1_VER | GTPU_PT_GTP;
290 gtpu->type = GTPU_TYPE_GTPU;
291 gtpu->teid = clib_host_to_net_u32 (t->tteid);
294 /* Now only support 8-byte gtpu header. TBD */
295 _vec_len (t->rewrite) = sizeof (ip4_gtpu_header_t) - 4;
301 gtpu_decap_next_is_valid (gtpu_main_t * gtm, u32 is_ip6, u32 decap_next_index)
303 vlib_main_t *vm = gtm->vlib_main;
304 u32 input_idx = (!is_ip6) ? gtpu4_input_node.index : gtpu6_input_node.index;
305 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, input_idx);
307 return decap_next_index < r->n_next_nodes;
310 typedef CLIB_PACKED (union
314 fib_node_index_t mfib_entry_index;
315 adj_index_t mcast_adj_index;
319 static inline mcast_shared_t
320 mcast_shared_get (ip46_address_t * ip)
322 ASSERT (ip46_address_is_multicast (ip));
323 uword *p = hash_get_mem (gtpu_main.mcast_shared, ip);
325 return (mcast_shared_t)
331 mcast_shared_add (ip46_address_t * dst, fib_node_index_t mfei, adj_index_t ai)
333 mcast_shared_t new_ep = {
334 .mcast_adj_index = ai,
335 .mfib_entry_index = mfei,
338 hash_set_mem_alloc (>pu_main.mcast_shared, dst, new_ep.as_u64);
342 mcast_shared_remove (ip46_address_t * dst)
344 mcast_shared_t ep = mcast_shared_get (dst);
346 adj_unlock (ep.mcast_adj_index);
347 mfib_table_entry_delete_index (ep.mfib_entry_index, MFIB_SOURCE_GTPU);
349 hash_unset_mem_free (>pu_main.mcast_shared, dst);
352 int vnet_gtpu_add_mod_del_tunnel
353 (vnet_gtpu_add_mod_del_tunnel_args_t * a, u32 * sw_if_indexp)
355 gtpu_main_t *gtm = >pu_main;
356 gtpu_tunnel_t *t = 0;
357 vnet_main_t *vnm = gtm->vnet_main;
359 u32 hw_if_index = ~0;
360 u32 sw_if_index = ~0;
361 gtpu4_tunnel_key_t key4;
362 gtpu6_tunnel_key_t key6;
363 bool is_ip6 = !ip46_address_is_ip4 (&a->dst);
367 key4.src = a->dst.ip4.as_u32; /* decap src in key is encap dst in config */
368 key4.teid = clib_host_to_net_u32 (a->teid);
369 p = hash_get (gtm->gtpu4_tunnel_by_key, key4.as_u64);
373 key6.src = a->dst.ip6;
374 key6.teid = clib_host_to_net_u32 (a->teid);
375 p = hash_get_mem (gtm->gtpu6_tunnel_by_key, &key6);
378 if (a->opn == GTPU_ADD_TUNNEL)
380 l2input_main_t *l2im = &l2input_main;
382 /* adding a tunnel: tunnel must not already exist */
384 return VNET_API_ERROR_TUNNEL_EXIST;
386 /*if not set explicitly, default to l2 */
387 if (a->decap_next_index == ~0)
388 a->decap_next_index = GTPU_INPUT_NEXT_L2_INPUT;
389 if (!gtpu_decap_next_is_valid (gtm, is_ip6, a->decap_next_index))
390 return VNET_API_ERROR_INVALID_DECAP_NEXT;
392 pool_get_aligned (gtm->tunnels, t, CLIB_CACHE_LINE_BYTES);
393 clib_memset (t, 0, sizeof (*t));
395 /* copy from arg structure */
396 #define _(x) t->x = a->x;
400 /* default to same as local rx teid */
404 ip_udp_gtpu_rewrite (t, is_ip6);
406 /* clear the flow index */
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 * Track the FIB entry for the tunnel's destination.
481 * 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 (>m->vtep_table, t->encap_fib_index, &t->src);
486 t->fib_entry_index = fib_entry_track (t->encap_fib_index,
491 gtpu_tunnel_restack_dpo (t);
495 /* Multicast tunnel -
496 * as the same mcast group can be used for multiple mcast tunnels
497 * with different VNIs, create the output adjacency only if
498 * it does not already exist
500 fib_protocol_t fp = fib_ip_proto (is_ip6);
502 if (vtep_addr_ref (>m->vtep_table,
503 t->encap_fib_index, &t->dst) == 1)
505 fib_node_index_t mfei;
507 fib_route_path_t path = {
508 .frp_proto = fib_proto_to_dpo (fp),
509 .frp_addr = zero_addr,
510 .frp_sw_if_index = 0xffffffff,
513 .frp_flags = FIB_ROUTE_PATH_LOCAL,
514 .frp_mitf_flags = MFIB_ITF_FLAG_FORWARD,
516 const mfib_prefix_t mpfx = {
518 .fp_len = (is_ip6 ? 128 : 32),
519 .fp_grp_addr = tun_dst_pfx.fp_addr,
523 * Setup the (*,G) to receive traffic on the mcast group
524 * - the forwarding interface is for-us
525 * - the accepting interface is that from the API
527 mfib_table_entry_path_update (t->encap_fib_index,
528 &mpfx, MFIB_SOURCE_GTPU, &path);
530 path.frp_sw_if_index = a->mcast_sw_if_index;
531 path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
532 path.frp_mitf_flags = MFIB_ITF_FLAG_ACCEPT;
533 mfei = mfib_table_entry_path_update (t->encap_fib_index,
535 MFIB_SOURCE_GTPU, &path);
538 * Create the mcast adjacency to send traffic to the group
540 ai = adj_mcast_add_or_lock (fp,
541 fib_proto_to_link (fp),
542 a->mcast_sw_if_index);
545 * create a new end-point
547 mcast_shared_add (&t->dst, mfei, ai);
550 dpo_id_t dpo = DPO_INVALID;
551 mcast_shared_t ep = mcast_shared_get (&t->dst);
553 /* Stack shared mcast dst mac addr rewrite on encap */
554 dpo_set (&dpo, DPO_ADJACENCY_MCAST,
555 fib_proto_to_dpo (fp), ep.mcast_adj_index);
557 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
560 flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
563 vnet_get_sw_interface (vnet_get_main (), sw_if_index)->flood_class =
568 /* mod-tteid or deleting a tunnel: tunnel must exist */
570 return VNET_API_ERROR_NO_SUCH_ENTRY;
572 t = pool_elt_at_index (gtm->tunnels, p[0]);
573 sw_if_index = t->sw_if_index;
575 if (a->opn == GTPU_UPD_TTEID)
578 return VNET_API_ERROR_INVALID_VALUE;
580 ip_udp_gtpu_rewrite (t, is_ip6);
585 vnet_sw_interface_set_flags (vnm, t->sw_if_index, 0 /* down */ );
586 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, t->sw_if_index);
587 si->flags |= VNET_SW_INTERFACE_FLAG_HIDDEN;
589 /* make sure tunnel is removed from l2 bd or xconnect */
590 set_int_l2_mode (gtm->vlib_main, vnm, MODE_L3, t->sw_if_index, 0,
591 L2_BD_PORT_TYPE_NORMAL, 0, 0);
592 vec_add1 (gtm->free_gtpu_tunnel_hw_if_indices, t->hw_if_index);
594 gtm->tunnel_index_by_sw_if_index[t->sw_if_index] = ~0;
597 hash_unset (gtm->gtpu4_tunnel_by_key, key4.as_u64);
599 hash_unset_mem_free (>m->gtpu6_tunnel_by_key, &key6);
601 if (!ip46_address_is_multicast (&t->dst))
603 if (t->flow_index != ~0)
604 vnet_flow_del (vnm, t->flow_index);
606 vtep_addr_unref (>m->vtep_table, t->encap_fib_index, &t->src);
607 fib_entry_untrack (t->fib_entry_index, t->sibling_index);
609 else if (vtep_addr_unref (>m->vtep_table,
610 t->encap_fib_index, &t->dst) == 0)
612 mcast_shared_remove (&t->dst);
615 fib_node_deinit (&t->node);
616 vec_free (t->rewrite);
617 pool_put (gtm->tunnels, t);
621 *sw_if_indexp = sw_if_index;
623 if (a->opn == GTPU_ADD_TUNNEL)
625 /* register udp ports */
626 if (!is_ip6 && !udp_is_valid_dst_port (UDP_DST_PORT_GTPU, 1))
627 udp_register_dst_port (gtm->vlib_main, UDP_DST_PORT_GTPU,
628 gtpu4_input_node.index, /* is_ip4 */ 1);
629 if (is_ip6 && !udp_is_valid_dst_port (UDP_DST_PORT_GTPU6, 0))
630 udp_register_dst_port (gtm->vlib_main, UDP_DST_PORT_GTPU6,
631 gtpu6_input_node.index, /* is_ip4 */ 0);
638 get_decap_next_for_node (u32 node_index, u32 ipv4_set)
640 gtpu_main_t *gtm = >pu_main;
641 vlib_main_t *vm = gtm->vlib_main;
642 uword input_node = (ipv4_set) ? gtpu4_input_node.index :
643 gtpu6_input_node.index;
645 return vlib_node_add_next (vm, input_node, node_index);
649 unformat_decap_next (unformat_input_t * input, va_list * args)
651 u32 *result = va_arg (*args, u32 *);
652 u32 ipv4_set = va_arg (*args, int);
653 gtpu_main_t *gtm = >pu_main;
654 vlib_main_t *vm = gtm->vlib_main;
658 if (unformat (input, "l2"))
659 *result = GTPU_INPUT_NEXT_L2_INPUT;
660 else if (unformat (input, "ip4"))
661 *result = GTPU_INPUT_NEXT_IP4_INPUT;
662 else if (unformat (input, "ip6"))
663 *result = GTPU_INPUT_NEXT_IP6_INPUT;
664 else if (unformat (input, "node %U", unformat_vlib_node, vm, &node_index))
665 *result = get_decap_next_for_node (node_index, ipv4_set);
666 else if (unformat (input, "%d", &tmp))
674 static clib_error_t *
675 gtpu_add_del_tunnel_command_fn (vlib_main_t * vm,
676 unformat_input_t * input,
677 vlib_cli_command_t * cmd)
679 unformat_input_t _line_input, *line_input = &_line_input;
680 ip46_address_t src, dst;
681 u8 opn = GTPU_ADD_TUNNEL;
687 u32 encap_fib_index = 0;
688 u32 mcast_sw_if_index = ~0;
689 u32 decap_next_index = GTPU_INPUT_NEXT_L2_INPUT;
690 u32 teid = 0, tteid = 0;
693 vnet_gtpu_add_mod_del_tunnel_args_t _a, *a = &_a;
694 u32 tunnel_sw_if_index;
695 clib_error_t *error = NULL;
697 /* Cant "universally zero init" (={0}) due to GCC bug 53119 */
698 clib_memset (&src, 0, sizeof src);
699 clib_memset (&dst, 0, sizeof dst);
701 /* Get a line of input. */
702 if (!unformat_user (input, unformat_line_input, line_input))
705 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
707 if (unformat (line_input, "del"))
709 opn = GTPU_DEL_TUNNEL;
711 else if (unformat (line_input, "src %U",
712 unformat_ip4_address, &src.ip4))
717 else if (unformat (line_input, "dst %U",
718 unformat_ip4_address, &dst.ip4))
723 else if (unformat (line_input, "src %U",
724 unformat_ip6_address, &src.ip6))
729 else if (unformat (line_input, "dst %U",
730 unformat_ip6_address, &dst.ip6))
735 else if (unformat (line_input, "group %U %U",
736 unformat_ip4_address, &dst.ip4,
737 unformat_vnet_sw_interface,
738 vnet_get_main (), &mcast_sw_if_index))
740 grp_set = dst_set = 1;
743 else if (unformat (line_input, "group %U %U",
744 unformat_ip6_address, &dst.ip6,
745 unformat_vnet_sw_interface,
746 vnet_get_main (), &mcast_sw_if_index))
748 grp_set = dst_set = 1;
751 else if (unformat (line_input, "encap-vrf-id %d", &tmp))
753 encap_fib_index = fib_table_find (fib_ip_proto (ipv6_set), tmp);
754 if (encap_fib_index == ~0)
757 clib_error_return (0, "nonexistent encap-vrf-id %d", tmp);
761 else if (unformat (line_input, "decap-next %U", unformat_decap_next,
762 &decap_next_index, ipv4_set))
764 else if (unformat (line_input, "teid %d", &teid))
766 else if (unformat (line_input, "tteid %d", &tteid))
768 else if (unformat (line_input, "upd-tteid %d", &tteid))
769 opn = GTPU_UPD_TTEID;
772 error = clib_error_return (0, "parse error: '%U'",
773 format_unformat_error, line_input);
780 error = clib_error_return (0, "tunnel teid specified");
784 if (src_set == 0 && opn == GTPU_ADD_TUNNEL)
786 error = clib_error_return (0, "tunnel src address not specified");
792 error = clib_error_return (0, "tunnel dst address not specified");
796 if (grp_set && !ip46_address_is_multicast (&dst))
798 error = clib_error_return (0, "tunnel group address not multicast");
802 if (grp_set == 0 && ip46_address_is_multicast (&dst))
804 error = clib_error_return (0, "dst address must be unicast");
808 if (grp_set && mcast_sw_if_index == ~0)
810 error = clib_error_return (0, "tunnel nonexistent multicast device");
814 if (ipv4_set && ipv6_set)
816 error = clib_error_return (0, "both IPv4 and IPv6 addresses specified");
820 if (ip46_address_cmp (&src, &dst) == 0)
822 error = clib_error_return (0, "src and dst addresses are identical");
826 if (decap_next_index == ~0)
828 error = clib_error_return (0, "next node not found");
832 clib_memset (a, 0, sizeof (*a));
836 #define _(x) a->x = x;
840 rv = vnet_gtpu_add_mod_del_tunnel (a, &tunnel_sw_if_index);
845 if (opn == GTPU_ADD_TUNNEL)
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...");
858 case VNET_API_ERROR_INVALID_VALUE:
859 error = clib_error_return (0, "tx teid not specified...");
863 error = clib_error_return
864 (0, "vnet_gtpu_add_del_tunnel returned %d", rv);
869 unformat_free (line_input);
875 * Add or delete a GTPU Tunnel.
877 * GTPU can be used to transport Ethernet packets as its PDU type to
878 * provides allow L2 network or bridge domains (BDs)
879 * to span multiple servers. This is done by building an L2 overlay on
880 * top of an L3 network underlay using GTPU tunnels.
882 * GTPU can also be used to transport IP packetes as its PDU type to
883 * allow IP forwarding over underlay network, e.g. between RAN and UPF
884 * for mobility deplyments.
887 * Example of how to create a GTPU Tunnel:
888 * @cliexcmd{create gtpu tunnel src 10.0.3.1 dst 10.0.3.3 teid 13 tteid 55 encap-vrf-id 7}
889 * Example of how to delete a GTPU Tunnel:
890 * @cliexcmd{create gtpu tunnel src 10.0.3.1 dst 10.0.3.3 teid 13 encap-vrf-id 7 del}
891 * Example of how to update tx TEID of a GTPU Tunnel:
892 * @cliexcmd{create gtpu tunnel src 10.0.3.1 dst 10.0.3.3 encap-vrf-id 7 upd-tteid 55}
895 VLIB_CLI_COMMAND (create_gtpu_tunnel_command, static) = {
896 .path = "create gtpu tunnel",
898 "create gtpu tunnel src <local-tep-addr>"
899 " {dst <remote-tep-addr>|group <mcast-addr> <intf-name>}"
900 " teid <nn> [tteid <nn>] [encap-vrf-id <nn>]"
901 " [decap-next [l2|ip4|ip6|node <name>]] [del | upd-tteid <nn>]",
902 .function = gtpu_add_del_tunnel_command_fn,
906 static clib_error_t *
907 show_gtpu_tunnel_command_fn (vlib_main_t * vm,
908 unformat_input_t * input,
909 vlib_cli_command_t * cmd)
911 gtpu_main_t *gtm = >pu_main;
914 if (pool_elts (gtm->tunnels) == 0)
915 vlib_cli_output (vm, "No gtpu tunnels configured...");
917 pool_foreach (t, gtm->tunnels)
919 vlib_cli_output (vm, "%U", format_gtpu_tunnel, t);
926 * Display all the GTPU Tunnel entries.
929 * Example of how to display the GTPU Tunnel entries:
930 * @cliexstart{show gtpu tunnel}
931 * [0] src 10.0.3.1 dst 10.0.3.3 teid 13 tx-teid 55 encap_fib_index 0 sw_if_index 5 decap_next l2
935 VLIB_CLI_COMMAND (show_gtpu_tunnel_command, static) = {
936 .path = "show gtpu tunnel",
937 .short_help = "show gtpu tunnel",
938 .function = show_gtpu_tunnel_command_fn,
943 vnet_int_gtpu_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable)
946 vnet_feature_enable_disable ("ip6-unicast", "ip6-gtpu-bypass",
947 sw_if_index, is_enable, 0, 0);
949 vnet_feature_enable_disable ("ip4-unicast", "ip4-gtpu-bypass",
950 sw_if_index, is_enable, 0, 0);
953 static clib_error_t *
954 set_ip_gtpu_bypass (u32 is_ip6,
955 unformat_input_t * input, vlib_cli_command_t * cmd)
957 unformat_input_t _line_input, *line_input = &_line_input;
958 vnet_main_t *vnm = vnet_get_main ();
959 clib_error_t *error = 0;
960 u32 sw_if_index, is_enable;
965 if (!unformat_user (input, unformat_line_input, line_input))
968 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
971 (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
973 else if (unformat (line_input, "del"))
977 error = unformat_parse_error (line_input);
982 if (~0 == sw_if_index)
984 error = clib_error_return (0, "unknown interface `%U'",
985 format_unformat_error, line_input);
989 vnet_int_gtpu_bypass_mode (sw_if_index, is_ip6, is_enable);
992 unformat_free (line_input);
997 static clib_error_t *
998 set_ip4_gtpu_bypass (vlib_main_t * vm,
999 unformat_input_t * input, vlib_cli_command_t * cmd)
1001 return set_ip_gtpu_bypass (0, input, cmd);
1005 * This command adds the 'ip4-gtpu-bypass' graph node for a given interface.
1006 * By adding the IPv4 gtpu-bypass graph node to an interface, the node checks
1007 * for and validate input gtpu packet and bypass ip4-lookup, ip4-local,
1008 * ip4-udp-lookup nodes to speedup gtpu packet forwarding. This node will
1009 * cause extra overhead to for non-gtpu packets which is kept at a minimum.
1013 * Example of graph node before ip4-gtpu-bypass is enabled:
1014 * @cliexstart{show vlib graph ip4-gtpu-bypass}
1015 * Name Next Previous
1016 * ip4-gtpu-bypass error-drop [0]
1021 * Example of how to enable ip4-gtpu-bypass on an interface:
1022 * @cliexcmd{set interface ip gtpu-bypass GigabitEthernet2/0/0}
1024 * Example of graph node after ip4-gtpu-bypass is enabled:
1025 * @cliexstart{show vlib graph ip4-gtpu-bypass}
1026 * Name Next Previous
1027 * ip4-gtpu-bypass error-drop [0] ip4-input
1028 * gtpu4-input [1] ip4-input-no-checksum
1032 * Example of how to display the feature enabled on an interface:
1033 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1034 * IP feature paths configured on GigabitEthernet2/0/0...
1042 * Example of how to disable ip4-gtpu-bypass on an interface:
1043 * @cliexcmd{set interface ip gtpu-bypass GigabitEthernet2/0/0 del}
1047 VLIB_CLI_COMMAND (set_interface_ip_gtpu_bypass_command, static) = {
1048 .path = "set interface ip gtpu-bypass",
1049 .function = set_ip4_gtpu_bypass,
1050 .short_help = "set interface ip gtpu-bypass <interface> [del]",
1054 static clib_error_t *
1055 set_ip6_gtpu_bypass (vlib_main_t * vm,
1056 unformat_input_t * input, vlib_cli_command_t * cmd)
1058 return set_ip_gtpu_bypass (1, input, cmd);
1062 * This command adds the 'ip6-gtpu-bypass' graph node for a given interface.
1063 * By adding the IPv6 gtpu-bypass graph node to an interface, the node checks
1064 * for and validate input gtpu packet and bypass ip6-lookup, ip6-local,
1065 * ip6-udp-lookup nodes to speedup gtpu packet forwarding. This node will
1066 * cause extra overhead to for non-gtpu packets which is kept at a minimum.
1070 * Example of graph node before ip6-gtpu-bypass is enabled:
1071 * @cliexstart{show vlib graph ip6-gtpu-bypass}
1072 * Name Next Previous
1073 * ip6-gtpu-bypass error-drop [0]
1078 * Example of how to enable ip6-gtpu-bypass on an interface:
1079 * @cliexcmd{set interface ip6 gtpu-bypass GigabitEthernet2/0/0}
1081 * Example of graph node after ip6-gtpu-bypass is enabled:
1082 * @cliexstart{show vlib graph ip6-gtpu-bypass}
1083 * Name Next Previous
1084 * ip6-gtpu-bypass error-drop [0] ip6-input
1085 * gtpu6-input [1] ip4-input-no-checksum
1089 * Example of how to display the feature enabled on an interface:
1090 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1091 * IP feature paths configured on GigabitEthernet2/0/0...
1099 * Example of how to disable ip6-gtpu-bypass on an interface:
1100 * @cliexcmd{set interface ip6 gtpu-bypass GigabitEthernet2/0/0 del}
1104 VLIB_CLI_COMMAND (set_interface_ip6_gtpu_bypass_command, static) = {
1105 .path = "set interface ip6 gtpu-bypass",
1106 .function = set_ip6_gtpu_bypass,
1107 .short_help = "set interface ip6 gtpu-bypass <interface> [del]",
1112 vnet_gtpu_add_del_rx_flow (u32 hw_if_index, u32 t_index, int is_add)
1114 gtpu_main_t *gtm = >pu_main;
1115 gtpu_tunnel_t *t = pool_elt_at_index (gtm->tunnels, t_index);
1116 vnet_main_t *vnm = vnet_get_main ();
1119 if (t->flow_index == ~0)
1121 vnet_flow_t flow = {
1123 VNET_FLOW_ACTION_REDIRECT_TO_NODE | VNET_FLOW_ACTION_MARK |
1124 VNET_FLOW_ACTION_BUFFER_ADVANCE,
1125 .mark_flow_id = t_index + gtm->flow_id_start,
1126 .redirect_node_index = gtpu4_flow_input_node.index,
1127 .buffer_advance = sizeof (ethernet_header_t)
1128 + sizeof (ip4_header_t) + sizeof (udp_header_t),
1129 .type = VNET_FLOW_TYPE_IP4_GTPU,
1131 .protocol.prot = IP_PROTOCOL_UDP,
1132 .src_addr.addr = t->dst.ip4,
1133 .src_addr.mask.as_u32 = ~0,
1134 .dst_addr.addr = t->src.ip4,
1135 .dst_addr.mask.as_u32 = ~0,
1140 vnet_flow_add (vnm, &flow, &t->flow_index);
1143 return vnet_flow_enable (vnm, t->flow_index, hw_if_index);
1146 /* flow index is removed when the tunnel is deleted */
1147 return vnet_flow_disable (vnm, t->flow_index, hw_if_index);
1151 vnet_gtpu_get_tunnel_index (u32 sw_if_index)
1153 gtpu_main_t *gtm = >pu_main;
1155 if (sw_if_index >= vec_len (gtm->tunnel_index_by_sw_if_index))
1157 return gtm->tunnel_index_by_sw_if_index[sw_if_index];
1160 static clib_error_t *
1161 gtpu_offload_command_fn (vlib_main_t * vm,
1162 unformat_input_t * input, vlib_cli_command_t * cmd)
1164 unformat_input_t _line_input, *line_input = &_line_input;
1166 /* Get a line of input. */
1167 if (!unformat_user (input, unformat_line_input, line_input))
1170 vnet_main_t *vnm = vnet_get_main ();
1171 u32 rx_sw_if_index = ~0;
1172 u32 hw_if_index = ~0;
1175 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1177 if (unformat (line_input, "hw %U", unformat_vnet_hw_interface, vnm,
1180 if (unformat (line_input, "rx %U", unformat_vnet_sw_interface, vnm,
1183 if (unformat (line_input, "del"))
1188 return clib_error_return (0, "unknown input `%U'",
1189 format_unformat_error, line_input);
1192 if (rx_sw_if_index == ~0)
1193 return clib_error_return (0, "missing rx interface");
1194 if (hw_if_index == ~0)
1195 return clib_error_return (0, "missing hw interface");
1197 u32 t_index = vnet_gtpu_get_tunnel_index (rx_sw_if_index);;
1199 return clib_error_return (0, "%U is not a gtpu tunnel",
1200 format_vnet_sw_if_index_name, vnm,
1203 gtpu_main_t *gtm = >pu_main;
1204 gtpu_tunnel_t *t = pool_elt_at_index (gtm->tunnels, t_index);
1206 /* first support ipv4 hw offload */
1207 if (!ip46_address_is_ip4 (&t->dst))
1208 return clib_error_return (0, "currently only IPV4 tunnels are supported");
1210 /* inner protocol should be IPv4/IPv6 */
1211 if ((t->decap_next_index != GTPU_INPUT_NEXT_IP4_INPUT) &&
1212 (t->decap_next_index != GTPU_INPUT_NEXT_IP6_INPUT))
1213 return clib_error_return (0,
1214 "currently only inner IPv4/IPv6 protocol is supported");
1216 vnet_hw_interface_t *hw_if = vnet_get_hw_interface (vnm, hw_if_index);
1217 ip4_main_t *im = &ip4_main;
1219 vec_elt (im->fib_index_by_sw_if_index, hw_if->sw_if_index);
1221 if (t->encap_fib_index != rx_fib_index)
1222 return clib_error_return (0, "interface/tunnel fib mismatch");
1224 if (vnet_gtpu_add_del_rx_flow (hw_if_index, t_index, is_add))
1225 return clib_error_return (0, "error %s flow",
1226 is_add ? "enabling" : "disabling");
1233 VLIB_CLI_COMMAND (gtpu_offload_command, static) = {
1234 .path = "set flow-offload gtpu",
1236 "set flow-offload gtpu hw <inerface-name> rx <tunnel-name> [del]",
1237 .function = gtpu_offload_command_fn,
1242 gtpu_init (vlib_main_t * vm)
1244 gtpu_main_t *gtm = >pu_main;
1246 gtm->vnet_main = vnet_get_main ();
1247 gtm->vlib_main = vm;
1249 vnet_flow_get_range (gtm->vnet_main, "gtpu", 1024 * 1024,
1250 >m->flow_id_start);
1252 /* initialize the ip6 hash */
1253 gtm->gtpu6_tunnel_by_key = hash_create_mem (0,
1254 sizeof (gtpu6_tunnel_key_t),
1256 gtm->vtep_table = vtep_table_create ();
1257 gtm->mcast_shared = hash_create_mem (0,
1258 sizeof (ip46_address_t),
1259 sizeof (mcast_shared_t));
1261 gtm->fib_node_type = fib_node_register_new_type (>pu_vft);
1266 VLIB_INIT_FUNCTION (gtpu_init);
1269 VLIB_PLUGIN_REGISTER () = {
1270 .version = VPP_BUILD_VER,
1271 .description = "GPRS Tunnelling Protocol, User Data (GTPv1-U)",
1276 * fd.io coding-style-patch-verification: ON
1279 * eval: (c-set-style "gnu")