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 *filename);   /* Execute commands from filename */
  56 void    interp_init(void);                      /* Initialize interpreater */
  57 int     interp_run(const char *line);           /* 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 *devdata, int rw, daddr_t blk,
  91                         size_t size, char *buf, size_t *rsize);
  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     void        (* c_probe)(struct console *cp);        /* set c_flags to match hardware */
 110     int         (* c_init)(int arg);                    /* reinit XXX may need more args */
 111     void        (* c_out)(int c);                       /* emit c */
 112     int         (* c_in)(void);                         /* wait for and return input */
 113     int         (* c_ready)(void);                      /* return nonzer if input waiting */
 114 };
 115 extern struct console   *consoles[];
 116 void            cons_probe(void);
 117
 118 /*
 119  * Plug-and-play enumerator/configurator interface.
 120  */
 121 struct pnphandler
 122 {
 123     const char  *pp_name;               /* handler/bus name */
 124     void        (* pp_enumerate)(void); /* enumerate PnP devices, add to chain */
 125 };
 126
 127 struct pnpident
 128 {
 129     char                        *id_ident;      /* ASCII identifier, actual format varies with bus/handler */
 130     STAILQ_ENTRY(pnpident)      id_link;
 131 };
 132
 133 struct pnpinfo
 134 {
 135     char                        *pi_desc;       /* ASCII description, optional */
 136     int                         pi_revision;    /* optional revision (or -1) if not supported */
 137     char                        *pi_module;     /* module/args nominated to handle device */
 138     int                         pi_argc;        /* module arguments */
 139     char                        **pi_argv;
 140     struct pnphandler           *pi_handler;    /* handler which detected this device */
 141     STAILQ_HEAD(,pnpident)      pi_ident;       /* list of identifiers */
 142     STAILQ_ENTRY(pnpinfo)       pi_link;
 143 };
 144
 145 STAILQ_HEAD(pnpinfo_stql, pnpinfo);
 146
 147 extern struct pnphandler        *pnphandlers[];         /* provided by MD code */
 148
 149 void                    pnp_addident(struct pnpinfo *pi, char *ident);
 150 struct pnpinfo          *pnp_allocinfo(void);
 151 void                    pnp_freeinfo(struct pnpinfo *pi);
 152 void                    pnp_addinfo(struct pnpinfo *pi);
 153 char                    *pnp_eisaformat(uint8_t *data);
 154
 155 /*
 156  *  < 0 - No ISA in system
 157  * == 0 - Maybe ISA, search for read data port
 158  *  > 0 - ISA in system, value is read data port address
 159  */
 160 extern int                      isapnp_readport;
 161
 162 /*
 163  * Version information
 164  */
 165 extern char bootprog_info[];
 166
 167 /*
 168  * Interpreter information
 169  */
 170 extern const char bootprog_interp[];
 171 #define INTERP_DEFINE(interpstr) \
 172 const char bootprog_interp[] = "$Interpreter:" interpstr
 173
 174
 175 /*
 176  * Preloaded file metadata header.
 177  *
 178  * Metadata are allocated on our heap, and copied into kernel space
 179  * before executing the kernel.
 180  */
 181 struct file_metadata
 182 {
 183     size_t                      md_size;
 184     uint16_t                    md_type;
 185     struct file_metadata        *md_next;
 186     char                        md_data[1];     /* data are immediately appended */
 187 };
 188
 189 struct preloaded_file;
 190 struct mod_depend;
 191
 192 struct kernel_module
 193 {
 194     char                        *m_name;        /* module name */
 195     int                         m_version;      /* module version */
 196 /*    char                      *m_args;*/      /* arguments for the module */
 197     struct preloaded_file       *m_fp;
 198     struct kernel_module        *m_next;
 199 };
 200
 201 /*
 202  * Preloaded file information. Depending on type, file can contain
 203  * additional units called 'modules'.
 204  *
 205  * At least one file (the kernel) must be loaded in order to boot.
 206  * The kernel is always loaded first.
 207  *
 208  * String fields (m_name, m_type) should be dynamically allocated.
 209  */
 210 struct preloaded_file
 211 {
 212     char                        *f_name;        /* file name */
 213     char                        *f_type;        /* verbose file type, eg 'ELF kernel', 'pnptable', etc. */
 214     char                        *f_args;        /* arguments for the file */
 215     struct file_metadata        *f_metadata;    /* metadata that will be placed in the module directory */
 216     int                         f_loader;       /* index of the loader that read the file */
 217     vm_offset_t                 f_addr;         /* load address */
 218     size_t                      f_size;         /* file size */
 219     struct kernel_module        *f_modules;     /* list of modules if any */
 220     struct preloaded_file       *f_next;        /* next file */
 221 };
 222
 223 struct file_format
 224 {
 225     /* Load function must return EFTYPE if it can't handle the module supplied */
 226     int         (* l_load)(char *filename, uint64_t dest, struct preloaded_file **result);
 227     /* Only a loader that will load a kernel (first module) should have an exec handler */
 228     int         (* l_exec)(struct preloaded_file *mp);
 229 };
 230
 231 extern struct file_format       *file_formats[];        /* supplied by consumer */
 232 extern struct preloaded_file    *preloaded_files;
 233
 234 int                     mod_load(char *name, struct mod_depend *verinfo, int argc, char *argv[]);
 235 int                     mod_loadkld(const char *name, int argc, char *argv[]);
 236 void                    unload(void);
 237
 238 struct preloaded_file *file_alloc(void);
 239 struct preloaded_file *file_findfile(const char *name, const char *type);
 240 struct file_metadata *file_findmetadata(struct preloaded_file *fp, int type);
 241 struct preloaded_file *file_loadraw(const char *name, char *type, int insert);
 242 void file_discard(struct preloaded_file *fp);
 243 void file_addmetadata(struct preloaded_file *fp, int type, size_t size, void *p);
 244 int  file_addmodule(struct preloaded_file *fp, char *modname, int version,
 245         struct kernel_module **newmp);
 246 void file_removemetadata(struct preloaded_file *fp);
 247
 248 /* MI module loaders */
 249 #ifdef __elfN
 250 /* Relocation types. */
 251 #define ELF_RELOC_REL   1
 252 #define ELF_RELOC_RELA  2
 253
 254 /* Relocation offset for some architectures */
 255 extern uint64_t __elfN(relocation_offset);
 256
 257 struct elf_file;
 258 typedef Elf_Addr (symaddr_fn)(struct elf_file *ef, Elf_Size symidx);
 259
 260 int     __elfN(loadfile)(char *filename, uint64_t dest, struct preloaded_file **result);
 261 int     __elfN(obj_loadfile)(char *filename, uint64_t dest,
 262             struct preloaded_file **result);
 263 int     __elfN(reloc)(struct elf_file *ef, symaddr_fn *symaddr,
 264             const void *reldata, int reltype, Elf_Addr relbase,
 265             Elf_Addr dataaddr, void *data, size_t len);
 266 int __elfN(loadfile_raw)(char *filename, uint64_t dest,
 267             struct preloaded_file **result, int multiboot);
 268 int __elfN(load_modmetadata)(struct preloaded_file *fp, uint64_t dest);
 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)(readin_handle_t 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     uint64_t    (*arch_loadaddr)(u_int type, void *data, uint64_t addr);
 318 #define LOAD_ELF        1       /* data points to the ELF header. */
 319 #define LOAD_RAW        2       /* data points to the file name. */
 320
 321     /*
 322      * Interface to inform MD code about a loaded (ELF) segment. This
 323      * can be used to flush caches and/or set up translations.
 324      */
 325 #ifdef __elfN
 326     void        (*arch_loadseg)(Elf_Ehdr *eh, Elf_Phdr *ph, uint64_t delta);
 327 #else
 328     void        (*arch_loadseg)(void *eh, void *ph, uint64_t delta);
 329 #endif
 330
 331     /* Probe ZFS pool(s), if needed. */
 332     void        (*arch_zfs_probe)(void);
 333
 334     /* Return the hypervisor name/type or NULL if not virtualized. */
 335     const char *(*arch_hypervisor)(void);
 336
 337     /* For kexec-type loaders, get ksegment structure */
 338     void        (*arch_kexec_kseg_get)(int *nseg, void **kseg);
 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 /*
 348  * nvstore API.
 349  */
 350 typedef int (nvstore_getter_cb_t)(void *, const char *, void **);
 351 typedef int (nvstore_setter_cb_t)(void *, int, const char *,
 352     const void *, size_t);
 353 typedef int (nvstore_setter_str_cb_t)(void *, const char *, const char *,
 354     const char *);
 355 typedef int (nvstore_unset_cb_t)(void *, const char *);
 356 typedef int (nvstore_print_cb_t)(void *, void *);
 357 typedef int (nvstore_iterate_cb_t)(void *, int (*)(void *, void *));
 358
 359 typedef struct nvs_callbacks {
 360         nvstore_getter_cb_t     *nvs_getter;
 361         nvstore_setter_cb_t     *nvs_setter;
 362         nvstore_setter_str_cb_t *nvs_setter_str;
 363         nvstore_unset_cb_t      *nvs_unset;
 364         nvstore_print_cb_t      *nvs_print;
 365         nvstore_iterate_cb_t    *nvs_iterate;
 366 } nvs_callbacks_t;
 367
 368 int nvstore_init(const char *, nvs_callbacks_t *, void *);
 369 int nvstore_fini(const char *);
 370 void *nvstore_get_store(const char *);
 371 int nvstore_print(void *);
 372 int nvstore_get_var(void *, const char *, void **);
 373 int nvstore_set_var(void *, int, const char *, void *, size_t);
 374 int nvstore_set_var_from_string(void *, const char *, const char *,
 375     const char *);
 376 int nvstore_unset_var(void *, const char *);
 377
 378 #ifndef CTASSERT
 379 #define CTASSERT(x)     _Static_assert(x, "compile-time assertion failed")
 380 #endif
 381
 382 #endif /* !_BOOTSTRAP_H_ */