2 * SPDX-License-Identifier: BSD-2-Clause
4 * Copyright (c) 2000 Michael Smith
5 * Copyright (c) 2000 BSDi
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #include <sys/cdefs.h>
32 * An interface to the FreeBSD kernel's bus/device information interface.
34 * This interface is implemented with the
40 * sysctls. The interface is not meant for general user application
43 * Device information is obtained by scanning a linear list of all devices
44 * maintained by the kernel. The actual device structure pointers are
45 * handed out as opaque handles in order to allow reconstruction of the
46 * logical toplogy in user space.
48 * Resource information is obtained by scanning the kernel's resource
49 * managers and fetching their contents. Ownership of resources is
50 * tracked using the device's structure pointer again as a handle.
52 * In order to ensure coherency of the library's picture of the kernel,
53 * a generation count is maintained by the kernel. The initial generation
54 * count is obtained (along with the interface version) from the hw.bus
55 * sysctl, and must be passed in with every request. If the generation
56 * number supplied by the library does not match the kernel's current
57 * generation number, the request is failed and the library must discard
58 * the data it has received and rescan.
60 * The information obtained from the kernel is exported to consumers of
61 * this library through a variety of interfaces.
64 #include <sys/param.h>
65 #include <sys/types.h>
66 #include <sys/sysctl.h>
73 #include "devinfo_var.h"
75 static int devinfo_init_devices(int generation);
76 static int devinfo_init_resources(int generation);
77 static void devinfo_free_dev(struct devinfo_i_dev *dd);
79 TAILQ_HEAD(,devinfo_i_dev) devinfo_dev;
80 TAILQ_HEAD(,devinfo_i_rman) devinfo_rman;
81 TAILQ_HEAD(,devinfo_i_res) devinfo_res;
83 static int devinfo_initted = 0;
84 static int devinfo_generation = 0;
87 # define debug(...) do { \
88 fprintf(stderr, "%s:", __func__); \
89 fprintf(stderr, __VA_ARGS__); \
90 fprintf(stderr, "\n"); \
97 * Initialise our local database with the contents of the kernel's
103 struct u_businfo ubus;
107 if (!devinfo_initted) {
108 TAILQ_INIT(&devinfo_dev);
109 TAILQ_INIT(&devinfo_rman);
110 TAILQ_INIT(&devinfo_res);
114 * Get the generation count and interface version, verify that we
115 * are compatible with the kernel.
117 for (retries = 0; retries < 10; retries++) {
118 debug("get interface version");
119 ub_size = sizeof(ubus);
120 if (sysctlbyname("hw.bus.info", &ubus,
121 &ub_size, NULL, 0) != 0) {
122 warn("sysctlbyname(\"hw.bus.info\", ...) failed");
125 if ((ub_size != sizeof(ubus)) ||
126 (ubus.ub_version != BUS_USER_VERSION)) {
127 warnx("kernel bus interface version mismatch: kernel %d expected %d",
128 ubus.ub_version, BUS_USER_VERSION);
131 debug("generation count is %d", ubus.ub_generation);
134 * Don't rescan if the generation count hasn't changed.
136 if (ubus.ub_generation == devinfo_generation)
140 * Generation count changed, rescan
144 devinfo_generation = 0;
146 if ((error = devinfo_init_devices(ubus.ub_generation)) != 0) {
152 if ((error = devinfo_init_resources(ubus.ub_generation)) != 0) {
159 devinfo_generation = ubus.ub_generation;
162 debug("scan failed after %d retries", retries);
168 devinfo_init_devices(int generation)
170 struct u_device udev;
171 struct devinfo_i_dev *dd;
175 int oid[CTL_MAXNAME + 12];
177 char *name, *walker, *ep;
181 * Find the OID for the rman interface node.
182 * This is just the usual evil, undocumented sysctl juju.
186 oidlen = sizeof(oid);
187 name = "hw.bus.devices";
188 error = sysctl(name2oid, 2, oid, &oidlen, name, strlen(name));
190 warnx("can't find hw.bus.devices sysctl node");
193 oidlen /= sizeof(int);
194 if (oidlen > CTL_MAXNAME) {
195 warnx("hw.bus.devices oid is too large");
198 oid[oidlen++] = generation;
204 * Stop after a fairly insane number to avoid death in the case
205 * of kernel corruption.
207 for (dev_idx = 0; dev_idx < 10000; dev_idx++) {
210 * Get the device information.
212 oid[dev_ptr] = dev_idx;
214 error = sysctl(oid, oidlen, &udev, &rlen, NULL, 0);
216 if (errno == ENOENT) /* end of list */
218 if (errno != EINVAL) /* gen count skip, restart */
219 warn("sysctl hw.bus.devices.%d", dev_idx);
222 if (rlen != sizeof(udev)) {
223 warnx("sysctl returned wrong data %zd bytes instead of %zd",
227 if ((dd = calloc(1, sizeof(*dd))) == NULL)
229 dd->dd_dev.dd_handle = udev.dv_handle;
230 dd->dd_dev.dd_parent = udev.dv_parent;
231 dd->dd_dev.dd_devflags = udev.dv_devflags;
232 dd->dd_dev.dd_flags = udev.dv_flags;
233 dd->dd_dev.dd_state = udev.dv_state;
235 walker = udev.dv_fields;
236 ep = walker + sizeof(udev.dv_fields);
239 dd->dd_drivername = NULL;
240 dd->dd_pnpinfo = NULL;
241 dd->dd_location = NULL;
243 dd->dd_dev.x = dd->x = strdup(walker); \
244 if (dd->x == NULL) { \
245 devinfo_free_dev(dd); \
248 if (walker + strnlen(walker, ep - walker) >= ep) { \
249 devinfo_free_dev(dd); \
252 walker += strlen(walker) + 1;
256 UNPACK(dd_drivername);
260 TAILQ_INSERT_TAIL(&devinfo_dev, dd, dd_link);
262 debug("fetched %d devices", dev_idx);
267 devinfo_init_resources(int generation)
270 struct devinfo_i_rman *dm;
271 struct u_resource ures;
272 struct devinfo_i_res *dr;
273 int rman_idx, res_idx;
274 int rman_ptr, res_ptr;
276 int oid[CTL_MAXNAME + 12];
282 * Find the OID for the rman interface node.
283 * This is just the usual evil, undocumented sysctl juju.
287 oidlen = sizeof(oid);
288 name = "hw.bus.rman";
289 error = sysctl(name2oid, 2, oid, &oidlen, name, strlen(name));
291 warnx("can't find hw.bus.rman sysctl node");
294 oidlen /= sizeof(int);
295 if (oidlen > CTL_MAXNAME) {
296 warnx("hw.bus.rman oid is too large");
299 oid[oidlen++] = generation;
304 * Scan resource managers.
306 * Stop after a fairly insane number to avoid death in the case
307 * of kernel corruption.
309 for (rman_idx = 0; rman_idx < 255; rman_idx++) {
312 * Get the resource manager information.
314 oid[rman_ptr] = rman_idx;
316 rlen = sizeof(urman);
317 error = sysctl(oid, oidlen, &urman, &rlen, NULL, 0);
319 if (errno == ENOENT) /* end of list */
321 if (errno != EINVAL) /* gen count skip, restart */
322 warn("sysctl hw.bus.rman.%d", rman_idx);
325 if ((dm = malloc(sizeof(*dm))) == NULL)
327 dm->dm_rman.dm_handle = urman.rm_handle;
328 dm->dm_rman.dm_start = urman.rm_start;
329 dm->dm_rman.dm_size = urman.rm_size;
330 snprintf(dm->dm_desc, DEVINFO_STRLEN, "%s", urman.rm_descr);
331 dm->dm_rman.dm_desc = &dm->dm_desc[0];
332 TAILQ_INSERT_TAIL(&devinfo_rman, dm, dm_link);
335 * Scan resources on this resource manager.
337 * Stop after a fairly insane number to avoid death in the case
338 * of kernel corruption.
340 for (res_idx = 0; res_idx < 1000; res_idx++) {
342 * Get the resource information.
344 oid[res_ptr] = res_idx;
346 error = sysctl(oid, oidlen, &ures, &rlen, NULL, 0);
348 if (errno == ENOENT) /* end of list */
350 if (errno != EINVAL) /* gen count skip */
351 warn("sysctl hw.bus.rman.%d.%d",
355 if ((dr = malloc(sizeof(*dr))) == NULL)
357 dr->dr_res.dr_handle = ures.r_handle;
358 dr->dr_res.dr_rman = ures.r_parent;
359 dr->dr_res.dr_device = ures.r_device;
360 dr->dr_res.dr_start = ures.r_start;
361 dr->dr_res.dr_size = ures.r_size;
362 TAILQ_INSERT_TAIL(&devinfo_res, dr, dr_link);
364 debug("fetched %d resources", res_idx);
366 debug("scanned %d resource managers", rman_idx);
371 * Free an individual dev.
374 devinfo_free_dev(struct devinfo_i_dev *dd)
378 free(dd->dd_drivername);
379 free(dd->dd_pnpinfo);
380 free(dd->dd_location);
385 * Free the list contents.
390 struct devinfo_i_dev *dd;
391 struct devinfo_i_rman *dm;
392 struct devinfo_i_res *dr;
394 while ((dd = TAILQ_FIRST(&devinfo_dev)) != NULL) {
395 TAILQ_REMOVE(&devinfo_dev, dd, dd_link);
396 devinfo_free_dev(dd);
398 while ((dm = TAILQ_FIRST(&devinfo_rman)) != NULL) {
399 TAILQ_REMOVE(&devinfo_rman, dm, dm_link);
402 while ((dr = TAILQ_FIRST(&devinfo_res)) != NULL) {
403 TAILQ_REMOVE(&devinfo_res, dr, dr_link);
407 devinfo_generation = 0;
411 * Find a device by its handle.
414 devinfo_handle_to_device(devinfo_handle_t handle)
416 struct devinfo_i_dev *dd;
419 * Find the root device, whose parent is NULL
421 if (handle == DEVINFO_ROOT_DEVICE) {
422 TAILQ_FOREACH(dd, &devinfo_dev, dd_link)
423 if (dd->dd_dev.dd_parent == DEVINFO_ROOT_DEVICE)
429 * Scan for the device
431 TAILQ_FOREACH(dd, &devinfo_dev, dd_link)
432 if (dd->dd_dev.dd_handle == handle)
438 * Find a resource by its handle.
441 devinfo_handle_to_resource(devinfo_handle_t handle)
443 struct devinfo_i_res *dr;
445 TAILQ_FOREACH(dr, &devinfo_res, dr_link)
446 if (dr->dr_res.dr_handle == handle)
452 * Find a resource manager by its handle.
454 struct devinfo_rman *
455 devinfo_handle_to_rman(devinfo_handle_t handle)
457 struct devinfo_i_rman *dm;
459 TAILQ_FOREACH(dm, &devinfo_rman, dm_link)
460 if (dm->dm_rman.dm_handle == handle)
461 return(&dm->dm_rman);
466 * Iterate over the children of a device, calling (fn) on each. If
467 * (fn) returns nonzero, abort the scan and return.
470 devinfo_foreach_device_child(struct devinfo_dev *parent,
471 int (* fn)(struct devinfo_dev *child, void *arg),
474 struct devinfo_i_dev *dd;
477 TAILQ_FOREACH(dd, &devinfo_dev, dd_link)
478 if (dd->dd_dev.dd_parent == parent->dd_handle)
479 if ((error = fn(&dd->dd_dev, arg)) != 0)
485 * Iterate over all the resources owned by a device, calling (fn) on each.
486 * If (fn) returns nonzero, abort the scan and return.
489 devinfo_foreach_device_resource(struct devinfo_dev *dev,
490 int (* fn)(struct devinfo_dev *dev, struct devinfo_res *res, void *arg),
493 struct devinfo_i_res *dr;
496 TAILQ_FOREACH(dr, &devinfo_res, dr_link)
497 if (dr->dr_res.dr_device == dev->dd_handle)
498 if ((error = fn(dev, &dr->dr_res, arg)) != 0)
504 * Iterate over all the resources owned by a resource manager, calling (fn)
505 * on each. If (fn) returns nonzero, abort the scan and return.
508 devinfo_foreach_rman_resource(struct devinfo_rman *rman,
509 int (* fn)(struct devinfo_res *res, void *arg),
512 struct devinfo_i_res *dr;
515 TAILQ_FOREACH(dr, &devinfo_res, dr_link)
516 if (dr->dr_res.dr_rman == rman->dm_handle)
517 if ((error = fn(&dr->dr_res, arg)) != 0)
523 * Iterate over all the resource managers, calling (fn) on each. If (fn)
524 * returns nonzero, abort the scan and return.
527 devinfo_foreach_rman(int (* fn)(struct devinfo_rman *rman, void *arg),
530 struct devinfo_i_rman *dm;
533 TAILQ_FOREACH(dm, &devinfo_rman, dm_link)
534 if ((error = fn(&dm->dm_rman, arg)) != 0)