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 if (file_loadraw(argv[1], typestr, 1) != NULL)
153 /* Failing to load mfs_root is never going to end well! */
154 if (strcmp("mfs_root", typestr) == 0)
160 * Do we have explicit KLD load ?
162 if (dokld || file_havepath(argv[1])) {
163 error = mod_loadkld(argv[1], argc - 2, argv + 2);
164 if (error == EEXIST) {
165 sprintf(command_errbuf, "warning: KLD '%s' already loaded", argv[1]);
169 return (error == 0 ? CMD_OK : CMD_CRIT);
172 * Looks like a request for a module.
174 error = mod_load(argv[1], NULL, argc - 2, argv + 2);
175 if (error == EEXIST) {
176 sprintf(command_errbuf, "warning: module '%s' already loaded", argv[1]);
180 return (error == 0 ? CMD_OK : CMD_CRIT);
183 COMMAND_SET(load_geli, "load_geli", "load a geli key", command_load_geli);
186 command_load_geli(int argc, char *argv[])
193 command_errmsg = "usage is [-n key#] <prov> <file>";
200 while ((ch = getopt(argc, argv, "n:")) != -1) {
203 num = strtol(optarg, &cp, 0);
205 sprintf(command_errbuf, "bad key index '%s'", optarg);
211 /* getopt has already reported an error */
215 argv += (optind - 1);
216 argc -= (optind - 1);
217 sprintf(typestr, "%s:geli_keyfile%d", argv[1], num);
218 return (file_loadraw(argv[2], typestr, 1) ? CMD_OK : CMD_ERROR);
224 struct preloaded_file *fp;
226 while (preloaded_files != NULL) {
227 fp = preloaded_files;
228 preloaded_files = preloaded_files->f_next;
232 unsetenv("kernelname");
235 COMMAND_SET(unload, "unload", "unload all modules", command_unload);
238 command_unload(int argc, char *argv[])
244 COMMAND_SET(lsmod, "lsmod", "list loaded modules", command_lsmod);
247 command_lsmod(int argc, char *argv[])
249 struct preloaded_file *fp;
250 struct kernel_module *mp;
251 struct file_metadata *md;
258 while ((ch = getopt(argc, argv, "v")) != -1) {
265 /* getopt has already reported an error */
271 for (fp = preloaded_files; fp; fp = fp->f_next) {
272 sprintf(lbuf, " %p: ", (void *) fp->f_addr);
274 pager_output(fp->f_name);
275 sprintf(lbuf, " (%s, 0x%lx)\n", fp->f_type, (long)fp->f_size);
277 if (fp->f_args != NULL) {
278 pager_output(" args: ");
279 pager_output(fp->f_args);
283 pager_output(" modules: ");
284 for (mp = fp->f_modules; mp; mp = mp->m_next) {
285 sprintf(lbuf, "%s.%d ", mp->m_name, mp->m_version);
291 /* XXX could add some formatting smarts here to display some better */
292 for (md = fp->f_metadata; md != NULL; md = md->md_next) {
293 sprintf(lbuf, " 0x%04x, 0x%lx\n", md->md_type, (long) md->md_size);
303 * File level interface, functions file_*
306 file_load(char *filename, vm_offset_t dest, struct preloaded_file **result)
308 static int last_file_format = 0;
309 struct preloaded_file *fp;
313 if (archsw.arch_loadaddr != NULL)
314 dest = archsw.arch_loadaddr(LOAD_RAW, filename, dest);
317 for (i = last_file_format, fp = NULL;
318 file_formats[i] && fp == NULL; i++) {
319 error = (file_formats[i]->l_load)(filename, dest, &fp);
321 fp->f_loader = last_file_format = i; /* remember the loader */
324 } else if (last_file_format == i && i != 0) {
325 /* Restart from the beginning */
327 last_file_format = 0;
332 continue; /* Unknown to this handler? */
334 sprintf(command_errbuf, "can't load file '%s': %s",
335 filename, strerror(error));
343 file_load_dependencies(struct preloaded_file *base_file)
345 struct file_metadata *md;
346 struct preloaded_file *fp;
347 struct mod_depend *verinfo;
348 struct kernel_module *mp;
352 md = file_findmetadata(base_file, MODINFOMD_DEPLIST);
357 verinfo = (struct mod_depend*)md->md_data;
358 dmodname = (char *)(verinfo + 1);
359 if (file_findmodule(NULL, dmodname, verinfo) == NULL) {
360 printf("loading required module '%s'\n", dmodname);
361 error = mod_load(dmodname, verinfo, 0, NULL);
365 * If module loaded via kld name which isn't listed
366 * in the linker.hints file, we should check if it have
369 mp = file_findmodule(NULL, dmodname, verinfo);
371 sprintf(command_errbuf, "module '%s' exists but with wrong version",
377 md = metadata_next(md, MODINFOMD_DEPLIST);
381 /* Load failed; discard everything */
382 while (base_file != NULL) {
384 base_file = base_file->f_next;
391 * We've been asked to load (fname) as (type), so just suck it in,
392 * no arguments or anything.
394 struct preloaded_file *
395 file_loadraw(const char *fname, char *type, int insert)
397 struct preloaded_file *fp;
402 /* We can't load first */
403 if ((file_findfile(NULL, NULL)) == NULL) {
404 command_errmsg = "can't load file before kernel";
408 /* locate the file on the load path */
409 name = file_search(fname, NULL);
411 sprintf(command_errbuf, "can't find '%s'", fname);
415 if ((fd = open(name, O_RDONLY)) < 0) {
416 sprintf(command_errbuf, "can't open '%s': %s", name, strerror(errno));
421 if (archsw.arch_loadaddr != NULL)
422 loadaddr = archsw.arch_loadaddr(LOAD_RAW, name, loadaddr);
428 /* read in 4k chunks; size is not really important */
429 got = archsw.arch_readin(fd, laddr, 4096);
430 if (got == 0) /* end of file */
432 if (got < 0) { /* error */
433 sprintf(command_errbuf, "error reading '%s': %s", name, strerror(errno));
441 printf("size=%#jx\n", (uintmax_t)(laddr - loadaddr));
443 /* Looks OK so far; create & populate control structure */
445 fp->f_name = strdup(name);
446 fp->f_type = strdup(type);
448 fp->f_metadata = NULL;
450 fp->f_addr = loadaddr;
451 fp->f_size = laddr - loadaddr;
453 /* recognise space consumption */
456 /* Add to the list of loaded files */
458 file_insert_tail(fp);
464 * Load the module (name), pass it (argc),(argv), add container file
465 * to the list of loaded files.
466 * If module is already loaded just assign new argc/argv.
469 mod_load(char *modname, struct mod_depend *verinfo, int argc, char *argv[])
471 struct kernel_module *mp;
475 if (file_havepath(modname)) {
476 printf("Warning: mod_load() called instead of mod_loadkld() for module '%s'\n", modname);
477 return (mod_loadkld(modname, argc, argv));
479 /* see if module is already loaded */
480 mp = file_findmodule(NULL, modname, verinfo);
485 mp->m_args = unargv(argc, argv);
487 sprintf(command_errbuf, "warning: module '%s' already loaded", mp->m_name);
490 /* locate file with the module on the search path */
491 filename = mod_searchmodule(modname, verinfo);
492 if (filename == NULL) {
493 sprintf(command_errbuf, "can't find '%s'", modname);
496 err = mod_loadkld(filename, argc, argv);
501 * Load specified KLD. If path is omitted, then try to locate it via
505 mod_loadkld(const char *kldname, int argc, char *argv[])
507 struct preloaded_file *fp, *last_file;
512 * Get fully qualified KLD name
514 filename = file_search(kldname, kld_ext_list);
515 if (filename == NULL) {
516 sprintf(command_errbuf, "can't find '%s'", kldname);
520 * Check if KLD already loaded
522 fp = file_findfile(filename, NULL);
524 sprintf(command_errbuf, "warning: KLD '%s' already loaded", filename);
528 for (last_file = preloaded_files;
529 last_file != NULL && last_file->f_next != NULL;
530 last_file = last_file->f_next)
534 err = file_load(filename, loadaddr, &fp);
537 fp->f_args = unargv(argc, argv);
538 loadaddr = fp->f_addr + fp->f_size;
539 file_insert_tail(fp); /* Add to the list of loaded files */
540 if (file_load_dependencies(fp) != 0) {
542 last_file->f_next = NULL;
543 loadaddr = last_file->f_addr + last_file->f_size;
549 sprintf(command_errbuf, "don't know how to load module '%s'", filename);
557 * Find a file matching (name) and (type).
558 * NULL may be passed as a wildcard to either.
560 struct preloaded_file *
561 file_findfile(const char *name, const char *type)
563 struct preloaded_file *fp;
565 for (fp = preloaded_files; fp != NULL; fp = fp->f_next) {
566 if (((name == NULL) || !strcmp(name, fp->f_name)) &&
567 ((type == NULL) || !strcmp(type, fp->f_type)))
574 * Find a module matching (name) inside of given file.
575 * NULL may be passed as a wildcard.
577 struct kernel_module *
578 file_findmodule(struct preloaded_file *fp, char *modname,
579 struct mod_depend *verinfo)
581 struct kernel_module *mp, *best;
585 for (fp = preloaded_files; fp; fp = fp->f_next) {
586 mp = file_findmodule(fp, modname, verinfo);
594 for (mp = fp->f_modules; mp; mp = mp->m_next) {
595 if (strcmp(modname, mp->m_name) == 0) {
598 mver = mp->m_version;
599 if (mver == verinfo->md_ver_preferred)
601 if (mver >= verinfo->md_ver_minimum &&
602 mver <= verinfo->md_ver_maximum &&
612 * Make a copy of (size) bytes of data from (p), and associate them as
613 * metadata of (type) to the module (mp).
616 file_addmetadata(struct preloaded_file *fp, int type, size_t size, void *p)
618 struct file_metadata *md;
620 md = malloc(sizeof(struct file_metadata) - sizeof(md->md_data) + size);
623 bcopy(p, md->md_data, size);
624 md->md_next = fp->f_metadata;
629 * Find a metadata object of (type) associated with the file (fp)
631 struct file_metadata *
632 file_findmetadata(struct preloaded_file *fp, int type)
634 struct file_metadata *md;
636 for (md = fp->f_metadata; md != NULL; md = md->md_next)
637 if (md->md_type == type)
642 struct file_metadata *
643 metadata_next(struct file_metadata *md, int type)
647 while((md = md->md_next) != NULL)
648 if (md->md_type == type)
653 static char *emptyextlist[] = { "", NULL };
656 * Check if the given file is in place and return full path to it.
659 file_lookup(const char *path, const char *name, int namelen, char **extlist)
662 char *result, *cp, **cpp;
663 int pathlen, extlen, len;
665 pathlen = strlen(path);
668 extlist = emptyextlist;
669 for (cpp = extlist; *cpp; cpp++) {
674 result = malloc(pathlen + namelen + extlen + 2);
677 bcopy(path, result, pathlen);
678 if (pathlen > 0 && result[pathlen - 1] != '/')
679 result[pathlen++] = '/';
680 cp = result + pathlen;
681 bcopy(name, cp, namelen);
683 for (cpp = extlist; *cpp; cpp++) {
685 if (stat(result, &st) == 0 && S_ISREG(st.st_mode))
693 * Check if file name have any qualifiers
696 file_havepath(const char *name)
700 archsw.arch_getdev(NULL, name, &cp);
701 return (cp != name || strchr(name, '/') != NULL);
705 * Attempt to find the file (name) on the module searchpath.
706 * If (name) is qualified in any way, we simply check it and
707 * return it or NULL. If it is not qualified, then we attempt
708 * to construct a path using entries in the environment variable
711 * The path we return a pointer to need never be freed, as we manage
715 file_search(const char *name, char **extlist)
717 struct moduledir *mdp;
722 /* Don't look for nothing */
727 return(strdup(name));
729 if (file_havepath(name)) {
730 /* Qualified, so just see if it exists */
731 if (stat(name, &sb) == 0)
732 return(strdup(name));
737 namelen = strlen(name);
738 STAILQ_FOREACH(mdp, &moduledir_list, d_link) {
739 result = file_lookup(mdp->d_path, name, namelen, extlist);
746 #define INT_ALIGN(base, ptr) ptr = \
747 (base) + (((ptr) - (base) + sizeof(int) - 1) & ~(sizeof(int) - 1))
750 mod_search_hints(struct moduledir *mdp, const char *modname,
751 struct mod_depend *verinfo)
753 u_char *cp, *recptr, *bufend, *best;
755 int *intp, bestver, blen, clen, found, ival, modnamelen, reclen;
757 moduledir_readhints(mdp);
758 modnamelen = strlen(modname);
762 if (mdp->d_hints == NULL)
764 recptr = mdp->d_hints;
765 bufend = recptr + mdp->d_hintsz;
768 while (recptr < bufend && !found) {
776 if (clen != modnamelen || bcmp(cp, modname, clen) != 0)
779 INT_ALIGN(mdp->d_hints, cp);
783 if (verinfo == NULL || ival == verinfo->md_ver_preferred) {
787 if (ival >= verinfo->md_ver_minimum &&
788 ival <= verinfo->md_ver_maximum &&
798 recptr += reclen + sizeof(int);
801 * Finally check if KLD is in the place
804 result = file_lookup(mdp->d_path, (const char *)cp, clen, NULL);
806 result = file_lookup(mdp->d_path, (const char *)best, blen, NULL);
809 * If nothing found or hints is absent - fallback to the old way
810 * by using "kldname[.ko]" as module name.
812 if (!found && !bestver && result == NULL)
813 result = file_lookup(mdp->d_path, modname, modnamelen, kld_ext_list);
818 * Attempt to locate the file containing the module (name)
821 mod_searchmodule(char *name, struct mod_depend *verinfo)
823 struct moduledir *mdp;
828 * Now we ready to lookup module in the given directories
831 STAILQ_FOREACH(mdp, &moduledir_list, d_link) {
832 result = mod_search_hints(mdp, name, verinfo);
841 file_addmodule(struct preloaded_file *fp, char *modname, int version,
842 struct kernel_module **newmp)
844 struct kernel_module *mp;
845 struct mod_depend mdepend;
847 bzero(&mdepend, sizeof(mdepend));
848 mdepend.md_ver_preferred = version;
849 mp = file_findmodule(fp, modname, &mdepend);
852 mp = malloc(sizeof(struct kernel_module));
855 bzero(mp, sizeof(struct kernel_module));
856 mp->m_name = strdup(modname);
857 mp->m_version = version;
859 mp->m_next = fp->f_modules;
870 file_discard(struct preloaded_file *fp)
872 struct file_metadata *md, *md1;
873 struct kernel_module *mp, *mp1;
890 if (fp->f_name != NULL)
892 if (fp->f_type != NULL)
894 if (fp->f_args != NULL)
900 * Allocate a new file; must be used instead of malloc()
901 * to ensure safe initialisation.
903 struct preloaded_file *
906 struct preloaded_file *fp;
908 if ((fp = malloc(sizeof(struct preloaded_file))) != NULL) {
909 bzero(fp, sizeof(struct preloaded_file));
915 * Add a module to the chain
918 file_insert_tail(struct preloaded_file *fp)
920 struct preloaded_file *cm;
922 /* Append to list of loaded file */
924 if (preloaded_files == NULL) {
925 preloaded_files = fp;
927 for (cm = preloaded_files; cm->f_next != NULL; cm = cm->f_next)
934 moduledir_fullpath(struct moduledir *mdp, const char *fname)
938 cp = malloc(strlen(mdp->d_path) + strlen(fname) + 2);
941 strcpy(cp, mdp->d_path);
948 * Read linker.hints file into memory performing some sanity checks.
951 moduledir_readhints(struct moduledir *mdp)
955 int fd, size, version;
957 if (mdp->d_hints != NULL || (mdp->d_flags & MDIR_NOHINTS))
959 path = moduledir_fullpath(mdp, "linker.hints");
960 if (stat(path, &st) != 0 ||
961 st.st_size < (ssize_t)(sizeof(version) + sizeof(int)) ||
962 st.st_size > LINKER_HINTS_MAX || (fd = open(path, O_RDONLY)) < 0) {
964 mdp->d_flags |= MDIR_NOHINTS;
968 size = read(fd, &version, sizeof(version));
969 if (size != sizeof(version) || version != LINKER_HINTS_VERSION)
971 size = st.st_size - size;
972 mdp->d_hints = malloc(size);
973 if (mdp->d_hints == NULL)
975 if (read(fd, mdp->d_hints, size) != size)
977 mdp->d_hintsz = size;
986 mdp->d_flags |= MDIR_NOHINTS;
991 * Extract directories from the ';' separated list, remove duplicates.
994 moduledir_rebuild(void)
996 struct moduledir *mdp, *mtmp;
997 const char *path, *cp, *ep;
1000 path = getenv("module_path");
1002 path = default_searchpath;
1004 * Rebuild list of module directories if it changed
1006 STAILQ_FOREACH(mdp, &moduledir_list, d_link)
1007 mdp->d_flags |= MDIR_REMOVED;
1009 for (ep = path; *ep != 0; ep++) {
1011 for (; *ep != 0 && *ep != ';'; ep++)
1014 * Ignore trailing slashes
1016 for (cplen = ep - cp; cplen > 1 && cp[cplen - 1] == '/'; cplen--)
1018 STAILQ_FOREACH(mdp, &moduledir_list, d_link) {
1019 if (strlen(mdp->d_path) != cplen || bcmp(cp, mdp->d_path, cplen) != 0)
1021 mdp->d_flags &= ~MDIR_REMOVED;
1025 mdp = malloc(sizeof(*mdp) + cplen + 1);
1028 mdp->d_path = (char*)(mdp + 1);
1029 bcopy(cp, mdp->d_path, cplen);
1030 mdp->d_path[cplen] = 0;
1031 mdp->d_hints = NULL;
1033 STAILQ_INSERT_TAIL(&moduledir_list, mdp, d_link);
1039 * Delete unused directories if any
1041 mdp = STAILQ_FIRST(&moduledir_list);
1043 if ((mdp->d_flags & MDIR_REMOVED) == 0) {
1044 mdp = STAILQ_NEXT(mdp, d_link);
1049 mdp = STAILQ_NEXT(mdp, d_link);
1050 STAILQ_REMOVE(&moduledir_list, mtmp, moduledir, d_link);