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[])
106 int dofile, dokld, ch, error;
113 command_errmsg = "no filename specified";
116 while ((ch = getopt(argc, argv, "kt:")) != -1) {
127 /* getopt has already reported an error */
131 argv += (optind - 1);
132 argc -= (optind - 1);
135 * Request to load a raw file?
138 if ((argc != 2) || (typestr == NULL) || (*typestr == 0)) {
139 command_errmsg = "invalid load type";
142 return (file_loadraw(argv[1], typestr, 1) ? CMD_OK : CMD_ERROR);
145 * Do we have explicit KLD load ?
147 if (dokld || file_havepath(argv[1])) {
148 error = mod_loadkld(argv[1], argc - 2, argv + 2);
150 sprintf(command_errbuf, "warning: KLD '%s' already loaded", argv[1]);
151 return (error == 0 ? CMD_OK : CMD_ERROR);
154 * Looks like a request for a module.
156 error = mod_load(argv[1], NULL, argc - 2, argv + 2);
158 sprintf(command_errbuf, "warning: module '%s' already loaded", argv[1]);
159 return (error == 0 ? CMD_OK : CMD_ERROR);
162 COMMAND_SET(load_geli, "load_geli", "load a geli key", command_load_geli);
165 command_load_geli(int argc, char *argv[])
172 command_errmsg = "usage is [-n key#] <prov> <file>";
179 while ((ch = getopt(argc, argv, "n:")) != -1) {
182 num = strtol(optarg, &cp, 0);
184 sprintf(command_errbuf, "bad key index '%s'", optarg);
190 /* getopt has already reported an error */
194 argv += (optind - 1);
195 argc -= (optind - 1);
196 sprintf(typestr, "%s:geli_keyfile%d", argv[1], num);
197 return (file_loadraw(argv[2], typestr, 1) ? CMD_OK : CMD_ERROR);
203 struct preloaded_file *fp;
205 while (preloaded_files != NULL) {
206 fp = preloaded_files;
207 preloaded_files = preloaded_files->f_next;
211 unsetenv("kernelname");
214 COMMAND_SET(unload, "unload", "unload all modules", command_unload);
217 command_unload(int argc, char *argv[])
223 COMMAND_SET(lsmod, "lsmod", "list loaded modules", command_lsmod);
226 command_lsmod(int argc, char *argv[])
228 struct preloaded_file *fp;
229 struct kernel_module *mp;
230 struct file_metadata *md;
237 while ((ch = getopt(argc, argv, "v")) != -1) {
244 /* getopt has already reported an error */
250 for (fp = preloaded_files; fp; fp = fp->f_next) {
251 sprintf(lbuf, " %p: ", (void *) fp->f_addr);
253 pager_output(fp->f_name);
254 sprintf(lbuf, " (%s, 0x%lx)\n", fp->f_type, (long)fp->f_size);
256 if (fp->f_args != NULL) {
257 pager_output(" args: ");
258 pager_output(fp->f_args);
262 pager_output(" modules: ");
263 for (mp = fp->f_modules; mp; mp = mp->m_next) {
264 sprintf(lbuf, "%s.%d ", mp->m_name, mp->m_version);
270 /* XXX could add some formatting smarts here to display some better */
271 for (md = fp->f_metadata; md != NULL; md = md->md_next) {
272 sprintf(lbuf, " 0x%04x, 0x%lx\n", md->md_type, (long) md->md_size);
282 * File level interface, functions file_*
285 file_load(char *filename, vm_offset_t dest, struct preloaded_file **result)
287 static int last_file_format = 0;
288 struct preloaded_file *fp;
292 if (archsw.arch_loadaddr != NULL)
293 dest = archsw.arch_loadaddr(LOAD_RAW, filename, dest);
296 for (i = last_file_format, fp = NULL;
297 file_formats[i] && fp == NULL; i++) {
298 error = (file_formats[i]->l_load)(filename, dest, &fp);
300 fp->f_loader = last_file_format = i; /* remember the loader */
303 } else if (last_file_format == i && i != 0) {
304 /* Restart from the beginning */
306 last_file_format = 0;
311 continue; /* Unknown to this handler? */
313 sprintf(command_errbuf, "can't load file '%s': %s",
314 filename, strerror(error));
322 file_load_dependencies(struct preloaded_file *base_file)
324 struct file_metadata *md;
325 struct preloaded_file *fp;
326 struct mod_depend *verinfo;
327 struct kernel_module *mp;
331 md = file_findmetadata(base_file, MODINFOMD_DEPLIST);
336 verinfo = (struct mod_depend*)md->md_data;
337 dmodname = (char *)(verinfo + 1);
338 if (file_findmodule(NULL, dmodname, verinfo) == NULL) {
339 printf("loading required module '%s'\n", dmodname);
340 error = mod_load(dmodname, verinfo, 0, NULL);
344 * If module loaded via kld name which isn't listed
345 * in the linker.hints file, we should check if it have
348 mp = file_findmodule(NULL, dmodname, verinfo);
350 sprintf(command_errbuf, "module '%s' exists but with wrong version",
356 md = metadata_next(md, MODINFOMD_DEPLIST);
360 /* Load failed; discard everything */
361 while (base_file != NULL) {
363 base_file = base_file->f_next;
370 * We've been asked to load (name) as (type), so just suck it in,
371 * no arguments or anything.
373 struct preloaded_file *
374 file_loadraw(char *name, char *type, int insert)
376 struct preloaded_file *fp;
381 /* We can't load first */
382 if ((file_findfile(NULL, NULL)) == NULL) {
383 command_errmsg = "can't load file before kernel";
387 /* locate the file on the load path */
388 cp = file_search(name, NULL);
390 sprintf(command_errbuf, "can't find '%s'", name);
395 if ((fd = open(name, O_RDONLY)) < 0) {
396 sprintf(command_errbuf, "can't open '%s': %s", name, strerror(errno));
401 if (archsw.arch_loadaddr != NULL)
402 loadaddr = archsw.arch_loadaddr(LOAD_RAW, name, loadaddr);
408 /* read in 4k chunks; size is not really important */
409 got = archsw.arch_readin(fd, laddr, 4096);
410 if (got == 0) /* end of file */
412 if (got < 0) { /* error */
413 sprintf(command_errbuf, "error reading '%s': %s", name, strerror(errno));
421 printf("size=%#jx\n", (uintmax_t)(laddr - loadaddr));
423 /* Looks OK so far; create & populate control structure */
425 fp->f_name = strdup(name);
426 fp->f_type = strdup(type);
428 fp->f_metadata = NULL;
430 fp->f_addr = loadaddr;
431 fp->f_size = laddr - loadaddr;
433 /* recognise space consumption */
436 /* Add to the list of loaded files */
438 file_insert_tail(fp);
444 * Load the module (name), pass it (argc),(argv), add container file
445 * to the list of loaded files.
446 * If module is already loaded just assign new argc/argv.
449 mod_load(char *modname, struct mod_depend *verinfo, int argc, char *argv[])
451 struct kernel_module *mp;
455 if (file_havepath(modname)) {
456 printf("Warning: mod_load() called instead of mod_loadkld() for module '%s'\n", modname);
457 return (mod_loadkld(modname, argc, argv));
459 /* see if module is already loaded */
460 mp = file_findmodule(NULL, modname, verinfo);
465 mp->m_args = unargv(argc, argv);
467 sprintf(command_errbuf, "warning: module '%s' already loaded", mp->m_name);
470 /* locate file with the module on the search path */
471 filename = mod_searchmodule(modname, verinfo);
472 if (filename == NULL) {
473 sprintf(command_errbuf, "can't find '%s'", modname);
476 err = mod_loadkld(filename, argc, argv);
481 * Load specified KLD. If path is omitted, then try to locate it via
485 mod_loadkld(const char *kldname, int argc, char *argv[])
487 struct preloaded_file *fp, *last_file;
492 * Get fully qualified KLD name
494 filename = file_search(kldname, kld_ext_list);
495 if (filename == NULL) {
496 sprintf(command_errbuf, "can't find '%s'", kldname);
500 * Check if KLD already loaded
502 fp = file_findfile(filename, NULL);
504 sprintf(command_errbuf, "warning: KLD '%s' already loaded", filename);
508 for (last_file = preloaded_files;
509 last_file != NULL && last_file->f_next != NULL;
510 last_file = last_file->f_next)
514 err = file_load(filename, loadaddr, &fp);
517 fp->f_args = unargv(argc, argv);
518 loadaddr = fp->f_addr + fp->f_size;
519 file_insert_tail(fp); /* Add to the list of loaded files */
520 if (file_load_dependencies(fp) != 0) {
522 last_file->f_next = NULL;
523 loadaddr = last_file->f_addr + last_file->f_size;
529 sprintf(command_errbuf, "don't know how to load module '%s'", filename);
537 * Find a file matching (name) and (type).
538 * NULL may be passed as a wildcard to either.
540 struct preloaded_file *
541 file_findfile(const char *name, const char *type)
543 struct preloaded_file *fp;
545 for (fp = preloaded_files; fp != NULL; fp = fp->f_next) {
546 if (((name == NULL) || !strcmp(name, fp->f_name)) &&
547 ((type == NULL) || !strcmp(type, fp->f_type)))
554 * Find a module matching (name) inside of given file.
555 * NULL may be passed as a wildcard.
557 struct kernel_module *
558 file_findmodule(struct preloaded_file *fp, char *modname,
559 struct mod_depend *verinfo)
561 struct kernel_module *mp, *best;
565 for (fp = preloaded_files; fp; fp = fp->f_next) {
566 mp = file_findmodule(fp, modname, verinfo);
574 for (mp = fp->f_modules; mp; mp = mp->m_next) {
575 if (strcmp(modname, mp->m_name) == 0) {
578 mver = mp->m_version;
579 if (mver == verinfo->md_ver_preferred)
581 if (mver >= verinfo->md_ver_minimum &&
582 mver <= verinfo->md_ver_maximum &&
592 * Make a copy of (size) bytes of data from (p), and associate them as
593 * metadata of (type) to the module (mp).
596 file_addmetadata(struct preloaded_file *fp, int type, size_t size, void *p)
598 struct file_metadata *md;
600 md = malloc(sizeof(struct file_metadata) - sizeof(md->md_data) + size);
603 bcopy(p, md->md_data, size);
604 md->md_next = fp->f_metadata;
609 * Find a metadata object of (type) associated with the file (fp)
611 struct file_metadata *
612 file_findmetadata(struct preloaded_file *fp, int type)
614 struct file_metadata *md;
616 for (md = fp->f_metadata; md != NULL; md = md->md_next)
617 if (md->md_type == type)
622 struct file_metadata *
623 metadata_next(struct file_metadata *md, int type)
627 while((md = md->md_next) != NULL)
628 if (md->md_type == type)
633 static char *emptyextlist[] = { "", NULL };
636 * Check if the given file is in place and return full path to it.
639 file_lookup(const char *path, const char *name, int namelen, char **extlist)
642 char *result, *cp, **cpp;
643 int pathlen, extlen, len;
645 pathlen = strlen(path);
648 extlist = emptyextlist;
649 for (cpp = extlist; *cpp; cpp++) {
654 result = malloc(pathlen + namelen + extlen + 2);
657 bcopy(path, result, pathlen);
658 if (pathlen > 0 && result[pathlen - 1] != '/')
659 result[pathlen++] = '/';
660 cp = result + pathlen;
661 bcopy(name, cp, namelen);
663 for (cpp = extlist; *cpp; cpp++) {
665 if (stat(result, &st) == 0 && S_ISREG(st.st_mode))
673 * Check if file name have any qualifiers
676 file_havepath(const char *name)
680 archsw.arch_getdev(NULL, name, &cp);
681 return (cp != name || strchr(name, '/') != NULL);
685 * Attempt to find the file (name) on the module searchpath.
686 * If (name) is qualified in any way, we simply check it and
687 * return it or NULL. If it is not qualified, then we attempt
688 * to construct a path using entries in the environment variable
691 * The path we return a pointer to need never be freed, as we manage
695 file_search(const char *name, char **extlist)
697 struct moduledir *mdp;
702 /* Don't look for nothing */
707 return(strdup(name));
709 if (file_havepath(name)) {
710 /* Qualified, so just see if it exists */
711 if (stat(name, &sb) == 0)
712 return(strdup(name));
717 namelen = strlen(name);
718 STAILQ_FOREACH(mdp, &moduledir_list, d_link) {
719 result = file_lookup(mdp->d_path, name, namelen, extlist);
726 #define INT_ALIGN(base, ptr) ptr = \
727 (base) + (((ptr) - (base) + sizeof(int) - 1) & ~(sizeof(int) - 1))
730 mod_search_hints(struct moduledir *mdp, const char *modname,
731 struct mod_depend *verinfo)
733 u_char *cp, *recptr, *bufend, *best;
735 int *intp, bestver, blen, clen, found, ival, modnamelen, reclen;
737 moduledir_readhints(mdp);
738 modnamelen = strlen(modname);
742 if (mdp->d_hints == NULL)
744 recptr = mdp->d_hints;
745 bufend = recptr + mdp->d_hintsz;
748 while (recptr < bufend && !found) {
756 if (clen != modnamelen || bcmp(cp, modname, clen) != 0)
759 INT_ALIGN(mdp->d_hints, cp);
763 if (verinfo == NULL || ival == verinfo->md_ver_preferred) {
767 if (ival >= verinfo->md_ver_minimum &&
768 ival <= verinfo->md_ver_maximum &&
778 recptr += reclen + sizeof(int);
781 * Finally check if KLD is in the place
784 result = file_lookup(mdp->d_path, cp, clen, NULL);
786 result = file_lookup(mdp->d_path, best, blen, NULL);
789 * If nothing found or hints is absent - fallback to the old way
790 * by using "kldname[.ko]" as module name.
792 if (!found && !bestver && result == NULL)
793 result = file_lookup(mdp->d_path, modname, modnamelen, kld_ext_list);
798 * Attempt to locate the file containing the module (name)
801 mod_searchmodule(char *name, struct mod_depend *verinfo)
803 struct moduledir *mdp;
808 * Now we ready to lookup module in the given directories
811 STAILQ_FOREACH(mdp, &moduledir_list, d_link) {
812 result = mod_search_hints(mdp, name, verinfo);
821 file_addmodule(struct preloaded_file *fp, char *modname, int version,
822 struct kernel_module **newmp)
824 struct kernel_module *mp;
825 struct mod_depend mdepend;
827 bzero(&mdepend, sizeof(mdepend));
828 mdepend.md_ver_preferred = version;
829 mp = file_findmodule(fp, modname, &mdepend);
832 mp = malloc(sizeof(struct kernel_module));
835 bzero(mp, sizeof(struct kernel_module));
836 mp->m_name = strdup(modname);
837 mp->m_version = version;
839 mp->m_next = fp->f_modules;
850 file_discard(struct preloaded_file *fp)
852 struct file_metadata *md, *md1;
853 struct kernel_module *mp, *mp1;
870 if (fp->f_name != NULL)
872 if (fp->f_type != NULL)
874 if (fp->f_args != NULL)
880 * Allocate a new file; must be used instead of malloc()
881 * to ensure safe initialisation.
883 struct preloaded_file *
886 struct preloaded_file *fp;
888 if ((fp = malloc(sizeof(struct preloaded_file))) != NULL) {
889 bzero(fp, sizeof(struct preloaded_file));
895 * Add a module to the chain
898 file_insert_tail(struct preloaded_file *fp)
900 struct preloaded_file *cm;
902 /* Append to list of loaded file */
904 if (preloaded_files == NULL) {
905 preloaded_files = fp;
907 for (cm = preloaded_files; cm->f_next != NULL; cm = cm->f_next)
914 moduledir_fullpath(struct moduledir *mdp, const char *fname)
918 cp = malloc(strlen(mdp->d_path) + strlen(fname) + 2);
921 strcpy(cp, mdp->d_path);
928 * Read linker.hints file into memory performing some sanity checks.
931 moduledir_readhints(struct moduledir *mdp)
935 int fd, size, version;
937 if (mdp->d_hints != NULL || (mdp->d_flags & MDIR_NOHINTS))
939 path = moduledir_fullpath(mdp, "linker.hints");
940 if (stat(path, &st) != 0 ||
941 st.st_size < (ssize_t)(sizeof(version) + sizeof(int)) ||
942 st.st_size > LINKER_HINTS_MAX || (fd = open(path, O_RDONLY)) < 0) {
944 mdp->d_flags |= MDIR_NOHINTS;
948 size = read(fd, &version, sizeof(version));
949 if (size != sizeof(version) || version != LINKER_HINTS_VERSION)
951 size = st.st_size - size;
952 mdp->d_hints = malloc(size);
953 if (mdp->d_hints == NULL)
955 if (read(fd, mdp->d_hints, size) != size)
957 mdp->d_hintsz = size;
966 mdp->d_flags |= MDIR_NOHINTS;
971 * Extract directories from the ';' separated list, remove duplicates.
974 moduledir_rebuild(void)
976 struct moduledir *mdp, *mtmp;
977 const char *path, *cp, *ep;
980 path = getenv("module_path");
982 path = default_searchpath;
984 * Rebuild list of module directories if it changed
986 STAILQ_FOREACH(mdp, &moduledir_list, d_link)
987 mdp->d_flags |= MDIR_REMOVED;
989 for (ep = path; *ep != 0; ep++) {
991 for (; *ep != 0 && *ep != ';'; ep++)
994 * Ignore trailing slashes
996 for (cplen = ep - cp; cplen > 1 && cp[cplen - 1] == '/'; cplen--)
998 STAILQ_FOREACH(mdp, &moduledir_list, d_link) {
999 if (strlen(mdp->d_path) != cplen || bcmp(cp, mdp->d_path, cplen) != 0)
1001 mdp->d_flags &= ~MDIR_REMOVED;
1005 mdp = malloc(sizeof(*mdp) + cplen + 1);
1008 mdp->d_path = (char*)(mdp + 1);
1009 bcopy(cp, mdp->d_path, cplen);
1010 mdp->d_path[cplen] = 0;
1011 mdp->d_hints = NULL;
1013 STAILQ_INSERT_TAIL(&moduledir_list, mdp, d_link);
1019 * Delete unused directories if any
1021 mdp = STAILQ_FIRST(&moduledir_list);
1023 if ((mdp->d_flags & MDIR_REMOVED) == 0) {
1024 mdp = STAILQ_NEXT(mdp, d_link);
1029 mdp = STAILQ_NEXT(mdp, d_link);
1030 STAILQ_REMOVE(&moduledir_list, mtmp, moduledir, d_link);