xref: /freebsd/stand/common/bootstrap.h (revision 32100375a661c1e16588ddfa7b90ca8d26cb9786)
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  * $FreeBSD$
27  */
28 
29 #ifndef _BOOTSTRAP_H_
30 #define	_BOOTSTRAP_H_
31 
32 #include <sys/types.h>
33 #include <sys/queue.h>
34 #include <sys/linker_set.h>
35 
36 #include "readin.h"
37 
38 /* Commands and return values; nonzero return sets command_errmsg != NULL */
39 typedef int	(bootblk_cmd_t)(int argc, char *argv[]);
40 #define	COMMAND_ERRBUFSZ	(256)
41 extern const char *command_errmsg;
42 extern char	command_errbuf[COMMAND_ERRBUFSZ];
43 #define CMD_OK		0
44 #define CMD_WARN	1
45 #define CMD_ERROR	2
46 #define CMD_CRIT	3
47 #define CMD_FATAL	4
48 
49 /* interp.c */
50 void	interact(void);
51 void	interp_emit_prompt(void);
52 int	interp_builtin_cmd(int argc, char *argv[]);
53 
54 /* Called by interp.c for interp_*.c embedded interpreters */
55 int	interp_include(const char *filename);	/* Execute commands from filename */
56 void	interp_init(void);			/* Initialize interpreater */
57 int	interp_run(const char *line);		/* Run a single command */
58 
59 /* interp_backslash.c */
60 char	*backslash(const char *str);
61 
62 /* interp_parse.c */
63 int	parse(int *argc, char ***argv, const char *str);
64 
65 /* boot.c */
66 void	autoboot_maybe(void);
67 int	getrootmount(char *rootdev);
68 
69 /* misc.c */
70 char	*unargv(int argc, char *argv[]);
71 void	hexdump(caddr_t region, size_t len);
72 size_t	strlenout(vm_offset_t str);
73 char	*strdupout(vm_offset_t str);
74 void	kern_bzero(vm_offset_t dest, size_t len);
75 int	kern_pread(readin_handle_t fd, vm_offset_t dest, size_t len, off_t off);
76 void	*alloc_pread(readin_handle_t fd, off_t off, size_t len);
77 
78 /* bcache.c */
79 void	bcache_init(size_t nblks, size_t bsize);
80 void	bcache_add_dev(int);
81 void	*bcache_allocate(void);
82 void	bcache_free(void *);
83 int	bcache_strategy(void *devdata, int rw, daddr_t blk, size_t size,
84 			char *buf, size_t *rsize);
85 
86 /*
87  * Disk block cache
88  */
89 struct bcache_devdata
90 {
91     int         (*dv_strategy)(void *devdata, int rw, daddr_t blk,
92 			size_t size, char *buf, size_t *rsize);
93     void	*dv_devdata;
94     void	*dv_cache;
95 };
96 
97 /*
98  * Modular console support.
99  */
100 struct console
101 {
102     const char	*c_name;
103     const char	*c_desc;
104     int		c_flags;
105 #define C_PRESENTIN	(1<<0)	    /* console can provide input */
106 #define C_PRESENTOUT	(1<<1)	    /* console can provide output */
107 #define C_ACTIVEIN	(1<<2)	    /* user wants input from console */
108 #define C_ACTIVEOUT	(1<<3)	    /* user wants output to console */
109 #define	C_WIDEOUT	(1<<4)	    /* c_out routine groks wide chars */
110     void	(* c_probe)(struct console *cp);	/* set c_flags to match hardware */
111     int		(* c_init)(int arg);			/* reinit XXX may need more args */
112     void	(* c_out)(int c);			/* emit c */
113     int		(* c_in)(void);				/* wait for and return input */
114     int		(* c_ready)(void);			/* return nonzer if input waiting */
115 };
116 extern struct console	*consoles[];
117 void		cons_probe(void);
118 
119 /*
120  * Plug-and-play enumerator/configurator interface.
121  */
122 struct pnphandler
123 {
124     const char	*pp_name;		/* handler/bus name */
125     void	(* pp_enumerate)(void);	/* enumerate PnP devices, add to chain */
126 };
127 
128 struct pnpident
129 {
130     char			*id_ident;	/* ASCII identifier, actual format varies with bus/handler */
131     STAILQ_ENTRY(pnpident)	id_link;
132 };
133 
134 struct pnpinfo
135 {
136     char			*pi_desc;	/* ASCII description, optional */
137     int				pi_revision;	/* optional revision (or -1) if not supported */
138     char			*pi_module;	/* module/args nominated to handle device */
139     int				pi_argc;	/* module arguments */
140     char			**pi_argv;
141     struct pnphandler		*pi_handler;	/* handler which detected this device */
142     STAILQ_HEAD(,pnpident)	pi_ident;	/* list of identifiers */
143     STAILQ_ENTRY(pnpinfo)	pi_link;
144 };
145 
146 STAILQ_HEAD(pnpinfo_stql, pnpinfo);
147 
148 extern struct pnphandler	*pnphandlers[];		/* provided by MD code */
149 
150 void			pnp_addident(struct pnpinfo *pi, char *ident);
151 struct pnpinfo		*pnp_allocinfo(void);
152 void			pnp_freeinfo(struct pnpinfo *pi);
153 void			pnp_addinfo(struct pnpinfo *pi);
154 char			*pnp_eisaformat(uint8_t *data);
155 
156 /*
157  *  < 0	- No ISA in system
158  * == 0	- Maybe ISA, search for read data port
159  *  > 0	- ISA in system, value is read data port address
160  */
161 extern int			isapnp_readport;
162 
163 /*
164  * Version information
165  */
166 extern char bootprog_info[];
167 
168 /*
169  * Interpreter information
170  */
171 extern const char bootprog_interp[];
172 #define	INTERP_DEFINE(interpstr) \
173 const char bootprog_interp[] = "$Interpreter:" interpstr
174 
175 
176 /*
177  * Preloaded file metadata header.
178  *
179  * Metadata are allocated on our heap, and copied into kernel space
180  * before executing the kernel.
181  */
182 struct file_metadata
183 {
184     size_t			md_size;
185     uint16_t			md_type;
186     struct file_metadata	*md_next;
187     char			md_data[1];	/* data are immediately appended */
188 };
189 
190 struct preloaded_file;
191 struct mod_depend;
192 
193 struct kernel_module
194 {
195     char			*m_name;	/* module name */
196     int				m_version;	/* module version */
197 /*    char			*m_args;*/	/* arguments for the module */
198     struct preloaded_file	*m_fp;
199     struct kernel_module	*m_next;
200 };
201 
202 /*
203  * Preloaded file information. Depending on type, file can contain
204  * additional units called 'modules'.
205  *
206  * At least one file (the kernel) must be loaded in order to boot.
207  * The kernel is always loaded first.
208  *
209  * String fields (m_name, m_type) should be dynamically allocated.
210  */
211 struct preloaded_file
212 {
213     char			*f_name;	/* file name */
214     char			*f_type;	/* verbose file type, eg 'ELF kernel', 'pnptable', etc. */
215     char			*f_args;	/* arguments for the file */
216     struct file_metadata	*f_metadata;	/* metadata that will be placed in the module directory */
217     int				f_loader;	/* index of the loader that read the file */
218     vm_offset_t			f_addr;		/* load address */
219     size_t			f_size;		/* file size */
220     struct kernel_module	*f_modules;	/* list of modules if any */
221     struct preloaded_file	*f_next;	/* next file */
222 };
223 
224 struct file_format
225 {
226     /* Load function must return EFTYPE if it can't handle the module supplied */
227     int		(* l_load)(char *filename, uint64_t dest, struct preloaded_file **result);
228     /* Only a loader that will load a kernel (first module) should have an exec handler */
229     int		(* l_exec)(struct preloaded_file *mp);
230 };
231 
232 extern struct file_format	*file_formats[];	/* supplied by consumer */
233 extern struct preloaded_file	*preloaded_files;
234 
235 int			mod_load(char *name, struct mod_depend *verinfo, int argc, char *argv[]);
236 int			mod_loadkld(const char *name, int argc, char *argv[]);
237 void			unload(void);
238 
239 struct preloaded_file *file_alloc(void);
240 struct preloaded_file *file_findfile(const char *name, const char *type);
241 struct file_metadata *file_findmetadata(struct preloaded_file *fp, int type);
242 struct preloaded_file *file_loadraw(const char *name, char *type, int insert);
243 void file_discard(struct preloaded_file *fp);
244 void file_addmetadata(struct preloaded_file *fp, int type, size_t size, void *p);
245 int  file_addmodule(struct preloaded_file *fp, char *modname, int version,
246 	struct kernel_module **newmp);
247 void file_removemetadata(struct preloaded_file *fp);
248 
249 /* MI module loaders */
250 #ifdef __elfN
251 /* Relocation types. */
252 #define ELF_RELOC_REL	1
253 #define ELF_RELOC_RELA	2
254 
255 /* Relocation offset for some architectures */
256 extern uint64_t __elfN(relocation_offset);
257 
258 struct elf_file;
259 typedef Elf_Addr (symaddr_fn)(struct elf_file *ef, Elf_Size symidx);
260 
261 int	__elfN(loadfile)(char *filename, uint64_t dest, struct preloaded_file **result);
262 int	__elfN(obj_loadfile)(char *filename, uint64_t dest,
263 	    struct preloaded_file **result);
264 int	__elfN(reloc)(struct elf_file *ef, symaddr_fn *symaddr,
265 	    const void *reldata, int reltype, Elf_Addr relbase,
266 	    Elf_Addr dataaddr, void *data, size_t len);
267 int __elfN(loadfile_raw)(char *filename, uint64_t dest,
268 	    struct preloaded_file **result, int multiboot);
269 int __elfN(load_modmetadata)(struct preloaded_file *fp, uint64_t dest);
270 #endif
271 
272 /*
273  * Support for commands
274  */
275 struct bootblk_command
276 {
277     const char		*c_name;
278     const char		*c_desc;
279     bootblk_cmd_t	*c_fn;
280 };
281 
282 #define COMMAND_SET(tag, key, desc, func)				\
283     static bootblk_cmd_t func;						\
284     static struct bootblk_command _cmd_ ## tag = { key, desc, func };	\
285     DATA_SET(Xcommand_set, _cmd_ ## tag)
286 
287 SET_DECLARE(Xcommand_set, struct bootblk_command);
288 
289 /*
290  * The intention of the architecture switch is to provide a convenient
291  * encapsulation of the interface between the bootstrap MI and MD code.
292  * MD code may selectively populate the switch at runtime based on the
293  * actual configuration of the target system.
294  */
295 struct arch_switch
296 {
297     /* Automatically load modules as required by detected hardware */
298     int		(*arch_autoload)(void);
299     /* Locate the device for (name), return pointer to tail in (*path) */
300     int		(*arch_getdev)(void **dev, const char *name, const char **path);
301     /* Copy from local address space to module address space, similar to bcopy() */
302     ssize_t	(*arch_copyin)(const void *src, vm_offset_t dest,
303 			       const size_t len);
304     /* Copy to local address space from module address space, similar to bcopy() */
305     ssize_t	(*arch_copyout)(const vm_offset_t src, void *dest,
306 				const size_t len);
307     /* Read from file to module address space, same semantics as read() */
308     ssize_t	(*arch_readin)(readin_handle_t fd, vm_offset_t dest,
309 			       const size_t len);
310     /* Perform ISA byte port I/O (only for systems with ISA) */
311     int		(*arch_isainb)(int port);
312     void	(*arch_isaoutb)(int port, int value);
313 
314     /*
315      * Interface to adjust the load address according to the "object"
316      * being loaded.
317      */
318     uint64_t	(*arch_loadaddr)(u_int type, void *data, uint64_t addr);
319 #define	LOAD_ELF	1	/* data points to the ELF header. */
320 #define	LOAD_RAW	2	/* data points to the file name. */
321 
322     /*
323      * Interface to inform MD code about a loaded (ELF) segment. This
324      * can be used to flush caches and/or set up translations.
325      */
326 #ifdef __elfN
327     void	(*arch_loadseg)(Elf_Ehdr *eh, Elf_Phdr *ph, uint64_t delta);
328 #else
329     void	(*arch_loadseg)(void *eh, void *ph, uint64_t delta);
330 #endif
331 
332     /* Probe ZFS pool(s), if needed. */
333     void	(*arch_zfs_probe)(void);
334 
335     /* Return the hypervisor name/type or NULL if not virtualized. */
336     const char *(*arch_hypervisor)(void);
337 
338     /* For kexec-type loaders, get ksegment structure */
339     void	(*arch_kexec_kseg_get)(int *nseg, void **kseg);
340 };
341 extern struct arch_switch archsw;
342 
343 /* This must be provided by the MD code, but should it be in the archsw? */
344 void	delay(int delay);
345 
346 void	dev_cleanup(void);
347 
348 #ifndef CTASSERT
349 #define	CTASSERT(x)	_Static_assert(x, "compile-time assertion failed")
350 #endif
351 
352 #endif /* !_BOOTSTRAP_H_ */
353