FD.io VPP  v18.01.2-1-g9b554f3
Vector Packet Processing
tap_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) 2016 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 #include <vnet/unix/tuntap.h>
28 #include <vnet/unix/tapcli.h>
29 
30 #include <vnet/vnet_msg_enum.h>
31 
32 #define vl_typedefs /* define message structures */
33 #include <vnet/vnet_all_api_h.h>
34 #undef vl_typedefs
35 
36 #define vl_endianfun /* define message structures */
37 #include <vnet/vnet_all_api_h.h>
38 #undef vl_endianfun
39 
40 /* instantiate all the print functions we know about */
41 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
42 #define vl_printfun
43 #include <vnet/vnet_all_api_h.h>
44 #undef vl_printfun
45 
47 
48 #define foreach_tap_api_msg \
49 _(TAP_CONNECT, tap_connect) \
50 _(TAP_MODIFY, tap_modify) \
51 _(TAP_DELETE, tap_delete) \
52 _(SW_INTERFACE_TAP_DUMP, sw_interface_tap_dump)
53 
54 #define vl_msg_name_crc_list
55 #include <vnet/unix/tap.api.h>
56 #undef vl_msg_name_crc_list
57 
58 /*
59  * WARNING: replicated pending api refactor completion
60  */
61 static void
64  u32 sw_if_index)
65 {
67 
68  mp = vl_msg_api_alloc (sizeof (*mp));
69  memset (mp, 0, sizeof (*mp));
70  mp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_EVENT);
71  mp->sw_if_index = ntohl (sw_if_index);
72 
73  mp->admin_up_down = 0;
74  mp->link_up_down = 0;
75  mp->deleted = 1;
76  vl_msg_api_send_shmem (q, (u8 *) & mp);
77 }
78 
79 static void
81 {
83  int rv;
85  vnet_main_t *vnm = vnet_get_main ();
87  u32 sw_if_index = (u32) ~ 0;
88  u8 *tag;
89  vnet_tap_connect_args_t _a, *ap = &_a;
90 
91  memset (ap, 0, sizeof (*ap));
92 
93  ap->intfc_name = mp->tap_name;
94  if (!mp->use_random_mac)
95  ap->hwaddr_arg = mp->mac_address;
96  ap->renumber = mp->renumber;
97  ap->sw_if_indexp = &sw_if_index;
98  ap->custom_dev_instance = ntohl (mp->custom_dev_instance);
99  if (mp->ip4_address_set)
100  {
101  ap->ip4_address = (ip4_address_t *) mp->ip4_address;
102  ap->ip4_mask_width = mp->ip4_mask_width;
103  ap->ip4_address_set = 1;
104  }
105  if (mp->ip6_address_set)
106  {
107  ap->ip6_address = (ip6_address_t *) mp->ip6_address;
108  ap->ip6_mask_width = mp->ip6_mask_width;
109  ap->ip6_address_set = 1;
110  }
111 
112  rv = vnet_tap_connect_renumber (vm, ap);
113 
114  /* Add tag if supplied */
115  if (rv == 0 && mp->tag[0])
116  {
117  mp->tag[ARRAY_LEN (mp->tag) - 1] = 0;
118  tag = format (0, "%s%c", mp->tag, 0);
119  vnet_set_sw_interface_tag (vnm, tag, sw_if_index);
120  }
121 
123  if (!q)
124  return;
125 
126  rmp = vl_msg_api_alloc (sizeof (*rmp));
127  rmp->_vl_msg_id = ntohs (VL_API_TAP_CONNECT_REPLY);
128  rmp->context = mp->context;
129  rmp->retval = ntohl (rv);
130  rmp->sw_if_index = ntohl (sw_if_index);
131 
132  vl_msg_api_send_shmem (q, (u8 *) & rmp);
133 }
134 
135 static void
137 {
138  int rv;
141  u32 sw_if_index = (u32) ~ 0;
143  vnet_tap_connect_args_t _a, *ap = &_a;
144 
145  memset (ap, 0, sizeof (*ap));
146 
147  ap->orig_sw_if_index = ntohl (mp->sw_if_index);
148  ap->intfc_name = mp->tap_name;
149  if (!mp->use_random_mac)
150  ap->hwaddr_arg = mp->mac_address;
151  ap->sw_if_indexp = &sw_if_index;
152  ap->renumber = mp->renumber;
153  ap->custom_dev_instance = ntohl (mp->custom_dev_instance);
154 
155  rv = vnet_tap_modify (vm, ap);
156 
158  if (!q)
159  return;
160 
161  rmp = vl_msg_api_alloc (sizeof (*rmp));
162  rmp->_vl_msg_id = ntohs (VL_API_TAP_MODIFY_REPLY);
163  rmp->context = mp->context;
164  rmp->retval = ntohl (rv);
165  rmp->sw_if_index = ntohl (sw_if_index);
166 
167  vl_msg_api_send_shmem (q, (u8 *) & rmp);
168 }
169 
170 static void
172 {
174  int rv;
176  vl_api_tap_delete_reply_t *rmp;
178  u32 sw_if_index = ntohl (mp->sw_if_index);
179 
180  rv = vnet_tap_delete (vm, sw_if_index);
181  if (!rv)
182  {
183  vnet_main_t *vnm = vnet_get_main ();
184  vnet_clear_sw_interface_tag (vnm, sw_if_index);
185  }
186 
188  if (!q)
189  return;
190 
191  rmp = vl_msg_api_alloc (sizeof (*rmp));
192  rmp->_vl_msg_id = ntohs (VL_API_TAP_DELETE_REPLY);
193  rmp->context = mp->context;
194  rmp->retval = ntohl (rv);
195 
196  vl_msg_api_send_shmem (q, (u8 *) & rmp);
197 
198  if (!rv)
199  send_sw_interface_event_deleted (vam, q, sw_if_index);
200 }
201 
202 static void
206  u32 context)
207 {
209  mp = vl_msg_api_alloc (sizeof (*mp));
210  memset (mp, 0, sizeof (*mp));
211  mp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_TAP_DETAILS);
212  mp->sw_if_index = ntohl (tap_if->sw_if_index);
213  strncpy ((char *) mp->dev_name,
214  (char *) tap_if->dev_name, ARRAY_LEN (mp->dev_name) - 1);
215  mp->context = context;
216 
217  vl_msg_api_send_shmem (q, (u8 *) & mp);
218 }
219 
220 static void
222 {
223  int rv = 0;
228 
230  if (q == 0)
231  return;
232 
233  rv = vnet_tap_dump_ifs (&tapifs);
234  if (rv)
235  return;
236 
237  vec_foreach (tap_if, tapifs)
238  {
239  send_sw_interface_tap_details (am, q, tap_if, mp->context);
240  }
241 
242  vec_free (tapifs);
243 }
244 
245 static void
247 {
248 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
249  foreach_vl_msg_name_crc_tap;
250 #undef _
251 }
252 
253 static clib_error_t *
255 {
256  api_main_t *am = &api_main;
257 
258 #define _(N,n) \
259  vl_msg_api_set_handlers(VL_API_##N, #n, \
260  vl_api_##n##_t_handler, \
261  vl_noop_handler, \
262  vl_api_##n##_t_endian, \
263  vl_api_##n##_t_print, \
264  sizeof(vl_api_##n##_t), 1);
266 #undef _
267 
268  /*
269  * Set up the (msg_name, crc, message-id) table
270  */
272 
273  return 0;
274 }
275 
277 
278 /*
279  * fd.io coding-style-patch-verification: ON
280  *
281  * Local Variables:
282  * eval: (c-set-style "gnu")
283  * End:
284  */
static void send_sw_interface_tap_details(vpe_api_main_t *am, unix_shared_memory_queue_t *q, tapcli_interface_details_t *tap_if, u32 context)
Definition: tap_api.c:203
u8 * intfc_name
Interface name.
Definition: tuntap.h:31
vnet_main_t * vnet_get_main(void)
Definition: misc.c:47
int vnet_tap_connect_renumber(vlib_main_t *vm, vnet_tap_connect_args_t *ap)
Renumber a TAP interface.
Definition: tapcli.c:1110
#define NULL
Definition: clib.h:55
u8 tap_name[64]
Definition: tap.api:75
u32 * sw_if_indexp
Output parameter: result sw_if_index.
Definition: tuntap.h:49
static void vnet_clear_sw_interface_tag(vnet_main_t *vnm, u32 sw_if_index)
u32 custom_dev_instance
Custom device instance.
Definition: tuntap.h:51
Dump tap interfaces request.
Definition: tap.api:106
static void setup_message_id_table(api_main_t *am)
Definition: tap_api.c:246
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:419
arguments structure for vnet_tap_connect, vnet_tap_connect_renumber, etc.
Definition: tuntap.h:28
TAP CLI interface details struct.
Definition: tapcli.h:42
int vnet_tap_modify(vlib_main_t *vm, vnet_tap_connect_args_t *ap)
Modifies tap interface - can result in new interface being created.
Definition: tapcli.c:1264
u32 custom_dev_instance
Definition: tap.api:78
static void send_sw_interface_event_deleted(vpe_api_main_t *am, unix_shared_memory_queue_t *q, u32 sw_if_index)
Definition: tap_api.c:62
static clib_error_t * tap_api_hookup(vlib_main_t *vm)
Definition: tap_api.c:254
u8 mac_address[6]
Definition: tap.api:76
TAPCLI definitions.
u8 ip6_address_set
Please set the indicated ip4 address/mask on the interface.
Definition: tuntap.h:37
#define foreach_tap_api_msg
Definition: tap_api.c:48
u32 ip4_mask_width
(optional) ip4 mask width to set
Definition: tuntap.h:43
u8 ip6_address[16]
Definition: tap.api:44
u8 tap_name[64]
Definition: tap.api:36
Initialize a new tap interface with the given paramters.
Definition: tap.api:31
void * vl_msg_api_alloc(int nbytes)
Reply for tap connect request.
Definition: tap.api:54
Delete tap interface.
Definition: tap.api:98
Call from VLIB_INIT_FUNCTION to set the Linux kernel inject node name.
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:198
u8 mac_address[6]
Definition: tap.api:37
api_main_t api_main
Definition: api_shared.c:35
u8 renumber
Renumber the (existing) interface.
Definition: tuntap.h:39
vlib_main_t * vm
Definition: buffer.c:283
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:336
unix_shared_memory_queue_t * vl_api_client_index_to_input_queue(u32 index)
#define ARRAY_LEN(x)
Definition: clib.h:59
void vl_msg_api_send_shmem(unix_shared_memory_queue_t *q, u8 *elem)
Reply for tap dump request.
Definition: tap.api:116
unsigned int u32
Definition: types.h:88
u8 ip4_address_set
Please set the indicated ip4 address/mask on the interface.
Definition: tuntap.h:35
Reply for tap modify request.
Definition: tap.api:86
static void vnet_set_sw_interface_tag(vnet_main_t *vnm, u8 *tag, u32 sw_if_index)
int vnet_tap_delete(vlib_main_t *vm, u32 sw_if_index)
Delete TAP interface.
Definition: tapcli.c:1167
ip4_address_t * ip4_address
(optional) ip4 address to set
Definition: tuntap.h:41
static vlib_main_t * vlib_get_main(void)
Definition: global_funcs.h:23
Interface Event generated by want_interface_events.
Definition: interface.api:41
VLIB_API_INIT_FUNCTION(tap_api_hookup)
unsigned char u8
Definition: types.h:56
u32 custom_dev_instance
Definition: tap.api:39
u8 ip4_address[4]
Definition: tap.api:41
u8 * hwaddr_arg
Mac address.
Definition: tuntap.h:33
Modify a tap interface with the given paramters.
Definition: tap.api:69
static void vl_api_sw_interface_tap_dump_t_handler(vl_api_sw_interface_tap_dump_t *mp)
Definition: tap_api.c:221
#define vec_foreach(var, vec)
Vector iterator.
static void vl_api_tap_connect_t_handler(vl_api_tap_connect_t *mp)
Definition: tap_api.c:80
vpe_api_main_t vpe_api_main
Definition: interface_api.c:49
int vnet_tap_dump_ifs(tapcli_interface_details_t **out_tapids)
Dump TAP interfaces.
Definition: tapcli.c:781
u32 ip6_mask_width
(optional) ip6 mask width to set
Definition: tuntap.h:47
u32 orig_sw_if_index
original sw_if_index (renumber)
Definition: tuntap.h:53
ip6_address_t * ip6_address
(optional) ip6 address to set
Definition: tuntap.h:45
static void vl_api_tap_delete_t_handler(vl_api_tap_delete_t *mp)
Definition: tap_api.c:171
static void vl_api_tap_modify_t_handler(vl_api_tap_modify_t *mp)
Definition: tap_api.c:136
struct _unix_shared_memory_queue unix_shared_memory_queue_t