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