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_errno.h>
23 #include "rte_bus_vdev.h"
24 #include "vdev_logs.h"
28 /* Forward declare to access virtual bus name */
29 static struct rte_bus rte_vdev_bus;
31 /** Double linked list of virtual device drivers. */
32 TAILQ_HEAD(vdev_device_list, rte_vdev_device);
34 static struct vdev_device_list vdev_device_list =
35 TAILQ_HEAD_INITIALIZER(vdev_device_list);
36 struct vdev_driver_list vdev_driver_list =
37 TAILQ_HEAD_INITIALIZER(vdev_driver_list);
39 struct vdev_custom_scan {
40 TAILQ_ENTRY(vdev_custom_scan) next;
41 rte_vdev_scan_callback callback;
44 TAILQ_HEAD(vdev_custom_scans, vdev_custom_scan);
45 static struct vdev_custom_scans vdev_custom_scans =
46 TAILQ_HEAD_INITIALIZER(vdev_custom_scans);
47 static rte_spinlock_t vdev_custom_scan_lock = RTE_SPINLOCK_INITIALIZER;
49 /* register a driver */
51 rte_vdev_register(struct rte_vdev_driver *driver)
53 TAILQ_INSERT_TAIL(&vdev_driver_list, driver, next);
56 /* unregister a driver */
58 rte_vdev_unregister(struct rte_vdev_driver *driver)
60 TAILQ_REMOVE(&vdev_driver_list, driver, next);
64 rte_vdev_add_custom_scan(rte_vdev_scan_callback callback, void *user_arg)
66 struct vdev_custom_scan *custom_scan;
68 rte_spinlock_lock(&vdev_custom_scan_lock);
70 /* check if already registered */
71 TAILQ_FOREACH(custom_scan, &vdev_custom_scans, next) {
72 if (custom_scan->callback == callback &&
73 custom_scan->user_arg == user_arg)
77 if (custom_scan == NULL) {
78 custom_scan = malloc(sizeof(struct vdev_custom_scan));
79 if (custom_scan != NULL) {
80 custom_scan->callback = callback;
81 custom_scan->user_arg = user_arg;
82 TAILQ_INSERT_TAIL(&vdev_custom_scans, custom_scan, next);
86 rte_spinlock_unlock(&vdev_custom_scan_lock);
88 return (custom_scan == NULL) ? -1 : 0;
92 rte_vdev_remove_custom_scan(rte_vdev_scan_callback callback, void *user_arg)
94 struct vdev_custom_scan *custom_scan, *tmp_scan;
96 rte_spinlock_lock(&vdev_custom_scan_lock);
97 TAILQ_FOREACH_SAFE(custom_scan, &vdev_custom_scans, next, tmp_scan) {
98 if (custom_scan->callback != callback ||
99 (custom_scan->user_arg != (void *)-1 &&
100 custom_scan->user_arg != user_arg))
102 TAILQ_REMOVE(&vdev_custom_scans, custom_scan, next);
105 rte_spinlock_unlock(&vdev_custom_scan_lock);
111 vdev_parse(const char *name, void *addr)
113 struct rte_vdev_driver **out = addr;
114 struct rte_vdev_driver *driver = NULL;
116 TAILQ_FOREACH(driver, &vdev_driver_list, next) {
117 if (strncmp(driver->driver.name, name,
118 strlen(driver->driver.name)) == 0)
120 if (driver->driver.alias &&
121 strncmp(driver->driver.alias, name,
122 strlen(driver->driver.alias)) == 0)
125 if (driver != NULL &&
128 return driver == NULL;
132 vdev_probe_all_drivers(struct rte_vdev_device *dev)
135 struct rte_vdev_driver *driver;
138 name = rte_vdev_device_name(dev);
140 VDEV_LOG(DEBUG, "Search driver %s to probe device %s\n", name,
141 rte_vdev_device_name(dev));
143 if (vdev_parse(name, &driver))
145 dev->device.driver = &driver->driver;
146 ret = driver->probe(dev);
148 dev->device.driver = NULL;
152 static struct rte_vdev_device *
153 find_vdev(const char *name)
155 struct rte_vdev_device *dev;
160 TAILQ_FOREACH(dev, &vdev_device_list, next) {
161 const char *devname = rte_vdev_device_name(dev);
163 if (!strcmp(devname, name))
170 static struct rte_devargs *
171 alloc_devargs(const char *name, const char *args)
173 struct rte_devargs *devargs;
176 devargs = calloc(1, sizeof(*devargs));
180 devargs->bus = &rte_vdev_bus;
182 devargs->args = strdup(args);
184 devargs->args = strdup("");
186 ret = snprintf(devargs->name, sizeof(devargs->name), "%s", name);
187 if (ret < 0 || ret >= (int)sizeof(devargs->name)) {
197 rte_vdev_init(const char *name, const char *args)
199 struct rte_vdev_device *dev;
200 struct rte_devargs *devargs;
206 dev = find_vdev(name);
210 devargs = alloc_devargs(name, args);
214 dev = calloc(1, sizeof(*dev));
220 dev->device.devargs = devargs;
221 dev->device.numa_node = SOCKET_ID_ANY;
222 dev->device.name = devargs->name;
224 ret = vdev_probe_all_drivers(dev);
227 VDEV_LOG(ERR, "no driver found for %s\n", name);
231 TAILQ_INSERT_TAIL(&devargs_list, devargs, next);
233 TAILQ_INSERT_TAIL(&vdev_device_list, dev, next);
244 vdev_remove_driver(struct rte_vdev_device *dev)
246 const char *name = rte_vdev_device_name(dev);
247 const struct rte_vdev_driver *driver;
249 if (!dev->device.driver) {
250 VDEV_LOG(DEBUG, "no driver attach to device %s\n", name);
254 driver = container_of(dev->device.driver, const struct rte_vdev_driver,
256 return driver->remove(dev);
260 rte_vdev_uninit(const char *name)
262 struct rte_vdev_device *dev;
263 struct rte_devargs *devargs;
269 dev = find_vdev(name);
273 devargs = dev->device.devargs;
275 ret = vdev_remove_driver(dev);
279 TAILQ_REMOVE(&vdev_device_list, dev, next);
281 TAILQ_REMOVE(&devargs_list, devargs, next);
292 struct rte_vdev_device *dev;
293 struct rte_devargs *devargs;
294 struct vdev_custom_scan *custom_scan;
296 /* call custom scan callbacks if any */
297 rte_spinlock_lock(&vdev_custom_scan_lock);
298 TAILQ_FOREACH(custom_scan, &vdev_custom_scans, next) {
299 if (custom_scan->callback != NULL)
301 * the callback should update devargs list
302 * by calling rte_eal_devargs_insert() with
303 * devargs.bus = rte_bus_find_by_name("vdev");
304 * devargs.type = RTE_DEVTYPE_VIRTUAL;
305 * devargs.policy = RTE_DEV_WHITELISTED;
307 custom_scan->callback(custom_scan->user_arg);
309 rte_spinlock_unlock(&vdev_custom_scan_lock);
311 /* for virtual devices we scan the devargs_list populated via cmdline */
312 TAILQ_FOREACH(devargs, &devargs_list, next) {
314 if (devargs->bus != &rte_vdev_bus)
317 dev = find_vdev(devargs->name);
321 dev = calloc(1, sizeof(*dev));
325 dev->device.devargs = devargs;
326 dev->device.numa_node = SOCKET_ID_ANY;
327 dev->device.name = devargs->name;
329 TAILQ_INSERT_TAIL(&vdev_device_list, dev, next);
338 struct rte_vdev_device *dev;
341 /* call the init function for each virtual device */
342 TAILQ_FOREACH(dev, &vdev_device_list, next) {
344 if (dev->device.driver)
347 if (vdev_probe_all_drivers(dev)) {
348 VDEV_LOG(ERR, "failed to initialize %s device\n",
349 rte_vdev_device_name(dev));
357 static struct rte_device *
358 vdev_find_device(const struct rte_device *start, rte_dev_cmp_t cmp,
361 struct rte_vdev_device *dev;
363 TAILQ_FOREACH(dev, &vdev_device_list, next) {
364 if (start && &dev->device == start) {
368 if (cmp(&dev->device, data) == 0)
375 vdev_plug(struct rte_device *dev)
377 return vdev_probe_all_drivers(RTE_DEV_TO_VDEV(dev));
381 vdev_unplug(struct rte_device *dev)
383 return rte_vdev_uninit(dev->name);
386 static struct rte_bus rte_vdev_bus = {
389 .find_device = vdev_find_device,
391 .unplug = vdev_unplug,
395 RTE_REGISTER_BUS(vdev, rte_vdev_bus);
397 RTE_INIT(vdev_init_log)
399 vdev_logtype_bus = rte_log_register("bus.vdev");
400 if (vdev_logtype_bus >= 0)
401 rte_log_set_level(vdev_logtype_bus, RTE_LOG_NOTICE);