FD.io VPP  v19.08.3-2-gbabecb413
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 
28 #include <vnet/vnet_msg_enum.h>
29 
30 #define vl_typedefs /* define message structures */
31 #include <vnet/vnet_all_api_h.h>
32 #undef vl_typedefs
33 
34 #define vl_endianfun /* define message structures */
35 #include <vnet/vnet_all_api_h.h>
36 #undef vl_endianfun
37 
38 /* instantiate all the print functions we know about */
39 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
40 #define vl_printfun
41 #include <vnet/vnet_all_api_h.h>
42 #undef vl_printfun
43 
45 #include <vnet/devices/tap/tap.h>
46 
47 #define foreach_tapv2_api_msg \
48 _(TAP_CREATE_V2, tap_create_v2) \
49 _(TAP_DELETE_V2, tap_delete_v2) \
50 _(SW_INTERFACE_TAP_V2_DUMP, sw_interface_tap_v2_dump)
51 
52 static void
54 {
55  vnet_main_t *vnm = vnet_get_main ();
59  tap_create_if_args_t _a, *ap = &_a;
60 
61  clib_memset (ap, 0, sizeof (*ap));
62 
63  ap->id = ntohl (mp->id);
64  if (!mp->use_random_mac)
65  {
66  clib_memcpy (ap->mac_addr, mp->mac_address, 6);
67  ap->mac_addr_set = 1;
68  }
69  ap->rx_ring_sz = ntohs (mp->rx_ring_sz);
70  ap->tx_ring_sz = ntohs (mp->tx_ring_sz);
71  ap->sw_if_index = (u32) ~ 0;
72 
73  if (mp->host_if_name_set)
74  ap->host_if_name = mp->host_if_name;
75 
76  if (mp->host_mac_addr_set)
77  {
79  ap->mac_addr_set = 1;
80  }
81 
82  if (mp->host_namespace_set)
84 
85  if (mp->host_bridge_set)
86  ap->host_bridge = mp->host_bridge;
87 
88  if (mp->host_ip4_addr_set)
89  {
92  }
93 
94  if (mp->host_ip6_addr_set)
95  {
96  clib_memcpy (&ap->host_ip6_addr, mp->host_ip6_addr, 16);
98  }
99 
100  if (mp->host_ip4_gw_set)
101  {
102  clib_memcpy (&ap->host_ip4_gw, mp->host_ip4_gw, 4);
103  ap->host_ip4_gw_set = 1;
104  }
105 
106  if (mp->host_ip6_gw_set)
107  {
108  clib_memcpy (&ap->host_ip6_gw, mp->host_ip6_gw, 16);
109  ap->host_ip6_gw_set = 1;
110  }
111 
112  if (mp->host_mtu_set)
113  {
114  ap->host_mtu_size = ntohl (mp->host_mtu_size);
115  ap->host_mtu_set = 1;
116  }
117 
118  ap->tap_flags = ntohl (mp->tap_flags);
119 
120  tap_create_if (vm, ap);
121 
123  if (!reg)
124  return;;
125 
126  /* If a tag was supplied... */
127  if (mp->tag[0])
128  {
129  /* Make sure it's a proper C-string */
130  mp->tag[ARRAY_LEN (mp->tag) - 1] = 0;
131  u8 *tag = format (0, "%s%c", mp->tag, 0);
132  vnet_set_sw_interface_tag (vnm, tag, ap->sw_if_index);
133  }
134 
135 
136  rmp = vl_msg_api_alloc (sizeof (*rmp));
137  rmp->_vl_msg_id = ntohs (VL_API_TAP_CREATE_V2_REPLY);
138  rmp->context = mp->context;
139  rmp->retval = ntohl (ap->rv);
140  rmp->sw_if_index = ntohl (ap->sw_if_index);
141 
142  vl_api_send_msg (reg, (u8 *) rmp);
143 }
144 
145 static void
147 {
148  vnet_main_t *vnm = vnet_get_main ();
150  int rv;
151  vl_api_tap_delete_v2_reply_t *rmp;
153  u32 sw_if_index = ntohl (mp->sw_if_index);
154 
155  rv = tap_delete_if (vm, sw_if_index);
156 
158  if (!reg)
159  return;
160 
161  rmp = vl_msg_api_alloc (sizeof (*rmp));
162  rmp->_vl_msg_id = ntohs (VL_API_TAP_DELETE_V2_REPLY);
163  rmp->context = mp->context;
164  rmp->retval = ntohl (rv);
165 
166  vl_api_send_msg (reg, (u8 *) rmp);
167 
168  if (!rv)
169  vnet_clear_sw_interface_tag (vnm, sw_if_index);
170 }
171 
172 static void
174  vl_api_registration_t * reg,
176 {
178  mp = vl_msg_api_alloc (sizeof (*mp));
179  clib_memset (mp, 0, sizeof (*mp));
180  mp->_vl_msg_id = htons (VL_API_SW_INTERFACE_TAP_V2_DETAILS);
181  mp->id = htonl (tap_if->id);
182  mp->sw_if_index = htonl (tap_if->sw_if_index);
183  mp->tap_flags = htonl (tap_if->tap_flags);
184  clib_memcpy (mp->dev_name, tap_if->dev_name,
185  MIN (ARRAY_LEN (mp->dev_name) - 1,
186  strlen ((const char *) tap_if->dev_name)));
187  mp->rx_ring_sz = htons (tap_if->rx_ring_sz);
188  mp->tx_ring_sz = htons (tap_if->tx_ring_sz);
189  clib_memcpy (mp->host_mac_addr, tap_if->host_mac_addr, 6);
190  clib_memcpy (mp->host_if_name, tap_if->host_if_name,
191  MIN (ARRAY_LEN (mp->host_if_name) - 1,
192  strlen ((const char *) tap_if->host_if_name)));
194  MIN (ARRAY_LEN (mp->host_namespace) - 1,
195  strlen ((const char *) tap_if->host_namespace)));
196  clib_memcpy (mp->host_bridge, tap_if->host_bridge,
197  MIN (ARRAY_LEN (mp->host_bridge) - 1,
198  strlen ((const char *) tap_if->host_bridge)));
199  mp->host_mtu_size = htonl (tap_if->host_mtu_size);
200  if (tap_if->host_ip4_prefix_len)
201  clib_memcpy (&mp->host_ip4_addr, &tap_if->host_ip4_addr, 4);
203  if (tap_if->host_ip6_prefix_len)
204  clib_memcpy (&mp->host_ip6_addr, &tap_if->host_ip6_addr, 16);
206 
207  mp->context = context;
208  vl_api_send_msg (reg, (u8 *) mp);
209 }
210 
211 static void
213  mp)
214 {
215  int rv;
218  tap_interface_details_t *tapifs = NULL;
219  tap_interface_details_t *tap_if = NULL;
220 
222  if (!reg)
223  return;
224 
225  rv = tap_dump_ifs (&tapifs);
226  if (rv)
227  return;
228 
229  vec_foreach (tap_if, tapifs)
230  {
231  tap_send_sw_interface_details (am, reg, tap_if, mp->context);
232  }
233 
234  vec_free (tapifs);
235 }
236 
237 #define vl_msg_name_crc_list
238 #include <vnet/vnet_all_api_h.h>
239 #undef vl_msg_name_crc_list
240 
241 static void
243 {
244 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
245  foreach_vl_msg_name_crc_tapv2;
246 #undef _
247 }
248 
249 static clib_error_t *
251 {
252  api_main_t *am = &api_main;
253 
254 #define _(N,n) \
255  vl_msg_api_set_handlers(VL_API_##N, #n, \
256  vl_api_##n##_t_handler, \
257  vl_noop_handler, \
258  vl_api_##n##_t_endian, \
259  vl_api_##n##_t_print, \
260  sizeof(vl_api_##n##_t), 1);
262 #undef _
263 
264  /*
265  * Set up the (msg_name, crc, message-id) table
266  */
268 
269  return 0;
270 }
271 
273 
274 /*
275  * fd.io coding-style-patch-verification: ON
276  *
277  * Local Variables:
278  * eval: (c-set-style "gnu")
279  * End:
280  */
static void vl_api_sw_interface_tap_v2_dump_t_handler(vl_api_sw_interface_tap_v2_dump_t *mp)
Definition: tapv2_api.c:212
u8 host_if_name[64]
Definition: tap.h:64
u8 host_namespace[64]
Definition: tap.h:65
ip4_address_t host_ip4_addr
Definition: tap.h:38
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:242
Reply for tap dump request.
Definition: tapv2.api:134
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:43
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:173
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
static clib_error_t * tapv2_api_hookup(vlib_main_t *vm)
Definition: tapv2_api.c:250
void * vl_msg_api_alloc(int nbytes)
int tap_dump_ifs(tap_interface_details_t **out_tapids)
Definition: tap.c:576
u8 host_ip4_gw_set
Definition: tap.h:41
unsigned char u8
Definition: types.h:56
#define clib_memcpy(d, s, n)
Definition: string.h:180
Dump tap interfaces request.
Definition: tapv2.api:112
u8 host_bridge[64]
Definition: tap.h:66
u8 host_ip6_addr[16]
Definition: tap.h:69
u8 host_mac_addr[6]
Definition: tap.h:63
vl_api_interface_index_t sw_if_index
Definition: gre.api:50
int tap_delete_if(vlib_main_t *vm, u32 sw_if_index)
Definition: tap.c:474
u8 host_mac_addr[6]
Definition: tap.h:36
unsigned int u32
Definition: types.h:88
#define MIN(x, y)
Definition: node.h:31
u8 host_ip4_addr[4]
Definition: tap.h:67
ip4_address_t host_ip4_gw
Definition: tap.h:40
ip6_address_t host_ip6_addr
Definition: tap.h:42
u8 host_ip4_prefix_len
Definition: tap.h:39
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:203
An API client registration, only in vpp/vlib.
Definition: api_common.h:46
vlib_main_t * vm
Definition: buffer.c:323
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:341
u32 host_mtu_size
Definition: tap.h:47
static void vl_api_tap_delete_v2_t_handler(vl_api_tap_delete_v2_t *mp)
Definition: tapv2_api.c:146
VLIB_API_INIT_FUNCTION(tapv2_api_hookup)
Initialize a new tap interface with the given paramters.
Definition: tapv2.api:54
#define ARRAY_LEN(x)
Definition: clib.h:63
static vl_api_registration_t * vl_api_client_index_to_registration(u32 index)
Definition: api.h:57
u8 * host_bridge
Definition: tap.h:37
ip6_address_t host_ip6_gw
Definition: tap.h:44
u8 * host_if_name
Definition: tap.h:35
static void vnet_set_sw_interface_tag(vnet_main_t *vnm, u8 *tag, u32 sw_if_index)
static vlib_main_t * vlib_get_main(void)
Definition: global_funcs.h:23
u8 host_ip6_gw_set
Definition: tap.h:45
void tap_create_if(vlib_main_t *vm, tap_create_if_args_t *args)
Definition: tap.c:82
#define foreach_tapv2_api_msg
Definition: tapv2_api.c:47
u8 mac_addr[6]
Definition: tap.h:29
Delete tap interface.
Definition: tapv2.api:104
TAP interface details struct.
Definition: tap.h:55
#define vec_foreach(var, vec)
Vector iterator.
u8 * host_namespace
Definition: tap.h:34
vpe_api_main_t vpe_api_main
Definition: interface_api.c:49
Reply for tap create reply.
Definition: tapv2.api:92
u32 context
Definition: gre.api:45
api_main_t api_main
Definition: api_shared.c:35
static void vl_api_tap_create_v2_t_handler(vl_api_tap_create_v2_t *mp)
Definition: tapv2_api.c:53