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 struct devsw { 144 const char dv_name[DEV_NAMLEN]; 145 int dv_type; /* opaque type constant */ 146 #define DEVT_NONE 0 147 #define DEVT_DISK 1 148 #define DEVT_NET 2 149 #define DEVT_CD 3 150 #define DEVT_ZFS 4 151 #define DEVT_FD 5 152 int (*dv_init)(void); /* early probe call */ 153 int (*dv_strategy)(void *devdata, int rw, daddr_t blk, 154 size_t size, char *buf, size_t *rsize); 155 int (*dv_open)(struct open_file *f, ...); 156 int (*dv_close)(struct open_file *f); 157 int (*dv_ioctl)(struct open_file *f, u_long cmd, void *data); 158 int (*dv_print)(int verbose); /* print device information */ 159 void (*dv_cleanup)(void); 160 }; 161 162 /* 163 * libsa-supplied device switch 164 */ 165 extern struct devsw netdev; 166 167 extern int errno; 168 169 /* 170 * Generic device specifier; architecture-dependent 171 * versions may be larger, but should be allowed to 172 * overlap. 173 */ 174 struct devdesc { 175 struct devsw *d_dev; 176 int d_unit; 177 void *d_opendata; 178 }; 179 180 struct open_file { 181 int f_flags; /* see F_* below */ 182 struct devsw *f_dev; /* pointer to device operations */ 183 void *f_devdata; /* device specific data */ 184 struct fs_ops *f_ops; /* pointer to file system operations */ 185 void *f_fsdata; /* file system specific data */ 186 off_t f_offset; /* current file offset */ 187 char *f_rabuf; /* readahead buffer pointer */ 188 size_t f_ralen; /* valid data in readahead buffer */ 189 off_t f_raoffset; /* consumer offset in readahead buffer */ 190 int f_id; /* file number */ 191 TAILQ_ENTRY(open_file) f_link; /* next entry */ 192 #define SOPEN_RASIZE 512 193 }; 194 195 typedef TAILQ_HEAD(file_list, open_file) file_list_t; 196 extern file_list_t files; 197 extern struct open_file *fd2open_file(int); 198 199 /* f_flags values */ 200 #define F_READ 0x0001 /* file opened for reading */ 201 #define F_WRITE 0x0002 /* file opened for writing */ 202 #define F_RAW 0x0004 /* raw device open - no file system */ 203 #define F_NODEV 0x0008 /* network open - no device */ 204 #define F_MASK 0xFFFF 205 /* Mode modifier for strategy() */ 206 #define F_NORA (0x01 << 16) /* Disable Read-Ahead */ 207 208 #define isascii(c) (((c) & ~0x7F) == 0) 209 210 static __inline int isupper(int c) 211 { 212 return c >= 'A' && c <= 'Z'; 213 } 214 215 static __inline int islower(int c) 216 { 217 return c >= 'a' && c <= 'z'; 218 } 219 220 static __inline int isspace(int c) 221 { 222 return c == ' ' || (c >= 0x9 && c <= 0xd); 223 } 224 225 static __inline int isdigit(int c) 226 { 227 return c >= '0' && c <= '9'; 228 } 229 230 static __inline int isxdigit(int c) 231 { 232 return isdigit(c) || (c >= 'a' && c <= 'f') || (c >= 'A' && c <= 'F'); 233 } 234 235 static __inline int isalpha(int c) 236 { 237 return isupper(c) || islower(c); 238 } 239 240 static __inline int isalnum(int c) 241 { 242 return isalpha(c) || isdigit(c); 243 } 244 245 static __inline int iscntrl(int c) 246 { 247 return (c >= 0 && c < ' ') || c == 127; 248 } 249 250 static __inline int isgraph(int c) 251 { 252 return c >= '!' && c <= '~'; 253 } 254 255 static __inline int ispunct(int c) 256 { 257 return (c >= '!' && c <= '/') || (c >= ':' && c <= '@') || 258 (c >= '[' && c <= '`') || (c >= '{' && c <= '~'); 259 } 260 261 static __inline int toupper(int c) 262 { 263 return islower(c) ? c - 'a' + 'A' : c; 264 } 265 266 static __inline int tolower(int c) 267 { 268 return isupper(c) ? c - 'A' + 'a' : c; 269 } 270 271 /* sbrk emulation */ 272 extern void setheap(void *base, void *top); 273 extern char *sbrk(int incr); 274 275 extern int printf(const char *fmt, ...) __printflike(1, 2); 276 extern int asprintf(char **buf, const char *cfmt, ...) __printflike(2, 3); 277 extern int sprintf(char *buf, const char *cfmt, ...) __printflike(2, 3); 278 extern int snprintf(char *buf, size_t size, const char *cfmt, ...) __printflike(3, 4); 279 extern int vprintf(const char *fmt, __va_list); 280 extern int vsprintf(char *buf, const char *cfmt, __va_list); 281 extern int vsnprintf(char *buf, size_t size, const char *cfmt, __va_list); 282 283 extern void twiddle(u_int callerdiv); 284 extern void twiddle_divisor(u_int globaldiv); 285 286 extern void ngets(char *, int); 287 #define gets(x) ngets((x), 0) 288 extern int fgetstr(char *buf, int size, int fd); 289 290 extern int mount(const char *dev, const char *path, int flags, void *data); 291 extern int unmount(const char *dev, int flags); 292 extern int open(const char *, int); 293 #define O_RDONLY 0x0 294 #define O_WRONLY 0x1 295 #define O_RDWR 0x2 296 #define O_ACCMODE 0x3 297 /* NOT IMPLEMENTED */ 298 #define O_CREAT 0x0200 /* create if nonexistent */ 299 #define O_TRUNC 0x0400 /* truncate to zero length */ 300 extern int close(int); 301 extern void closeall(void); 302 extern ssize_t read(int, void *, size_t); 303 extern ssize_t write(int, const void *, size_t); 304 extern struct dirent *readdirfd(int); 305 extern void preload(int); 306 307 extern void srandom(unsigned int); 308 extern long random(void); 309 310 /* imports from stdlib, locally modified */ 311 extern char *optarg; /* getopt(3) external variables */ 312 extern int optind, opterr, optopt, optreset; 313 extern int getopt(int, char * const [], const char *); 314 315 /* pager.c */ 316 extern void pager_open(void); 317 extern void pager_close(void); 318 extern int pager_output(const char *lines); 319 extern int pager_file(const char *fname); 320 321 /* No signal state to preserve */ 322 #define setjmp _setjmp 323 #define longjmp _longjmp 324 325 /* environment.c */ 326 #define EV_DYNAMIC (1<<0) /* value was dynamically allocated, free if changed/unset */ 327 #define EV_VOLATILE (1<<1) /* value is volatile, make a copy of it */ 328 #define EV_NOHOOK (1<<2) /* don't call hook when setting */ 329 330 struct env_var; 331 typedef char *(ev_format_t)(struct env_var *ev); 332 typedef int (ev_sethook_t)(struct env_var *ev, int flags, 333 const void *value); 334 typedef int (ev_unsethook_t)(struct env_var *ev); 335 336 struct env_var 337 { 338 char *ev_name; 339 int ev_flags; 340 void *ev_value; 341 ev_sethook_t *ev_sethook; 342 ev_unsethook_t *ev_unsethook; 343 struct env_var *ev_next, *ev_prev; 344 }; 345 extern struct env_var *environ; 346 347 extern struct env_var *env_getenv(const char *name); 348 extern int env_setenv(const char *name, int flags, 349 const void *value, ev_sethook_t sethook, 350 ev_unsethook_t unsethook); 351 extern void env_discard(struct env_var *); 352 extern char *getenv(const char *name); 353 extern int setenv(const char *name, const char *value, 354 int overwrite); 355 extern int putenv(char *string); 356 extern int unsetenv(const char *name); 357 358 extern ev_sethook_t env_noset; /* refuse set operation */ 359 extern ev_unsethook_t env_nounset; /* refuse unset operation */ 360 361 /* stdlib.h routines */ 362 extern int abs(int a); 363 extern void abort(void) __dead2; 364 extern long strtol(const char * __restrict, char ** __restrict, int); 365 extern long long strtoll(const char * __restrict, char ** __restrict, int); 366 extern unsigned long strtoul(const char * __restrict, char ** __restrict, int); 367 extern unsigned long long strtoull(const char * __restrict, char ** __restrict, int); 368 369 /* BCD conversions (undocumented) */ 370 extern u_char const bcd2bin_data[]; 371 extern u_char const bin2bcd_data[]; 372 extern char const hex2ascii_data[]; 373 374 #define bcd2bin(bcd) (bcd2bin_data[bcd]) 375 #define bin2bcd(bin) (bin2bcd_data[bin]) 376 #define hex2ascii(hex) (hex2ascii_data[hex]) 377 #define validbcd(bcd) (bcd == 0 || (bcd > 0 && bcd <= 0x99 && bcd2bin_data[bcd] != 0)) 378 379 /* min/max (undocumented) */ 380 static __inline int imax(int a, int b) { return (a > b ? a : b); } 381 static __inline int imin(int a, int b) { return (a < b ? a : b); } 382 static __inline long lmax(long a, long b) { return (a > b ? a : b); } 383 static __inline long lmin(long a, long b) { return (a < b ? a : b); } 384 static __inline u_int max(u_int a, u_int b) { return (a > b ? a : b); } 385 static __inline u_int min(u_int a, u_int b) { return (a < b ? a : b); } 386 static __inline quad_t qmax(quad_t a, quad_t b) { return (a > b ? a : b); } 387 static __inline quad_t qmin(quad_t a, quad_t b) { return (a < b ? a : b); } 388 static __inline u_long ulmax(u_long a, u_long b) { return (a > b ? a : b); } 389 static __inline u_long ulmin(u_long a, u_long b) { return (a < b ? a : b); } 390 391 /* null functions for device/filesystem switches (undocumented) */ 392 extern int nodev(void); 393 extern int noioctl(struct open_file *, u_long, void *); 394 extern void nullsys(void); 395 396 extern int null_open(const char *path, struct open_file *f); 397 extern int null_close(struct open_file *f); 398 extern int null_read(struct open_file *f, void *buf, size_t size, size_t *resid); 399 extern int null_write(struct open_file *f, const void *buf, size_t size, size_t *resid); 400 extern off_t null_seek(struct open_file *f, off_t offset, int where); 401 extern int null_stat(struct open_file *f, struct stat *sb); 402 extern int null_readdir(struct open_file *f, struct dirent *d); 403 404 405 /* 406 * Machine dependent functions and data, must be provided or stubbed by 407 * the consumer 408 */ 409 extern void exit(int) __dead2; 410 extern int getchar(void); 411 extern int ischar(void); 412 extern void putchar(int); 413 extern int devopen(struct open_file *, const char *, const char **); 414 extern int devclose(struct open_file *f); 415 extern void panic(const char *, ...) __dead2 __printflike(1, 2); 416 extern void panic_action(void) __weak_symbol __dead2; 417 extern time_t getsecs(void); 418 extern struct fs_ops *file_system[]; 419 extern struct fs_ops *exclusive_file_system; 420 extern struct devsw *devsw[]; 421 422 /* 423 * Time routines 424 */ 425 time_t time(time_t *); 426 427 /* 428 * Expose byteorder(3) functions. 429 */ 430 #ifndef _BYTEORDER_PROTOTYPED 431 #define _BYTEORDER_PROTOTYPED 432 extern uint32_t htonl(uint32_t); 433 extern uint16_t htons(uint16_t); 434 extern uint32_t ntohl(uint32_t); 435 extern uint16_t ntohs(uint16_t); 436 #endif 437 438 #ifndef _BYTEORDER_FUNC_DEFINED 439 #define _BYTEORDER_FUNC_DEFINED 440 #define htonl(x) __htonl(x) 441 #define htons(x) __htons(x) 442 #define ntohl(x) __ntohl(x) 443 #define ntohs(x) __ntohs(x) 444 #endif 445 446 void *Malloc(size_t, const char *, int); 447 void *Memalign(size_t, size_t, const char *, int); 448 void *Calloc(size_t, size_t, const char *, int); 449 void *Realloc(void *, size_t, const char *, int); 450 void *Reallocf(void *, size_t, const char *, int); 451 void Free(void *, const char *, int); 452 extern void mallocstats(void); 453 454 const char *x86_hypervisor(void); 455 456 #ifdef USER_MALLOC 457 extern void *malloc(size_t); 458 extern void *memalign(size_t, size_t); 459 extern void *calloc(size_t, size_t); 460 extern void free(void *); 461 extern void *realloc(void *, size_t); 462 extern void *reallocf(void *, size_t); 463 #elif defined(DEBUG_MALLOC) 464 #define malloc(x) Malloc(x, __FILE__, __LINE__) 465 #define memalign(x, y) Memalign(x, y, __FILE__, __LINE__) 466 #define calloc(x, y) Calloc(x, y, __FILE__, __LINE__) 467 #define free(x) Free(x, __FILE__, __LINE__) 468 #define realloc(x, y) Realloc(x, y, __FILE__, __LINE__) 469 #define reallocf(x, y) Reallocf(x, y, __FILE__, __LINE__) 470 #else 471 #define malloc(x) Malloc(x, NULL, 0) 472 #define memalign(x, y) Memalign(x, y, NULL, 0) 473 #define calloc(x, y) Calloc(x, y, NULL, 0) 474 #define free(x) Free(x, NULL, 0) 475 #define realloc(x, y) Realloc(x, y, NULL, 0) 476 #define reallocf(x, y) Reallocf(x, y, NULL, 0) 477 #endif 478 479 /* 480 * va <-> pa routines. MD code must supply. 481 */ 482 caddr_t ptov(uintptr_t); 483 484 /* hexdump.c */ 485 void hexdump(caddr_t region, size_t len); 486 487 /* tslog.c */ 488 #define TSRAW(a, b, c) tslog(a, b, c) 489 #define TSENTER() TSRAW("ENTER", __func__, NULL) 490 #define TSENTER2(x) TSRAW("ENTER", __func__, x) 491 #define TSEXIT() TSRAW("EXIT", __func__, NULL) 492 #define TSLINE() TSRAW("EVENT", __FILE__, __XSTRING(__LINE__)) 493 void tslog(const char *, const char *, const char *); 494 void tslog_setbuf(void * buf, size_t len); 495 void tslog_getbuf(void ** buf, size_t * len); 496 497 #endif /* STAND_H */ 498