1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2016 RehiveTech. All rights reserved.
11 #include <sys/queue.h>
16 #include <rte_common.h>
17 #include <rte_devargs.h>
18 #include <rte_memory.h>
19 #include <rte_tailq.h>
20 #include <rte_spinlock.h>
21 #include <rte_string_fns.h>
22 #include <rte_errno.h>
24 #include "rte_bus_vdev.h"
25 #include "vdev_logs.h"
26 #include "vdev_private.h"
28 #define VDEV_MP_KEY "bus_vdev_mp"
30 /* Forward declare to access virtual bus name */
31 static struct rte_bus rte_vdev_bus;
33 /** Double linked list of virtual device drivers. */
34 TAILQ_HEAD(vdev_device_list, rte_vdev_device);
36 static struct vdev_device_list vdev_device_list =
37 TAILQ_HEAD_INITIALIZER(vdev_device_list);
38 /* The lock needs to be recursive because a vdev can manage another vdev. */
39 static rte_spinlock_recursive_t vdev_device_list_lock =
40 RTE_SPINLOCK_RECURSIVE_INITIALIZER;
42 static struct vdev_driver_list vdev_driver_list =
43 TAILQ_HEAD_INITIALIZER(vdev_driver_list);
45 struct vdev_custom_scan {
46 TAILQ_ENTRY(vdev_custom_scan) next;
47 rte_vdev_scan_callback callback;
50 TAILQ_HEAD(vdev_custom_scans, vdev_custom_scan);
51 static struct vdev_custom_scans vdev_custom_scans =
52 TAILQ_HEAD_INITIALIZER(vdev_custom_scans);
53 static rte_spinlock_t vdev_custom_scan_lock = RTE_SPINLOCK_INITIALIZER;
55 /* register a driver */
57 rte_vdev_register(struct rte_vdev_driver *driver)
59 TAILQ_INSERT_TAIL(&vdev_driver_list, driver, next);
62 /* unregister a driver */
64 rte_vdev_unregister(struct rte_vdev_driver *driver)
66 TAILQ_REMOVE(&vdev_driver_list, driver, next);
70 rte_vdev_add_custom_scan(rte_vdev_scan_callback callback, void *user_arg)
72 struct vdev_custom_scan *custom_scan;
74 rte_spinlock_lock(&vdev_custom_scan_lock);
76 /* check if already registered */
77 TAILQ_FOREACH(custom_scan, &vdev_custom_scans, next) {
78 if (custom_scan->callback == callback &&
79 custom_scan->user_arg == user_arg)
83 if (custom_scan == NULL) {
84 custom_scan = malloc(sizeof(struct vdev_custom_scan));
85 if (custom_scan != NULL) {
86 custom_scan->callback = callback;
87 custom_scan->user_arg = user_arg;
88 TAILQ_INSERT_TAIL(&vdev_custom_scans, custom_scan, next);
92 rte_spinlock_unlock(&vdev_custom_scan_lock);
94 return (custom_scan == NULL) ? -1 : 0;
98 rte_vdev_remove_custom_scan(rte_vdev_scan_callback callback, void *user_arg)
100 struct vdev_custom_scan *custom_scan, *tmp_scan;
102 rte_spinlock_lock(&vdev_custom_scan_lock);
103 RTE_TAILQ_FOREACH_SAFE(custom_scan, &vdev_custom_scans, next,
105 if (custom_scan->callback != callback ||
106 (custom_scan->user_arg != (void *)-1 &&
107 custom_scan->user_arg != user_arg))
109 TAILQ_REMOVE(&vdev_custom_scans, custom_scan, next);
112 rte_spinlock_unlock(&vdev_custom_scan_lock);
118 vdev_parse(const char *name, void *addr)
120 struct rte_vdev_driver **out = addr;
121 struct rte_vdev_driver *driver = NULL;
123 TAILQ_FOREACH(driver, &vdev_driver_list, next) {
124 if (strncmp(driver->driver.name, name,
125 strlen(driver->driver.name)) == 0)
127 if (driver->driver.alias &&
128 strncmp(driver->driver.alias, name,
129 strlen(driver->driver.alias)) == 0)
132 if (driver != NULL &&
135 return driver == NULL;
139 vdev_dma_map(struct rte_device *dev, void *addr, uint64_t iova, size_t len)
141 struct rte_vdev_device *vdev = RTE_DEV_TO_VDEV(dev);
142 const struct rte_vdev_driver *driver;
149 if (!vdev->device.driver) {
150 VDEV_LOG(DEBUG, "no driver attach to device %s", dev->name);
154 driver = container_of(vdev->device.driver, const struct rte_vdev_driver,
158 return driver->dma_map(vdev, addr, iova, len);
164 vdev_dma_unmap(struct rte_device *dev, void *addr, uint64_t iova, size_t len)
166 struct rte_vdev_device *vdev = RTE_DEV_TO_VDEV(dev);
167 const struct rte_vdev_driver *driver;
174 if (!vdev->device.driver) {
175 VDEV_LOG(DEBUG, "no driver attach to device %s", dev->name);
179 driver = container_of(vdev->device.driver, const struct rte_vdev_driver,
182 if (driver->dma_unmap)
183 return driver->dma_unmap(vdev, addr, iova, len);
189 vdev_probe_all_drivers(struct rte_vdev_device *dev)
192 struct rte_vdev_driver *driver;
193 enum rte_iova_mode iova_mode;
196 if (rte_dev_is_probed(&dev->device))
199 name = rte_vdev_device_name(dev);
200 VDEV_LOG(DEBUG, "Search driver to probe device %s", name);
202 if (vdev_parse(name, &driver))
205 iova_mode = rte_eal_iova_mode();
206 if ((driver->drv_flags & RTE_VDEV_DRV_NEED_IOVA_AS_VA) && (iova_mode == RTE_IOVA_PA)) {
207 VDEV_LOG(ERR, "%s requires VA IOVA mode but current mode is PA, not initializing",
212 ret = driver->probe(dev);
214 dev->device.driver = &driver->driver;
218 /* The caller shall be responsible for thread-safe */
219 static struct rte_vdev_device *
220 find_vdev(const char *name)
222 struct rte_vdev_device *dev;
227 TAILQ_FOREACH(dev, &vdev_device_list, next) {
228 const char *devname = rte_vdev_device_name(dev);
230 if (!strcmp(devname, name))
237 static struct rte_devargs *
238 alloc_devargs(const char *name, const char *args)
240 struct rte_devargs *devargs;
243 devargs = calloc(1, sizeof(*devargs));
247 devargs->bus = &rte_vdev_bus;
249 devargs->data = strdup(args);
251 devargs->data = strdup("");
252 devargs->args = devargs->data;
254 ret = strlcpy(devargs->name, name, sizeof(devargs->name));
255 if (ret < 0 || ret >= (int)sizeof(devargs->name)) {
256 rte_devargs_reset(devargs);
265 insert_vdev(const char *name, const char *args,
266 struct rte_vdev_device **p_dev,
269 struct rte_vdev_device *dev;
270 struct rte_devargs *devargs;
276 devargs = alloc_devargs(name, args);
280 dev = calloc(1, sizeof(*dev));
286 dev->device.bus = &rte_vdev_bus;
287 dev->device.numa_node = SOCKET_ID_ANY;
288 dev->device.name = devargs->name;
290 if (find_vdev(name)) {
292 * A vdev is expected to have only one port.
293 * So there is no reason to try probing again,
294 * even with new arguments.
301 rte_devargs_insert(&devargs);
302 dev->device.devargs = devargs;
303 TAILQ_INSERT_TAIL(&vdev_device_list, dev, next);
310 rte_devargs_reset(devargs);
317 rte_vdev_init(const char *name, const char *args)
319 struct rte_vdev_device *dev;
322 rte_spinlock_recursive_lock(&vdev_device_list_lock);
323 ret = insert_vdev(name, args, &dev, true);
325 ret = vdev_probe_all_drivers(dev);
328 VDEV_LOG(ERR, "no driver found for %s", name);
329 /* If fails, remove it from vdev list */
330 TAILQ_REMOVE(&vdev_device_list, dev, next);
331 rte_devargs_remove(dev->device.devargs);
335 rte_spinlock_recursive_unlock(&vdev_device_list_lock);
340 vdev_remove_driver(struct rte_vdev_device *dev)
342 const char *name = rte_vdev_device_name(dev);
343 const struct rte_vdev_driver *driver;
345 if (!dev->device.driver) {
346 VDEV_LOG(DEBUG, "no driver attach to device %s", name);
350 driver = container_of(dev->device.driver, const struct rte_vdev_driver,
352 return driver->remove(dev);
356 rte_vdev_uninit(const char *name)
358 struct rte_vdev_device *dev;
364 rte_spinlock_recursive_lock(&vdev_device_list_lock);
366 dev = find_vdev(name);
372 ret = vdev_remove_driver(dev);
376 TAILQ_REMOVE(&vdev_device_list, dev, next);
377 rte_devargs_remove(dev->device.devargs);
381 rte_spinlock_recursive_unlock(&vdev_device_list_lock);
386 #define VDEV_SCAN_REQ 1
387 #define VDEV_SCAN_ONE 2
388 #define VDEV_SCAN_REP 3
391 char name[RTE_DEV_NAME_MAX_LEN];
394 static int vdev_plug(struct rte_device *dev);
397 * This function works as the action for both primary and secondary process
398 * for static vdev discovery when a secondary process is booting.
400 * step 1, secondary process sends a sync request to ask for vdev in primary;
401 * step 2, primary process receives the request, and send vdevs one by one;
402 * step 3, primary process sends back reply, which indicates how many vdevs
406 vdev_action(const struct rte_mp_msg *mp_msg, const void *peer)
408 struct rte_vdev_device *dev;
409 struct rte_mp_msg mp_resp;
410 struct vdev_param *ou = (struct vdev_param *)&mp_resp.param;
411 const struct vdev_param *in = (const struct vdev_param *)mp_msg->param;
416 strlcpy(mp_resp.name, VDEV_MP_KEY, sizeof(mp_resp.name));
417 mp_resp.len_param = sizeof(*ou);
422 ou->type = VDEV_SCAN_ONE;
426 rte_spinlock_recursive_lock(&vdev_device_list_lock);
427 TAILQ_FOREACH(dev, &vdev_device_list, next) {
428 devname = rte_vdev_device_name(dev);
429 if (strlen(devname) == 0) {
430 VDEV_LOG(INFO, "vdev with no name is not sent");
433 VDEV_LOG(INFO, "send vdev, %s", devname);
434 strlcpy(ou->name, devname, RTE_DEV_NAME_MAX_LEN);
435 if (rte_mp_sendmsg(&mp_resp) < 0)
436 VDEV_LOG(ERR, "send vdev, %s, failed, %s",
437 devname, strerror(rte_errno));
440 rte_spinlock_recursive_unlock(&vdev_device_list_lock);
442 ou->type = VDEV_SCAN_REP;
444 if (rte_mp_reply(&mp_resp, peer) < 0)
445 VDEV_LOG(ERR, "Failed to reply a scan request");
448 VDEV_LOG(INFO, "receive vdev, %s", in->name);
449 ret = insert_vdev(in->name, NULL, NULL, false);
451 VDEV_LOG(DEBUG, "device already exist, %s", in->name);
453 VDEV_LOG(ERR, "failed to add vdev, %s", in->name);
456 VDEV_LOG(ERR, "vdev cannot recognize this message");
465 struct rte_vdev_device *dev;
466 struct rte_devargs *devargs;
467 struct vdev_custom_scan *custom_scan;
469 if (rte_mp_action_register(VDEV_MP_KEY, vdev_action) < 0 &&
470 rte_errno != EEXIST) {
471 /* for primary, unsupported IPC is not an error */
472 if (rte_eal_process_type() == RTE_PROC_PRIMARY &&
473 rte_errno == ENOTSUP)
475 VDEV_LOG(ERR, "Failed to add vdev mp action");
479 if (rte_eal_process_type() == RTE_PROC_SECONDARY) {
480 struct rte_mp_msg mp_req, *mp_rep;
481 struct rte_mp_reply mp_reply;
482 struct timespec ts = {.tv_sec = 5, .tv_nsec = 0};
483 struct vdev_param *req = (struct vdev_param *)mp_req.param;
484 struct vdev_param *resp;
486 strlcpy(mp_req.name, VDEV_MP_KEY, sizeof(mp_req.name));
487 mp_req.len_param = sizeof(*req);
489 req->type = VDEV_SCAN_REQ;
490 if (rte_mp_request_sync(&mp_req, &mp_reply, &ts) == 0 &&
491 mp_reply.nb_received == 1) {
492 mp_rep = &mp_reply.msgs[0];
493 resp = (struct vdev_param *)mp_rep->param;
494 VDEV_LOG(INFO, "Received %d vdevs", resp->num);
497 VDEV_LOG(ERR, "Failed to request vdev from primary");
499 /* Fall through to allow private vdevs in secondary process */
503 /* call custom scan callbacks if any */
504 rte_spinlock_lock(&vdev_custom_scan_lock);
505 TAILQ_FOREACH(custom_scan, &vdev_custom_scans, next) {
506 if (custom_scan->callback != NULL)
508 * the callback should update devargs list
509 * by calling rte_devargs_insert() with
510 * devargs.bus = rte_bus_find_by_name("vdev");
511 * devargs.type = RTE_DEVTYPE_VIRTUAL;
512 * devargs.policy = RTE_DEV_ALLOWED;
514 custom_scan->callback(custom_scan->user_arg);
516 rte_spinlock_unlock(&vdev_custom_scan_lock);
518 /* for virtual devices we scan the devargs_list populated via cmdline */
519 RTE_EAL_DEVARGS_FOREACH("vdev", devargs) {
521 dev = calloc(1, sizeof(*dev));
525 rte_spinlock_recursive_lock(&vdev_device_list_lock);
527 if (find_vdev(devargs->name)) {
528 rte_spinlock_recursive_unlock(&vdev_device_list_lock);
533 dev->device.bus = &rte_vdev_bus;
534 dev->device.devargs = devargs;
535 dev->device.numa_node = SOCKET_ID_ANY;
536 dev->device.name = devargs->name;
538 TAILQ_INSERT_TAIL(&vdev_device_list, dev, next);
540 rte_spinlock_recursive_unlock(&vdev_device_list_lock);
549 struct rte_vdev_device *dev;
552 /* call the init function for each virtual device */
553 TAILQ_FOREACH(dev, &vdev_device_list, next) {
554 /* we don't use the vdev lock here, as it's only used in DPDK
555 * initialization; and we don't want to hold such a lock when
556 * we call each driver probe.
559 r = vdev_probe_all_drivers(dev);
563 VDEV_LOG(ERR, "failed to initialize %s device",
564 rte_vdev_device_name(dev));
573 rte_vdev_find_device(const struct rte_device *start, rte_dev_cmp_t cmp,
576 const struct rte_vdev_device *vstart;
577 struct rte_vdev_device *dev;
579 rte_spinlock_recursive_lock(&vdev_device_list_lock);
581 vstart = RTE_DEV_TO_VDEV_CONST(start);
582 dev = TAILQ_NEXT(vstart, next);
584 dev = TAILQ_FIRST(&vdev_device_list);
586 while (dev != NULL) {
587 if (cmp(&dev->device, data) == 0)
589 dev = TAILQ_NEXT(dev, next);
591 rte_spinlock_recursive_unlock(&vdev_device_list_lock);
593 return dev ? &dev->device : NULL;
597 vdev_plug(struct rte_device *dev)
599 return vdev_probe_all_drivers(RTE_DEV_TO_VDEV(dev));
603 vdev_unplug(struct rte_device *dev)
605 return rte_vdev_uninit(dev->name);
608 static enum rte_iova_mode
609 vdev_get_iommu_class(void)
612 struct rte_vdev_device *dev;
613 struct rte_vdev_driver *driver;
615 TAILQ_FOREACH(dev, &vdev_device_list, next) {
616 name = rte_vdev_device_name(dev);
617 if (vdev_parse(name, &driver))
620 if (driver->drv_flags & RTE_VDEV_DRV_NEED_IOVA_AS_VA)
627 static struct rte_bus rte_vdev_bus = {
630 .find_device = rte_vdev_find_device,
632 .unplug = vdev_unplug,
634 .dma_map = vdev_dma_map,
635 .dma_unmap = vdev_dma_unmap,
636 .get_iommu_class = vdev_get_iommu_class,
637 .dev_iterate = rte_vdev_dev_iterate,
640 RTE_REGISTER_BUS(vdev, rte_vdev_bus);
641 RTE_LOG_REGISTER_DEFAULT(vdev_logtype_bus, NOTICE);