2 * SPDX-License-Identifier: BSD-4-Clause
4 * Copyright (c) 2000, Boris Popov
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. All advertising materials mentioning features or use of this software
16 * must display the following acknowledgement:
17 * This product includes software developed by Boris Popov.
18 * 4. Neither the name of the author nor the names of any co-contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 #include <sys/types.h>
38 #include <sys/param.h>
39 #include <sys/endian.h>
41 #include <sys/queue.h>
42 #include <sys/kernel.h>
43 #include <sys/reboot.h>
44 #include <sys/linker.h>
46 #include <sys/module.h>
57 #include <machine/elf.h>
61 #define MAXRECSIZE (64 << 10) /* 64k */
62 #define check(val) if ((error = (val)) != 0) break
64 static bool dflag; /* do not create a hint file, only write on stdout */
67 static FILE *fxref; /* current hints file */
69 static const char *xref_file = "linker.hints";
72 * A record is stored in the static buffer recbuf before going to disk.
74 static char recbuf[MAXRECSIZE];
75 static int recpos; /* current write position */
76 static int reccnt; /* total record written to this file so far */
82 recpos = roundup2(recpos, sizeof(int));
90 memset(recbuf, 0, MAXRECSIZE);
101 fwrite(&recpos, sizeof(recpos), 1, fxref);
102 return (fwrite(recbuf, recpos, 1, fxref) != 1 ? errno : 0);
106 record_buf(const void *buf, size_t size)
109 if (MAXRECSIZE - recpos < size)
110 errx(1, "record buffer overflow");
111 memcpy(recbuf + recpos, buf, size);
117 * An int is stored in host order and aligned
124 return (record_buf(&val, sizeof(val)));
128 * A string is stored as 1-byte length plus data, no padding
131 record_string(const char *str)
139 val = len = strlen(str);
141 errx(1, "string %s too long", str);
142 error = record_buf(&val, sizeof(val));
145 return (record_buf(str, len));
148 /* From sys/isa/pnp.c */
150 pnp_eisaformat(uint32_t id)
153 static char idbuf[8];
154 const char hextoascii[] = "0123456789abcdef";
157 data = (uint8_t *)&id;
158 idbuf[0] = '@' + ((data[0] & 0x7c) >> 2);
159 idbuf[1] = '@' + (((data[0] & 0x3) << 3) + ((data[1] & 0xe0) >> 5));
160 idbuf[2] = '@' + (data[1] & 0x1f);
161 idbuf[3] = hextoascii[(data[2] >> 4)];
162 idbuf[4] = hextoascii[(data[2] & 0xf)];
163 idbuf[5] = hextoascii[(data[3] >> 4)];
164 idbuf[6] = hextoascii[(data[3] & 0xf)];
171 int pe_kind; /* What kind of entry */
172 #define TYPE_SZ_MASK 0x0f
173 #define TYPE_FLAGGED 0x10 /* all f's is a wildcard */
174 #define TYPE_INT 0x20 /* Is a number */
175 #define TYPE_PAIRED 0x40
176 #define TYPE_LE 0x80 /* Matches <= this value */
177 #define TYPE_GE 0x100 /* Matches >= this value */
178 #define TYPE_MASK 0x200 /* Specifies a mask to follow */
179 #define TYPE_U8 (1 | TYPE_INT)
180 #define TYPE_V8 (1 | TYPE_INT | TYPE_FLAGGED)
181 #define TYPE_G16 (2 | TYPE_INT | TYPE_GE)
182 #define TYPE_L16 (2 | TYPE_INT | TYPE_LE)
183 #define TYPE_M16 (2 | TYPE_INT | TYPE_MASK)
184 #define TYPE_U16 (2 | TYPE_INT)
185 #define TYPE_V16 (2 | TYPE_INT | TYPE_FLAGGED)
186 #define TYPE_U32 (4 | TYPE_INT)
187 #define TYPE_V32 (4 | TYPE_INT | TYPE_FLAGGED)
188 #define TYPE_W32 (4 | TYPE_INT | TYPE_PAIRED)
194 int pe_offset; /* Offset within the element */
195 char * pe_key; /* pnp key name */
196 TAILQ_ENTRY(pnp_elt) next; /* Link */
198 typedef TAILQ_HEAD(pnp_head, pnp_elt) pnp_list;
201 * this function finds the data from the pnp table, as described by the
202 * the description and creates a new output (new_desc). This output table
203 * is a form that's easier for the agent that's automatically loading the
206 * The format output is the simplified string from this routine in the
207 * same basic format as the pnp string, as documented in sys/module.h.
208 * First a string describing the format is output, the a count of the
209 * number of records, then each record. The format string also describes
210 * the length of each entry (though it isn't a fixed length when strings
213 * type Output Meaning
214 * I uint32_t Integer equality comparison
215 * J uint32_t Pair of uint16_t fields converted to native
216 * byte order. The two fields both must match.
217 * G uint32_t Greater than or equal to
218 * L uint32_t Less than or equal to
219 * M uint32_t Mask of which fields to test. Fields that
220 * take up space increment the count. This
221 * field must be first, and resets the count.
222 * D string Description of the device this pnp info is for
223 * Z string pnp string must match this
224 * T nothing T fields set pnp values that must be true for
226 * Values are packed the same way that other values are packed in this file.
227 * Strings and int32_t's start on a 32-bit boundary and are padded with 0
228 * bytes. Objects that are smaller than uint32_t are converted, without
229 * sign extension to uint32_t to simplify parsing downstream.
232 parse_pnp_list(const char *desc, char **new_desc, pnp_list *list)
234 const char *walker, *ep;
235 const char *colon, *semi;
238 char type[8], key[32];
242 ep = desc + strlen(desc);
244 nd = *new_desc = malloc(strlen(desc) + 1);
246 printf("Converting %s into a list\n", desc);
247 while (walker < ep) {
248 colon = strchr(walker, ':');
249 semi = strchr(walker, ';');
250 if (semi != NULL && semi < colon)
252 if (colon - walker > sizeof(type))
254 strncpy(type, walker, colon - walker);
255 type[colon - walker] = '\0';
257 if (semi - colon >= sizeof(key))
259 strncpy(key, colon + 1, semi - colon - 1);
260 key[semi - colon - 1] = '\0';
263 if (strlen(colon + 1) >= sizeof(key))
265 strcpy(key, colon + 1);
269 printf("Found type %s for name %s\n", type, key);
270 /* Skip pointer place holders */
271 if (strcmp(type, "P") == 0) {
272 off += sizeof(void *);
277 * Add a node of the appropriate type
279 elt = malloc(sizeof(struct pnp_elt) + strlen(key) + 1);
280 TAILQ_INSERT_TAIL(list, elt, next);
281 elt->pe_key = (char *)(elt + 1);
282 elt->pe_offset = off;
283 if (strcmp(type, "U8") == 0)
284 elt->pe_kind = TYPE_U8;
285 else if (strcmp(type, "V8") == 0)
286 elt->pe_kind = TYPE_V8;
287 else if (strcmp(type, "G16") == 0)
288 elt->pe_kind = TYPE_G16;
289 else if (strcmp(type, "L16") == 0)
290 elt->pe_kind = TYPE_L16;
291 else if (strcmp(type, "M16") == 0)
292 elt->pe_kind = TYPE_M16;
293 else if (strcmp(type, "U16") == 0)
294 elt->pe_kind = TYPE_U16;
295 else if (strcmp(type, "V16") == 0)
296 elt->pe_kind = TYPE_V16;
297 else if (strcmp(type, "U32") == 0)
298 elt->pe_kind = TYPE_U32;
299 else if (strcmp(type, "V32") == 0)
300 elt->pe_kind = TYPE_V32;
301 else if (strcmp(type, "W32") == 0)
302 elt->pe_kind = TYPE_W32;
303 else if (strcmp(type, "D") == 0) /* description char * */
304 elt->pe_kind = TYPE_D;
305 else if (strcmp(type, "Z") == 0) /* char * to match */
306 elt->pe_kind = TYPE_Z;
307 else if (strcmp(type, "P") == 0) /* Pointer -- ignored */
308 elt->pe_kind = TYPE_P;
309 else if (strcmp(type, "E") == 0) /* EISA PNP ID, as uint32_t */
310 elt->pe_kind = TYPE_E;
311 else if (strcmp(type, "T") == 0)
312 elt->pe_kind = TYPE_T;
316 * Maybe the rounding here needs to be more nuanced and/or somehow
317 * architecture specific. Fortunately, most tables in the system
318 * have sane ordering of types.
320 if (elt->pe_kind & TYPE_INT) {
321 elt->pe_offset = roundup2(elt->pe_offset, elt->pe_kind & TYPE_SZ_MASK);
322 off = elt->pe_offset + (elt->pe_kind & TYPE_SZ_MASK);
323 } else if (elt->pe_kind == TYPE_E) {
324 /* Type E stored as Int, displays as string */
325 elt->pe_offset = roundup2(elt->pe_offset, sizeof(uint32_t));
326 off = elt->pe_offset + sizeof(uint32_t);
327 } else if (elt->pe_kind == TYPE_T) {
328 /* doesn't actually consume space in the table */
329 off = elt->pe_offset;
331 elt->pe_offset = roundup2(elt->pe_offset, sizeof(void *));
332 off = elt->pe_offset + sizeof(void *);
334 if (elt->pe_kind & TYPE_PAIRED) {
337 for (word = strtok_r(key, "/", &ctx);
338 word; word = strtok_r(NULL, "/", &ctx)) {
339 sprintf(nd, "%c:%s;", elt->pe_kind & TYPE_FLAGGED ? 'J' : 'I',
346 if (elt->pe_kind & TYPE_FLAGGED)
348 else if (elt->pe_kind & TYPE_GE)
350 else if (elt->pe_kind & TYPE_LE)
352 else if (elt->pe_kind & TYPE_MASK)
354 else if (elt->pe_kind & TYPE_INT)
356 else if (elt->pe_kind == TYPE_D)
358 else if (elt->pe_kind == TYPE_Z || elt->pe_kind == TYPE_E)
360 else if (elt->pe_kind == TYPE_T)
363 errx(1, "Impossible type %x\n", elt->pe_kind);
373 errx(1, "Parse error of description string %s", desc);
377 parse_entry(struct mod_metadata *md, const char *cval,
378 struct elf_file *ef, const char *kldname)
380 struct mod_depend mdp;
381 struct mod_version mdv;
382 struct mod_pnp_match_info pnp;
390 data = (Elf_Off)md->md_data;
393 switch (md->md_type) {
397 check(EF_SEG_READ(ef, data, sizeof(mdp), &mdp));
398 printf(" depends on %s.%d (%d,%d)\n", cval,
399 mdp.md_ver_preferred, mdp.md_ver_minimum, mdp.md_ver_maximum);
402 check(EF_SEG_READ(ef, data, sizeof(mdv), &mdv));
404 printf(" interface %s.%d\n", cval, mdv.mv_version);
406 record_int(MDT_VERSION);
408 record_int(mdv.mv_version);
409 record_string(kldname);
414 printf(" module %s\n", cval);
416 record_int(MDT_MODULE);
418 record_string(kldname);
422 check(EF_SEG_READ_REL(ef, data, sizeof(pnp), &pnp));
423 check(EF_SEG_READ(ef, (Elf_Off)pnp.descr, sizeof(descr), descr));
424 descr[sizeof(descr) - 1] = '\0';
426 printf(" pnp info for bus %s format %s %d entries of %d bytes\n",
427 cval, descr, pnp.num_entry, pnp.entry_len);
430 struct pnp_elt *elt, *elt_tmp;
434 printf(" pnp info for bus %s format %s %d entries of %d bytes\n",
435 cval, descr, pnp.num_entry, pnp.entry_len);
437 * Parse descr to weed out the chaff and to create a list
438 * of offsets to output.
441 parse_pnp_list(descr, &new_descr, &list);
442 record_int(MDT_PNP_INFO);
444 record_string(new_descr);
445 record_int(pnp.num_entry);
446 len = pnp.num_entry * pnp.entry_len;
447 walker = table = malloc(len);
448 check(EF_SEG_READ_REL(ef, (Elf_Off)pnp.table, len, table));
451 * Walk the list and output things. We've collapsed all the
452 * variant forms of the table down to just ints and strings.
454 for (i = 0; i < pnp.num_entry; i++) {
455 TAILQ_FOREACH(elt, &list, next) {
462 if (elt->pe_kind == TYPE_W32) {
463 memcpy(&v4, walker + elt->pe_offset, sizeof(v4));
467 printf("W32:%#x", value);
468 value = (v4 >> 16) & 0xffff;
471 printf(":%#x;", value);
472 } else if (elt->pe_kind & TYPE_INT) {
473 switch (elt->pe_kind & TYPE_SZ_MASK) {
475 memcpy(&v1, walker + elt->pe_offset, sizeof(v1));
476 if ((elt->pe_kind & TYPE_FLAGGED) && v1 == 0xff)
482 memcpy(&v2, walker + elt->pe_offset, sizeof(v2));
483 if ((elt->pe_kind & TYPE_FLAGGED) && v2 == 0xffff)
489 memcpy(&v4, walker + elt->pe_offset, sizeof(v4));
490 if ((elt->pe_kind & TYPE_FLAGGED) && v4 == 0xffffffff)
496 errx(1, "Invalid size somehow %#x", elt->pe_kind);
499 printf("I:%#x;", value);
501 } else if (elt->pe_kind == TYPE_T) {
503 } else { /* E, Z or D -- P already filtered */
504 if (elt->pe_kind == TYPE_E) {
505 memcpy(&v4, walker + elt->pe_offset, sizeof(v4));
506 strcpy(buffer, pnp_eisaformat(v4));
510 ptr = *(char **)(walker + elt->pe_offset);
513 EF_SEG_READ(ef, (Elf_Off)ptr,
514 sizeof(buffer), buffer);
515 buffer[sizeof(buffer) - 1] = '\0';
519 printf("%c:%s;", elt->pe_kind == TYPE_E ? 'E' : (elt->pe_kind == TYPE_Z ? 'Z' : 'D'), buffer);
520 record_string(buffer);
525 walker += pnp.entry_len;
528 TAILQ_FOREACH_SAFE(elt, &list, next, elt_tmp) {
529 TAILQ_REMOVE(&list, elt, next);
536 warnx("unknown metadata record %d in file %s", md->md_type, kldname);
544 read_kld(char *filename, char *kldname)
546 struct mod_metadata md;
550 long start, finish, entries;
551 char cval[MAXMODNAME + 1];
553 if (verbose || dflag)
554 printf("%s\n", filename);
555 error = ef_open(filename, &ef, verbose);
557 error = ef_obj_open(filename, &ef, verbose);
560 warnc(error, "elf_open(%s)", filename);
564 eftype = EF_GET_TYPE(&ef);
565 if (eftype != EFT_KLD && eftype != EFT_KERNEL) {
570 check(EF_LOOKUP_SET(&ef, MDT_SETNAME, &start, &finish,
572 check(EF_SEG_READ_ENTRY_REL(&ef, start, sizeof(*p) * entries,
576 check(EF_SEG_READ_REL(&ef, (Elf_Off)*p, sizeof(md),
579 check(EF_SEG_READ_STRING(&ef, (Elf_Off)md.md_cval,
580 sizeof(cval), cval));
581 parse_entry(&md, cval, &ef, kldname);
584 warnc(error, "error while reading %s", filename);
592 * Create a temp file in directory root, make sure we don't
593 * overflow the buffer for the destination name
596 maketempfile(char *dest, const char *root)
601 p = strrchr(root, '/');
602 n = p != NULL ? p - root + 1 : 0;
603 if (snprintf(dest, MAXPATHLEN, "%.*slhint.XXXXXX", n, root) >=
605 errno = ENAMETOOLONG;
612 fchmod(fd, 0644); /* nothing secret in the file */
613 return (fdopen(fd, "w+"));
616 static char xrefname[MAXPATHLEN], tempname[MAXPATHLEN];
622 fprintf(stderr, "%s\n",
623 "usage: kldxref [-Rdv] [-f hintsfile] path ..."
629 compare(const FTSENT *const *a, const FTSENT *const *b)
632 if ((*a)->fts_info == FTS_D && (*b)->fts_info != FTS_D)
634 if ((*a)->fts_info != FTS_D && (*b)->fts_info == FTS_D)
636 return (strcmp((*a)->fts_name, (*b)->fts_name));
640 main(int argc, char *argv[])
644 int opt, fts_options, ival;
647 fts_options = FTS_PHYSICAL;
649 while ((opt = getopt(argc, argv, "Rdf:v")) != -1) {
651 case 'd': /* no hint file, only print on stdout */
654 case 'f': /* use this name instead of linker.hints */
660 case 'R': /* recurse on directories */
661 fts_options |= FTS_COMFOLLOW;
668 if (argc - optind < 1)
673 if (stat(argv[0], &sb) != 0)
674 err(1, "%s", argv[0]);
675 if ((sb.st_mode & S_IFDIR) == 0) {
677 err(1, "%s", argv[0]);
680 ftsp = fts_open(argv, fts_options, compare);
686 if ((p == NULL || p->fts_info == FTS_D) && fxref) {
687 /* close and rename the current hint file */
691 rename(tempname, xrefname);
693 /* didn't find any entry, ignore this file */
700 if (p->fts_info == FTS_D && !dflag) {
701 /* visiting a new directory, create a new hint file */
702 snprintf(xrefname, sizeof(xrefname), "%s/%s",
703 ftsp->fts_path, xref_file);
704 fxref = maketempfile(tempname, ftsp->fts_path);
706 err(1, "can't create %s", tempname);
708 fwrite(&ival, sizeof(ival), 1, fxref);
711 /* skip non-files and separate debug files */
712 if (p->fts_info != FTS_F)
714 if (p->fts_namelen >= 6 &&
715 strcmp(p->fts_name + p->fts_namelen - 6, ".debug") == 0)
717 if (p->fts_namelen >= 8 &&
718 strcmp(p->fts_name + p->fts_namelen - 8, ".symbols") == 0)
720 read_kld(p->fts_path, p->fts_name);