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