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