2 * Copyright (c) 2017 Netflix, Inc
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
41 #include <sys/linker.h>
42 #include <sys/module.h>
44 #include <sys/sysctl.h>
46 /* options descriptor */
47 static struct option longopts[] = {
48 { "all", no_argument, NULL, 'a' },
49 { "dump", no_argument, NULL, 'd' },
50 { "hints", required_argument, NULL, 'h' },
51 { "nomatch", required_argument, NULL, 'p' },
52 { "unbound", no_argument, NULL, 'u' },
53 { "verbose", no_argument, NULL, 'v' },
57 #define DEVMATCH_MAX_HITS 256
59 static struct match_data {
62 } match_data[DEVMATCH_MAX_HITS];
67 static char *linker_hints;
68 static char *nomatch_str;
69 static int unbound_flag;
70 static int verbose_flag;
73 static void *hints_end;
76 read_hints(const char *fn, size_t *len)
82 fd = open(fn, O_RDONLY);
86 err(1, "Can't open %s for reading", fn);
88 if (fstat(fd, &sb) != 0)
89 err(1, "Can't fstat %s\n", fn);
90 h = malloc(sb.st_size);
92 err(1, "not enough space to read hints file of %ju bytes", (uintmax_t)sb.st_size);
93 if (read(fd, h, sb.st_size) != sb.st_size)
94 err(1, "Can't read in %ju bytes from %s", (uintmax_t)sb.st_size, fn);
101 read_linker_hints(void)
104 char *modpath, *p, *q;
107 if (linker_hints == NULL) {
108 if (sysctlbyname("kern.module_path", NULL, &buflen, NULL, 0) < 0)
109 errx(1, "Can't find kernel module path.");
110 modpath = malloc(buflen);
112 err(1, "Can't get memory for modpath.");
113 if (sysctlbyname("kern.module_path", modpath, &buflen, NULL, 0) < 0)
114 errx(1, "Can't find kernel module path.");
116 while ((q = strsep(&p, ";")) != NULL) {
117 snprintf(fn, sizeof(fn), "%s/linker.hints", q);
118 hints = read_hints(fn, &len);
124 warnx("Can't read linker hints file.");
130 hints = read_hints(linker_hints, &len);
132 err(1, "Can't open %s for reading", fn);
135 if (*(int *)(intptr_t)hints != LINKER_HINTS_VERSION) {
136 warnx("Linker hints version %d doesn't match expected %d.",
137 *(int *)(intptr_t)hints, LINKER_HINTS_VERSION);
142 hints_end = (void *)((intptr_t)hints + (intptr_t)len);
151 p = (int *)roundup2((intptr_t)p, sizeof(int));
158 getstr(void **ptr, char *val)
162 int len = *(uint8_t *)c;
164 memcpy(val, c + 1, len);
171 pnpval_as_int(const char *val, const char *pnpinfo)
180 cp = strchr(val, ';');
183 strlcpy(key + 1, val, sizeof(key) - 1);
185 memcpy(key + 1, val, cp - val);
186 key[cp - val + 1] = '\0';
188 strlcat(key, "=", sizeof(key));
189 if (strncmp(key + 1, pnpinfo, strlen(key + 1)) == 0)
190 rv = strtol(pnpinfo + strlen(key + 1), NULL, 0);
192 cp = strstr(pnpinfo, key);
196 rv = strtol(cp + strlen(key), NULL, 0);
202 quoted_strcpy(char *dst, const char *src)
206 if (*src == '\'' || *src == '"')
208 while (*src && *src != q)
209 *dst++ = *src++; // XXX backtick quoting
215 pnpval_as_str(const char *val, const char *pnpinfo)
217 static char retval[256];
221 if (pnpinfo == NULL) {
226 cp = strchr(val, ';');
229 strlcpy(key + 1, val, sizeof(key) - 1);
231 memcpy(key + 1, val, cp - val);
232 key[cp - val + 1] = '\0';
234 strlcat(key, "=", sizeof(key));
235 if (strncmp(key + 1, pnpinfo, strlen(key + 1)) == 0)
236 quoted_strcpy(retval, pnpinfo + strlen(key + 1));
238 cp = strstr(pnpinfo, key);
240 strcpy(retval, "MISSING");
242 quoted_strcpy(retval, cp + strlen(key));
248 match_data_compare(const void *_pa, const void *_pb)
250 const struct match_data *pa = _pa;
251 const struct match_data *pb = _pb;
253 /* biggest value first */
254 if (pa->priority > pb->priority)
256 else if (pa->priority < pb->priority)
259 /* then sort by string */
260 return (strcmp(pa->descr, pb->descr));
269 for (x = 0; x != 16; x++) {
270 if ((input >> x) & 1)
271 retval |= (0x8000 >> x);
277 search_hints(const char *bus, const char *dev, const char *pnpinfo)
279 char val1[256], val2[256];
280 int ival, len, ents, i, notme, mask, bit, v, found;
282 char *lastmod = NULL, *cp, *s;
288 printf("Searching bus %s dev %s for pnpinfo %s\n",
290 while (walker < hints_end) {
291 len = getint(&walker);
292 ival = getint(&walker);
299 if (dump_flag || verbose_flag)
300 printf("Version: if %s.%d kmod %s\n", val1, ival, val2);
307 lastmod = strdup(val2);
308 if (dump_flag || verbose_flag)
309 printf("Module %s in %s\n", val1, val2);
312 if (!dump_flag && !unbound_flag && lastmod && strcmp(lastmod, "kernel") == 0)
317 if (dump_flag || verbose_flag)
318 printf("PNP info for bus %s format %s %d entries (%s)\n",
319 val1, val2, ents, lastmod);
320 if (strcmp(val1, "usb") == 0) {
322 printf("Treating usb as uhub -- bug in source table still?\n");
323 strcpy(val1, "uhub");
325 if (bus && strcmp(val1, bus) != 0) {
327 printf("Skipped because table for bus %s, looking for %s\n",
331 for (i = 0; i < ents; i++) {
333 printf("---------- Entry %d ----------\n", i);
342 /* All integer fields */
350 printf("%#x:", ival);
353 if (bit >= 0 && ((1 << bit) & mask) == 0)
355 v = pnpval_as_int(cp + 2, pnpinfo);
357 printf("Matching %s (%c) table=%#x tomatch=%#x\n",
358 cp + 2, *cp, v, ival);
386 printf("'%s':", val1);
391 s = pnpval_as_str(cp + 2, pnpinfo);
392 if (strcmp(s, val1) != 0)
395 /* Key override fields, required to be last in the string */
398 * This is imperfect and only does one key and will be redone
399 * to be more general for multiple keys. Currently, nothing
402 if (dump_flag) /* No per-row data stored */
404 if (cp[strlen(cp) - 1] == ';') /* Skip required ; at end */
405 cp[strlen(cp) - 1] = '\0'; /* in case it's not there */
406 if ((s = strstr(pnpinfo, cp + 2)) == NULL)
408 else if (s > pnpinfo && s[-1] != ' ')
412 fprintf(stderr, "Unknown field type %c\n:", *cp);
416 cp = strchr(cp, ';');
427 asprintf(&descr, "%s: %s", *dev ? dev : "unattached", lastmod);
429 asprintf(&descr, "%s", lastmod);
431 printf("Matches --- %s ---\n", lastmod);
433 if (descr != NULL && hit_index < DEVMATCH_MAX_HITS) {
434 match_data[hit_index].descr = descr;
435 match_data[hit_index].priority = bitrev16(mask);
447 printf("Unknown Type %d len %d\n", ival, len);
450 walker = (void *)(len - sizeof(int) + (intptr_t)walker);
452 if (hit_index != 0) {
453 /* sort hits by priority */
454 mergesort(match_data, hit_index, sizeof(match_data[0]), &match_data_compare);
457 for (i = 0; i != hit_index; i++) {
458 puts(match_data[i].descr);
459 free(match_data[i].descr);
462 /* reset hit_index */
465 if (unbound_flag && found == 0 && *pnpinfo) {
467 printf("------------------------- ");
468 printf("%s on %s pnpinfo %s", *dev ? dev : "unattached", bus, pnpinfo);
470 printf(" -------------------------");
477 find_unmatched(struct devinfo_dev *dev, void *arg)
479 struct devinfo_dev *parent;
483 if (!all_flag && dev->dd_name[0] != '\0')
485 if (!(dev->dd_flags & DF_ENABLED))
487 parent = devinfo_handle_to_device(dev->dd_parent);
488 bus = strdup(parent->dd_name);
489 p = bus + strlen(bus) - 1;
490 while (p >= bus && isdigit(*p))
494 printf("Searching %s %s bus at %s for pnpinfo %s\n",
495 dev->dd_name, bus, dev->dd_location, dev->dd_pnpinfo);
496 search_hints(bus, dev->dd_name, dev->dd_pnpinfo);
500 return (devinfo_foreach_device_child(dev, find_unmatched, arg));
504 find_nomatch(char *nomatch)
506 char *bus, *pnpinfo, *tmp;
509 * Find our bus name. It will include the unit number. We have to search
510 * backwards to avoid false positive for any PNP string that has ' on '
511 * in them, which would come earlier in the string. Like if there were
512 * an 'Old Bard' ethernet card made by 'Stratford on Avon Hardware' or
513 * something silly like that.
515 tmp = nomatch + strlen(nomatch) - 4;
516 while (tmp > nomatch && strncmp(tmp, " on ", 4) != 0)
519 errx(1, "No bus found in nomatch string: '%s'", nomatch);
522 tmp = bus + strlen(bus) - 1;
523 while (tmp > bus && isdigit(*tmp))
528 * Note: the NOMATCH events place both the bus location as well as the
529 * pnp info after the 'at' and we don't know where one stops and the
530 * other begins, so we pass the whole thing to our search routine.
534 if (strncmp(nomatch, " at ", 4) != 0)
535 errx(1, "Malformed NOMATCH string: '%s'", nomatch);
536 pnpinfo = nomatch + 4;
538 search_hints(bus, "", pnpinfo);
547 errx(1, "devmatch [-adv] [-p nomatch] [-h linker-hints]");
551 main(int argc, char **argv)
553 struct devinfo_dev *root;
556 while ((ch = getopt_long(argc, argv, "adh:p:uv",
557 longopts, NULL)) != -1) {
566 linker_hints = optarg;
569 nomatch_str = optarg;
589 search_hints(NULL, NULL, NULL);
593 if (nomatch_str != NULL)
594 find_nomatch(nomatch_str);
596 err(1, "devinfo_init");
597 if ((root = devinfo_handle_to_device(DEVINFO_ROOT_DEVICE)) == NULL)
598 errx(1, "can't find root device");
599 devinfo_foreach_device_child(root, find_unmatched, (void *)0);