xref: /illumos-gate/usr/src/boot/common/bootstrap.h (revision d3bd5503)
1 /*
2  * Copyright (c) 1998 Michael Smith <msmith@freebsd.org>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  */
26 
27 #ifndef _BOOTSTRAP_H_
28 #define	_BOOTSTRAP_H_
29 
30 #include <sys/types.h>
31 #include <sys/queue.h>
32 #include <sys/linker_set.h>
33 #include <stdbool.h>
34 
35 /* Commands and return values; nonzero return sets command_errmsg != NULL */
36 typedef int	(bootblk_cmd_t)(int argc, char *argv[]);
37 #define	COMMAND_ERRBUFSZ	(256)
38 extern const char	*command_errmsg;
39 extern char	command_errbuf[COMMAND_ERRBUFSZ];
40 #define	CMD_OK		0
41 #define	CMD_WARN	1
42 #define	CMD_ERROR	2
43 #define	CMD_CRIT	3
44 #define	CMD_FATAL	4
45 
46 /* interp.c */
47 void	interact(const char *rc);
48 int	include(const char *filename);
49 
50 /* interp_backslash.c */
51 char	*backslash(char *str);
52 
53 /* interp_parse.c */
54 int	parse(int *argc, char ***argv, char *str);
55 
56 /* interp_forth.c */
57 void	bf_init(char *rc);
58 int	bf_run(char *line);
59 
60 /* boot.c */
61 int	autoboot(int timeout, char *prompt);
62 void	autoboot_maybe(void);
63 int	getrootmount(char *rootdev);
64 
65 /* misc.c */
66 char	*unargv(int argc, char *argv[]);
67 void	hexdump(caddr_t region, size_t len);
68 size_t	strlenout(vm_offset_t str);
69 char	*strdupout(vm_offset_t str);
70 void	kern_bzero(vm_offset_t dest, size_t len);
71 int	kern_pread(int fd, vm_offset_t dest, size_t len, off_t off);
72 void	*alloc_pread(int fd, off_t off, size_t len);
73 
74 /* bcache.c */
75 void	bcache_init(size_t nblks, size_t bsize);
76 void	bcache_add_dev(int);
77 void	*bcache_allocate(void);
78 void	bcache_free(void *);
79 int	bcache_strategy(void *devdata, int rw, daddr_t blk,
80     size_t size, char *buf, size_t *rsize);
81 
82 /*
83  * Disk block cache
84  */
85 struct bcache_devdata
86 {
87 	int	(*dv_strategy)(void *devdata, int rw, daddr_t blk,
88 		size_t size, char *buf, size_t *rsize);
89 	void	*dv_devdata;
90 	void	*dv_cache;
91 };
92 
93 /*
94  * Modular console support.
95  */
96 struct console
97 {
98 	char		*c_name;
99 	char		*c_desc;
100 	int		c_flags;
101 #define	C_PRESENTIN	(1<<0)		/* console can provide input */
102 #define	C_PRESENTOUT	(1<<1)		/* console can provide output */
103 #define	C_ACTIVEIN	(1<<2)		/* user wants input from console */
104 #define	C_ACTIVEOUT	(1<<3)		/* user wants output to console */
105 #define	C_WIDEOUT	(1<<4)		/* c_out routine groks wide chars */
106 #define	C_MODERAW	(1<<5)		/* raw mode */
107 
108 	/* set c_flags to match hardware */
109 	void	(*c_probe)(struct console *);
110 	/* reinit XXX may need more args */
111 	int		(*c_init)(struct console *, int);
112 	/* emit c */
113 	void		(*c_out)(struct console *, int);
114 	/* wait for and return input */
115 	int		(*c_in)(struct console *);
116 	/* return nonzero if input is waiting */
117 	int		(*c_ready)(struct console *);
118 	int		(*c_ioctl)(struct console *, int, void *);
119 	/* Print device info */
120 	void		(*c_devinfo)(struct console *);
121 	void		*c_private;	/* private data */
122 };
123 
124 /*
125  * Provide either pointer to console device or init function
126  * to add devices to array of console devices.
127  */
128 struct console_template {
129 	struct console	*ct_dev;
130 	void		(*ct_init)(void);
131 };
132 
133 extern struct console_template ct_list[];
134 extern struct console **consoles;
135 uint_t	cons_array_size(void);
136 int	cons_inputdev(void);
137 void	cons_probe(void);
138 void	cons_mode(int);
139 void	autoload_font(bool);
140 
141 /*
142  * Plug-and-play enumerator/configurator interface.
143  */
144 struct pnphandler
145 {
146 	const char	*pp_name;		/* handler/bus name */
147 	/* enumerate PnP devices, add to chain */
148 	void		(*pp_enumerate)(void);
149 };
150 
151 struct pnpident
152 {
153 	/* ASCII identifier, actual format varies with bus/handler */
154 	char			*id_ident;
155 	STAILQ_ENTRY(pnpident)	id_link;
156 };
157 
158 struct pnpinfo
159 {
160 	/* ASCII description, optional */
161 	char			*pi_desc;
162 	/* optional revision (or -1) if not supported */
163 	int			pi_revision;
164 	/* module/args nominated to handle device */
165 	char			*pi_module;
166 	/* module arguments */
167 	int			pi_argc;
168 	char			**pi_argv;
169 	/* handler which detected this device */
170 	struct pnphandler	*pi_handler;
171 	/* list of identifiers */
172 	STAILQ_HEAD(, pnpident)	pi_ident;
173 	STAILQ_ENTRY(pnpinfo)	pi_link;
174 };
175 
176 STAILQ_HEAD(pnpinfo_stql, pnpinfo);
177 
178 extern struct pnphandler *pnphandlers[];	/* provided by MD code */
179 
180 void			pnp_addident(struct pnpinfo *pi, char *ident);
181 struct pnpinfo		*pnp_allocinfo(void);
182 void			pnp_freeinfo(struct pnpinfo *pi);
183 void			pnp_addinfo(struct pnpinfo *pi);
184 char			*pnp_eisaformat(uint8_t *data);
185 
186 /*
187  *  < 0	- No ISA in system
188  * == 0	- Maybe ISA, search for read data port
189  *  > 0	- ISA in system, value is read data port address
190  */
191 extern int			isapnp_readport;
192 
193 /*
194  * Version information
195  */
196 extern char bootprog_info[];
197 
198 /*
199  * Preloaded file metadata header.
200  *
201  * Metadata are allocated on our heap, and copied into kernel space
202  * before executing the kernel.
203  */
204 struct file_metadata
205 {
206 	size_t			md_size;
207 	uint16_t		md_type;
208 	struct file_metadata	*md_next;
209 	/* data are immediately appended */
210 	char			md_data[1];
211 };
212 
213 struct preloaded_file;
214 struct mod_depend;
215 
216 struct kernel_module
217 {
218 	char			*m_name;	/* module name */
219 	int			m_version;	/* module version */
220 	char			*m_args;	/* arguments for the module */
221 	struct preloaded_file	*m_fp;
222 	struct kernel_module	*m_next;
223 };
224 
225 /*
226  * Preloaded file information. Depending on type, file can contain
227  * additional units called 'modules'.
228  *
229  * At least one file (the kernel) must be loaded in order to boot.
230  * The kernel is always loaded first.
231  *
232  * String fields (m_name, m_type) should be dynamically allocated.
233  */
234 struct preloaded_file
235 {
236 	char			*f_name;	/* file name */
237 	/* verbose file type, eg 'ELF kernel', 'pnptable', etc. */
238 	char			*f_type;
239 	char			*f_args;	/* arguments for the file */
240 	/* metadata that will be placed in the module directory */
241 	struct file_metadata	*f_metadata;
242 	/* index of the loader that read the file */
243 	int			f_loader;
244 	vm_offset_t		f_addr;		/* load address */
245 	size_t			f_size;		/* file size */
246 	struct kernel_module	*f_modules;	/* list of modules if any */
247 	struct preloaded_file	*f_next;	/* next file */
248 };
249 
250 struct file_format
251 {
252 	/*
253 	 * Load function must return EFTYPE if it can't handle the module
254 	 * supplied.
255 	 */
256 	int (*l_load)(char *, uint64_t, struct preloaded_file **);
257 	/*
258 	 * Only a loader that will load a kernel (first module)
259 	 * should have an exec handler.
260 	 */
261 	int (*l_exec)(struct preloaded_file *);
262 };
263 
264 extern struct file_format *file_formats[];	/* supplied by consumer */
265 extern struct preloaded_file *preloaded_files;
266 
267 int mod_load(char *name, struct mod_depend *verinfo, int argc, char *argv[]);
268 int mod_loadkld(const char *name, int argc, char *argv[]);
269 void unload(void);
270 
271 struct preloaded_file *file_alloc(void);
272 struct preloaded_file *file_findfile(const char *name, const char *type);
273 struct file_metadata *file_findmetadata(struct preloaded_file *fp, int type);
274 struct preloaded_file *file_loadraw(const char *name, char *type, int argc,
275 	char **argv, int insert);
276 void file_discard(struct preloaded_file *fp);
277 void file_addmetadata(struct preloaded_file *, int, size_t, void *);
278 int  file_addmodule(struct preloaded_file *, char *, int,
279 	struct kernel_module **);
280 void build_environment_module(void);
281 void build_font_module(void);
282 vm_offset_t bi_copyenv(vm_offset_t);
283 
284 /* MI module loaders */
285 #ifdef __elfN
286 /* Relocation types. */
287 #define	ELF_RELOC_REL	1
288 #define	ELF_RELOC_RELA	2
289 
290 /* Relocation offset for some architectures */
291 extern uint64_t __elfN(relocation_offset);
292 
293 struct elf_file;
294 typedef Elf_Addr(symaddr_fn)(struct elf_file *, Elf_Size);
295 
296 int	elf64_loadfile(char *, uint64_t, struct preloaded_file **);
297 int	elf32_loadfile(char *, uint64_t, struct preloaded_file **);
298 int	elf64_obj_loadfile(char *, uint64_t, struct preloaded_file **);
299 int	elf32_obj_loadfile(char *, uint64_t, struct preloaded_file **);
300 int	__elfN(reloc)(struct elf_file *ef, symaddr_fn *symaddr,
301 	    const void *reldata, int reltype, Elf_Addr relbase,
302 	    Elf_Addr dataaddr, void *data, size_t len);
303 int	elf64_loadfile_raw(char *, uint64_t, struct preloaded_file **, int);
304 int	elf32_loadfile_raw(char *, uint64_t, struct preloaded_file **, int);
305 int	elf64_load_modmetadata(struct preloaded_file *, uint64_t);
306 int	elf32_load_modmetadata(struct preloaded_file *, uint64_t);
307 #endif
308 
309 /*
310  * Support for commands
311  */
312 struct bootblk_command
313 {
314 	const char	*c_name;
315 	const char	*c_desc;
316 	bootblk_cmd_t	*c_fn;
317 };
318 
319 #define	COMMAND_SET(tag, key, desc, func)				\
320     static bootblk_cmd_t func;						\
321     static struct bootblk_command _cmd_ ## tag = { key, desc, func };	\
322     DATA_SET(Xcommand_set, _cmd_ ## tag)
323 
324 SET_DECLARE(Xcommand_set, struct bootblk_command);
325 
326 /*
327  * The intention of the architecture switch is to provide a convenient
328  * encapsulation of the interface between the bootstrap MI and MD code.
329  * MD code may selectively populate the switch at runtime based on the
330  * actual configuration of the target system.
331  */
332 struct arch_switch
333 {
334 	/* Automatically load modules as required by detected hardware */
335 	int	(*arch_autoload)(void);
336 	/* Locate the device for (name), return pointer to tail in (*path) */
337 	int	(*arch_getdev)(void **dev, const char *name, const char **path);
338 	/*
339 	 * Copy from local address space to module address space,
340 	 * similar to bcopy()
341 	 */
342 	ssize_t	(*arch_copyin)(const void *src, vm_offset_t dest,
343 		const size_t len);
344 	/*
345 	 * Copy to local address space from module address space,
346 	 * similar to bcopy()
347 	 */
348 	ssize_t	(*arch_copyout)(const vm_offset_t src, void *dest,
349 				const size_t len);
350 	/* Read from file to module address space, same semantics as read() */
351 	ssize_t	(*arch_readin)(const int fd, vm_offset_t dest,
352 		const size_t len);
353 	/* Perform ISA byte port I/O (only for systems with ISA) */
354 	int	(*arch_isainb)(int port);
355 	void	(*arch_isaoutb)(int port, int value);
356 
357 	/*
358 	 * Interface to adjust the load address according to the "object"
359 	 * being loaded.
360 	 */
361 	vm_offset_t (*arch_loadaddr)(uint_t type, void *data, vm_offset_t addr);
362 #define	LOAD_ELF	1	/* data points to the ELF header. */
363 #define	LOAD_RAW	2	/* data points to the module file name. */
364 #define	LOAD_KERN	3	/* data points to the kernel file name. */
365 #define	LOAD_MEM	4	/* data points to int for buffer size. */
366 	/*
367 	 * Interface to release the load address.
368 	 */
369 	void	(*arch_free_loadaddr)(vm_offset_t addr, size_t pages);
370 
371 	/*
372 	 * Interface to inform MD code about a loaded (ELF) segment. This
373 	 * can be used to flush caches and/or set up translations.
374 	 */
375 #ifdef __elfN
376 	void	(*arch_loadseg)(Elf_Ehdr *eh, Elf_Phdr *ph, uint64_t delta);
377 #else
378 	void	(*arch_loadseg)(void *eh, void *ph, uint64_t delta);
379 #endif
380 
381 	/* Probe ZFS pool(s), if needed. */
382 	void	(*arch_zfs_probe)(void);
383 
384 	/* Return the hypervisor name/type or NULL if not virtualized. */
385 	const char *(*arch_hypervisor)(void);
386 };
387 extern struct arch_switch archsw;
388 
389 /* This must be provided by the MD code, but should it be in the archsw? */
390 void	delay(int delay);
391 
392 void	dev_cleanup(void);
393 
394 /*
395  * nvstore API.
396  */
397 typedef int (nvstore_getter_cb_t)(void *, const char *, void **);
398 typedef int (nvstore_setter_cb_t)(void *, int, const char *,
399     const void *, size_t);
400 typedef int (nvstore_setter_str_cb_t)(void *, const char *, const char *,
401     const char *);
402 typedef int (nvstore_unset_cb_t)(void *, const char *);
403 typedef int (nvstore_print_cb_t)(void *, void *);
404 typedef int (nvstore_iterate_cb_t)(void *, int (*)(void *, void *));
405 
406 typedef struct nvs_callbacks {
407 	nvstore_getter_cb_t	*nvs_getter;
408 	nvstore_setter_cb_t	*nvs_setter;
409 	nvstore_setter_str_cb_t *nvs_setter_str;
410 	nvstore_unset_cb_t	*nvs_unset;
411 	nvstore_print_cb_t	*nvs_print;
412 	nvstore_iterate_cb_t	*nvs_iterate;
413 } nvs_callbacks_t;
414 
415 int nvstore_init(const char *, nvs_callbacks_t *, void *);
416 int nvstore_fini(const char *);
417 void *nvstore_get_store(const char *);
418 int nvstore_print(void *);
419 int nvstore_get_var(void *, const char *, void **);
420 int nvstore_set_var(void *, int, const char *, void *, size_t);
421 int nvstore_set_var_from_string(void *, const char *, const char *,
422     const char *);
423 int nvstore_unset_var(void *, const char *);
424 
425 #define	CTASSERT(x)	_Static_assert(x, "compile-time assertion failed")
426 
427 #endif /* !_BOOTSTRAP_H_ */
428