FD.io VPP  v19.01.3-6-g70449b9b9
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 
28 #include <gtpu/gtpu.h>
29 
30 
31 #define vl_msg_id(n,h) n,
32 typedef enum
33 {
34 #include <gtpu/gtpu.api.h>
35  /* We'll want to know how many messages IDs we need... */
37 } vl_msg_id_t;
38 #undef vl_msg_id
39 
40 /* define message structures */
41 #define vl_typedefs
42 #include <gtpu/gtpu.api.h>
43 #undef vl_typedefs
44 
45 /* define generated endian-swappers */
46 #define vl_endianfun
47 #include <gtpu/gtpu.api.h>
48 #undef vl_endianfun
49 
50 /* instantiate all the print functions we know about */
51 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
52 #define vl_printfun
53 #include <gtpu/gtpu.api.h>
54 #undef vl_printfun
55 
56 /* Get the API version number */
57 #define vl_api_version(n,v) static u32 api_version=(v);
58 #include <gtpu/gtpu.api.h>
59 #undef vl_api_version
60 
61 #define vl_msg_name_crc_list
62 #include <gtpu/gtpu.api.h>
63 #undef vl_msg_name_crc_list
64 
65 #define REPLY_MSG_ID_BASE gtm->msg_id_base
67 
68 static void
70 {
71 #define _(id,n,crc) \
72  vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id + gtm->msg_id_base);
73  foreach_vl_msg_name_crc_gtpu;
74 #undef _
75 }
76 
77 #define foreach_gtpu_plugin_api_msg \
78 _(SW_INTERFACE_SET_GTPU_BYPASS, sw_interface_set_gtpu_bypass) \
79 _(GTPU_ADD_DEL_TUNNEL, gtpu_add_del_tunnel) \
80 _(GTPU_TUNNEL_DUMP, gtpu_tunnel_dump)
81 
82 static void
85 {
87  int rv = 0;
88  u32 sw_if_index = ntohl (mp->sw_if_index);
89  gtpu_main_t *gtm = &gtpu_main;
90 
92 
93  vnet_int_gtpu_bypass_mode (sw_if_index, mp->is_ipv6, mp->enable);
95 
96  REPLY_MACRO (VL_API_SW_INTERFACE_SET_GTPU_BYPASS_REPLY);
97 }
98 
101 {
103  int rv = 0;
104  ip4_main_t *im = &ip4_main;
105  gtpu_main_t *gtm = &gtpu_main;
106 
107  uword *p = hash_get (im->fib_index_by_table_id, ntohl (mp->encap_vrf_id));
108  if (!p)
109  {
110  rv = VNET_API_ERROR_NO_SUCH_FIB;
111  goto out;
112  }
113 
115  .is_add = mp->is_add,
116  .is_ip6 = mp->is_ipv6,
117  .mcast_sw_if_index = ntohl (mp->mcast_sw_if_index),
118  .encap_fib_index = p[0],
119  .decap_next_index = ntohl (mp->decap_next_index),
120  .teid = ntohl (mp->teid),
121  .dst = to_ip46 (mp->is_ipv6, mp->dst_address),
122  .src = to_ip46 (mp->is_ipv6, mp->src_address),
123  };
124 
125  /* Check src & dst are different */
126  if (ip46_address_cmp (&a.dst, &a.src) == 0)
127  {
128  rv = VNET_API_ERROR_SAME_SRC_DST;
129  goto out;
130  }
131  if (ip46_address_is_multicast (&a.dst) &&
133  {
134  rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
135  goto out;
136  }
137 
138  u32 sw_if_index = ~0;
139  rv = vnet_gtpu_add_del_tunnel (&a, &sw_if_index);
140 
141 out:
142  /* *INDENT-OFF* */
143  REPLY_MACRO2(VL_API_GTPU_ADD_DEL_TUNNEL_REPLY,
144  ({
145  rmp->sw_if_index = ntohl (sw_if_index);
146  }));
147  /* *INDENT-ON* */
148 }
149 
150 static void send_gtpu_tunnel_details
152 {
154  ip4_main_t *im4 = &ip4_main;
155  ip6_main_t *im6 = &ip6_main;
156  u8 is_ipv6 = !ip46_address_is_ip4 (&t->dst);
157 
158  rmp = vl_msg_api_alloc (sizeof (*rmp));
159  clib_memset (rmp, 0, sizeof (*rmp));
160  rmp->_vl_msg_id = ntohs (VL_API_GTPU_TUNNEL_DETAILS);
161  if (is_ipv6)
162  {
163  memcpy (rmp->src_address, t->src.ip6.as_u8, 16);
164  memcpy (rmp->dst_address, t->dst.ip6.as_u8, 16);
165  rmp->encap_vrf_id = htonl (im6->fibs[t->encap_fib_index].ft_table_id);
166  }
167  else
168  {
169  memcpy (rmp->src_address, t->src.ip4.as_u8, 4);
170  memcpy (rmp->dst_address, t->dst.ip4.as_u8, 4);
171  rmp->encap_vrf_id = htonl (im4->fibs[t->encap_fib_index].ft_table_id);
172  }
173  rmp->mcast_sw_if_index = htonl (t->mcast_sw_if_index);
174  rmp->teid = htonl (t->teid);
175  rmp->decap_next_index = htonl (t->decap_next_index);
176  rmp->sw_if_index = htonl (t->sw_if_index);
177  rmp->is_ipv6 = is_ipv6;
178  rmp->context = context;
179 
180  vl_api_send_msg (reg, (u8 *) rmp);
181 }
182 
183 static void
185 {
187  gtpu_main_t *gtm = &gtpu_main;
188  gtpu_tunnel_t *t;
190 
192  if (!reg)
193  return;
194 
195  sw_if_index = ntohl (mp->sw_if_index);
196 
197  if (~0 == sw_if_index)
198  {
199  /* *INDENT-OFF* */
200  pool_foreach (t, gtm->tunnels,
201  ({
202  send_gtpu_tunnel_details(t, reg, mp->context);
203  }));
204  /* *INDENT-ON* */
205  }
206  else
207  {
208  if ((sw_if_index >= vec_len (gtm->tunnel_index_by_sw_if_index)) ||
209  (~0 == gtm->tunnel_index_by_sw_if_index[sw_if_index]))
210  {
211  return;
212  }
214  send_gtpu_tunnel_details (t, reg, mp->context);
215  }
216 }
217 
218 
219 static clib_error_t *
221 {
222  gtpu_main_t *gtm = &gtpu_main;
223 
224  u8 *name = format (0, "gtpu_%08x%c", api_version, 0);
226  ((char *) name, VL_MSG_FIRST_AVAILABLE);
227 
228 #define _(N,n) \
229  vl_msg_api_set_handlers((VL_API_##N + gtm->msg_id_base), \
230  #n, \
231  vl_api_##n##_t_handler, \
232  vl_noop_handler, \
233  vl_api_##n##_t_endian, \
234  vl_api_##n##_t_print, \
235  sizeof(vl_api_##n##_t), 1);
237 #undef _
238 
239  /* Add our API messages to the global name_crc hash table */
241 
242  return 0;
243 }
244 
246 
247 /*
248  * fd.io coding-style-patch-verification: ON
249  *
250  * Local Variables:
251  * eval: (c-set-style "gnu")
252  * End:
253  */
static void setup_message_id_table(gtpu_main_t *gtm, api_main_t *am)
Definition: gtpu_api.c:69
a
Definition: bitmap.h:538
static void send_gtpu_tunnel_details(gtpu_tunnel_t *t, vl_api_registration_t *reg, u32 context)
Definition: gtpu_api.c:151
u32 teid
Definition: gtpu.h:138
u32 * tunnel_index_by_sw_if_index
Definition: gtpu.h:221
#define REPLY_MACRO2(t, body)
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
static void vl_api_send_msg(vl_api_registration_t *rp, u8 *elem)
Definition: api.h:34
#define foreach_gtpu_plugin_api_msg
Definition: gtpu_api.c:77
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:419
void * vl_msg_api_alloc(int nbytes)
#define ip46_address_cmp(ip46_1, ip46_2)
Definition: ip6_packet.h:92
unsigned char u8
Definition: types.h:56
static void vl_api_sw_interface_set_gtpu_bypass_t_handler(vl_api_sw_interface_set_gtpu_bypass_t *mp)
Definition: gtpu_api.c:84
static uword ip46_address_is_multicast(const ip46_address_t *a)
Definition: ip6_packet.h:178
static clib_error_t * gtpu_api_hookup(vlib_main_t *vm)
Definition: gtpu_api.c:220
static void vl_api_gtpu_add_del_tunnel_t_handler(vl_api_gtpu_add_del_tunnel_t *mp)
Definition: gtpu_api.c:100
#define pool_foreach(VAR, POOL, BODY)
Iterate through pool.
Definition: pool.h:490
int vnet_gtpu_add_del_tunnel(vnet_gtpu_add_del_tunnel_args_t *a, u32 *sw_if_indexp)
Definition: gtpu.c:360
ip46_address_t src
Definition: gtpu.h:141
u32 sw_if_index
Definition: vxlan_gbp.api:37
u16 msg_id_base
Definition: gtpu.h:229
reply for set or delete an GTPU tunnel
Definition: gtpu.api:49
unsigned int u32
Definition: types.h:88
gtpu_main_t gtpu_main
Definition: gtpu.c:35
#define hash_get(h, key)
Definition: hash.h:249
uword * fib_index_by_table_id
Hash table mapping table id to fib index.
Definition: ip4.h:122
u32 decap_next_index
Definition: gtpu.h:148
#define REPLY_MACRO(t)
Interface set gtpu-bypass request.
Definition: gtpu.api:99
u8 name[64]
Definition: memclnt.api:152
ip46_address_t dst
Definition: gtpu.h:142
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:202
#define ip46_address_is_ip4(ip46)
Definition: ip6_packet.h:88
An API client registration, only in vpp/vlib.
Definition: api_common.h:45
#define BAD_SW_IF_INDEX_LABEL
static uword vnet_sw_if_index_is_api_valid(u32 sw_if_index)
u32 ft_table_id
Table ID (hash key) for this FIB.
Definition: fib_table.h:89
vlib_main_t * vm
Definition: buffer.c:301
Interface set gtpu-bypass response.
Definition: gtpu.api:112
u32 sw_if_index
Definition: gtpu.h:154
static vl_api_registration_t * vl_api_client_index_to_registration(u32 index)
Definition: api.h:56
static void vl_api_gtpu_tunnel_dump_t_handler(vl_api_gtpu_tunnel_dump_t *mp)
Definition: gtpu_api.c:184
static ip46_address_t to_ip46(u32 is_ipv6, u8 *buf)
Definition: ip6_packet.h:113
VLIB_API_INIT_FUNCTION(gtpu_api_hookup)
ip6_main_t ip6_main
Definition: ip6_forward.c:2624
IPv4 main type.
Definition: ip4.h:96
void vnet_int_gtpu_bypass_mode(u32 sw_if_index, u8 is_ip6, u8 is_enable)
Definition: gtpu.c:908
u32 encap_fib_index
Definition: gtpu.h:151
dump details of an GTPU tunnel
Definition: gtpu.api:79
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
u64 uword
Definition: types.h:112
gtpu_tunnel_t * tunnels
Definition: gtpu.h:203
ip4_main_t ip4_main
Global ip4 main structure.
Definition: ip4_forward.c:903
struct fib_table_t_ * fibs
Vector of FIBs.
Definition: ip4.h:101
Set or delete an GTPU tunnel.
Definition: gtpu.api:30
vl_msg_id_t
Definition: gtpu_api.c:32
Dump GTPU tunnel.
Definition: gtpu.api:61
api_main_t api_main
Definition: api_shared.c:35
struct fib_table_t_ * fibs
Definition: ip6.h:181
u32 mcast_sw_if_index
Definition: gtpu.h:145
#define VALIDATE_SW_IF_INDEX(mp)
u16 vl_msg_api_get_msg_ids(const char *name, int n)
Definition: api_shared.c:865