1 files changed, 418 insertions, 0 deletions
diff --git a/usr/src/boot/common/bootstrap.h b/usr/src/boot/common/bootstrap.h
new file mode 100644
index 0000000000..689905ae68
--- /dev/null
+++ b/usr/src/boot/common/bootstrap.h
@@ -0,0 +1,418 @@
+/*
+ * Copyright (c) 1998 Michael Smith <msmith@freebsd.org>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+ * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+ * SUCH DAMAGE.
+ */
+
+#ifndef _BOOTSTRAP_H_
+#define	_BOOTSTRAP_H_
+
+#include <sys/types.h>
+#include <sys/queue.h>
+#include <sys/linker_set.h>
+#include <stdbool.h>
+
+/* Commands and return values; nonzero return sets command_errmsg != NULL */
+typedef int	(bootblk_cmd_t)(int argc, char *argv[]);
+#define	COMMAND_ERRBUFSZ	(256)
+extern const char	*command_errmsg;
+extern char	command_errbuf[COMMAND_ERRBUFSZ];
+#define	CMD_OK		0
+#define	CMD_WARN	1
+#define	CMD_ERROR	2
+#define	CMD_CRIT	3
+#define	CMD_FATAL	4
+
+/* interp.c */
+void	interact(const char *rc);
+int	include(const char *filename);
+
+/* interp_backslash.c */
+char	*backslash(char *str);
+
+/* interp_parse.c */
+int	parse(int *argc, char ***argv, char *str);
+
+/* interp_forth.c */
+void	bf_init(char *rc);
+int	bf_run(char *line);
+
+/* boot.c */
+int	autoboot(int timeout, char *prompt);
+void	autoboot_maybe(void);
+int	getrootmount(char *rootdev);
+
+/* misc.c */
+char	*unargv(int argc, char *argv[]);
+void	hexdump(caddr_t region, size_t len);
+size_t	strlenout(vm_offset_t str);
+char	*strdupout(vm_offset_t str);
+void	kern_bzero(vm_offset_t dest, size_t len);
+int	kern_pread(int fd, vm_offset_t dest, size_t len, off_t off);
+void	*alloc_pread(int fd, off_t off, size_t len);
+
+/* bcache.c */
+void	bcache_init(size_t nblks, size_t bsize);
+void	bcache_add_dev(int);
+void	*bcache_allocate(void);
+void	bcache_free(void *);
+int	bcache_strategy(void *devdata, int rw, daddr_t blk,
+    size_t size, char *buf, size_t *rsize);
+
+/*
+ * Disk block cache
+ */
+struct bcache_devdata
+{
+	int	(*dv_strategy)(void *devdata, int rw, daddr_t blk,
+		size_t size, char *buf, size_t *rsize);
+	void	*dv_devdata;
+	void	*dv_cache;
+};
+
+/*
+ * Modular console support.
+ */
+struct console
+{
+	const char	*c_name;
+	const char	*c_desc;
+	int		c_flags;
+#define	C_PRESENTIN	(1<<0)		/* console can provide input */
+#define	C_PRESENTOUT	(1<<1)		/* console can provide output */
+#define	C_ACTIVEIN	(1<<2)		/* user wants input from console */
+#define	C_ACTIVEOUT	(1<<3)		/* user wants output to console */
+#define	C_WIDEOUT	(1<<4)		/* c_out routine groks wide chars */
+#define	C_MODERAW	(1<<5)		/* raw mode */
+
+	/* set c_flags to match hardware */
+	void	(*c_probe)(struct console *);
+	/* reinit XXX may need more args */
+	int		(*c_init)(struct console *, int);
+	/* emit c */
+	void		(*c_out)(struct console *, int);
+	/* wait for and return input */
+	int		(*c_in)(struct console *);
+	/* return nonzero if input is waiting */
+	int		(*c_ready)(struct console *);
+	int		(*c_ioctl)(struct console *, int, void *);
+	/* Print device info */
+	void		(*c_devinfo)(struct console *);
+	void		*c_private;	/* private data */
+};
+extern struct console	*consoles[];
+void	cons_probe(void);
+void	cons_mode(int);
+void	autoload_font(bool);
+
+/*
+ * Plug-and-play enumerator/configurator interface.
+ */
+struct pnphandler
+{
+	const char	*pp_name;		/* handler/bus name */
+	/* enumerate PnP devices, add to chain */
+	void		(*pp_enumerate)(void);
+};
+
+struct pnpident
+{
+	/* ASCII identifier, actual format varies with bus/handler */
+	char			*id_ident;
+	STAILQ_ENTRY(pnpident)	id_link;
+};
+
+struct pnpinfo
+{
+	/* ASCII description, optional */
+	char			*pi_desc;
+	/* optional revision (or -1) if not supported */
+	int			pi_revision;
+	/* module/args nominated to handle device */
+	char			*pi_module;
+	/* module arguments */
+	int			pi_argc;
+	char			**pi_argv;
+	/* handler which detected this device */
+	struct pnphandler	*pi_handler;
+	/* list of identifiers */
+	STAILQ_HEAD(, pnpident)	pi_ident;
+	STAILQ_ENTRY(pnpinfo)	pi_link;
+};
+
+STAILQ_HEAD(pnpinfo_stql, pnpinfo);
+
+extern struct pnphandler *pnphandlers[];	/* provided by MD code */
+
+void			pnp_addident(struct pnpinfo *pi, char *ident);
+struct pnpinfo		*pnp_allocinfo(void);
+void			pnp_freeinfo(struct pnpinfo *pi);
+void			pnp_addinfo(struct pnpinfo *pi);
+char			*pnp_eisaformat(uint8_t *data);
+
+/*
+ *  < 0	- No ISA in system
+ * == 0	- Maybe ISA, search for read data port
+ *  > 0	- ISA in system, value is read data port address
+ */
+extern int			isapnp_readport;
+
+/*
+ * Version information
+ */
+extern char bootprog_info[];
+
+/*
+ * Preloaded file metadata header.
+ *
+ * Metadata are allocated on our heap, and copied into kernel space
+ * before executing the kernel.
+ */
+struct file_metadata
+{
+	size_t			md_size;
+	uint16_t		md_type;
+	struct file_metadata	*md_next;
+	/* data are immediately appended */
+	char			md_data[1];
+};
+
+struct preloaded_file;
+struct mod_depend;
+
+struct kernel_module
+{
+	char			*m_name;	/* module name */
+	int			m_version;	/* module version */
+	char			*m_args;	/* arguments for the module */
+	struct preloaded_file	*m_fp;
+	struct kernel_module	*m_next;
+};
+
+/*
+ * Preloaded file information. Depending on type, file can contain
+ * additional units called 'modules'.
+ *
+ * At least one file (the kernel) must be loaded in order to boot.
+ * The kernel is always loaded first.
+ *
+ * String fields (m_name, m_type) should be dynamically allocated.
+ */
+struct preloaded_file
+{
+	char			*f_name;	/* file name */
+	/* verbose file type, eg 'ELF kernel', 'pnptable', etc. */
+	char			*f_type;
+	char			*f_args;	/* arguments for the file */
+	/* metadata that will be placed in the module directory */
+	struct file_metadata	*f_metadata;
+	/* index of the loader that read the file */
+	int			f_loader;
+	vm_offset_t		f_addr;		/* load address */
+	size_t			f_size;		/* file size */
+	struct kernel_module	*f_modules;	/* list of modules if any */
+	struct preloaded_file	*f_next;	/* next file */
+};
+
+struct file_format
+{
+	/*
+	 * Load function must return EFTYPE if it can't handle the module
+	 * supplied.
+	 */
+	int (*l_load)(char *, uint64_t, struct preloaded_file **);
+	/*
+	 * Only a loader that will load a kernel (first module)
+	 * should have an exec handler.
+	 */
+	int (*l_exec)(struct preloaded_file *);
+};
+
+extern struct file_format *file_formats[];	/* supplied by consumer */
+extern struct preloaded_file *preloaded_files;
+
+int mod_load(char *name, struct mod_depend *verinfo, int argc, char *argv[]);
+int mod_loadkld(const char *name, int argc, char *argv[]);
+void unload(void);
+
+struct preloaded_file *file_alloc(void);
+struct preloaded_file *file_findfile(const char *name, const char *type);
+struct file_metadata *file_findmetadata(struct preloaded_file *fp, int type);
+struct preloaded_file *file_loadraw(const char *name, char *type, int argc,
+	char **argv, int insert);
+void file_discard(struct preloaded_file *fp);
+void file_addmetadata(struct preloaded_file *, int, size_t, void *);
+int  file_addmodule(struct preloaded_file *, char *, int,
+	struct kernel_module **);
+void build_environment_module(void);
+void build_font_module(void);
+vm_offset_t bi_copyenv(vm_offset_t);
+
+/* MI module loaders */
+#ifdef __elfN
+/* Relocation types. */
+#define	ELF_RELOC_REL	1
+#define	ELF_RELOC_RELA	2
+
+/* Relocation offset for some architectures */
+extern uint64_t __elfN(relocation_offset);
+
+struct elf_file;
+typedef Elf_Addr(symaddr_fn)(struct elf_file *, Elf_Size);
+
+int	elf64_loadfile(char *, uint64_t, struct preloaded_file **);
+int	elf32_loadfile(char *, uint64_t, struct preloaded_file **);
+int	elf64_obj_loadfile(char *, uint64_t, struct preloaded_file **);
+int	elf32_obj_loadfile(char *, uint64_t, struct preloaded_file **);
+int	__elfN(reloc)(struct elf_file *ef, symaddr_fn *symaddr,
+	    const void *reldata, int reltype, Elf_Addr relbase,
+	    Elf_Addr dataaddr, void *data, size_t len);
+int	elf64_loadfile_raw(char *, uint64_t, struct preloaded_file **, int);
+int	elf32_loadfile_raw(char *, uint64_t, struct preloaded_file **, int);
+int	elf64_load_modmetadata(struct preloaded_file *, uint64_t);
+int	elf32_load_modmetadata(struct preloaded_file *, uint64_t);
+#endif
+
+/*
+ * Support for commands
+ */
+struct bootblk_command
+{
+	const char	*c_name;
+	const char	*c_desc;
+	bootblk_cmd_t	*c_fn;
+};
+
+#define	COMMAND_SET(tag, key, desc, func)				\
+    static bootblk_cmd_t func;						\
+    static struct bootblk_command _cmd_ ## tag = { key, desc, func };	\
+    DATA_SET(Xcommand_set, _cmd_ ## tag)
+
+SET_DECLARE(Xcommand_set, struct bootblk_command);
+
+/*
+ * The intention of the architecture switch is to provide a convenient
+ * encapsulation of the interface between the bootstrap MI and MD code.
+ * MD code may selectively populate the switch at runtime based on the
+ * actual configuration of the target system.
+ */
+struct arch_switch
+{
+	/* Automatically load modules as required by detected hardware */
+	int	(*arch_autoload)(void);
+	/* Locate the device for (name), return pointer to tail in (*path) */
+	int	(*arch_getdev)(void **dev, const char *name, const char **path);
+	/*
+	 * Copy from local address space to module address space,
+	 * similar to bcopy()
+	 */
+	ssize_t	(*arch_copyin)(const void *src, vm_offset_t dest,
+		const size_t len);
+	/*
+	 * Copy to local address space from module address space,
+	 * similar to bcopy()
+	 */
+	ssize_t	(*arch_copyout)(const vm_offset_t src, void *dest,
+				const size_t len);
+	/* Read from file to module address space, same semantics as read() */
+	ssize_t	(*arch_readin)(const int fd, vm_offset_t dest,
+		const size_t len);
+	/* Perform ISA byte port I/O (only for systems with ISA) */
+	int	(*arch_isainb)(int port);
+	void	(*arch_isaoutb)(int port, int value);
+
+	/*
+	 * Interface to adjust the load address according to the "object"
+	 * being loaded.
+	 */
+	vm_offset_t (*arch_loadaddr)(uint_t type, void *data, vm_offset_t addr);
+#define	LOAD_ELF	1	/* data points to the ELF header. */
+#define	LOAD_RAW	2	/* data points to the module file name. */
+#define	LOAD_KERN	3	/* data points to the kernel file name. */
+#define	LOAD_MEM	4	/* data points to int for buffer size. */
+	/*
+	 * Interface to release the load address.
+	 */
+	void	(*arch_free_loadaddr)(vm_offset_t addr, size_t pages);
+
+	/*
+	 * Interface to inform MD code about a loaded (ELF) segment. This
+	 * can be used to flush caches and/or set up translations.
+	 */
+#ifdef __elfN
+	void	(*arch_loadseg)(Elf_Ehdr *eh, Elf_Phdr *ph, uint64_t delta);
+#else
+	void	(*arch_loadseg)(void *eh, void *ph, uint64_t delta);
+#endif
+
+	/* Probe ZFS pool(s), if needed. */
+	void	(*arch_zfs_probe)(void);
+
+	/* Return the hypervisor name/type or NULL if not virtualized. */
+	const char *(*arch_hypervisor)(void);
+};
+extern struct arch_switch archsw;
+
+/* This must be provided by the MD code, but should it be in the archsw? */
+void	delay(int delay);
+
+void	dev_cleanup(void);
+
+/*
+ * nvstore API.
+ */
+typedef int (nvstore_getter_cb_t)(void *, const char *, void **);
+typedef int (nvstore_setter_cb_t)(void *, int, const char *,
+    const void *, size_t);
+typedef int (nvstore_setter_str_cb_t)(void *, const char *, const char *,
+    const char *);
+typedef int (nvstore_unset_cb_t)(void *, const char *);
+typedef int (nvstore_print_cb_t)(void *, void *);
+typedef int (nvstore_iterate_cb_t)(void *, int (*)(void *, void *));
+
+typedef struct nvs_callbacks {
+	nvstore_getter_cb_t	*nvs_getter;
+	nvstore_setter_cb_t	*nvs_setter;
+	nvstore_setter_str_cb_t *nvs_setter_str;
+	nvstore_unset_cb_t	*nvs_unset;
+	nvstore_print_cb_t	*nvs_print;
+	nvstore_iterate_cb_t	*nvs_iterate;
+} nvs_callbacks_t;
+
+int nvstore_init(const char *, nvs_callbacks_t *, void *);
+int nvstore_fini(const char *);
+void *nvstore_get_store(const char *);
+int nvstore_print(void *);
+int nvstore_get_var(void *, const char *, void **);
+int nvstore_set_var(void *, int, const char *, void *, size_t);
+int nvstore_set_var_from_string(void *, const char *, const char *,
+    const char *);
+int nvstore_unset_var(void *, const char *);
+
+#ifndef CTASSERT		/* Allow lint to override */
+#define	CTASSERT(x)		_CTASSERT(x, __LINE__)
+#define	_CTASSERT(x, y)		__CTASSERT(x, y)
+#define	__CTASSERT(x, y)	typedef char __assert ## y[(x) ? 1 : -1]
+#endif
+
+#endif /* !_BOOTSTRAP_H_ */