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