stand/common/bootstrap.h

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