FD.io VPP  v19.01.3-6-g70449b9b9
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 {
66 
67  mp = vl_msg_api_alloc (sizeof (*mp));
68  clib_memset (mp, 0, sizeof (*mp));
69  mp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_EVENT);
70  mp->sw_if_index = ntohl (sw_if_index);
71 
72  mp->admin_up_down = 0;
73  mp->link_up_down = 0;
74  mp->deleted = 1;
75  vl_api_send_msg (reg, (u8 *) mp);
76 }
77 
78 static void
80 {
82  int rv;
84  vnet_main_t *vnm = vnet_get_main ();
86  u32 sw_if_index = (u32) ~ 0;
87  u8 *tag;
88  vnet_tap_connect_args_t _a, *ap = &_a;
89 
90  clib_memset (ap, 0, sizeof (*ap));
91 
92  ap->intfc_name = mp->tap_name;
93  if (!mp->use_random_mac)
94  ap->hwaddr_arg = mp->mac_address;
95  ap->renumber = mp->renumber;
97  ap->custom_dev_instance = ntohl (mp->custom_dev_instance);
98  if (mp->ip4_address_set)
99  {
100  ap->ip4_address = (ip4_address_t *) mp->ip4_address;
101  ap->ip4_mask_width = mp->ip4_mask_width;
102  ap->ip4_address_set = 1;
103  }
104  if (mp->ip6_address_set)
105  {
106  ap->ip6_address = (ip6_address_t *) mp->ip6_address;
107  ap->ip6_mask_width = mp->ip6_mask_width;
108  ap->ip6_address_set = 1;
109  }
110 
111  rv = vnet_tap_connect_renumber (vm, ap);
112 
113  /* Add tag if supplied */
114  if (rv == 0 && mp->tag[0])
115  {
116  mp->tag[ARRAY_LEN (mp->tag) - 1] = 0;
117  tag = format (0, "%s%c", mp->tag, 0);
118  vnet_set_sw_interface_tag (vnm, tag, sw_if_index);
119  }
120 
122  if (!reg)
123  return;
124 
125  rmp = vl_msg_api_alloc (sizeof (*rmp));
126  rmp->_vl_msg_id = ntohs (VL_API_TAP_CONNECT_REPLY);
127  rmp->context = mp->context;
128  rmp->retval = ntohl (rv);
129  rmp->sw_if_index = ntohl (sw_if_index);
130 
131  vl_api_send_msg (reg, (u8 *) rmp);
132 }
133 
134 static void
136 {
137  int rv;
140  u32 sw_if_index = (u32) ~ 0;
142  vnet_tap_connect_args_t _a, *ap = &_a;
143 
144  clib_memset (ap, 0, sizeof (*ap));
145 
146  ap->orig_sw_if_index = ntohl (mp->sw_if_index);
147  ap->intfc_name = mp->tap_name;
148  if (!mp->use_random_mac)
149  ap->hwaddr_arg = mp->mac_address;
150  ap->sw_if_indexp = &sw_if_index;
151  ap->renumber = mp->renumber;
152  ap->custom_dev_instance = ntohl (mp->custom_dev_instance);
153 
154  rv = vnet_tap_modify (vm, ap);
155 
157  if (!reg)
158  return;
159 
160  rmp = vl_msg_api_alloc (sizeof (*rmp));
161  rmp->_vl_msg_id = ntohs (VL_API_TAP_MODIFY_REPLY);
162  rmp->context = mp->context;
163  rmp->retval = ntohl (rv);
164  rmp->sw_if_index = ntohl (sw_if_index);
165 
166  vl_api_send_msg (reg, (u8 *) rmp);
167 }
168 
169 static void
171 {
173  int rv;
175  vl_api_tap_delete_reply_t *rmp;
177  u32 sw_if_index = ntohl (mp->sw_if_index);
178 
179  rv = vnet_tap_delete (vm, sw_if_index);
180  if (!rv)
181  {
182  vnet_main_t *vnm = vnet_get_main ();
183  vnet_clear_sw_interface_tag (vnm, sw_if_index);
184  }
185 
187  if (!reg)
188  return;
189 
190  rmp = vl_msg_api_alloc (sizeof (*rmp));
191  rmp->_vl_msg_id = ntohs (VL_API_TAP_DELETE_REPLY);
192  rmp->context = mp->context;
193  rmp->retval = ntohl (rv);
194 
195  vl_api_send_msg (reg, (u8 *) rmp);
196 
197  if (!rv)
198  send_sw_interface_event_deleted (vam, reg, sw_if_index);
199 }
200 
201 static void
203  vl_api_registration_t * reg,
205  u32 context)
206 {
208  mp = vl_msg_api_alloc (sizeof (*mp));
209  clib_memset (mp, 0, sizeof (*mp));
210  mp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_TAP_DETAILS);
211  mp->sw_if_index = ntohl (tap_if->sw_if_index);
212  strncpy ((char *) mp->dev_name,
213  (char *) tap_if->dev_name, ARRAY_LEN (mp->dev_name) - 1);
214  mp->context = context;
215 
216  vl_api_send_msg (reg, (u8 *) mp);
217 }
218 
219 static void
221 {
222  int rv = 0;
227 
229  if (!reg)
230  return;
231 
232  rv = vnet_tap_dump_ifs (&tapifs);
233  if (rv)
234  return;
235 
236  vec_foreach (tap_if, tapifs)
237  {
238  send_sw_interface_tap_details (am, reg, tap_if, mp->context);
239  }
240 
241  vec_free (tapifs);
242 }
243 
244 static void
246 {
247 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
248  foreach_vl_msg_name_crc_tap;
249 #undef _
250 }
251 
252 static clib_error_t *
254 {
255  api_main_t *am = &api_main;
256 
257 #define _(N,n) \
258  vl_msg_api_set_handlers(VL_API_##N, #n, \
259  vl_api_##n##_t_handler, \
260  vl_noop_handler, \
261  vl_api_##n##_t_endian, \
262  vl_api_##n##_t_print, \
263  sizeof(vl_api_##n##_t), 1);
265 #undef _
266 
267  /*
268  * Set up the (msg_name, crc, message-id) table
269  */
271 
272  return 0;
273 }
274 
276 
277 /*
278  * fd.io coding-style-patch-verification: ON
279  *
280  * Local Variables:
281  * eval: (c-set-style "gnu")
282  * End:
283  */
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:1112
#define NULL
Definition: clib.h:58
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:34
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:245
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:1266
void * vl_msg_api_alloc(int nbytes)
unsigned char u8
Definition: types.h:56
u32 custom_dev_instance
Definition: tap.api:78
static clib_error_t * tap_api_hookup(vlib_main_t *vm)
Definition: tap_api.c:253
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
u32 sw_if_index
Definition: vxlan_gbp.api: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
unsigned int u32
Definition: types.h:88
Initialize a new tap interface with the given parameters.
Definition: tap.api:31
Reply for tap connect request.
Definition: tap.api:54
Delete tap interface.
Definition: tap.api:98
static void send_sw_interface_tap_details(vpe_api_main_t *am, vl_api_registration_t *reg, tapcli_interface_details_t *tap_if, u32 context)
Definition: tap_api.c:202
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:202
An API client registration, only in vpp/vlib.
Definition: api_common.h:45
u8 mac_address[6]
Definition: tap.api:37
u8 renumber
Renumber the (existing) interface.
Definition: tuntap.h:39
vlib_main_t * vm
Definition: buffer.c:301
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:341
#define ARRAY_LEN(x)
Definition: clib.h:62
static vl_api_registration_t * vl_api_client_index_to_registration(u32 index)
Definition: api.h:56
static void send_sw_interface_event_deleted(vpe_api_main_t *am, vl_api_registration_t *reg, u32 sw_if_index)
Definition: tap_api.c:62
Reply for tap dump request.
Definition: tap.api:116
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:1169
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:89
VLIB_API_INIT_FUNCTION(tap_api_hookup)
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 parameters.
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:220
#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:79
vpe_api_main_t vpe_api_main
Definition: pipe_api.c:39
api_main_t api_main
Definition: api_shared.c:35
int vnet_tap_dump_ifs(tapcli_interface_details_t **out_tapids)
Dump TAP interfaces.
Definition: tapcli.c:784
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:170
static void vl_api_tap_modify_t_handler(vl_api_tap_modify_t *mp)
Definition: tap_api.c:135