4 * Copyright(c) 2010-2016 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 #include <sys/types.h>
38 #include <rte_malloc.h>
39 #include <rte_kvargs.h>
41 #include "virtio_ethdev.h"
42 #include "virtio_logs.h"
43 #include "virtio_pci.h"
44 #include "virtqueue.h"
45 #include "virtio_user/virtio_user_dev.h"
47 #define virtio_user_get_dev(hw) \
48 ((struct virtio_user_dev *)(hw)->virtio_user_dev)
51 virtio_user_read_dev_config(struct virtio_hw *hw, size_t offset,
52 void *dst, int length)
55 struct virtio_user_dev *dev = virtio_user_get_dev(hw);
57 if (offset == offsetof(struct virtio_net_config, mac) &&
58 length == ETHER_ADDR_LEN) {
59 for (i = 0; i < ETHER_ADDR_LEN; ++i)
60 ((uint8_t *)dst)[i] = dev->mac_addr[i];
64 if (offset == offsetof(struct virtio_net_config, status))
65 *(uint16_t *)dst = dev->status;
67 if (offset == offsetof(struct virtio_net_config, max_virtqueue_pairs))
68 *(uint16_t *)dst = dev->max_queue_pairs;
72 virtio_user_write_dev_config(struct virtio_hw *hw, size_t offset,
73 const void *src, int length)
76 struct virtio_user_dev *dev = virtio_user_get_dev(hw);
78 if ((offset == offsetof(struct virtio_net_config, mac)) &&
79 (length == ETHER_ADDR_LEN))
80 for (i = 0; i < ETHER_ADDR_LEN; ++i)
81 dev->mac_addr[i] = ((const uint8_t *)src)[i];
83 PMD_DRV_LOG(ERR, "not supported offset=%" PRIu64 ", len=%d\n",
88 virtio_user_set_status(struct virtio_hw *hw, uint8_t status)
90 struct virtio_user_dev *dev = virtio_user_get_dev(hw);
92 if (status & VIRTIO_CONFIG_STATUS_DRIVER_OK)
93 virtio_user_start_device(dev);
98 virtio_user_reset(struct virtio_hw *hw)
100 struct virtio_user_dev *dev = virtio_user_get_dev(hw);
102 virtio_user_stop_device(dev);
106 virtio_user_get_status(struct virtio_hw *hw)
108 struct virtio_user_dev *dev = virtio_user_get_dev(hw);
114 virtio_user_get_features(struct virtio_hw *hw)
116 struct virtio_user_dev *dev = virtio_user_get_dev(hw);
118 return dev->features;
122 virtio_user_set_features(struct virtio_hw *hw, uint64_t features)
124 struct virtio_user_dev *dev = virtio_user_get_dev(hw);
126 dev->features = features;
130 virtio_user_get_isr(struct virtio_hw *hw __rte_unused)
132 /* When config interrupt happens, driver calls this function to query
133 * what kinds of change happen. Interrupt mode not supported for now.
139 virtio_user_set_config_irq(struct virtio_hw *hw __rte_unused,
140 uint16_t vec __rte_unused)
142 return VIRTIO_MSI_NO_VECTOR;
145 /* This function is to get the queue size, aka, number of descs, of a specified
146 * queue. Different with the VHOST_USER_GET_QUEUE_NUM, which is used to get the
147 * max supported queues.
150 virtio_user_get_queue_num(struct virtio_hw *hw, uint16_t queue_id __rte_unused)
152 struct virtio_user_dev *dev = virtio_user_get_dev(hw);
154 /* Currently, each queue has same queue size */
155 return dev->queue_size;
159 virtio_user_setup_queue(struct virtio_hw *hw, struct virtqueue *vq)
161 struct virtio_user_dev *dev = virtio_user_get_dev(hw);
162 uint16_t queue_idx = vq->vq_queue_index;
163 uint64_t desc_addr, avail_addr, used_addr;
165 desc_addr = (uintptr_t)vq->vq_ring_virt_mem;
166 avail_addr = desc_addr + vq->vq_nentries * sizeof(struct vring_desc);
167 used_addr = RTE_ALIGN_CEIL(avail_addr + offsetof(struct vring_avail,
168 ring[vq->vq_nentries]),
169 VIRTIO_PCI_VRING_ALIGN);
171 dev->vrings[queue_idx].num = vq->vq_nentries;
172 dev->vrings[queue_idx].desc = (void *)(uintptr_t)desc_addr;
173 dev->vrings[queue_idx].avail = (void *)(uintptr_t)avail_addr;
174 dev->vrings[queue_idx].used = (void *)(uintptr_t)used_addr;
180 virtio_user_del_queue(struct virtio_hw *hw, struct virtqueue *vq)
182 /* For legacy devices, write 0 to VIRTIO_PCI_QUEUE_PFN port, QEMU
183 * correspondingly stops the ioeventfds, and reset the status of
185 * For modern devices, set queue desc, avail, used in PCI bar to 0,
186 * not see any more behavior in QEMU.
188 * Here we just care about what information to deliver to vhost-user
189 * or vhost-kernel. So we just close ioeventfd for now.
191 struct virtio_user_dev *dev = virtio_user_get_dev(hw);
193 close(dev->callfds[vq->vq_queue_index]);
194 close(dev->kickfds[vq->vq_queue_index]);
198 virtio_user_notify_queue(struct virtio_hw *hw, struct virtqueue *vq)
201 struct virtio_user_dev *dev = virtio_user_get_dev(hw);
203 if (write(dev->kickfds[vq->vq_queue_index], &buf, sizeof(buf)) < 0)
204 PMD_DRV_LOG(ERR, "failed to kick backend: %s\n",
208 static const struct virtio_pci_ops virtio_user_ops = {
209 .read_dev_cfg = virtio_user_read_dev_config,
210 .write_dev_cfg = virtio_user_write_dev_config,
211 .reset = virtio_user_reset,
212 .get_status = virtio_user_get_status,
213 .set_status = virtio_user_set_status,
214 .get_features = virtio_user_get_features,
215 .set_features = virtio_user_set_features,
216 .get_isr = virtio_user_get_isr,
217 .set_config_irq = virtio_user_set_config_irq,
218 .get_queue_num = virtio_user_get_queue_num,
219 .setup_queue = virtio_user_setup_queue,
220 .del_queue = virtio_user_del_queue,
221 .notify_queue = virtio_user_notify_queue,
224 static const char *valid_args[] = {
225 #define VIRTIO_USER_ARG_QUEUES_NUM "queues"
226 VIRTIO_USER_ARG_QUEUES_NUM,
227 #define VIRTIO_USER_ARG_CQ_NUM "cq"
228 VIRTIO_USER_ARG_CQ_NUM,
229 #define VIRTIO_USER_ARG_MAC "mac"
231 #define VIRTIO_USER_ARG_PATH "path"
232 VIRTIO_USER_ARG_PATH,
233 #define VIRTIO_USER_ARG_QUEUE_SIZE "queue_size"
234 VIRTIO_USER_ARG_QUEUE_SIZE,
238 #define VIRTIO_USER_DEF_CQ_EN 0
239 #define VIRTIO_USER_DEF_Q_NUM 1
240 #define VIRTIO_USER_DEF_Q_SZ 256
243 get_string_arg(const char *key __rte_unused,
244 const char *value, void *extra_args)
246 if (!value || !extra_args)
249 *(char **)extra_args = strdup(value);
255 get_integer_arg(const char *key __rte_unused,
256 const char *value, void *extra_args)
258 if (!value || !extra_args)
261 *(uint64_t *)extra_args = strtoull(value, NULL, 0);
266 static struct rte_eth_dev *
267 virtio_user_eth_dev_alloc(const char *name)
269 struct rte_eth_dev *eth_dev;
270 struct rte_eth_dev_data *data;
271 struct virtio_hw *hw;
272 struct virtio_user_dev *dev;
274 eth_dev = rte_eth_dev_allocate(name, RTE_ETH_DEV_VIRTUAL);
276 PMD_INIT_LOG(ERR, "cannot alloc rte_eth_dev");
280 data = eth_dev->data;
282 hw = rte_zmalloc(NULL, sizeof(*hw), 0);
284 PMD_INIT_LOG(ERR, "malloc virtio_hw failed");
285 rte_eth_dev_release_port(eth_dev);
289 dev = rte_zmalloc(NULL, sizeof(*dev), 0);
291 PMD_INIT_LOG(ERR, "malloc virtio_user_dev failed");
292 rte_eth_dev_release_port(eth_dev);
297 hw->vtpci_ops = &virtio_user_ops;
300 hw->virtio_user_dev = dev;
301 data->dev_private = hw;
302 data->numa_node = SOCKET_ID_ANY;
303 data->kdrv = RTE_KDRV_NONE;
304 data->dev_flags = RTE_ETH_DEV_DETACHABLE;
305 eth_dev->pci_dev = NULL;
306 eth_dev->driver = NULL;
310 /* Dev initialization routine. Invoked once for each virtio vdev at
311 * EAL init time, see rte_eal_dev_init().
312 * Returns 0 on success.
315 virtio_user_pmd_devinit(const char *name, const char *params)
317 struct rte_kvargs *kvlist;
318 struct rte_eth_dev *eth_dev;
319 struct virtio_hw *hw;
320 uint64_t queues = VIRTIO_USER_DEF_Q_NUM;
321 uint64_t cq = VIRTIO_USER_DEF_CQ_EN;
322 uint64_t queue_size = VIRTIO_USER_DEF_Q_SZ;
324 char *mac_addr = NULL;
327 if (!params || params[0] == '\0') {
328 PMD_INIT_LOG(ERR, "arg %s is mandatory for virtio-user",
329 VIRTIO_USER_ARG_QUEUE_SIZE);
333 kvlist = rte_kvargs_parse(params, valid_args);
335 PMD_INIT_LOG(ERR, "error when parsing param");
339 if (rte_kvargs_count(kvlist, VIRTIO_USER_ARG_PATH) == 1)
340 rte_kvargs_process(kvlist, VIRTIO_USER_ARG_PATH,
341 &get_string_arg, &path);
343 PMD_INIT_LOG(ERR, "arg %s is mandatory for virtio-user\n",
344 VIRTIO_USER_ARG_QUEUE_SIZE);
348 if (rte_kvargs_count(kvlist, VIRTIO_USER_ARG_MAC) == 1)
349 rte_kvargs_process(kvlist, VIRTIO_USER_ARG_MAC,
350 &get_string_arg, &mac_addr);
352 if (rte_kvargs_count(kvlist, VIRTIO_USER_ARG_QUEUE_SIZE) == 1)
353 rte_kvargs_process(kvlist, VIRTIO_USER_ARG_QUEUE_SIZE,
354 &get_integer_arg, &queue_size);
356 if (rte_kvargs_count(kvlist, VIRTIO_USER_ARG_QUEUES_NUM) == 1)
357 rte_kvargs_process(kvlist, VIRTIO_USER_ARG_QUEUES_NUM,
358 &get_integer_arg, &queues);
360 if (rte_kvargs_count(kvlist, VIRTIO_USER_ARG_CQ_NUM) == 1)
361 rte_kvargs_process(kvlist, VIRTIO_USER_ARG_CQ_NUM,
362 &get_integer_arg, &cq);
364 eth_dev = virtio_user_eth_dev_alloc(name);
366 PMD_INIT_LOG(ERR, "virtio-user fails to alloc device");
370 hw = eth_dev->data->dev_private;
371 if (virtio_user_dev_init(hw->virtio_user_dev, path, queues, cq,
372 queue_size, mac_addr) < 0)
375 /* previously called by rte_eal_pci_probe() for physical dev */
376 if (eth_virtio_dev_init(eth_dev) < 0) {
377 PMD_INIT_LOG(ERR, "eth_virtio_dev_init fails");
390 /** Called by rte_eth_dev_detach() */
392 virtio_user_pmd_devuninit(const char *name)
394 struct rte_eth_dev *eth_dev;
395 struct virtio_hw *hw;
396 struct virtio_user_dev *dev;
401 PMD_DRV_LOG(INFO, "Un-Initializing %s\n", name);
402 eth_dev = rte_eth_dev_allocated(name);
406 /* make sure the device is stopped, queues freed */
407 rte_eth_dev_close(eth_dev->data->port_id);
409 hw = eth_dev->data->dev_private;
410 dev = hw->virtio_user_dev;
411 virtio_user_dev_uninit(dev);
413 rte_free(eth_dev->data->dev_private);
414 rte_free(eth_dev->data);
415 rte_eth_dev_release_port(eth_dev);
420 static struct rte_driver virtio_user_driver = {
421 .name = "virtio-user",
423 .init = virtio_user_pmd_devinit,
424 .uninit = virtio_user_pmd_devuninit,
427 PMD_REGISTER_DRIVER(virtio_user_driver);