2 *------------------------------------------------------------------
3 * virtio_api.c - vnet virtio pci device driver API support
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:
10 * http://www.apache.org/licenses/LICENSE-2.0
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 *------------------------------------------------------------------
20 #include <vnet/vnet.h>
21 #include <vlibmemory/api.h>
23 #include <vnet/interface.h>
24 #include <vnet/api_errno.h>
25 #include <vnet/ip/ip.h>
26 #include <vnet/devices/virtio/virtio.h>
27 #include <vnet/devices/virtio/pci.h>
28 #include <vlib/pci/pci_types_api.h>
30 #include <vnet/vnet_msg_enum.h>
32 #define vl_typedefs /* define message structures */
33 #include <vnet/vnet_all_api_h.h>
36 #define vl_endianfun /* define message structures */
37 #include <vnet/vnet_all_api_h.h>
40 /* instantiate all the print functions we know about */
41 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
43 #include <vnet/vnet_all_api_h.h>
46 #include <vlibapi/api_helper_macros.h>
48 #define foreach_virtio_pci_api_msg \
49 _(VIRTIO_PCI_CREATE, virtio_pci_create) \
50 _(VIRTIO_PCI_CREATE_V2, virtio_pci_create_v2) \
51 _(VIRTIO_PCI_DELETE, virtio_pci_delete) \
52 _(SW_INTERFACE_VIRTIO_PCI_DUMP, sw_interface_virtio_pci_dump)
54 /* It will be deprecated in 21.01 */
56 vl_api_virtio_pci_create_t_handler (vl_api_virtio_pci_create_t * mp)
58 vlib_main_t *vm = vlib_get_main ();
59 vl_api_virtio_pci_create_reply_t *rmp;
60 vl_api_registration_t *reg;
61 virtio_pci_create_if_args_t _a, *ap = &_a;
63 clib_memset (ap, 0, sizeof (*ap));
65 pci_address_decode (&mp->pci_addr, (vlib_pci_addr_t *) & ap->addr);
66 if (!mp->use_random_mac)
68 clib_memcpy (ap->mac_addr, mp->mac_address, 6);
71 ap->sw_if_index = (u32) ~ 0;
76 if (mp->checksum_offload_enabled)
77 ap->checksum_offload_enabled = 1;
79 ap->checksum_offload_enabled = 0;
81 ap->features = clib_net_to_host_u64 (mp->features);
83 virtio_pci_create_if (vm, ap);
85 reg = vl_api_client_index_to_registration (mp->client_index);
89 rmp = vl_msg_api_alloc (sizeof (*rmp));
90 rmp->_vl_msg_id = htons (VL_API_VIRTIO_PCI_CREATE_REPLY);
91 rmp->context = mp->context;
92 rmp->retval = htonl (ap->rv);
93 rmp->sw_if_index = htonl (ap->sw_if_index);
95 vl_api_send_msg (reg, (u8 *) rmp);
99 vl_api_virtio_pci_create_v2_t_handler (vl_api_virtio_pci_create_v2_t * mp)
101 vlib_main_t *vm = vlib_get_main ();
102 vl_api_virtio_pci_create_v2_reply_t *rmp;
103 vl_api_registration_t *reg;
104 virtio_pci_create_if_args_t _a, *ap = &_a;
106 clib_memset (ap, 0, sizeof (*ap));
108 pci_address_decode (&mp->pci_addr, (vlib_pci_addr_t *) & ap->addr);
109 if (!mp->use_random_mac)
111 clib_memcpy (ap->mac_addr, mp->mac_address, 6);
112 ap->mac_addr_set = 1;
114 ap->sw_if_index = (u32) ~ 0;
116 STATIC_ASSERT (((int) VIRTIO_API_FLAG_GSO == (int) VIRTIO_FLAG_GSO),
117 "virtio gso api flag mismatch");
118 STATIC_ASSERT (((int) VIRTIO_API_FLAG_CSUM_OFFLOAD ==
119 (int) VIRTIO_FLAG_CSUM_OFFLOAD),
120 "virtio checksum offload api flag mismatch");
121 STATIC_ASSERT (((int) VIRTIO_API_FLAG_GRO_COALESCE ==
122 (int) VIRTIO_FLAG_GRO_COALESCE),
123 "virtio gro coalesce api flag mismatch");
124 STATIC_ASSERT (((int) VIRTIO_API_FLAG_PACKED == (int) VIRTIO_FLAG_PACKED),
125 "virtio packed api flag mismatch");
126 STATIC_ASSERT (((int) VIRTIO_API_FLAG_IN_ORDER ==
127 (int) VIRTIO_FLAG_IN_ORDER),
128 "virtio in-order api flag mismatch");
130 ap->virtio_flags = clib_net_to_host_u32 (mp->virtio_flags);
131 ap->features = clib_net_to_host_u64 (mp->features);
133 if (ap->virtio_flags & VIRTIO_FLAG_GSO)
137 if (ap->virtio_flags & VIRTIO_FLAG_CSUM_OFFLOAD)
138 ap->checksum_offload_enabled = 1;
140 ap->checksum_offload_enabled = 0;
142 virtio_pci_create_if (vm, ap);
144 reg = vl_api_client_index_to_registration (mp->client_index);
148 rmp = vl_msg_api_alloc (sizeof (*rmp));
149 rmp->_vl_msg_id = htons (VL_API_VIRTIO_PCI_CREATE_V2_REPLY);
150 rmp->context = mp->context;
151 rmp->retval = htonl (ap->rv);
152 rmp->sw_if_index = htonl (ap->sw_if_index);
154 vl_api_send_msg (reg, (u8 *) rmp);
158 vl_api_virtio_pci_delete_t_handler (vl_api_virtio_pci_delete_t * mp)
160 vnet_main_t *vnm = vnet_get_main ();
161 vlib_main_t *vm = vlib_get_main ();
162 virtio_main_t *vim = &virtio_main;
164 vnet_hw_interface_t *hw;
166 vl_api_virtio_pci_delete_reply_t *rmp;
167 vl_api_registration_t *reg;
170 vnet_get_sup_hw_interface_api_visible_or_null (vnm,
171 htonl (mp->sw_if_index));
172 if (hw == NULL || virtio_device_class.index != hw->dev_class_index)
174 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
178 vif = pool_elt_at_index (vim->interfaces, hw->dev_instance);
180 rv = virtio_pci_delete_if (vm, vif);
183 reg = vl_api_client_index_to_registration (mp->client_index);
187 rmp = vl_msg_api_alloc (sizeof (*rmp));
188 rmp->_vl_msg_id = htons (VL_API_VIRTIO_PCI_DELETE_REPLY);
189 rmp->context = mp->context;
190 rmp->retval = htonl (rv);
192 vl_api_send_msg (reg, (u8 *) rmp);
196 virtio_pci_send_sw_interface_details (vpe_api_main_t * am,
197 vl_api_registration_t * reg,
198 virtio_if_t * vif, u32 context)
200 vl_api_sw_interface_virtio_pci_details_t *mp;
201 mp = vl_msg_api_alloc (sizeof (*mp));
203 clib_memset (mp, 0, sizeof (*mp));
205 mp->_vl_msg_id = htons (VL_API_SW_INTERFACE_VIRTIO_PCI_DETAILS);
206 pci_address_encode ((vlib_pci_addr_t *) & vif->pci_addr.as_u32,
208 mp->sw_if_index = htonl (vif->sw_if_index);
209 virtio_vring_t *vring = vec_elt_at_index (vif->rxq_vrings, 0);
210 mp->rx_ring_sz = htons (vring->size);
211 vring = vec_elt_at_index (vif->txq_vrings, 0);
212 mp->tx_ring_sz = htons (vring->size);
213 clib_memcpy (mp->mac_addr, vif->mac_addr, 6);
214 mp->features = clib_host_to_net_u64 (vif->features);
216 mp->context = context;
217 vl_api_send_msg (reg, (u8 *) mp);
221 vl_api_sw_interface_virtio_pci_dump_t_handler
222 (vl_api_sw_interface_virtio_pci_dump_t * mp)
224 vpe_api_main_t *am = &vpe_api_main;
225 vl_api_registration_t *reg;
226 virtio_main_t *vmx = &virtio_main;
229 reg = vl_api_client_index_to_registration (mp->client_index);
233 pool_foreach (vif, vmx->interfaces, (
235 if (vif->type == VIRTIO_IF_TYPE_PCI)
237 virtio_pci_send_sw_interface_details
238 (am, reg, vif, mp->context);}
243 #define vl_msg_name_crc_list
244 #include <vnet/vnet_all_api_h.h>
245 #undef vl_msg_name_crc_list
248 setup_message_id_table (api_main_t * am)
250 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
251 foreach_vl_msg_name_crc_virtio;
255 static clib_error_t *
256 virtio_pci_api_hookup (vlib_main_t * vm)
258 api_main_t *am = vlibapi_get_main ();
261 vl_msg_api_set_handlers(VL_API_##N, #n, \
262 vl_api_##n##_t_handler, \
264 vl_api_##n##_t_endian, \
265 vl_api_##n##_t_print, \
266 sizeof(vl_api_##n##_t), 1);
267 foreach_virtio_pci_api_msg;
271 * Set up the (msg_name, crc, message-id) table
273 setup_message_id_table (am);
278 VLIB_API_INIT_FUNCTION (virtio_pci_api_hookup);
281 * fd.io coding-style-patch-verification: ON
284 * eval: (c-set-style "gnu")