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/devices/virtio/virtio.h>
26 #include <vnet/devices/virtio/pci.h>
27 #include <vlib/pci/pci_types_api.h>
29 #include <vnet/vnet_msg_enum.h>
31 #define vl_typedefs /* define message structures */
32 #include <vnet/vnet_all_api_h.h>
35 #define vl_endianfun /* define message structures */
36 #include <vnet/vnet_all_api_h.h>
39 /* instantiate all the print functions we know about */
40 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
42 #include <vnet/vnet_all_api_h.h>
45 #include <vlibapi/api_helper_macros.h>
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)
53 /* It will be deprecated in 21.01 */
55 vl_api_virtio_pci_create_t_handler (vl_api_virtio_pci_create_t * mp)
57 vlib_main_t *vm = vlib_get_main ();
58 vl_api_virtio_pci_create_reply_t *rmp;
59 vl_api_registration_t *reg;
60 virtio_pci_create_if_args_t _a, *ap = &_a;
62 clib_memset (ap, 0, sizeof (*ap));
64 pci_address_decode (&mp->pci_addr, (vlib_pci_addr_t *) & ap->addr);
65 if (!mp->use_random_mac)
67 clib_memcpy (ap->mac_addr, mp->mac_address, 6);
70 ap->sw_if_index = (u32) ~ 0;
75 if (mp->checksum_offload_enabled)
76 ap->checksum_offload_enabled = 1;
78 ap->checksum_offload_enabled = 0;
80 ap->features = clib_net_to_host_u64 (mp->features);
82 virtio_pci_create_if (vm, ap);
84 reg = vl_api_client_index_to_registration (mp->client_index);
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);
94 vl_api_send_msg (reg, (u8 *) rmp);
98 vl_api_virtio_pci_create_v2_t_handler (vl_api_virtio_pci_create_v2_t * mp)
100 vlib_main_t *vm = vlib_get_main ();
101 vl_api_virtio_pci_create_v2_reply_t *rmp;
102 vl_api_registration_t *reg;
103 virtio_pci_create_if_args_t _a, *ap = &_a;
105 clib_memset (ap, 0, sizeof (*ap));
107 pci_address_decode (&mp->pci_addr, (vlib_pci_addr_t *) & ap->addr);
108 if (!mp->use_random_mac)
110 clib_memcpy (ap->mac_addr, mp->mac_address, 6);
111 ap->mac_addr_set = 1;
113 ap->sw_if_index = (u32) ~ 0;
115 STATIC_ASSERT (((int) VIRTIO_API_FLAG_GSO == (int) VIRTIO_FLAG_GSO),
116 "virtio gso api flag mismatch");
117 STATIC_ASSERT (((int) VIRTIO_API_FLAG_CSUM_OFFLOAD ==
118 (int) VIRTIO_FLAG_CSUM_OFFLOAD),
119 "virtio checksum offload api flag mismatch");
120 STATIC_ASSERT (((int) VIRTIO_API_FLAG_GRO_COALESCE ==
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");
125 STATIC_ASSERT (((int) VIRTIO_API_FLAG_IN_ORDER ==
126 (int) VIRTIO_FLAG_IN_ORDER),
127 "virtio in-order api flag mismatch");
128 STATIC_ASSERT (((int) VIRTIO_API_FLAG_BUFFERING ==
129 (int) VIRTIO_FLAG_BUFFERING),
130 "virtio buffering api flag mismatch");
132 ap->virtio_flags = clib_net_to_host_u32 (mp->virtio_flags);
133 ap->features = clib_net_to_host_u64 (mp->features);
135 if (ap->virtio_flags & VIRTIO_API_FLAG_GSO)
139 if (ap->virtio_flags & VIRTIO_API_FLAG_CSUM_OFFLOAD)
140 ap->checksum_offload_enabled = 1;
142 ap->checksum_offload_enabled = 0;
144 virtio_pci_create_if (vm, ap);
146 reg = vl_api_client_index_to_registration (mp->client_index);
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);
156 vl_api_send_msg (reg, (u8 *) rmp);
160 vl_api_virtio_pci_delete_t_handler (vl_api_virtio_pci_delete_t * mp)
162 vnet_main_t *vnm = vnet_get_main ();
163 vlib_main_t *vm = vlib_get_main ();
164 virtio_main_t *vim = &virtio_main;
166 vnet_hw_interface_t *hw;
168 vl_api_virtio_pci_delete_reply_t *rmp;
169 vl_api_registration_t *reg;
172 vnet_get_sup_hw_interface_api_visible_or_null (vnm,
173 htonl (mp->sw_if_index));
174 if (hw == NULL || virtio_device_class.index != hw->dev_class_index)
176 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
180 vif = pool_elt_at_index (vim->interfaces, hw->dev_instance);
182 rv = virtio_pci_delete_if (vm, vif);
185 reg = vl_api_client_index_to_registration (mp->client_index);
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);
194 vl_api_send_msg (reg, (u8 *) rmp);
198 virtio_pci_send_sw_interface_details (vpe_api_main_t * am,
199 vl_api_registration_t * reg,
200 virtio_if_t * vif, u32 context)
202 vl_api_sw_interface_virtio_pci_details_t *mp;
203 mp = vl_msg_api_alloc (sizeof (*mp));
205 clib_memset (mp, 0, sizeof (*mp));
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,
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);
218 mp->context = context;
219 vl_api_send_msg (reg, (u8 *) mp);
223 vl_api_sw_interface_virtio_pci_dump_t_handler
224 (vl_api_sw_interface_virtio_pci_dump_t * mp)
226 vpe_api_main_t *am = &vpe_api_main;
227 vl_api_registration_t *reg;
228 virtio_main_t *vmx = &virtio_main;
231 reg = vl_api_client_index_to_registration (mp->client_index);
235 pool_foreach (vif, vmx->interfaces)
237 if (vif->type == VIRTIO_IF_TYPE_PCI)
239 virtio_pci_send_sw_interface_details (am, reg, vif, mp->context);
244 #define vl_msg_name_crc_list
245 #include <vnet/vnet_all_api_h.h>
246 #undef vl_msg_name_crc_list
249 setup_message_id_table (api_main_t * am)
251 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
252 foreach_vl_msg_name_crc_virtio;
256 static clib_error_t *
257 virtio_pci_api_hookup (vlib_main_t * vm)
259 api_main_t *am = vlibapi_get_main ();
262 vl_msg_api_set_handlers(VL_API_##N, #n, \
263 vl_api_##n##_t_handler, \
265 vl_api_##n##_t_endian, \
266 vl_api_##n##_t_print, \
267 sizeof(vl_api_##n##_t), 1);
268 foreach_virtio_pci_api_msg;
272 * Set up the (msg_name, crc, message-id) table
274 setup_message_id_table (am);
279 VLIB_API_INIT_FUNCTION (virtio_pci_api_hookup);
282 * fd.io coding-style-patch-verification: ON
285 * eval: (c-set-style "gnu")