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 /* Commands and return values; nonzero return sets command_errmsg != NULL */
  37 typedef int     (bootblk_cmd_t)(int argc, char *argv[]);
  38 #define COMMAND_ERRBUFSZ        (256)
  39 extern const char *command_errmsg;
  40 extern char     command_errbuf[COMMAND_ERRBUFSZ];
  41 #define CMD_OK          0
  42 #define CMD_WARN        1
  43 #define CMD_ERROR       2
  44 #define CMD_CRIT        3
  45 #define CMD_FATAL       4
  46
  47 /* interp.c */
  48 void    interact(void);
  49 void    interp_emit_prompt(void);
  50 int     interp_builtin_cmd(int argc, char *argv[]);
  51
  52 /* Called by interp.c for interp_*.c embedded interpreters */
  53 int     interp_include(const char *filename);   /* Execute commands from filename */
  54 void    interp_init(void);                      /* Initialize interpreater */
  55 int     interp_run(const char *line);           /* Run a single command */
  56
  57 /* interp_backslash.c */
  58 char    *backslash(const char *str);
  59
  60 /* interp_parse.c */
  61 int     parse(int *argc, char ***argv, const char *str);
  62
  63 /* boot.c */
  64 void    autoboot_maybe(void);
  65 int     getrootmount(char *rootdev);
  66 int     bootenv_flags(void);
  67 void    bootenv_set(int);
  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(int fd, vm_offset_t dest, size_t len, off_t off);
  76 void    *alloc_pread(int 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 *devdata, int rw, daddr_t blk,
  92                         size_t size, char *buf, size_t *rsize);
  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     void        (* c_probe)(struct console *cp);        /* set c_flags to match hardware */
 111     int         (* c_init)(int arg);                    /* reinit XXX may need more args */
 112     void        (* c_out)(int c);                       /* emit c */
 113     int         (* c_in)(void);                         /* wait for and return input */
 114     int         (* c_ready)(void);                      /* return nonzer if input waiting */
 115 };
 116 extern struct console   *consoles[];
 117 void            cons_probe(void);
 118
 119 /*
 120  * Plug-and-play enumerator/configurator interface.
 121  */
 122 struct pnphandler
 123 {
 124     const char  *pp_name;               /* handler/bus name */
 125     void        (* pp_enumerate)(void); /* enumerate PnP devices, add to chain */
 126 };
 127
 128 struct pnpident
 129 {
 130     char                        *id_ident;      /* ASCII identifier, actual format varies with bus/handler */
 131     STAILQ_ENTRY(pnpident)      id_link;
 132 };
 133
 134 struct pnpinfo
 135 {
 136     char                        *pi_desc;       /* ASCII description, optional */
 137     int                         pi_revision;    /* optional revision (or -1) if not supported */
 138     char                        *pi_module;     /* module/args nominated to handle device */
 139     int                         pi_argc;        /* module arguments */
 140     char                        **pi_argv;
 141     struct pnphandler           *pi_handler;    /* handler which detected this device */
 142     STAILQ_HEAD(,pnpident)      pi_ident;       /* list of identifiers */
 143     STAILQ_ENTRY(pnpinfo)       pi_link;
 144 };
 145
 146 STAILQ_HEAD(pnpinfo_stql, pnpinfo);
 147
 148 extern struct pnphandler        *pnphandlers[];         /* provided by MD code */
 149
 150 void                    pnp_addident(struct pnpinfo *pi, char *ident);
 151 struct pnpinfo          *pnp_allocinfo(void);
 152 void                    pnp_freeinfo(struct pnpinfo *pi);
 153 void                    pnp_addinfo(struct pnpinfo *pi);
 154 char                    *pnp_eisaformat(uint8_t *data);
 155
 156 /*
 157  *  < 0 - No ISA in system
 158  * == 0 - Maybe ISA, search for read data port
 159  *  > 0 - ISA in system, value is read data port address
 160  */
 161 extern int                      isapnp_readport;
 162
 163 /*
 164  * Version information
 165  */
 166 extern char bootprog_info[];
 167
 168 /*
 169  * Preloaded file metadata header.
 170  *
 171  * Metadata are allocated on our heap, and copied into kernel space
 172  * before executing the kernel.
 173  */
 174 struct file_metadata
 175 {
 176     size_t                      md_size;
 177     uint16_t                    md_type;
 178     struct file_metadata        *md_next;
 179     char                        md_data[1];     /* data are immediately appended */
 180 };
 181
 182 struct preloaded_file;
 183 struct mod_depend;
 184
 185 struct kernel_module
 186 {
 187     char                        *m_name;        /* module name */
 188     int                         m_version;      /* module version */
 189 /*    char                      *m_args;*/      /* arguments for the module */
 190     struct preloaded_file       *m_fp;
 191     struct kernel_module        *m_next;
 192 };
 193
 194 /*
 195  * Preloaded file information. Depending on type, file can contain
 196  * additional units called 'modules'.
 197  *
 198  * At least one file (the kernel) must be loaded in order to boot.
 199  * The kernel is always loaded first.
 200  *
 201  * String fields (m_name, m_type) should be dynamically allocated.
 202  */
 203 struct preloaded_file
 204 {
 205     char                        *f_name;        /* file name */
 206     char                        *f_type;        /* verbose file type, eg 'ELF kernel', 'pnptable', etc. */
 207     char                        *f_args;        /* arguments for the file */
 208     struct file_metadata        *f_metadata;    /* metadata that will be placed in the module directory */
 209     int                         f_loader;       /* index of the loader that read the file */
 210     vm_offset_t                 f_addr;         /* load address */
 211     size_t                      f_size;         /* file size */
 212     struct kernel_module        *f_modules;     /* list of modules if any */
 213     struct preloaded_file       *f_next;        /* next file */
 214 };
 215
 216 struct file_format
 217 {
 218     /* Load function must return EFTYPE if it can't handle the module supplied */
 219     int         (* l_load)(char *filename, uint64_t dest, struct preloaded_file **result);
 220     /* Only a loader that will load a kernel (first module) should have an exec handler */
 221     int         (* l_exec)(struct preloaded_file *mp);
 222 };
 223
 224 extern struct file_format       *file_formats[];        /* supplied by consumer */
 225 extern struct preloaded_file    *preloaded_files;
 226
 227 int                     mod_load(char *name, struct mod_depend *verinfo, int argc, char *argv[]);
 228 int                     mod_loadkld(const char *name, int argc, char *argv[]);
 229 void                    unload(void);
 230
 231 struct preloaded_file *file_alloc(void);
 232 struct preloaded_file *file_findfile(const char *name, const char *type);
 233 struct file_metadata *file_findmetadata(struct preloaded_file *fp, int type);
 234 struct preloaded_file *file_loadraw(const char *name, char *type, int insert);
 235 void file_discard(struct preloaded_file *fp);
 236 void file_addmetadata(struct preloaded_file *fp, int type, size_t size, void *p);
 237 int  file_addmodule(struct preloaded_file *fp, char *modname, int version,
 238         struct kernel_module **newmp);
 239 void file_removemetadata(struct preloaded_file *fp);
 240
 241 /* MI module loaders */
 242 #ifdef __elfN
 243 /* Relocation types. */
 244 #define ELF_RELOC_REL   1
 245 #define ELF_RELOC_RELA  2
 246
 247 /* Relocation offset for some architectures */
 248 extern uint64_t __elfN(relocation_offset);
 249
 250 struct elf_file;
 251 typedef Elf_Addr (symaddr_fn)(struct elf_file *ef, Elf_Size symidx);
 252
 253 int     __elfN(loadfile)(char *filename, uint64_t dest, struct preloaded_file **result);
 254 int     __elfN(obj_loadfile)(char *filename, uint64_t dest,
 255             struct preloaded_file **result);
 256 int     __elfN(reloc)(struct elf_file *ef, symaddr_fn *symaddr,
 257             const void *reldata, int reltype, Elf_Addr relbase,
 258             Elf_Addr dataaddr, void *data, size_t len);
 259 int __elfN(loadfile_raw)(char *filename, uint64_t dest,
 260             struct preloaded_file **result, int multiboot);
 261 int __elfN(load_modmetadata)(struct preloaded_file *fp, uint64_t dest);
 262 #endif
 263
 264 /*
 265  * Support for commands
 266  */
 267 struct bootblk_command
 268 {
 269     const char          *c_name;
 270     const char          *c_desc;
 271     bootblk_cmd_t       *c_fn;
 272 };
 273
 274 #define COMMAND_SET(tag, key, desc, func)                               \
 275     static bootblk_cmd_t func;                                          \
 276     static struct bootblk_command _cmd_ ## tag = { key, desc, func };   \
 277     DATA_SET(Xcommand_set, _cmd_ ## tag)
 278
 279 SET_DECLARE(Xcommand_set, struct bootblk_command);
 280
 281 /*
 282  * The intention of the architecture switch is to provide a convenient
 283  * encapsulation of the interface between the bootstrap MI and MD code.
 284  * MD code may selectively populate the switch at runtime based on the
 285  * actual configuration of the target system.
 286  */
 287 struct arch_switch
 288 {
 289     /* Automatically load modules as required by detected hardware */
 290     int         (*arch_autoload)(void);
 291     /* Locate the device for (name), return pointer to tail in (*path) */
 292     int         (*arch_getdev)(void **dev, const char *name, const char **path);
 293     /* Copy from local address space to module address space, similar to bcopy() */
 294     ssize_t     (*arch_copyin)(const void *src, vm_offset_t dest,
 295                                const size_t len);
 296     /* Copy to local address space from module address space, similar to bcopy() */
 297     ssize_t     (*arch_copyout)(const vm_offset_t src, void *dest,
 298                                 const size_t len);
 299     /* Read from file to module address space, same semantics as read() */
 300     ssize_t     (*arch_readin)(const int fd, vm_offset_t dest,
 301                                const size_t len);
 302     /* Perform ISA byte port I/O (only for systems with ISA) */
 303     int         (*arch_isainb)(int port);
 304     void        (*arch_isaoutb)(int port, int value);
 305
 306     /*
 307      * Interface to adjust the load address according to the "object"
 308      * being loaded.
 309      */
 310     uint64_t    (*arch_loadaddr)(u_int type, void *data, uint64_t addr);
 311 #define LOAD_ELF        1       /* data points to the ELF header. */
 312 #define LOAD_RAW        2       /* data points to the file name. */
 313
 314     /*
 315      * Interface to inform MD code about a loaded (ELF) segment. This
 316      * can be used to flush caches and/or set up translations.
 317      */
 318 #ifdef __elfN
 319     void        (*arch_loadseg)(Elf_Ehdr *eh, Elf_Phdr *ph, uint64_t delta);
 320 #else
 321     void        (*arch_loadseg)(void *eh, void *ph, uint64_t delta);
 322 #endif
 323
 324     /* Probe ZFS pool(s), if needed. */
 325     void        (*arch_zfs_probe)(void);
 326
 327     /* For kexec-type loaders, get ksegment structure */
 328     void        (*arch_kexec_kseg_get)(int *nseg, void **kseg);
 329 };
 330 extern struct arch_switch archsw;
 331
 332 /* This must be provided by the MD code, but should it be in the archsw? */
 333 void    delay(int delay);
 334
 335 void    dev_cleanup(void);
 336
 337 time_t  time(time_t *tloc);
 338
 339 #ifndef CTASSERT
 340 #define CTASSERT(x)     _Static_assert(x, "compile-time assertion failed")
 341 #endif
 342
 343 #endif /* !_BOOTSTRAP_H_ */