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;
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 encap-vrf-id %d sw-if-idx %d ",
100 format_ip46_address, &t->src, IP46_TYPE_ANY,
101 format_ip46_address, &t->dst, IP46_TYPE_ANY,
102 t->teid, encap_vrf_id, t->sw_if_index);
104 s = format (s, "encap-dpo-idx %d ", t->next_dpo.dpoi_index);
105 s = format (s, "decap-next-%U ", format_decap_next, t->decap_next_index);
107 if (PREDICT_FALSE (ip46_address_is_multicast (&t->dst)))
108 s = format (s, "mcast-sw-if-idx %d ", t->mcast_sw_if_index);
114 format_gtpu_name (u8 * s, va_list * args)
116 u32 dev_instance = va_arg (*args, u32);
117 return format (s, "gtpu_tunnel%d", dev_instance);
120 static clib_error_t *
121 gtpu_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
123 u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
124 VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
125 vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
127 return /* no error */ 0;
131 VNET_DEVICE_CLASS (gtpu_device_class,static) = {
133 .format_device_name = format_gtpu_name,
134 .format_tx_trace = format_gtpu_encap_trace,
135 .admin_up_down_function = gtpu_interface_admin_up_down,
140 format_gtpu_header_with_length (u8 * s, va_list * args)
142 u32 dev_instance = va_arg (*args, u32);
143 s = format (s, "unimplemented dev %u", dev_instance);
148 VNET_HW_INTERFACE_CLASS (gtpu_hw_class) =
151 .format_header = format_gtpu_header_with_length,
152 .build_rewrite = default_build_rewrite,
153 .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
158 gtpu_tunnel_restack_dpo (gtpu_tunnel_t * t)
160 dpo_id_t dpo = DPO_INVALID;
161 u32 encap_index = ip46_address_is_ip4 (&t->dst) ?
162 gtpu4_encap_node.index : gtpu6_encap_node.index;
163 fib_forward_chain_type_t forw_type = ip46_address_is_ip4 (&t->dst) ?
164 FIB_FORW_CHAIN_TYPE_UNICAST_IP4 : FIB_FORW_CHAIN_TYPE_UNICAST_IP6;
166 fib_entry_contribute_forwarding (t->fib_entry_index, forw_type, &dpo);
167 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
171 static gtpu_tunnel_t *
172 gtpu_tunnel_from_fib_node (fib_node_t * node)
174 return ((gtpu_tunnel_t *) (((char *) node) -
175 STRUCT_OFFSET_OF (gtpu_tunnel_t, node)));
179 * Function definition to backwalk a FIB node -
180 * Here we will restack the new dpo of GTPU DIP to encap node.
182 static fib_node_back_walk_rc_t
183 gtpu_tunnel_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
185 gtpu_tunnel_restack_dpo (gtpu_tunnel_from_fib_node (node));
186 return (FIB_NODE_BACK_WALK_CONTINUE);
190 * Function definition to get a FIB node from its index
193 gtpu_tunnel_fib_node_get (fib_node_index_t index)
196 gtpu_main_t *gtm = >pu_main;
198 t = pool_elt_at_index (gtm->tunnels, index);
204 * Function definition to inform the FIB node that its last lock has gone.
207 gtpu_tunnel_last_lock_gone (fib_node_t * node)
210 * The GTPU tunnel is a root of the graph. As such
211 * it never has children and thus is never locked.
217 * Virtual function table registered by GTPU tunnels
218 * for participation in the FIB object graph.
220 const static fib_node_vft_t gtpu_vft = {
221 .fnv_get = gtpu_tunnel_fib_node_get,
222 .fnv_last_lock = gtpu_tunnel_last_lock_gone,
223 .fnv_back_walk = gtpu_tunnel_back_walk,
227 #define foreach_copy_field \
229 _(mcast_sw_if_index) \
231 _(decap_next_index) \
236 ip_udp_gtpu_rewrite (gtpu_tunnel_t * t, bool is_ip6)
240 ip4_gtpu_header_t *h4;
241 ip6_gtpu_header_t *h6;
246 int len = is_ip6 ? sizeof *r.h6 : sizeof *r.h4;
248 vec_validate_aligned (r.rw, len - 1, CLIB_CACHE_LINE_BYTES);
252 /* Fixed portion of the (outer) ip header */
255 ip4_header_t *ip = &r.h4->ip4;
258 ip->ip_version_and_header_length = 0x45;
260 ip->protocol = IP_PROTOCOL_UDP;
262 ip->src_address = t->src.ip4;
263 ip->dst_address = t->dst.ip4;
265 /* we fix up the ip4 header length and checksum after-the-fact */
266 ip->checksum = ip4_header_checksum (ip);
270 ip6_header_t *ip = &r.h6->ip6;
273 ip->ip_version_traffic_class_and_flow_label =
274 clib_host_to_net_u32 (6 << 28);
276 ip->protocol = IP_PROTOCOL_UDP;
278 ip->src_address = t->src.ip6;
279 ip->dst_address = t->dst.ip6;
282 /* UDP header, randomize src port on something, maybe? */
283 udp->src_port = clib_host_to_net_u16 (2152);
284 udp->dst_port = clib_host_to_net_u16 (UDP_DST_PORT_GTPU);
287 gtpu->ver_flags = GTPU_V1_VER | GTPU_PT_GTP;
288 gtpu->type = GTPU_TYPE_GTPU;
289 gtpu->teid = clib_host_to_net_u32 (t->teid);
292 /* Now only support 8-byte gtpu header. TBD */
293 _vec_len (t->rewrite) = sizeof (ip4_gtpu_header_t) - 4;
299 gtpu_decap_next_is_valid (gtpu_main_t * gtm, u32 is_ip6, u32 decap_next_index)
301 vlib_main_t *vm = gtm->vlib_main;
302 u32 input_idx = (!is_ip6) ? gtpu4_input_node.index : gtpu6_input_node.index;
303 vlib_node_runtime_t *r = vlib_node_get_runtime (vm, input_idx);
305 return decap_next_index < r->n_next_nodes;
308 typedef CLIB_PACKED (union
312 fib_node_index_t mfib_entry_index;
313 adj_index_t mcast_adj_index;
317 static inline mcast_shared_t
318 mcast_shared_get (ip46_address_t * ip)
320 ASSERT (ip46_address_is_multicast (ip));
321 uword *p = hash_get_mem (gtpu_main.mcast_shared, ip);
323 return (mcast_shared_t)
329 mcast_shared_add (ip46_address_t * dst, fib_node_index_t mfei, adj_index_t ai)
331 mcast_shared_t new_ep = {
332 .mcast_adj_index = ai,
333 .mfib_entry_index = mfei,
336 hash_set_mem_alloc (>pu_main.mcast_shared, dst, new_ep.as_u64);
340 mcast_shared_remove (ip46_address_t * dst)
342 mcast_shared_t ep = mcast_shared_get (dst);
344 adj_unlock (ep.mcast_adj_index);
345 mfib_table_entry_delete_index (ep.mfib_entry_index, MFIB_SOURCE_GTPU);
347 hash_unset_mem_free (>pu_main.mcast_shared, dst);
350 int vnet_gtpu_add_del_tunnel
351 (vnet_gtpu_add_del_tunnel_args_t * a, u32 * sw_if_indexp)
353 gtpu_main_t *gtm = >pu_main;
354 gtpu_tunnel_t *t = 0;
355 vnet_main_t *vnm = gtm->vnet_main;
357 u32 hw_if_index = ~0;
358 u32 sw_if_index = ~0;
359 gtpu4_tunnel_key_t key4;
360 gtpu6_tunnel_key_t key6;
361 bool is_ip6 = !ip46_address_is_ip4 (&a->dst);
365 key4.src = a->dst.ip4.as_u32; /* decap src in key is encap dst in config */
366 key4.teid = clib_host_to_net_u32 (a->teid);
367 p = hash_get (gtm->gtpu4_tunnel_by_key, key4.as_u64);
371 key6.src = a->dst.ip6;
372 key6.teid = clib_host_to_net_u32 (a->teid);
373 p = hash_get_mem (gtm->gtpu6_tunnel_by_key, &key6);
378 l2input_main_t *l2im = &l2input_main;
380 /* adding a tunnel: tunnel must not already exist */
382 return VNET_API_ERROR_TUNNEL_EXIST;
384 /*if not set explicitly, default to l2 */
385 if (a->decap_next_index == ~0)
386 a->decap_next_index = GTPU_INPUT_NEXT_L2_INPUT;
387 if (!gtpu_decap_next_is_valid (gtm, is_ip6, a->decap_next_index))
388 return VNET_API_ERROR_INVALID_DECAP_NEXT;
390 pool_get_aligned (gtm->tunnels, t, CLIB_CACHE_LINE_BYTES);
391 clib_memset (t, 0, sizeof (*t));
393 /* copy from arg structure */
394 #define _(x) t->x = a->x;
398 ip_udp_gtpu_rewrite (t, is_ip6);
400 /* clear the flow index */
405 hash_set_mem_alloc (>m->gtpu6_tunnel_by_key, &key6,
408 hash_set (gtm->gtpu4_tunnel_by_key, key4.as_u64, t - gtm->tunnels);
410 vnet_hw_interface_t *hi;
411 if (vec_len (gtm->free_gtpu_tunnel_hw_if_indices) > 0)
413 vnet_interface_main_t *im = &vnm->interface_main;
414 hw_if_index = gtm->free_gtpu_tunnel_hw_if_indices
415 [vec_len (gtm->free_gtpu_tunnel_hw_if_indices) - 1];
416 _vec_len (gtm->free_gtpu_tunnel_hw_if_indices) -= 1;
418 hi = vnet_get_hw_interface (vnm, hw_if_index);
419 hi->dev_instance = t - gtm->tunnels;
420 hi->hw_instance = hi->dev_instance;
422 /* clear old stats of freed tunnel before reuse */
423 sw_if_index = hi->sw_if_index;
424 vnet_interface_counter_lock (im);
425 vlib_zero_combined_counter
426 (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX],
428 vlib_zero_combined_counter (&im->combined_sw_if_counters
429 [VNET_INTERFACE_COUNTER_RX],
431 vlib_zero_simple_counter (&im->sw_if_counters
432 [VNET_INTERFACE_COUNTER_DROP],
434 vnet_interface_counter_unlock (im);
438 hw_if_index = vnet_register_interface
439 (vnm, gtpu_device_class.index, t - gtm->tunnels,
440 gtpu_hw_class.index, t - gtm->tunnels);
441 hi = vnet_get_hw_interface (vnm, hw_if_index);
444 /* Set gtpu tunnel output node */
445 u32 encap_index = !is_ip6 ?
446 gtpu4_encap_node.index : gtpu6_encap_node.index;
447 vnet_set_interface_output_node (vnm, hw_if_index, encap_index);
449 t->hw_if_index = hw_if_index;
450 t->sw_if_index = sw_if_index = hi->sw_if_index;
452 vec_validate_init_empty (gtm->tunnel_index_by_sw_if_index, sw_if_index,
454 gtm->tunnel_index_by_sw_if_index[sw_if_index] = t - gtm->tunnels;
456 /* setup l2 input config with l2 feature and bd 0 to drop packet */
457 vec_validate (l2im->configs, sw_if_index);
458 l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
459 l2im->configs[sw_if_index].bd_index = 0;
461 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
462 si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
463 vnet_sw_interface_set_flags (vnm, sw_if_index,
464 VNET_SW_INTERFACE_FLAG_ADMIN_UP);
466 fib_node_init (&t->node, gtm->fib_node_type);
467 fib_prefix_t tun_dst_pfx;
468 vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
470 fib_prefix_from_ip46_addr (&t->dst, &tun_dst_pfx);
471 if (!ip46_address_is_multicast (&t->dst))
474 * Track the FIB entry for the tunnel's destination.
475 * The tunnel will then get poked
476 * when the forwarding for the entry updates, and the tunnel can
477 * re-stack accordingly
479 vtep_addr_ref (>m->vtep_table, t->encap_fib_index, &t->src);
480 t->fib_entry_index = fib_entry_track (t->encap_fib_index,
485 gtpu_tunnel_restack_dpo (t);
489 /* Multicast tunnel -
490 * as the same mcast group can be used for multiple mcast tunnels
491 * with different VNIs, create the output adjacency only if
492 * it does not already exist
494 fib_protocol_t fp = fib_ip_proto (is_ip6);
496 if (vtep_addr_ref (>m->vtep_table,
497 t->encap_fib_index, &t->dst) == 1)
499 fib_node_index_t mfei;
501 fib_route_path_t path = {
502 .frp_proto = fib_proto_to_dpo (fp),
503 .frp_addr = zero_addr,
504 .frp_sw_if_index = 0xffffffff,
507 .frp_flags = FIB_ROUTE_PATH_LOCAL,
508 .frp_mitf_flags = MFIB_ITF_FLAG_FORWARD,
510 const mfib_prefix_t mpfx = {
512 .fp_len = (is_ip6 ? 128 : 32),
513 .fp_grp_addr = tun_dst_pfx.fp_addr,
517 * Setup the (*,G) to receive traffic on the mcast group
518 * - the forwarding interface is for-us
519 * - the accepting interface is that from the API
521 mfib_table_entry_path_update (t->encap_fib_index,
522 &mpfx, MFIB_SOURCE_GTPU, &path);
524 path.frp_sw_if_index = a->mcast_sw_if_index;
525 path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
526 path.frp_mitf_flags = MFIB_ITF_FLAG_ACCEPT;
527 mfei = mfib_table_entry_path_update (t->encap_fib_index,
529 MFIB_SOURCE_GTPU, &path);
532 * Create the mcast adjacency to send traffic to the group
534 ai = adj_mcast_add_or_lock (fp,
535 fib_proto_to_link (fp),
536 a->mcast_sw_if_index);
539 * create a new end-point
541 mcast_shared_add (&t->dst, mfei, ai);
544 dpo_id_t dpo = DPO_INVALID;
545 mcast_shared_t ep = mcast_shared_get (&t->dst);
547 /* Stack shared mcast dst mac addr rewrite on encap */
548 dpo_set (&dpo, DPO_ADJACENCY_MCAST,
549 fib_proto_to_dpo (fp), ep.mcast_adj_index);
551 dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
554 flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
557 vnet_get_sw_interface (vnet_get_main (), sw_if_index)->flood_class =
562 /* deleting a tunnel: tunnel must exist */
564 return VNET_API_ERROR_NO_SUCH_ENTRY;
566 t = pool_elt_at_index (gtm->tunnels, p[0]);
567 sw_if_index = t->sw_if_index;
569 vnet_sw_interface_set_flags (vnm, t->sw_if_index, 0 /* down */ );
570 vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, t->sw_if_index);
571 si->flags |= VNET_SW_INTERFACE_FLAG_HIDDEN;
573 /* make sure tunnel is removed from l2 bd or xconnect */
574 set_int_l2_mode (gtm->vlib_main, vnm, MODE_L3, t->sw_if_index, 0,
575 L2_BD_PORT_TYPE_NORMAL, 0, 0);
576 vec_add1 (gtm->free_gtpu_tunnel_hw_if_indices, t->hw_if_index);
578 gtm->tunnel_index_by_sw_if_index[t->sw_if_index] = ~0;
581 hash_unset (gtm->gtpu4_tunnel_by_key, key4.as_u64);
583 hash_unset_mem_free (>m->gtpu6_tunnel_by_key, &key6);
585 if (!ip46_address_is_multicast (&t->dst))
587 if (t->flow_index != ~0)
588 vnet_flow_del (vnm, t->flow_index);
590 vtep_addr_unref (>m->vtep_table, t->encap_fib_index, &t->src);
591 fib_entry_untrack (t->fib_entry_index, t->sibling_index);
593 else if (vtep_addr_unref (>m->vtep_table,
594 t->encap_fib_index, &t->dst) == 0)
596 mcast_shared_remove (&t->dst);
599 fib_node_deinit (&t->node);
600 vec_free (t->rewrite);
601 pool_put (gtm->tunnels, t);
605 *sw_if_indexp = sw_if_index;
609 /* register udp ports */
610 if (!is_ip6 && !udp_is_valid_dst_port (UDP_DST_PORT_GTPU, 1))
611 udp_register_dst_port (gtm->vlib_main, UDP_DST_PORT_GTPU,
612 gtpu4_input_node.index, /* is_ip4 */ 1);
613 if (is_ip6 && !udp_is_valid_dst_port (UDP_DST_PORT_GTPU6, 0))
614 udp_register_dst_port (gtm->vlib_main, UDP_DST_PORT_GTPU6,
615 gtpu6_input_node.index, /* is_ip4 */ 0);
622 get_decap_next_for_node (u32 node_index, u32 ipv4_set)
624 gtpu_main_t *gtm = >pu_main;
625 vlib_main_t *vm = gtm->vlib_main;
626 uword input_node = (ipv4_set) ? gtpu4_input_node.index :
627 gtpu6_input_node.index;
629 return vlib_node_add_next (vm, input_node, node_index);
633 unformat_decap_next (unformat_input_t * input, va_list * args)
635 u32 *result = va_arg (*args, u32 *);
636 u32 ipv4_set = va_arg (*args, int);
637 gtpu_main_t *gtm = >pu_main;
638 vlib_main_t *vm = gtm->vlib_main;
642 if (unformat (input, "l2"))
643 *result = GTPU_INPUT_NEXT_L2_INPUT;
644 else if (unformat (input, "ip4"))
645 *result = GTPU_INPUT_NEXT_IP4_INPUT;
646 else if (unformat (input, "ip6"))
647 *result = GTPU_INPUT_NEXT_IP6_INPUT;
648 else if (unformat (input, "node %U", unformat_vlib_node, vm, &node_index))
649 *result = get_decap_next_for_node (node_index, ipv4_set);
650 else if (unformat (input, "%d", &tmp))
658 static clib_error_t *
659 gtpu_add_del_tunnel_command_fn (vlib_main_t * vm,
660 unformat_input_t * input,
661 vlib_cli_command_t * cmd)
663 unformat_input_t _line_input, *line_input = &_line_input;
664 ip46_address_t src, dst;
671 u32 encap_fib_index = 0;
672 u32 mcast_sw_if_index = ~0;
673 u32 decap_next_index = GTPU_INPUT_NEXT_L2_INPUT;
677 vnet_gtpu_add_del_tunnel_args_t _a, *a = &_a;
678 u32 tunnel_sw_if_index;
679 clib_error_t *error = NULL;
681 /* Cant "universally zero init" (={0}) due to GCC bug 53119 */
682 clib_memset (&src, 0, sizeof src);
683 clib_memset (&dst, 0, sizeof dst);
685 /* Get a line of input. */
686 if (!unformat_user (input, unformat_line_input, line_input))
689 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
691 if (unformat (line_input, "del"))
695 else if (unformat (line_input, "src %U",
696 unformat_ip4_address, &src.ip4))
701 else if (unformat (line_input, "dst %U",
702 unformat_ip4_address, &dst.ip4))
707 else if (unformat (line_input, "src %U",
708 unformat_ip6_address, &src.ip6))
713 else if (unformat (line_input, "dst %U",
714 unformat_ip6_address, &dst.ip6))
719 else if (unformat (line_input, "group %U %U",
720 unformat_ip4_address, &dst.ip4,
721 unformat_vnet_sw_interface,
722 vnet_get_main (), &mcast_sw_if_index))
724 grp_set = dst_set = 1;
727 else if (unformat (line_input, "group %U %U",
728 unformat_ip6_address, &dst.ip6,
729 unformat_vnet_sw_interface,
730 vnet_get_main (), &mcast_sw_if_index))
732 grp_set = dst_set = 1;
735 else if (unformat (line_input, "encap-vrf-id %d", &tmp))
737 encap_fib_index = fib_table_find (fib_ip_proto (ipv6_set), tmp);
738 if (encap_fib_index == ~0)
741 clib_error_return (0, "nonexistent encap-vrf-id %d", tmp);
745 else if (unformat (line_input, "decap-next %U", unformat_decap_next,
746 &decap_next_index, ipv4_set))
748 else if (unformat (line_input, "teid %d", &teid))
752 error = clib_error_return (0, "parse error: '%U'",
753 format_unformat_error, line_input);
760 error = clib_error_return (0, "tunnel src address not specified");
766 error = clib_error_return (0, "tunnel dst address not specified");
770 if (grp_set && !ip46_address_is_multicast (&dst))
772 error = clib_error_return (0, "tunnel group address not multicast");
776 if (grp_set == 0 && ip46_address_is_multicast (&dst))
778 error = clib_error_return (0, "dst address must be unicast");
782 if (grp_set && mcast_sw_if_index == ~0)
784 error = clib_error_return (0, "tunnel nonexistent multicast device");
788 if (ipv4_set && ipv6_set)
790 error = clib_error_return (0, "both IPv4 and IPv6 addresses specified");
794 if (ip46_address_cmp (&src, &dst) == 0)
796 error = clib_error_return (0, "src and dst addresses are identical");
800 if (decap_next_index == ~0)
802 error = clib_error_return (0, "next node not found");
806 clib_memset (a, 0, sizeof (*a));
810 #define _(x) a->x = x;
814 rv = vnet_gtpu_add_del_tunnel (a, &tunnel_sw_if_index);
820 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
821 vnet_get_main (), tunnel_sw_if_index);
824 case VNET_API_ERROR_TUNNEL_EXIST:
825 error = clib_error_return (0, "tunnel already exists...");
828 case VNET_API_ERROR_NO_SUCH_ENTRY:
829 error = clib_error_return (0, "tunnel does not exist...");
833 error = clib_error_return
834 (0, "vnet_gtpu_add_del_tunnel returned %d", rv);
839 unformat_free (line_input);
845 * Add or delete a GTPU Tunnel.
847 * GTPU provides the features needed to allow L2 bridge domains (BDs)
848 * to span multiple servers. This is done by building an L2 overlay on
849 * top of an L3 network underlay using GTPU tunnels.
851 * This makes it possible for servers to be co-located in the same data
852 * center or be separated geographically as long as they are reachable
853 * through the underlay L3 network.
855 * You can refer to this kind of L2 overlay bridge domain as a GTPU
856 * (Virtual eXtensible VLAN) segment.
859 * Example of how to create a GTPU Tunnel:
860 * @cliexcmd{create gtpu tunnel src 10.0.3.1 dst 10.0.3.3 teid 13 encap-vrf-id 7}
861 * Example of how to delete a GTPU Tunnel:
862 * @cliexcmd{create gtpu tunnel src 10.0.3.1 dst 10.0.3.3 teid 13 del}
865 VLIB_CLI_COMMAND (create_gtpu_tunnel_command, static) = {
866 .path = "create gtpu tunnel",
868 "create gtpu tunnel src <local-vtep-addr>"
869 " {dst <remote-vtep-addr>|group <mcast-vtep-addr> <intf-name>} teid <nn>"
870 " [encap-vrf-id <nn>] [decap-next [l2|ip4|ip6|node <name>]] [del]",
871 .function = gtpu_add_del_tunnel_command_fn,
875 static clib_error_t *
876 show_gtpu_tunnel_command_fn (vlib_main_t * vm,
877 unformat_input_t * input,
878 vlib_cli_command_t * cmd)
880 gtpu_main_t *gtm = >pu_main;
883 if (pool_elts (gtm->tunnels) == 0)
884 vlib_cli_output (vm, "No gtpu tunnels configured...");
886 pool_foreach (t, gtm->tunnels, (
888 vlib_cli_output (vm, "%U",
889 format_gtpu_tunnel, t);
897 * Display all the GTPU Tunnel entries.
900 * Example of how to display the GTPU Tunnel entries:
901 * @cliexstart{show gtpu tunnel}
902 * [0] src 10.0.3.1 dst 10.0.3.3 teid 13 encap_fib_index 0 sw_if_index 5 decap_next l2
906 VLIB_CLI_COMMAND (show_gtpu_tunnel_command, static) = {
907 .path = "show gtpu tunnel",
908 .short_help = "show gtpu tunnel",
909 .function = show_gtpu_tunnel_command_fn,
914 vnet_int_gtpu_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable)
917 vnet_feature_enable_disable ("ip6-unicast", "ip6-gtpu-bypass",
918 sw_if_index, is_enable, 0, 0);
920 vnet_feature_enable_disable ("ip4-unicast", "ip4-gtpu-bypass",
921 sw_if_index, is_enable, 0, 0);
924 static clib_error_t *
925 set_ip_gtpu_bypass (u32 is_ip6,
926 unformat_input_t * input, vlib_cli_command_t * cmd)
928 unformat_input_t _line_input, *line_input = &_line_input;
929 vnet_main_t *vnm = vnet_get_main ();
930 clib_error_t *error = 0;
931 u32 sw_if_index, is_enable;
936 if (!unformat_user (input, unformat_line_input, line_input))
939 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
942 (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
944 else if (unformat (line_input, "del"))
948 error = unformat_parse_error (line_input);
953 if (~0 == sw_if_index)
955 error = clib_error_return (0, "unknown interface `%U'",
956 format_unformat_error, line_input);
960 vnet_int_gtpu_bypass_mode (sw_if_index, is_ip6, is_enable);
963 unformat_free (line_input);
968 static clib_error_t *
969 set_ip4_gtpu_bypass (vlib_main_t * vm,
970 unformat_input_t * input, vlib_cli_command_t * cmd)
972 return set_ip_gtpu_bypass (0, input, cmd);
976 * This command adds the 'ip4-gtpu-bypass' graph node for a given interface.
977 * By adding the IPv4 gtpu-bypass graph node to an interface, the node checks
978 * for and validate input gtpu packet and bypass ip4-lookup, ip4-local,
979 * ip4-udp-lookup nodes to speedup gtpu packet forwarding. This node will
980 * cause extra overhead to for non-gtpu packets which is kept at a minimum.
984 * Example of graph node before ip4-gtpu-bypass is enabled:
985 * @cliexstart{show vlib graph ip4-gtpu-bypass}
987 * ip4-gtpu-bypass error-drop [0]
992 * Example of how to enable ip4-gtpu-bypass on an interface:
993 * @cliexcmd{set interface ip gtpu-bypass GigabitEthernet2/0/0}
995 * Example of graph node after ip4-gtpu-bypass is enabled:
996 * @cliexstart{show vlib graph ip4-gtpu-bypass}
998 * ip4-gtpu-bypass error-drop [0] ip4-input
999 * gtpu4-input [1] ip4-input-no-checksum
1003 * Example of how to display the feature enabled on an interface:
1004 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1005 * IP feature paths configured on GigabitEthernet2/0/0...
1013 * Example of how to disable ip4-gtpu-bypass on an interface:
1014 * @cliexcmd{set interface ip gtpu-bypass GigabitEthernet2/0/0 del}
1018 VLIB_CLI_COMMAND (set_interface_ip_gtpu_bypass_command, static) = {
1019 .path = "set interface ip gtpu-bypass",
1020 .function = set_ip4_gtpu_bypass,
1021 .short_help = "set interface ip gtpu-bypass <interface> [del]",
1025 static clib_error_t *
1026 set_ip6_gtpu_bypass (vlib_main_t * vm,
1027 unformat_input_t * input, vlib_cli_command_t * cmd)
1029 return set_ip_gtpu_bypass (1, input, cmd);
1033 * This command adds the 'ip6-gtpu-bypass' graph node for a given interface.
1034 * By adding the IPv6 gtpu-bypass graph node to an interface, the node checks
1035 * for and validate input gtpu packet and bypass ip6-lookup, ip6-local,
1036 * ip6-udp-lookup nodes to speedup gtpu packet forwarding. This node will
1037 * cause extra overhead to for non-gtpu packets which is kept at a minimum.
1041 * Example of graph node before ip6-gtpu-bypass is enabled:
1042 * @cliexstart{show vlib graph ip6-gtpu-bypass}
1043 * Name Next Previous
1044 * ip6-gtpu-bypass error-drop [0]
1049 * Example of how to enable ip6-gtpu-bypass on an interface:
1050 * @cliexcmd{set interface ip6 gtpu-bypass GigabitEthernet2/0/0}
1052 * Example of graph node after ip6-gtpu-bypass is enabled:
1053 * @cliexstart{show vlib graph ip6-gtpu-bypass}
1054 * Name Next Previous
1055 * ip6-gtpu-bypass error-drop [0] ip6-input
1056 * gtpu6-input [1] ip4-input-no-checksum
1060 * Example of how to display the feature enabled on an interface:
1061 * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1062 * IP feature paths configured on GigabitEthernet2/0/0...
1070 * Example of how to disable ip6-gtpu-bypass on an interface:
1071 * @cliexcmd{set interface ip6 gtpu-bypass GigabitEthernet2/0/0 del}
1075 VLIB_CLI_COMMAND (set_interface_ip6_gtpu_bypass_command, static) = {
1076 .path = "set interface ip6 gtpu-bypass",
1077 .function = set_ip6_gtpu_bypass,
1078 .short_help = "set interface ip6 gtpu-bypass <interface> [del]",
1083 vnet_gtpu_add_del_rx_flow (u32 hw_if_index, u32 t_index, int is_add)
1085 gtpu_main_t *gtm = >pu_main;
1086 gtpu_tunnel_t *t = pool_elt_at_index (gtm->tunnels, t_index);
1087 vnet_main_t *vnm = vnet_get_main ();
1090 if (t->flow_index == ~0)
1092 vnet_flow_t flow = {
1094 VNET_FLOW_ACTION_REDIRECT_TO_NODE | VNET_FLOW_ACTION_MARK |
1095 VNET_FLOW_ACTION_BUFFER_ADVANCE,
1096 .mark_flow_id = t_index + gtm->flow_id_start,
1097 .redirect_node_index = gtpu4_flow_input_node.index,
1098 .buffer_advance = sizeof (ethernet_header_t)
1099 + sizeof (ip4_header_t) + sizeof (udp_header_t),
1100 .type = VNET_FLOW_TYPE_IP4_GTPU_IP4,
1102 .protocol = IP_PROTOCOL_UDP,
1103 .src_addr.addr = t->dst.ip4,
1104 .src_addr.mask.as_u32 = ~0,
1105 .dst_addr.addr = t->src.ip4,
1106 .dst_addr.mask.as_u32 = ~0,
1111 vnet_flow_add (vnm, &flow, &t->flow_index);
1114 return vnet_flow_enable (vnm, t->flow_index, hw_if_index);
1117 /* flow index is removed when the tunnel is deleted */
1118 return vnet_flow_disable (vnm, t->flow_index, hw_if_index);
1122 vnet_gtpu_get_tunnel_index (u32 sw_if_index)
1124 gtpu_main_t *gtm = >pu_main;
1126 if (sw_if_index >= vec_len (gtm->tunnel_index_by_sw_if_index))
1128 return gtm->tunnel_index_by_sw_if_index[sw_if_index];
1131 static clib_error_t *
1132 gtpu_offload_command_fn (vlib_main_t * vm,
1133 unformat_input_t * input, vlib_cli_command_t * cmd)
1135 unformat_input_t _line_input, *line_input = &_line_input;
1137 /* Get a line of input. */
1138 if (!unformat_user (input, unformat_line_input, line_input))
1141 vnet_main_t *vnm = vnet_get_main ();
1142 u32 rx_sw_if_index = ~0;
1143 u32 hw_if_index = ~0;
1146 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1148 if (unformat (line_input, "hw %U", unformat_vnet_hw_interface, vnm,
1151 if (unformat (line_input, "rx %U", unformat_vnet_sw_interface, vnm,
1154 if (unformat (line_input, "del"))
1159 return clib_error_return (0, "unknown input `%U'",
1160 format_unformat_error, line_input);
1163 if (rx_sw_if_index == ~0)
1164 return clib_error_return (0, "missing rx interface");
1165 if (hw_if_index == ~0)
1166 return clib_error_return (0, "missing hw interface");
1168 u32 t_index = vnet_gtpu_get_tunnel_index (rx_sw_if_index);;
1170 return clib_error_return (0, "%U is not a gtpu tunnel",
1171 format_vnet_sw_if_index_name, vnm,
1174 gtpu_main_t *gtm = >pu_main;
1175 gtpu_tunnel_t *t = pool_elt_at_index (gtm->tunnels, t_index);
1177 /* first support ipv4 hw offload */
1178 if (!ip46_address_is_ip4 (&t->dst))
1179 return clib_error_return (0, "currently only IPV4 tunnels are supported");
1181 /* inner protocol should be IPv4 */
1182 if (t->decap_next_index != GTPU_INPUT_NEXT_IP4_INPUT)
1183 return clib_error_return (0,
1184 "currently only inner IPV4 protocol is supported");
1186 vnet_hw_interface_t *hw_if = vnet_get_hw_interface (vnm, hw_if_index);
1187 ip4_main_t *im = &ip4_main;
1189 vec_elt (im->fib_index_by_sw_if_index, hw_if->sw_if_index);
1191 if (t->encap_fib_index != rx_fib_index)
1192 return clib_error_return (0, "interface/tunnel fib mismatch");
1194 if (vnet_gtpu_add_del_rx_flow (hw_if_index, t_index, is_add))
1195 return clib_error_return (0, "error %s flow",
1196 is_add ? "enabling" : "disabling");
1203 VLIB_CLI_COMMAND (gtpu_offload_command, static) = {
1204 .path = "set flow-offload gtpu",
1206 "set flow-offload gtpu hw <inerface-name> rx <tunnel-name> [del]",
1207 .function = gtpu_offload_command_fn,
1212 gtpu_init (vlib_main_t * vm)
1214 gtpu_main_t *gtm = >pu_main;
1216 gtm->vnet_main = vnet_get_main ();
1217 gtm->vlib_main = vm;
1219 vnet_flow_get_range (gtm->vnet_main, "gtpu", 1024 * 1024,
1220 >m->flow_id_start);
1222 /* initialize the ip6 hash */
1223 gtm->gtpu6_tunnel_by_key = hash_create_mem (0,
1224 sizeof (gtpu6_tunnel_key_t),
1226 gtm->vtep_table = vtep_table_create ();
1227 gtm->mcast_shared = hash_create_mem (0,
1228 sizeof (ip46_address_t),
1229 sizeof (mcast_shared_t));
1231 gtm->fib_node_type = fib_node_register_new_type (>pu_vft);
1236 VLIB_INIT_FUNCTION (gtpu_init);
1239 VLIB_PLUGIN_REGISTER () = {
1240 .version = VPP_BUILD_VER,
1241 .description = "GPRS Tunnelling Protocol, User Data (GTPv1-U)",
1246 * fd.io coding-style-patch-verification: ON
1249 * eval: (c-set-style "gnu")