1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright (c) 2018, Microsoft Corporation.
10 #include <sys/queue.h>
16 #include <rte_tailq.h>
17 #include <rte_devargs.h>
18 #include <rte_lcore.h>
19 #include <rte_malloc.h>
20 #include <rte_errno.h>
21 #include <rte_memory.h>
22 #include <rte_bus_vmbus.h>
26 extern struct rte_vmbus_bus rte_vmbus_bus;
28 /* map a particular resource from a file */
30 vmbus_map_resource(void *requested_addr, int fd, off_t offset, size_t size,
35 /* Map the memory resource of device */
36 mapaddr = mmap(requested_addr, size, PROT_READ | PROT_WRITE,
37 MAP_SHARED | flags, fd, offset);
38 if (mapaddr == MAP_FAILED) {
40 "mmap(%d, %p, %zu, %ld) failed: %s",
41 fd, requested_addr, size, (long)offset,
47 /* unmap a particular resource */
49 vmbus_unmap_resource(void *requested_addr, size_t size)
51 if (requested_addr == NULL)
54 /* Unmap the VMBUS memory resource of device */
55 if (munmap(requested_addr, size)) {
56 VMBUS_LOG(ERR, "munmap(%p, 0x%lx) failed: %s",
57 requested_addr, (unsigned long)size,
60 VMBUS_LOG(DEBUG, " VMBUS memory unmapped at %p",
65 * Match the VMBUS driver and device using UUID table
68 * VMBUS driver from which ID table would be extracted
70 * VMBUS device to match against the driver
72 * true for successful match
73 * false for unsuccessful match
76 vmbus_match(const struct rte_vmbus_driver *dr,
77 const struct rte_vmbus_device *dev)
79 const rte_uuid_t *id_table;
81 for (id_table = dr->id_table; !rte_uuid_is_null(*id_table); ++id_table) {
82 if (rte_uuid_compare(*id_table, dev->class_id) == 0)
89 * If device ID match, call the devinit() function of the driver.
92 vmbus_probe_one_driver(struct rte_vmbus_driver *dr,
93 struct rte_vmbus_device *dev)
95 char guid[RTE_UUID_STRLEN];
98 if (!vmbus_match(dr, dev))
99 return 1; /* not supported */
101 rte_uuid_unparse(dev->device_id, guid, sizeof(guid));
102 VMBUS_LOG(INFO, "VMBUS device %s on NUMA socket %i",
103 guid, dev->device.numa_node);
105 /* TODO add block/allow logic */
107 /* map resources for device */
108 ret = rte_vmbus_map_device(dev);
112 /* reference driver structure */
115 if (dev->device.numa_node < 0) {
116 if (rte_socket_count() > 1)
117 VMBUS_LOG(INFO, "Device %s is not NUMA-aware, defaulting socket to 0",
119 dev->device.numa_node = 0;
122 /* call the driver probe() function */
123 VMBUS_LOG(INFO, " probe driver: %s", dr->driver.name);
124 ret = dr->probe(dr, dev);
127 rte_vmbus_unmap_device(dev);
129 dev->device.driver = &dr->driver;
136 * If device class GUID matches, call the probe function of
137 * registere drivers for the vmbus device.
138 * Return -1 if initialization failed,
139 * and 1 if no driver found for this device.
142 vmbus_probe_all_drivers(struct rte_vmbus_device *dev)
144 struct rte_vmbus_driver *dr;
147 /* Check if a driver is already loaded */
148 if (rte_dev_is_probed(&dev->device)) {
149 VMBUS_LOG(DEBUG, "VMBUS driver already loaded");
153 FOREACH_DRIVER_ON_VMBUS(dr) {
154 rc = vmbus_probe_one_driver(dr, dev);
155 if (rc < 0) /* negative is an error */
158 if (rc > 0) /* positive driver doesn't support it */
167 * Scan the vmbus, and call the devinit() function for
168 * all registered drivers that have a matching entry in its id_table
169 * for discovered devices.
172 rte_vmbus_probe(void)
174 struct rte_vmbus_device *dev;
175 size_t probed = 0, failed = 0;
176 char ubuf[RTE_UUID_STRLEN];
178 FOREACH_DEVICE_ON_VMBUS(dev) {
181 rte_uuid_unparse(dev->device_id, ubuf, sizeof(ubuf));
183 /* TODO: add allowlist/blocklist */
185 if (vmbus_probe_all_drivers(dev) < 0) {
187 "Requested device %s cannot be used", ubuf);
193 return (probed && probed == failed) ? -1 : 0;
197 vmbus_parse(const char *name, void *addr)
202 ret = rte_uuid_parse(name, guid);
203 if (ret == 0 && addr)
204 memcpy(addr, &guid, sizeof(guid));
210 * scan for matching device args on command line
212 * -a 'vmbus:635a7ae3-091e-4410-ad59-667c4f8c04c3,latency=20'
215 vmbus_devargs_lookup(struct rte_vmbus_device *dev)
217 struct rte_devargs *devargs;
220 RTE_EAL_DEVARGS_FOREACH("vmbus", devargs) {
221 vmbus_parse(devargs->name, &addr);
223 if (rte_uuid_compare(dev->device_id, addr) == 0)
230 /* register vmbus driver */
232 rte_vmbus_register(struct rte_vmbus_driver *driver)
235 "Registered driver %s", driver->driver.name);
237 TAILQ_INSERT_TAIL(&rte_vmbus_bus.driver_list, driver, next);
238 driver->bus = &rte_vmbus_bus;
241 /* unregister vmbus driver */
243 rte_vmbus_unregister(struct rte_vmbus_driver *driver)
245 TAILQ_REMOVE(&rte_vmbus_bus.driver_list, driver, next);
249 /* Add a device to VMBUS bus */
251 vmbus_add_device(struct rte_vmbus_device *vmbus_dev)
253 TAILQ_INSERT_TAIL(&rte_vmbus_bus.device_list, vmbus_dev, next);
256 /* Insert a device into a predefined position in VMBUS bus */
258 vmbus_insert_device(struct rte_vmbus_device *exist_vmbus_dev,
259 struct rte_vmbus_device *new_vmbus_dev)
261 TAILQ_INSERT_BEFORE(exist_vmbus_dev, new_vmbus_dev, next);
264 /* Remove a device from VMBUS bus */
266 vmbus_remove_device(struct rte_vmbus_device *vmbus_dev)
268 TAILQ_REMOVE(&rte_vmbus_bus.device_list, vmbus_dev, next);
271 /* VMBUS doesn't support hotplug */
272 static struct rte_device *
273 vmbus_find_device(const struct rte_device *start, rte_dev_cmp_t cmp,
276 struct rte_vmbus_device *dev;
278 FOREACH_DEVICE_ON_VMBUS(dev) {
279 if (start && &dev->device == start) {
283 if (cmp(&dev->device, data) == 0)
291 struct rte_vmbus_bus rte_vmbus_bus = {
293 .scan = rte_vmbus_scan,
294 .probe = rte_vmbus_probe,
295 .find_device = vmbus_find_device,
296 .parse = vmbus_parse,
298 .device_list = TAILQ_HEAD_INITIALIZER(rte_vmbus_bus.device_list),
299 .driver_list = TAILQ_HEAD_INITIALIZER(rte_vmbus_bus.driver_list),
302 RTE_REGISTER_BUS(vmbus, rte_vmbus_bus.bus);
303 RTE_LOG_REGISTER_DEFAULT(vmbus_logtype_bus, NOTICE);