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