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