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;
107 int dofile, dokld, ch, error;
114 command_errmsg = "no filename specified";
117 while ((ch = getopt(argc, argv, "kt:")) != -1) {
128 /* getopt has already reported an error */
132 argv += (optind - 1);
133 argc -= (optind - 1);
136 * Request to load a raw file?
139 if ((argc != 2) || (typestr == NULL) || (*typestr == 0)) {
140 command_errmsg = "invalid load type";
144 fp = file_findfile(argv[1], typestr);
146 sprintf(command_errbuf, "warning: file '%s' already loaded", argv[1]);
150 return (file_loadraw(argv[1], typestr, 1) ? CMD_OK : CMD_ERROR);
153 * Do we have explicit KLD load ?
155 if (dokld || file_havepath(argv[1])) {
156 error = mod_loadkld(argv[1], argc - 2, argv + 2);
158 sprintf(command_errbuf, "warning: KLD '%s' already loaded", argv[1]);
159 return (error == 0 ? CMD_OK : CMD_ERROR);
162 * Looks like a request for a module.
164 error = mod_load(argv[1], NULL, argc - 2, argv + 2);
166 sprintf(command_errbuf, "warning: module '%s' already loaded", argv[1]);
167 return (error == 0 ? CMD_OK : CMD_ERROR);
170 COMMAND_SET(load_geli, "load_geli", "load a geli key", command_load_geli);
173 command_load_geli(int argc, char *argv[])
180 command_errmsg = "usage is [-n key#] <prov> <file>";
187 while ((ch = getopt(argc, argv, "n:")) != -1) {
190 num = strtol(optarg, &cp, 0);
192 sprintf(command_errbuf, "bad key index '%s'", optarg);
198 /* getopt has already reported an error */
202 argv += (optind - 1);
203 argc -= (optind - 1);
204 sprintf(typestr, "%s:geli_keyfile%d", argv[1], num);
205 return (file_loadraw(argv[2], typestr, 1) ? CMD_OK : CMD_ERROR);
211 struct preloaded_file *fp;
213 while (preloaded_files != NULL) {
214 fp = preloaded_files;
215 preloaded_files = preloaded_files->f_next;
219 unsetenv("kernelname");
222 COMMAND_SET(unload, "unload", "unload all modules", command_unload);
225 command_unload(int argc, char *argv[])
231 COMMAND_SET(lsmod, "lsmod", "list loaded modules", command_lsmod);
234 command_lsmod(int argc, char *argv[])
236 struct preloaded_file *fp;
237 struct kernel_module *mp;
238 struct file_metadata *md;
245 while ((ch = getopt(argc, argv, "v")) != -1) {
252 /* getopt has already reported an error */
258 for (fp = preloaded_files; fp; fp = fp->f_next) {
259 sprintf(lbuf, " %p: ", (void *) fp->f_addr);
261 pager_output(fp->f_name);
262 sprintf(lbuf, " (%s, 0x%lx)\n", fp->f_type, (long)fp->f_size);
264 if (fp->f_args != NULL) {
265 pager_output(" args: ");
266 pager_output(fp->f_args);
270 pager_output(" modules: ");
271 for (mp = fp->f_modules; mp; mp = mp->m_next) {
272 sprintf(lbuf, "%s.%d ", mp->m_name, mp->m_version);
278 /* XXX could add some formatting smarts here to display some better */
279 for (md = fp->f_metadata; md != NULL; md = md->md_next) {
280 sprintf(lbuf, " 0x%04x, 0x%lx\n", md->md_type, (long) md->md_size);
290 * File level interface, functions file_*
293 file_load(char *filename, vm_offset_t dest, struct preloaded_file **result)
295 static int last_file_format = 0;
296 struct preloaded_file *fp;
300 if (archsw.arch_loadaddr != NULL)
301 dest = archsw.arch_loadaddr(LOAD_RAW, filename, dest);
304 for (i = last_file_format, fp = NULL;
305 file_formats[i] && fp == NULL; i++) {
306 error = (file_formats[i]->l_load)(filename, dest, &fp);
308 fp->f_loader = last_file_format = i; /* remember the loader */
311 } else if (last_file_format == i && i != 0) {
312 /* Restart from the beginning */
314 last_file_format = 0;
319 continue; /* Unknown to this handler? */
321 sprintf(command_errbuf, "can't load file '%s': %s",
322 filename, strerror(error));
330 file_load_dependencies(struct preloaded_file *base_file)
332 struct file_metadata *md;
333 struct preloaded_file *fp;
334 struct mod_depend *verinfo;
335 struct kernel_module *mp;
339 md = file_findmetadata(base_file, MODINFOMD_DEPLIST);
344 verinfo = (struct mod_depend*)md->md_data;
345 dmodname = (char *)(verinfo + 1);
346 if (file_findmodule(NULL, dmodname, verinfo) == NULL) {
347 printf("loading required module '%s'\n", dmodname);
348 error = mod_load(dmodname, verinfo, 0, NULL);
352 * If module loaded via kld name which isn't listed
353 * in the linker.hints file, we should check if it have
356 mp = file_findmodule(NULL, dmodname, verinfo);
358 sprintf(command_errbuf, "module '%s' exists but with wrong version",
364 md = metadata_next(md, MODINFOMD_DEPLIST);
368 /* Load failed; discard everything */
369 while (base_file != NULL) {
371 base_file = base_file->f_next;
378 * We've been asked to load (name) as (type), so just suck it in,
379 * no arguments or anything.
381 struct preloaded_file *
382 file_loadraw(char *name, char *type, int insert)
384 struct preloaded_file *fp;
389 /* We can't load first */
390 if ((file_findfile(NULL, NULL)) == NULL) {
391 command_errmsg = "can't load file before kernel";
395 /* locate the file on the load path */
396 cp = file_search(name, NULL);
398 sprintf(command_errbuf, "can't find '%s'", name);
403 if ((fd = open(name, O_RDONLY)) < 0) {
404 sprintf(command_errbuf, "can't open '%s': %s", name, strerror(errno));
409 if (archsw.arch_loadaddr != NULL)
410 loadaddr = archsw.arch_loadaddr(LOAD_RAW, name, loadaddr);
416 /* read in 4k chunks; size is not really important */
417 got = archsw.arch_readin(fd, laddr, 4096);
418 if (got == 0) /* end of file */
420 if (got < 0) { /* error */
421 sprintf(command_errbuf, "error reading '%s': %s", name, strerror(errno));
429 printf("size=%#jx\n", (uintmax_t)(laddr - loadaddr));
431 /* Looks OK so far; create & populate control structure */
433 fp->f_name = strdup(name);
434 fp->f_type = strdup(type);
436 fp->f_metadata = NULL;
438 fp->f_addr = loadaddr;
439 fp->f_size = laddr - loadaddr;
441 /* recognise space consumption */
444 /* Add to the list of loaded files */
446 file_insert_tail(fp);
452 * Load the module (name), pass it (argc),(argv), add container file
453 * to the list of loaded files.
454 * If module is already loaded just assign new argc/argv.
457 mod_load(char *modname, struct mod_depend *verinfo, int argc, char *argv[])
459 struct kernel_module *mp;
463 if (file_havepath(modname)) {
464 printf("Warning: mod_load() called instead of mod_loadkld() for module '%s'\n", modname);
465 return (mod_loadkld(modname, argc, argv));
467 /* see if module is already loaded */
468 mp = file_findmodule(NULL, modname, verinfo);
473 mp->m_args = unargv(argc, argv);
475 sprintf(command_errbuf, "warning: module '%s' already loaded", mp->m_name);
478 /* locate file with the module on the search path */
479 filename = mod_searchmodule(modname, verinfo);
480 if (filename == NULL) {
481 sprintf(command_errbuf, "can't find '%s'", modname);
484 err = mod_loadkld(filename, argc, argv);
489 * Load specified KLD. If path is omitted, then try to locate it via
493 mod_loadkld(const char *kldname, int argc, char *argv[])
495 struct preloaded_file *fp, *last_file;
500 * Get fully qualified KLD name
502 filename = file_search(kldname, kld_ext_list);
503 if (filename == NULL) {
504 sprintf(command_errbuf, "can't find '%s'", kldname);
508 * Check if KLD already loaded
510 fp = file_findfile(filename, NULL);
512 sprintf(command_errbuf, "warning: KLD '%s' already loaded", filename);
516 for (last_file = preloaded_files;
517 last_file != NULL && last_file->f_next != NULL;
518 last_file = last_file->f_next)
522 err = file_load(filename, loadaddr, &fp);
525 fp->f_args = unargv(argc, argv);
526 loadaddr = fp->f_addr + fp->f_size;
527 file_insert_tail(fp); /* Add to the list of loaded files */
528 if (file_load_dependencies(fp) != 0) {
530 last_file->f_next = NULL;
531 loadaddr = last_file->f_addr + last_file->f_size;
537 sprintf(command_errbuf, "don't know how to load module '%s'", filename);
545 * Find a file matching (name) and (type).
546 * NULL may be passed as a wildcard to either.
548 struct preloaded_file *
549 file_findfile(const char *name, const char *type)
551 struct preloaded_file *fp;
553 for (fp = preloaded_files; fp != NULL; fp = fp->f_next) {
554 if (((name == NULL) || !strcmp(name, fp->f_name)) &&
555 ((type == NULL) || !strcmp(type, fp->f_type)))
562 * Find a module matching (name) inside of given file.
563 * NULL may be passed as a wildcard.
565 struct kernel_module *
566 file_findmodule(struct preloaded_file *fp, char *modname,
567 struct mod_depend *verinfo)
569 struct kernel_module *mp, *best;
573 for (fp = preloaded_files; fp; fp = fp->f_next) {
574 mp = file_findmodule(fp, modname, verinfo);
582 for (mp = fp->f_modules; mp; mp = mp->m_next) {
583 if (strcmp(modname, mp->m_name) == 0) {
586 mver = mp->m_version;
587 if (mver == verinfo->md_ver_preferred)
589 if (mver >= verinfo->md_ver_minimum &&
590 mver <= verinfo->md_ver_maximum &&
600 * Make a copy of (size) bytes of data from (p), and associate them as
601 * metadata of (type) to the module (mp).
604 file_addmetadata(struct preloaded_file *fp, int type, size_t size, void *p)
606 struct file_metadata *md;
608 md = malloc(sizeof(struct file_metadata) - sizeof(md->md_data) + size);
611 bcopy(p, md->md_data, size);
612 md->md_next = fp->f_metadata;
617 * Find a metadata object of (type) associated with the file (fp)
619 struct file_metadata *
620 file_findmetadata(struct preloaded_file *fp, int type)
622 struct file_metadata *md;
624 for (md = fp->f_metadata; md != NULL; md = md->md_next)
625 if (md->md_type == type)
630 struct file_metadata *
631 metadata_next(struct file_metadata *md, int type)
635 while((md = md->md_next) != NULL)
636 if (md->md_type == type)
641 static char *emptyextlist[] = { "", NULL };
644 * Check if the given file is in place and return full path to it.
647 file_lookup(const char *path, const char *name, int namelen, char **extlist)
650 char *result, *cp, **cpp;
651 int pathlen, extlen, len;
653 pathlen = strlen(path);
656 extlist = emptyextlist;
657 for (cpp = extlist; *cpp; cpp++) {
662 result = malloc(pathlen + namelen + extlen + 2);
665 bcopy(path, result, pathlen);
666 if (pathlen > 0 && result[pathlen - 1] != '/')
667 result[pathlen++] = '/';
668 cp = result + pathlen;
669 bcopy(name, cp, namelen);
671 for (cpp = extlist; *cpp; cpp++) {
673 if (stat(result, &st) == 0 && S_ISREG(st.st_mode))
681 * Check if file name have any qualifiers
684 file_havepath(const char *name)
688 archsw.arch_getdev(NULL, name, &cp);
689 return (cp != name || strchr(name, '/') != NULL);
693 * Attempt to find the file (name) on the module searchpath.
694 * If (name) is qualified in any way, we simply check it and
695 * return it or NULL. If it is not qualified, then we attempt
696 * to construct a path using entries in the environment variable
699 * The path we return a pointer to need never be freed, as we manage
703 file_search(const char *name, char **extlist)
705 struct moduledir *mdp;
710 /* Don't look for nothing */
715 return(strdup(name));
717 if (file_havepath(name)) {
718 /* Qualified, so just see if it exists */
719 if (stat(name, &sb) == 0)
720 return(strdup(name));
725 namelen = strlen(name);
726 STAILQ_FOREACH(mdp, &moduledir_list, d_link) {
727 result = file_lookup(mdp->d_path, name, namelen, extlist);
734 #define INT_ALIGN(base, ptr) ptr = \
735 (base) + (((ptr) - (base) + sizeof(int) - 1) & ~(sizeof(int) - 1))
738 mod_search_hints(struct moduledir *mdp, const char *modname,
739 struct mod_depend *verinfo)
741 u_char *cp, *recptr, *bufend, *best;
743 int *intp, bestver, blen, clen, found, ival, modnamelen, reclen;
745 moduledir_readhints(mdp);
746 modnamelen = strlen(modname);
750 if (mdp->d_hints == NULL)
752 recptr = mdp->d_hints;
753 bufend = recptr + mdp->d_hintsz;
756 while (recptr < bufend && !found) {
764 if (clen != modnamelen || bcmp(cp, modname, clen) != 0)
767 INT_ALIGN(mdp->d_hints, cp);
771 if (verinfo == NULL || ival == verinfo->md_ver_preferred) {
775 if (ival >= verinfo->md_ver_minimum &&
776 ival <= verinfo->md_ver_maximum &&
786 recptr += reclen + sizeof(int);
789 * Finally check if KLD is in the place
792 result = file_lookup(mdp->d_path, cp, clen, NULL);
794 result = file_lookup(mdp->d_path, best, blen, NULL);
797 * If nothing found or hints is absent - fallback to the old way
798 * by using "kldname[.ko]" as module name.
800 if (!found && !bestver && result == NULL)
801 result = file_lookup(mdp->d_path, modname, modnamelen, kld_ext_list);
806 * Attempt to locate the file containing the module (name)
809 mod_searchmodule(char *name, struct mod_depend *verinfo)
811 struct moduledir *mdp;
816 * Now we ready to lookup module in the given directories
819 STAILQ_FOREACH(mdp, &moduledir_list, d_link) {
820 result = mod_search_hints(mdp, name, verinfo);
829 file_addmodule(struct preloaded_file *fp, char *modname, int version,
830 struct kernel_module **newmp)
832 struct kernel_module *mp;
833 struct mod_depend mdepend;
835 bzero(&mdepend, sizeof(mdepend));
836 mdepend.md_ver_preferred = version;
837 mp = file_findmodule(fp, modname, &mdepend);
840 mp = malloc(sizeof(struct kernel_module));
843 bzero(mp, sizeof(struct kernel_module));
844 mp->m_name = strdup(modname);
845 mp->m_version = version;
847 mp->m_next = fp->f_modules;
858 file_discard(struct preloaded_file *fp)
860 struct file_metadata *md, *md1;
861 struct kernel_module *mp, *mp1;
878 if (fp->f_name != NULL)
880 if (fp->f_type != NULL)
882 if (fp->f_args != NULL)
888 * Allocate a new file; must be used instead of malloc()
889 * to ensure safe initialisation.
891 struct preloaded_file *
894 struct preloaded_file *fp;
896 if ((fp = malloc(sizeof(struct preloaded_file))) != NULL) {
897 bzero(fp, sizeof(struct preloaded_file));
903 * Add a module to the chain
906 file_insert_tail(struct preloaded_file *fp)
908 struct preloaded_file *cm;
910 /* Append to list of loaded file */
912 if (preloaded_files == NULL) {
913 preloaded_files = fp;
915 for (cm = preloaded_files; cm->f_next != NULL; cm = cm->f_next)
922 moduledir_fullpath(struct moduledir *mdp, const char *fname)
926 cp = malloc(strlen(mdp->d_path) + strlen(fname) + 2);
929 strcpy(cp, mdp->d_path);
936 * Read linker.hints file into memory performing some sanity checks.
939 moduledir_readhints(struct moduledir *mdp)
943 int fd, size, version;
945 if (mdp->d_hints != NULL || (mdp->d_flags & MDIR_NOHINTS))
947 path = moduledir_fullpath(mdp, "linker.hints");
948 if (stat(path, &st) != 0 ||
949 st.st_size < (ssize_t)(sizeof(version) + sizeof(int)) ||
950 st.st_size > LINKER_HINTS_MAX || (fd = open(path, O_RDONLY)) < 0) {
952 mdp->d_flags |= MDIR_NOHINTS;
956 size = read(fd, &version, sizeof(version));
957 if (size != sizeof(version) || version != LINKER_HINTS_VERSION)
959 size = st.st_size - size;
960 mdp->d_hints = malloc(size);
961 if (mdp->d_hints == NULL)
963 if (read(fd, mdp->d_hints, size) != size)
965 mdp->d_hintsz = size;
974 mdp->d_flags |= MDIR_NOHINTS;
979 * Extract directories from the ';' separated list, remove duplicates.
982 moduledir_rebuild(void)
984 struct moduledir *mdp, *mtmp;
985 const char *path, *cp, *ep;
988 path = getenv("module_path");
990 path = default_searchpath;
992 * Rebuild list of module directories if it changed
994 STAILQ_FOREACH(mdp, &moduledir_list, d_link)
995 mdp->d_flags |= MDIR_REMOVED;
997 for (ep = path; *ep != 0; ep++) {
999 for (; *ep != 0 && *ep != ';'; ep++)
1002 * Ignore trailing slashes
1004 for (cplen = ep - cp; cplen > 1 && cp[cplen - 1] == '/'; cplen--)
1006 STAILQ_FOREACH(mdp, &moduledir_list, d_link) {
1007 if (strlen(mdp->d_path) != cplen || bcmp(cp, mdp->d_path, cplen) != 0)
1009 mdp->d_flags &= ~MDIR_REMOVED;
1013 mdp = malloc(sizeof(*mdp) + cplen + 1);
1016 mdp->d_path = (char*)(mdp + 1);
1017 bcopy(cp, mdp->d_path, cplen);
1018 mdp->d_path[cplen] = 0;
1019 mdp->d_hints = NULL;
1021 STAILQ_INSERT_TAIL(&moduledir_list, mdp, d_link);
1027 * Delete unused directories if any
1029 mdp = STAILQ_FIRST(&moduledir_list);
1031 if ((mdp->d_flags & MDIR_REMOVED) == 0) {
1032 mdp = STAILQ_NEXT(mdp, d_link);
1037 mdp = STAILQ_NEXT(mdp, d_link);
1038 STAILQ_REMOVE(&moduledir_list, mtmp, moduledir, d_link);