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