2 * Copyright (c) 1998 Michael Smith <msmith@freebsd.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 #include <sys/types.h>
33 #include <sys/queue.h>
34 #include <sys/linker_set.h>
36 /* Commands and return values; nonzero return sets command_errmsg != NULL */
37 typedef int (bootblk_cmd_t)(int argc, char *argv[]);
38 #define COMMAND_ERRBUFSZ (256)
39 extern const char *command_errmsg;
40 extern char command_errbuf[COMMAND_ERRBUFSZ];
49 void interp_emit_prompt(void);
50 int interp_builtin_cmd(int argc, char *argv[]);
52 /* Called by interp.c for interp_*.c embedded interpreters */
53 int interp_include(const char *filename); /* Execute commands from filename */
54 void interp_init(void); /* Initialize interpreater */
55 int interp_run(const char *line); /* Run a single command */
57 /* interp_backslash.c */
58 char *backslash(const char *str);
61 int parse(int *argc, char ***argv, const char *str);
64 void autoboot_maybe(void);
65 int getrootmount(char *rootdev);
68 char *unargv(int argc, char *argv[]);
69 void hexdump(caddr_t region, size_t len);
70 size_t strlenout(vm_offset_t str);
71 char *strdupout(vm_offset_t str);
72 void kern_bzero(vm_offset_t dest, size_t len);
73 int kern_pread(int fd, vm_offset_t dest, size_t len, off_t off);
74 void *alloc_pread(int fd, off_t off, size_t len);
77 void bcache_init(size_t nblks, size_t bsize);
78 void bcache_add_dev(int);
79 void *bcache_allocate(void);
80 void bcache_free(void *);
81 int bcache_strategy(void *devdata, int rw, daddr_t blk, size_t size,
82 char *buf, size_t *rsize);
89 int (*dv_strategy)(void *devdata, int rw, daddr_t blk,
90 size_t size, char *buf, size_t *rsize);
96 * Modular console support.
103 #define C_PRESENTIN (1<<0) /* console can provide input */
104 #define C_PRESENTOUT (1<<1) /* console can provide output */
105 #define C_ACTIVEIN (1<<2) /* user wants input from console */
106 #define C_ACTIVEOUT (1<<3) /* user wants output to console */
107 #define C_WIDEOUT (1<<4) /* c_out routine groks wide chars */
108 void (* c_probe)(struct console *cp); /* set c_flags to match hardware */
109 int (* c_init)(int arg); /* reinit XXX may need more args */
110 void (* c_out)(int c); /* emit c */
111 int (* c_in)(void); /* wait for and return input */
112 int (* c_ready)(void); /* return nonzer if input waiting */
114 extern struct console *consoles[];
115 void cons_probe(void);
118 * Plug-and-play enumerator/configurator interface.
122 const char *pp_name; /* handler/bus name */
123 void (* pp_enumerate)(void); /* enumerate PnP devices, add to chain */
128 char *id_ident; /* ASCII identifier, actual format varies with bus/handler */
129 STAILQ_ENTRY(pnpident) id_link;
134 char *pi_desc; /* ASCII description, optional */
135 int pi_revision; /* optional revision (or -1) if not supported */
136 char *pi_module; /* module/args nominated to handle device */
137 int pi_argc; /* module arguments */
139 struct pnphandler *pi_handler; /* handler which detected this device */
140 STAILQ_HEAD(,pnpident) pi_ident; /* list of identifiers */
141 STAILQ_ENTRY(pnpinfo) pi_link;
144 STAILQ_HEAD(pnpinfo_stql, pnpinfo);
146 extern struct pnphandler *pnphandlers[]; /* provided by MD code */
148 void pnp_addident(struct pnpinfo *pi, char *ident);
149 struct pnpinfo *pnp_allocinfo(void);
150 void pnp_freeinfo(struct pnpinfo *pi);
151 void pnp_addinfo(struct pnpinfo *pi);
152 char *pnp_eisaformat(uint8_t *data);
155 * < 0 - No ISA in system
156 * == 0 - Maybe ISA, search for read data port
157 * > 0 - ISA in system, value is read data port address
159 extern int isapnp_readport;
162 * Version information
164 extern char bootprog_info[];
167 * Interpreter information
169 extern const char bootprog_interp[];
170 #define INTERP_DEFINE(interpstr) \
171 const char bootprog_interp[] = "$Interpreter:" interpstr
175 * Preloaded file metadata header.
177 * Metadata are allocated on our heap, and copied into kernel space
178 * before executing the kernel.
184 struct file_metadata *md_next;
185 char md_data[1]; /* data are immediately appended */
188 struct preloaded_file;
193 char *m_name; /* module name */
194 int m_version; /* module version */
195 /* char *m_args;*/ /* arguments for the module */
196 struct preloaded_file *m_fp;
197 struct kernel_module *m_next;
201 * Preloaded file information. Depending on type, file can contain
202 * additional units called 'modules'.
204 * At least one file (the kernel) must be loaded in order to boot.
205 * The kernel is always loaded first.
207 * String fields (m_name, m_type) should be dynamically allocated.
209 struct preloaded_file
211 char *f_name; /* file name */
212 char *f_type; /* verbose file type, eg 'ELF kernel', 'pnptable', etc. */
213 char *f_args; /* arguments for the file */
214 struct file_metadata *f_metadata; /* metadata that will be placed in the module directory */
215 int f_loader; /* index of the loader that read the file */
216 vm_offset_t f_addr; /* load address */
217 size_t f_size; /* file size */
218 struct kernel_module *f_modules; /* list of modules if any */
219 struct preloaded_file *f_next; /* next file */
224 /* Load function must return EFTYPE if it can't handle the module supplied */
225 int (* l_load)(char *filename, uint64_t dest, struct preloaded_file **result);
226 /* Only a loader that will load a kernel (first module) should have an exec handler */
227 int (* l_exec)(struct preloaded_file *mp);
230 extern struct file_format *file_formats[]; /* supplied by consumer */
231 extern struct preloaded_file *preloaded_files;
233 int mod_load(char *name, struct mod_depend *verinfo, int argc, char *argv[]);
234 int mod_loadkld(const char *name, int argc, char *argv[]);
237 struct preloaded_file *file_alloc(void);
238 struct preloaded_file *file_findfile(const char *name, const char *type);
239 struct file_metadata *file_findmetadata(struct preloaded_file *fp, int type);
240 struct preloaded_file *file_loadraw(const char *name, char *type, int insert);
241 void file_discard(struct preloaded_file *fp);
242 void file_addmetadata(struct preloaded_file *fp, int type, size_t size, void *p);
243 int file_addmodule(struct preloaded_file *fp, char *modname, int version,
244 struct kernel_module **newmp);
245 void file_removemetadata(struct preloaded_file *fp);
247 /* MI module loaders */
249 /* Relocation types. */
250 #define ELF_RELOC_REL 1
251 #define ELF_RELOC_RELA 2
253 /* Relocation offset for some architectures */
254 extern uint64_t __elfN(relocation_offset);
257 typedef Elf_Addr (symaddr_fn)(struct elf_file *ef, Elf_Size symidx);
259 int __elfN(loadfile)(char *filename, uint64_t dest, struct preloaded_file **result);
260 int __elfN(obj_loadfile)(char *filename, uint64_t dest,
261 struct preloaded_file **result);
262 int __elfN(reloc)(struct elf_file *ef, symaddr_fn *symaddr,
263 const void *reldata, int reltype, Elf_Addr relbase,
264 Elf_Addr dataaddr, void *data, size_t len);
265 int __elfN(loadfile_raw)(char *filename, uint64_t dest,
266 struct preloaded_file **result, int multiboot);
267 int __elfN(load_modmetadata)(struct preloaded_file *fp, uint64_t dest);
271 * Support for commands
273 struct bootblk_command
280 #define COMMAND_SET(tag, key, desc, func) \
281 static bootblk_cmd_t func; \
282 static struct bootblk_command _cmd_ ## tag = { key, desc, func }; \
283 DATA_SET(Xcommand_set, _cmd_ ## tag)
285 SET_DECLARE(Xcommand_set, struct bootblk_command);
288 * The intention of the architecture switch is to provide a convenient
289 * encapsulation of the interface between the bootstrap MI and MD code.
290 * MD code may selectively populate the switch at runtime based on the
291 * actual configuration of the target system.
295 /* Automatically load modules as required by detected hardware */
296 int (*arch_autoload)(void);
297 /* Locate the device for (name), return pointer to tail in (*path) */
298 int (*arch_getdev)(void **dev, const char *name, const char **path);
299 /* Copy from local address space to module address space, similar to bcopy() */
300 ssize_t (*arch_copyin)(const void *src, vm_offset_t dest,
302 /* Copy to local address space from module address space, similar to bcopy() */
303 ssize_t (*arch_copyout)(const vm_offset_t src, void *dest,
305 /* Read from file to module address space, same semantics as read() */
306 ssize_t (*arch_readin)(const int fd, vm_offset_t dest,
308 /* Perform ISA byte port I/O (only for systems with ISA) */
309 int (*arch_isainb)(int port);
310 void (*arch_isaoutb)(int port, int value);
313 * Interface to adjust the load address according to the "object"
316 uint64_t (*arch_loadaddr)(u_int type, void *data, uint64_t addr);
317 #define LOAD_ELF 1 /* data points to the ELF header. */
318 #define LOAD_RAW 2 /* data points to the file name. */
321 * Interface to inform MD code about a loaded (ELF) segment. This
322 * can be used to flush caches and/or set up translations.
325 void (*arch_loadseg)(Elf_Ehdr *eh, Elf_Phdr *ph, uint64_t delta);
327 void (*arch_loadseg)(void *eh, void *ph, uint64_t delta);
330 /* Probe ZFS pool(s), if needed. */
331 void (*arch_zfs_probe)(void);
333 /* Return the hypervisor name/type or NULL if not virtualized. */
334 const char *(*arch_hypervisor)(void);
336 /* For kexec-type loaders, get ksegment structure */
337 void (*arch_kexec_kseg_get)(int *nseg, void **kseg);
339 extern struct arch_switch archsw;
341 /* This must be provided by the MD code, but should it be in the archsw? */
342 void delay(int delay);
344 void dev_cleanup(void);
346 time_t time(time_t *tloc);
349 #define CTASSERT(x) _Static_assert(x, "compile-time assertion failed")
352 #ifdef LOADER_VERIEXEC
353 #include <verify_file.h>
356 #endif /* !_BOOTSTRAP_H_ */