FD.io VPP  v18.11-rc0-18-g2a3fb1a
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  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  tap_create_if (vm, ap);
113 
115  if (!reg)
116  return;;
117 
118  /* If a tag was supplied... */
119  if (mp->tag[0])
120  {
121  /* Make sure it's a proper C-string */
122  mp->tag[ARRAY_LEN (mp->tag) - 1] = 0;
123  u8 *tag = format (0, "%s%c", mp->tag, 0);
124  vnet_set_sw_interface_tag (vnm, tag, ap->sw_if_index);
125  }
126 
127 
128  rmp = vl_msg_api_alloc (sizeof (*rmp));
129  rmp->_vl_msg_id = ntohs (VL_API_TAP_CREATE_V2_REPLY);
130  rmp->context = mp->context;
131  rmp->retval = ntohl (ap->rv);
132  rmp->sw_if_index = ntohl (ap->sw_if_index);
133 
134  vl_api_send_msg (reg, (u8 *) rmp);
135 }
136 
137 static void
139  vl_api_registration_t * reg,
140  u32 sw_if_index)
141 {
143 
144  mp = vl_msg_api_alloc (sizeof (*mp));
145  memset (mp, 0, sizeof (*mp));
146  mp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_EVENT);
147  mp->sw_if_index = ntohl (sw_if_index);
148 
149  mp->admin_up_down = 0;
150  mp->link_up_down = 0;
151  mp->deleted = 1;
152  vl_api_send_msg (reg, (u8 *) mp);
153 }
154 
155 static void
157 {
158  vnet_main_t *vnm = vnet_get_main ();
160  int rv;
162  vl_api_tap_delete_v2_reply_t *rmp;
164  u32 sw_if_index = ntohl (mp->sw_if_index);
165 
166  rv = tap_delete_if (vm, sw_if_index);
167 
169  if (!reg)
170  return;
171 
172  rmp = vl_msg_api_alloc (sizeof (*rmp));
173  rmp->_vl_msg_id = ntohs (VL_API_TAP_DELETE_V2_REPLY);
174  rmp->context = mp->context;
175  rmp->retval = ntohl (rv);
176 
177  vl_api_send_msg (reg, (u8 *) rmp);
178 
179  if (!rv)
180  {
181  vnet_clear_sw_interface_tag (vnm, sw_if_index);
182  tap_send_sw_interface_event_deleted (vam, reg, sw_if_index);
183  }
184 }
185 
186 static void
188  vl_api_registration_t * reg,
189  tap_interface_details_t * tap_if, u32 context)
190 {
192  mp = vl_msg_api_alloc (sizeof (*mp));
193  memset (mp, 0, sizeof (*mp));
194  mp->_vl_msg_id = htons (VL_API_SW_INTERFACE_TAP_V2_DETAILS);
195  mp->id = htonl (tap_if->id);
196  mp->sw_if_index = htonl (tap_if->sw_if_index);
197  clib_memcpy (mp->dev_name, tap_if->dev_name,
198  MIN (ARRAY_LEN (mp->dev_name) - 1,
199  strlen ((const char *) tap_if->dev_name)));
200  mp->rx_ring_sz = htons (tap_if->rx_ring_sz);
201  mp->tx_ring_sz = htons (tap_if->tx_ring_sz);
202  clib_memcpy (mp->host_mac_addr, tap_if->host_mac_addr, 6);
203  clib_memcpy (mp->host_if_name, tap_if->host_if_name,
204  MIN (ARRAY_LEN (mp->host_if_name) - 1,
205  strlen ((const char *) tap_if->host_if_name)));
207  MIN (ARRAY_LEN (mp->host_namespace) - 1,
208  strlen ((const char *) tap_if->host_namespace)));
209  clib_memcpy (mp->host_bridge, tap_if->host_bridge,
210  MIN (ARRAY_LEN (mp->host_bridge) - 1,
211  strlen ((const char *) tap_if->host_bridge)));
212  if (tap_if->host_ip4_prefix_len)
213  clib_memcpy (&mp->host_ip4_addr, &tap_if->host_ip4_addr, 4);
215  if (tap_if->host_ip6_prefix_len)
216  clib_memcpy (&mp->host_ip6_addr, &tap_if->host_ip6_addr, 16);
218 
219  mp->context = context;
220  vl_api_send_msg (reg, (u8 *) mp);
221 }
222 
223 static void
225  mp)
226 {
227  int rv;
230  tap_interface_details_t *tapifs = NULL;
231  tap_interface_details_t *tap_if = NULL;
232 
234  if (!reg)
235  return;
236 
237  rv = tap_dump_ifs (&tapifs);
238  if (rv)
239  return;
240 
241  vec_foreach (tap_if, tapifs)
242  {
243  tap_send_sw_interface_details (am, reg, tap_if, mp->context);
244  }
245 
246  vec_free (tapifs);
247 }
248 
249 #define vl_msg_name_crc_list
250 #include <vnet/vnet_all_api_h.h>
251 #undef vl_msg_name_crc_list
252 
253 static void
255 {
256 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
257  foreach_vl_msg_name_crc_tapv2;
258 #undef _
259 }
260 
261 static clib_error_t *
263 {
264  api_main_t *am = &api_main;
265 
266 #define _(N,n) \
267  vl_msg_api_set_handlers(VL_API_##N, #n, \
268  vl_api_##n##_t_handler, \
269  vl_noop_handler, \
270  vl_api_##n##_t_endian, \
271  vl_api_##n##_t_print, \
272  sizeof(vl_api_##n##_t), 1);
274 #undef _
275 
276  /*
277  * Set up the (msg_name, crc, message-id) table
278  */
280 
281  return 0;
282 }
283 
285 
286 /*
287  * fd.io coding-style-patch-verification: ON
288  *
289  * Local Variables:
290  * eval: (c-set-style "gnu")
291  * End:
292  */
static void vl_api_sw_interface_tap_v2_dump_t_handler(vl_api_sw_interface_tap_v2_dump_t *mp)
Definition: tapv2_api.c:224
u8 host_if_name[64]
Definition: tap.h:59
u8 host_namespace[64]
Definition: tap.h:60
ip4_address_t host_ip4_addr
Definition: tap.h:36
vnet_main_t * vnet_get_main(void)
Definition: misc.c:47
static void tap_setup_message_id_table(api_main_t *am)
Definition: tapv2_api.c:254
Reply for tap dump request.
Definition: tapv2.api:127
#define NULL
Definition: clib.h:55
static void vl_api_send_msg(vl_api_registration_t *rp, u8 *elem)
Definition: api.h:34
u8 host_ip6_prefix_len
Definition: tap.h:41
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:187
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:419
static clib_error_t * tapv2_api_hookup(vlib_main_t *vm)
Definition: tapv2_api.c:262
void * vl_msg_api_alloc(int nbytes)
int tap_dump_ifs(tap_interface_details_t **out_tapids)
Definition: tap.c:459
u8 host_ip4_gw_set
Definition: tap.h:39
unsigned char u8
Definition: types.h:56
static void tap_send_sw_interface_event_deleted(vpe_api_main_t *am, vl_api_registration_t *reg, u32 sw_if_index)
Definition: tapv2_api.c:138
Dump tap interfaces request.
Definition: tapv2.api:106
u8 host_bridge[64]
Definition: tap.h:61
u8 host_ip6_addr[16]
Definition: tap.h:64
u8 host_mac_addr[6]
Definition: tap.h:58
int tap_delete_if(vlib_main_t *vm, u32 sw_if_index)
Definition: tap.c:419
u8 host_mac_addr[6]
Definition: tap.h:34
unsigned int u32
Definition: types.h:88
#define MIN(x, y)
Definition: node.h:31
u8 host_ip4_addr[4]
Definition: tap.h:62
ip4_address_t host_ip4_gw
Definition: tap.h:38
ip6_address_t host_ip6_addr
Definition: tap.h:40
u8 host_ip4_prefix_len
Definition: tap.h:37
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:201
An API client registration, only in vpp/vlib.
Definition: api_common.h:44
vlib_main_t * vm
Definition: buffer.c:294
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:339
static void vl_api_tap_delete_v2_t_handler(vl_api_tap_delete_v2_t *mp)
Definition: tapv2_api.c:156
#define clib_memcpy(a, b, c)
Definition: string.h:75
VLIB_API_INIT_FUNCTION(tapv2_api_hookup)
Initialize a new tap interface with the given paramters.
Definition: tapv2.api:51
#define ARRAY_LEN(x)
Definition: clib.h:59
static vl_api_registration_t * vl_api_client_index_to_registration(u32 index)
Definition: api.h:56
u8 * host_bridge
Definition: tap.h:35
ip6_address_t host_ip6_gw
Definition: tap.h:42
u8 * host_if_name
Definition: tap.h:33
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
Interface Event generated by want_interface_events.
Definition: interface.api:57
u8 host_ip6_gw_set
Definition: tap.h:43
void tap_create_if(vlib_main_t *vm, tap_create_if_args_t *args)
Definition: tap.c:81
#define foreach_tapv2_api_msg
Definition: tapv2_api.c:47
u8 mac_addr[6]
Definition: tap.h:29
Delete tap interface.
Definition: tapv2.api:98
TAP interface details struct.
Definition: tap.h:51
#define vec_foreach(var, vec)
Vector iterator.
u8 * host_namespace
Definition: tap.h:32
vpe_api_main_t vpe_api_main
Definition: pipe_api.c:39
Reply for tap create reply.
Definition: tapv2.api:86
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