2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 1998 Michael Smith
6 * Copyright (c) 2020 NetApp Inc.
7 * Copyright (c) 2020 Klara Inc.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
34 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/linker.h>
38 #include <sys/sysctl.h>
40 #include <machine/metadata.h>
43 #include <vm/vm_extern.h>
46 * Preloaded module support
49 vm_offset_t preload_addr_relocate = 0;
50 caddr_t preload_metadata;
53 * Search for the preloaded module (name)
56 preload_search_by_name(const char *name)
62 if (preload_metadata != NULL) {
63 curp = preload_metadata;
65 hdr = (uint32_t *)curp;
66 if (hdr[0] == 0 && hdr[1] == 0)
69 /* Search for a MODINFO_NAME field */
70 if ((hdr[0] == MODINFO_NAME) &&
71 !strcmp(name, curp + sizeof(uint32_t) * 2))
74 /* skip to next field */
75 next = sizeof(uint32_t) * 2 + hdr[1];
76 next = roundup(next, sizeof(u_long));
84 * Search for the first preloaded module of (type)
87 preload_search_by_type(const char *type)
93 if (preload_metadata != NULL) {
94 curp = preload_metadata;
97 hdr = (uint32_t *)curp;
98 if (hdr[0] == 0 && hdr[1] == 0)
101 /* remember the start of each record */
102 if (hdr[0] == MODINFO_NAME)
105 /* Search for a MODINFO_TYPE field */
106 if ((hdr[0] == MODINFO_TYPE) &&
107 !strcmp(type, curp + sizeof(uint32_t) * 2))
110 /* skip to next field */
111 next = sizeof(uint32_t) * 2 + hdr[1];
112 next = roundup(next, sizeof(u_long));
120 * Walk through the preloaded module list
123 preload_search_next_name(caddr_t base)
129 if (preload_metadata != NULL) {
130 /* Pick up where we left off last time */
132 /* skip to next field */
134 hdr = (uint32_t *)curp;
135 next = sizeof(uint32_t) * 2 + hdr[1];
136 next = roundup(next, sizeof(u_long));
139 curp = preload_metadata;
142 hdr = (uint32_t *)curp;
143 if (hdr[0] == 0 && hdr[1] == 0)
146 /* Found a new record? */
147 if (hdr[0] == MODINFO_NAME)
150 /* skip to next field */
151 next = sizeof(uint32_t) * 2 + hdr[1];
152 next = roundup(next, sizeof(u_long));
160 * Given a preloaded module handle (mod), return a pointer
161 * to the data for the attribute (inf).
164 preload_search_info(caddr_t mod, int inf)
176 hdr = (uint32_t *)curp;
177 /* end of module data? */
178 if (hdr[0] == 0 && hdr[1] == 0)
181 * We give up once we've looped back to what we were looking at
182 * first - this should normally be a MODINFO_NAME field.
192 * Attribute match? Return pointer to data.
193 * Consumer may safely assume that size value precedes
197 return(curp + (sizeof(uint32_t) * 2));
199 /* skip to next field */
200 next = sizeof(uint32_t) * 2 + hdr[1];
201 next = roundup(next, sizeof(u_long));
208 * Delete a preload record by name.
211 preload_delete_name(const char *name)
221 if (preload_metadata != NULL) {
223 curp = preload_metadata;
225 hdr = (uint32_t *)curp;
226 if (hdr[0] == MODINFO_NAME || (hdr[0] == 0 && hdr[1] == 0)) {
227 /* Free memory used to store the file. */
228 if (addr != 0 && sz != 0)
229 kmem_bootstrap_free((vm_offset_t)addr, sz);
235 if (!strcmp(name, curp + sizeof(uint32_t) * 2))
236 clearing = 1; /* got it, start clearing */
238 clearing = 0; /* at next one now.. better stop */
242 if (hdr[0] == MODINFO_ADDR)
243 addr = *(caddr_t *)(curp + sizeof(uint32_t) * 2);
244 else if (hdr[0] == MODINFO_SIZE)
245 sz = *(uint32_t *)(curp + sizeof(uint32_t) * 2);
246 hdr[0] = MODINFO_EMPTY;
249 /* skip to next field */
250 next = sizeof(uint32_t) * 2 + hdr[1];
251 next = roundup(next, sizeof(u_long));
258 preload_fetch_addr(caddr_t mod)
262 mdp = (caddr_t *)preload_search_info(mod, MODINFO_ADDR);
265 return (*mdp + preload_addr_relocate);
269 preload_fetch_size(caddr_t mod)
273 mdp = (size_t *)preload_search_info(mod, MODINFO_SIZE);
279 /* Called from locore. Convert physical pointers to kvm. Sigh. */
281 preload_bootstrap_relocate(vm_offset_t offset)
288 if (preload_metadata != NULL) {
289 curp = preload_metadata;
291 hdr = (uint32_t *)curp;
292 if (hdr[0] == 0 && hdr[1] == 0)
295 /* Deal with the ones that we know we have to fix */
298 case MODINFO_METADATA|MODINFOMD_SSYM:
299 case MODINFO_METADATA|MODINFOMD_ESYM:
300 ptr = (vm_offset_t *)(curp + (sizeof(uint32_t) * 2));
304 /* The rest is beyond us for now */
306 /* skip to next field */
307 next = sizeof(uint32_t) * 2 + hdr[1];
308 next = roundup(next, sizeof(u_long));
315 * Parse the modinfo type and append to the provided sbuf.
318 preload_modinfo_type(struct sbuf *sbp, int type)
321 if ((type & MODINFO_METADATA) == 0) {
324 sbuf_cat(sbp, "MODINFO_END");
327 sbuf_cat(sbp, "MODINFO_NAME");
330 sbuf_cat(sbp, "MODINFO_TYPE");
333 sbuf_cat(sbp, "MODINFO_ADDR");
336 sbuf_cat(sbp, "MODINFO_SIZE");
339 sbuf_cat(sbp, "MODINFO_EMPTY");
342 sbuf_cat(sbp, "MODINFO_ARGS");
345 sbuf_cat(sbp, "unrecognized modinfo attribute");
351 sbuf_cat(sbp, "MODINFO_METADATA | ");
352 switch (type & ~MODINFO_METADATA) {
353 case MODINFOMD_ELFHDR:
354 sbuf_cat(sbp, "MODINFOMD_ELFHDR");
357 sbuf_cat(sbp, "MODINFOMD_SSYM");
360 sbuf_cat(sbp, "MODINFOMD_ESYM");
362 case MODINFOMD_DYNAMIC:
363 sbuf_cat(sbp, "MODINFOMD_DYNAMIC");
366 sbuf_cat(sbp, "MODINFOMD_ENVP");
368 case MODINFOMD_HOWTO:
369 sbuf_cat(sbp, "MODINFOMD_HOWTO");
371 case MODINFOMD_KERNEND:
372 sbuf_cat(sbp, "MODINFOMD_KERNEND");
375 sbuf_cat(sbp, "MODINFOMD_SHDR");
377 case MODINFOMD_CTORS_ADDR:
378 sbuf_cat(sbp, "MODINFOMD_CTORS_ADDR");
380 case MODINFOMD_CTORS_SIZE:
381 sbuf_cat(sbp, "MODINFOMD_CTORS_SIZE");
383 case MODINFOMD_FW_HANDLE:
384 sbuf_cat(sbp, "MODINFOMD_FW_HANDLE");
386 case MODINFOMD_KEYBUF:
387 sbuf_cat(sbp, "MODINFOMD_KEYBUF");
389 #ifdef MODINFOMD_SMAP
391 sbuf_cat(sbp, "MODINFOMD_SMAP");
394 #ifdef MODINFOMD_SMAP_XATTR
395 case MODINFOMD_SMAP_XATTR:
396 sbuf_cat(sbp, "MODINFOMD_SMAP_XATTR");
399 #ifdef MODINFOMD_DTBP
401 sbuf_cat(sbp, "MODINFOMD_DTBP");
404 #ifdef MODINFOMD_EFI_MAP
405 case MODINFOMD_EFI_MAP:
406 sbuf_cat(sbp, "MODINFOMD_EFI_MAP");
409 #ifdef MODINFOMD_EFI_FB
410 case MODINFOMD_EFI_FB:
411 sbuf_cat(sbp, "MODINFOMD_EFI_FB");
414 #ifdef MODINFOMD_MODULEP
415 case MODINFOMD_MODULEP:
416 sbuf_cat(sbp, "MODINFOMD_MODULEP");
420 sbuf_cat(sbp, "unrecognized metadata type");
425 * Print the modinfo value, depending on type.
428 preload_modinfo_value(struct sbuf *sbp, uint32_t *bptr, int type, int len)
431 #define sbuf_print_vmoffset(sb, o) sbuf_printf(sb, "0x%016lx", o);
433 #define sbuf_print_vmoffset(sb, o) sbuf_printf(sb, "0x%08x", o);
440 sbuf_printf(sbp, "%s", (char *)bptr);
443 case MODINFO_METADATA | MODINFOMD_CTORS_SIZE:
444 sbuf_printf(sbp, "%lu", *(u_long *)bptr);
447 case MODINFO_METADATA | MODINFOMD_SSYM:
448 case MODINFO_METADATA | MODINFOMD_ESYM:
449 case MODINFO_METADATA | MODINFOMD_DYNAMIC:
450 case MODINFO_METADATA | MODINFOMD_KERNEND:
451 case MODINFO_METADATA | MODINFOMD_ENVP:
452 case MODINFO_METADATA | MODINFOMD_CTORS_ADDR:
453 #ifdef MODINFOMD_SMAP
454 case MODINFO_METADATA | MODINFOMD_SMAP:
456 #ifdef MODINFOMD_SMAP_XATTR
457 case MODINFO_METADATA | MODINFOMD_SMAP_XATTR:
459 #ifdef MODINFOMD_DTBP
460 case MODINFO_METADATA | MODINFOMD_DTBP:
462 #ifdef MODINFOMD_EFI_FB
463 case MODINFO_METADATA | MODINFOMD_EFI_FB:
465 sbuf_print_vmoffset(sbp, *(vm_offset_t *)bptr);
467 case MODINFO_METADATA | MODINFOMD_HOWTO:
468 sbuf_printf(sbp, "0x%08x", *bptr);
470 case MODINFO_METADATA | MODINFOMD_SHDR:
471 case MODINFO_METADATA | MODINFOMD_ELFHDR:
472 case MODINFO_METADATA | MODINFOMD_FW_HANDLE:
473 case MODINFO_METADATA | MODINFOMD_KEYBUF:
474 #ifdef MODINFOMD_EFI_MAP
475 case MODINFO_METADATA | MODINFOMD_EFI_MAP:
477 /* Don't print data buffers. */
478 sbuf_cat(sbp, "buffer contents omitted");
483 #undef sbuf_print_vmoffset
487 preload_dump_internal(struct sbuf *sbp)
489 uint32_t *bptr, type, len;
491 KASSERT(preload_metadata != NULL,
492 ("%s called without setting up preload_metadata", __func__));
495 * Iterate through the TLV-encoded sections.
497 bptr = (uint32_t *)preload_metadata;
498 sbuf_putc(sbp, '\n');
499 while (bptr[0] != MODINFO_END || bptr[1] != MODINFO_END) {
500 sbuf_printf(sbp, " %p:\n", bptr);
504 sbuf_printf(sbp, "\ttype:\t(%#04x) ", type);
505 preload_modinfo_type(sbp, type);
506 sbuf_putc(sbp, '\n');
507 sbuf_printf(sbp, "\tlen:\t%u\n", len);
508 sbuf_cat(sbp, "\tvalue:\t");
509 preload_modinfo_value(sbp, bptr, type, len);
510 sbuf_putc(sbp, '\n');
512 bptr += roundup(len, sizeof(u_long)) / sizeof(uint32_t);
517 * Print the preloaded data to the console. Called from the machine-dependent
518 * initialization routines, e.g. hammer_time().
527 * This function is expected to be called before malloc is available,
528 * so use a static buffer and struct sbuf.
530 sbuf_new(&sb, buf, sizeof(buf), SBUF_FIXEDLEN);
531 sbuf_set_drain(&sb, sbuf_printf_drain, NULL);
532 preload_dump_internal(&sb);
539 sysctl_preload_dump(SYSCTL_HANDLER_ARGS)
544 if (preload_metadata == NULL)
547 sbuf_new_for_sysctl(&sb, NULL, 512, req);
548 preload_dump_internal(&sb);
550 error = sbuf_finish(&sb);
555 SYSCTL_PROC(_debug, OID_AUTO, dump_modinfo,
556 CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_MPSAFE,
557 NULL, 0, sysctl_preload_dump, "A",
558 "pretty-print the bootloader metadata");