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>
51 #include <machine/elf.h>
59 #define MAXRECSIZE (64 << 10) /* 64k */
60 #define check(val) if ((error = (val)) != 0) break
62 static int dflag; /* do not create a hint file, only write on stdout */
65 static FILE *fxref; /* current hints file */
67 static const char *xref_file = "linker.hints";
70 * A record is stored in the static buffer recbuf before going to disk.
72 static char recbuf[MAXRECSIZE];
73 static int recpos; /* current write position */
74 static int reccnt; /* total record written to this file so far */
79 recpos = roundup2(recpos, sizeof(int));
86 memset(recbuf, 0, MAXRECSIZE);
96 fwrite(&recpos, sizeof(recpos), 1, fxref);
97 return fwrite(recbuf, recpos, 1, fxref) != 1 ? errno : 0;
101 record_buf(const void *buf, int size)
103 if (MAXRECSIZE - recpos < size)
104 errx(1, "record buffer overflow");
105 memcpy(recbuf + recpos, buf, size);
111 * An int is stored in host order and aligned
117 return record_buf(&val, sizeof(val));
121 * A string is stored as 1-byte length plus data, no padding
124 record_string(const char *str)
131 val = len = strlen(str);
133 errx(1, "string %s too long", str);
134 error = record_buf(&val, sizeof(val));
137 return record_buf(str, len);
140 /* From sys/isa/pnp.c */
142 pnp_eisaformat(uint32_t id)
145 static char idbuf[8];
146 const char hextoascii[] = "0123456789abcdef";
149 data = (uint8_t *)&id;
150 idbuf[0] = '@' + ((data[0] & 0x7c) >> 2);
151 idbuf[1] = '@' + (((data[0] & 0x3) << 3) + ((data[1] & 0xe0) >> 5));
152 idbuf[2] = '@' + (data[1] & 0x1f);
153 idbuf[3] = hextoascii[(data[2] >> 4)];
154 idbuf[4] = hextoascii[(data[2] & 0xf)];
155 idbuf[5] = hextoascii[(data[3] >> 4)];
156 idbuf[6] = hextoascii[(data[3] & 0xf)];
163 int pe_kind; /* What kind of entry */
164 #define TYPE_SZ_MASK 0x0f
165 #define TYPE_FLAGGED 0x10 /* all f's is a wildcard */
166 #define TYPE_INT 0x20 /* Is a number */
167 #define TYPE_PAIRED 0x40
168 #define TYPE_LE 0x80 /* Matches <= this value */
169 #define TYPE_GE 0x100 /* Matches >= this value */
170 #define TYPE_MASK 0x200 /* Specifies a mask to follow */
171 #define TYPE_U8 (1 | TYPE_INT)
172 #define TYPE_V8 (1 | TYPE_INT | TYPE_FLAGGED)
173 #define TYPE_G16 (2 | TYPE_INT | TYPE_GE)
174 #define TYPE_L16 (2 | TYPE_INT | TYPE_LE)
175 #define TYPE_M16 (2 | TYPE_INT | TYPE_MASK)
176 #define TYPE_U16 (2 | TYPE_INT)
177 #define TYPE_V16 (2 | TYPE_INT | TYPE_FLAGGED)
178 #define TYPE_U32 (4 | TYPE_INT)
179 #define TYPE_V32 (4 | TYPE_INT | TYPE_FLAGGED)
180 #define TYPE_W32 (4 | TYPE_INT | TYPE_PAIRED)
186 int pe_offset; /* Offset within the element */
187 char * pe_key; /* pnp key name */
188 TAILQ_ENTRY(pnp_elt) next; /* Link */
190 typedef TAILQ_HEAD(pnp_head, pnp_elt) pnp_list;
193 * this function finds the data from the pnp table, as described by the
194 * the description and creates a new output (new_desc). This output table
195 * is a form that's easier for the agent that's automatically loading the
198 * The format output is the simplified string from this routine in the
199 * same basic format as the pnp string, as documented in sys/module.h.
200 * First a string describing the format is output, the a count of the
201 * number of records, then each record. The format string also describes
202 * the length of each entry (though it isn't a fixed length when strings
205 * type Output Meaning
206 * I uint32_t Integer equality comparison
207 * J uint32_t Pair of uint16_t fields converted to native
208 byte order. The two fields both must match.
209 * G uint32_t Greater than or equal to
210 * L uint32_t Less than or equal to
211 * M uint32_t Mask of which fields to test. Fields that
212 take up space increment the count. This
213 field must be first, and resets the count.
214 * D string Description of the device this pnp info is for
215 * Z string pnp string must match this
216 * T nothing T fields set pnp values that must be true for
218 * Values are packed the same way that other values are packed in this file.
219 * Strings and int32_t's start on a 32-bit boundary and are padded with 0
220 * bytes. Objects that are smaller than uint32_t are converted, without
221 * sign extension to uint32_t to simplify parsing downstream.
224 parse_pnp_list(const char *desc, char **new_desc, pnp_list *list)
226 const char *walker = desc, *ep = desc + strlen(desc);
227 const char *colon, *semi;
230 char type[8], key[32];
234 nd = *new_desc = malloc(strlen(desc) + 1);
236 printf("Converting %s into a list\n", desc);
237 while (walker < ep) {
238 colon = strchr(walker, ':');
239 semi = strchr(walker, ';');
240 if (semi != NULL && semi < colon)
242 if (colon - walker > sizeof(type))
244 strncpy(type, walker, colon - walker);
245 type[colon - walker] = '\0';
247 if (semi - colon >= sizeof(key))
249 strncpy(key, colon + 1, semi - colon - 1);
250 key[semi - colon - 1] = '\0';
253 if (strlen(colon + 1) >= sizeof(key))
255 strcpy(key, colon + 1);
259 printf("Found type %s for name %s\n", type, key);
260 /* Skip pointer place holders */
261 if (strcmp(type, "P") == 0) {
262 off += sizeof(void *);
267 * Add a node of the appropriate type
269 elt = malloc(sizeof(struct pnp_elt) + strlen(key) + 1);
270 TAILQ_INSERT_TAIL(list, elt, next);
271 elt->pe_key = (char *)(elt + 1);
272 elt->pe_offset = off;
273 if (strcmp(type, "U8") == 0)
274 elt->pe_kind = TYPE_U8;
275 else if (strcmp(type, "V8") == 0)
276 elt->pe_kind = TYPE_V8;
277 else if (strcmp(type, "G16") == 0)
278 elt->pe_kind = TYPE_G16;
279 else if (strcmp(type, "L16") == 0)
280 elt->pe_kind = TYPE_L16;
281 else if (strcmp(type, "M16") == 0)
282 elt->pe_kind = TYPE_M16;
283 else if (strcmp(type, "U16") == 0)
284 elt->pe_kind = TYPE_U16;
285 else if (strcmp(type, "V16") == 0)
286 elt->pe_kind = TYPE_V16;
287 else if (strcmp(type, "U32") == 0)
288 elt->pe_kind = TYPE_U32;
289 else if (strcmp(type, "V32") == 0)
290 elt->pe_kind = TYPE_V32;
291 else if (strcmp(type, "W32") == 0)
292 elt->pe_kind = TYPE_W32;
293 else if (strcmp(type, "D") == 0) /* description char * */
294 elt->pe_kind = TYPE_D;
295 else if (strcmp(type, "Z") == 0) /* char * to match */
296 elt->pe_kind = TYPE_Z;
297 else if (strcmp(type, "P") == 0) /* Pointer -- ignored */
298 elt->pe_kind = TYPE_P;
299 else if (strcmp(type, "E") == 0) /* EISA PNP ID, as uint32_t */
300 elt->pe_kind = TYPE_E;
301 else if (strcmp(type, "T") == 0)
302 elt->pe_kind = TYPE_T;
306 * Maybe the rounding here needs to be more nuanced and/or somehow
307 * architecture specific. Fortunately, most tables in the system
308 * have sane ordering of types.
310 if (elt->pe_kind & TYPE_INT) {
311 elt->pe_offset = roundup2(elt->pe_offset, elt->pe_kind & TYPE_SZ_MASK);
312 off = elt->pe_offset + (elt->pe_kind & TYPE_SZ_MASK);
313 } else if (elt->pe_kind == TYPE_E) {
314 /* Type E stored as Int, displays as string */
315 elt->pe_offset = roundup2(elt->pe_offset, sizeof(uint32_t));
316 off = elt->pe_offset + sizeof(uint32_t);
317 } else if (elt->pe_kind == TYPE_T) {
318 /* doesn't actually consume space in the table */
319 off = elt->pe_offset;
321 elt->pe_offset = roundup2(elt->pe_offset, sizeof(void *));
322 off = elt->pe_offset + sizeof(void *);
324 if (elt->pe_kind & TYPE_PAIRED) {
327 for (word = strtok_r(key, "/", &ctx);
328 word; word = strtok_r(NULL, "/", &ctx)) {
329 sprintf(nd, "%c:%s;", elt->pe_kind & TYPE_FLAGGED ? 'J' : 'I',
336 if (elt->pe_kind & TYPE_FLAGGED)
338 else if (elt->pe_kind & TYPE_GE)
340 else if (elt->pe_kind & TYPE_LE)
342 else if (elt->pe_kind & TYPE_MASK)
344 else if (elt->pe_kind & TYPE_INT)
346 else if (elt->pe_kind == TYPE_D)
348 else if (elt->pe_kind == TYPE_Z || elt->pe_kind == TYPE_E)
350 else if (elt->pe_kind == TYPE_T)
353 errx(1, "Impossible type %x\n", elt->pe_kind);
363 errx(1, "Parse error of description string %s", desc);
367 parse_entry(struct mod_metadata *md, const char *cval,
368 struct elf_file *ef, const char *kldname)
370 struct mod_depend mdp;
371 struct mod_version mdv;
372 struct mod_pnp_match_info pnp;
374 Elf_Off data = (Elf_Off)md->md_data;
375 int error = 0, i, len;
380 switch (md->md_type) {
384 check(EF_SEG_READ(ef, data, sizeof(mdp), &mdp));
385 printf(" depends on %s.%d (%d,%d)\n", cval,
386 mdp.md_ver_preferred, mdp.md_ver_minimum, mdp.md_ver_maximum);
389 check(EF_SEG_READ(ef, data, sizeof(mdv), &mdv));
391 printf(" interface %s.%d\n", cval, mdv.mv_version);
393 record_int(MDT_VERSION);
395 record_int(mdv.mv_version);
396 record_string(kldname);
401 printf(" module %s\n", cval);
403 record_int(MDT_MODULE);
405 record_string(kldname);
409 check(EF_SEG_READ_REL(ef, data, sizeof(pnp), &pnp));
410 check(EF_SEG_READ(ef, (Elf_Off)pnp.descr, sizeof(descr), descr));
411 descr[sizeof(descr) - 1] = '\0';
413 printf(" pnp info for bus %s format %s %d entries of %d bytes\n",
414 cval, descr, pnp.num_entry, pnp.entry_len);
417 struct pnp_elt *elt, *elt_tmp;
421 printf(" pnp info for bus %s format %s %d entries of %d bytes\n",
422 cval, descr, pnp.num_entry, pnp.entry_len);
424 * Parse descr to weed out the chaff and to create a list
425 * of offsets to output.
428 parse_pnp_list(descr, &new_descr, &list);
429 record_int(MDT_PNP_INFO);
431 record_string(new_descr);
432 record_int(pnp.num_entry);
433 len = pnp.num_entry * pnp.entry_len;
434 walker = table = malloc(len);
435 check(EF_SEG_READ_REL(ef, (Elf_Off)pnp.table, len, table));
438 * Walk the list and output things. We've collapsed all the
439 * variant forms of the table down to just ints and strings.
441 for (i = 0; i < pnp.num_entry; i++) {
442 TAILQ_FOREACH(elt, &list, next) {
449 if (elt->pe_kind == TYPE_W32) {
450 memcpy(&v4, walker + elt->pe_offset, sizeof(v4));
454 printf("W32:%#x", value);
455 value = (v4 >> 16) & 0xffff;
458 printf(":%#x;", value);
459 } else if (elt->pe_kind & TYPE_INT) {
460 switch (elt->pe_kind & TYPE_SZ_MASK) {
462 memcpy(&v1, walker + elt->pe_offset, sizeof(v1));
463 if ((elt->pe_kind & TYPE_FLAGGED) && v1 == 0xff)
469 memcpy(&v2, walker + elt->pe_offset, sizeof(v2));
470 if ((elt->pe_kind & TYPE_FLAGGED) && v2 == 0xffff)
476 memcpy(&v4, walker + elt->pe_offset, sizeof(v4));
477 if ((elt->pe_kind & TYPE_FLAGGED) && v4 == 0xffffffff)
483 errx(1, "Invalid size somehow %#x", elt->pe_kind);
486 printf("I:%#x;", value);
488 } else if (elt->pe_kind == TYPE_T) {
490 } else { /* E, Z or D -- P already filtered */
491 if (elt->pe_kind == TYPE_E) {
492 memcpy(&v4, walker + elt->pe_offset, sizeof(v4));
493 strcpy(buffer, pnp_eisaformat(v4));
497 ptr = *(char **)(walker + elt->pe_offset);
500 EF_SEG_READ(ef, (Elf_Off)ptr,
501 sizeof(buffer), buffer);
502 buffer[sizeof(buffer) - 1] = '\0';
506 printf("%c:%s;", elt->pe_kind == TYPE_E ? 'E' : (elt->pe_kind == TYPE_Z ? 'Z' : 'D'), buffer);
507 record_string(buffer);
512 walker += pnp.entry_len;
515 TAILQ_FOREACH_SAFE(elt, &list, next, elt_tmp) {
516 TAILQ_REMOVE(&list, elt, next);
523 warnx("unknown metadata record %d in file %s", md->md_type, kldname);
531 read_kld(char *filename, char *kldname)
533 struct mod_metadata md;
536 int error, eftype, nmlen;
537 long start, finish, entries;
538 char kldmodname[MAXMODNAME + 1], cval[MAXMODNAME + 1], *cp;
540 if (verbose || dflag)
541 printf("%s\n", filename);
542 error = ef_open(filename, &ef, verbose);
544 error = ef_obj_open(filename, &ef, verbose);
547 warnc(error, "elf_open(%s)", filename);
551 eftype = EF_GET_TYPE(&ef);
552 if (eftype != EFT_KLD && eftype != EFT_KERNEL) {
557 cp = strrchr(kldname, '.');
558 nmlen = (cp != NULL) ? cp - kldname : (int)strlen(kldname);
559 if (nmlen > MAXMODNAME)
561 strlcpy(kldmodname, kldname, nmlen);
562 /* fprintf(fxref, "%s:%s:%d\n", kldmodname, kldname, 0);*/
565 check(EF_LOOKUP_SET(&ef, MDT_SETNAME, &start, &finish,
567 check(EF_SEG_READ_ENTRY_REL(&ef, start, sizeof(*p) * entries,
571 check(EF_SEG_READ_REL(&ef, (Elf_Off)*p, sizeof(md),
574 check(EF_SEG_READ(&ef, (Elf_Off)md.md_cval,
575 sizeof(cval), cval));
576 cval[MAXMODNAME] = '\0';
577 parse_entry(&md, cval, &ef, kldname);
580 warnc(error, "error while reading %s", filename);
588 * Create a temp file in directory root, make sure we don't
589 * overflow the buffer for the destination name
592 maketempfile(char *dest, const char *root)
597 p = strrchr(root, '/');
598 n = p != NULL ? p - root + 1 : 0;
599 if (snprintf(dest, MAXPATHLEN, "%.*slhint.XXXXXX", n, root) >=
601 errno = ENAMETOOLONG;
608 fchmod(fd, 0644); /* nothing secret in the file */
609 return fdopen(fd, "w+");
612 static char xrefname[MAXPATHLEN], tempname[MAXPATHLEN];
618 fprintf(stderr, "%s\n",
619 "usage: kldxref [-Rdv] [-f hintsfile] path ..."
625 compare(const FTSENT *const *a, const FTSENT *const *b)
627 if ((*a)->fts_info == FTS_D && (*b)->fts_info != FTS_D)
629 if ((*a)->fts_info != FTS_D && (*b)->fts_info == FTS_D)
631 return strcmp((*a)->fts_name, (*b)->fts_name);
635 main(int argc, char *argv[])
639 int opt, fts_options, ival;
642 fts_options = FTS_PHYSICAL;
644 while ((opt = getopt(argc, argv, "Rdf:v")) != -1) {
646 case 'd': /* no hint file, only print on stdout */
649 case 'f': /* use this name instead of linker.hints */
655 case 'R': /* recurse on directories */
656 fts_options |= FTS_COMFOLLOW;
663 if (argc - optind < 1)
668 if (stat(argv[0], &sb) != 0)
669 err(1, "%s", argv[0]);
670 if ((sb.st_mode & S_IFDIR) == 0) {
672 err(1, "%s", argv[0]);
675 ftsp = fts_open(argv, fts_options, compare);
681 if ((p == NULL || p->fts_info == FTS_D) && fxref) {
682 /* close and rename the current hint file */
686 rename(tempname, xrefname);
688 /* didn't find any entry, ignore this file */
695 if (p->fts_info == FTS_D && !dflag) {
696 /* visiting a new directory, create a new hint file */
697 snprintf(xrefname, sizeof(xrefname), "%s/%s",
698 ftsp->fts_path, xref_file);
699 fxref = maketempfile(tempname, ftsp->fts_path);
701 err(1, "can't create %s", tempname);
703 fwrite(&ival, sizeof(ival), 1, fxref);
706 /* skip non-files and separate debug files */
707 if (p->fts_info != FTS_F)
709 if (p->fts_namelen >= 6 &&
710 strcmp(p->fts_name + p->fts_namelen - 6, ".debug") == 0)
712 if (p->fts_namelen >= 8 &&
713 strcmp(p->fts_name + p->fts_namelen - 8, ".symbols") == 0)
715 read_kld(p->fts_path, p->fts_name);