stand.h revision 329114
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: stable/11/lib/libstand/stand.h 329114 2018-02-11 02:27:50Z kevans $ 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 * 4. 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 69/* this header intentionally exports NULL from <string.h> */ 70#include <string.h> 71 72#define CHK(fmt, args...) printf("%s(%d): " fmt "\n", __func__, __LINE__ , ##args) 73#define PCHK(fmt, args...) {printf("%s(%d): " fmt "\n", __func__, __LINE__ , ##args); getchar();} 74 75/* Avoid unwanted userlandish components */ 76#define _KERNEL 77#include <sys/errno.h> 78#undef _KERNEL 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 91struct open_file; 92 93/* 94 * This structure is used to define file system operations in a file system 95 * independent way. 96 * 97 * XXX note that filesystem providers should export a pointer to their fs_ops 98 * struct, so that consumers can reference this and thus include the 99 * filesystems that they require. 100 */ 101struct fs_ops { 102 const char *fs_name; 103 int (*fo_open)(const char *path, struct open_file *f); 104 int (*fo_close)(struct open_file *f); 105 int (*fo_read)(struct open_file *f, void *buf, 106 size_t size, size_t *resid); 107 int (*fo_write)(struct open_file *f, void *buf, 108 size_t size, size_t *resid); 109 off_t (*fo_seek)(struct open_file *f, off_t offset, int where); 110 int (*fo_stat)(struct open_file *f, struct stat *sb); 111 int (*fo_readdir)(struct open_file *f, struct dirent *d); 112}; 113 114/* 115 * libstand-supplied filesystems 116 */ 117extern struct fs_ops ufs_fsops; 118extern struct fs_ops tftp_fsops; 119extern struct fs_ops nfs_fsops; 120extern struct fs_ops cd9660_fsops; 121extern struct fs_ops nandfs_fsops; 122extern struct fs_ops gzipfs_fsops; 123extern struct fs_ops bzipfs_fsops; 124extern struct fs_ops dosfs_fsops; 125extern struct fs_ops ext2fs_fsops; 126extern struct fs_ops splitfs_fsops; 127extern struct fs_ops pkgfs_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 */ 137struct devsw { 138 const char dv_name[8]; 139 int dv_type; /* opaque type constant, arch-dependant */ 140 int (*dv_init)(void); /* early probe call */ 141 int (*dv_strategy)(void *devdata, int rw, daddr_t blk, 142 size_t size, char *buf, size_t *rsize); 143 int (*dv_open)(struct open_file *f, ...); 144 int (*dv_close)(struct open_file *f); 145 int (*dv_ioctl)(struct open_file *f, u_long cmd, void *data); 146 int (*dv_print)(int verbose); /* print device information */ 147 void (*dv_cleanup)(void); 148}; 149 150/* 151 * libstand-supplied device switch 152 */ 153extern struct devsw netdev; 154 155extern int errno; 156 157/* 158 * Generic device specifier; architecture-dependent 159 * versions may be larger, but should be allowed to 160 * overlap. 161 */ 162struct devdesc 163{ 164 struct devsw *d_dev; 165 int d_type; 166#define DEVT_NONE 0 167#define DEVT_DISK 1 168#define DEVT_NET 2 169#define DEVT_CD 3 170#define DEVT_ZFS 4 171#define DEVT_FD 5 172 int d_unit; 173 void *d_opendata; 174}; 175 176struct open_file { 177 int f_flags; /* see F_* below */ 178 struct devsw *f_dev; /* pointer to device operations */ 179 void *f_devdata; /* device specific data */ 180 struct fs_ops *f_ops; /* pointer to file system operations */ 181 void *f_fsdata; /* file system specific data */ 182 off_t f_offset; /* current file offset */ 183 char *f_rabuf; /* readahead buffer pointer */ 184 size_t f_ralen; /* valid data in readahead buffer */ 185 off_t f_raoffset; /* consumer offset in readahead buffer */ 186#define SOPEN_RASIZE 512 187}; 188 189#define SOPEN_MAX 64 190extern struct open_file files[]; 191 192/* f_flags values */ 193#define F_READ 0x0001 /* file opened for reading */ 194#define F_WRITE 0x0002 /* file opened for writing */ 195#define F_RAW 0x0004 /* raw device open - no file system */ 196#define F_NODEV 0x0008 /* network open - no device */ 197#define F_MASK 0xFFFF 198/* Mode modifier for strategy() */ 199#define F_NORA (0x01 << 16) /* Disable Read-Ahead */ 200 201#define isascii(c) (((c) & ~0x7F) == 0) 202 203static __inline int isupper(int c) 204{ 205 return c >= 'A' && c <= 'Z'; 206} 207 208static __inline int islower(int c) 209{ 210 return c >= 'a' && c <= 'z'; 211} 212 213static __inline int isspace(int c) 214{ 215 return c == ' ' || (c >= 0x9 && c <= 0xd); 216} 217 218static __inline int isdigit(int c) 219{ 220 return c >= '0' && c <= '9'; 221} 222 223static __inline int isxdigit(int c) 224{ 225 return isdigit(c) || (c >= 'a' && c <= 'f') || (c >= 'A' && c <= 'F'); 226} 227 228static __inline int isalpha(int c) 229{ 230 return isupper(c) || islower(c); 231} 232 233static __inline int isalnum(int c) 234{ 235 return isalpha(c) || isdigit(c); 236} 237 238static __inline int toupper(int c) 239{ 240 return islower(c) ? c - 'a' + 'A' : c; 241} 242 243static __inline int tolower(int c) 244{ 245 return isupper(c) ? c - 'A' + 'a' : c; 246} 247 248/* sbrk emulation */ 249extern void setheap(void *base, void *top); 250extern char *sbrk(int incr); 251 252/* Matt Dillon's zalloc/zmalloc */ 253extern void *malloc(size_t bytes); 254extern void free(void *ptr); 255/*#define free(p) {CHK("free %p", p); free(p);} */ /* use for catching guard violations */ 256extern void *calloc(size_t n1, size_t n2); 257extern void *realloc(void *ptr, size_t size); 258extern void *reallocf(void *ptr, size_t size); 259extern void mallocstats(void); 260 261extern int printf(const char *fmt, ...) __printflike(1, 2); 262extern void vprintf(const char *fmt, __va_list); 263extern int sprintf(char *buf, const char *cfmt, ...) __printflike(2, 3); 264extern int snprintf(char *buf, size_t size, const char *cfmt, ...) __printflike(3, 4); 265extern void vsprintf(char *buf, const char *cfmt, __va_list); 266 267extern void twiddle(u_int callerdiv); 268extern void twiddle_divisor(u_int globaldiv); 269 270extern void ngets(char *, int); 271#define gets(x) ngets((x), 0) 272extern int fgetstr(char *buf, int size, int fd); 273 274extern int open(const char *, int); 275#define O_RDONLY 0x0 276#define O_WRONLY 0x1 277#define O_RDWR 0x2 278extern int close(int); 279extern void closeall(void); 280extern ssize_t read(int, void *, size_t); 281extern ssize_t write(int, void *, size_t); 282extern struct dirent *readdirfd(int); 283 284extern void srandom(u_long seed); 285extern long random(void); 286 287/* imports from stdlib, locally modified */ 288extern long strtol(const char *, char **, int); 289extern unsigned long strtoul(const char *, char **, int); 290extern char *optarg; /* getopt(3) external variables */ 291extern int optind, opterr, optopt, optreset; 292extern int getopt(int, char * const [], const char *); 293 294/* pager.c */ 295extern void pager_open(void); 296extern void pager_close(void); 297extern int pager_output(const char *lines); 298extern int pager_file(const char *fname); 299 300/* No signal state to preserve */ 301#define setjmp _setjmp 302#define longjmp _longjmp 303 304/* environment.c */ 305#define EV_DYNAMIC (1<<0) /* value was dynamically allocated, free if changed/unset */ 306#define EV_VOLATILE (1<<1) /* value is volatile, make a copy of it */ 307#define EV_NOHOOK (1<<2) /* don't call hook when setting */ 308 309struct env_var; 310typedef char *(ev_format_t)(struct env_var *ev); 311typedef int (ev_sethook_t)(struct env_var *ev, int flags, 312 const void *value); 313typedef int (ev_unsethook_t)(struct env_var *ev); 314 315struct env_var 316{ 317 char *ev_name; 318 int ev_flags; 319 void *ev_value; 320 ev_sethook_t *ev_sethook; 321 ev_unsethook_t *ev_unsethook; 322 struct env_var *ev_next, *ev_prev; 323}; 324extern struct env_var *environ; 325 326extern struct env_var *env_getenv(const char *name); 327extern int env_setenv(const char *name, int flags, 328 const void *value, ev_sethook_t sethook, 329 ev_unsethook_t unsethook); 330extern char *getenv(const char *name); 331extern int setenv(const char *name, const char *value, 332 int overwrite); 333extern int putenv(char *string); 334extern int unsetenv(const char *name); 335 336extern ev_sethook_t env_noset; /* refuse set operation */ 337extern ev_unsethook_t env_nounset; /* refuse unset operation */ 338 339/* BCD conversions (undocumented) */ 340extern u_char const bcd2bin_data[]; 341extern u_char const bin2bcd_data[]; 342extern char const hex2ascii_data[]; 343 344#define bcd2bin(bcd) (bcd2bin_data[bcd]) 345#define bin2bcd(bin) (bin2bcd_data[bin]) 346#define hex2ascii(hex) (hex2ascii_data[hex]) 347 348/* min/max (undocumented) */ 349static __inline int imax(int a, int b) { return (a > b ? a : b); } 350static __inline int imin(int a, int b) { return (a < b ? a : b); } 351static __inline long lmax(long a, long b) { return (a > b ? a : b); } 352static __inline long lmin(long a, long b) { return (a < b ? a : b); } 353static __inline u_int max(u_int a, u_int b) { return (a > b ? a : b); } 354static __inline u_int min(u_int a, u_int b) { return (a < b ? a : b); } 355static __inline quad_t qmax(quad_t a, quad_t b) { return (a > b ? a : b); } 356static __inline quad_t qmin(quad_t a, quad_t b) { return (a < b ? a : b); } 357static __inline u_long ulmax(u_long a, u_long b) { return (a > b ? a : b); } 358static __inline u_long ulmin(u_long a, u_long b) { return (a < b ? a : b); } 359 360 361/* null functions for device/filesystem switches (undocumented) */ 362extern int nodev(void); 363extern int noioctl(struct open_file *, u_long, void *); 364extern void nullsys(void); 365 366extern int null_open(const char *path, struct open_file *f); 367extern int null_close(struct open_file *f); 368extern int null_read(struct open_file *f, void *buf, size_t size, size_t *resid); 369extern int null_write(struct open_file *f, void *buf, size_t size, size_t *resid); 370extern off_t null_seek(struct open_file *f, off_t offset, int where); 371extern int null_stat(struct open_file *f, struct stat *sb); 372extern int null_readdir(struct open_file *f, struct dirent *d); 373 374 375/* 376 * Machine dependent functions and data, must be provided or stubbed by 377 * the consumer 378 */ 379extern void exit(int); 380extern int getchar(void); 381extern int ischar(void); 382extern void putchar(int); 383extern int devopen(struct open_file *, const char *, const char **); 384extern int devclose(struct open_file *f); 385extern void panic(const char *, ...) __dead2 __printflike(1, 2); 386extern struct fs_ops *file_system[]; 387extern struct fs_ops *exclusive_file_system; 388extern struct devsw *devsw[]; 389 390/* 391 * Expose byteorder(3) functions. 392 */ 393#ifndef _BYTEORDER_PROTOTYPED 394#define _BYTEORDER_PROTOTYPED 395extern uint32_t htonl(uint32_t); 396extern uint16_t htons(uint16_t); 397extern uint32_t ntohl(uint32_t); 398extern uint16_t ntohs(uint16_t); 399#endif 400 401#ifndef _BYTEORDER_FUNC_DEFINED 402#define _BYTEORDER_FUNC_DEFINED 403#define htonl(x) __htonl(x) 404#define htons(x) __htons(x) 405#define ntohl(x) __ntohl(x) 406#define ntohs(x) __ntohs(x) 407#endif 408 409void *Malloc(size_t, const char *, int); 410void *Calloc(size_t, size_t, const char *, int); 411void *Realloc(void *, size_t, const char *, int); 412void Free(void *, const char *, int); 413 414#if 1 415#define malloc(x) Malloc(x, __FILE__, __LINE__) 416#define calloc(x, y) Calloc(x, y, __FILE__, __LINE__) 417#define free(x) Free(x, __FILE__, __LINE__) 418#define realloc(x, y) Realloc(x, y, __FILE__, __LINE__) 419#else 420#define malloc(x) Malloc(x, NULL, 0) 421#define calloc(x, y) Calloc(x, y, NULL, 0) 422#define free(x) Free(x, NULL, 0) 423#define realloc(x, y) Realloc(x, y, NULL, 0) 424#endif 425 426#endif /* STAND_H */ 427