FD.io VPP  v21.01.1
Vector Packet Processing
tapv2_api.c
Go to the documentation of this file.
1 /*
2  *------------------------------------------------------------------
3  * tap_api.c - vnet tap device driver API support
4  *
5  * Copyright (c) 2017 Cisco 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/vnet.h>
21 #include <vlibmemory/api.h>
22 
23 #include <vnet/interface.h>
24 #include <vnet/api_errno.h>
25 #include <vnet/ethernet/ethernet.h>
26 #include <vnet/ip/ip.h>
27 
29 #include <vnet/ip/ip_types_api.h>
30 
31 #include <vnet/vnet_msg_enum.h>
32 
33 #define vl_typedefs /* define message structures */
34 #include <vnet/vnet_all_api_h.h>
35 #undef vl_typedefs
36 
37 #define vl_endianfun /* define message structures */
38 #include <vnet/vnet_all_api_h.h>
39 #undef vl_endianfun
40 
41 /* instantiate all the print functions we know about */
42 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
43 #define vl_printfun
44 #include <vnet/vnet_all_api_h.h>
45 #undef vl_printfun
46 
48 #include <vnet/devices/tap/tap.h>
49 
50 #define foreach_tapv2_api_msg \
51 _(TAP_CREATE_V2, tap_create_v2) \
52 _(TAP_DELETE_V2, tap_delete_v2) \
53 _(SW_INTERFACE_TAP_V2_DUMP, sw_interface_tap_v2_dump)
54 
55 static void
57 {
60  if (!reg)
61  return;
62 
63  vnet_main_t *vnm = vnet_get_main ();
66 
67  tap_create_if_args_t _a, *ap = &_a;
68 
69  clib_memset (ap, 0, sizeof (*ap));
70 
71  ap->id = ntohl (mp->id);
72  if (!mp->use_random_mac)
73  {
75  ap->mac_addr_set = 1;
76  }
77  ap->rx_ring_sz = ntohs (mp->rx_ring_sz);
78  ap->tx_ring_sz = ntohs (mp->tx_ring_sz);
79  ap->sw_if_index = (u32) ~ 0;
80  ap->num_rx_queues = 1;
81 
82  if (mp->num_rx_queues > 1)
83  ap->num_rx_queues = mp->num_rx_queues;
84 
85  if (mp->host_if_name_set)
86  ap->host_if_name = format (0, "%s%c", mp->host_if_name, 0);
87 
88  if (mp->host_mac_addr_set)
89  {
91  }
92 
93  if (mp->host_namespace_set)
94  ap->host_namespace = format (0, "%s%c", mp->host_namespace, 0);
95 
96  if (mp->host_bridge_set)
97  ap->host_bridge = format (0, "%s%c", mp->host_bridge, 0);
98 
99  if (mp->host_ip4_prefix_set)
100  {
102  ap->host_ip4_prefix_len = mp->host_ip4_prefix.len;
103  }
104 
105  if (mp->host_ip6_prefix_set)
106  {
108  ap->host_ip6_prefix_len = mp->host_ip6_prefix.len;
109  }
110 
111  if (mp->host_ip4_gw_set)
112  {
114  ap->host_ip4_gw_set = 1;
115  }
116 
117  if (mp->host_ip6_gw_set)
118  {
120  ap->host_ip6_gw_set = 1;
121  }
122 
123  if (mp->host_mtu_set)
124  {
125  ap->host_mtu_size = ntohl (mp->host_mtu_size);
126  ap->host_mtu_set = 1;
127  }
128 
129  STATIC_ASSERT (((int) TAP_API_FLAG_GSO == (int) TAP_FLAG_GSO),
130  "tap gso api flag mismatch");
132  (int) TAP_FLAG_CSUM_OFFLOAD),
133  "tap checksum offload api flag mismatch");
134  STATIC_ASSERT (((int) TAP_API_FLAG_PERSIST == (int) TAP_FLAG_PERSIST),
135  "tap persist api flag mismatch");
136  STATIC_ASSERT (((int) TAP_API_FLAG_ATTACH == (int) TAP_FLAG_ATTACH),
137  "tap attach api flag mismatch");
138  STATIC_ASSERT (((int) TAP_API_FLAG_TUN == (int) TAP_FLAG_TUN),
139  "tap tun api flag mismatch");
141  (int) TAP_FLAG_GRO_COALESCE),
142  "tap gro coalesce api flag mismatch");
143  STATIC_ASSERT (((int) TAP_API_FLAG_PACKED == (int) TAP_FLAG_PACKED),
144  "tap packed api flag mismatch");
146  (int) TAP_FLAG_IN_ORDER), "tap in-order api flag mismatch");
147 
148  ap->tap_flags = ntohl (mp->tap_flags);
149 
150  tap_create_if (vm, ap);
151 
152 
153  /* If a tag was supplied... */
154  if (vl_api_string_len (&mp->tag))
155  {
156  u8 *tag = vl_api_from_api_to_new_vec (mp, &mp->tag);
157  vnet_set_sw_interface_tag (vnm, tag, ap->sw_if_index);
158  }
159 
160  rmp = vl_msg_api_alloc (sizeof (*rmp));
161  rmp->_vl_msg_id = ntohs (VL_API_TAP_CREATE_V2_REPLY);
162  rmp->context = mp->context;
163  rmp->retval = ntohl (ap->rv);
164  rmp->sw_if_index = ntohl (ap->sw_if_index);
165 
166  vl_api_send_msg (reg, (u8 *) rmp);
167 
168  vec_free (ap->host_if_name);
169  vec_free (ap->host_namespace);
170  vec_free (ap->host_bridge);
171 
172 }
173 
174 static void
176 {
179  if (!reg)
180  return;
181 
182  vnet_main_t *vnm = vnet_get_main ();
184  int rv;
185  vl_api_tap_delete_v2_reply_t *rmp;
186 
187  u32 sw_if_index = ntohl (mp->sw_if_index);
188 
189  rv = tap_delete_if (vm, sw_if_index);
190 
191  rmp = vl_msg_api_alloc (sizeof (*rmp));
192  rmp->_vl_msg_id = ntohs (VL_API_TAP_DELETE_V2_REPLY);
193  rmp->context = mp->context;
194  rmp->retval = ntohl (rv);
195 
196  vl_api_send_msg (reg, (u8 *) rmp);
197 
198  if (!rv)
199  vnet_clear_sw_interface_tag (vnm, sw_if_index);
200 }
201 
202 static void
204  vl_api_registration_t * reg,
205  tap_interface_details_t * tap_if, u32 context)
206 {
208  mp = vl_msg_api_alloc (sizeof (*mp));
209  clib_memset (mp, 0, sizeof (*mp));
210  mp->_vl_msg_id = htons (VL_API_SW_INTERFACE_TAP_V2_DETAILS);
211  mp->id = htonl (tap_if->id);
212  mp->sw_if_index = htonl (tap_if->sw_if_index);
213  mp->tap_flags = htonl (tap_if->tap_flags);
214  clib_memcpy (mp->dev_name, tap_if->dev_name,
215  MIN (ARRAY_LEN (mp->dev_name) - 1,
216  strlen ((const char *) tap_if->dev_name)));
217  mp->rx_ring_sz = htons (tap_if->rx_ring_sz);
218  mp->tx_ring_sz = htons (tap_if->tx_ring_sz);
220  clib_memcpy (mp->host_if_name, tap_if->host_if_name,
221  MIN (ARRAY_LEN (mp->host_if_name) - 1,
222  strlen ((const char *) tap_if->host_if_name)));
224  MIN (ARRAY_LEN (mp->host_namespace) - 1,
225  strlen ((const char *) tap_if->host_namespace)));
226  clib_memcpy (mp->host_bridge, tap_if->host_bridge,
227  MIN (ARRAY_LEN (mp->host_bridge) - 1,
228  strlen ((const char *) tap_if->host_bridge)));
229  mp->host_mtu_size = htonl (tap_if->host_mtu_size);
231 
232  if (tap_if->host_ip4_prefix_len)
233  ip4_address_encode (&tap_if->host_ip4_addr, mp->host_ip4_prefix.address);
234  mp->host_ip4_prefix.len = tap_if->host_ip4_prefix_len;
235  if (tap_if->host_ip6_prefix_len)
236  ip6_address_encode (&tap_if->host_ip6_addr, mp->host_ip6_prefix.address);
237  mp->host_ip6_prefix.len = tap_if->host_ip6_prefix_len;
238 
239  mp->context = context;
240  vl_api_send_msg (reg, (u8 *) mp);
241 }
242 
243 static void
245  mp)
246 {
247  int rv;
250  tap_interface_details_t *tapifs = NULL;
251  tap_interface_details_t *tap_if = NULL;
252  u32 filter_sw_if_index;
253 
255  if (!reg)
256  return;
257 
258  filter_sw_if_index = htonl (mp->sw_if_index);
259  if (mp->sw_if_index != ~0)
261 
262  rv = tap_dump_ifs (&tapifs);
263  if (rv)
264  return;
265 
266  vec_foreach (tap_if, tapifs)
267  {
268  if ((filter_sw_if_index == ~0)
269  || (tap_if->sw_if_index == filter_sw_if_index))
270  tap_send_sw_interface_details (am, reg, tap_if, mp->context);
271  }
273  vec_free (tapifs);
274 }
275 
276 #define vl_msg_name_crc_list
277 #include <vnet/vnet_all_api_h.h>
278 #undef vl_msg_name_crc_list
279 
280 static void
282 {
283 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
284  foreach_vl_msg_name_crc_tapv2;
285 #undef _
286 }
287 
288 static clib_error_t *
290 {
291  api_main_t *am = vlibapi_get_main ();
292 
293 #define _(N,n) \
294  vl_msg_api_set_handlers(VL_API_##N, #n, \
295  vl_api_##n##_t_handler, \
296  vl_noop_handler, \
297  vl_api_##n##_t_endian, \
298  vl_api_##n##_t_print, \
299  sizeof(vl_api_##n##_t), 1);
301 #undef _
302 
303  /*
304  * Set up the (msg_name, crc, message-id) table
305  */
307 
308  return 0;
309 }
310 
312 
313 /*
314  * fd.io coding-style-patch-verification: ON
315  *
316  * Local Variables:
317  * eval: (c-set-style "gnu")
318  * End:
319  */
static void vl_api_sw_interface_tap_v2_dump_t_handler(vl_api_sw_interface_tap_v2_dump_t *mp)
Definition: tapv2_api.c:244
vl_api_ip4_address_with_prefix_t host_ip4_prefix
Definition: tapv2.api:159
u8 host_if_name[64]
Definition: tap.h:81
u8 host_namespace[64]
Definition: tap.h:82
ip4_address_t host_ip4_addr
Definition: tap.h:55
#define ntohs(x)
Definition: af_xdp.bpf.c:29
vnet_main_t * vnet_get_main(void)
Definition: misc.c:46
static void tap_setup_message_id_table(api_main_t *am)
Definition: tapv2_api.c:281
void mac_address_encode(const mac_address_t *in, u8 *out)
Reply for tap dump request.
Definition: tapv2.api:150
u32 id[default=0xffffffff]
Definition: tapv2.api:73
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:35
u8 host_ip6_prefix_len
Definition: tap.h:60
void ip6_address_decode(const vl_api_ip6_address_t in, ip6_address_t *out)
Definition: ip_types_api.c:143
static void vnet_clear_sw_interface_tag(vnet_main_t *vnm, u32 sw_if_index)
static void tap_send_sw_interface_details(vpe_api_main_t *am, vl_api_registration_t *reg, tap_interface_details_t *tap_if, u32 context)
Definition: tapv2_api.c:203
vlib_main_t * vm
Definition: in2out_ed.c:1580
static clib_error_t * tapv2_api_hookup(vlib_main_t *vm)
Definition: tapv2_api.c:289
void * vl_msg_api_alloc(int nbytes)
int tap_dump_ifs(tap_interface_details_t **out_tapids)
Definition: tap.c:938
vl_api_mac_address_t mac_address
Definition: tapv2.api:75
u8 host_ip4_gw_set
Definition: tap.h:58
unsigned char u8
Definition: types.h:56
#define clib_memcpy(d, s, n)
Definition: string.h:180
Dump tap interfaces request.
Definition: tapv2.api:128
vl_api_interface_index_t sw_if_index[default=0xffffffff]
Definition: tapv2.api:132
u8 host_bridge[64]
Definition: tap.h:83
description fragment has unexpected format
Definition: map.api:433
int tap_delete_if(vlib_main_t *vm, u32 sw_if_index)
Definition: tap.c:787
vl_api_ip6_address_t host_ip6_gw
Definition: tapv2.api:90
unsigned int u32
Definition: types.h:88
u16 tx_ring_sz[default=256]
Definition: tapv2.api:77
u16 rx_ring_sz[default=256]
Definition: tapv2.api:78
#define MIN(x, y)
Definition: node.h:31
vl_api_interface_index_t sw_if_index
Definition: tapv2.api:110
mac_address_t host_mac_addr
Definition: tap.h:80
vl_api_tap_flags_t tap_flags
Definition: tapv2.api:161
ip4_address_t host_ip4_gw
Definition: tap.h:57
ip6_address_t host_ip6_addr
Definition: tap.h:59
u32 vl_api_string_len(vl_api_string_t *astr)
Definition: api_shared.c:1170
u8 host_ip4_prefix_len
Definition: tap.h:56
vl_api_ip4_address_with_prefix_t host_ip4_prefix
Definition: tapv2.api:84
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:227
ip4_address_t host_ip4_addr
Definition: tap.h:84
An API client registration, only in vpp/vlib.
Definition: api_common.h:47
#define BAD_SW_IF_INDEX_LABEL
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:380
vl_api_tap_flags_t tap_flags
Definition: tapv2.api:91
u32 host_mtu_size
Definition: tap.h:64
static void vl_api_tap_delete_v2_t_handler(vl_api_tap_delete_v2_t *mp)
Definition: tapv2_api.c:175
vl_api_ip4_address_t host_ip4_gw
Definition: tapv2.api:88
VLIB_API_INIT_FUNCTION(tapv2_api_hookup)
Initialize a new tap interface with the given parameters.
Definition: tapv2.api:69
#define ARRAY_LEN(x)
Definition: clib.h:67
static vl_api_registration_t * vl_api_client_index_to_registration(u32 index)
Definition: api.h:79
vl_api_interface_index_t sw_if_index
Definition: tapv2.api:122
u8 * host_bridge
Definition: tap.h:54
ip6_address_t host_ip6_gw
Definition: tap.h:61
u8 * host_if_name
Definition: tap.h:52
static void vnet_set_sw_interface_tag(vnet_main_t *vnm, u8 *tag, u32 sw_if_index)
void ip6_address_encode(const ip6_address_t *in, vl_api_ip6_address_t out)
Definition: ip_types_api.c:137
string host_namespace[64]
Definition: tapv2.api:93
static vlib_main_t * vlib_get_main(void)
Definition: global_funcs.h:23
u8 host_ip6_gw_set
Definition: tap.h:62
void tap_create_if(vlib_main_t *vm, tap_create_if_args_t *args)
Definition: tap.c:137
u8 num_rx_queues[default=1]
Definition: tapv2.api:76
vl_api_mac_address_t host_mac_addr
Definition: tapv2.api:82
#define STATIC_ASSERT(truth,...)
#define foreach_tapv2_api_msg
Definition: tapv2_api.c:50
void ip4_address_decode(const vl_api_ip4_address_t in, ip4_address_t *out)
Definition: ip_types_api.c:155
Delete tap interface.
Definition: tapv2.api:118
mac_address_t host_mac_addr
Definition: tap.h:53
mac_address_t mac_addr
Definition: tap.h:46
ip6_address_t host_ip6_addr
Definition: tap.h:86
static api_main_t * vlibapi_get_main(void)
Definition: api_common.h:389
TAP interface details struct.
Definition: tap.h:72
void ip4_address_encode(const ip4_address_t *in, vl_api_ip4_address_t out)
Definition: ip_types_api.c:149
#define vec_foreach(var, vec)
Vector iterator.
u8 * host_namespace
Definition: tap.h:51
string host_if_name[64]
Definition: tapv2.api:95
vpe_api_main_t vpe_api_main
Definition: interface_api.c:54
Reply for tap create reply.
Definition: tapv2.api:106
void mac_address_decode(const u8 *in, mac_address_t *out)
Conversion functions to/from (decode/encode) API types to VPP internal types.
u8 * vl_api_from_api_to_new_vec(void *mp, vl_api_string_t *astr)
Definition: api_shared.c:1188
vl_api_mac_address_t host_mac_addr
Definition: tapv2.api:158
string host_bridge[64]
Definition: tapv2.api:97
vl_api_interface_index_t sw_if_index
Definition: wireguard.api:34
vl_api_ip6_address_with_prefix_t host_ip6_prefix
Definition: tapv2.api:160
bool use_random_mac[default=true]
Definition: tapv2.api:74
#define VALIDATE_SW_IF_INDEX(mp)
static void vl_api_tap_create_v2_t_handler(vl_api_tap_create_v2_t *mp)
Definition: tapv2_api.c:56
vl_api_ip6_address_with_prefix_t host_ip6_prefix
Definition: tapv2.api:86