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>
42 #include "bootstrap.h"
44 #define MDIR_REMOVED 0x0001
45 #define MDIR_NOHINTS 0x0002
48 char *d_path; /* path of modules directory */
49 u_char *d_hints; /* content of linker.hints file */
50 int d_hintsz; /* size of hints data */
52 STAILQ_ENTRY(moduledir) d_link;
55 static int file_load(char *filename, vm_offset_t dest, struct preloaded_file **result);
56 static int file_load_dependencies(struct preloaded_file *base_mod);
57 static char * file_search(const char *name, char **extlist);
58 static struct kernel_module * file_findmodule(struct preloaded_file *fp, char *modname, struct mod_depend *verinfo);
59 static int file_havepath(const char *name);
60 static char *mod_searchmodule(char *name, struct mod_depend *verinfo);
61 static void file_insert_tail(struct preloaded_file *mp);
62 struct file_metadata* metadata_next(struct file_metadata *base_mp, int type);
63 static void moduledir_readhints(struct moduledir *mdp);
64 static void moduledir_rebuild(void);
66 /* load address should be tweaked by first module loaded (kernel) */
67 static vm_offset_t loadaddr = 0;
69 #if defined(LOADER_FDT_SUPPORT)
70 static const char *default_searchpath =
71 "/boot/kernel;/boot/modules;/boot/dtb";
73 static const char *default_searchpath ="/boot/kernel;/boot/modules";
76 static STAILQ_HEAD(, moduledir) moduledir_list = STAILQ_HEAD_INITIALIZER(moduledir_list);
78 struct preloaded_file *preloaded_files = NULL;
80 static char *kld_ext_list[] = {
89 * load an object, either a disk file or code module.
91 * To load a file, the syntax is:
93 * load -t <type> <path>
95 * code modules are loaded as:
97 * load <path> <options>
100 COMMAND_SET(load, "load", "load a kernel or module", command_load);
103 command_load(int argc, char *argv[])
105 struct preloaded_file *fp;
109 int dflag, dofile, dokld, ch, error;
111 dflag = dokld = dofile = 0;
116 command_errmsg = "no filename specified";
119 prefix = skip = NULL;
120 while ((ch = getopt(argc, argv, "dkp:s:t:")) != -1) {
140 /* getopt has already reported an error */
144 argv += (optind - 1);
145 argc -= (optind - 1);
148 * Request to load a raw file?
151 if ((argc != 2) || (typestr == NULL) || (*typestr == 0)) {
152 command_errmsg = "invalid load type";
156 #ifdef LOADER_VERIEXEC
157 if (strncmp(typestr, "manifest", 8) == 0) {
160 return (load_manifest(argv[1], prefix, skip, NULL));
164 fp = file_findfile(argv[1], typestr);
166 snprintf(command_errbuf, sizeof(command_errbuf),
167 "warning: file '%s' already loaded", argv[1]);
171 if (file_loadraw(argv[1], typestr, 1) != NULL)
174 /* Failing to load mfs_root is never going to end well! */
175 if (strcmp("mfs_root", typestr) == 0)
181 * Do we have explicit KLD load ?
183 if (dokld || file_havepath(argv[1])) {
184 error = mod_loadkld(argv[1], argc - 2, argv + 2);
185 if (error == EEXIST) {
186 snprintf(command_errbuf, sizeof(command_errbuf),
187 "warning: KLD '%s' already loaded", argv[1]);
191 return (error == 0 ? CMD_OK : CMD_CRIT);
194 * Looks like a request for a module.
196 error = mod_load(argv[1], NULL, argc - 2, argv + 2);
197 if (error == EEXIST) {
198 snprintf(command_errbuf, sizeof(command_errbuf),
199 "warning: module '%s' already loaded", argv[1]);
203 return (error == 0 ? CMD_OK : CMD_CRIT);
206 #ifdef LOADER_GELI_SUPPORT
207 COMMAND_SET(load_geli, "load_geli", "load a geli key", command_load_geli);
210 command_load_geli(int argc, char *argv[])
217 command_errmsg = "usage is [-n key#] <prov> <file>";
224 while ((ch = getopt(argc, argv, "n:")) != -1) {
227 num = strtol(optarg, &cp, 0);
229 snprintf(command_errbuf, sizeof(command_errbuf),
230 "bad key index '%s'", optarg);
236 /* getopt has already reported an error */
240 argv += (optind - 1);
241 argc -= (optind - 1);
242 sprintf(typestr, "%s:geli_keyfile%d", argv[1], num);
243 return (file_loadraw(argv[2], typestr, 1) ? CMD_OK : CMD_ERROR);
250 struct preloaded_file *fp;
252 while (preloaded_files != NULL) {
253 fp = preloaded_files;
254 preloaded_files = preloaded_files->f_next;
258 unsetenv("kernelname");
261 COMMAND_SET(unload, "unload", "unload all modules", command_unload);
264 command_unload(int argc, char *argv[])
270 COMMAND_SET(lsmod, "lsmod", "list loaded modules", command_lsmod);
273 command_lsmod(int argc, char *argv[])
275 struct preloaded_file *fp;
276 struct kernel_module *mp;
277 struct file_metadata *md;
279 int ch, verbose, ret = 0;
284 while ((ch = getopt(argc, argv, "v")) != -1) {
291 /* getopt has already reported an error */
297 for (fp = preloaded_files; fp; fp = fp->f_next) {
298 snprintf(lbuf, sizeof(lbuf), " %p: ", (void *) fp->f_addr);
300 pager_output(fp->f_name);
301 snprintf(lbuf, sizeof(lbuf), " (%s, 0x%lx)\n", fp->f_type,
303 if (pager_output(lbuf))
305 if (fp->f_args != NULL) {
306 pager_output(" args: ");
307 pager_output(fp->f_args);
308 if (pager_output("\n"))
312 pager_output(" modules: ");
313 for (mp = fp->f_modules; mp; mp = mp->m_next) {
314 snprintf(lbuf, sizeof(lbuf), "%s.%d ", mp->m_name,
318 if (pager_output("\n"))
322 /* XXX could add some formatting smarts here to display some better */
323 for (md = fp->f_metadata; md != NULL; md = md->md_next) {
324 snprintf(lbuf, sizeof(lbuf), " 0x%04x, 0x%lx\n",
325 md->md_type, (long) md->md_size);
326 if (pager_output(lbuf))
338 * File level interface, functions file_*
341 file_load(char *filename, vm_offset_t dest, struct preloaded_file **result)
343 static int last_file_format = 0;
344 struct preloaded_file *fp;
348 if (archsw.arch_loadaddr != NULL)
349 dest = archsw.arch_loadaddr(LOAD_RAW, filename, dest);
352 for (i = last_file_format, fp = NULL;
353 file_formats[i] && fp == NULL; i++) {
354 error = (file_formats[i]->l_load)(filename, dest, &fp);
356 fp->f_loader = last_file_format = i; /* remember the loader */
359 } else if (last_file_format == i && i != 0) {
360 /* Restart from the beginning */
362 last_file_format = 0;
367 continue; /* Unknown to this handler? */
369 snprintf(command_errbuf, sizeof(command_errbuf),
370 "can't load file '%s': %s", filename, strerror(error));
378 file_load_dependencies(struct preloaded_file *base_file)
380 struct file_metadata *md;
381 struct preloaded_file *fp;
382 struct mod_depend *verinfo;
383 struct kernel_module *mp;
387 md = file_findmetadata(base_file, MODINFOMD_DEPLIST);
392 verinfo = (struct mod_depend*)md->md_data;
393 dmodname = (char *)(verinfo + 1);
394 if (file_findmodule(NULL, dmodname, verinfo) == NULL) {
395 printf("loading required module '%s'\n", dmodname);
396 error = mod_load(dmodname, verinfo, 0, NULL);
400 * If module loaded via kld name which isn't listed
401 * in the linker.hints file, we should check if it have
404 mp = file_findmodule(NULL, dmodname, verinfo);
406 snprintf(command_errbuf, sizeof(command_errbuf),
407 "module '%s' exists but with wrong version", dmodname);
412 md = metadata_next(md, MODINFOMD_DEPLIST);
416 /* Load failed; discard everything */
417 while (base_file != NULL) {
419 base_file = base_file->f_next;
426 * We've been asked to load (fname) as (type), so just suck it in,
427 * no arguments or anything.
429 struct preloaded_file *
430 file_loadraw(const char *fname, char *type, int insert)
432 struct preloaded_file *fp;
437 /* We can't load first */
438 if ((file_findfile(NULL, NULL)) == NULL) {
439 command_errmsg = "can't load file before kernel";
443 /* locate the file on the load path */
444 name = file_search(fname, NULL);
446 snprintf(command_errbuf, sizeof(command_errbuf),
447 "can't find '%s'", fname);
451 if ((fd = open(name, O_RDONLY)) < 0) {
452 snprintf(command_errbuf, sizeof(command_errbuf),
453 "can't open '%s': %s", name, strerror(errno));
458 #ifdef LOADER_VERIEXEC
459 if (verify_file(fd, name, 0, VE_MUST) < 0) {
460 sprintf(command_errbuf, "can't verify '%s'", name);
467 if (archsw.arch_loadaddr != NULL)
468 loadaddr = archsw.arch_loadaddr(LOAD_RAW, name, loadaddr);
474 /* read in 4k chunks; size is not really important */
475 got = archsw.arch_readin(fd, laddr, 4096);
476 if (got == 0) /* end of file */
478 if (got < 0) { /* error */
479 snprintf(command_errbuf, sizeof(command_errbuf),
480 "error reading '%s': %s", name, strerror(errno));
488 printf("size=%#jx\n", (uintmax_t)(laddr - loadaddr));
490 /* Looks OK so far; create & populate control structure */
492 fp->f_name = strdup(name);
493 fp->f_type = strdup(type);
495 fp->f_metadata = NULL;
497 fp->f_addr = loadaddr;
498 fp->f_size = laddr - loadaddr;
500 /* recognise space consumption */
503 /* Add to the list of loaded files */
505 file_insert_tail(fp);
511 * Load the module (name), pass it (argc),(argv), add container file
512 * to the list of loaded files.
513 * If module is already loaded just assign new argc/argv.
516 mod_load(char *modname, struct mod_depend *verinfo, int argc, char *argv[])
518 struct kernel_module *mp;
522 if (file_havepath(modname)) {
523 printf("Warning: mod_load() called instead of mod_loadkld() for module '%s'\n", modname);
524 return (mod_loadkld(modname, argc, argv));
526 /* see if module is already loaded */
527 mp = file_findmodule(NULL, modname, verinfo);
532 mp->m_args = unargv(argc, argv);
534 snprintf(command_errbuf, sizeof(command_errbuf),
535 "warning: module '%s' already loaded", mp->m_name);
538 /* locate file with the module on the search path */
539 filename = mod_searchmodule(modname, verinfo);
540 if (filename == NULL) {
541 snprintf(command_errbuf, sizeof(command_errbuf),
542 "can't find '%s'", modname);
545 err = mod_loadkld(filename, argc, argv);
550 * Load specified KLD. If path is omitted, then try to locate it via
554 mod_loadkld(const char *kldname, int argc, char *argv[])
556 struct preloaded_file *fp, *last_file;
561 * Get fully qualified KLD name
563 filename = file_search(kldname, kld_ext_list);
564 if (filename == NULL) {
565 snprintf(command_errbuf, sizeof(command_errbuf),
566 "can't find '%s'", kldname);
570 * Check if KLD already loaded
572 fp = file_findfile(filename, NULL);
574 snprintf(command_errbuf, sizeof(command_errbuf),
575 "warning: KLD '%s' already loaded", filename);
579 for (last_file = preloaded_files;
580 last_file != NULL && last_file->f_next != NULL;
581 last_file = last_file->f_next)
585 err = file_load(filename, loadaddr, &fp);
588 fp->f_args = unargv(argc, argv);
589 loadaddr = fp->f_addr + fp->f_size;
590 file_insert_tail(fp); /* Add to the list of loaded files */
591 if (file_load_dependencies(fp) != 0) {
593 last_file->f_next = NULL;
594 loadaddr = last_file->f_addr + last_file->f_size;
600 snprintf(command_errbuf, sizeof(command_errbuf),
601 "don't know how to load module '%s'", filename);
610 * Find a file matching (name) and (type).
611 * NULL may be passed as a wildcard to either.
613 struct preloaded_file *
614 file_findfile(const char *name, const char *type)
616 struct preloaded_file *fp;
618 for (fp = preloaded_files; fp != NULL; fp = fp->f_next) {
619 if (((name == NULL) || !strcmp(name, fp->f_name)) &&
620 ((type == NULL) || !strcmp(type, fp->f_type)))
627 * Find a module matching (name) inside of given file.
628 * NULL may be passed as a wildcard.
630 struct kernel_module *
631 file_findmodule(struct preloaded_file *fp, char *modname,
632 struct mod_depend *verinfo)
634 struct kernel_module *mp, *best;
638 for (fp = preloaded_files; fp; fp = fp->f_next) {
639 mp = file_findmodule(fp, modname, verinfo);
647 for (mp = fp->f_modules; mp; mp = mp->m_next) {
648 if (strcmp(modname, mp->m_name) == 0) {
651 mver = mp->m_version;
652 if (mver == verinfo->md_ver_preferred)
654 if (mver >= verinfo->md_ver_minimum &&
655 mver <= verinfo->md_ver_maximum &&
665 * Make a copy of (size) bytes of data from (p), and associate them as
666 * metadata of (type) to the module (mp).
669 file_addmetadata(struct preloaded_file *fp, int type, size_t size, void *p)
671 struct file_metadata *md;
673 md = malloc(sizeof(struct file_metadata) - sizeof(md->md_data) + size);
676 bcopy(p, md->md_data, size);
677 md->md_next = fp->f_metadata;
682 * Find a metadata object of (type) associated with the file (fp)
684 struct file_metadata *
685 file_findmetadata(struct preloaded_file *fp, int type)
687 struct file_metadata *md;
689 for (md = fp->f_metadata; md != NULL; md = md->md_next)
690 if (md->md_type == type)
696 * Remove all metadata from the file.
699 file_removemetadata(struct preloaded_file *fp)
701 struct file_metadata *md, *next;
703 for (md = fp->f_metadata; md != NULL; md = next)
708 fp->f_metadata = NULL;
711 struct file_metadata *
712 metadata_next(struct file_metadata *md, int type)
717 while((md = md->md_next) != NULL)
718 if (md->md_type == type)
723 static char *emptyextlist[] = { "", NULL };
726 * Check if the given file is in place and return full path to it.
729 file_lookup(const char *path, const char *name, int namelen, char **extlist)
732 char *result, *cp, **cpp;
733 int pathlen, extlen, len;
735 pathlen = strlen(path);
738 extlist = emptyextlist;
739 for (cpp = extlist; *cpp; cpp++) {
744 result = malloc(pathlen + namelen + extlen + 2);
747 bcopy(path, result, pathlen);
748 if (pathlen > 0 && result[pathlen - 1] != '/')
749 result[pathlen++] = '/';
750 cp = result + pathlen;
751 bcopy(name, cp, namelen);
753 for (cpp = extlist; *cpp; cpp++) {
755 if (stat(result, &st) == 0 && S_ISREG(st.st_mode))
763 * Check if file name have any qualifiers
766 file_havepath(const char *name)
770 archsw.arch_getdev(NULL, name, &cp);
771 return (cp != name || strchr(name, '/') != NULL);
775 * Attempt to find the file (name) on the module searchpath.
776 * If (name) is qualified in any way, we simply check it and
777 * return it or NULL. If it is not qualified, then we attempt
778 * to construct a path using entries in the environment variable
781 * The path we return a pointer to need never be freed, as we manage
785 file_search(const char *name, char **extlist)
787 struct moduledir *mdp;
792 /* Don't look for nothing */
797 return(strdup(name));
799 if (file_havepath(name)) {
800 /* Qualified, so just see if it exists */
801 if (stat(name, &sb) == 0)
802 return(strdup(name));
807 namelen = strlen(name);
808 STAILQ_FOREACH(mdp, &moduledir_list, d_link) {
809 result = file_lookup(mdp->d_path, name, namelen, extlist);
816 #define INT_ALIGN(base, ptr) ptr = \
817 (base) + roundup2((ptr) - (base), sizeof(int))
820 mod_search_hints(struct moduledir *mdp, const char *modname,
821 struct mod_depend *verinfo)
823 u_char *cp, *recptr, *bufend, *best;
825 int *intp, bestver, blen, clen, found, ival, modnamelen, reclen;
827 moduledir_readhints(mdp);
828 modnamelen = strlen(modname);
832 if (mdp->d_hints == NULL)
834 recptr = mdp->d_hints;
835 bufend = recptr + mdp->d_hintsz;
838 while (recptr < bufend && !found) {
846 if (clen != modnamelen || bcmp(cp, modname, clen) != 0)
849 INT_ALIGN(mdp->d_hints, cp);
853 if (verinfo == NULL || ival == verinfo->md_ver_preferred) {
857 if (ival >= verinfo->md_ver_minimum &&
858 ival <= verinfo->md_ver_maximum &&
868 recptr += reclen + sizeof(int);
871 * Finally check if KLD is in the place
874 result = file_lookup(mdp->d_path, (const char *)cp, clen, NULL);
876 result = file_lookup(mdp->d_path, (const char *)best, blen, NULL);
879 * If nothing found or hints is absent - fallback to the old way
880 * by using "kldname[.ko]" as module name.
882 if (!found && !bestver && result == NULL)
883 result = file_lookup(mdp->d_path, modname, modnamelen, kld_ext_list);
888 * Attempt to locate the file containing the module (name)
891 mod_searchmodule(char *name, struct mod_depend *verinfo)
893 struct moduledir *mdp;
898 * Now we ready to lookup module in the given directories
901 STAILQ_FOREACH(mdp, &moduledir_list, d_link) {
902 result = mod_search_hints(mdp, name, verinfo);
911 file_addmodule(struct preloaded_file *fp, char *modname, int version,
912 struct kernel_module **newmp)
914 struct kernel_module *mp;
915 struct mod_depend mdepend;
917 bzero(&mdepend, sizeof(mdepend));
918 mdepend.md_ver_preferred = version;
919 mp = file_findmodule(fp, modname, &mdepend);
922 mp = malloc(sizeof(struct kernel_module));
925 bzero(mp, sizeof(struct kernel_module));
926 mp->m_name = strdup(modname);
927 mp->m_version = version;
929 mp->m_next = fp->f_modules;
940 file_discard(struct preloaded_file *fp)
942 struct file_metadata *md, *md1;
943 struct kernel_module *mp, *mp1;
960 if (fp->f_name != NULL)
962 if (fp->f_type != NULL)
964 if (fp->f_args != NULL)
970 * Allocate a new file; must be used instead of malloc()
971 * to ensure safe initialisation.
973 struct preloaded_file *
976 struct preloaded_file *fp;
978 if ((fp = malloc(sizeof(struct preloaded_file))) != NULL) {
979 bzero(fp, sizeof(struct preloaded_file));
985 * Add a module to the chain
988 file_insert_tail(struct preloaded_file *fp)
990 struct preloaded_file *cm;
992 /* Append to list of loaded file */
994 if (preloaded_files == NULL) {
995 preloaded_files = fp;
997 for (cm = preloaded_files; cm->f_next != NULL; cm = cm->f_next)
1004 moduledir_fullpath(struct moduledir *mdp, const char *fname)
1008 cp = malloc(strlen(mdp->d_path) + strlen(fname) + 2);
1011 strcpy(cp, mdp->d_path);
1018 * Read linker.hints file into memory performing some sanity checks.
1021 moduledir_readhints(struct moduledir *mdp)
1025 int fd, size, version;
1027 if (mdp->d_hints != NULL || (mdp->d_flags & MDIR_NOHINTS))
1029 path = moduledir_fullpath(mdp, "linker.hints");
1030 if (stat(path, &st) != 0 ||
1031 st.st_size < (ssize_t)(sizeof(version) + sizeof(int)) ||
1032 st.st_size > LINKER_HINTS_MAX || (fd = open(path, O_RDONLY)) < 0) {
1034 mdp->d_flags |= MDIR_NOHINTS;
1038 size = read(fd, &version, sizeof(version));
1039 if (size != sizeof(version) || version != LINKER_HINTS_VERSION)
1041 size = st.st_size - size;
1042 mdp->d_hints = malloc(size);
1043 if (mdp->d_hints == NULL)
1045 if (read(fd, mdp->d_hints, size) != size)
1047 mdp->d_hintsz = size;
1054 mdp->d_hints = NULL;
1056 mdp->d_flags |= MDIR_NOHINTS;
1061 * Extract directories from the ';' separated list, remove duplicates.
1064 moduledir_rebuild(void)
1066 struct moduledir *mdp, *mtmp;
1067 const char *path, *cp, *ep;
1070 path = getenv("module_path");
1072 path = default_searchpath;
1074 * Rebuild list of module directories if it changed
1076 STAILQ_FOREACH(mdp, &moduledir_list, d_link)
1077 mdp->d_flags |= MDIR_REMOVED;
1079 for (ep = path; *ep != 0; ep++) {
1081 for (; *ep != 0 && *ep != ';'; ep++)
1084 * Ignore trailing slashes
1086 for (cplen = ep - cp; cplen > 1 && cp[cplen - 1] == '/'; cplen--)
1088 STAILQ_FOREACH(mdp, &moduledir_list, d_link) {
1089 if (strlen(mdp->d_path) != cplen || bcmp(cp, mdp->d_path, cplen) != 0)
1091 mdp->d_flags &= ~MDIR_REMOVED;
1095 mdp = malloc(sizeof(*mdp) + cplen + 1);
1098 mdp->d_path = (char*)(mdp + 1);
1099 bcopy(cp, mdp->d_path, cplen);
1100 mdp->d_path[cplen] = 0;
1101 mdp->d_hints = NULL;
1103 STAILQ_INSERT_TAIL(&moduledir_list, mdp, d_link);
1109 * Delete unused directories if any
1111 mdp = STAILQ_FIRST(&moduledir_list);
1113 if ((mdp->d_flags & MDIR_REMOVED) == 0) {
1114 mdp = STAILQ_NEXT(mdp, d_link);
1119 mdp = STAILQ_NEXT(mdp, d_link);
1120 STAILQ_REMOVE(&moduledir_list, mtmp, moduledir, d_link);