1 /* 2 * Copyright (c) 1998 Michael Smith. 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 * From $NetBSD: stand.h,v 1.22 1997/06/26 19:17:40 drochner Exp $ 26 */ 27 28 /*- 29 * Copyright (c) 1993 30 * The Regents of the University of California. All rights reserved. 31 * 32 * Redistribution and use in source and binary forms, with or without 33 * modification, are permitted provided that the following conditions 34 * are met: 35 * 1. Redistributions of source code must retain the above copyright 36 * notice, this list of conditions and the following disclaimer. 37 * 2. Redistributions in binary form must reproduce the above copyright 38 * notice, this list of conditions and the following disclaimer in the 39 * documentation and/or other materials provided with the distribution. 40 * 3. Neither the name of the University nor the names of its contributors 41 * may be used to endorse or promote products derived from this software 42 * without specific prior written permission. 43 * 44 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 45 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 46 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 47 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 48 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 49 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 50 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 51 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 52 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 53 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 54 * SUCH DAMAGE. 55 */ 56 57 #ifndef STAND_H 58 #define STAND_H 59 60 #include <sys/types.h> 61 #include <sys/stat.h> 62 #include <sys/dirent.h> 63 #include <sys/queue.h> 64 65 /* this header intentionally exports NULL from <string.h> */ 66 #include <string.h> 67 #define strcoll(a, b) strcmp((a), (b)) 68 69 #define CHK(fmt, args...) printf("%s(%d): " fmt "\n", __func__, __LINE__ , ##args) 70 #define PCHK(fmt, args...) {printf("%s(%d): " fmt "\n", __func__, __LINE__ , ##args); getchar();} 71 72 #include <sys/errno.h> 73 74 /* special stand error codes */ 75 #define EADAPT (ELAST+1) /* bad adaptor */ 76 #define ECTLR (ELAST+2) /* bad controller */ 77 #define EUNIT (ELAST+3) /* bad unit */ 78 #define ESLICE (ELAST+4) /* bad slice */ 79 #define EPART (ELAST+5) /* bad partition */ 80 #define ERDLAB (ELAST+6) /* can't read disk label */ 81 #define EUNLAB (ELAST+7) /* unlabeled disk */ 82 #define EOFFSET (ELAST+8) /* relative seek not supported */ 83 #define ESALAST (ELAST+8) /* */ 84 85 /* 86 * LUA needs sig_atomic_t. This is defined to be long or int on all our 87 * platforms. On all but powerpc, these are all the same thing as long. 64-bit 88 * powerpc defines this as int, but long can also be accessed atomically. It's 89 * also OK because we don't have signal handlers in the boot loader. 90 */ 91 typedef long sig_atomic_t; 92 93 __BEGIN_DECLS 94 95 struct open_file; 96 97 /* 98 * This structure is used to define file system operations in a file system 99 * independent way. 100 * 101 * XXX note that filesystem providers should export a pointer to their fs_ops 102 * struct, so that consumers can reference this and thus include the 103 * filesystems that they require. 104 */ 105 struct fs_ops { 106 const char *fs_name; 107 int (*fo_open)(const char *path, struct open_file *f); 108 int (*fo_close)(struct open_file *f); 109 int (*fo_read)(struct open_file *f, void *buf, 110 size_t size, size_t *resid); 111 int (*fo_write)(struct open_file *f, const void *buf, 112 size_t size, size_t *resid); 113 off_t (*fo_seek)(struct open_file *f, off_t offset, int where); 114 int (*fo_stat)(struct open_file *f, struct stat *sb); 115 int (*fo_readdir)(struct open_file *f, struct dirent *d); 116 int (*fo_preload)(struct open_file *f); 117 int (*fo_mount)(const char *, const char *, void **); 118 int (*fo_unmount)(const char *, void *); 119 }; 120 121 /* 122 * libsa-supplied filesystems 123 */ 124 extern struct fs_ops ufs_fsops; 125 extern struct fs_ops tftp_fsops; 126 extern struct fs_ops nfs_fsops; 127 extern struct fs_ops cd9660_fsops; 128 extern struct fs_ops gzipfs_fsops; 129 extern struct fs_ops bzipfs_fsops; 130 extern struct fs_ops dosfs_fsops; 131 extern struct fs_ops ext2fs_fsops; 132 extern struct fs_ops splitfs_fsops; 133 extern struct fs_ops pkgfs_fsops; 134 extern struct fs_ops efihttp_fsops; 135 136 /* where values for lseek(2) */ 137 #define SEEK_SET 0 /* set file offset to offset */ 138 #define SEEK_CUR 1 /* set file offset to current plus offset */ 139 #define SEEK_END 2 /* set file offset to EOF plus offset */ 140 141 /* 142 * Device switch 143 */ 144 #define DEV_NAMLEN 8 /* Length of name of device class */ 145 #define DEV_DEVLEN 128 /* Length of longest device instance name */ 146 struct devdesc; 147 struct devsw { 148 const char dv_name[DEV_NAMLEN]; 149 int dv_type; /* opaque type constant */ 150 #define DEVT_NONE 0 151 #define DEVT_DISK 1 152 #define DEVT_NET 2 153 #define DEVT_CD 3 154 #define DEVT_ZFS 4 155 #define DEVT_FD 5 156 int (*dv_init)(void); /* early probe call */ 157 int (*dv_strategy)(void *devdata, int rw, daddr_t blk, 158 size_t size, char *buf, size_t *rsize); 159 int (*dv_open)(struct open_file *f, ...); 160 int (*dv_close)(struct open_file *f); 161 int (*dv_ioctl)(struct open_file *f, u_long cmd, void *data); 162 int (*dv_print)(int verbose); /* print device information */ 163 void (*dv_cleanup)(void); 164 char * (*dv_fmtdev)(struct devdesc *); 165 int (*dv_parsedev)(struct devdesc **, const char *, const char **); 166 bool (*dv_match)(struct devsw *, const char *); 167 }; 168 169 /* 170 * libsa-supplied device switch 171 */ 172 extern struct devsw netdev; 173 174 extern int errno; 175 176 /* 177 * Generic device specifier; architecture-dependent versions may be larger, but 178 * should be allowed to overlap. The larger device specifiers store more data 179 * than can fit in the generic one that's gleaned after parsing the device 180 * string, or used in some cases to indicate wildcards that match a variety of 181 * situations based on what's on the drive itself rather than what the progammer 182 * might know in advance. Information about open files is stored in d_opendata, 183 * though what's passed into the open routine may differ from what's present 184 * after the open on some configurations. 185 */ 186 struct devdesc { 187 struct devsw *d_dev; 188 int d_unit; 189 void *d_opendata; 190 }; 191 192 char *devformat(struct devdesc *d); 193 int devparse(struct devdesc **, const char *, const char **); 194 int devinit(void); 195 void dev_cleanup(void); 196 197 struct open_file { 198 int f_flags; /* see F_* below */ 199 struct devsw *f_dev; /* pointer to device operations */ 200 void *f_devdata; /* device specific data */ 201 struct fs_ops *f_ops; /* pointer to file system operations */ 202 void *f_fsdata; /* file system specific data */ 203 off_t f_offset; /* current file offset */ 204 char *f_rabuf; /* readahead buffer pointer */ 205 size_t f_ralen; /* valid data in readahead buffer */ 206 off_t f_raoffset; /* consumer offset in readahead buffer */ 207 int f_id; /* file number */ 208 TAILQ_ENTRY(open_file) f_link; /* next entry */ 209 #define SOPEN_RASIZE 512 210 }; 211 212 typedef TAILQ_HEAD(file_list, open_file) file_list_t; 213 extern file_list_t files; 214 extern struct open_file *fd2open_file(int); 215 216 /* f_flags values */ 217 #define F_READ 0x0001 /* file opened for reading */ 218 #define F_WRITE 0x0002 /* file opened for writing */ 219 #define F_RAW 0x0004 /* raw device open - no file system */ 220 #define F_NODEV 0x0008 /* network open - no device */ 221 #define F_MASK 0xFFFF 222 /* Mode modifier for strategy() */ 223 #define F_NORA (0x01 << 16) /* Disable Read-Ahead */ 224 225 #define isascii(c) (((c) & ~0x7F) == 0) 226 227 static __inline int isupper(int c) 228 { 229 return c >= 'A' && c <= 'Z'; 230 } 231 232 static __inline int islower(int c) 233 { 234 return c >= 'a' && c <= 'z'; 235 } 236 237 static __inline int isspace(int c) 238 { 239 return c == ' ' || (c >= 0x9 && c <= 0xd); 240 } 241 242 static __inline int isdigit(int c) 243 { 244 return c >= '0' && c <= '9'; 245 } 246 247 static __inline int isxdigit(int c) 248 { 249 return isdigit(c) || (c >= 'a' && c <= 'f') || (c >= 'A' && c <= 'F'); 250 } 251 252 static __inline int isalpha(int c) 253 { 254 return isupper(c) || islower(c); 255 } 256 257 static __inline int isalnum(int c) 258 { 259 return isalpha(c) || isdigit(c); 260 } 261 262 static __inline int iscntrl(int c) 263 { 264 return (c >= 0 && c < ' ') || c == 127; 265 } 266 267 static __inline int isgraph(int c) 268 { 269 return c >= '!' && c <= '~'; 270 } 271 272 static __inline int ispunct(int c) 273 { 274 return (c >= '!' && c <= '/') || (c >= ':' && c <= '@') || 275 (c >= '[' && c <= '`') || (c >= '{' && c <= '~'); 276 } 277 278 static __inline int toupper(int c) 279 { 280 return islower(c) ? c - 'a' + 'A' : c; 281 } 282 283 static __inline int tolower(int c) 284 { 285 return isupper(c) ? c - 'A' + 'a' : c; 286 } 287 288 /* sbrk emulation */ 289 extern void setheap(void *base, void *top); 290 extern char *sbrk(int incr); 291 292 extern int printf(const char *fmt, ...) __printflike(1, 2); 293 extern int asprintf(char **buf, const char *cfmt, ...) __printflike(2, 3); 294 extern int sprintf(char *buf, const char *cfmt, ...) __printflike(2, 3); 295 extern int snprintf(char *buf, size_t size, const char *cfmt, ...) __printflike(3, 4); 296 extern int vprintf(const char *fmt, __va_list); 297 extern int vsprintf(char *buf, const char *cfmt, __va_list); 298 extern int vsnprintf(char *buf, size_t size, const char *cfmt, __va_list); 299 300 extern void twiddle(u_int callerdiv); 301 extern void twiddle_divisor(u_int globaldiv); 302 303 extern void ngets(char *, int); 304 #define gets(x) ngets((x), 0) 305 extern int fgetstr(char *buf, int size, int fd); 306 307 extern int mount(const char *dev, const char *path, int flags, void *data); 308 extern int unmount(const char *dev, int flags); 309 extern int open(const char *, int); 310 #define O_RDONLY 0x0 311 #define O_WRONLY 0x1 312 #define O_RDWR 0x2 313 #define O_ACCMODE 0x3 314 /* NOT IMPLEMENTED */ 315 #define O_CREAT 0x0200 /* create if nonexistent */ 316 #define O_TRUNC 0x0400 /* truncate to zero length */ 317 extern int close(int); 318 extern void closeall(void); 319 extern ssize_t read(int, void *, size_t); 320 extern ssize_t write(int, const void *, size_t); 321 extern int ioctl(int, u_long, void *); 322 extern struct dirent *readdirfd(int); 323 extern void preload(int); 324 325 extern void srandom(unsigned int); 326 extern long random(void); 327 328 /* imports from stdlib, locally modified */ 329 extern char *optarg; /* getopt(3) external variables */ 330 extern int optind, opterr, optopt, optreset; 331 extern int getopt(int, char * const [], const char *); 332 333 /* pager.c */ 334 extern void pager_open(void); 335 extern void pager_close(void); 336 extern int pager_output(const char *lines); 337 extern int pager_file(const char *fname); 338 339 /* No signal state to preserve */ 340 #define setjmp _setjmp 341 #define longjmp _longjmp 342 343 /* environment.c */ 344 #define EV_DYNAMIC (1<<0) /* value was dynamically allocated, free if changed/unset */ 345 #define EV_VOLATILE (1<<1) /* value is volatile, make a copy of it */ 346 #define EV_NOHOOK (1<<2) /* don't call hook when setting */ 347 348 struct env_var; 349 typedef char *(ev_format_t)(struct env_var *ev); 350 typedef int (ev_sethook_t)(struct env_var *ev, int flags, 351 const void *value); 352 typedef int (ev_unsethook_t)(struct env_var *ev); 353 354 struct env_var 355 { 356 char *ev_name; 357 int ev_flags; 358 void *ev_value; 359 ev_sethook_t *ev_sethook; 360 ev_unsethook_t *ev_unsethook; 361 struct env_var *ev_next, *ev_prev; 362 }; 363 extern struct env_var *environ; 364 365 extern struct env_var *env_getenv(const char *name); 366 extern int env_setenv(const char *name, int flags, 367 const void *value, ev_sethook_t sethook, 368 ev_unsethook_t unsethook); 369 extern void env_discard(struct env_var *); 370 extern char *getenv(const char *name); 371 extern int setenv(const char *name, const char *value, 372 int overwrite); 373 extern int putenv(char *string); 374 extern int unsetenv(const char *name); 375 376 extern ev_sethook_t env_noset; /* refuse set operation */ 377 extern ev_unsethook_t env_nounset; /* refuse unset operation */ 378 379 /* stdlib.h routines */ 380 extern int abs(int a); 381 extern void abort(void) __dead2; 382 extern long strtol(const char * __restrict, char ** __restrict, int); 383 extern long long strtoll(const char * __restrict, char ** __restrict, int); 384 extern unsigned long strtoul(const char * __restrict, char ** __restrict, int); 385 extern unsigned long long strtoull(const char * __restrict, char ** __restrict, int); 386 387 /* BCD conversions (undocumented) */ 388 extern u_char const bcd2bin_data[]; 389 extern u_char const bin2bcd_data[]; 390 extern char const hex2ascii_data[]; 391 392 #define bcd2bin(bcd) (bcd2bin_data[bcd]) 393 #define bin2bcd(bin) (bin2bcd_data[bin]) 394 #define hex2ascii(hex) (hex2ascii_data[hex]) 395 #define validbcd(bcd) (bcd == 0 || (bcd > 0 && bcd <= 0x99 && bcd2bin_data[bcd] != 0)) 396 397 /* min/max (undocumented) */ 398 static __inline int imax(int a, int b) { return (a > b ? a : b); } 399 static __inline int imin(int a, int b) { return (a < b ? a : b); } 400 static __inline long lmax(long a, long b) { return (a > b ? a : b); } 401 static __inline long lmin(long a, long b) { return (a < b ? a : b); } 402 static __inline u_int max(u_int a, u_int b) { return (a > b ? a : b); } 403 static __inline u_int min(u_int a, u_int b) { return (a < b ? a : b); } 404 static __inline quad_t qmax(quad_t a, quad_t b) { return (a > b ? a : b); } 405 static __inline quad_t qmin(quad_t a, quad_t b) { return (a < b ? a : b); } 406 static __inline u_long ulmax(u_long a, u_long b) { return (a > b ? a : b); } 407 static __inline u_long ulmin(u_long a, u_long b) { return (a < b ? a : b); } 408 409 /* null functions for device/filesystem switches (undocumented) */ 410 extern int nodev(void); 411 extern int noioctl(struct open_file *, u_long, void *); 412 extern void nullsys(void); 413 414 extern int null_open(const char *path, struct open_file *f); 415 extern int null_close(struct open_file *f); 416 extern int null_read(struct open_file *f, void *buf, size_t size, size_t *resid); 417 extern int null_write(struct open_file *f, const void *buf, size_t size, size_t *resid); 418 extern off_t null_seek(struct open_file *f, off_t offset, int where); 419 extern int null_stat(struct open_file *f, struct stat *sb); 420 extern int null_readdir(struct open_file *f, struct dirent *d); 421 422 423 /* 424 * Machine dependent functions and data, must be provided or stubbed by 425 * the consumer 426 */ 427 extern void exit(int) __dead2; 428 extern int getchar(void); 429 extern int ischar(void); 430 extern void putchar(int); 431 extern int devopen(struct open_file *, const char *, const char **); 432 extern int devclose(struct open_file *f); 433 extern void panic(const char *, ...) __dead2 __printflike(1, 2); 434 extern void panic_action(void) __weak_symbol __dead2; 435 extern time_t getsecs(void); 436 extern struct fs_ops *file_system[]; 437 extern struct fs_ops *exclusive_file_system; 438 extern struct devsw *devsw[]; 439 440 /* 441 * Time routines 442 */ 443 time_t time(time_t *); 444 445 /* 446 * Expose byteorder(3) functions. 447 */ 448 #ifndef _BYTEORDER_PROTOTYPED 449 #define _BYTEORDER_PROTOTYPED 450 extern uint32_t htonl(uint32_t); 451 extern uint16_t htons(uint16_t); 452 extern uint32_t ntohl(uint32_t); 453 extern uint16_t ntohs(uint16_t); 454 #endif 455 456 #ifndef _BYTEORDER_FUNC_DEFINED 457 #define _BYTEORDER_FUNC_DEFINED 458 #define htonl(x) __htonl(x) 459 #define htons(x) __htons(x) 460 #define ntohl(x) __ntohl(x) 461 #define ntohs(x) __ntohs(x) 462 #endif 463 464 void *Malloc(size_t, const char *, int); 465 void *Memalign(size_t, size_t, const char *, int); 466 void *Calloc(size_t, size_t, const char *, int); 467 void *Realloc(void *, size_t, const char *, int); 468 void *Reallocf(void *, size_t, const char *, int); 469 void Free(void *, const char *, int); 470 extern void mallocstats(void); 471 472 const char *x86_hypervisor(void); 473 474 #ifdef USER_MALLOC 475 extern void *malloc(size_t); 476 extern void *memalign(size_t, size_t); 477 extern void *calloc(size_t, size_t); 478 extern void free(void *); 479 extern void *realloc(void *, size_t); 480 extern void *reallocf(void *, size_t); 481 #elif defined(DEBUG_MALLOC) 482 #define malloc(x) Malloc(x, __FILE__, __LINE__) 483 #define memalign(x, y) Memalign(x, y, __FILE__, __LINE__) 484 #define calloc(x, y) Calloc(x, y, __FILE__, __LINE__) 485 #define free(x) Free(x, __FILE__, __LINE__) 486 #define realloc(x, y) Realloc(x, y, __FILE__, __LINE__) 487 #define reallocf(x, y) Reallocf(x, y, __FILE__, __LINE__) 488 #else 489 #define malloc(x) Malloc(x, NULL, 0) 490 #define memalign(x, y) Memalign(x, y, NULL, 0) 491 #define calloc(x, y) Calloc(x, y, NULL, 0) 492 #define free(x) Free(x, NULL, 0) 493 #define realloc(x, y) Realloc(x, y, NULL, 0) 494 #define reallocf(x, y) Reallocf(x, y, NULL, 0) 495 #endif 496 497 /* 498 * va <-> pa routines. MD code must supply. 499 */ 500 caddr_t ptov(uintptr_t); 501 502 /* features.c */ 503 typedef void (feature_iter_fn)(void *, const char *, const char *, bool); 504 505 extern void feature_enable(uint32_t); 506 extern bool feature_name_is_enabled(const char *); 507 extern void feature_iter(feature_iter_fn *, void *); 508 509 /* 510 * Note that these should also be added to the mapping table in features.c, 511 * which the interpreter may query to provide details from. The name with 512 * FEATURE_ removed is assumed to be the name we'll provide in the loader 513 * features table, just to simplify reasoning about these. 514 */ 515 #define FEATURE_EARLY_ACPI 0x0001 516 517 /* hexdump.c */ 518 void hexdump(caddr_t region, size_t len); 519 520 /* nvstore.c */ 521 typedef int (nvstore_getter_cb_t)(void *, const char *, void **); 522 typedef int (nvstore_setter_cb_t)(void *, int, const char *, 523 const void *, size_t); 524 typedef int (nvstore_setter_str_cb_t)(void *, const char *, const char *, 525 const char *); 526 typedef int (nvstore_unset_cb_t)(void *, const char *); 527 typedef int (nvstore_print_cb_t)(void *, void *); 528 typedef int (nvstore_iterate_cb_t)(void *, int (*)(void *, void *)); 529 530 typedef struct nvs_callbacks { 531 nvstore_getter_cb_t *nvs_getter; 532 nvstore_setter_cb_t *nvs_setter; 533 nvstore_setter_str_cb_t *nvs_setter_str; 534 nvstore_unset_cb_t *nvs_unset; 535 nvstore_print_cb_t *nvs_print; 536 nvstore_iterate_cb_t *nvs_iterate; 537 } nvs_callbacks_t; 538 539 int nvstore_init(const char *, nvs_callbacks_t *, void *); 540 int nvstore_fini(const char *); 541 void *nvstore_get_store(const char *); 542 int nvstore_print(void *); 543 int nvstore_get_var(void *, const char *, void **); 544 int nvstore_set_var(void *, int, const char *, void *, size_t); 545 int nvstore_set_var_from_string(void *, const char *, const char *, 546 const char *); 547 int nvstore_unset_var(void *, const char *); 548 549 /* tslog.c */ 550 #define TSRAW(a, b, c) tslog(a, b, c) 551 #define TSENTER() TSRAW("ENTER", __func__, NULL) 552 #define TSENTER2(x) TSRAW("ENTER", __func__, x) 553 #define TSEXIT() TSRAW("EXIT", __func__, NULL) 554 #define TSLINE() TSRAW("EVENT", __FILE__, __XSTRING(__LINE__)) 555 void tslog(const char *, const char *, const char *); 556 void tslog_setbuf(void * buf, size_t len); 557 void tslog_getbuf(void ** buf, size_t * len); 558 559 __END_DECLS 560 561 #endif /* STAND_H */ 562