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