FD.io VPP  v17.10-9-gd594711
Vector Packet Processing
gtpu_api.c
Go to the documentation of this file.
1 /*
2  *------------------------------------------------------------------
3  * gtpu_api.c - gtpu api
4  *
5  * Copyright (c) 2017 Intel and/or its affiliates.
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at:
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  *------------------------------------------------------------------
18  */
19 
20 #include <vnet/interface.h>
21 #include <vnet/api_errno.h>
22 #include <vnet/feature/feature.h>
23 #include <vnet/fib/fib_table.h>
24 
25 #include <vppinfra/byte_order.h>
26 #include <vlibmemory/api.h>
27 #include <vlibsocket/api.h>
28 
29 #include <gtpu/gtpu.h>
30 
31 
32 #define vl_msg_id(n,h) n,
33 typedef enum
34 {
35 #include <gtpu/gtpu.api.h>
36  /* We'll want to know how many messages IDs we need... */
38 } vl_msg_id_t;
39 #undef vl_msg_id
40 
41 /* define message structures */
42 #define vl_typedefs
43 #include <gtpu/gtpu.api.h>
44 #undef vl_typedefs
45 
46 /* define generated endian-swappers */
47 #define vl_endianfun
48 #include <gtpu/gtpu.api.h>
49 #undef vl_endianfun
50 
51 /* instantiate all the print functions we know about */
52 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
53 #define vl_printfun
54 #include <gtpu/gtpu.api.h>
55 #undef vl_printfun
56 
57 /* Get the API version number */
58 #define vl_api_version(n,v) static u32 api_version=(v);
59 #include <gtpu/gtpu.api.h>
60 #undef vl_api_version
61 
62 #define vl_msg_name_crc_list
63 #include <gtpu/gtpu.api.h>
64 #undef vl_msg_name_crc_list
65 
66 #define REPLY_MSG_ID_BASE gtm->msg_id_base
68 
69 static void
71 {
72 #define _(id,n,crc) \
73  vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id + gtm->msg_id_base);
74  foreach_vl_msg_name_crc_gtpu;
75 #undef _
76 }
77 
78 #define foreach_gtpu_plugin_api_msg \
79 _(SW_INTERFACE_SET_GTPU_BYPASS, sw_interface_set_gtpu_bypass) \
80 _(GTPU_ADD_DEL_TUNNEL, gtpu_add_del_tunnel) \
81 _(GTPU_TUNNEL_DUMP, gtpu_tunnel_dump)
82 
83 static void
86 {
88  int rv = 0;
89  u32 sw_if_index = ntohl (mp->sw_if_index);
90  gtpu_main_t *gtm = &gtpu_main;
91 
93 
94  vnet_int_gtpu_bypass_mode (sw_if_index, mp->is_ipv6, mp->enable);
96 
97  REPLY_MACRO (VL_API_SW_INTERFACE_SET_GTPU_BYPASS_REPLY);
98 }
99 
102 {
104  int rv = 0;
105  ip4_main_t *im = &ip4_main;
106  gtpu_main_t *gtm = &gtpu_main;
107 
108  uword *p = hash_get (im->fib_index_by_table_id, ntohl (mp->encap_vrf_id));
109  if (!p)
110  {
111  rv = VNET_API_ERROR_NO_SUCH_FIB;
112  goto out;
113  }
114 
116  .is_add = mp->is_add,
117  .is_ip6 = mp->is_ipv6,
118  .mcast_sw_if_index = ntohl (mp->mcast_sw_if_index),
119  .encap_fib_index = p[0],
120  .decap_next_index = ntohl (mp->decap_next_index),
121  .teid = ntohl (mp->teid),
122  .dst = to_ip46 (mp->is_ipv6, mp->dst_address),
123  .src = to_ip46 (mp->is_ipv6, mp->src_address),
124  };
125 
126  /* Check src & dst are different */
127  if (ip46_address_cmp (&a.dst, &a.src) == 0)
128  {
129  rv = VNET_API_ERROR_SAME_SRC_DST;
130  goto out;
131  }
132  if (ip46_address_is_multicast (&a.dst) &&
134  {
135  rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
136  goto out;
137  }
138 
139  u32 sw_if_index = ~0;
140  rv = vnet_gtpu_add_del_tunnel (&a, &sw_if_index);
141 
142 out:
143  /* *INDENT-OFF* */
144  REPLY_MACRO2(VL_API_GTPU_ADD_DEL_TUNNEL_REPLY,
145  ({
146  rmp->sw_if_index = ntohl (sw_if_index);
147  }));
148  /* *INDENT-ON* */
149 }
150 
151 static void send_gtpu_tunnel_details
153 {
155  ip4_main_t *im4 = &ip4_main;
156  ip6_main_t *im6 = &ip6_main;
157  u8 is_ipv6 = !ip46_address_is_ip4 (&t->dst);
158 
159  rmp = vl_msg_api_alloc (sizeof (*rmp));
160  memset (rmp, 0, sizeof (*rmp));
161  rmp->_vl_msg_id = ntohs (VL_API_GTPU_TUNNEL_DETAILS);
162  if (is_ipv6)
163  {
164  memcpy (rmp->src_address, t->src.ip6.as_u8, 16);
165  memcpy (rmp->dst_address, t->dst.ip6.as_u8, 16);
166  rmp->encap_vrf_id = htonl (im6->fibs[t->encap_fib_index].ft_table_id);
167  }
168  else
169  {
170  memcpy (rmp->src_address, t->src.ip4.as_u8, 4);
171  memcpy (rmp->dst_address, t->dst.ip4.as_u8, 4);
172  rmp->encap_vrf_id = htonl (im4->fibs[t->encap_fib_index].ft_table_id);
173  }
174  rmp->mcast_sw_if_index = htonl (t->mcast_sw_if_index);
175  rmp->teid = htonl (t->teid);
176  rmp->decap_next_index = htonl (t->decap_next_index);
177  rmp->sw_if_index = htonl (t->sw_if_index);
178  rmp->is_ipv6 = is_ipv6;
179  rmp->context = context;
180 
181  vl_msg_api_send_shmem (q, (u8 *) & rmp);
182 }
183 
184 static void
186 {
188  gtpu_main_t *gtm = &gtpu_main;
189  gtpu_tunnel_t *t;
190  u32 sw_if_index;
191 
193  if (q == 0)
194  {
195  return;
196  }
197 
198  sw_if_index = ntohl (mp->sw_if_index);
199 
200  if (~0 == sw_if_index)
201  {
202  /* *INDENT-OFF* */
203  pool_foreach (t, gtm->tunnels,
204  ({
205  send_gtpu_tunnel_details(t, q, mp->context);
206  }));
207  /* *INDENT-ON* */
208  }
209  else
210  {
211  if ((sw_if_index >= vec_len (gtm->tunnel_index_by_sw_if_index)) ||
212  (~0 == gtm->tunnel_index_by_sw_if_index[sw_if_index]))
213  {
214  return;
215  }
216  t = &gtm->tunnels[gtm->tunnel_index_by_sw_if_index[sw_if_index]];
217  send_gtpu_tunnel_details (t, q, mp->context);
218  }
219 }
220 
221 
222 static clib_error_t *
224 {
225  gtpu_main_t *gtm = &gtpu_main;
226 
227  u8 *name = format (0, "gtpu_%08x%c", api_version, 0);
229  ((char *) name, VL_MSG_FIRST_AVAILABLE);
230 
231 #define _(N,n) \
232  vl_msg_api_set_handlers((VL_API_##N + gtm->msg_id_base), \
233  #n, \
234  vl_api_##n##_t_handler, \
235  vl_noop_handler, \
236  vl_api_##n##_t_endian, \
237  vl_api_##n##_t_print, \
238  sizeof(vl_api_##n##_t), 1);
240 #undef _
241 
242  /* Add our API messages to the global name_crc hash table */
244 
245  return 0;
246 }
247 
249 
250 /*
251  * fd.io coding-style-patch-verification: ON
252  *
253  * Local Variables:
254  * eval: (c-set-style "gnu")
255  * End:
256  */
static void setup_message_id_table(gtpu_main_t *gtm, api_main_t *am)
Definition: gtpu_api.c:70
u16 vl_msg_api_get_msg_ids(const char *name, int n)
Definition: api_shared.c:857
a
Definition: bitmap.h:516
static uword ip46_address_is_multicast(ip46_address_t *a)
Definition: ip6_packet.h:151
u32 teid
Definition: gtpu.h:133
u32 * tunnel_index_by_sw_if_index
Definition: gtpu.h:216
#define REPLY_MACRO2(t, body)
#define foreach_gtpu_plugin_api_msg
Definition: gtpu_api.c:78
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:419
#define ip46_address_cmp(ip46_1, ip46_2)
Definition: ip6_packet.h:80
static void vl_api_sw_interface_set_gtpu_bypass_t_handler(vl_api_sw_interface_set_gtpu_bypass_t *mp)
Definition: gtpu_api.c:85
static clib_error_t * gtpu_api_hookup(vlib_main_t *vm)
Definition: gtpu_api.c:223
static void vl_api_gtpu_add_del_tunnel_t_handler(vl_api_gtpu_add_del_tunnel_t *mp)
Definition: gtpu_api.c:101
#define pool_foreach(VAR, POOL, BODY)
Iterate through pool.
Definition: pool.h:437
int vnet_gtpu_add_del_tunnel(vnet_gtpu_add_del_tunnel_args_t *a, u32 *sw_if_indexp)
Definition: gtpu.c:393
ip46_address_t src
Definition: gtpu.h:136
u16 msg_id_base
Definition: gtpu.h:224
reply for set or delete an GTPU tunnel
Definition: gtpu.api:47
void * vl_msg_api_alloc(int nbytes)
static void send_gtpu_tunnel_details(gtpu_tunnel_t *t, unix_shared_memory_queue_t *q, u32 context)
Definition: gtpu_api.c:152
#define hash_get(h, key)
Definition: hash.h:248
uword * fib_index_by_table_id
Hash table mapping table id to fib index.
Definition: ip4.h:121
u32 decap_next_index
Definition: gtpu.h:143
#define REPLY_MACRO(t)
Interface set gtpu-bypass request.
Definition: gtpu.api:97
ip46_address_t dst
Definition: gtpu.h:137
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:182
#define ip46_address_is_ip4(ip46)
Definition: ip6_packet.h:76
#define BAD_SW_IF_INDEX_LABEL
static uword vnet_sw_if_index_is_api_valid(u32 sw_if_index)
api_main_t api_main
Definition: api_shared.c:35
u32 ft_table_id
Table ID (hash key) for this FIB.
Definition: fib_table.h:50
vlib_main_t * vm
Definition: buffer.c:283
Interface set gtpu-bypass response.
Definition: gtpu.api:110
unix_shared_memory_queue_t * vl_api_client_index_to_input_queue(u32 index)
u32 sw_if_index
Definition: gtpu.h:149
static void vl_api_gtpu_tunnel_dump_t_handler(vl_api_gtpu_tunnel_dump_t *mp)
Definition: gtpu_api.c:185
static ip46_address_t to_ip46(u32 is_ipv6, u8 *buf)
Definition: ip6_packet.h:86
VLIB_API_INIT_FUNCTION(gtpu_api_hookup)
void vl_msg_api_send_shmem(unix_shared_memory_queue_t *q, u8 *elem)
unsigned int u32
Definition: types.h:88
ip6_main_t ip6_main
Definition: ip6_forward.c:3043
IPv4 main type.
Definition: ip4.h:95
void vnet_int_gtpu_bypass_mode(u32 sw_if_index, u8 is_ip6, u8 is_enable)
Definition: gtpu.c:941
u32 encap_fib_index
Definition: gtpu.h:146
dump details of an GTPU tunnel
Definition: gtpu.api:77
u64 uword
Definition: types.h:112
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
unsigned char u8
Definition: types.h:56
gtpu_main_t gtpu_main
Definition: jvpp_gtpu.h:39
gtpu_tunnel_t * tunnels
Definition: gtpu.h:198
ip4_main_t ip4_main
Global ip4 main structure.
Definition: ip4_forward.c:1175
struct fib_table_t_ * fibs
Vector of FIBs.
Definition: ip4.h:100
Set or delete an GTPU tunnel.
Definition: gtpu.api:28
vl_msg_id_t
Definition: gtpu_api.c:33
Dump GTPU tunnel.
Definition: gtpu.api:59
struct fib_table_t_ * fibs
Definition: ip6.h:161
u32 mcast_sw_if_index
Definition: gtpu.h:140
#define VALIDATE_SW_IF_INDEX(mp)
struct _unix_shared_memory_queue unix_shared_memory_queue_t