bootstrap.h revision 344413
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: stable/11/stand/common/bootstrap.h 344413 2019-02-21 03:18:12Z kevans $ 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/* Commands and return values; nonzero return sets command_errmsg != NULL */ 37typedef int (bootblk_cmd_t)(int argc, char *argv[]); 38#define COMMAND_ERRBUFSZ (256) 39extern const char *command_errmsg; 40extern char command_errbuf[COMMAND_ERRBUFSZ]; 41#define CMD_OK 0 42#define CMD_WARN 1 43#define CMD_ERROR 2 44#define CMD_CRIT 3 45#define CMD_FATAL 4 46 47/* interp.c */ 48void interact(void); 49void interp_emit_prompt(void); 50int interp_builtin_cmd(int argc, char *argv[]); 51 52/* Called by interp.c for interp_*.c embedded interpreters */ 53int interp_include(const char *filename); /* Execute commands from filename */ 54void interp_init(void); /* Initialize interpreater */ 55int interp_run(const char *line); /* Run a single command */ 56 57/* interp_backslash.c */ 58char *backslash(const char *str); 59 60/* interp_parse.c */ 61int parse(int *argc, char ***argv, const char *str); 62 63/* boot.c */ 64void autoboot_maybe(void); 65int getrootmount(char *rootdev); 66 67/* misc.c */ 68char *unargv(int argc, char *argv[]); 69void hexdump(caddr_t region, size_t len); 70size_t strlenout(vm_offset_t str); 71char *strdupout(vm_offset_t str); 72void kern_bzero(vm_offset_t dest, size_t len); 73int kern_pread(int fd, vm_offset_t dest, size_t len, off_t off); 74void *alloc_pread(int fd, off_t off, size_t len); 75 76/* bcache.c */ 77void bcache_init(size_t nblks, size_t bsize); 78void bcache_add_dev(int); 79void *bcache_allocate(void); 80void bcache_free(void *); 81int bcache_strategy(void *devdata, int rw, daddr_t blk, size_t size, 82 char *buf, size_t *rsize); 83 84/* 85 * Disk block cache 86 */ 87struct bcache_devdata 88{ 89 int (*dv_strategy)(void *devdata, int rw, daddr_t blk, 90 size_t size, char *buf, size_t *rsize); 91 void *dv_devdata; 92 void *dv_cache; 93}; 94 95/* 96 * Modular console support. 97 */ 98struct console 99{ 100 const char *c_name; 101 const char *c_desc; 102 int c_flags; 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 */ 113}; 114extern struct console *consoles[]; 115void cons_probe(void); 116 117/* 118 * Plug-and-play enumerator/configurator interface. 119 */ 120struct pnphandler 121{ 122 const char *pp_name; /* handler/bus name */ 123 void (* pp_enumerate)(void); /* enumerate PnP devices, add to chain */ 124}; 125 126struct pnpident 127{ 128 char *id_ident; /* ASCII identifier, actual format varies with bus/handler */ 129 STAILQ_ENTRY(pnpident) id_link; 130}; 131 132struct pnpinfo 133{ 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 */ 138 char **pi_argv; 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; 142}; 143 144STAILQ_HEAD(pnpinfo_stql, pnpinfo); 145 146extern struct pnphandler *pnphandlers[]; /* provided by MD code */ 147 148void pnp_addident(struct pnpinfo *pi, char *ident); 149struct pnpinfo *pnp_allocinfo(void); 150void pnp_freeinfo(struct pnpinfo *pi); 151void pnp_addinfo(struct pnpinfo *pi); 152char *pnp_eisaformat(uint8_t *data); 153 154/* 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 158 */ 159extern int isapnp_readport; 160 161/* 162 * Version information 163 */ 164extern char bootprog_info[]; 165 166/* 167 * Interpreter information 168 */ 169extern const char bootprog_interp[]; 170#define INTERP_DEFINE(interpstr) \ 171const char bootprog_interp[] = "$Interpreter:" interpstr 172 173 174/* 175 * Preloaded file metadata header. 176 * 177 * Metadata are allocated on our heap, and copied into kernel space 178 * before executing the kernel. 179 */ 180struct file_metadata 181{ 182 size_t md_size; 183 uint16_t md_type; 184 struct file_metadata *md_next; 185 char md_data[1]; /* data are immediately appended */ 186}; 187 188struct preloaded_file; 189struct mod_depend; 190 191struct kernel_module 192{ 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; 198}; 199 200/* 201 * Preloaded file information. Depending on type, file can contain 202 * additional units called 'modules'. 203 * 204 * At least one file (the kernel) must be loaded in order to boot. 205 * The kernel is always loaded first. 206 * 207 * String fields (m_name, m_type) should be dynamically allocated. 208 */ 209struct preloaded_file 210{ 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 */ 220}; 221 222struct file_format 223{ 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); 228}; 229 230extern struct file_format *file_formats[]; /* supplied by consumer */ 231extern struct preloaded_file *preloaded_files; 232 233int mod_load(char *name, struct mod_depend *verinfo, int argc, char *argv[]); 234int mod_loadkld(const char *name, int argc, char *argv[]); 235void unload(void); 236 237struct preloaded_file *file_alloc(void); 238struct preloaded_file *file_findfile(const char *name, const char *type); 239struct file_metadata *file_findmetadata(struct preloaded_file *fp, int type); 240struct preloaded_file *file_loadraw(const char *name, char *type, int insert); 241void file_discard(struct preloaded_file *fp); 242void file_addmetadata(struct preloaded_file *fp, int type, size_t size, void *p); 243int file_addmodule(struct preloaded_file *fp, char *modname, int version, 244 struct kernel_module **newmp); 245void file_removemetadata(struct preloaded_file *fp); 246 247/* MI module loaders */ 248#ifdef __elfN 249/* Relocation types. */ 250#define ELF_RELOC_REL 1 251#define ELF_RELOC_RELA 2 252 253/* Relocation offset for some architectures */ 254extern uint64_t __elfN(relocation_offset); 255 256struct elf_file; 257typedef Elf_Addr (symaddr_fn)(struct elf_file *ef, Elf_Size symidx); 258 259int __elfN(loadfile)(char *filename, uint64_t dest, struct preloaded_file **result); 260int __elfN(obj_loadfile)(char *filename, uint64_t dest, 261 struct preloaded_file **result); 262int __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); 265int __elfN(loadfile_raw)(char *filename, uint64_t dest, 266 struct preloaded_file **result, int multiboot); 267int __elfN(load_modmetadata)(struct preloaded_file *fp, uint64_t dest); 268#endif 269 270/* 271 * Support for commands 272 */ 273struct bootblk_command 274{ 275 const char *c_name; 276 const char *c_desc; 277 bootblk_cmd_t *c_fn; 278}; 279 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) 284 285SET_DECLARE(Xcommand_set, struct bootblk_command); 286 287/* 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. 292 */ 293struct arch_switch 294{ 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, 301 const size_t len); 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, 304 const size_t len); 305 /* Read from file to module address space, same semantics as read() */ 306 ssize_t (*arch_readin)(const int fd, vm_offset_t dest, 307 const size_t len); 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); 311 312 /* 313 * Interface to adjust the load address according to the "object" 314 * being loaded. 315 */ 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. */ 319 320 /* 321 * Interface to inform MD code about a loaded (ELF) segment. This 322 * can be used to flush caches and/or set up translations. 323 */ 324#ifdef __elfN 325 void (*arch_loadseg)(Elf_Ehdr *eh, Elf_Phdr *ph, uint64_t delta); 326#else 327 void (*arch_loadseg)(void *eh, void *ph, uint64_t delta); 328#endif 329 330 /* Probe ZFS pool(s), if needed. */ 331 void (*arch_zfs_probe)(void); 332 333 /* For kexec-type loaders, get ksegment structure */ 334 void (*arch_kexec_kseg_get)(int *nseg, void **kseg); 335}; 336extern struct arch_switch archsw; 337 338/* This must be provided by the MD code, but should it be in the archsw? */ 339void delay(int delay); 340 341void dev_cleanup(void); 342 343time_t time(time_t *tloc); 344 345#ifndef CTASSERT 346#define CTASSERT(x) _Static_assert(x, "compile-time assertion failed") 347#endif 348 349#endif /* !_BOOTSTRAP_H_ */ 350