xref: /freebsd/stand/common/module.c (revision ed792026824c3031c161dba9df0e4acd4a2f202d)
1ca987d46SWarner Losh /*-
2ca987d46SWarner Losh  * Copyright (c) 1998 Michael Smith <msmith@freebsd.org>
3ca987d46SWarner Losh  * All rights reserved.
4ca987d46SWarner Losh  *
5ca987d46SWarner Losh  * Redistribution and use in source and binary forms, with or without
6ca987d46SWarner Losh  * modification, are permitted provided that the following conditions
7ca987d46SWarner Losh  * are met:
8ca987d46SWarner Losh  * 1. Redistributions of source code must retain the above copyright
9ca987d46SWarner Losh  *    notice, this list of conditions and the following disclaimer.
10ca987d46SWarner Losh  * 2. Redistributions in binary form must reproduce the above copyright
11ca987d46SWarner Losh  *    notice, this list of conditions and the following disclaimer in the
12ca987d46SWarner Losh  *    documentation and/or other materials provided with the distribution.
13ca987d46SWarner Losh  *
14ca987d46SWarner Losh  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15ca987d46SWarner Losh  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16ca987d46SWarner Losh  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17ca987d46SWarner Losh  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18ca987d46SWarner Losh  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19ca987d46SWarner Losh  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20ca987d46SWarner Losh  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21ca987d46SWarner Losh  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22ca987d46SWarner Losh  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23ca987d46SWarner Losh  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24ca987d46SWarner Losh  * SUCH DAMAGE.
25ca987d46SWarner Losh  */
26ca987d46SWarner Losh 
27ca987d46SWarner Losh #include <sys/cdefs.h>
28ca987d46SWarner Losh __FBSDID("$FreeBSD$");
29ca987d46SWarner Losh 
30ca987d46SWarner Losh /*
31ca987d46SWarner Losh  * file/module function dispatcher, support, etc.
32ca987d46SWarner Losh  */
33ca987d46SWarner Losh 
34ca987d46SWarner Losh #include <stand.h>
35ca987d46SWarner Losh #include <string.h>
36ca987d46SWarner Losh #include <sys/param.h>
37ca987d46SWarner Losh #include <sys/linker.h>
38ca987d46SWarner Losh #include <sys/module.h>
39ca987d46SWarner Losh #include <sys/queue.h>
40ca987d46SWarner Losh #include <sys/stdint.h>
41ca987d46SWarner Losh 
42ca987d46SWarner Losh #include "bootstrap.h"
43ca987d46SWarner Losh 
44ca987d46SWarner Losh #define	MDIR_REMOVED	0x0001
45ca987d46SWarner Losh #define	MDIR_NOHINTS	0x0002
46ca987d46SWarner Losh 
47ca987d46SWarner Losh struct moduledir {
48ca987d46SWarner Losh 	char	*d_path;	/* path of modules directory */
49ca987d46SWarner Losh 	u_char	*d_hints;	/* content of linker.hints file */
50ca987d46SWarner Losh 	int	d_hintsz;	/* size of hints data */
51ca987d46SWarner Losh 	int	d_flags;
52ca987d46SWarner Losh 	STAILQ_ENTRY(moduledir) d_link;
53ca987d46SWarner Losh };
54ca987d46SWarner Losh 
55*ed792026SToomas Soome static int file_load(char *, vm_offset_t, struct preloaded_file **);
56*ed792026SToomas Soome static int file_load_dependencies(struct preloaded_file *);
57*ed792026SToomas Soome static char * file_search(const char *, char **);
58*ed792026SToomas Soome static struct kernel_module *file_findmodule(struct preloaded_file *, char *,
59*ed792026SToomas Soome     struct mod_depend *);
60*ed792026SToomas Soome static int file_havepath(const char *);
61*ed792026SToomas Soome static char *mod_searchmodule(char *, struct mod_depend *);
62*ed792026SToomas Soome static void file_insert_tail(struct preloaded_file *);
63*ed792026SToomas Soome static void file_remove(struct preloaded_file *);
64*ed792026SToomas Soome struct file_metadata *metadata_next(struct file_metadata *, int);
65*ed792026SToomas Soome static void moduledir_readhints(struct moduledir *);
66ca987d46SWarner Losh static void moduledir_rebuild(void);
67ca987d46SWarner Losh 
68ca987d46SWarner Losh /* load address should be tweaked by first module loaded (kernel) */
69ca987d46SWarner Losh static vm_offset_t	loadaddr = 0;
70ca987d46SWarner Losh 
71ca987d46SWarner Losh #if defined(LOADER_FDT_SUPPORT)
72ca987d46SWarner Losh static const char	*default_searchpath =
73ca987d46SWarner Losh     "/boot/kernel;/boot/modules;/boot/dtb";
74ca987d46SWarner Losh #else
75ca987d46SWarner Losh static const char	*default_searchpath = "/boot/kernel;/boot/modules";
76ca987d46SWarner Losh #endif
77ca987d46SWarner Losh 
78*ed792026SToomas Soome static STAILQ_HEAD(, moduledir) moduledir_list =
79*ed792026SToomas Soome     STAILQ_HEAD_INITIALIZER(moduledir_list);
80ca987d46SWarner Losh 
81ca987d46SWarner Losh struct preloaded_file *preloaded_files = NULL;
82ca987d46SWarner Losh 
83ca987d46SWarner Losh static char *kld_ext_list[] = {
84ca987d46SWarner Losh     ".ko",
85ca987d46SWarner Losh     "",
86ca987d46SWarner Losh     ".debug",
87ca987d46SWarner Losh     NULL
88ca987d46SWarner Losh };
89ca987d46SWarner Losh 
90ca987d46SWarner Losh 
91ca987d46SWarner Losh /*
92ca987d46SWarner Losh  * load an object, either a disk file or code module.
93ca987d46SWarner Losh  *
94ca987d46SWarner Losh  * To load a file, the syntax is:
95ca987d46SWarner Losh  *
96ca987d46SWarner Losh  * load -t <type> <path>
97ca987d46SWarner Losh  *
98ca987d46SWarner Losh  * code modules are loaded as:
99ca987d46SWarner Losh  *
100ca987d46SWarner Losh  * load <path> <options>
101ca987d46SWarner Losh  */
102ca987d46SWarner Losh 
103ca987d46SWarner Losh COMMAND_SET(load, "load", "load a kernel or module", command_load);
104ca987d46SWarner Losh 
105ca987d46SWarner Losh static int
106ca987d46SWarner Losh command_load(int argc, char *argv[])
107ca987d46SWarner Losh {
108ca987d46SWarner Losh 	struct preloaded_file *fp;
109ca987d46SWarner Losh 	char	*typestr;
1108df8b2d3SSimon J. Gerraty 	char	*prefix;
1118df8b2d3SSimon J. Gerraty 	char	*skip;
112fd1d7567SSimon J. Gerraty 	int		dflag, dofile, dokld, ch, error;
113ca987d46SWarner Losh 
114fd1d7567SSimon J. Gerraty 	dflag = dokld = dofile = 0;
115ca987d46SWarner Losh 	optind = 1;
116ca987d46SWarner Losh 	optreset = 1;
117ca987d46SWarner Losh 	typestr = NULL;
118ca987d46SWarner Losh 	if (argc == 1) {
119ca987d46SWarner Losh 		command_errmsg = "no filename specified";
120ca987d46SWarner Losh 		return (CMD_CRIT);
121ca987d46SWarner Losh 	}
1228df8b2d3SSimon J. Gerraty 	prefix = skip = NULL;
123fd1d7567SSimon J. Gerraty 	while ((ch = getopt(argc, argv, "dkp:s:t:")) != -1) {
124ca987d46SWarner Losh 		switch(ch) {
125fd1d7567SSimon J. Gerraty 		case 'd':
126fd1d7567SSimon J. Gerraty 			dflag++;
127fd1d7567SSimon J. Gerraty 			break;
128ca987d46SWarner Losh 		case 'k':
129ca987d46SWarner Losh 			dokld = 1;
130ca987d46SWarner Losh 			break;
1318df8b2d3SSimon J. Gerraty 		case 'p':
1328df8b2d3SSimon J. Gerraty 			prefix = optarg;
1338df8b2d3SSimon J. Gerraty 			break;
1348df8b2d3SSimon J. Gerraty 		case 's':
1358df8b2d3SSimon J. Gerraty 			skip = optarg;
1368df8b2d3SSimon J. Gerraty 			break;
137ca987d46SWarner Losh 		case 't':
138ca987d46SWarner Losh 			typestr = optarg;
139ca987d46SWarner Losh 			dofile = 1;
140ca987d46SWarner Losh 			break;
141ca987d46SWarner Losh 		case '?':
142ca987d46SWarner Losh 		default:
143ca987d46SWarner Losh 			/* getopt has already reported an error */
144ca987d46SWarner Losh 			return (CMD_OK);
145ca987d46SWarner Losh 		}
146ca987d46SWarner Losh 	}
147ca987d46SWarner Losh 	argv += (optind - 1);
148ca987d46SWarner Losh 	argc -= (optind - 1);
149ca987d46SWarner Losh 
150ca987d46SWarner Losh 	/*
151ca987d46SWarner Losh 	 * Request to load a raw file?
152ca987d46SWarner Losh 	 */
153ca987d46SWarner Losh 	if (dofile) {
154ca987d46SWarner Losh 		if ((argc != 2) || (typestr == NULL) || (*typestr == 0)) {
155ca987d46SWarner Losh 			command_errmsg = "invalid load type";
156ca987d46SWarner Losh 			return (CMD_CRIT);
157ca987d46SWarner Losh 		}
158ca987d46SWarner Losh 
1598df8b2d3SSimon J. Gerraty #ifdef LOADER_VERIEXEC
1608df8b2d3SSimon J. Gerraty 		if (strncmp(typestr, "manifest", 8) == 0) {
161fd1d7567SSimon J. Gerraty 			if (dflag > 0)
162fd1d7567SSimon J. Gerraty 				ve_debug_set(dflag);
1638df8b2d3SSimon J. Gerraty 			return (load_manifest(argv[1], prefix, skip, NULL));
1648df8b2d3SSimon J. Gerraty 		}
165b0fefb25SMarcin Wojtas #ifdef LOADER_VERIEXEC_PASS_MANIFEST
166b0fefb25SMarcin Wojtas 		if (strncmp(typestr, "pass_manifest", 13) == 0) {
167b0fefb25SMarcin Wojtas 			if (dflag > 0)
168b0fefb25SMarcin Wojtas 				ve_debug_set(dflag);
169b0fefb25SMarcin Wojtas 		    return (pass_manifest(argv[1], prefix));
170b0fefb25SMarcin Wojtas 		}
171b0fefb25SMarcin Wojtas #endif
1728df8b2d3SSimon J. Gerraty #endif
1738df8b2d3SSimon J. Gerraty 
174ca987d46SWarner Losh 		fp = file_findfile(argv[1], typestr);
175ca987d46SWarner Losh 		if (fp) {
176ca987d46SWarner Losh 			snprintf(command_errbuf, sizeof(command_errbuf),
177ca987d46SWarner Losh 			  "warning: file '%s' already loaded", argv[1]);
178ca987d46SWarner Losh 			return (CMD_WARN);
179ca987d46SWarner Losh 		}
180ca987d46SWarner Losh 
181ca987d46SWarner Losh 		if (file_loadraw(argv[1], typestr, 1) != NULL)
182ca987d46SWarner Losh 			return (CMD_OK);
183ca987d46SWarner Losh 
184ca987d46SWarner Losh 		/* Failing to load mfs_root is never going to end well! */
185ca987d46SWarner Losh 		if (strcmp("mfs_root", typestr) == 0)
186ca987d46SWarner Losh 			return (CMD_FATAL);
187ca987d46SWarner Losh 
188ca987d46SWarner Losh 		return (CMD_ERROR);
189ca987d46SWarner Losh 	}
190ca987d46SWarner Losh 	/*
191ca987d46SWarner Losh 	 * Do we have explicit KLD load ?
192ca987d46SWarner Losh 	 */
193ca987d46SWarner Losh 	if (dokld || file_havepath(argv[1])) {
194ca987d46SWarner Losh 		error = mod_loadkld(argv[1], argc - 2, argv + 2);
195ca987d46SWarner Losh 		if (error == EEXIST) {
196ca987d46SWarner Losh 			snprintf(command_errbuf, sizeof(command_errbuf),
197ca987d46SWarner Losh 			  "warning: KLD '%s' already loaded", argv[1]);
198ca987d46SWarner Losh 			return (CMD_WARN);
199ca987d46SWarner Losh 		}
200ca987d46SWarner Losh 
201ca987d46SWarner Losh 		return (error == 0 ? CMD_OK : CMD_CRIT);
202ca987d46SWarner Losh 	}
203ca987d46SWarner Losh 	/*
204ca987d46SWarner Losh 	 * Looks like a request for a module.
205ca987d46SWarner Losh 	 */
206ca987d46SWarner Losh 	error = mod_load(argv[1], NULL, argc - 2, argv + 2);
207ca987d46SWarner Losh 	if (error == EEXIST) {
208ca987d46SWarner Losh 		snprintf(command_errbuf, sizeof(command_errbuf),
209ca987d46SWarner Losh 		  "warning: module '%s' already loaded", argv[1]);
210ca987d46SWarner Losh 		return (CMD_WARN);
211ca987d46SWarner Losh 	}
212ca987d46SWarner Losh 
213ca987d46SWarner Losh 	return (error == 0 ? CMD_OK : CMD_CRIT);
214ca987d46SWarner Losh }
215ca987d46SWarner Losh 
216ca987d46SWarner Losh #ifdef LOADER_GELI_SUPPORT
217ca987d46SWarner Losh COMMAND_SET(load_geli, "load_geli", "load a geli key", command_load_geli);
218ca987d46SWarner Losh 
219ca987d46SWarner Losh static int
220ca987d46SWarner Losh command_load_geli(int argc, char *argv[])
221ca987d46SWarner Losh {
222ca987d46SWarner Losh 	char	typestr[80];
223ca987d46SWarner Losh 	char	*cp;
224ca987d46SWarner Losh 	int		ch, num;
225ca987d46SWarner Losh 
226ca987d46SWarner Losh 	if (argc < 3) {
227ca987d46SWarner Losh 		command_errmsg = "usage is [-n key#] <prov> <file>";
228ca987d46SWarner Losh 		return(CMD_ERROR);
229ca987d46SWarner Losh 	}
230ca987d46SWarner Losh 
231ca987d46SWarner Losh 	num = 0;
232ca987d46SWarner Losh 	optind = 1;
233ca987d46SWarner Losh 	optreset = 1;
234ca987d46SWarner Losh 	while ((ch = getopt(argc, argv, "n:")) != -1) {
235ca987d46SWarner Losh 		switch(ch) {
236ca987d46SWarner Losh 		case 'n':
237ca987d46SWarner Losh 			num = strtol(optarg, &cp, 0);
238ca987d46SWarner Losh 			if (cp == optarg) {
239ca987d46SWarner Losh 				snprintf(command_errbuf, sizeof(command_errbuf),
240ca987d46SWarner Losh 				  "bad key index '%s'", optarg);
241ca987d46SWarner Losh 				return(CMD_ERROR);
242ca987d46SWarner Losh 			}
243ca987d46SWarner Losh 			break;
244ca987d46SWarner Losh 		case '?':
245ca987d46SWarner Losh 		default:
246ca987d46SWarner Losh 			/* getopt has already reported an error */
247ca987d46SWarner Losh 			return(CMD_OK);
248ca987d46SWarner Losh 		}
249ca987d46SWarner Losh 	}
250ca987d46SWarner Losh 	argv += (optind - 1);
251ca987d46SWarner Losh 	argc -= (optind - 1);
252ca987d46SWarner Losh 	sprintf(typestr, "%s:geli_keyfile%d", argv[1], num);
253ca987d46SWarner Losh 	return (file_loadraw(argv[2], typestr, 1) ? CMD_OK : CMD_ERROR);
254ca987d46SWarner Losh }
255ca987d46SWarner Losh #endif
256ca987d46SWarner Losh 
257ca987d46SWarner Losh void
258ca987d46SWarner Losh unload(void)
259ca987d46SWarner Losh {
260ca987d46SWarner Losh 	struct preloaded_file *fp;
261ca987d46SWarner Losh 
262ca987d46SWarner Losh 	while (preloaded_files != NULL) {
263ca987d46SWarner Losh 		fp = preloaded_files;
264ca987d46SWarner Losh 		preloaded_files = preloaded_files->f_next;
265ca987d46SWarner Losh 		file_discard(fp);
266ca987d46SWarner Losh 	}
267ca987d46SWarner Losh 	loadaddr = 0;
268ca987d46SWarner Losh 	unsetenv("kernelname");
269ca987d46SWarner Losh }
270ca987d46SWarner Losh 
271ca987d46SWarner Losh COMMAND_SET(unload, "unload", "unload all modules", command_unload);
272ca987d46SWarner Losh 
273ca987d46SWarner Losh static int
274ca987d46SWarner Losh command_unload(int argc, char *argv[])
275ca987d46SWarner Losh {
276ca987d46SWarner Losh 	unload();
277ca987d46SWarner Losh 	return(CMD_OK);
278ca987d46SWarner Losh }
279ca987d46SWarner Losh 
280ca987d46SWarner Losh COMMAND_SET(lsmod, "lsmod", "list loaded modules", command_lsmod);
281ca987d46SWarner Losh 
282ca987d46SWarner Losh static int
283ca987d46SWarner Losh command_lsmod(int argc, char *argv[])
284ca987d46SWarner Losh {
285ca987d46SWarner Losh 	struct preloaded_file	*fp;
286ca987d46SWarner Losh 	struct kernel_module	*mp;
287ca987d46SWarner Losh 	struct file_metadata	*md;
288ca987d46SWarner Losh 	char			lbuf[80];
289ca987d46SWarner Losh 	int				ch, verbose, ret = 0;
290ca987d46SWarner Losh 
291ca987d46SWarner Losh 	verbose = 0;
292ca987d46SWarner Losh 	optind = 1;
293ca987d46SWarner Losh 	optreset = 1;
294ca987d46SWarner Losh 	while ((ch = getopt(argc, argv, "v")) != -1) {
295ca987d46SWarner Losh 		switch(ch) {
296ca987d46SWarner Losh 		case 'v':
297ca987d46SWarner Losh 			verbose = 1;
298ca987d46SWarner Losh 			break;
299ca987d46SWarner Losh 		case '?':
300ca987d46SWarner Losh 		default:
301ca987d46SWarner Losh 			/* getopt has already reported an error */
302ca987d46SWarner Losh 			return(CMD_OK);
303ca987d46SWarner Losh 		}
304ca987d46SWarner Losh 	}
305ca987d46SWarner Losh 
306ca987d46SWarner Losh 	pager_open();
307ca987d46SWarner Losh 	for (fp = preloaded_files; fp; fp = fp->f_next) {
308ca987d46SWarner Losh 		snprintf(lbuf, sizeof(lbuf), " %p: ", (void *) fp->f_addr);
309ca987d46SWarner Losh 		pager_output(lbuf);
310ca987d46SWarner Losh 		pager_output(fp->f_name);
311ca987d46SWarner Losh 		snprintf(lbuf, sizeof(lbuf), " (%s, 0x%lx)\n", fp->f_type,
312ca987d46SWarner Losh 		  (long)fp->f_size);
313ca987d46SWarner Losh 		if (pager_output(lbuf))
314ca987d46SWarner Losh 			break;
315ca987d46SWarner Losh 		if (fp->f_args != NULL) {
316ca987d46SWarner Losh 			pager_output("    args: ");
317ca987d46SWarner Losh 			pager_output(fp->f_args);
318ca987d46SWarner Losh 			if (pager_output("\n"))
319ca987d46SWarner Losh 				break;
320ca987d46SWarner Losh 		}
321ca987d46SWarner Losh 		if (fp->f_modules) {
322ca987d46SWarner Losh 			pager_output("  modules: ");
323ca987d46SWarner Losh 			for (mp = fp->f_modules; mp; mp = mp->m_next) {
324ca987d46SWarner Losh 				snprintf(lbuf, sizeof(lbuf), "%s.%d ", mp->m_name,
325ca987d46SWarner Losh 				  mp->m_version);
326ca987d46SWarner Losh 				pager_output(lbuf);
327ca987d46SWarner Losh 			}
328ca987d46SWarner Losh 			if (pager_output("\n"))
329ca987d46SWarner Losh 				break;
330ca987d46SWarner Losh 		}
331ca987d46SWarner Losh 		if (verbose) {
332ca987d46SWarner Losh 			/* XXX could add some formatting smarts here to display some better */
333ca987d46SWarner Losh 			for (md = fp->f_metadata; md != NULL; md = md->md_next) {
334ca987d46SWarner Losh 				snprintf(lbuf, sizeof(lbuf), "      0x%04x, 0x%lx\n",
335ca987d46SWarner Losh 				  md->md_type, (long) md->md_size);
336ca987d46SWarner Losh 				if (pager_output(lbuf))
337ca987d46SWarner Losh 					break;
338ca987d46SWarner Losh 			}
339ca987d46SWarner Losh 		}
340ca987d46SWarner Losh 		if (ret)
341ca987d46SWarner Losh 			break;
342ca987d46SWarner Losh 	}
343ca987d46SWarner Losh 	pager_close();
344ca987d46SWarner Losh 	return(CMD_OK);
345ca987d46SWarner Losh }
346ca987d46SWarner Losh 
347ca987d46SWarner Losh /*
348ca987d46SWarner Losh  * File level interface, functions file_*
349ca987d46SWarner Losh  */
350ca987d46SWarner Losh int
351ca987d46SWarner Losh file_load(char *filename, vm_offset_t dest, struct preloaded_file **result)
352ca987d46SWarner Losh {
353ca987d46SWarner Losh 	static int last_file_format = 0;
354ca987d46SWarner Losh 	struct preloaded_file *fp;
355ca987d46SWarner Losh 	int error;
356ca987d46SWarner Losh 	int i;
357ca987d46SWarner Losh 
358ca987d46SWarner Losh 	if (archsw.arch_loadaddr != NULL)
359ca987d46SWarner Losh 		dest = archsw.arch_loadaddr(LOAD_RAW, filename, dest);
360ca987d46SWarner Losh 
361ca987d46SWarner Losh 	error = EFTYPE;
362ca987d46SWarner Losh 	for (i = last_file_format, fp = NULL;
363ca987d46SWarner Losh 	     file_formats[i] && fp == NULL; i++) {
364ca987d46SWarner Losh 		error = (file_formats[i]->l_load)(filename, dest, &fp);
365ca987d46SWarner Losh 		if (error == 0) {
366ca987d46SWarner Losh 			fp->f_loader = last_file_format = i; /* remember the loader */
367ca987d46SWarner Losh 			*result = fp;
368ca987d46SWarner Losh 			break;
369ca987d46SWarner Losh 		} else if (last_file_format == i && i != 0) {
370ca987d46SWarner Losh 			/* Restart from the beginning */
371ca987d46SWarner Losh 			i = -1;
372ca987d46SWarner Losh 			last_file_format = 0;
373ca987d46SWarner Losh 			fp = NULL;
374ca987d46SWarner Losh 			continue;
375ca987d46SWarner Losh 		}
376ca987d46SWarner Losh 		if (error == EFTYPE)
377ca987d46SWarner Losh 			continue;		/* Unknown to this handler? */
378ca987d46SWarner Losh 		if (error) {
379ca987d46SWarner Losh 			snprintf(command_errbuf, sizeof(command_errbuf),
380ca987d46SWarner Losh 			  "can't load file '%s': %s", filename, strerror(error));
381ca987d46SWarner Losh 			break;
382ca987d46SWarner Losh 		}
383ca987d46SWarner Losh 	}
384ca987d46SWarner Losh 	return (error);
385ca987d46SWarner Losh }
386ca987d46SWarner Losh 
387ca987d46SWarner Losh static int
388ca987d46SWarner Losh file_load_dependencies(struct preloaded_file *base_file)
389ca987d46SWarner Losh {
390ca987d46SWarner Losh 	struct file_metadata *md;
391ca987d46SWarner Losh 	struct preloaded_file *fp;
392ca987d46SWarner Losh 	struct mod_depend *verinfo;
393ca987d46SWarner Losh 	struct kernel_module *mp;
394ca987d46SWarner Losh 	char *dmodname;
395ca987d46SWarner Losh 	int error;
396ca987d46SWarner Losh 
397ca987d46SWarner Losh 	md = file_findmetadata(base_file, MODINFOMD_DEPLIST);
398ca987d46SWarner Losh 	if (md == NULL)
399ca987d46SWarner Losh 		return (0);
400ca987d46SWarner Losh 	error = 0;
401ca987d46SWarner Losh 	do {
402ca987d46SWarner Losh 		verinfo = (struct mod_depend*)md->md_data;
403ca987d46SWarner Losh 		dmodname = (char *)(verinfo + 1);
404ca987d46SWarner Losh 		if (file_findmodule(NULL, dmodname, verinfo) == NULL) {
405ca987d46SWarner Losh 			printf("loading required module '%s'\n", dmodname);
406ca987d46SWarner Losh 			error = mod_load(dmodname, verinfo, 0, NULL);
407ca987d46SWarner Losh 			if (error)
408ca987d46SWarner Losh 				break;
409ca987d46SWarner Losh 			/*
410ca987d46SWarner Losh 			 * If module loaded via kld name which isn't listed
411ca987d46SWarner Losh 			 * in the linker.hints file, we should check if it have
412ca987d46SWarner Losh 			 * required version.
413ca987d46SWarner Losh 			 */
414ca987d46SWarner Losh 			mp = file_findmodule(NULL, dmodname, verinfo);
415ca987d46SWarner Losh 			if (mp == NULL) {
416ca987d46SWarner Losh 				snprintf(command_errbuf, sizeof(command_errbuf),
417ca987d46SWarner Losh 				  "module '%s' exists but with wrong version", dmodname);
418ca987d46SWarner Losh 				error = ENOENT;
419ca987d46SWarner Losh 				break;
420ca987d46SWarner Losh 			}
421ca987d46SWarner Losh 		}
422ca987d46SWarner Losh 		md = metadata_next(md, MODINFOMD_DEPLIST);
423ca987d46SWarner Losh 	} while (md);
424ca987d46SWarner Losh 	if (!error)
425ca987d46SWarner Losh 		return (0);
426ca987d46SWarner Losh 	/* Load failed; discard everything */
427ca987d46SWarner Losh 	while (base_file != NULL) {
428ca987d46SWarner Losh 		fp = base_file;
429ca987d46SWarner Losh 		base_file = base_file->f_next;
430ca987d46SWarner Losh 		file_discard(fp);
431ca987d46SWarner Losh 	}
432ca987d46SWarner Losh 	return (error);
433ca987d46SWarner Losh }
434ca987d46SWarner Losh 
435ca987d46SWarner Losh /*
436ca987d46SWarner Losh  * We've been asked to load (fname) as (type), so just suck it in,
437ca987d46SWarner Losh  * no arguments or anything.
438ca987d46SWarner Losh  */
439ca987d46SWarner Losh struct preloaded_file *
440ca987d46SWarner Losh file_loadraw(const char *fname, char *type, int insert)
441ca987d46SWarner Losh {
442ca987d46SWarner Losh 	struct preloaded_file	*fp;
443ca987d46SWarner Losh 	char			*name;
444ca987d46SWarner Losh 	int				fd, got;
445ca987d46SWarner Losh 	vm_offset_t			laddr;
446ca987d46SWarner Losh 
447ca987d46SWarner Losh 	/* We can't load first */
448ca987d46SWarner Losh 	if ((file_findfile(NULL, NULL)) == NULL) {
449ca987d46SWarner Losh 		command_errmsg = "can't load file before kernel";
450ca987d46SWarner Losh 		return(NULL);
451ca987d46SWarner Losh 	}
452ca987d46SWarner Losh 
453ca987d46SWarner Losh 	/* locate the file on the load path */
454ca987d46SWarner Losh 	name = file_search(fname, NULL);
455ca987d46SWarner Losh 	if (name == NULL) {
456ca987d46SWarner Losh 		snprintf(command_errbuf, sizeof(command_errbuf),
457ca987d46SWarner Losh 		  "can't find '%s'", fname);
458ca987d46SWarner Losh 		return(NULL);
459ca987d46SWarner Losh 	}
460ca987d46SWarner Losh 
461ca987d46SWarner Losh 	if ((fd = open(name, O_RDONLY)) < 0) {
462ca987d46SWarner Losh 		snprintf(command_errbuf, sizeof(command_errbuf),
463ca987d46SWarner Losh 		  "can't open '%s': %s", name, strerror(errno));
464ca987d46SWarner Losh 		free(name);
465ca987d46SWarner Losh 		return(NULL);
466ca987d46SWarner Losh 	}
467ca987d46SWarner Losh 
4688df8b2d3SSimon J. Gerraty #ifdef LOADER_VERIEXEC
4698df8b2d3SSimon J. Gerraty 	if (verify_file(fd, name, 0, VE_MUST) < 0) {
4708df8b2d3SSimon J. Gerraty 		sprintf(command_errbuf, "can't verify '%s'", name);
4718df8b2d3SSimon J. Gerraty 		free(name);
4728df8b2d3SSimon J. Gerraty 		close(fd);
4738df8b2d3SSimon J. Gerraty 		return(NULL);
4748df8b2d3SSimon J. Gerraty 	}
4758df8b2d3SSimon J. Gerraty #endif
4768df8b2d3SSimon J. Gerraty 
477ca987d46SWarner Losh 	if (archsw.arch_loadaddr != NULL)
478ca987d46SWarner Losh 		loadaddr = archsw.arch_loadaddr(LOAD_RAW, name, loadaddr);
479ca987d46SWarner Losh 
480ca987d46SWarner Losh 	printf("%s ", name);
481ca987d46SWarner Losh 
482ca987d46SWarner Losh 	laddr = loadaddr;
483ca987d46SWarner Losh 	for (;;) {
484ca987d46SWarner Losh 		/* read in 4k chunks; size is not really important */
485ca987d46SWarner Losh 		got = archsw.arch_readin(fd, laddr, 4096);
486ca987d46SWarner Losh 		if (got == 0)				/* end of file */
487ca987d46SWarner Losh 			break;
488ca987d46SWarner Losh 		if (got < 0) {				/* error */
489ca987d46SWarner Losh 			snprintf(command_errbuf, sizeof(command_errbuf),
490ca987d46SWarner Losh 			  "error reading '%s': %s", name, strerror(errno));
491ca987d46SWarner Losh 			free(name);
492ca987d46SWarner Losh 			close(fd);
493ca987d46SWarner Losh 			return(NULL);
494ca987d46SWarner Losh 		}
495ca987d46SWarner Losh 		laddr += got;
496ca987d46SWarner Losh 	}
497ca987d46SWarner Losh 
498ca987d46SWarner Losh 	printf("size=%#jx\n", (uintmax_t)(laddr - loadaddr));
499ca987d46SWarner Losh 
500ca987d46SWarner Losh 	/* Looks OK so far; create & populate control structure */
501ca987d46SWarner Losh 	fp = file_alloc();
502ca987d46SWarner Losh 	fp->f_name = strdup(name);
503ca987d46SWarner Losh 	fp->f_type = strdup(type);
504ca987d46SWarner Losh 	fp->f_args = NULL;
505ca987d46SWarner Losh 	fp->f_metadata = NULL;
506ca987d46SWarner Losh 	fp->f_loader = -1;
507ca987d46SWarner Losh 	fp->f_addr = loadaddr;
508ca987d46SWarner Losh 	fp->f_size = laddr - loadaddr;
509ca987d46SWarner Losh 
510ca987d46SWarner Losh 	/* recognise space consumption */
511ca987d46SWarner Losh 	loadaddr = laddr;
512ca987d46SWarner Losh 
513ca987d46SWarner Losh 	/* Add to the list of loaded files */
514ca987d46SWarner Losh 	if (insert != 0)
515ca987d46SWarner Losh 		file_insert_tail(fp);
516ca987d46SWarner Losh 	close(fd);
517ca987d46SWarner Losh 	return(fp);
518ca987d46SWarner Losh }
519ca987d46SWarner Losh 
520ca987d46SWarner Losh /*
521ca987d46SWarner Losh  * Load the module (name), pass it (argc),(argv), add container file
522ca987d46SWarner Losh  * to the list of loaded files.
523ca987d46SWarner Losh  * If module is already loaded just assign new argc/argv.
524ca987d46SWarner Losh  */
525ca987d46SWarner Losh int
526ca987d46SWarner Losh mod_load(char *modname, struct mod_depend *verinfo, int argc, char *argv[])
527ca987d46SWarner Losh {
528ca987d46SWarner Losh 	struct kernel_module	*mp;
529ca987d46SWarner Losh 	int				err;
530ca987d46SWarner Losh 	char			*filename;
531ca987d46SWarner Losh 
532ca987d46SWarner Losh 	if (file_havepath(modname)) {
533ca987d46SWarner Losh 		printf("Warning: mod_load() called instead of mod_loadkld() for module '%s'\n", modname);
534ca987d46SWarner Losh 		return (mod_loadkld(modname, argc, argv));
535ca987d46SWarner Losh 	}
536ca987d46SWarner Losh 	/* see if module is already loaded */
537ca987d46SWarner Losh 	mp = file_findmodule(NULL, modname, verinfo);
538ca987d46SWarner Losh 	if (mp) {
539ca987d46SWarner Losh #ifdef moduleargs
540ca987d46SWarner Losh 		free(mp->m_args);
541ca987d46SWarner Losh 		mp->m_args = unargv(argc, argv);
542ca987d46SWarner Losh #endif
543ca987d46SWarner Losh 		snprintf(command_errbuf, sizeof(command_errbuf),
544ca987d46SWarner Losh 		  "warning: module '%s' already loaded", mp->m_name);
545ca987d46SWarner Losh 		return (0);
546ca987d46SWarner Losh 	}
547ca987d46SWarner Losh 	/* locate file with the module on the search path */
548ca987d46SWarner Losh 	filename = mod_searchmodule(modname, verinfo);
549ca987d46SWarner Losh 	if (filename == NULL) {
550ca987d46SWarner Losh 		snprintf(command_errbuf, sizeof(command_errbuf),
551ca987d46SWarner Losh 		  "can't find '%s'", modname);
552ca987d46SWarner Losh 		return (ENOENT);
553ca987d46SWarner Losh 	}
554ca987d46SWarner Losh 	err = mod_loadkld(filename, argc, argv);
555ca987d46SWarner Losh 	return (err);
556ca987d46SWarner Losh }
557ca987d46SWarner Losh 
558ca987d46SWarner Losh /*
559ca987d46SWarner Losh  * Load specified KLD. If path is omitted, then try to locate it via
560ca987d46SWarner Losh  * search path.
561ca987d46SWarner Losh  */
562ca987d46SWarner Losh int
563ca987d46SWarner Losh mod_loadkld(const char *kldname, int argc, char *argv[])
564ca987d46SWarner Losh {
565d7125bb1SToomas Soome 	struct preloaded_file	*fp;
566ca987d46SWarner Losh 	int			err;
567ca987d46SWarner Losh 	char			*filename;
568d7125bb1SToomas Soome 	vm_offset_t		loadaddr_saved;
569ca987d46SWarner Losh 
570ca987d46SWarner Losh 	/*
571ca987d46SWarner Losh 	 * Get fully qualified KLD name
572ca987d46SWarner Losh 	 */
573ca987d46SWarner Losh 	filename = file_search(kldname, kld_ext_list);
574ca987d46SWarner Losh 	if (filename == NULL) {
575ca987d46SWarner Losh 		snprintf(command_errbuf, sizeof(command_errbuf),
576ca987d46SWarner Losh 		  "can't find '%s'", kldname);
577ca987d46SWarner Losh 		return (ENOENT);
578ca987d46SWarner Losh 	}
579ca987d46SWarner Losh 	/*
580ca987d46SWarner Losh 	 * Check if KLD already loaded
581ca987d46SWarner Losh 	 */
582ca987d46SWarner Losh 	fp = file_findfile(filename, NULL);
583ca987d46SWarner Losh 	if (fp) {
584ca987d46SWarner Losh 		snprintf(command_errbuf, sizeof(command_errbuf),
585ca987d46SWarner Losh 		  "warning: KLD '%s' already loaded", filename);
586ca987d46SWarner Losh 		free(filename);
587ca987d46SWarner Losh 		return (0);
588ca987d46SWarner Losh 	}
589ca987d46SWarner Losh 
590ca987d46SWarner Losh 	do {
591ca987d46SWarner Losh 		err = file_load(filename, loadaddr, &fp);
592ca987d46SWarner Losh 		if (err)
593ca987d46SWarner Losh 			break;
594ca987d46SWarner Losh 		fp->f_args = unargv(argc, argv);
595d7125bb1SToomas Soome 		loadaddr_saved = loadaddr;
596ca987d46SWarner Losh 		loadaddr = fp->f_addr + fp->f_size;
597ca987d46SWarner Losh 		file_insert_tail(fp);	/* Add to the list of loaded files */
598ca987d46SWarner Losh 		if (file_load_dependencies(fp) != 0) {
599ca987d46SWarner Losh 			err = ENOENT;
600*ed792026SToomas Soome 			file_remove(fp);
601d7125bb1SToomas Soome 			loadaddr = loadaddr_saved;
602ca987d46SWarner Losh 			fp = NULL;
603ca987d46SWarner Losh 			break;
604ca987d46SWarner Losh 		}
605ca987d46SWarner Losh 	} while(0);
606ca987d46SWarner Losh 	if (err == EFTYPE) {
607ca987d46SWarner Losh 		snprintf(command_errbuf, sizeof(command_errbuf),
608ca987d46SWarner Losh 		  "don't know how to load module '%s'", filename);
609ca987d46SWarner Losh 	}
610ca987d46SWarner Losh 	if (err && fp)
611ca987d46SWarner Losh 		file_discard(fp);
612ca987d46SWarner Losh 	free(filename);
613ca987d46SWarner Losh 	return (err);
614ca987d46SWarner Losh }
615ca987d46SWarner Losh 
616ca987d46SWarner Losh /*
617ca987d46SWarner Losh  * Find a file matching (name) and (type).
618ca987d46SWarner Losh  * NULL may be passed as a wildcard to either.
619ca987d46SWarner Losh  */
620ca987d46SWarner Losh struct preloaded_file *
621ca987d46SWarner Losh file_findfile(const char *name, const char *type)
622ca987d46SWarner Losh {
623ca987d46SWarner Losh 	struct preloaded_file *fp;
624ca987d46SWarner Losh 
625ca987d46SWarner Losh 	for (fp = preloaded_files; fp != NULL; fp = fp->f_next) {
626ca987d46SWarner Losh 		if (((name == NULL) || !strcmp(name, fp->f_name)) &&
627ca987d46SWarner Losh 		  ((type == NULL) || !strcmp(type, fp->f_type)))
628ca987d46SWarner Losh 			break;
629ca987d46SWarner Losh 	}
630ca987d46SWarner Losh 	return (fp);
631ca987d46SWarner Losh }
632ca987d46SWarner Losh 
633ca987d46SWarner Losh /*
634ca987d46SWarner Losh  * Find a module matching (name) inside of given file.
635ca987d46SWarner Losh  * NULL may be passed as a wildcard.
636ca987d46SWarner Losh  */
637ca987d46SWarner Losh struct kernel_module *
638ca987d46SWarner Losh file_findmodule(struct preloaded_file *fp, char *modname,
639ca987d46SWarner Losh 	struct mod_depend *verinfo)
640ca987d46SWarner Losh {
641ca987d46SWarner Losh 	struct kernel_module *mp, *best;
642ca987d46SWarner Losh 	int bestver, mver;
643ca987d46SWarner Losh 
644ca987d46SWarner Losh 	if (fp == NULL) {
645ca987d46SWarner Losh 		for (fp = preloaded_files; fp; fp = fp->f_next) {
646ca987d46SWarner Losh 			mp = file_findmodule(fp, modname, verinfo);
647ca987d46SWarner Losh 			if (mp)
648ca987d46SWarner Losh 				return (mp);
649ca987d46SWarner Losh 		}
650ca987d46SWarner Losh 		return (NULL);
651ca987d46SWarner Losh 	}
652ca987d46SWarner Losh 	best = NULL;
653ca987d46SWarner Losh 	bestver = 0;
654ca987d46SWarner Losh 	for (mp = fp->f_modules; mp; mp = mp->m_next) {
655ca987d46SWarner Losh 		if (strcmp(modname, mp->m_name) == 0) {
656ca987d46SWarner Losh 			if (verinfo == NULL)
657ca987d46SWarner Losh 				return (mp);
658ca987d46SWarner Losh 			mver = mp->m_version;
659ca987d46SWarner Losh 			if (mver == verinfo->md_ver_preferred)
660ca987d46SWarner Losh 				return (mp);
661ca987d46SWarner Losh 			if (mver >= verinfo->md_ver_minimum &&
662ca987d46SWarner Losh 			  mver <= verinfo->md_ver_maximum &&
663ca987d46SWarner Losh 			  mver > bestver) {
664ca987d46SWarner Losh 				best = mp;
665ca987d46SWarner Losh 				bestver = mver;
666ca987d46SWarner Losh 			}
667ca987d46SWarner Losh 		}
668ca987d46SWarner Losh 	}
669ca987d46SWarner Losh 	return (best);
670ca987d46SWarner Losh }
671ca987d46SWarner Losh /*
672ca987d46SWarner Losh  * Make a copy of (size) bytes of data from (p), and associate them as
673ca987d46SWarner Losh  * metadata of (type) to the module (mp).
674ca987d46SWarner Losh  */
675ca987d46SWarner Losh void
676ca987d46SWarner Losh file_addmetadata(struct preloaded_file *fp, int type, size_t size, void *p)
677ca987d46SWarner Losh {
678ca987d46SWarner Losh 	struct file_metadata	*md;
679ca987d46SWarner Losh 
680ca987d46SWarner Losh 	md = malloc(sizeof(struct file_metadata) - sizeof(md->md_data) + size);
681d28c5946SToomas Soome 	if (md != NULL) {
682ca987d46SWarner Losh 		md->md_size = size;
683ca987d46SWarner Losh 		md->md_type = type;
684ca987d46SWarner Losh 		bcopy(p, md->md_data, size);
685ca987d46SWarner Losh 		md->md_next = fp->f_metadata;
686d28c5946SToomas Soome 	}
687ca987d46SWarner Losh 	fp->f_metadata = md;
688ca987d46SWarner Losh }
689ca987d46SWarner Losh 
690ca987d46SWarner Losh /*
691ca987d46SWarner Losh  * Find a metadata object of (type) associated with the file (fp)
692ca987d46SWarner Losh  */
693ca987d46SWarner Losh struct file_metadata *
694ca987d46SWarner Losh file_findmetadata(struct preloaded_file *fp, int type)
695ca987d46SWarner Losh {
696ca987d46SWarner Losh 	struct file_metadata *md;
697ca987d46SWarner Losh 
698ca987d46SWarner Losh 	for (md = fp->f_metadata; md != NULL; md = md->md_next)
699ca987d46SWarner Losh 		if (md->md_type == type)
700ca987d46SWarner Losh 			break;
701ca987d46SWarner Losh 	return(md);
702ca987d46SWarner Losh }
703ca987d46SWarner Losh 
704ca987d46SWarner Losh /*
705ca987d46SWarner Losh  * Remove all metadata from the file.
706ca987d46SWarner Losh  */
707ca987d46SWarner Losh void
708ca987d46SWarner Losh file_removemetadata(struct preloaded_file *fp)
709ca987d46SWarner Losh {
710ca987d46SWarner Losh 	struct file_metadata *md, *next;
711ca987d46SWarner Losh 
712ca987d46SWarner Losh 	for (md = fp->f_metadata; md != NULL; md = next)
713ca987d46SWarner Losh 	{
714ca987d46SWarner Losh 		next = md->md_next;
715ca987d46SWarner Losh 		free(md);
716ca987d46SWarner Losh 	}
717ca987d46SWarner Losh 	fp->f_metadata = NULL;
718ca987d46SWarner Losh }
719ca987d46SWarner Losh 
720ca987d46SWarner Losh struct file_metadata *
721ca987d46SWarner Losh metadata_next(struct file_metadata *md, int type)
722ca987d46SWarner Losh {
72373a41ff8SEmmanuel Vadot 
724ca987d46SWarner Losh 	if (md == NULL)
725ca987d46SWarner Losh 		return (NULL);
726ca987d46SWarner Losh 	while((md = md->md_next) != NULL)
727ca987d46SWarner Losh 		if (md->md_type == type)
728ca987d46SWarner Losh 			break;
729ca987d46SWarner Losh 	return (md);
730ca987d46SWarner Losh }
731ca987d46SWarner Losh 
732ca987d46SWarner Losh static char *emptyextlist[] = { "", NULL };
733ca987d46SWarner Losh 
734ca987d46SWarner Losh /*
735ca987d46SWarner Losh  * Check if the given file is in place and return full path to it.
736ca987d46SWarner Losh  */
737ca987d46SWarner Losh static char *
738ca987d46SWarner Losh file_lookup(const char *path, const char *name, int namelen, char **extlist)
739ca987d46SWarner Losh {
740ca987d46SWarner Losh 	struct stat	st;
741ca987d46SWarner Losh 	char	*result, *cp, **cpp;
742ca987d46SWarner Losh 	int		pathlen, extlen, len;
743ca987d46SWarner Losh 
744ca987d46SWarner Losh 	pathlen = strlen(path);
745ca987d46SWarner Losh 	extlen = 0;
746ca987d46SWarner Losh 	if (extlist == NULL)
747ca987d46SWarner Losh 		extlist = emptyextlist;
748ca987d46SWarner Losh 	for (cpp = extlist; *cpp; cpp++) {
749ca987d46SWarner Losh 		len = strlen(*cpp);
750ca987d46SWarner Losh 		if (len > extlen)
751ca987d46SWarner Losh 			extlen = len;
752ca987d46SWarner Losh 	}
753ca987d46SWarner Losh 	result = malloc(pathlen + namelen + extlen + 2);
754ca987d46SWarner Losh 	if (result == NULL)
755ca987d46SWarner Losh 		return (NULL);
756ca987d46SWarner Losh 	bcopy(path, result, pathlen);
757ca987d46SWarner Losh 	if (pathlen > 0 && result[pathlen - 1] != '/')
758ca987d46SWarner Losh 		result[pathlen++] = '/';
759ca987d46SWarner Losh 	cp = result + pathlen;
760ca987d46SWarner Losh 	bcopy(name, cp, namelen);
761ca987d46SWarner Losh 	cp += namelen;
762ca987d46SWarner Losh 	for (cpp = extlist; *cpp; cpp++) {
763ca987d46SWarner Losh 		strcpy(cp, *cpp);
764ca987d46SWarner Losh 		if (stat(result, &st) == 0 && S_ISREG(st.st_mode))
765ca987d46SWarner Losh 			return result;
766ca987d46SWarner Losh 	}
767ca987d46SWarner Losh 	free(result);
768ca987d46SWarner Losh 	return NULL;
769ca987d46SWarner Losh }
770ca987d46SWarner Losh 
771ca987d46SWarner Losh /*
772ca987d46SWarner Losh  * Check if file name have any qualifiers
773ca987d46SWarner Losh  */
774ca987d46SWarner Losh static int
775ca987d46SWarner Losh file_havepath(const char *name)
776ca987d46SWarner Losh {
777ca987d46SWarner Losh 	const char		*cp;
778ca987d46SWarner Losh 
779ca987d46SWarner Losh 	archsw.arch_getdev(NULL, name, &cp);
780ca987d46SWarner Losh 	return (cp != name || strchr(name, '/') != NULL);
781ca987d46SWarner Losh }
782ca987d46SWarner Losh 
783ca987d46SWarner Losh /*
784ca987d46SWarner Losh  * Attempt to find the file (name) on the module searchpath.
785ca987d46SWarner Losh  * If (name) is qualified in any way, we simply check it and
786ca987d46SWarner Losh  * return it or NULL.  If it is not qualified, then we attempt
787ca987d46SWarner Losh  * to construct a path using entries in the environment variable
788ca987d46SWarner Losh  * module_path.
789ca987d46SWarner Losh  *
790ca987d46SWarner Losh  * The path we return a pointer to need never be freed, as we manage
791ca987d46SWarner Losh  * it internally.
792ca987d46SWarner Losh  */
793ca987d46SWarner Losh static char *
794ca987d46SWarner Losh file_search(const char *name, char **extlist)
795ca987d46SWarner Losh {
796ca987d46SWarner Losh 	struct moduledir	*mdp;
797ca987d46SWarner Losh 	struct stat		sb;
798ca987d46SWarner Losh 	char		*result;
799ca987d46SWarner Losh 	int			namelen;
800ca987d46SWarner Losh 
801ca987d46SWarner Losh 	/* Don't look for nothing */
802ca987d46SWarner Losh 	if (name == NULL)
803ca987d46SWarner Losh 		return(NULL);
804ca987d46SWarner Losh 
805ca987d46SWarner Losh 	if (*name == 0)
806ca987d46SWarner Losh 		return(strdup(name));
807ca987d46SWarner Losh 
808ca987d46SWarner Losh 	if (file_havepath(name)) {
809ca987d46SWarner Losh 		/* Qualified, so just see if it exists */
810ca987d46SWarner Losh 		if (stat(name, &sb) == 0)
811ca987d46SWarner Losh 			return(strdup(name));
812ca987d46SWarner Losh 		return(NULL);
813ca987d46SWarner Losh 	}
814ca987d46SWarner Losh 	moduledir_rebuild();
815ca987d46SWarner Losh 	result = NULL;
816ca987d46SWarner Losh 	namelen = strlen(name);
817ca987d46SWarner Losh 	STAILQ_FOREACH(mdp, &moduledir_list, d_link) {
818ca987d46SWarner Losh 		result = file_lookup(mdp->d_path, name, namelen, extlist);
819ca987d46SWarner Losh 		if (result)
820ca987d46SWarner Losh 			break;
821ca987d46SWarner Losh 	}
822ca987d46SWarner Losh 	return(result);
823ca987d46SWarner Losh }
824ca987d46SWarner Losh 
825ca987d46SWarner Losh #define	INT_ALIGN(base, ptr)	ptr = \
826ca987d46SWarner Losh 	(base) + roundup2((ptr) - (base), sizeof(int))
827ca987d46SWarner Losh 
828ca987d46SWarner Losh static char *
829ca987d46SWarner Losh mod_search_hints(struct moduledir *mdp, const char *modname,
830ca987d46SWarner Losh 	struct mod_depend *verinfo)
831ca987d46SWarner Losh {
832ca987d46SWarner Losh 	u_char	*cp, *recptr, *bufend, *best;
833ca987d46SWarner Losh 	char	*result;
834ca987d46SWarner Losh 	int		*intp, bestver, blen, clen, found, ival, modnamelen, reclen;
835ca987d46SWarner Losh 
836ca987d46SWarner Losh 	moduledir_readhints(mdp);
837ca987d46SWarner Losh 	modnamelen = strlen(modname);
838ca987d46SWarner Losh 	found = 0;
839ca987d46SWarner Losh 	result = NULL;
840ca987d46SWarner Losh 	bestver = 0;
841ca987d46SWarner Losh 	if (mdp->d_hints == NULL)
842ca987d46SWarner Losh 		goto bad;
843ca987d46SWarner Losh 	recptr = mdp->d_hints;
844ca987d46SWarner Losh 	bufend = recptr + mdp->d_hintsz;
845ca987d46SWarner Losh 	clen = blen = 0;
846ca987d46SWarner Losh 	best = cp = NULL;
847ca987d46SWarner Losh 	while (recptr < bufend && !found) {
848ca987d46SWarner Losh 		intp = (int*)recptr;
849ca987d46SWarner Losh 		reclen = *intp++;
850ca987d46SWarner Losh 		ival = *intp++;
851ca987d46SWarner Losh 		cp = (u_char*)intp;
852ca987d46SWarner Losh 		switch (ival) {
853ca987d46SWarner Losh 		case MDT_VERSION:
854ca987d46SWarner Losh 			clen = *cp++;
855ca987d46SWarner Losh 			if (clen != modnamelen || bcmp(cp, modname, clen) != 0)
856ca987d46SWarner Losh 				break;
857ca987d46SWarner Losh 			cp += clen;
858ca987d46SWarner Losh 			INT_ALIGN(mdp->d_hints, cp);
859ca987d46SWarner Losh 			ival = *(int*)cp;
860ca987d46SWarner Losh 			cp += sizeof(int);
861ca987d46SWarner Losh 			clen = *cp++;
862ca987d46SWarner Losh 			if (verinfo == NULL || ival == verinfo->md_ver_preferred) {
863ca987d46SWarner Losh 				found = 1;
864ca987d46SWarner Losh 				break;
865ca987d46SWarner Losh 			}
866ca987d46SWarner Losh 			if (ival >= verinfo->md_ver_minimum &&
867ca987d46SWarner Losh 			  ival <= verinfo->md_ver_maximum &&
868ca987d46SWarner Losh 			  ival > bestver) {
869ca987d46SWarner Losh 				bestver = ival;
870ca987d46SWarner Losh 				best = cp;
871ca987d46SWarner Losh 				blen = clen;
872ca987d46SWarner Losh 			}
873ca987d46SWarner Losh 			break;
874ca987d46SWarner Losh 		default:
875ca987d46SWarner Losh 			break;
876ca987d46SWarner Losh 		}
877ca987d46SWarner Losh 		recptr += reclen + sizeof(int);
878ca987d46SWarner Losh 	}
879ca987d46SWarner Losh 	/*
880ca987d46SWarner Losh 	 * Finally check if KLD is in the place
881ca987d46SWarner Losh 	 */
882ca987d46SWarner Losh 	if (found)
883ca987d46SWarner Losh 		result = file_lookup(mdp->d_path, (const char *)cp, clen, NULL);
884ca987d46SWarner Losh 	else if (best)
885ca987d46SWarner Losh 		result = file_lookup(mdp->d_path, (const char *)best, blen, NULL);
886ca987d46SWarner Losh bad:
887ca987d46SWarner Losh 	/*
888ca987d46SWarner Losh 	 * If nothing found or hints is absent - fallback to the old way
889ca987d46SWarner Losh 	 * by using "kldname[.ko]" as module name.
890ca987d46SWarner Losh 	 */
891ca987d46SWarner Losh 	if (!found && !bestver && result == NULL)
892ca987d46SWarner Losh 		result = file_lookup(mdp->d_path, modname, modnamelen, kld_ext_list);
893ca987d46SWarner Losh 	return result;
894ca987d46SWarner Losh }
895ca987d46SWarner Losh 
896ca987d46SWarner Losh /*
897ca987d46SWarner Losh  * Attempt to locate the file containing the module (name)
898ca987d46SWarner Losh  */
899ca987d46SWarner Losh static char *
900ca987d46SWarner Losh mod_searchmodule(char *name, struct mod_depend *verinfo)
901ca987d46SWarner Losh {
902ca987d46SWarner Losh 	struct	moduledir *mdp;
903ca987d46SWarner Losh 	char	*result;
904ca987d46SWarner Losh 
905ca987d46SWarner Losh 	moduledir_rebuild();
906ca987d46SWarner Losh 	/*
907ca987d46SWarner Losh 	 * Now we ready to lookup module in the given directories
908ca987d46SWarner Losh 	 */
909ca987d46SWarner Losh 	result = NULL;
910ca987d46SWarner Losh 	STAILQ_FOREACH(mdp, &moduledir_list, d_link) {
911ca987d46SWarner Losh 		result = mod_search_hints(mdp, name, verinfo);
912ca987d46SWarner Losh 		if (result)
913ca987d46SWarner Losh 			break;
914ca987d46SWarner Losh 	}
915ca987d46SWarner Losh 
916ca987d46SWarner Losh 	return(result);
917ca987d46SWarner Losh }
918ca987d46SWarner Losh 
919ca987d46SWarner Losh int
920ca987d46SWarner Losh file_addmodule(struct preloaded_file *fp, char *modname, int version,
921ca987d46SWarner Losh 	struct kernel_module **newmp)
922ca987d46SWarner Losh {
923ca987d46SWarner Losh 	struct kernel_module *mp;
924ca987d46SWarner Losh 	struct mod_depend mdepend;
925ca987d46SWarner Losh 
926ca987d46SWarner Losh 	bzero(&mdepend, sizeof(mdepend));
927ca987d46SWarner Losh 	mdepend.md_ver_preferred = version;
928ca987d46SWarner Losh 	mp = file_findmodule(fp, modname, &mdepend);
929ca987d46SWarner Losh 	if (mp)
930ca987d46SWarner Losh 		return (EEXIST);
931cef2742eSToomas Soome 	mp = calloc(1, sizeof(struct kernel_module));
932ca987d46SWarner Losh 	if (mp == NULL)
933ca987d46SWarner Losh 		return (ENOMEM);
934ca987d46SWarner Losh 	mp->m_name = strdup(modname);
935db7599e9SToomas Soome 	if (mp->m_name == NULL) {
936db7599e9SToomas Soome 		free(mp);
937db7599e9SToomas Soome 		return (ENOMEM);
938db7599e9SToomas Soome 	}
939ca987d46SWarner Losh 	mp->m_version = version;
940ca987d46SWarner Losh 	mp->m_fp = fp;
941ca987d46SWarner Losh 	mp->m_next = fp->f_modules;
942ca987d46SWarner Losh 	fp->f_modules = mp;
943ca987d46SWarner Losh 	if (newmp)
944ca987d46SWarner Losh 		*newmp = mp;
945ca987d46SWarner Losh 	return (0);
946ca987d46SWarner Losh }
947ca987d46SWarner Losh 
948ca987d46SWarner Losh /*
949ca987d46SWarner Losh  * Throw a file away
950ca987d46SWarner Losh  */
951ca987d46SWarner Losh void
952ca987d46SWarner Losh file_discard(struct preloaded_file *fp)
953ca987d46SWarner Losh {
954ca987d46SWarner Losh 	struct file_metadata	*md, *md1;
955ca987d46SWarner Losh 	struct kernel_module	*mp, *mp1;
956ca987d46SWarner Losh 	if (fp == NULL)
957ca987d46SWarner Losh 		return;
958ca987d46SWarner Losh 	md = fp->f_metadata;
959ca987d46SWarner Losh 	while (md) {
960ca987d46SWarner Losh 		md1 = md;
961ca987d46SWarner Losh 		md = md->md_next;
962ca987d46SWarner Losh 		free(md1);
963ca987d46SWarner Losh 	}
964ca987d46SWarner Losh 	mp = fp->f_modules;
965ca987d46SWarner Losh 	while (mp) {
966ca987d46SWarner Losh 		free(mp->m_name);
967ca987d46SWarner Losh 		mp1 = mp;
968ca987d46SWarner Losh 		mp = mp->m_next;
969ca987d46SWarner Losh 		free(mp1);
970ca987d46SWarner Losh 	}
971ca987d46SWarner Losh 	free(fp->f_name);
972ca987d46SWarner Losh 	free(fp->f_type);
973ca987d46SWarner Losh 	free(fp->f_args);
974ca987d46SWarner Losh 	free(fp);
975ca987d46SWarner Losh }
976ca987d46SWarner Losh 
977ca987d46SWarner Losh /*
978ca987d46SWarner Losh  * Allocate a new file; must be used instead of malloc()
979ca987d46SWarner Losh  * to ensure safe initialisation.
980ca987d46SWarner Losh  */
981ca987d46SWarner Losh struct preloaded_file *
982ca987d46SWarner Losh file_alloc(void)
983ca987d46SWarner Losh {
984ca987d46SWarner Losh 
985cef2742eSToomas Soome 	return (calloc(1, sizeof(struct preloaded_file)));
986ca987d46SWarner Losh }
987ca987d46SWarner Losh 
988ca987d46SWarner Losh /*
989ca987d46SWarner Losh  * Add a module to the chain
990ca987d46SWarner Losh  */
991ca987d46SWarner Losh static void
992ca987d46SWarner Losh file_insert_tail(struct preloaded_file *fp)
993ca987d46SWarner Losh {
994ca987d46SWarner Losh 	struct preloaded_file	*cm;
995ca987d46SWarner Losh 
996ca987d46SWarner Losh 	/* Append to list of loaded file */
997ca987d46SWarner Losh 	fp->f_next = NULL;
998ca987d46SWarner Losh 	if (preloaded_files == NULL) {
999ca987d46SWarner Losh 		preloaded_files = fp;
1000ca987d46SWarner Losh 	} else {
1001ca987d46SWarner Losh 		for (cm = preloaded_files; cm->f_next != NULL; cm = cm->f_next)
1002ca987d46SWarner Losh 			;
1003ca987d46SWarner Losh 		cm->f_next = fp;
1004ca987d46SWarner Losh 	}
1005ca987d46SWarner Losh }
1006ca987d46SWarner Losh 
1007*ed792026SToomas Soome /*
1008*ed792026SToomas Soome  * Remove module from the chain
1009*ed792026SToomas Soome  */
1010*ed792026SToomas Soome static void
1011*ed792026SToomas Soome file_remove(struct preloaded_file *fp)
1012*ed792026SToomas Soome {
1013*ed792026SToomas Soome 	struct preloaded_file   *cm;
1014*ed792026SToomas Soome 
1015*ed792026SToomas Soome 	if (preloaded_files == NULL)
1016*ed792026SToomas Soome 		return;
1017*ed792026SToomas Soome 
1018*ed792026SToomas Soome 	if (preloaded_files == fp) {
1019*ed792026SToomas Soome 		preloaded_files = fp->f_next;
1020*ed792026SToomas Soome 		return;
1021*ed792026SToomas Soome         }
1022*ed792026SToomas Soome         for (cm = preloaded_files; cm->f_next != NULL; cm = cm->f_next) {
1023*ed792026SToomas Soome 		if (cm->f_next == fp) {
1024*ed792026SToomas Soome 			cm->f_next = fp->f_next;
1025*ed792026SToomas Soome 			return;
1026*ed792026SToomas Soome 		}
1027*ed792026SToomas Soome 	}
1028*ed792026SToomas Soome }
1029*ed792026SToomas Soome 
1030ca987d46SWarner Losh static char *
1031ca987d46SWarner Losh moduledir_fullpath(struct moduledir *mdp, const char *fname)
1032ca987d46SWarner Losh {
1033ca987d46SWarner Losh 	char *cp;
1034ca987d46SWarner Losh 
1035ca987d46SWarner Losh 	cp = malloc(strlen(mdp->d_path) + strlen(fname) + 2);
1036ca987d46SWarner Losh 	if (cp == NULL)
1037ca987d46SWarner Losh 		return NULL;
1038ca987d46SWarner Losh 	strcpy(cp, mdp->d_path);
1039ca987d46SWarner Losh 	strcat(cp, "/");
1040ca987d46SWarner Losh 	strcat(cp, fname);
1041ca987d46SWarner Losh 	return (cp);
1042ca987d46SWarner Losh }
1043ca987d46SWarner Losh 
1044ca987d46SWarner Losh /*
1045ca987d46SWarner Losh  * Read linker.hints file into memory performing some sanity checks.
1046ca987d46SWarner Losh  */
1047ca987d46SWarner Losh static void
1048ca987d46SWarner Losh moduledir_readhints(struct moduledir *mdp)
1049ca987d46SWarner Losh {
1050ca987d46SWarner Losh 	struct stat	st;
1051ca987d46SWarner Losh 	char	*path;
1052ca987d46SWarner Losh 	int		fd, size, version;
1053ca987d46SWarner Losh 
1054ca987d46SWarner Losh 	if (mdp->d_hints != NULL || (mdp->d_flags & MDIR_NOHINTS))
1055ca987d46SWarner Losh 		return;
1056ca987d46SWarner Losh 	path = moduledir_fullpath(mdp, "linker.hints");
1057ca987d46SWarner Losh 	if (stat(path, &st) != 0 ||
1058ca987d46SWarner Losh 	  st.st_size < (ssize_t)(sizeof(version) + sizeof(int)) ||
1059ca987d46SWarner Losh 	  st.st_size > LINKER_HINTS_MAX || (fd = open(path, O_RDONLY)) < 0) {
1060ca987d46SWarner Losh 		free(path);
1061ca987d46SWarner Losh 		mdp->d_flags |= MDIR_NOHINTS;
1062ca987d46SWarner Losh 		return;
1063ca987d46SWarner Losh 	}
1064ca987d46SWarner Losh 	free(path);
1065ca987d46SWarner Losh 	size = read(fd, &version, sizeof(version));
1066ca987d46SWarner Losh 	if (size != sizeof(version) || version != LINKER_HINTS_VERSION)
1067ca987d46SWarner Losh 		goto bad;
1068ca987d46SWarner Losh 	size = st.st_size - size;
1069ca987d46SWarner Losh 	mdp->d_hints = malloc(size);
1070ca987d46SWarner Losh 	if (mdp->d_hints == NULL)
1071ca987d46SWarner Losh 		goto bad;
1072ca987d46SWarner Losh 	if (read(fd, mdp->d_hints, size) != size)
1073ca987d46SWarner Losh 		goto bad;
1074ca987d46SWarner Losh 	mdp->d_hintsz = size;
1075ca987d46SWarner Losh 	close(fd);
1076ca987d46SWarner Losh 	return;
1077ca987d46SWarner Losh bad:
1078ca987d46SWarner Losh 	close(fd);
1079ca987d46SWarner Losh 	free(mdp->d_hints);
1080ca987d46SWarner Losh 	mdp->d_hints = NULL;
1081ca987d46SWarner Losh 	mdp->d_flags |= MDIR_NOHINTS;
1082ca987d46SWarner Losh 	return;
1083ca987d46SWarner Losh }
1084ca987d46SWarner Losh 
1085ca987d46SWarner Losh /*
1086ca987d46SWarner Losh  * Extract directories from the ';' separated list, remove duplicates.
1087ca987d46SWarner Losh  */
1088ca987d46SWarner Losh static void
1089ca987d46SWarner Losh moduledir_rebuild(void)
1090ca987d46SWarner Losh {
1091ca987d46SWarner Losh 	struct	moduledir *mdp, *mtmp;
1092ca987d46SWarner Losh 	const char	*path, *cp, *ep;
1093ca987d46SWarner Losh 	size_t	cplen;
1094ca987d46SWarner Losh 
1095ca987d46SWarner Losh 	path = getenv("module_path");
1096ca987d46SWarner Losh 	if (path == NULL)
1097ca987d46SWarner Losh 		path = default_searchpath;
1098ca987d46SWarner Losh 	/*
1099ca987d46SWarner Losh 	 * Rebuild list of module directories if it changed
1100ca987d46SWarner Losh 	 */
1101ca987d46SWarner Losh 	STAILQ_FOREACH(mdp, &moduledir_list, d_link)
1102ca987d46SWarner Losh 		mdp->d_flags |= MDIR_REMOVED;
1103ca987d46SWarner Losh 
1104ca987d46SWarner Losh 	for (ep = path; *ep != 0;  ep++) {
1105ca987d46SWarner Losh 		cp = ep;
1106ca987d46SWarner Losh 		for (; *ep != 0 && *ep != ';'; ep++)
1107ca987d46SWarner Losh 			;
1108ca987d46SWarner Losh 		/*
1109ca987d46SWarner Losh 		 * Ignore trailing slashes
1110ca987d46SWarner Losh 		 */
1111ca987d46SWarner Losh 		for (cplen = ep - cp; cplen > 1 && cp[cplen - 1] == '/'; cplen--)
1112ca987d46SWarner Losh 			;
1113ca987d46SWarner Losh 		STAILQ_FOREACH(mdp, &moduledir_list, d_link) {
1114ca987d46SWarner Losh 			if (strlen(mdp->d_path) != cplen ||	bcmp(cp, mdp->d_path, cplen) != 0)
1115ca987d46SWarner Losh 				continue;
1116ca987d46SWarner Losh 			mdp->d_flags &= ~MDIR_REMOVED;
1117ca987d46SWarner Losh 			break;
1118ca987d46SWarner Losh 		}
1119ca987d46SWarner Losh 		if (mdp == NULL) {
1120ca987d46SWarner Losh 			mdp = malloc(sizeof(*mdp) + cplen + 1);
1121ca987d46SWarner Losh 			if (mdp == NULL)
1122ca987d46SWarner Losh 				return;
1123ca987d46SWarner Losh 			mdp->d_path = (char*)(mdp + 1);
1124ca987d46SWarner Losh 			bcopy(cp, mdp->d_path, cplen);
1125ca987d46SWarner Losh 			mdp->d_path[cplen] = 0;
1126ca987d46SWarner Losh 			mdp->d_hints = NULL;
1127ca987d46SWarner Losh 			mdp->d_flags = 0;
1128ca987d46SWarner Losh 			STAILQ_INSERT_TAIL(&moduledir_list, mdp, d_link);
1129ca987d46SWarner Losh 		}
1130ca987d46SWarner Losh 		if (*ep == 0)
1131ca987d46SWarner Losh 			break;
1132ca987d46SWarner Losh 	}
1133ca987d46SWarner Losh 	/*
1134ca987d46SWarner Losh 	 * Delete unused directories if any
1135ca987d46SWarner Losh 	 */
1136ca987d46SWarner Losh 	mdp = STAILQ_FIRST(&moduledir_list);
1137ca987d46SWarner Losh 	while (mdp) {
1138ca987d46SWarner Losh 		if ((mdp->d_flags & MDIR_REMOVED) == 0) {
1139ca987d46SWarner Losh 			mdp = STAILQ_NEXT(mdp, d_link);
1140ca987d46SWarner Losh 		} else {
1141ca987d46SWarner Losh 			free(mdp->d_hints);
1142ca987d46SWarner Losh 			mtmp = mdp;
1143ca987d46SWarner Losh 			mdp = STAILQ_NEXT(mdp, d_link);
1144ca987d46SWarner Losh 			STAILQ_REMOVE(&moduledir_list, mtmp, moduledir, d_link);
1145ca987d46SWarner Losh 			free(mtmp);
1146ca987d46SWarner Losh 		}
1147ca987d46SWarner Losh 	}
1148ca987d46SWarner Losh 	return;
1149ca987d46SWarner Losh }
1150