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