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 teid %d",
60 t->tunnel_index, t->teid);
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;
91 s = format (s, "[%d] src %U dst %U teid %d fib-idx %d sw-if-idx %d ",
93 format_ip46_address, &t->src, IP46_TYPE_ANY,
94 format_ip46_address, &t->dst, IP46_TYPE_ANY,
95 t->teid, t->encap_fib_index, t->sw_if_index);
97 s = format (s, "encap-dpo-idx %d ", t->next_dpo.dpoi_index);
98 s = format (s, "decap-next-%U ", format_decap_next, t->decap_next_index);
100 if (PREDICT_FALSE (ip46_address_is_multicast (&t->dst)))
101 s = format (s, "mcast-sw-if-idx %d ", t->mcast_sw_if_index);
107 format_gtpu_name (u8 * s, va_list * args)
109 u32 dev_instance = va_arg (*args, u32);
110 return format (s, "gtpu_tunnel%d", dev_instance);
113 static clib_error_t *
114 gtpu_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
116 u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
117 VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
118 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
120 return /* no error */ 0;
124 VNET_DEVICE_CLASS (gtpu_device_class,static) = {
126 .format_device_name = format_gtpu_name,
127 .format_tx_trace = format_gtpu_encap_trace,
128 .admin_up_down_function = gtpu_interface_admin_up_down,
133 format_gtpu_header_with_length (u8 * s, va_list * args)
135 u32 dev_instance = va_arg (*args, u32);
136 s = format (s, "unimplemented dev %u", dev_instance);
141 VNET_HW_INTERFACE_CLASS (gtpu_hw_class) =
144 .format_header = format_gtpu_header_with_length,
145 .build_rewrite = default_build_rewrite,
146 .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
151 gtpu_tunnel_restack_dpo (gtpu_tunnel_t * t)
153 dpo_id_t dpo = DPO_INVALID;
154 u32 encap_index = ip46_address_is_ip4 (&t->dst) ?
155 gtpu4_encap_node.index : gtpu6_encap_node.index;
156 fib_forward_chain_type_t forw_type = ip46_address_is_ip4 (&t->dst) ?
157 FIB_FORW_CHAIN_TYPE_UNICAST_IP4 : FIB_FORW_CHAIN_TYPE_UNICAST_IP6;
159 fib_entry_contribute_forwarding (t->fib_entry_index, forw_type, &dpo);
160 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
164 static gtpu_tunnel_t *
165 gtpu_tunnel_from_fib_node (fib_node_t * node)
167 return ((gtpu_tunnel_t *) (((char *) node) -
168 STRUCT_OFFSET_OF (gtpu_tunnel_t, node)));
172 * Function definition to backwalk a FIB node -
173 * Here we will restack the new dpo of GTPU DIP to encap node.
175 static fib_node_back_walk_rc_t
176 gtpu_tunnel_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
178 gtpu_tunnel_restack_dpo (gtpu_tunnel_from_fib_node (node));
179 return (FIB_NODE_BACK_WALK_CONTINUE);
183 * Function definition to get a FIB node from its index
186 gtpu_tunnel_fib_node_get (fib_node_index_t index)
189 gtpu_main_t *gtm = >pu_main;
191 t = pool_elt_at_index (gtm->tunnels, index);
197 * Function definition to inform the FIB node that its last lock has gone.
200 gtpu_tunnel_last_lock_gone (fib_node_t * node)
203 * The GTPU tunnel is a root of the graph. As such
204 * it never has children and thus is never locked.
210 * Virtual function table registered by GTPU tunnels
211 * for participation in the FIB object graph.
213 const static fib_node_vft_t gtpu_vft = {
214 .fnv_get = gtpu_tunnel_fib_node_get,
215 .fnv_last_lock = gtpu_tunnel_last_lock_gone,
216 .fnv_back_walk = gtpu_tunnel_back_walk,
220 #define foreach_copy_field \
222 _(mcast_sw_if_index) \
224 _(decap_next_index) \
229 ip_udp_gtpu_rewrite (gtpu_tunnel_t * t, bool is_ip6)
233 ip4_gtpu_header_t *h4;
234 ip6_gtpu_header_t *h6;
239 int len = is_ip6 ? sizeof *r.h6 : sizeof *r.h4;
241 vec_validate_aligned (r.rw, len - 1, CLIB_CACHE_LINE_BYTES);
245 /* Fixed portion of the (outer) ip header */
248 ip4_header_t *ip = &r.h4->ip4;
251 ip->ip_version_and_header_length = 0x45;
253 ip->protocol = IP_PROTOCOL_UDP;
255 ip->src_address = t->src.ip4;
256 ip->dst_address = t->dst.ip4;
258 /* we fix up the ip4 header length and checksum after-the-fact */
259 ip->checksum = ip4_header_checksum (ip);
263 ip6_header_t *ip = &r.h6->ip6;
266 ip->ip_version_traffic_class_and_flow_label =
267 clib_host_to_net_u32 (6 << 28);
269 ip->protocol = IP_PROTOCOL_UDP;
271 ip->src_address = t->src.ip6;
272 ip->dst_address = t->dst.ip6;
275 /* UDP header, randomize src port on something, maybe? */
276 udp->src_port = clib_host_to_net_u16 (2152);
277 udp->dst_port = clib_host_to_net_u16 (UDP_DST_PORT_GTPU);
280 gtpu->ver_flags = GTPU_V1_VER | GTPU_PT_GTP;
281 gtpu->type = GTPU_TYPE_GTPU;
282 gtpu->teid = clib_host_to_net_u32 (t->teid);
285 /* Now only support 8-byte gtpu header. TBD */
286 _vec_len (t->rewrite) = sizeof (ip4_gtpu_header_t) - 4;
292 gtpu_decap_next_is_valid (gtpu_main_t * gtm, u32 is_ip6, u32 decap_next_index)
294 vlib_main_t *vm = gtm->vlib_main;
295 u32 input_idx = (!is_ip6) ? gtpu4_input_node.index : gtpu6_input_node.index;
296 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, input_idx);
298 return decap_next_index < r->n_next_nodes;
302 vtep_addr_ref (ip46_address_t * ip)
304 uword *vtep = ip46_address_is_ip4 (ip) ?
305 hash_get (gtpu_main.vtep4, ip->ip4.as_u32) :
306 hash_get_mem (gtpu_main.vtep6, &ip->ip6);
309 ip46_address_is_ip4 (ip) ?
310 hash_set (gtpu_main.vtep4, ip->ip4.as_u32, 1) :
311 hash_set_mem_alloc (>pu_main.vtep6, &ip->ip6, 1);
316 vtep_addr_unref (ip46_address_t * ip)
318 uword *vtep = ip46_address_is_ip4 (ip) ?
319 hash_get (gtpu_main.vtep4, ip->ip4.as_u32) :
320 hash_get_mem (gtpu_main.vtep6, &ip->ip6);
321 ALWAYS_ASSERT (vtep);
324 ip46_address_is_ip4 (ip) ?
325 hash_unset (gtpu_main.vtep4, ip->ip4.as_u32) :
326 hash_unset_mem_free (>pu_main.vtep6, &ip->ip6);
330 typedef CLIB_PACKED (union
334 fib_node_index_t mfib_entry_index;
335 adj_index_t mcast_adj_index;
339 static inline mcast_shared_t
340 mcast_shared_get (ip46_address_t * ip)
342 ASSERT (ip46_address_is_multicast (ip));
343 uword *p = hash_get_mem (gtpu_main.mcast_shared, ip);
345 return (mcast_shared_t)
351 mcast_shared_add (ip46_address_t * dst, fib_node_index_t mfei, adj_index_t ai)
353 mcast_shared_t new_ep = {
354 .mcast_adj_index = ai,
355 .mfib_entry_index = mfei,
358 hash_set_mem_alloc (>pu_main.mcast_shared, dst, new_ep.as_u64);
362 mcast_shared_remove (ip46_address_t * dst)
364 mcast_shared_t ep = mcast_shared_get (dst);
366 adj_unlock (ep.mcast_adj_index);
367 mfib_table_entry_delete_index (ep.mfib_entry_index, MFIB_SOURCE_GTPU);
369 hash_unset_mem_free (>pu_main.mcast_shared, dst);
372 int vnet_gtpu_add_del_tunnel
373 (vnet_gtpu_add_del_tunnel_args_t * a, u32 * sw_if_indexp)
375 gtpu_main_t *gtm = >pu_main;
376 gtpu_tunnel_t *t = 0;
377 vnet_main_t *vnm = gtm->vnet_main;
379 u32 hw_if_index = ~0;
380 u32 sw_if_index = ~0;
381 gtpu4_tunnel_key_t key4;
382 gtpu6_tunnel_key_t key6;
383 bool is_ip6 = !ip46_address_is_ip4 (&a->dst);
387 key4.src = a->dst.ip4.as_u32; /* decap src in key is encap dst in config */
388 key4.teid = clib_host_to_net_u32 (a->teid);
389 p = hash_get (gtm->gtpu4_tunnel_by_key, key4.as_u64);
393 key6.src = a->dst.ip6;
394 key6.teid = clib_host_to_net_u32 (a->teid);
395 p = hash_get_mem (gtm->gtpu6_tunnel_by_key, &key6);
400 l2input_main_t *l2im = &l2input_main;
402 /* adding a tunnel: tunnel must not already exist */
404 return VNET_API_ERROR_TUNNEL_EXIST;
406 /*if not set explicitly, default to l2 */
407 if (a->decap_next_index == ~0)
408 a->decap_next_index = GTPU_INPUT_NEXT_L2_INPUT;
409 if (!gtpu_decap_next_is_valid (gtm, is_ip6, a->decap_next_index))
410 return VNET_API_ERROR_INVALID_DECAP_NEXT;
412 pool_get_aligned (gtm->tunnels, t, CLIB_CACHE_LINE_BYTES);
413 clib_memset (t, 0, sizeof (*t));
415 /* copy from arg structure */
416 #define _(x) t->x = a->x;
420 ip_udp_gtpu_rewrite (t, is_ip6);
422 /* clear the flow index */
427 hash_set_mem_alloc (>m->gtpu6_tunnel_by_key, &key6,
430 hash_set (gtm->gtpu4_tunnel_by_key, key4.as_u64, t - gtm->tunnels);
432 vnet_hw_interface_t *hi;
433 if (vec_len (gtm->free_gtpu_tunnel_hw_if_indices) > 0)
435 vnet_interface_main_t *im = &vnm->interface_main;
436 hw_if_index = gtm->free_gtpu_tunnel_hw_if_indices
437 [vec_len (gtm->free_gtpu_tunnel_hw_if_indices) - 1];
438 _vec_len (gtm->free_gtpu_tunnel_hw_if_indices) -= 1;
440 hi = vnet_get_hw_interface (vnm, hw_if_index);
441 hi->dev_instance = t - gtm->tunnels;
442 hi->hw_instance = hi->dev_instance;
444 /* clear old stats of freed tunnel before reuse */
445 sw_if_index = hi->sw_if_index;
446 vnet_interface_counter_lock (im);
447 vlib_zero_combined_counter
448 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX],
450 vlib_zero_combined_counter (&im->combined_sw_if_counters
451 [VNET_INTERFACE_COUNTER_RX],
453 vlib_zero_simple_counter (&im->sw_if_counters
454 [VNET_INTERFACE_COUNTER_DROP],
456 vnet_interface_counter_unlock (im);
460 hw_if_index = vnet_register_interface
461 (vnm, gtpu_device_class.index, t - gtm->tunnels,
462 gtpu_hw_class.index, t - gtm->tunnels);
463 hi = vnet_get_hw_interface (vnm, hw_if_index);
466 /* Set gtpu tunnel output node */
467 u32 encap_index = !is_ip6 ?
468 gtpu4_encap_node.index : gtpu6_encap_node.index;
469 vnet_set_interface_output_node (vnm, hw_if_index, encap_index);
471 t->hw_if_index = hw_if_index;
472 t->sw_if_index = sw_if_index = hi->sw_if_index;
474 vec_validate_init_empty (gtm->tunnel_index_by_sw_if_index, sw_if_index,
476 gtm->tunnel_index_by_sw_if_index[sw_if_index] = t - gtm->tunnels;
478 /* setup l2 input config with l2 feature and bd 0 to drop packet */
479 vec_validate (l2im->configs, sw_if_index);
480 l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
481 l2im->configs[sw_if_index].bd_index = 0;
483 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
484 si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
485 vnet_sw_interface_set_flags (vnm, sw_if_index,
486 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
488 fib_node_init (&t->node, gtm->fib_node_type);
489 fib_prefix_t tun_dst_pfx;
490 vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
492 fib_prefix_from_ip46_addr (&t->dst, &tun_dst_pfx);
493 if (!ip46_address_is_multicast (&t->dst))
496 * Track the FIB entry for the tunnel's destination.
497 * The tunnel will then get poked
498 * when the forwarding for the entry updates, and the tunnel can
499 * re-stack accordingly
501 vtep_addr_ref (&t->src);
502 t->fib_entry_index = fib_entry_track (t->encap_fib_index,
507 gtpu_tunnel_restack_dpo (t);
511 /* Multicast tunnel -
512 * as the same mcast group can be used for multiple mcast tunnels
513 * with different VNIs, create the output adjacency only if
514 * it does not already exist
516 fib_protocol_t fp = fib_ip_proto (is_ip6);
518 if (vtep_addr_ref (&t->dst) == 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_dst_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_GTPU, &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_GTPU, &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->dst, mfei, ai);
565 dpo_id_t dpo = DPO_INVALID;
566 mcast_shared_t ep = mcast_shared_get (&t->dst);
568 /* Stack shared mcast dst 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);
575 flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
578 vnet_get_sw_interface (vnet_get_main (), sw_if_index)->flood_class =
583 /* deleting a tunnel: tunnel must exist */
585 return VNET_API_ERROR_NO_SUCH_ENTRY;
587 t = pool_elt_at_index (gtm->tunnels, p[0]);
588 sw_if_index = t->sw_if_index;
590 vnet_sw_interface_set_flags (vnm, t->sw_if_index, 0 /* down */ );
591 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, t->sw_if_index);
592 si->flags |= VNET_SW_INTERFACE_FLAG_HIDDEN;
594 /* make sure tunnel is removed from l2 bd or xconnect */
595 set_int_l2_mode (gtm->vlib_main, vnm, MODE_L3, t->sw_if_index, 0,
596 L2_BD_PORT_TYPE_NORMAL, 0, 0);
597 vec_add1 (gtm->free_gtpu_tunnel_hw_if_indices, t->hw_if_index);
599 gtm->tunnel_index_by_sw_if_index[t->sw_if_index] = ~0;
602 hash_unset (gtm->gtpu4_tunnel_by_key, key4.as_u64);
604 hash_unset_mem_free (>m->gtpu6_tunnel_by_key, &key6);
606 if (!ip46_address_is_multicast (&t->dst))
608 if (t->flow_index != ~0)
609 vnet_flow_del (vnm, t->flow_index);
611 vtep_addr_unref (&t->src);
612 fib_entry_untrack (t->fib_entry_index, t->sibling_index);
614 else if (vtep_addr_unref (&t->dst) == 0)
616 mcast_shared_remove (&t->dst);
619 fib_node_deinit (&t->node);
620 vec_free (t->rewrite);
621 pool_put (gtm->tunnels, t);
625 *sw_if_indexp = sw_if_index;
629 /* register udp ports */
630 if (!is_ip6 && !udp_is_valid_dst_port (UDP_DST_PORT_GTPU, 1))
631 udp_register_dst_port (gtm->vlib_main, UDP_DST_PORT_GTPU,
632 gtpu4_input_node.index, /* is_ip4 */ 1);
633 if (is_ip6 && !udp_is_valid_dst_port (UDP_DST_PORT_GTPU6, 0))
634 udp_register_dst_port (gtm->vlib_main, UDP_DST_PORT_GTPU6,
635 gtpu6_input_node.index, /* is_ip4 */ 0);
642 get_decap_next_for_node (u32 node_index, u32 ipv4_set)
644 gtpu_main_t *gtm = >pu_main;
645 vlib_main_t *vm = gtm->vlib_main;
646 uword input_node = (ipv4_set) ? gtpu4_input_node.index :
647 gtpu6_input_node.index;
649 return vlib_node_add_next (vm, input_node, node_index);
653 unformat_decap_next (unformat_input_t * input, va_list * args)
655 u32 *result = va_arg (*args, u32 *);
656 u32 ipv4_set = va_arg (*args, int);
657 gtpu_main_t *gtm = >pu_main;
658 vlib_main_t *vm = gtm->vlib_main;
662 if (unformat (input, "l2"))
663 *result = GTPU_INPUT_NEXT_L2_INPUT;
664 else if (unformat (input, "ip4"))
665 *result = GTPU_INPUT_NEXT_IP4_INPUT;
666 else if (unformat (input, "ip6"))
667 *result = GTPU_INPUT_NEXT_IP6_INPUT;
668 else if (unformat (input, "node %U", unformat_vlib_node, vm, &node_index))
669 *result = get_decap_next_for_node (node_index, ipv4_set);
670 else if (unformat (input, "%d", &tmp))
678 static clib_error_t *
679 gtpu_add_del_tunnel_command_fn (vlib_main_t * vm,
680 unformat_input_t * input,
681 vlib_cli_command_t * cmd)
683 unformat_input_t _line_input, *line_input = &_line_input;
684 ip46_address_t src, dst;
691 u32 encap_fib_index = 0;
692 u32 mcast_sw_if_index = ~0;
693 u32 decap_next_index = GTPU_INPUT_NEXT_L2_INPUT;
697 vnet_gtpu_add_del_tunnel_args_t _a, *a = &_a;
698 u32 tunnel_sw_if_index;
699 clib_error_t *error = NULL;
701 /* Cant "universally zero init" (={0}) due to GCC bug 53119 */
702 clib_memset (&src, 0, sizeof src);
703 clib_memset (&dst, 0, sizeof dst);
705 /* Get a line of input. */
706 if (!unformat_user (input, unformat_line_input, line_input))
709 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
711 if (unformat (line_input, "del"))
715 else if (unformat (line_input, "src %U",
716 unformat_ip4_address, &src.ip4))
721 else if (unformat (line_input, "dst %U",
722 unformat_ip4_address, &dst.ip4))
727 else if (unformat (line_input, "src %U",
728 unformat_ip6_address, &src.ip6))
733 else if (unformat (line_input, "dst %U",
734 unformat_ip6_address, &dst.ip6))
739 else if (unformat (line_input, "group %U %U",
740 unformat_ip4_address, &dst.ip4,
741 unformat_vnet_sw_interface,
742 vnet_get_main (), &mcast_sw_if_index))
744 grp_set = dst_set = 1;
747 else if (unformat (line_input, "group %U %U",
748 unformat_ip6_address, &dst.ip6,
749 unformat_vnet_sw_interface,
750 vnet_get_main (), &mcast_sw_if_index))
752 grp_set = dst_set = 1;
755 else if (unformat (line_input, "encap-vrf-id %d", &tmp))
757 encap_fib_index = fib_table_find (fib_ip_proto (ipv6_set), tmp);
758 if (encap_fib_index == ~0)
761 clib_error_return (0, "nonexistent encap-vrf-id %d", tmp);
765 else if (unformat (line_input, "decap-next %U", unformat_decap_next,
766 &decap_next_index, ipv4_set))
768 else if (unformat (line_input, "teid %d", &teid))
772 error = clib_error_return (0, "parse error: '%U'",
773 format_unformat_error, line_input);
780 error = clib_error_return (0, "tunnel src address not specified");
786 error = clib_error_return (0, "tunnel dst address not specified");
790 if (grp_set && !ip46_address_is_multicast (&dst))
792 error = clib_error_return (0, "tunnel group address not multicast");
796 if (grp_set == 0 && ip46_address_is_multicast (&dst))
798 error = clib_error_return (0, "dst address must be unicast");
802 if (grp_set && mcast_sw_if_index == ~0)
804 error = clib_error_return (0, "tunnel nonexistent multicast device");
808 if (ipv4_set && ipv6_set)
810 error = clib_error_return (0, "both IPv4 and IPv6 addresses specified");
814 if (ip46_address_cmp (&src, &dst) == 0)
816 error = clib_error_return (0, "src and dst addresses are identical");
820 if (decap_next_index == ~0)
822 error = clib_error_return (0, "next node not found");
826 clib_memset (a, 0, sizeof (*a));
830 #define _(x) a->x = x;
834 rv = vnet_gtpu_add_del_tunnel (a, &tunnel_sw_if_index);
840 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
841 vnet_get_main (), tunnel_sw_if_index);
844 case VNET_API_ERROR_TUNNEL_EXIST:
845 error = clib_error_return (0, "tunnel already exists...");
848 case VNET_API_ERROR_NO_SUCH_ENTRY:
849 error = clib_error_return (0, "tunnel does not exist...");
853 error = clib_error_return
854 (0, "vnet_gtpu_add_del_tunnel returned %d", rv);
859 unformat_free (line_input);
865 * Add or delete a GTPU Tunnel.
867 * GTPU provides the features needed to allow L2 bridge domains (BDs)
868 * to span multiple servers. This is done by building an L2 overlay on
869 * top of an L3 network underlay using GTPU tunnels.
871 * This makes it possible for servers to be co-located in the same data
872 * center or be separated geographically as long as they are reachable
873 * through the underlay L3 network.
875 * You can refer to this kind of L2 overlay bridge domain as a GTPU
876 * (Virtual eXtensible VLAN) segment.
879 * Example of how to create a GTPU Tunnel:
880 * @cliexcmd{create gtpu tunnel src 10.0.3.1 dst 10.0.3.3 teid 13 encap-vrf-id 7}
881 * Example of how to delete a GTPU Tunnel:
882 * @cliexcmd{create gtpu tunnel src 10.0.3.1 dst 10.0.3.3 teid 13 del}
885 VLIB_CLI_COMMAND (create_gtpu_tunnel_command, static) = {
886 .path = "create gtpu tunnel",
888 "create gtpu tunnel src <local-vtep-addr>"
889 " {dst <remote-vtep-addr>|group <mcast-vtep-addr> <intf-name>} teid <nn>"
890 " [encap-vrf-id <nn>] [decap-next [l2|ip4|ip6|node <name>]] [del]",
891 .function = gtpu_add_del_tunnel_command_fn,
895 static clib_error_t *
896 show_gtpu_tunnel_command_fn (vlib_main_t * vm,
897 unformat_input_t * input,
898 vlib_cli_command_t * cmd)
900 gtpu_main_t *gtm = >pu_main;
903 if (pool_elts (gtm->tunnels) == 0)
904 vlib_cli_output (vm, "No gtpu tunnels configured...");
906 pool_foreach (t, gtm->tunnels, (
908 vlib_cli_output (vm, "%U",
909 format_gtpu_tunnel, t);
917 * Display all the GTPU Tunnel entries.
920 * Example of how to display the GTPU Tunnel entries:
921 * @cliexstart{show gtpu tunnel}
922 * [0] src 10.0.3.1 dst 10.0.3.3 teid 13 encap_fib_index 0 sw_if_index 5 decap_next l2
926 VLIB_CLI_COMMAND (show_gtpu_tunnel_command, static) = {
927 .path = "show gtpu tunnel",
928 .short_help = "show gtpu tunnel",
929 .function = show_gtpu_tunnel_command_fn,
934 vnet_int_gtpu_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable)
937 vnet_feature_enable_disable ("ip6-unicast", "ip6-gtpu-bypass",
938 sw_if_index, is_enable, 0, 0);
940 vnet_feature_enable_disable ("ip4-unicast", "ip4-gtpu-bypass",
941 sw_if_index, is_enable, 0, 0);
944 static clib_error_t *
945 set_ip_gtpu_bypass (u32 is_ip6,
946 unformat_input_t * input, vlib_cli_command_t * cmd)
948 unformat_input_t _line_input, *line_input = &_line_input;
949 vnet_main_t *vnm = vnet_get_main ();
950 clib_error_t *error = 0;
951 u32 sw_if_index, is_enable;
956 if (!unformat_user (input, unformat_line_input, line_input))
959 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
962 (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
964 else if (unformat (line_input, "del"))
968 error = unformat_parse_error (line_input);
973 if (~0 == sw_if_index)
975 error = clib_error_return (0, "unknown interface `%U'",
976 format_unformat_error, line_input);
980 vnet_int_gtpu_bypass_mode (sw_if_index, is_ip6, is_enable);
983 unformat_free (line_input);
988 static clib_error_t *
989 set_ip4_gtpu_bypass (vlib_main_t * vm,
990 unformat_input_t * input, vlib_cli_command_t * cmd)
992 return set_ip_gtpu_bypass (0, input, cmd);
996 * This command adds the 'ip4-gtpu-bypass' graph node for a given interface.
997 * By adding the IPv4 gtpu-bypass graph node to an interface, the node checks
998 * for and validate input gtpu packet and bypass ip4-lookup, ip4-local,
999 * ip4-udp-lookup nodes to speedup gtpu packet forwarding. This node will
1000 * cause extra overhead to for non-gtpu packets which is kept at a minimum.
1004 * Example of graph node before ip4-gtpu-bypass is enabled:
1005 * @cliexstart{show vlib graph ip4-gtpu-bypass}
1006 * Name Next Previous
1007 * ip4-gtpu-bypass error-drop [0]
1012 * Example of how to enable ip4-gtpu-bypass on an interface:
1013 * @cliexcmd{set interface ip gtpu-bypass GigabitEthernet2/0/0}
1015 * Example of graph node after ip4-gtpu-bypass is enabled:
1016 * @cliexstart{show vlib graph ip4-gtpu-bypass}
1017 * Name Next Previous
1018 * ip4-gtpu-bypass error-drop [0] ip4-input
1019 * gtpu4-input [1] ip4-input-no-checksum
1023 * Example of how to display the feature enabled on an interface:
1024 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1025 * IP feature paths configured on GigabitEthernet2/0/0...
1033 * Example of how to disable ip4-gtpu-bypass on an interface:
1034 * @cliexcmd{set interface ip gtpu-bypass GigabitEthernet2/0/0 del}
1038 VLIB_CLI_COMMAND (set_interface_ip_gtpu_bypass_command, static) = {
1039 .path = "set interface ip gtpu-bypass",
1040 .function = set_ip4_gtpu_bypass,
1041 .short_help = "set interface ip gtpu-bypass <interface> [del]",
1045 static clib_error_t *
1046 set_ip6_gtpu_bypass (vlib_main_t * vm,
1047 unformat_input_t * input, vlib_cli_command_t * cmd)
1049 return set_ip_gtpu_bypass (1, input, cmd);
1053 * This command adds the 'ip6-gtpu-bypass' graph node for a given interface.
1054 * By adding the IPv6 gtpu-bypass graph node to an interface, the node checks
1055 * for and validate input gtpu packet and bypass ip6-lookup, ip6-local,
1056 * ip6-udp-lookup nodes to speedup gtpu packet forwarding. This node will
1057 * cause extra overhead to for non-gtpu packets which is kept at a minimum.
1061 * Example of graph node before ip6-gtpu-bypass is enabled:
1062 * @cliexstart{show vlib graph ip6-gtpu-bypass}
1063 * Name Next Previous
1064 * ip6-gtpu-bypass error-drop [0]
1069 * Example of how to enable ip6-gtpu-bypass on an interface:
1070 * @cliexcmd{set interface ip6 gtpu-bypass GigabitEthernet2/0/0}
1072 * Example of graph node after ip6-gtpu-bypass is enabled:
1073 * @cliexstart{show vlib graph ip6-gtpu-bypass}
1074 * Name Next Previous
1075 * ip6-gtpu-bypass error-drop [0] ip6-input
1076 * gtpu6-input [1] ip4-input-no-checksum
1080 * Example of how to display the feature enabled on an interface:
1081 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1082 * IP feature paths configured on GigabitEthernet2/0/0...
1090 * Example of how to disable ip6-gtpu-bypass on an interface:
1091 * @cliexcmd{set interface ip6 gtpu-bypass GigabitEthernet2/0/0 del}
1095 VLIB_CLI_COMMAND (set_interface_ip6_gtpu_bypass_command, static) = {
1096 .path = "set interface ip6 gtpu-bypass",
1097 .function = set_ip6_gtpu_bypass,
1098 .short_help = "set interface ip6 gtpu-bypass <interface> [del]",
1103 vnet_gtpu_add_del_rx_flow (u32 hw_if_index, u32 t_index, int is_add)
1105 gtpu_main_t *gtm = >pu_main;
1106 gtpu_tunnel_t *t = pool_elt_at_index (gtm->tunnels, t_index);
1107 vnet_main_t *vnm = vnet_get_main ();
1110 if (t->flow_index == ~0)
1112 vnet_flow_t flow = {
1114 VNET_FLOW_ACTION_REDIRECT_TO_NODE | VNET_FLOW_ACTION_MARK |
1115 VNET_FLOW_ACTION_BUFFER_ADVANCE,
1116 .mark_flow_id = t_index + gtm->flow_id_start,
1117 .redirect_node_index = gtpu4_flow_input_node.index,
1118 .buffer_advance = sizeof (ethernet_header_t)
1119 + sizeof (ip4_header_t) + sizeof (udp_header_t),
1120 .type = VNET_FLOW_TYPE_IP4_GTPU_IP4,
1122 .protocol = IP_PROTOCOL_UDP,
1123 .src_addr.addr = t->dst.ip4,
1124 .src_addr.mask.as_u32 = ~0,
1125 .dst_addr.addr = t->src.ip4,
1126 .dst_addr.mask.as_u32 = ~0,
1131 vnet_flow_add (vnm, &flow, &t->flow_index);
1134 return vnet_flow_enable (vnm, t->flow_index, hw_if_index);
1137 /* flow index is removed when the tunnel is deleted */
1138 return vnet_flow_disable (vnm, t->flow_index, hw_if_index);
1142 vnet_gtpu_get_tunnel_index (u32 sw_if_index)
1144 gtpu_main_t *gtm = >pu_main;
1146 if (sw_if_index >= vec_len (gtm->tunnel_index_by_sw_if_index))
1148 return gtm->tunnel_index_by_sw_if_index[sw_if_index];
1151 static clib_error_t *
1152 gtpu_offload_command_fn (vlib_main_t * vm,
1153 unformat_input_t * input, vlib_cli_command_t * cmd)
1155 unformat_input_t _line_input, *line_input = &_line_input;
1157 /* Get a line of input. */
1158 if (!unformat_user (input, unformat_line_input, line_input))
1161 vnet_main_t *vnm = vnet_get_main ();
1162 u32 rx_sw_if_index = ~0;
1163 u32 hw_if_index = ~0;
1166 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1168 if (unformat (line_input, "hw %U", unformat_vnet_hw_interface, vnm,
1171 if (unformat (line_input, "rx %U", unformat_vnet_sw_interface, vnm,
1174 if (unformat (line_input, "del"))
1179 return clib_error_return (0, "unknown input `%U'",
1180 format_unformat_error, line_input);
1183 if (rx_sw_if_index == ~0)
1184 return clib_error_return (0, "missing rx interface");
1185 if (hw_if_index == ~0)
1186 return clib_error_return (0, "missing hw interface");
1188 u32 t_index = vnet_gtpu_get_tunnel_index (rx_sw_if_index);;
1190 return clib_error_return (0, "%U is not a gtpu tunnel",
1191 format_vnet_sw_if_index_name, vnm,
1194 gtpu_main_t *gtm = >pu_main;
1195 gtpu_tunnel_t *t = pool_elt_at_index (gtm->tunnels, t_index);
1197 /* first support ipv4 hw offload */
1198 if (!ip46_address_is_ip4 (&t->dst))
1199 return clib_error_return (0, "currently only IPV4 tunnels are supported");
1201 /* inner protocol should be IPv4 */
1202 if (t->decap_next_index != GTPU_INPUT_NEXT_IP4_INPUT)
1203 return clib_error_return (0,
1204 "currently only inner IPV4 protocol is supported");
1206 vnet_hw_interface_t *hw_if = vnet_get_hw_interface (vnm, hw_if_index);
1207 ip4_main_t *im = &ip4_main;
1209 vec_elt (im->fib_index_by_sw_if_index, hw_if->sw_if_index);
1211 if (t->encap_fib_index != rx_fib_index)
1212 return clib_error_return (0, "interface/tunnel fib mismatch");
1214 if (vnet_gtpu_add_del_rx_flow (hw_if_index, t_index, is_add))
1215 return clib_error_return (0, "error %s flow",
1216 is_add ? "enabling" : "disabling");
1223 VLIB_CLI_COMMAND (gtpu_offload_command, static) = {
1224 .path = "set flow-offload gtpu",
1226 "set flow-offload gtpu hw <inerface-name> rx <tunnel-name> [del]",
1227 .function = gtpu_offload_command_fn,
1232 gtpu_init (vlib_main_t * vm)
1234 gtpu_main_t *gtm = >pu_main;
1236 gtm->vnet_main = vnet_get_main ();
1237 gtm->vlib_main = vm;
1239 vnet_flow_get_range (gtm->vnet_main, "gtpu", 1024 * 1024,
1240 >m->flow_id_start);
1242 /* initialize the ip6 hash */
1243 gtm->gtpu6_tunnel_by_key = hash_create_mem (0,
1244 sizeof (gtpu6_tunnel_key_t),
1246 gtm->vtep6 = hash_create_mem (0, sizeof (ip6_address_t), sizeof (uword));
1247 gtm->mcast_shared = hash_create_mem (0,
1248 sizeof (ip46_address_t),
1249 sizeof (mcast_shared_t));
1251 gtm->fib_node_type = fib_node_register_new_type (>pu_vft);
1256 VLIB_INIT_FUNCTION (gtpu_init);
1259 VLIB_PLUGIN_REGISTER () = {
1260 .version = VPP_BUILD_VER,
1261 .description = "GPRS Tunnelling Protocol, User Data (GTPv1-U)",
1266 * fd.io coding-style-patch-verification: ON
1269 * eval: (c-set-style "gnu")