FD.io VPP  v20.05.1-6-gf53edbc3b
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 = mp->host_if_name;
87 
88  if (mp->host_mac_addr_set)
89  {
91  }
92 
93  if (mp->host_namespace_set)
95 
96  if (mp->host_bridge_set)
97  ap->host_bridge = mp->host_bridge;
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  ap->tap_flags = ntohl (mp->tap_flags);
130 
131  tap_create_if (vm, ap);
132 
133 
134  /* If a tag was supplied... */
135  if (vl_api_string_len (&mp->tag))
136  {
137  u8 *tag = vl_api_from_api_to_new_vec (mp, &mp->tag);
138  vnet_set_sw_interface_tag (vnm, tag, ap->sw_if_index);
139  }
140 
141  rmp = vl_msg_api_alloc (sizeof (*rmp));
142  rmp->_vl_msg_id = ntohs (VL_API_TAP_CREATE_V2_REPLY);
143  rmp->context = mp->context;
144  rmp->retval = ntohl (ap->rv);
145  rmp->sw_if_index = ntohl (ap->sw_if_index);
146 
147  vl_api_send_msg (reg, (u8 *) rmp);
148 }
149 
150 static void
152 {
155  if (!reg)
156  return;
157 
158  vnet_main_t *vnm = vnet_get_main ();
160  int rv;
161  vl_api_tap_delete_v2_reply_t *rmp;
162 
163  u32 sw_if_index = ntohl (mp->sw_if_index);
164 
165  rv = tap_delete_if (vm, sw_if_index);
166 
167  rmp = vl_msg_api_alloc (sizeof (*rmp));
168  rmp->_vl_msg_id = ntohs (VL_API_TAP_DELETE_V2_REPLY);
169  rmp->context = mp->context;
170  rmp->retval = ntohl (rv);
171 
172  vl_api_send_msg (reg, (u8 *) rmp);
173 
174  if (!rv)
175  vnet_clear_sw_interface_tag (vnm, sw_if_index);
176 }
177 
178 static void
180  vl_api_registration_t * reg,
181  tap_interface_details_t * tap_if, u32 context)
182 {
184  mp = vl_msg_api_alloc (sizeof (*mp));
185  clib_memset (mp, 0, sizeof (*mp));
186  mp->_vl_msg_id = htons (VL_API_SW_INTERFACE_TAP_V2_DETAILS);
187  mp->id = htonl (tap_if->id);
188  mp->sw_if_index = htonl (tap_if->sw_if_index);
189  mp->tap_flags = htonl (tap_if->tap_flags);
190  clib_memcpy (mp->dev_name, tap_if->dev_name,
191  MIN (ARRAY_LEN (mp->dev_name) - 1,
192  strlen ((const char *) tap_if->dev_name)));
193  mp->rx_ring_sz = htons (tap_if->rx_ring_sz);
194  mp->tx_ring_sz = htons (tap_if->tx_ring_sz);
196  clib_memcpy (mp->host_if_name, tap_if->host_if_name,
197  MIN (ARRAY_LEN (mp->host_if_name) - 1,
198  strlen ((const char *) tap_if->host_if_name)));
200  MIN (ARRAY_LEN (mp->host_namespace) - 1,
201  strlen ((const char *) tap_if->host_namespace)));
202  clib_memcpy (mp->host_bridge, tap_if->host_bridge,
203  MIN (ARRAY_LEN (mp->host_bridge) - 1,
204  strlen ((const char *) tap_if->host_bridge)));
205  mp->host_mtu_size = htonl (tap_if->host_mtu_size);
207 
208  if (tap_if->host_ip4_prefix_len)
209  ip4_address_encode (&tap_if->host_ip4_addr, mp->host_ip4_prefix.address);
210  mp->host_ip4_prefix.len = tap_if->host_ip4_prefix_len;
211  if (tap_if->host_ip6_prefix_len)
212  ip6_address_encode (&tap_if->host_ip6_addr, mp->host_ip6_prefix.address);
213  mp->host_ip6_prefix.len = tap_if->host_ip6_prefix_len;
214 
215  mp->context = context;
216  vl_api_send_msg (reg, (u8 *) mp);
217 }
218 
219 static void
221  mp)
222 {
223  int rv;
226  tap_interface_details_t *tapifs = NULL;
227  tap_interface_details_t *tap_if = NULL;
228  u32 filter_sw_if_index;
229 
231  if (!reg)
232  return;
233 
234  filter_sw_if_index = htonl (mp->sw_if_index);
235  if (mp->sw_if_index != ~0)
237 
238  rv = tap_dump_ifs (&tapifs);
239  if (rv)
240  return;
241 
242  vec_foreach (tap_if, tapifs)
243  {
244  if ((filter_sw_if_index == ~0)
245  || (tap_if->sw_if_index == filter_sw_if_index))
246  tap_send_sw_interface_details (am, reg, tap_if, mp->context);
247  }
249  vec_free (tapifs);
250 }
251 
252 #define vl_msg_name_crc_list
253 #include <vnet/vnet_all_api_h.h>
254 #undef vl_msg_name_crc_list
255 
256 static void
258 {
259 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
260  foreach_vl_msg_name_crc_tapv2;
261 #undef _
262 }
263 
264 static clib_error_t *
266 {
267  api_main_t *am = vlibapi_get_main ();
268 
269 #define _(N,n) \
270  vl_msg_api_set_handlers(VL_API_##N, #n, \
271  vl_api_##n##_t_handler, \
272  vl_noop_handler, \
273  vl_api_##n##_t_endian, \
274  vl_api_##n##_t_print, \
275  sizeof(vl_api_##n##_t), 1);
277 #undef _
278 
279  /*
280  * Set up the (msg_name, crc, message-id) table
281  */
283 
284  return 0;
285 }
286 
288 
289 /*
290  * fd.io coding-style-patch-verification: ON
291  *
292  * Local Variables:
293  * eval: (c-set-style "gnu")
294  * End:
295  */
static void vl_api_sw_interface_tap_v2_dump_t_handler(vl_api_sw_interface_tap_v2_dump_t *mp)
Definition: tapv2_api.c:220
vl_api_ip4_address_with_prefix_t host_ip4_prefix
Definition: tapv2.api:157
u8 host_if_name[64]
Definition: tap.h:79
u8 host_namespace[64]
Definition: tap.h:80
ip4_address_t host_ip4_addr
Definition: tap.h:53
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:257
void mac_address_encode(const mac_address_t *in, u8 *out)
Reply for tap dump request.
Definition: tapv2.api:148
u32 id[default=0xffffffff]
Definition: tapv2.api:71
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:58
void ip6_address_decode(const vl_api_ip6_address_t in, ip6_address_t *out)
Definition: ip_types_api.c:117
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:179
static clib_error_t * tapv2_api_hookup(vlib_main_t *vm)
Definition: tapv2_api.c:265
void * vl_msg_api_alloc(int nbytes)
int tap_dump_ifs(tap_interface_details_t **out_tapids)
Definition: tap.c:923
vl_api_mac_address_t mac_address
Definition: tapv2.api:73
u8 host_ip4_gw_set
Definition: tap.h:56
unsigned char u8
Definition: types.h:56
#define clib_memcpy(d, s, n)
Definition: string.h:180
Dump tap interfaces request.
Definition: tapv2.api:126
vl_api_interface_index_t sw_if_index[default=0xffffffff]
Definition: tapv2.api:130
u8 host_bridge[64]
Definition: tap.h:81
vl_api_interface_index_t sw_if_index
Definition: gre.api:53
int tap_delete_if(vlib_main_t *vm, u32 sw_if_index)
Definition: tap.c:773
vl_api_ip6_address_t host_ip6_gw
Definition: tapv2.api:88
unsigned int u32
Definition: types.h:88
u16 tx_ring_sz[default=256]
Definition: tapv2.api:75
u16 rx_ring_sz[default=256]
Definition: tapv2.api:76
#define MIN(x, y)
Definition: node.h:31
vl_api_interface_index_t sw_if_index
Definition: tapv2.api:108
mac_address_t host_mac_addr
Definition: tap.h:78
vl_api_tap_flags_t tap_flags
Definition: tapv2.api:159
ip4_address_t host_ip4_gw
Definition: tap.h:55
ip6_address_t host_ip6_addr
Definition: tap.h:57
u32 vl_api_string_len(vl_api_string_t *astr)
Definition: api_shared.c:1138
u8 host_ip4_prefix_len
Definition: tap.h:54
vlib_main_t * vm
Definition: in2out_ed.c:1599
vl_api_ip4_address_with_prefix_t host_ip4_prefix
Definition: tapv2.api:82
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:226
ip4_address_t host_ip4_addr
Definition: tap.h:82
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:89
u32 host_mtu_size
Definition: tap.h:62
static void vl_api_tap_delete_v2_t_handler(vl_api_tap_delete_v2_t *mp)
Definition: tapv2_api.c:151
vl_api_ip4_address_t host_ip4_gw
Definition: tapv2.api:86
VLIB_API_INIT_FUNCTION(tapv2_api_hookup)
Initialize a new tap interface with the given parameters.
Definition: tapv2.api:67
#define ARRAY_LEN(x)
Definition: clib.h:66
static vl_api_registration_t * vl_api_client_index_to_registration(u32 index)
Definition: api.h:57
vl_api_interface_index_t sw_if_index
Definition: tapv2.api:120
u8 * host_bridge
Definition: tap.h:52
ip6_address_t host_ip6_gw
Definition: tap.h:59
u8 * host_if_name
Definition: tap.h:50
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:111
string host_namespace[64]
Definition: tapv2.api:91
static vlib_main_t * vlib_get_main(void)
Definition: global_funcs.h:23
u8 host_ip6_gw_set
Definition: tap.h:60
void tap_create_if(vlib_main_t *vm, tap_create_if_args_t *args)
Definition: tap.c:133
u8 num_rx_queues[default=1]
Definition: tapv2.api:74
vl_api_mac_address_t host_mac_addr
Definition: tapv2.api:80
#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:129
Delete tap interface.
Definition: tapv2.api:116
mac_address_t host_mac_addr
Definition: tap.h:51
mac_address_t mac_addr
Definition: tap.h:44
ip6_address_t host_ip6_addr
Definition: tap.h:84
static api_main_t * vlibapi_get_main(void)
Definition: api_common.h:379
TAP interface details struct.
Definition: tap.h:70
void ip4_address_encode(const ip4_address_t *in, vl_api_ip4_address_t out)
Definition: ip_types_api.c:123
#define vec_foreach(var, vec)
Vector iterator.
u8 * host_namespace
Definition: tap.h:49
string host_if_name[64]
Definition: tapv2.api:93
vpe_api_main_t vpe_api_main
Definition: interface_api.c:54
Reply for tap create reply.
Definition: tapv2.api:104
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:1156
vl_api_mac_address_t host_mac_addr
Definition: tapv2.api:156
string host_bridge[64]
Definition: tapv2.api:95
vl_api_ip6_address_with_prefix_t host_ip6_prefix
Definition: tapv2.api:158
bool use_random_mac[default=true]
Definition: tapv2.api:72
#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:84