FD.io VPP  v21.06-3-gbb25fbf28
Vector Packet Processing
virtio_api.c
Go to the documentation of this file.
1 /*
2  *------------------------------------------------------------------
3  * virtio_api.c - vnet virtio pci device driver API support
4  *
5  * Copyright (c) 2018 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>
27 #include <vlib/pci/pci_types_api.h>
28 
29 #include <vnet/vnet_msg_enum.h>
30 
31 #define vl_typedefs /* define message structures */
32 #include <vnet/vnet_all_api_h.h>
33 #undef vl_typedefs
34 
35 #define vl_endianfun /* define message structures */
36 #include <vnet/vnet_all_api_h.h>
37 #undef vl_endianfun
38 
39 /* instantiate all the print functions we know about */
40 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
41 #define vl_printfun
42 #include <vnet/vnet_all_api_h.h>
43 #undef vl_printfun
44 
46 
47 #define foreach_virtio_pci_api_msg \
48 _(VIRTIO_PCI_CREATE, virtio_pci_create) \
49 _(VIRTIO_PCI_CREATE_V2, virtio_pci_create_v2) \
50 _(VIRTIO_PCI_DELETE, virtio_pci_delete) \
51 _(SW_INTERFACE_VIRTIO_PCI_DUMP, sw_interface_virtio_pci_dump)
52 
53 /* It will be deprecated in 21.01 */
54 static void
56 {
60  virtio_pci_create_if_args_t _a, *ap = &_a;
61 
62  clib_memset (ap, 0, sizeof (*ap));
63 
64  pci_address_decode (&mp->pci_addr, (vlib_pci_addr_t *) & ap->addr);
65  if (!mp->use_random_mac)
66  {
67  clib_memcpy (ap->mac_addr, mp->mac_address, 6);
68  ap->mac_addr_set = 1;
69  }
70  ap->sw_if_index = (u32) ~ 0;
71  if (mp->gso_enabled)
72  ap->gso_enabled = 1;
73  else
74  ap->gso_enabled = 0;
77  else
79 
80  ap->features = clib_net_to_host_u64 (mp->features);
81 
83 
85  if (!reg)
86  return;;
87 
88  rmp = vl_msg_api_alloc (sizeof (*rmp));
89  rmp->_vl_msg_id = htons (VL_API_VIRTIO_PCI_CREATE_REPLY);
90  rmp->context = mp->context;
91  rmp->retval = htonl (ap->rv);
92  rmp->sw_if_index = htonl (ap->sw_if_index);
93 
94  vl_api_send_msg (reg, (u8 *) rmp);
95 }
96 
97 static void
99 {
103  virtio_pci_create_if_args_t _a, *ap = &_a;
104 
105  clib_memset (ap, 0, sizeof (*ap));
106 
107  pci_address_decode (&mp->pci_addr, (vlib_pci_addr_t *) & ap->addr);
108  if (!mp->use_random_mac)
109  {
110  clib_memcpy (ap->mac_addr, mp->mac_address, 6);
111  ap->mac_addr_set = 1;
112  }
113  ap->sw_if_index = (u32) ~ 0;
114 
115  STATIC_ASSERT (((int) VIRTIO_API_FLAG_GSO == (int) VIRTIO_FLAG_GSO),
116  "virtio gso api flag mismatch");
118  (int) VIRTIO_FLAG_CSUM_OFFLOAD),
119  "virtio checksum offload api flag mismatch");
121  (int) VIRTIO_FLAG_GRO_COALESCE),
122  "virtio gro coalesce api flag mismatch");
123  STATIC_ASSERT (((int) VIRTIO_API_FLAG_PACKED == (int) VIRTIO_FLAG_PACKED),
124  "virtio packed api flag mismatch");
126  (int) VIRTIO_FLAG_IN_ORDER),
127  "virtio in-order api flag mismatch");
129  (int) VIRTIO_FLAG_BUFFERING),
130  "virtio buffering api flag mismatch");
131 
132  ap->virtio_flags = clib_net_to_host_u32 (mp->virtio_flags);
133  ap->features = clib_net_to_host_u64 (mp->features);
134 
136  ap->gso_enabled = 1;
137  else
138  ap->gso_enabled = 0;
140  ap->checksum_offload_enabled = 1;
141  else
142  ap->checksum_offload_enabled = 0;
143 
144  virtio_pci_create_if (vm, ap);
145 
147  if (!reg)
148  return;;
149 
150  rmp = vl_msg_api_alloc (sizeof (*rmp));
151  rmp->_vl_msg_id = htons (VL_API_VIRTIO_PCI_CREATE_V2_REPLY);
152  rmp->context = mp->context;
153  rmp->retval = htonl (ap->rv);
154  rmp->sw_if_index = htonl (ap->sw_if_index);
155 
156  vl_api_send_msg (reg, (u8 *) rmp);
157 }
158 
159 static void
161 {
162  vnet_main_t *vnm = vnet_get_main ();
164  virtio_main_t *vim = &virtio_main;
165  int rv = 0;
167  virtio_if_t *vif;
168  vl_api_virtio_pci_delete_reply_t *rmp;
170 
171  hw =
173  htonl (mp->sw_if_index));
174  if (hw == NULL || virtio_device_class.index != hw->dev_class_index)
175  {
176  rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
177  goto reply;
178  }
179 
180  vif = pool_elt_at_index (vim->interfaces, hw->dev_instance);
181 
182  rv = virtio_pci_delete_if (vm, vif);
183 
184 reply:
186  if (!reg)
187  return;
188 
189  rmp = vl_msg_api_alloc (sizeof (*rmp));
190  rmp->_vl_msg_id = htons (VL_API_VIRTIO_PCI_DELETE_REPLY);
191  rmp->context = mp->context;
192  rmp->retval = htonl (rv);
193 
194  vl_api_send_msg (reg, (u8 *) rmp);
195 }
196 
197 static void
199  vl_api_registration_t * reg,
200  virtio_if_t * vif, u32 context)
201 {
203  mp = vl_msg_api_alloc (sizeof (*mp));
204 
205  clib_memset (mp, 0, sizeof (*mp));
206 
207  mp->_vl_msg_id = htons (VL_API_SW_INTERFACE_VIRTIO_PCI_DETAILS);
208  pci_address_encode ((vlib_pci_addr_t *) & vif->pci_addr.as_u32,
209  &mp->pci_addr);
210  mp->sw_if_index = htonl (vif->sw_if_index);
211  virtio_vring_t *vring = vec_elt_at_index (vif->rxq_vrings, 0);
212  mp->rx_ring_sz = htons (vring->size);
213  vring = vec_elt_at_index (vif->txq_vrings, 0);
214  mp->tx_ring_sz = htons (vring->size);
215  clib_memcpy (mp->mac_addr, vif->mac_addr, 6);
216  mp->features = clib_host_to_net_u64 (vif->features);
217 
218  mp->context = context;
219  vl_api_send_msg (reg, (u8 *) mp);
220 }
221 
222 static void
225 {
228  virtio_main_t *vmx = &virtio_main;
229  virtio_if_t *vif;
230 
232  if (!reg)
233  return;
234 
235  pool_foreach (vif, vmx->interfaces)
236  {
237  if (vif->type == VIRTIO_IF_TYPE_PCI)
238  {
240  }
241  }
242 }
243 
244 #define vl_msg_name_crc_list
245 #include <vnet/vnet_all_api_h.h>
246 #undef vl_msg_name_crc_list
247 
248 static void
250 {
251 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
252  foreach_vl_msg_name_crc_virtio;
253 #undef _
254 }
255 
256 static clib_error_t *
258 {
260 
261 #define _(N,n) \
262  vl_msg_api_set_handlers(VL_API_##N, #n, \
263  vl_api_##n##_t_handler, \
264  vl_noop_handler, \
265  vl_api_##n##_t_endian, \
266  vl_api_##n##_t_print, \
267  sizeof(vl_api_##n##_t), 1);
269 #undef _
270 
271  /*
272  * Set up the (msg_name, crc, message-id) table
273  */
275 
276  return 0;
277 }
278 
280 
281 /*
282  * fd.io coding-style-patch-verification: ON
283  *
284  * Local Variables:
285  * eval: (c-set-style "gnu")
286  * End:
287  */
vl_api_sw_interface_virtio_pci_dump_t::context
u32 context
Definition: virtio.api:116
virtio_device_class
vnet_device_class_t virtio_device_class
pci.h
virtio_pci_create_if
void virtio_pci_create_if(vlib_main_t *vm, virtio_pci_create_if_args_t *args)
Definition: pci.c:1348
vl_api_virtio_pci_create_v2_reply_t::sw_if_index
vl_api_interface_index_t sw_if_index
Definition: virtio.api:97
vl_api_client_index_to_registration
static vl_api_registration_t * vl_api_client_index_to_registration(u32 index)
Definition: api.h:79
api.h
virtio_pci_api_hookup
static clib_error_t * virtio_pci_api_hookup(vlib_main_t *vm)
Definition: virtio_api.c:257
vl_api_sw_interface_virtio_pci_details_t::tx_ring_sz
u16 tx_ring_sz
Definition: virtio.api:133
clib_memcpy
#define clib_memcpy(d, s, n)
Definition: string.h:197
virtio_vring_t
Definition: virtio.h:63
virtio.h
vl_api_send_msg
static void vl_api_send_msg(vl_api_registration_t *rp, u8 *elem)
Definition: api.h:35
pool_elt_at_index
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:553
vl_api_virtio_pci_create_v2_t::pci_addr
vl_api_pci_address_t pci_addr
Definition: virtio.api:81
virtio_if_t::mac_addr
u8 mac_addr[6]
Definition: virtio.h:171
vl_api_virtio_pci_create_reply_t
Reply for virtio pci create reply.
Definition: virtio.api:51
VIRTIO_API_FLAG_CSUM_OFFLOAD
@ VIRTIO_API_FLAG_CSUM_OFFLOAD
Definition: virtio.api:61
vpe_api_main_t
Definition: api_helper_macros.h:414
vl_api_virtio_pci_create_v2_t_handler
static void vl_api_virtio_pci_create_v2_t_handler(vl_api_virtio_pci_create_v2_t *mp)
Definition: virtio_api.c:98
virtio_pci_create_if_args_t::gso_enabled
u8 gso_enabled
Definition: pci.h:239
vl_api_virtio_pci_create_t::gso_enabled
bool gso_enabled
Definition: virtio.api:41
virtio_pci_create_if_args_t::mac_addr_set
u8 mac_addr_set
Definition: pci.h:236
vl_api_virtio_pci_create_v2_t::features
u64 features
Definition: virtio.api:85
am
app_main_t * am
Definition: application.c:489
vl_api_virtio_pci_create_v2_t::mac_address
vl_api_mac_address_t mac_address
Definition: virtio.api:83
vm
vlib_main_t * vm
X-connect all packets from the HOST to the PHY.
Definition: nat44_ei.c:3047
vl_api_virtio_pci_create_t::features
u64 features
Definition: virtio.api:43
vl_api_virtio_pci_create_v2_reply_t::context
u32 context
Definition: virtio.api:95
vnet_hw_interface_t::dev_instance
u32 dev_instance
Definition: interface.h:660
vl_api_virtio_pci_create_t::pci_addr
vl_api_pci_address_t pci_addr
Definition: virtio.api:38
vl_api_sw_interface_virtio_pci_dump_t_handler
static void vl_api_sw_interface_virtio_pci_dump_t_handler(vl_api_sw_interface_virtio_pci_dump_t *mp)
Definition: virtio_api.c:224
virtio_vring_t::size
u16 size
Definition: virtio.h:83
VIRTIO_API_FLAG_PACKED
@ VIRTIO_API_FLAG_PACKED
Definition: virtio.api:63
virtio_pci_create_if_args_t::features
u64 features
Definition: pci.h:238
virtio_main
virtio_main_t virtio_main
Definition: virtio.c:37
pool_foreach
#define pool_foreach(VAR, POOL)
Iterate through pool.
Definition: pool.h:534
VIRTIO_API_FLAG_GRO_COALESCE
@ VIRTIO_API_FLAG_GRO_COALESCE
Definition: virtio.api:62
vl_api_virtio_pci_create_t::use_random_mac
bool use_random_mac
Definition: virtio.api:39
vl_api_virtio_pci_create_t
Initialize a new virtio pci interface with the given parameters.
Definition: virtio.api:33
vl_api_sw_interface_virtio_pci_dump_t
Dump virtio pci interfaces request.
Definition: virtio.api:113
virtio_if_t::txq_vrings
virtio_vring_t * txq_vrings
Definition: virtio.h:137
virtio_if_t::pci_addr
pci_addr_t pci_addr
Definition: virtio.h:196
virtio_pci_delete_if
int virtio_pci_delete_if(vlib_main_t *vm, virtio_if_t *vif)
Definition: pci.c:1548
vl_api_sw_interface_virtio_pci_dump_t::client_index
u32 client_index
Definition: virtio.api:115
vec_elt_at_index
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
Definition: vec_bootstrap.h:203
vnet_get_main
vnet_main_t * vnet_get_main(void)
Definition: pnat_test_stubs.h:56
vnet_msg_enum.h
vl_api_sw_interface_virtio_pci_details_t::pci_addr
vl_api_pci_address_t pci_addr
Definition: virtio.api:131
VIRTIO_API_FLAG_IN_ORDER
@ VIRTIO_API_FLAG_IN_ORDER
Definition: virtio.api:64
vl_api_registration_
An API client registration, only in vpp/vlib.
Definition: api_common.h:47
virtio_if_t::features
u64 features
Definition: virtio.h:131
vnet_get_sup_hw_interface_api_visible_or_null
static vnet_hw_interface_t * vnet_get_sup_hw_interface_api_visible_or_null(vnet_main_t *vnm, u32 sw_if_index)
Definition: interface_funcs.h:101
vnet_hw_interface_t::dev_class_index
u32 dev_class_index
Definition: interface.h:659
virtio_pci_create_if_args_t::addr
u32 addr
Definition: pci.h:232
vl_api_sw_interface_virtio_pci_details_t::context
u32 context
Definition: virtio.api:129
virtio_pci_create_if_args_t::virtio_flags
u32 virtio_flags
Definition: pci.h:242
pci_address_encode
void pci_address_encode(const vlib_pci_addr_t *in, vl_api_pci_address_t *out)
Definition: pci_types_api.c:31
virtio_pci_create_if_args_t::checksum_offload_enabled
u8 checksum_offload_enabled
Definition: pci.h:240
vlibapi_get_main
static api_main_t * vlibapi_get_main(void)
Definition: api_common.h:390
interface.h
virtio_pci_create_if_args_t::rv
i32 rv
Definition: pci.h:234
VIRTIO_API_FLAG_GSO
@ VIRTIO_API_FLAG_GSO
Definition: virtio.api:60
vl_api_virtio_pci_delete_t
Delete virtio pci interface.
Definition: virtio.api:105
vl_api_sw_interface_virtio_pci_details_t
Reply for virtio pci interface dump request.
Definition: virtio.api:127
vl_api_virtio_pci_create_v2_reply_t::retval
i32 retval
Definition: virtio.api:96
virtio_pci_create_if_args_t::sw_if_index
u32 sw_if_index
Definition: pci.h:235
vl_api_sw_interface_virtio_pci_details_t::rx_ring_sz
u16 rx_ring_sz
Definition: virtio.api:134
STATIC_ASSERT
#define STATIC_ASSERT(truth,...)
Definition: error_bootstrap.h:111
vl_api_virtio_pci_create_t::context
u32 context
Definition: virtio.api:37
virtio_if_t::sw_if_index
u32 sw_if_index
Definition: virtio.h:153
vl_api_virtio_pci_create_reply_t::retval
i32 retval
Definition: virtio.api:55
api_main_t
API main structure, used by both vpp and binary API clients.
Definition: api_common.h:228
virtio_main_t
Definition: virtio.h:214
vl_api_virtio_pci_delete_t_handler
static void vl_api_virtio_pci_delete_t_handler(vl_api_virtio_pci_delete_t *mp)
Definition: virtio_api.c:160
vnet_hw_interface_t
Definition: interface.h:638
vnet_main_t
Definition: vnet.h:76
vl_api_virtio_pci_delete_t::sw_if_index
vl_api_interface_index_t sw_if_index
Definition: virtio.api:109
vl_api_virtio_pci_create_v2_t::use_random_mac
bool use_random_mac
Definition: virtio.api:82
vl_api_virtio_pci_delete_t::client_index
u32 client_index
Definition: virtio.api:107
vl_api_sw_interface_virtio_pci_details_t::mac_addr
vl_api_mac_address_t mac_addr
Definition: virtio.api:132
vl_api_virtio_pci_delete_t::context
u32 context
Definition: virtio.api:108
virtio_pci_create_if_args_t::mac_addr
u8 mac_addr[6]
Definition: pci.h:237
vl_api_virtio_pci_create_v2_reply_t
Reply for virtio pci create reply.
Definition: virtio.api:93
u32
unsigned int u32
Definition: types.h:88
vl_api_virtio_pci_create_reply_t::sw_if_index
vl_api_interface_index_t sw_if_index
Definition: virtio.api:56
api_helper_macros.h
virtio_pci_send_sw_interface_details
static void virtio_pci_send_sw_interface_details(vpe_api_main_t *am, vl_api_registration_t *reg, virtio_if_t *vif, u32 context)
Definition: virtio_api.c:198
vl_api_virtio_pci_create_t::checksum_offload_enabled
bool checksum_offload_enabled
Definition: virtio.api:42
virtio_if_t::type
virtio_if_type_t type
Definition: virtio.h:150
virtio_if_t
Definition: virtio.h:128
vl_api_virtio_pci_create_t_handler
static void vl_api_virtio_pci_create_t_handler(vl_api_virtio_pci_create_t *mp)
Definition: virtio_api.c:55
vl_api_sw_interface_virtio_pci_details_t::sw_if_index
vl_api_interface_index_t sw_if_index
Definition: virtio.api:130
VLIB_API_INIT_FUNCTION
VLIB_API_INIT_FUNCTION(virtio_pci_api_hookup)
virtio_if_t::rxq_vrings
virtio_vring_t * rxq_vrings
Definition: virtio.h:136
pci_address_decode
void pci_address_decode(const vl_api_pci_address_t *in, vlib_pci_addr_t *out)
Definition: pci_types_api.c:22
virtio_main_t::interfaces
virtio_if_t * interfaces
Definition: virtio.h:220
virtio_pci_create_if_args_t
Definition: pci.h:230
clib_memset
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
vlib_main_t
Definition: main.h:102
foreach_virtio_pci_api_msg
#define foreach_virtio_pci_api_msg
Definition: virtio_api.c:47
vl_api_virtio_pci_create_v2_t::virtio_flags
vl_api_virtio_flags_t virtio_flags
Definition: virtio.api:84
vl_api_virtio_pci_create_reply_t::context
u32 context
Definition: virtio.api:54
vlib_get_main
static vlib_main_t * vlib_get_main(void)
Definition: global_funcs.h:38
u8
unsigned char u8
Definition: types.h:56
clib_error_t
Definition: clib_error.h:21
vl_api_virtio_pci_create_t::mac_address
vl_api_mac_address_t mac_address
Definition: virtio.api:40
vl_api_virtio_pci_create_v2_t::context
u32 context
Definition: virtio.api:80
vnet_all_api_h.h
vl_api_virtio_pci_create_t::client_index
u32 client_index
Definition: virtio.api:36
vl_api_virtio_pci_create_v2_t::client_index
u32 client_index
Definition: virtio.api:79
context
u32 context
Definition: ip.api:780
rv
int __clib_unused rv
Definition: application.c:491
pci_types_api.h
pci_addr_t::as_u32
u32 as_u32
Definition: virtio.h:122
vnet.h
api_errno.h
vl_api_virtio_pci_create_v2_t
Initialize a new virtio pci interface with the given parameters.
Definition: virtio.api:77
VIRTIO_API_FLAG_BUFFERING
@ VIRTIO_API_FLAG_BUFFERING
Definition: virtio.api:65
vpe_api_main
vpe_api_main_t vpe_api_main
Definition: interface_api.c:55
vl_msg_api_alloc
void * vl_msg_api_alloc(int nbytes)
Definition: memory_shared.c:199
vl_api_sw_interface_virtio_pci_details_t::features
u64 features
Definition: virtio.api:135
setup_message_id_table
static void setup_message_id_table(api_main_t *am)
Definition: virtio_api.c:249