2 * Copyright (c) 1998 Michael Smith <msmith@freebsd.org>
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$");
31 * file/module function dispatcher, support, etc.
36 #include <sys/param.h>
37 #include <sys/linker.h>
38 #include <sys/module.h>
39 #include <sys/queue.h>
40 #include <sys/stdint.h>
44 #if defined(LOADER_FDT_SUPPORT)
45 #include <fdt_platform.h>
48 #include "bootstrap.h"
50 #define MDIR_REMOVED 0x0001
51 #define MDIR_NOHINTS 0x0002
54 char *d_path; /* path of modules directory */
55 u_char *d_hints; /* content of linker.hints file */
56 int d_hintsz; /* size of hints data */
58 STAILQ_ENTRY(moduledir) d_link;
61 static int file_load(char *filename, vm_offset_t dest, struct preloaded_file **result);
62 static int file_load_dependencies(struct preloaded_file *base_mod);
63 static char * file_search(const char *name, char **extlist);
64 static struct kernel_module * file_findmodule(struct preloaded_file *fp, char *modname, struct mod_depend *verinfo);
65 static int file_havepath(const char *name);
66 static char *mod_searchmodule(char *name, struct mod_depend *verinfo);
67 static char * mod_searchmodule_pnpinfo(const char *bus, const char *pnpinfo);
68 static void file_insert_tail(struct preloaded_file *mp);
69 static void file_remove(struct preloaded_file *fp);
70 struct file_metadata* metadata_next(struct file_metadata *base_mp, int type);
71 static void moduledir_readhints(struct moduledir *mdp);
72 static void moduledir_rebuild(void);
74 /* load address should be tweaked by first module loaded (kernel) */
75 static vm_offset_t loadaddr = 0;
77 #if defined(LOADER_FDT_SUPPORT)
78 static const char *default_searchpath =
79 "/boot/kernel;/boot/modules;/boot/dtb";
81 static const char *default_searchpath = "/boot/kernel;/boot/modules";
84 static STAILQ_HEAD(, moduledir) moduledir_list =
85 STAILQ_HEAD_INITIALIZER(moduledir_list);
87 struct preloaded_file *preloaded_files = NULL;
89 static char *kld_ext_list[] = {
97 * load an object, either a disk file or code module.
99 * To load a file, the syntax is:
101 * load -t <type> <path>
103 * code modules are loaded as:
105 * load <path> <options>
108 COMMAND_SET(load, "load", "load a kernel or module", command_load);
111 command_load(int argc, char *argv[])
113 struct preloaded_file *fp;
115 #ifdef LOADER_VERIEXEC
118 char *args = "dkp:s:t:";
122 int dofile, dokld, ch, error;
129 command_errmsg = "no filename specified";
132 #ifdef LOADER_VERIEXEC
136 while ((ch = getopt(argc, argv, args)) != -1) {
138 #ifdef LOADER_VERIEXEC
146 #ifdef LOADER_VERIEXEC
160 /* getopt has already reported an error */
164 argv += (optind - 1);
165 argc -= (optind - 1);
168 * Request to load a raw file?
171 if ((argc != 2) || (typestr == NULL) || (*typestr == 0)) {
172 command_errmsg = "invalid load type";
176 #ifdef LOADER_VERIEXEC
177 if (strncmp(typestr, "manifest", 8) == 0) {
180 return (load_manifest(argv[1], prefix, skip, NULL));
182 #ifdef LOADER_VERIEXEC_PASS_MANIFEST
183 if (strncmp(typestr, "pass_manifest", 13) == 0) {
186 return (pass_manifest(argv[1], prefix));
191 fp = file_findfile(argv[1], typestr);
193 snprintf(command_errbuf, sizeof(command_errbuf),
194 "warning: file '%s' already loaded", argv[1]);
198 if (file_loadraw(argv[1], typestr, 1) != NULL)
201 /* Failing to load mfs_root is never going to end well! */
202 if (strcmp("mfs_root", typestr) == 0)
208 * Do we have explicit KLD load ?
210 if (dokld || file_havepath(argv[1])) {
211 error = mod_loadkld(argv[1], argc - 2, argv + 2);
212 if (error == EEXIST) {
213 snprintf(command_errbuf, sizeof(command_errbuf),
214 "warning: KLD '%s' already loaded", argv[1]);
218 return (error == 0 ? CMD_OK : CMD_CRIT);
221 * Looks like a request for a module.
223 error = mod_load(argv[1], NULL, argc - 2, argv + 2);
224 if (error == EEXIST) {
225 snprintf(command_errbuf, sizeof(command_errbuf),
226 "warning: module '%s' already loaded", argv[1]);
230 return (error == 0 ? CMD_OK : CMD_CRIT);
233 #ifdef LOADER_GELI_SUPPORT
234 COMMAND_SET(load_geli, "load_geli", "load a geli key", command_load_geli);
237 command_load_geli(int argc, char *argv[])
244 command_errmsg = "usage is [-n key#] <prov> <file>";
251 while ((ch = getopt(argc, argv, "n:")) != -1) {
254 num = strtol(optarg, &cp, 0);
256 snprintf(command_errbuf, sizeof(command_errbuf),
257 "bad key index '%s'", optarg);
263 /* getopt has already reported an error */
267 argv += (optind - 1);
268 argc -= (optind - 1);
269 sprintf(typestr, "%s:geli_keyfile%d", argv[1], num);
270 return (file_loadraw(argv[2], typestr, 1) ? CMD_OK : CMD_ERROR);
277 struct preloaded_file *fp;
279 while (preloaded_files != NULL) {
280 fp = preloaded_files;
281 preloaded_files = preloaded_files->f_next;
285 unsetenv("kernelname");
288 COMMAND_SET(unload, "unload", "unload all modules", command_unload);
291 command_unload(int argc, char *argv[])
297 COMMAND_SET(lsmod, "lsmod", "list loaded modules", command_lsmod);
300 command_lsmod(int argc, char *argv[])
302 struct preloaded_file *fp;
303 struct kernel_module *mp;
304 struct file_metadata *md;
306 int ch, verbose, ret = 0;
311 while ((ch = getopt(argc, argv, "v")) != -1) {
318 /* getopt has already reported an error */
324 for (fp = preloaded_files; fp; fp = fp->f_next) {
325 snprintf(lbuf, sizeof(lbuf), " %p: ", (void *) fp->f_addr);
327 pager_output(fp->f_name);
328 snprintf(lbuf, sizeof(lbuf), " (%s, 0x%lx)\n", fp->f_type,
330 if (pager_output(lbuf))
332 if (fp->f_args != NULL) {
333 pager_output(" args: ");
334 pager_output(fp->f_args);
335 if (pager_output("\n"))
339 pager_output(" modules: ");
340 for (mp = fp->f_modules; mp; mp = mp->m_next) {
341 snprintf(lbuf, sizeof(lbuf), "%s.%d ", mp->m_name,
345 if (pager_output("\n"))
349 /* XXX could add some formatting smarts here to display some better */
350 for (md = fp->f_metadata; md != NULL; md = md->md_next) {
351 snprintf(lbuf, sizeof(lbuf), " 0x%04x, 0x%lx\n",
352 md->md_type, (long) md->md_size);
353 if (pager_output(lbuf))
364 COMMAND_SET(pnpmatch, "pnpmatch", "list matched modules based on pnpinfo", command_pnpmatch);
366 static int pnp_dump_flag = 0;
367 static int pnp_unbound_flag = 0;
368 static int pnp_verbose_flag = 0;
371 command_pnpmatch(int argc, char *argv[])
376 pnp_verbose_flag = 0;
380 while ((ch = getopt(argc, argv, "vd")) != -1) {
383 pnp_verbose_flag = 1;
390 /* getopt has already reported an error */
398 command_errmsg = "Usage: pnpmatch <busname> compat=<compatdata>";
402 module = mod_searchmodule_pnpinfo(argv[0], argv[1]);
404 printf("Matched module: %s\n", module);
406 printf("No module matches %s on bus %s\n", argv[1], argv[0]);
411 COMMAND_SET(pnpload, "pnpload", "load matched modules based on pnpinfo", command_pnpload);
414 command_pnpload(int argc, char *argv[])
419 pnp_verbose_flag = 0;
423 while ((ch = getopt(argc, argv, "vd")) != -1) {
426 pnp_verbose_flag = 1;
433 /* getopt has already reported an error */
441 command_errmsg = "Usage: pnpload <busname> compat=<compatdata>";
445 module = mod_searchmodule_pnpinfo(argv[0], argv[1]);
447 error = mod_load(module, NULL, 0, NULL);
448 if (error == EEXIST) {
449 snprintf(command_errbuf, sizeof(command_errbuf),
450 "warning: module '%s' already loaded", argv[1]);
454 return (error == 0 ? CMD_OK : CMD_CRIT);
457 #if defined(LOADER_FDT_SUPPORT)
459 pnpautoload_fdt_bus(const char *busname) {
460 const char *pnpstring;
461 const char *compatstr;
462 char *pnpinfo = NULL;
464 int tag = 0, len, pnplen;
468 pnpstring = fdt_devmatch_next(&tag, &len);
469 if (pnpstring == NULL)
472 compatstr = pnpstring;
473 for (pnplen = 0; pnplen != len; compatstr = pnpstring + pnplen) {
474 pnplen += strlen(compatstr) + 1;
475 asprintf(&pnpinfo, "compat=%s", compatstr);
477 module = mod_searchmodule_pnpinfo(busname, pnpinfo);
479 error = mod_loadkld(module, 0, NULL);
481 printf("Cannot load module %s\n", module);
493 void (*load)(const char *busname);
496 struct pnp_bus pnp_buses[] = {
497 #if defined(LOADER_FDT_SUPPORT)
498 {"simplebus", pnpautoload_fdt_bus},
499 {"ofwbus", pnpautoload_fdt_bus},
500 {"iicbus", pnpautoload_fdt_bus},
501 {"spibus", pnpautoload_fdt_bus},
505 COMMAND_SET(pnpautoload, "pnpautoload", "auto load modules based on pnpinfo", command_pnpautoload);
508 command_pnpautoload(int argc, char *argv[])
514 pnp_verbose_flag = 0;
520 while ((ch = getopt(argc, argv, "v")) != -1) {
527 /* getopt has already reported an error */
531 argv += (optind - 1);
532 argc -= (optind - 1);
537 for (i = 0; i < nitems(pnp_buses); i++) {
538 if (argc == 2 && strcmp(argv[1], pnp_buses[i].name) != 0) {
540 printf("Skipping bus %s\n", pnp_buses[i].name);
544 printf("Autoloading modules for %s\n", pnp_buses[i].name);
545 pnp_buses[i].load(pnp_buses[i].name);
549 printf("Unsupported bus %s\n", argv[1]);
555 * File level interface, functions file_*
558 file_load(char *filename, vm_offset_t dest, struct preloaded_file **result)
560 static int last_file_format = 0;
561 struct preloaded_file *fp;
566 if (archsw.arch_loadaddr != NULL)
567 dest = archsw.arch_loadaddr(LOAD_RAW, filename, dest);
570 for (i = last_file_format, fp = NULL;
571 file_formats[i] && fp == NULL; i++) {
572 error = (file_formats[i]->l_load)(filename, dest, &fp);
574 fp->f_loader = last_file_format = i; /* remember the loader */
577 } else if (last_file_format == i && i != 0) {
578 /* Restart from the beginning */
580 last_file_format = 0;
585 continue; /* Unknown to this handler? */
587 snprintf(command_errbuf, sizeof(command_errbuf),
588 "can't load file '%s': %s", filename, strerror(error));
597 file_load_dependencies(struct preloaded_file *base_file)
599 struct file_metadata *md;
600 struct preloaded_file *fp;
601 struct mod_depend *verinfo;
602 struct kernel_module *mp;
606 md = file_findmetadata(base_file, MODINFOMD_DEPLIST);
611 verinfo = (struct mod_depend*)md->md_data;
612 dmodname = (char *)(verinfo + 1);
613 if (file_findmodule(NULL, dmodname, verinfo) == NULL) {
614 if (module_verbose > MODULE_VERBOSE_SILENT)
615 printf("loading required module '%s'\n", dmodname);
616 error = mod_load(dmodname, verinfo, 0, NULL);
620 * If module loaded via kld name which isn't listed
621 * in the linker.hints file, we should check if it have
624 mp = file_findmodule(NULL, dmodname, verinfo);
626 snprintf(command_errbuf, sizeof(command_errbuf),
627 "module '%s' exists but with wrong version", dmodname);
632 md = metadata_next(md, MODINFOMD_DEPLIST);
636 /* Load failed; discard everything */
637 while (base_file != NULL) {
639 base_file = base_file->f_next;
646 build_font_module(vm_offset_t addr)
648 vt_font_bitmap_data_t *bd;
650 struct preloaded_file *fp;
658 if (STAILQ_EMPTY(&fonts))
661 /* We can't load first */
662 if ((file_findfile(NULL, NULL)) == NULL) {
663 printf("Can not load font module: %s\n",
664 "the kernel is not loaded");
668 /* helper pointers */
670 STAILQ_FOREACH(fl, &fonts, font_next) {
671 if (gfx_state.tg_font.vf_width == fl->font_data->vfbd_width &&
672 gfx_state.tg_font.vf_height == fl->font_data->vfbd_height) {
674 * Kernel does have better built in font.
676 if (fl->font_flags == FONT_BUILTIN)
687 fi.fi_width = fd->vf_width;
688 checksum = fi.fi_width;
689 fi.fi_height = fd->vf_height;
690 checksum += fi.fi_height;
691 fi.fi_bitmap_size = bd->vfbd_uncompressed_size;
692 checksum += fi.fi_bitmap_size;
694 size = roundup2(sizeof (struct font_info), 8);
695 for (i = 0; i < VFNT_MAPS; i++) {
696 fi.fi_map_count[i] = fd->vf_map_count[i];
697 checksum += fi.fi_map_count[i];
698 size += fd->vf_map_count[i] * sizeof (struct vfnt_map);
699 size += roundup2(size, 8);
701 size += bd->vfbd_uncompressed_size;
703 fi.fi_checksum = -checksum;
705 fp = file_findfile(NULL, "elf kernel");
707 fp = file_findfile(NULL, "elf64 kernel");
709 panic("can't find kernel file");
712 addr += archsw.arch_copyin(&fi, addr, sizeof (struct font_info));
713 addr = roundup2(addr, 8);
716 for (i = 0; i < VFNT_MAPS; i++) {
717 if (fd->vf_map_count[i] != 0) {
718 addr += archsw.arch_copyin(fd->vf_map[i], addr,
719 fd->vf_map_count[i] * sizeof (struct vfnt_map));
720 addr = roundup2(addr, 8);
724 /* Copy the bitmap. */
725 addr += archsw.arch_copyin(fd->vf_bytes, addr, fi.fi_bitmap_size);
727 /* Looks OK so far; populate control structure */
728 file_addmetadata(fp, MODINFOMD_FONT, sizeof(fontp), &fontp);
732 #ifdef LOADER_VERIEXEC_VECTX
733 #define VECTX_HANDLE(fd) vctx
735 #define VECTX_HANDLE(fd) fd
740 * We've been asked to load (fname) as (type), so just suck it in,
741 * no arguments or anything.
743 struct preloaded_file *
744 file_loadraw(const char *fname, char *type, int insert)
746 struct preloaded_file *fp;
750 #ifdef LOADER_VERIEXEC_VECTX
756 /* We can't load first */
757 if ((file_findfile(NULL, NULL)) == NULL) {
758 command_errmsg = "can't load file before kernel";
763 /* locate the file on the load path */
764 name = file_search(fname, NULL);
766 snprintf(command_errbuf, sizeof(command_errbuf),
767 "can't find '%s'", fname);
772 if ((fd = open(name, O_RDONLY)) < 0) {
773 snprintf(command_errbuf, sizeof(command_errbuf),
774 "can't open '%s': %s", name, strerror(errno));
780 #ifdef LOADER_VERIEXEC_VECTX
781 vctx = vectx_open(fd, name, 0L, NULL, &verror, __func__);
783 sprintf(command_errbuf, "can't verify '%s': %s",
784 name, ve_error_get());
792 #ifdef LOADER_VERIEXEC
793 if (verify_file(fd, name, 0, VE_MUST, __func__) < 0) {
794 sprintf(command_errbuf, "can't verify '%s': %s",
795 name, ve_error_get());
804 if (archsw.arch_loadaddr != NULL)
805 loadaddr = archsw.arch_loadaddr(LOAD_RAW, name, loadaddr);
807 if (module_verbose > MODULE_VERBOSE_SILENT)
812 /* read in 4k chunks; size is not really important */
813 got = archsw.arch_readin(VECTX_HANDLE(fd), laddr, 4096);
814 if (got == 0) /* end of file */
816 if (got < 0) { /* error */
817 snprintf(command_errbuf, sizeof(command_errbuf),
818 "error reading '%s': %s", name, strerror(errno));
821 #ifdef LOADER_VERIEXEC_VECTX
830 if (module_verbose > MODULE_VERBOSE_SILENT)
831 printf("size=%#jx\n", (uintmax_t)(laddr - loadaddr));
832 #ifdef LOADER_VERIEXEC_VECTX
833 verror = vectx_close(vctx, VE_MUST, __func__);
843 /* Looks OK so far; create & populate control structure */
846 snprintf(command_errbuf, sizeof (command_errbuf),
847 "no memory to load %s", name);
854 fp->f_type = strdup(type);
856 fp->f_metadata = NULL;
858 fp->f_addr = loadaddr;
859 fp->f_size = laddr - loadaddr;
861 if (fp->f_type == NULL) {
862 snprintf(command_errbuf, sizeof (command_errbuf),
863 "no memory to load %s", name);
869 /* recognise space consumption */
872 /* Add to the list of loaded files */
874 file_insert_tail(fp);
881 * Load the module (name), pass it (argc),(argv), add container file
882 * to the list of loaded files.
883 * If module is already loaded just assign new argc/argv.
886 mod_load(char *modname, struct mod_depend *verinfo, int argc, char *argv[])
888 struct kernel_module *mp;
893 if (file_havepath(modname)) {
894 printf("Warning: mod_load() called instead of mod_loadkld() for module '%s'\n", modname);
896 return (mod_loadkld(modname, argc, argv));
898 /* see if module is already loaded */
899 mp = file_findmodule(NULL, modname, verinfo);
903 mp->m_args = unargv(argc, argv);
905 snprintf(command_errbuf, sizeof(command_errbuf),
906 "warning: module '%s' already loaded", mp->m_name);
910 /* locate file with the module on the search path */
911 filename = mod_searchmodule(modname, verinfo);
912 if (filename == NULL) {
913 snprintf(command_errbuf, sizeof(command_errbuf),
914 "can't find '%s'", modname);
918 err = mod_loadkld(filename, argc, argv);
925 * Load specified KLD. If path is omitted, then try to locate it via
929 mod_loadkld(const char *kldname, int argc, char *argv[])
931 struct preloaded_file *fp;
934 vm_offset_t loadaddr_saved;
938 * Get fully qualified KLD name
940 filename = file_search(kldname, kld_ext_list);
941 if (filename == NULL) {
942 snprintf(command_errbuf, sizeof(command_errbuf),
943 "can't find '%s'", kldname);
948 * Check if KLD already loaded
950 fp = file_findfile(filename, NULL);
952 snprintf(command_errbuf, sizeof(command_errbuf),
953 "warning: KLD '%s' already loaded", filename);
960 err = file_load(filename, loadaddr, &fp);
963 fp->f_args = unargv(argc, argv);
964 loadaddr_saved = loadaddr;
965 loadaddr = fp->f_addr + fp->f_size;
966 file_insert_tail(fp); /* Add to the list of loaded files */
967 if (file_load_dependencies(fp) != 0) {
970 loadaddr = loadaddr_saved;
976 snprintf(command_errbuf, sizeof(command_errbuf),
977 "don't know how to load module '%s'", filename);
987 * Find a file matching (name) and (type).
988 * NULL may be passed as a wildcard to either.
990 struct preloaded_file *
991 file_findfile(const char *name, const char *type)
993 struct preloaded_file *fp;
995 for (fp = preloaded_files; fp != NULL; fp = fp->f_next) {
996 if (((name == NULL) || !strcmp(name, fp->f_name)) &&
997 ((type == NULL) || !strcmp(type, fp->f_type)))
1004 * Find a module matching (name) inside of given file.
1005 * NULL may be passed as a wildcard.
1007 struct kernel_module *
1008 file_findmodule(struct preloaded_file *fp, char *modname,
1009 struct mod_depend *verinfo)
1011 struct kernel_module *mp, *best;
1015 for (fp = preloaded_files; fp; fp = fp->f_next) {
1016 mp = file_findmodule(fp, modname, verinfo);
1024 for (mp = fp->f_modules; mp; mp = mp->m_next) {
1025 if (strcmp(modname, mp->m_name) == 0) {
1026 if (verinfo == NULL)
1028 mver = mp->m_version;
1029 if (mver == verinfo->md_ver_preferred)
1031 if (mver >= verinfo->md_ver_minimum &&
1032 mver <= verinfo->md_ver_maximum &&
1042 * Make a copy of (size) bytes of data from (p), and associate them as
1043 * metadata of (type) to the module (mp).
1046 file_addmetadata(struct preloaded_file *fp, int type, size_t size, void *p)
1048 struct file_metadata *md;
1050 md = malloc(sizeof(struct file_metadata) - sizeof(md->md_data) + size);
1054 bcopy(p, md->md_data, size);
1055 md->md_next = fp->f_metadata;
1057 fp->f_metadata = md;
1061 * Find a metadata object of (type) associated with the file (fp)
1063 struct file_metadata *
1064 file_findmetadata(struct preloaded_file *fp, int type)
1066 struct file_metadata *md;
1068 for (md = fp->f_metadata; md != NULL; md = md->md_next)
1069 if (md->md_type == type)
1075 * Remove all metadata from the file.
1078 file_removemetadata(struct preloaded_file *fp)
1080 struct file_metadata *md, *next;
1082 for (md = fp->f_metadata; md != NULL; md = next)
1087 fp->f_metadata = NULL;
1091 * Add a buffer to the list of preloaded "files".
1094 file_addbuf(const char *name, const char *type, size_t len, void *buf)
1096 struct preloaded_file *fp;
1099 /* We can't load first */
1100 if ((file_findfile(NULL, NULL)) == NULL) {
1101 command_errmsg = "can't load file before kernel";
1105 /* Figure out where to load the data. */
1107 if (archsw.arch_loadaddr != NULL)
1108 dest = archsw.arch_loadaddr(LOAD_RAW, (void *)name, dest);
1110 /* Create & populate control structure */
1113 snprintf(command_errbuf, sizeof (command_errbuf),
1114 "no memory to load %s", name);
1117 fp->f_name = strdup(name);
1118 fp->f_type = strdup(type);
1120 fp->f_metadata = NULL;
1124 if ((fp->f_name == NULL) || (fp->f_type == NULL)) {
1125 snprintf(command_errbuf, sizeof (command_errbuf),
1126 "no memory to load %s", name);
1132 /* Copy the data in. */
1133 archsw.arch_copyin(buf, fp->f_addr, len);
1134 loadaddr = fp->f_addr + len;
1136 /* Add to the list of loaded files */
1137 file_insert_tail(fp);
1141 struct file_metadata *
1142 metadata_next(struct file_metadata *md, int type)
1147 while((md = md->md_next) != NULL)
1148 if (md->md_type == type)
1153 static char *emptyextlist[] = { "", NULL };
1156 * Check if the given file is in place and return full path to it.
1159 file_lookup(const char *path, const char *name, int namelen, char **extlist)
1162 char *result, *cp, **cpp;
1163 int pathlen, extlen, len;
1165 pathlen = strlen(path);
1167 if (extlist == NULL)
1168 extlist = emptyextlist;
1169 for (cpp = extlist; *cpp; cpp++) {
1174 result = malloc(pathlen + namelen + extlen + 2);
1177 bcopy(path, result, pathlen);
1178 if (pathlen > 0 && result[pathlen - 1] != '/')
1179 result[pathlen++] = '/';
1180 cp = result + pathlen;
1181 bcopy(name, cp, namelen);
1183 for (cpp = extlist; *cpp; cpp++) {
1185 if (stat(result, &st) == 0 && S_ISREG(st.st_mode))
1193 * Check if file name have any qualifiers
1196 file_havepath(const char *name)
1200 archsw.arch_getdev(NULL, name, &cp);
1201 return (cp != name || strchr(name, '/') != NULL);
1205 * Attempt to find the file (name) on the module searchpath.
1206 * If (name) is qualified in any way, we simply check it and
1207 * return it or NULL. If it is not qualified, then we attempt
1208 * to construct a path using entries in the environment variable
1211 * The path we return a pointer to need never be freed, as we manage
1215 file_search(const char *name, char **extlist)
1217 struct moduledir *mdp;
1222 /* Don't look for nothing */
1227 return(strdup(name));
1229 if (file_havepath(name)) {
1230 /* Qualified, so just see if it exists */
1231 if (stat(name, &sb) == 0)
1232 return(strdup(name));
1235 moduledir_rebuild();
1237 namelen = strlen(name);
1238 STAILQ_FOREACH(mdp, &moduledir_list, d_link) {
1239 result = file_lookup(mdp->d_path, name, namelen, extlist);
1246 #define INT_ALIGN(base, ptr) ptr = \
1247 (base) + roundup2((ptr) - (base), sizeof(int))
1250 mod_search_hints(struct moduledir *mdp, const char *modname,
1251 struct mod_depend *verinfo)
1253 u_char *cp, *recptr, *bufend, *best;
1255 int *intp, bestver, blen, clen, found, ival, modnamelen, reclen;
1257 moduledir_readhints(mdp);
1258 modnamelen = strlen(modname);
1262 if (mdp->d_hints == NULL)
1264 recptr = mdp->d_hints;
1265 bufend = recptr + mdp->d_hintsz;
1268 while (recptr < bufend && !found) {
1269 intp = (int*)recptr;
1276 if (clen != modnamelen || bcmp(cp, modname, clen) != 0)
1279 INT_ALIGN(mdp->d_hints, cp);
1283 if (verinfo == NULL || ival == verinfo->md_ver_preferred) {
1287 if (ival >= verinfo->md_ver_minimum &&
1288 ival <= verinfo->md_ver_maximum &&
1298 recptr += reclen + sizeof(int);
1301 * Finally check if KLD is in the place
1304 result = file_lookup(mdp->d_path, (const char *)cp, clen, NULL);
1306 result = file_lookup(mdp->d_path, (const char *)best, blen, NULL);
1309 * If nothing found or hints is absent - fallback to the old way
1310 * by using "kldname[.ko]" as module name.
1312 if (!found && !bestver && result == NULL)
1313 result = file_lookup(mdp->d_path, modname, modnamelen, kld_ext_list);
1323 p = (int *)roundup2((intptr_t)p, sizeof(int));
1330 getstr(void **ptr, char *val)
1333 char *c = (char *)p;
1334 int len = *(uint8_t *)c;
1336 memcpy(val, c + 1, len);
1343 pnpval_as_int(const char *val, const char *pnpinfo)
1349 if (pnpinfo == NULL)
1352 cp = strchr(val, ';');
1355 strlcpy(key + 1, val, sizeof(key) - 1);
1357 memcpy(key + 1, val, cp - val);
1358 key[cp - val + 1] = '\0';
1360 strlcat(key, "=", sizeof(key));
1361 if (strncmp(key + 1, pnpinfo, strlen(key + 1)) == 0)
1362 rv = strtol(pnpinfo + strlen(key + 1), NULL, 0);
1364 cp = strstr(pnpinfo, key);
1368 rv = strtol(cp + strlen(key), NULL, 0);
1374 quoted_strcpy(char *dst, const char *src)
1378 if (*src == '\'' || *src == '"')
1380 while (*src && *src != q)
1381 *dst++ = *src++; // XXX backtick quoting
1387 pnpval_as_str(const char *val, const char *pnpinfo)
1389 static char retval[256];
1393 if (pnpinfo == NULL) {
1398 cp = strchr(val, ';');
1401 strlcpy(key + 1, val, sizeof(key) - 1);
1403 memcpy(key + 1, val, cp - val);
1404 key[cp - val + 1] = '\0';
1406 strlcat(key, "=", sizeof(key));
1407 if (strncmp(key + 1, pnpinfo, strlen(key + 1)) == 0)
1408 quoted_strcpy(retval, pnpinfo + strlen(key + 1));
1410 cp = strstr(pnpinfo, key);
1412 strcpy(retval, "MISSING");
1414 quoted_strcpy(retval, cp + strlen(key));
1420 devmatch_search_hints(struct moduledir *mdp, const char *bus, const char *dev, const char *pnpinfo)
1422 char val1[256], val2[256];
1423 int ival, len, ents, i, notme, mask, bit, v, found;
1424 void *ptr, *walker, *hints_end;
1425 char *lastmod = NULL, *cp, *s;
1427 moduledir_readhints(mdp);
1429 if (mdp->d_hints == NULL)
1431 walker = mdp->d_hints;
1432 hints_end = walker + mdp->d_hintsz;
1433 while (walker < hints_end && !found) {
1434 len = getint(&walker);
1435 ival = getint(&walker);
1440 ival = getint(&ptr);
1442 if (pnp_dump_flag || pnp_verbose_flag)
1443 printf("Version: if %s.%d kmod %s\n", val1, ival, val2);
1450 lastmod = strdup(val2);
1451 if (pnp_dump_flag || pnp_verbose_flag)
1452 printf("module %s in %s\n", val1, val1);
1455 if (!pnp_dump_flag && !pnp_unbound_flag && lastmod && strcmp(lastmod, "kernel") == 0)
1459 ents = getint(&ptr);
1460 if (pnp_dump_flag || pnp_verbose_flag)
1461 printf("PNP info for bus %s format %s %d entries (%s)\n",
1462 val1, val2, ents, lastmod);
1463 if (strcmp(val1, "usb") == 0) {
1464 if (pnp_verbose_flag)
1465 printf("Treating usb as uhub -- bug in source table still?\n");
1466 strcpy(val1, "uhub");
1468 if (bus && strcmp(val1, bus) != 0) {
1469 if (pnp_verbose_flag)
1470 printf("Skipped because table for bus %s, looking for %s\n",
1474 for (i = 0; i < ents; i++) {
1475 if (pnp_verbose_flag)
1476 printf("---------- Entry %d ----------\n", i);
1485 /* All integer fields */
1491 ival = getint(&ptr);
1492 if (pnp_dump_flag) {
1493 printf("%#x:", ival);
1496 if (bit >= 0 && ((1 << bit) & mask) == 0)
1498 v = pnpval_as_int(cp + 2, pnpinfo);
1499 if (pnp_verbose_flag)
1500 printf("Matching %s (%c) table=%#x tomatch=%#x\n",
1501 cp + 2, *cp, v, ival);
1528 if (pnp_dump_flag) {
1529 printf("'%s':", val1);
1534 s = pnpval_as_str(cp + 2, pnpinfo);
1535 if (strcmp(s, val1) != 0)
1538 /* Key override fields, required to be last in the string */
1541 * This is imperfect and only does one key and will be redone
1542 * to be more general for multiple keys. Currently, nothing
1545 if (pnp_dump_flag) /* No per-row data stored */
1547 if (cp[strlen(cp) - 1] == ';') /* Skip required ; at end */
1548 cp[strlen(cp) - 1] = '\0'; /* in case it's not there */
1549 if ((s = strstr(pnpinfo, cp + 2)) == NULL)
1551 else if (s > pnpinfo && s[-1] != ' ')
1555 printf("Unknown field type %c\n:", *cp);
1559 cp = strchr(cp, ';');
1562 } while (cp && *cp);
1566 if (!pnp_unbound_flag) {
1567 if (pnp_verbose_flag)
1568 printf("Matches --- %s ---\n", lastmod);
1577 walker = (void *)(len - sizeof(int) + (intptr_t)walker);
1579 if (pnp_unbound_flag && found == 0 && *pnpinfo) {
1580 if (pnp_verbose_flag)
1581 printf("------------------------- ");
1582 printf("%s on %s pnpinfo %s", *dev ? dev : "unattached", bus, pnpinfo);
1583 if (pnp_verbose_flag)
1584 printf(" -------------------------");
1596 * Attempt to locate the file containing the module (name)
1599 mod_searchmodule(char *name, struct mod_depend *verinfo)
1601 struct moduledir *mdp;
1604 moduledir_rebuild();
1606 * Now we ready to lookup module in the given directories
1609 STAILQ_FOREACH(mdp, &moduledir_list, d_link) {
1610 result = mod_search_hints(mdp, name, verinfo);
1619 mod_searchmodule_pnpinfo(const char *bus, const char *pnpinfo)
1621 struct moduledir *mdp;
1624 moduledir_rebuild();
1626 * Now we ready to lookup module in the given directories
1629 STAILQ_FOREACH(mdp, &moduledir_list, d_link) {
1630 result = devmatch_search_hints(mdp, bus, NULL, pnpinfo);
1639 file_addmodule(struct preloaded_file *fp, char *modname, int version,
1640 struct kernel_module **newmp)
1642 struct kernel_module *mp;
1643 struct mod_depend mdepend;
1645 bzero(&mdepend, sizeof(mdepend));
1646 mdepend.md_ver_preferred = version;
1647 mp = file_findmodule(fp, modname, &mdepend);
1650 mp = calloc(1, sizeof(struct kernel_module));
1653 mp->m_name = strdup(modname);
1654 if (mp->m_name == NULL) {
1658 mp->m_version = version;
1660 mp->m_next = fp->f_modules;
1671 file_discard(struct preloaded_file *fp)
1673 struct file_metadata *md, *md1;
1674 struct kernel_module *mp, *mp1;
1677 md = fp->f_metadata;
1697 * Allocate a new file; must be used instead of malloc()
1698 * to ensure safe initialisation.
1700 struct preloaded_file *
1704 return (calloc(1, sizeof(struct preloaded_file)));
1708 * Add a module to the chain
1711 file_insert_tail(struct preloaded_file *fp)
1713 struct preloaded_file *cm;
1715 /* Append to list of loaded file */
1717 if (preloaded_files == NULL) {
1718 preloaded_files = fp;
1720 for (cm = preloaded_files; cm->f_next != NULL; cm = cm->f_next)
1727 * Remove module from the chain
1730 file_remove(struct preloaded_file *fp)
1732 struct preloaded_file *cm;
1734 if (preloaded_files == NULL)
1737 if (preloaded_files == fp) {
1738 preloaded_files = fp->f_next;
1741 for (cm = preloaded_files; cm->f_next != NULL; cm = cm->f_next) {
1742 if (cm->f_next == fp) {
1743 cm->f_next = fp->f_next;
1750 moduledir_fullpath(struct moduledir *mdp, const char *fname)
1754 cp = malloc(strlen(mdp->d_path) + strlen(fname) + 2);
1757 strcpy(cp, mdp->d_path);
1764 * Read linker.hints file into memory performing some sanity checks.
1767 moduledir_readhints(struct moduledir *mdp)
1771 int fd, size, version;
1773 if (mdp->d_hints != NULL || (mdp->d_flags & MDIR_NOHINTS))
1775 path = moduledir_fullpath(mdp, "linker.hints");
1776 if (stat(path, &st) != 0 ||
1777 st.st_size < (ssize_t)(sizeof(version) + sizeof(int)) ||
1778 st.st_size > LINKER_HINTS_MAX || (fd = open(path, O_RDONLY)) < 0) {
1780 mdp->d_flags |= MDIR_NOHINTS;
1784 size = read(fd, &version, sizeof(version));
1785 if (size != sizeof(version) || version != LINKER_HINTS_VERSION)
1787 size = st.st_size - size;
1788 mdp->d_hints = malloc(size);
1789 if (mdp->d_hints == NULL)
1791 if (read(fd, mdp->d_hints, size) != size)
1793 mdp->d_hintsz = size;
1799 mdp->d_hints = NULL;
1800 mdp->d_flags |= MDIR_NOHINTS;
1805 * Extract directories from the ';' separated list, remove duplicates.
1808 moduledir_rebuild(void)
1810 struct moduledir *mdp, *mtmp;
1811 const char *path, *cp, *ep;
1814 path = getenv("module_path");
1816 path = default_searchpath;
1818 * Rebuild list of module directories if it changed
1820 STAILQ_FOREACH(mdp, &moduledir_list, d_link)
1821 mdp->d_flags |= MDIR_REMOVED;
1823 for (ep = path; *ep != 0; ep++) {
1825 for (; *ep != 0 && *ep != ';'; ep++)
1828 * Ignore trailing slashes
1830 for (cplen = ep - cp; cplen > 1 && cp[cplen - 1] == '/'; cplen--)
1832 STAILQ_FOREACH(mdp, &moduledir_list, d_link) {
1833 if (strlen(mdp->d_path) != cplen || bcmp(cp, mdp->d_path, cplen) != 0)
1835 mdp->d_flags &= ~MDIR_REMOVED;
1839 mdp = malloc(sizeof(*mdp) + cplen + 1);
1842 mdp->d_path = (char*)(mdp + 1);
1843 bcopy(cp, mdp->d_path, cplen);
1844 mdp->d_path[cplen] = 0;
1845 mdp->d_hints = NULL;
1847 STAILQ_INSERT_TAIL(&moduledir_list, mdp, d_link);
1853 * Delete unused directories if any
1855 mdp = STAILQ_FIRST(&moduledir_list);
1857 if ((mdp->d_flags & MDIR_REMOVED) == 0) {
1858 mdp = STAILQ_NEXT(mdp, d_link);
1862 mdp = STAILQ_NEXT(mdp, d_link);
1863 STAILQ_REMOVE(&moduledir_list, mtmp, moduledir, d_link);