1 /* 2 * Copyright (c) 1998 Michael Smith. 3 * All rights reserved. 4 * Copyright 2024 MNX Cloud, Inc. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25 * SUCH DAMAGE. 26 * 27 * $FreeBSD$ 28 * From $NetBSD: stand.h,v 1.22 1997/06/26 19:17:40 drochner Exp $ 29 */ 30 31 /* 32 * Copyright (c) 1993 33 * The Regents of the University of California. All rights reserved. 34 * 35 * Redistribution and use in source and binary forms, with or without 36 * modification, are permitted provided that the following conditions 37 * are met: 38 * 1. Redistributions of source code must retain the above copyright 39 * notice, this list of conditions and the following disclaimer. 40 * 2. Redistributions in binary form must reproduce the above copyright 41 * notice, this list of conditions and the following disclaimer in the 42 * documentation and/or other materials provided with the distribution. 43 * 4. Neither the name of the University nor the names of its contributors 44 * may be used to endorse or promote products derived from this software 45 * without specific prior written permission. 46 * 47 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 48 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 49 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 50 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 51 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 52 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 53 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 54 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 55 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 56 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 57 * SUCH DAMAGE. 58 * 59 * @(#)stand.h 8.1 (Berkeley) 6/11/93 60 */ 61 62 #ifndef STAND_H 63 #define STAND_H 64 65 #include <sys/types.h> 66 #include <sys/cdefs.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 74 #define CHK(fmt, args...) \ 75 printf("%s(%d): " fmt "\n", __func__, __LINE__, ##args) 76 #define PCHK(fmt, args...) {\ 77 printf("%s(%d): " fmt "\n", __func__, __LINE__, ##args); getchar();\ 78 } 79 80 /* Avoid unwanted userlandish components */ 81 #define _KERNEL 82 #include <sys/errno.h> 83 #undef _KERNEL 84 85 /* special stand error codes */ 86 #define EADAPT (ELAST+1) /* bad adaptor */ 87 #define ECTLR (ELAST+2) /* bad controller */ 88 #define EUNIT (ELAST+3) /* bad unit */ 89 #define ESLICE (ELAST+4) /* bad slice */ 90 #define EPART (ELAST+5) /* bad partition */ 91 #define ERDLAB (ELAST+6) /* can't read disk label */ 92 #define EUNLAB (ELAST+7) /* unlabeled disk */ 93 #define EOFFSET (ELAST+8) /* relative seek not supported */ 94 #define ESALAST (ELAST+8) /* */ 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 }; 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 dosfs_fsops; 128 129 /* where values for lseek(2) */ 130 #define SEEK_SET 0 /* set file offset to offset */ 131 #define SEEK_CUR 1 /* set file offset to current plus offset */ 132 #define SEEK_END 2 /* set file offset to EOF plus offset */ 133 134 /* 135 * Device switch 136 */ 137 struct devsw { 138 const char dv_name[8]; 139 int dv_type; /* opaque type constant, arch-dependant */ 140 #define DEVT_NONE 0 141 #define DEVT_DISK 1 142 #define DEVT_NET 2 143 #define DEVT_CD 3 144 #define DEVT_ZFS 4 145 #define DEVT_FD 5 146 int (*dv_init)(void); /* early probe call */ 147 int (*dv_strategy)(void *devdata, int rw, daddr_t blk, 148 size_t size, char *buf, size_t *rsize); 149 int (*dv_open)(struct open_file *f, ...); 150 int (*dv_close)(struct open_file *f); 151 int (*dv_ioctl)(struct open_file *f, ulong_t cmd, void *data); 152 int (*dv_print)(int verbose); /* print device information */ 153 void (*dv_cleanup)(void); 154 }; 155 156 /* 157 * libstand-supplied device switch 158 */ 159 extern struct devsw netdev; 160 161 extern int errno; 162 163 /* 164 * Generic device specifier; architecture-dependent 165 * versions may be larger, but should be allowed to 166 * overlap. 167 */ 168 struct devdesc { 169 struct devsw *d_dev; 170 int d_unit; 171 void *d_opendata; 172 }; 173 174 struct open_file { 175 int f_flags; /* see F_* below */ 176 struct devsw *f_dev; /* pointer to device operations */ 177 void *f_devdata; /* device specific data */ 178 struct fs_ops *f_ops; /* pointer to file system operations */ 179 void *f_fsdata; /* file system specific data */ 180 off_t f_offset; /* current file offset */ 181 char *f_rabuf; /* readahead buffer pointer */ 182 size_t f_ralen; /* valid data in readahead buffer */ 183 off_t f_raoffset; /* consumer offset in readahead buffer */ 184 int f_id; /* file number */ 185 TAILQ_ENTRY(open_file) f_link; /* next entry */ 186 #define SOPEN_RASIZE 512 187 }; 188 189 typedef TAILQ_HEAD(file_list, open_file) file_list_t; 190 extern file_list_t files; 191 extern struct open_file *fd2open_file(int); 192 193 /* f_flags values */ 194 #define F_READ 0x0001 /* file opened for reading */ 195 #define F_WRITE 0x0002 /* file opened for writing */ 196 #define F_RAW 0x0004 /* raw device open - no file system */ 197 #define F_NODEV 0x0008 /* network open - no device */ 198 #define F_GZIP 0x0010 /* file is compressed by gzip */ 199 #define F_MASK 0xFFFF 200 /* Mode modifier for strategy() */ 201 #define F_NORA (0x01 << 16) /* Disable Read-Ahead */ 202 203 #define isascii(c) (((c) & ~0x7F) == 0) 204 205 static __inline int isupper(int c) 206 { 207 return (c >= 'A' && c <= 'Z'); 208 } 209 210 static __inline int islower(int c) 211 { 212 return (c >= 'a' && c <= 'z'); 213 } 214 215 static __inline int isspace(int c) 216 { 217 return (c == ' ' || (c >= 0x9 && c <= 0xd)); 218 } 219 220 static __inline int isdigit(int c) 221 { 222 return (c >= '0' && c <= '9'); 223 } 224 225 static __inline int isxdigit(int c) 226 { 227 return (isdigit(c) || (c >= 'a' && c <= 'f') || (c >= 'A' && c <= 'F')); 228 } 229 230 static __inline int isalpha(int c) 231 { 232 return (isupper(c) || islower(c)); 233 } 234 235 static __inline int isalnum(int c) 236 { 237 return (isalpha(c) || isdigit(c)); 238 } 239 240 static __inline int iscntrl(int c) 241 { 242 return ((c >= 0 && c < ' ') || c == 127); 243 } 244 245 static __inline int isgraph(int c) 246 { 247 return (c >= '!' && c <= '~'); 248 } 249 250 static __inline int ispunct(int c) 251 { 252 return ((c >= '!' && c <= '/') || (c >= ':' && c <= '@') || 253 (c >= '[' && c <= '`') || (c >= '{' && c <= '~')); 254 } 255 256 static __inline int toupper(int c) 257 { 258 return (islower(c) ? c - 'a' + 'A' : c); 259 } 260 261 static __inline int tolower(int c) 262 { 263 return (isupper(c) ? c - 'A' + 'a' : c); 264 } 265 266 /* sbrk emulation */ 267 extern void setheap(void *base, void *top); 268 extern char *sbrk(int incr); 269 270 extern void mallocstats(void); 271 272 const char *x86_hypervisor(void); 273 274 extern int printf(const char *fmt, ...) __printflike(1, 2); 275 extern void vprintf(const char *fmt, __va_list); 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, ...) \ 279 __printflike(3, 4); 280 extern void vsprintf(char *buf, const char *cfmt, __va_list); 281 extern void vsnprintf(char *buf, size_t size, const char *cfmt, __va_list); 282 283 extern void twiddle(uint_t callerdiv); 284 extern void twiddle_divisor(uint_t 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 open(const char *, int); 291 #define O_RDONLY 0x0 292 #define O_WRONLY 0x1 293 #define O_RDWR 0x2 294 extern int close(int); 295 extern void closeall(void); 296 extern ssize_t read(int, void *, size_t); 297 extern ssize_t write(int, const void *, size_t); 298 extern struct dirent *readdirfd(int); 299 300 extern void srandom(ulong_t seed); 301 extern ulong_t random(void); 302 303 extern char *optarg; /* getopt(3) external variables */ 304 extern int optind, opterr, optopt, optreset; 305 extern int getopt(int, char * const [], const char *); 306 307 /* pager.c */ 308 extern void pager_open(void); 309 extern void pager_close(void); 310 extern int pager_output(const char *lines); 311 extern int pager_file(const char *fname); 312 313 /* No signal state to preserve */ 314 #define setjmp _setjmp 315 #define longjmp _longjmp 316 317 /* environment.c */ 318 /* value was dynamically allocated, free if changed/unset */ 319 #define EV_DYNAMIC (1<<0) 320 /* value is volatile, make a copy of it */ 321 #define EV_VOLATILE (1<<1) 322 /* don't call hook when setting */ 323 #define EV_NOHOOK (1<<2) 324 325 struct env_var; 326 typedef char *(ev_format_t)(struct env_var *ev); 327 typedef int (ev_sethook_t)(struct env_var *ev, int flags, 328 const void *value); 329 typedef int (ev_unsethook_t)(struct env_var *ev); 330 331 struct env_var 332 { 333 char *ev_name; 334 int ev_flags; 335 void *ev_value; 336 ev_sethook_t *ev_sethook; 337 ev_unsethook_t *ev_unsethook; 338 struct env_var *ev_next, *ev_prev; 339 }; 340 extern struct env_var *environ; 341 342 extern struct env_var *env_getenv(const char *name); 343 extern int env_setenv(const char *name, int flags, 344 const void *value, ev_sethook_t sethook, 345 ev_unsethook_t unsethook); 346 extern void env_discard(struct env_var *); 347 extern char *getenv(const char *name); 348 extern int setenv(const char *name, const char *value, 349 int overwrite); 350 extern int putenv(const char *string); 351 extern int unsetenv(const char *name); 352 353 extern ev_sethook_t env_noset; /* refuse set operation */ 354 extern ev_unsethook_t env_nounset; /* refuse unset operation */ 355 356 /* stdlib.h routines */ 357 extern long strtol(const char *__restrict, char **__restrict, int); 358 extern long long strtoll(const char *__restrict, char **__restrict, int); 359 extern unsigned long strtoul(const char *__restrict, char **__restrict, int); 360 extern unsigned long long strtoull(const char *__restrict, char **__restrict, 361 int); 362 363 /* BCD conversions (undocumented) */ 364 extern uchar_t const bcd2bin_data[]; 365 extern uchar_t const bin2bcd_data[]; 366 extern char const hex2ascii_data[]; 367 368 #define bcd2bin(bcd) (bcd2bin_data[bcd]) 369 #define bin2bcd(bin) (bin2bcd_data[bin]) 370 #define hex2ascii(hex) (hex2ascii_data[hex]) 371 372 /* min/max (undocumented) */ 373 static __inline int imax(int a, int b) { return (a > b ? a : b); } 374 static __inline int imin(int a, int b) { return (a < b ? a : b); } 375 static __inline long lmax(long a, long b) { return (a > b ? a : b); } 376 static __inline long lmin(long a, long b) { return (a < b ? a : b); } 377 static __inline uint_t max(uint_t a, uint_t b) { return (a > b ? a : b); } 378 static __inline uint_t min(uint_t a, uint_t b) { return (a < b ? a : b); } 379 static __inline quad_t qmax(quad_t a, quad_t b) { return (a > b ? a : b); } 380 static __inline quad_t qmin(quad_t a, quad_t b) { return (a < b ? a : b); } 381 static __inline ulong_t ulmax(ulong_t a, ulong_t b) { return (a > b ? a : b); } 382 static __inline ulong_t ulmin(ulong_t a, ulong_t b) { return (a < b ? a : b); } 383 384 /* null functions for device/filesystem switches (undocumented) */ 385 extern int nodev(void); 386 extern int noioctl(struct open_file *, ulong_t, void *); 387 extern void nullsys(void); 388 389 extern int null_open(const char *, struct open_file *); 390 extern int null_close(struct open_file *); 391 extern int null_read(struct open_file *, void *, size_t, size_t *); 392 extern int null_write(struct open_file *, const void *, size_t, size_t *); 393 extern off_t null_seek(struct open_file *, off_t, int); 394 extern int null_stat(struct open_file *, struct stat *); 395 extern int null_readdir(struct open_file *, struct dirent *); 396 397 398 /* 399 * Machine dependent functions and data, must be provided or stubbed by 400 * the consumer 401 */ 402 extern void exit(int) __dead2; 403 extern int getchar(void); 404 extern int ischar(void); 405 extern void putchar(int); 406 extern int devopen(struct open_file *, const char *, const char **); 407 extern int devclose(struct open_file *f); 408 extern void panic(const char *, ...) __dead2 __printflike(1, 2); 409 extern void panic_action(void) __weak_symbol __dead2; 410 extern time_t getsecs(void); 411 extern struct fs_ops *file_system[]; 412 extern struct fs_ops *exclusive_file_system; 413 extern struct devsw *devsw[]; 414 415 /* 416 * Expose byteorder(3) functions. 417 */ 418 #ifndef _BYTEORDER_PROTOTYPED 419 #define _BYTEORDER_PROTOTYPED 420 extern uint32_t htonl(uint32_t); 421 extern uint16_t htons(uint16_t); 422 extern uint32_t ntohl(uint32_t); 423 extern uint16_t ntohs(uint16_t); 424 #endif 425 426 #ifndef _BYTEORDER_FUNC_DEFINED 427 #define _BYTEORDER_FUNC_DEFINED 428 #define htonl(x) __htonl(x) 429 #define htons(x) __htons(x) 430 #define ntohl(x) __ntohl(x) 431 #define ntohs(x) __ntohs(x) 432 #endif 433 434 void *Malloc(size_t, const char *, int); 435 void *Memalign(size_t, size_t, const char *, int); 436 void *Calloc(size_t, size_t, const char *, int); 437 void *Realloc(void *, size_t, const char *, int); 438 void *Reallocf(void *, size_t, const char *, int); 439 void Free(void *, const char *, int); 440 441 #if DEBUG_MALLOC 442 #define malloc(x) Malloc(x, __FILE__, __LINE__) 443 #define memalign(x, y) Memalign(x, y, __FILE__, __LINE__) 444 #define calloc(x, y) Calloc(x, y, __FILE__, __LINE__) 445 #define free(x) Free(x, __FILE__, __LINE__) 446 #define realloc(x, y) Realloc(x, y, __FILE__, __LINE__) 447 #define reallocf(x, y) Reallocf(x, y, __FILE__, __LINE__) 448 #else 449 #define malloc(x) Malloc(x, NULL, 0) 450 #define memalign(x, y) Memalign(x, y, NULL, 0) 451 #define calloc(x, y) Calloc(x, y, NULL, 0) 452 #define free(x) Free(x, NULL, 0) 453 #define realloc(x, y) Realloc(x, y, NULL, 0) 454 #define reallocf(x, y) Reallocf(x, y, NULL, 0) 455 #endif 456 457 /* 458 * va <-> pa routines. MD code must supply. 459 */ 460 caddr_t ptov(uintptr_t); 461 462 #endif /* STAND_H */ 463