FD.io VPP  v18.01.2-1-g9b554f3
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 {
58  tap_create_if_args_t _a, *ap = &_a;
59 
60  memset (ap, 0, sizeof (*ap));
61 
62  ap->id = mp->id;
63  if (!mp->use_random_mac)
64  {
65  clib_memcpy (ap->mac_addr, mp->mac_address, 6);
66  ap->mac_addr_set = 1;
67  }
68  ap->rx_ring_sz = ntohs (mp->rx_ring_sz);
69  ap->tx_ring_sz = ntohs (mp->tx_ring_sz);
70  ap->sw_if_index = (u32) ~ 0;
71 
72  if (mp->host_if_name_set)
73  ap->host_if_name = mp->host_if_name;
74 
75  if (mp->host_mac_addr_set)
76  {
78  ap->mac_addr_set = 1;
79  }
80 
81  if (mp->host_namespace_set)
83 
84  if (mp->host_bridge_set)
85  ap->host_bridge = mp->host_bridge;
86 
87  if (mp->host_ip4_addr_set)
88  {
91  }
92 
93  if (mp->host_ip6_addr_set)
94  {
95  clib_memcpy (&ap->host_ip6_addr, mp->host_ip6_addr, 16);
97  }
98 
99  tap_create_if (vm, ap);
100 
102  if (!q)
103  return;
104 
105  rmp = vl_msg_api_alloc (sizeof (*rmp));
106  rmp->_vl_msg_id = ntohs (VL_API_TAP_CREATE_V2_REPLY);
107  rmp->context = mp->context;
108  rmp->retval = ntohl (ap->rv);
109  rmp->sw_if_index = ntohl (ap->sw_if_index);
110 
111  vl_msg_api_send_shmem (q, (u8 *) & rmp);
112 }
113 
114 static void
117  u32 sw_if_index)
118 {
120 
121  mp = vl_msg_api_alloc (sizeof (*mp));
122  memset (mp, 0, sizeof (*mp));
123  mp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_EVENT);
124  mp->sw_if_index = ntohl (sw_if_index);
125 
126  mp->admin_up_down = 0;
127  mp->link_up_down = 0;
128  mp->deleted = 1;
129  vl_msg_api_send_shmem (q, (u8 *) & mp);
130 }
131 
132 static void
134 {
136  int rv;
138  vl_api_tap_delete_v2_reply_t *rmp;
140  u32 sw_if_index = ntohl (mp->sw_if_index);
141 
142  rv = tap_delete_if (vm, sw_if_index);
143 
145  if (!q)
146  return;
147 
148  rmp = vl_msg_api_alloc (sizeof (*rmp));
149  rmp->_vl_msg_id = ntohs (VL_API_TAP_DELETE_V2_REPLY);
150  rmp->context = mp->context;
151  rmp->retval = ntohl (rv);
152 
153  vl_msg_api_send_shmem (q, (u8 *) & rmp);
154 
155  if (!rv)
156  tap_send_sw_interface_event_deleted (vam, q, sw_if_index);
157 }
158 
159 static void
162  tap_interface_details_t * tap_if, u32 context)
163 {
165  mp = vl_msg_api_alloc (sizeof (*mp));
166  memset (mp, 0, sizeof (*mp));
167  mp->_vl_msg_id = htons (VL_API_SW_INTERFACE_TAP_V2_DETAILS);
168  mp->id = htonl (tap_if->id);
169  mp->sw_if_index = htonl (tap_if->sw_if_index);
170  clib_memcpy (mp->dev_name, tap_if->dev_name,
171  MIN (ARRAY_LEN (mp->dev_name) - 1,
172  strlen ((const char *) tap_if->dev_name)));
173  mp->rx_ring_sz = htons (tap_if->rx_ring_sz);
174  mp->tx_ring_sz = htons (tap_if->tx_ring_sz);
175  clib_memcpy (mp->host_mac_addr, tap_if->host_mac_addr, 6);
176  clib_memcpy (mp->host_if_name, tap_if->host_if_name,
177  MIN (ARRAY_LEN (mp->host_if_name) - 1,
178  strlen ((const char *) tap_if->host_if_name)));
180  MIN (ARRAY_LEN (mp->host_namespace) - 1,
181  strlen ((const char *) tap_if->host_namespace)));
182  clib_memcpy (mp->host_bridge, tap_if->host_bridge,
183  MIN (ARRAY_LEN (mp->host_bridge) - 1,
184  strlen ((const char *) tap_if->host_bridge)));
185  if (tap_if->host_ip4_prefix_len)
186  clib_memcpy (&mp->host_ip4_addr, &tap_if->host_ip4_addr, 4);
188  if (tap_if->host_ip6_prefix_len)
189  clib_memcpy (&mp->host_ip6_addr, &tap_if->host_ip6_addr, 16);
191 
192  mp->context = context;
193  vl_msg_api_send_shmem (q, (u8 *) & mp);
194 }
195 
196 static void
198  mp)
199 {
200  int rv;
203  tap_interface_details_t *tapifs = NULL;
204  tap_interface_details_t *tap_if = NULL;
205 
207  if (q == 0)
208  return;
209 
210  rv = tap_dump_ifs (&tapifs);
211  if (rv)
212  return;
213 
214  vec_foreach (tap_if, tapifs)
215  {
216  tap_send_sw_interface_details (am, q, tap_if, mp->context);
217  }
218 
219  vec_free (tapifs);
220 }
221 
222 #define vl_msg_name_crc_list
223 #include <vnet/vnet_all_api_h.h>
224 #undef vl_msg_name_crc_list
225 
226 static void
228 {
229 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
230  foreach_vl_msg_name_crc_tapv2;
231 #undef _
232 }
233 
234 static clib_error_t *
236 {
237  api_main_t *am = &api_main;
238 
239 #define _(N,n) \
240  vl_msg_api_set_handlers(VL_API_##N, #n, \
241  vl_api_##n##_t_handler, \
242  vl_noop_handler, \
243  vl_api_##n##_t_endian, \
244  vl_api_##n##_t_print, \
245  sizeof(vl_api_##n##_t), 1);
247 #undef _
248 
249  /*
250  * Set up the (msg_name, crc, message-id) table
251  */
253 
254  return 0;
255 }
256 
258 
259 /*
260  * fd.io coding-style-patch-verification: ON
261  *
262  * Local Variables:
263  * eval: (c-set-style "gnu")
264  * End:
265  */
static void vl_api_sw_interface_tap_v2_dump_t_handler(vl_api_sw_interface_tap_v2_dump_t *mp)
Definition: tapv2_api.c:197
u8 host_if_name[64]
Definition: tap.h:55
u8 host_namespace[64]
Definition: tap.h:56
ip4_address_t host_ip4_addr
Definition: tap.h:36
static void tap_setup_message_id_table(api_main_t *am)
Definition: tapv2_api.c:227
Reply for tap dump request.
Definition: tapv2.api:118
#define NULL
Definition: clib.h:55
u8 host_ip6_prefix_len
Definition: tap.h:39
static clib_error_t * tapv2_api_hookup(vlib_main_t *vm)
Definition: tapv2_api.c:235
int tap_dump_ifs(tap_interface_details_t **out_tapids)
Definition: tap.c:448
#define MIN(x, y)
Definition: tap.h:22
Dump tap interfaces request.
Definition: tapv2.api:97
u8 host_bridge[64]
Definition: tap.h:57
u8 host_ip6_addr[16]
Definition: tap.h:60
u8 host_mac_addr[6]
Definition: tap.h:54
int tap_delete_if(vlib_main_t *vm, u32 sw_if_index)
Definition: tap.c:408
u8 host_mac_addr[6]
Definition: tap.h:34
void * vl_msg_api_alloc(int nbytes)
u8 host_ip4_addr[4]
Definition: tap.h:58
ip6_address_t host_ip6_addr
Definition: tap.h:38
u8 host_ip4_prefix_len
Definition: tap.h:37
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:198
api_main_t api_main
Definition: api_shared.c:35
vlib_main_t * vm
Definition: buffer.c:283
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:336
static void vl_api_tap_delete_v2_t_handler(vl_api_tap_delete_v2_t *mp)
Definition: tapv2_api.c:133
#define clib_memcpy(a, b, c)
Definition: string.h:75
unix_shared_memory_queue_t * vl_api_client_index_to_input_queue(u32 index)
VLIB_API_INIT_FUNCTION(tapv2_api_hookup)
Initialize a new tap interface with the given paramters.
Definition: tapv2.api:47
static void tap_send_sw_interface_details(vpe_api_main_t *am, unix_shared_memory_queue_t *q, tap_interface_details_t *tap_if, u32 context)
Definition: tapv2_api.c:160
#define ARRAY_LEN(x)
Definition: clib.h:59
u8 * host_bridge
Definition: tap.h:35
void vl_msg_api_send_shmem(unix_shared_memory_queue_t *q, u8 *elem)
unsigned int u32
Definition: types.h:88
u8 * host_if_name
Definition: tap.h:33
static vlib_main_t * vlib_get_main(void)
Definition: global_funcs.h:23
Interface Event generated by want_interface_events.
Definition: interface.api:41
void tap_create_if(vlib_main_t *vm, tap_create_if_args_t *args)
Definition: tap.c:80
unsigned char u8
Definition: types.h:56
#define foreach_tapv2_api_msg
Definition: tapv2_api.c:47
u8 mac_addr[6]
Definition: tap.h:29
Delete tap interface.
Definition: tapv2.api:89
static void tap_send_sw_interface_event_deleted(vpe_api_main_t *am, unix_shared_memory_queue_t *q, u32 sw_if_index)
Definition: tapv2_api.c:115
TAP interface details struct.
Definition: tap.h:47
#define vec_foreach(var, vec)
Vector iterator.
u8 * host_namespace
Definition: tap.h:32
vpe_api_main_t vpe_api_main
Definition: interface_api.c:49
Reply for tap create reply.
Definition: tapv2.api:77
struct _unix_shared_memory_queue unix_shared_memory_queue_t
static void vl_api_tap_create_v2_t_handler(vl_api_tap_create_v2_t *mp)
Definition: tapv2_api.c:53