usr/src/boot/sys/boot/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
  27 #ifndef _BOOTSTRAP_H_
  28 #define _BOOTSTRAP_H_
  29
  30 #include <sys/types.h>
  31 #include <stdbool.h>
  32 #include <sys/queue.h>
  33 #include <sys/linker_set.h>
  34
  35 /* Commands and return values; nonzero return sets command_errmsg != NULL */
  36 typedef int     (bootblk_cmd_t)(int argc, char *argv[]);
  37 #define COMMAND_ERRBUFSZ        (256)
  38 extern const char       *command_errmsg;
  39 extern char     command_errbuf[COMMAND_ERRBUFSZ];
  40 #define CMD_OK          0
  41 #define CMD_WARN        1
  42 #define CMD_ERROR       2
  43 #define CMD_CRIT        3
  44 #define CMD_FATAL       4
  45
  46 /* interp.c */
  47 void    interact(const char *rc);
  48 int     include(const char *filename);
  49
  50 /* interp_backslash.c */
  51 char    *backslash(char *str);
  52
  53 /* interp_parse.c */
  54 int     parse(int *argc, char ***argv, char *str);
  55
  56 /* interp_forth.c */
  57 void    bf_init(char *rc);
  58 int     bf_run(char *line);
  59
  60 /* boot.c */
  61 int     autoboot(int timeout, char *prompt);
  62 void    autoboot_maybe(void);
  63 int     getrootmount(char *rootdev);
  64
  65 /* misc.c */
  66 char    *unargv(int argc, char *argv[]);
  67 void    hexdump(caddr_t region, size_t len);
  68 size_t  strlenout(vm_offset_t str);
  69 char    *strdupout(vm_offset_t str);
  70 void    kern_bzero(vm_offset_t dest, size_t len);
  71 int     kern_pread(int fd, vm_offset_t dest, size_t len, off_t off);
  72 void    *alloc_pread(int fd, off_t off, size_t len);
  73
  74 /* bcache.c */
  75 void    bcache_init(size_t nblks, size_t bsize);
  76 void    bcache_add_dev(int);
  77 void    *bcache_allocate(void);
  78 void    bcache_free(void *);
  79 int     bcache_strategy(void *devdata, int rw, daddr_t blk,
  80     size_t size, char *buf, size_t *rsize);
  81
  82 /*
  83  * Disk block cache
  84  */
  85 struct bcache_devdata
  86 {
  87     int         (*dv_strategy)(void *devdata, int rw, daddr_t blk,
  88                     size_t size, char *buf, size_t *rsize);
  89     void        *dv_devdata;
  90     void        *dv_cache;
  91 };
  92
  93 /*
  94  * Modular console support.
  95  */
  96 struct console
  97 {
  98     const char  *c_name;
  99     const char  *c_desc;
 100     int         c_flags;
 101 #define C_PRESENTIN     (1<<0)      /* console can provide input */
 102 #define C_PRESENTOUT    (1<<1)      /* console can provide output */
 103 #define C_ACTIVEIN      (1<<2)      /* user wants input from console */
 104 #define C_ACTIVEOUT     (1<<3)      /* user wants output to console */
 105 #define C_WIDEOUT       (1<<4)      /* c_out routine groks wide chars */
 106 #define C_MODERAW       (1<<5)      /* raw mode */
 107     void        (*c_probe)(struct console *);   /* set c_flags to match hardware */
 108     int         (*c_init)(struct console *, int);       /* reinit XXX may need more args */
 109     void        (*c_out)(struct console *, int);        /* emit c */
 110     int         (*c_in)(struct console *);      /* wait for and return input */
 111     int         (*c_ready)(struct console *);   /* return nonzer if input waiting */
 112     int         (*c_ioctl)(struct console *, int, void *);
 113     void        *c_private;             /* private data */
 114 };
 115 extern struct console   *consoles[];
 116 void            cons_probe(void);
 117 void            cons_mode(int);
 118 void            autoload_font(void);
 119
 120 /*
 121  * Plug-and-play enumerator/configurator interface.
 122  */
 123 struct pnphandler
 124 {
 125     const char  *pp_name;               /* handler/bus name */
 126     void        (* pp_enumerate)(void); /* enumerate PnP devices, add to chain */
 127 };
 128
 129 struct pnpident
 130 {
 131     char                        *id_ident;      /* ASCII identifier, actual format varies with bus/handler */
 132     STAILQ_ENTRY(pnpident)      id_link;
 133 };
 134
 135 struct pnpinfo
 136 {
 137     char                        *pi_desc;       /* ASCII description, optional */
 138     int                         pi_revision;    /* optional revision (or -1) if not supported */
 139     char                        *pi_module;     /* module/args nominated to handle device */
 140     int                         pi_argc;        /* module arguments */
 141     char                        **pi_argv;
 142     struct pnphandler           *pi_handler;    /* handler which detected this device */
 143     STAILQ_HEAD(,pnpident)      pi_ident;       /* list of identifiers */
 144     STAILQ_ENTRY(pnpinfo)       pi_link;
 145 };
 146
 147 STAILQ_HEAD(pnpinfo_stql, pnpinfo);
 148
 149 extern struct pnphandler        *pnphandlers[];         /* provided by MD code */
 150
 151 void                    pnp_addident(struct pnpinfo *pi, char *ident);
 152 struct pnpinfo          *pnp_allocinfo(void);
 153 void                    pnp_freeinfo(struct pnpinfo *pi);
 154 void                    pnp_addinfo(struct pnpinfo *pi);
 155 char                    *pnp_eisaformat(u_int8_t *data);
 156
 157 /*
 158  *  < 0 - No ISA in system
 159  * == 0 - Maybe ISA, search for read data port
 160  *  > 0 - ISA in system, value is read data port address
 161  */
 162 extern int                      isapnp_readport;
 163
 164 /*
 165  * Version information
 166  */
 167 extern char bootprog_info[];
 168
 169 /*
 170  * Preloaded file metadata header.
 171  *
 172  * Metadata are allocated on our heap, and copied into kernel space
 173  * before executing the kernel.
 174  */
 175 struct file_metadata
 176 {
 177     size_t                      md_size;
 178     u_int16_t                   md_type;
 179     struct file_metadata        *md_next;
 180     char                        md_data[1];     /* data are immediately appended */
 181 };
 182
 183 struct preloaded_file;
 184 struct mod_depend;
 185
 186 struct kernel_module
 187 {
 188     char                        *m_name;        /* module name */
 189     int                         m_version;      /* module version */
 190     char                        *m_args;        /* arguments for the module */
 191     struct preloaded_file       *m_fp;
 192     struct kernel_module        *m_next;
 193 };
 194
 195 /*
 196  * Preloaded file information. Depending on type, file can contain
 197  * additional units called 'modules'.
 198  *
 199  * At least one file (the kernel) must be loaded in order to boot.
 200  * The kernel is always loaded first.
 201  *
 202  * String fields (m_name, m_type) should be dynamically allocated.
 203  */
 204 struct preloaded_file
 205 {
 206     char                        *f_name;        /* file name */
 207     char                        *f_type;        /* verbose file type, eg 'ELF kernel', 'pnptable', etc. */
 208     char                        *f_args;        /* arguments for the file */
 209     struct file_metadata        *f_metadata;    /* metadata that will be placed in the module directory */
 210     int                         f_loader;       /* index of the loader that read the file */
 211     vm_offset_t                 f_addr;         /* load address */
 212     size_t                      f_size;         /* file size */
 213     struct kernel_module        *f_modules;     /* list of modules if any */
 214     struct preloaded_file       *f_next;        /* next file */
 215 };
 216
 217 struct file_format
 218 {
 219     /* Load function must return EFTYPE if it can't handle the module supplied */
 220     int         (* l_load)(char *filename, u_int64_t dest, struct preloaded_file **result);
 221     /* Only a loader that will load a kernel (first module) should have an exec handler */
 222     int         (* l_exec)(struct preloaded_file *mp);
 223 };
 224
 225 extern struct file_format       *file_formats[];        /* supplied by consumer */
 226 extern struct preloaded_file    *preloaded_files;
 227
 228 int                     mod_load(char *name, struct mod_depend *verinfo, int argc, char *argv[]);
 229 int                     mod_loadkld(const char *name, int argc, char *argv[]);
 230 void                    unload(void);
 231
 232 struct preloaded_file *file_alloc(void);
 233 struct preloaded_file *file_findfile(const char *name, const char *type);
 234 struct file_metadata *file_findmetadata(struct preloaded_file *fp, int type);
 235 struct preloaded_file *file_loadraw(const char *name, char *type, int argc,
 236         char **argv, int insert);
 237 void file_discard(struct preloaded_file *fp);
 238 void file_addmetadata(struct preloaded_file *fp, int type, size_t size, void *p);
 239 int  file_addmodule(struct preloaded_file *fp, char *modname, int version,
 240         struct kernel_module **newmp);
 241 void build_environment_module(void);
 242 void build_font_module(void);
 243 vm_offset_t bi_copyenv(vm_offset_t);
 244 bool sha1(void *, size_t, uint8_t *);
 245
 246 /* MI module loaders */
 247 #ifdef __elfN
 248 /* Relocation types. */
 249 #define ELF_RELOC_REL   1
 250 #define ELF_RELOC_RELA  2
 251
 252 /* Relocation offset for some architectures */
 253 extern u_int64_t __elfN(relocation_offset);
 254
 255 struct elf_file;
 256 typedef Elf_Addr (symaddr_fn)(struct elf_file *ef, Elf_Size symidx);
 257
 258 int     elf64_loadfile(char *, uint64_t, struct preloaded_file **);
 259 int     elf32_loadfile(char *, uint64_t, struct preloaded_file **);
 260 int     elf64_obj_loadfile(char *, uint64_t, struct preloaded_file **);
 261 int     elf32_obj_loadfile(char *, uint64_t, struct preloaded_file **);
 262 int     __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);
 265 int     elf64_loadfile_raw(char *, uint64_t, struct preloaded_file **, int);
 266 int     elf32_loadfile_raw(char *, uint64_t, struct preloaded_file **, int);
 267 int     elf64_load_modmetadata(struct preloaded_file *, uint64_t);
 268 int     elf32_load_modmetadata(struct preloaded_file *, uint64_t);
 269 #endif
 270
 271 /*
 272  * Support for commands
 273  */
 274 struct bootblk_command
 275 {
 276     const char          *c_name;
 277     const char          *c_desc;
 278     bootblk_cmd_t       *c_fn;
 279 };
 280
 281 #define COMMAND_SET(tag, key, desc, func)                               \
 282     static bootblk_cmd_t func;                                          \
 283     static struct bootblk_command _cmd_ ## tag = { key, desc, func };   \
 284     DATA_SET(Xcommand_set, _cmd_ ## tag)
 285
 286 SET_DECLARE(Xcommand_set, struct bootblk_command);
 287
 288 /*
 289  * The intention of the architecture switch is to provide a convenient
 290  * encapsulation of the interface between the bootstrap MI and MD code.
 291  * MD code may selectively populate the switch at runtime based on the
 292  * actual configuration of the target system.
 293  */
 294 struct arch_switch
 295 {
 296     /* Automatically load modules as required by detected hardware */
 297     int         (*arch_autoload)(void);
 298     /* Locate the device for (name), return pointer to tail in (*path) */
 299     int         (*arch_getdev)(void **dev, const char *name, const char **path);
 300     /* Copy from local address space to module address space, similar to bcopy() */
 301     ssize_t     (*arch_copyin)(const void *src, vm_offset_t dest,
 302                                const size_t len);
 303     /* Copy to local address space from module address space, similar to bcopy() */
 304     ssize_t     (*arch_copyout)(const vm_offset_t src, void *dest,
 305                                 const size_t len);
 306     /* Read from file to module address space, same semantics as read() */
 307     ssize_t     (*arch_readin)(const int fd, vm_offset_t dest,
 308                                const size_t len);
 309     /* Perform ISA byte port I/O (only for systems with ISA) */
 310     int         (*arch_isainb)(int port);
 311     void        (*arch_isaoutb)(int port, int value);
 312
 313     /*
 314      * Interface to adjust the load address according to the "object"
 315      * being loaded.
 316      */
 317     vm_offset_t (*arch_loadaddr)(u_int type, void *data, vm_offset_t addr);
 318 #define LOAD_ELF        1       /* data points to the ELF header. */
 319 #define LOAD_RAW        2       /* data points to the module file name. */
 320 #define LOAD_KERN       3       /* data points to the kernel file name. */
 321 #define LOAD_MEM        4       /* data points to int for buffer size. */
 322     /*
 323      * Interface to release the load address.
 324      */
 325     void        (*arch_free_loadaddr)(vm_offset_t addr, size_t pages);
 326
 327     /*
 328      * Interface to inform MD code about a loaded (ELF) segment. This
 329      * can be used to flush caches and/or set up translations.
 330      */
 331 #ifdef __elfN
 332     void        (*arch_loadseg)(Elf_Ehdr *eh, Elf_Phdr *ph, uint64_t delta);
 333 #else
 334     void        (*arch_loadseg)(void *eh, void *ph, uint64_t delta);
 335 #endif
 336
 337     /* Probe ZFS pool(s), if needed. */
 338     void        (*arch_zfs_probe)(void);
 339 };
 340 extern struct arch_switch archsw;
 341
 342 /* This must be provided by the MD code, but should it be in the archsw? */
 343 void    delay(int delay);
 344
 345 void    dev_cleanup(void);
 346
 347 #ifndef CTASSERT                /* Allow lint to override */
 348 #define CTASSERT(x)             _CTASSERT(x, __LINE__)
 349 #define _CTASSERT(x, y)         __CTASSERT(x, y)
 350 #define __CTASSERT(x, y)        typedef char __assert ## y[(x) ? 1 : -1]
 351 #endif
 352
 353 #endif /* !_BOOTSTRAP_H_ */