stand.h revision 100394
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: head/lib/libstand/stand.h 100394 2002-07-20 04:18:20Z peter $ 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. All advertising materials mentioning features or use of this software 43 * must display the following acknowledgement: 44 * This product includes software developed by the University of 45 * California, Berkeley and its contributors. 46 * 4. Neither the name of the University nor the names of its contributors 47 * may be used to endorse or promote products derived from this software 48 * without specific prior written permission. 49 * 50 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 51 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 52 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 53 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 54 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 55 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 56 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 57 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 58 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 59 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 60 * SUCH DAMAGE. 61 * 62 * @(#)stand.h 8.1 (Berkeley) 6/11/93 63 */ 64 65#include <sys/types.h> 66#include <sys/cdefs.h> 67#include <sys/stat.h> 68#include <sys/dirent.h> 69#include <string.h> 70 71#define CHK(fmt, args...) printf("%s(%d): " fmt "\n", __FUNCTION__, __LINE__ , ##args) 72#define PCHK(fmt, args...) {printf("%s(%d): " fmt "\n", __FUNCTION__, __LINE__ , ##args); getchar();} 73 74#ifndef NULL 75#define NULL 0 76#endif 77 78/* Avoid unwanted userlandish components */ 79#define _KERNEL 80#include <sys/errno.h> 81#undef _KERNEL 82 83/* special stand error codes */ 84#define EADAPT (ELAST+1) /* bad adaptor */ 85#define ECTLR (ELAST+2) /* bad controller */ 86#define EUNIT (ELAST+3) /* bad unit */ 87#define ESLICE (ELAST+4) /* bad slice */ 88#define EPART (ELAST+5) /* bad partition */ 89#define ERDLAB (ELAST+6) /* can't read disk label */ 90#define EUNLAB (ELAST+7) /* unlabeled disk */ 91#define EOFFSET (ELAST+8) /* relative seek not supported */ 92#define ESALAST (ELAST+8) /* */ 93 94struct open_file; 95 96/* 97 * This structure is used to define file system operations in a file system 98 * independent way. 99 * 100 * XXX note that filesystem providers should export a pointer to their fs_ops 101 * struct, so that consumers can reference this and thus include the 102 * filesystems that they require. 103 */ 104struct fs_ops { 105 const char *fs_name; 106 int (*fo_open)(const char *path, struct open_file *f); 107 int (*fo_close)(struct open_file *f); 108 int (*fo_read)(struct open_file *f, void *buf, 109 size_t size, size_t *resid); 110 int (*fo_write)(struct open_file *f, void *buf, 111 size_t size, size_t *resid); 112 off_t (*fo_seek)(struct open_file *f, off_t offset, int where); 113 int (*fo_stat)(struct open_file *f, struct stat *sb); 114 int (*fo_readdir)(struct open_file *f, struct dirent *d); 115}; 116 117/* 118 * libstand-supplied filesystems 119 */ 120extern struct fs_ops ufs_fsops; 121extern struct fs_ops tftp_fsops; 122extern struct fs_ops nfs_fsops; 123extern struct fs_ops cd9660_fsops; 124extern struct fs_ops zipfs_fsops; 125extern struct fs_ops bzipfs_fsops; 126extern struct fs_ops dosfs_fsops; 127extern struct fs_ops ext2fs_fsops; 128extern struct fs_ops splitfs_fsops; 129 130/* where values for lseek(2) */ 131#define SEEK_SET 0 /* set file offset to offset */ 132#define SEEK_CUR 1 /* set file offset to current plus offset */ 133#define SEEK_END 2 /* set file offset to EOF plus offset */ 134 135/* 136 * Device switch 137 */ 138struct devsw { 139 const char dv_name[8]; 140 int dv_type; /* opaque type constant, arch-dependant */ 141 int (*dv_init)(void); /* early probe call */ 142 int (*dv_strategy)(void *devdata, int rw, daddr_t blk, size_t size, 143 char *buf, size_t *rsize); 144 int (*dv_open)(struct open_file *f, ...); 145 int (*dv_close)(struct open_file *f); 146 int (*dv_ioctl)(struct open_file *f, u_long cmd, void *data); 147 void (*dv_print)(int verbose); /* print device information */ 148 void (*dv_cleanup)(void); 149}; 150 151/* 152 * libstand-supplied device switch 153 */ 154extern struct devsw netdev; 155 156extern int errno; 157 158struct open_file { 159 int f_flags; /* see F_* below */ 160 struct devsw *f_dev; /* pointer to device operations */ 161 void *f_devdata; /* device specific data */ 162 struct fs_ops *f_ops; /* pointer to file system operations */ 163 void *f_fsdata; /* file system specific data */ 164 off_t f_offset; /* current file offset */ 165 char *f_rabuf; /* readahead buffer pointer */ 166 size_t f_ralen; /* valid data in readahead buffer */ 167 off_t f_raoffset; /* consumer offset in readahead buffer */ 168#define SOPEN_RASIZE 512 169}; 170 171#define SOPEN_MAX 8 172extern struct open_file files[]; 173 174/* f_flags values */ 175#define F_READ 0x0001 /* file opened for reading */ 176#define F_WRITE 0x0002 /* file opened for writing */ 177#define F_RAW 0x0004 /* raw device open - no file system */ 178#define F_NODEV 0x0008 /* network open - no device */ 179 180#define isascii(c) (((c) & ~0x7F) == 0) 181 182static __inline int isupper(int c) 183{ 184 return c >= 'A' && c <= 'Z'; 185} 186 187static __inline int islower(int c) 188{ 189 return c >= 'a' && c <= 'z'; 190} 191 192static __inline int isspace(int c) 193{ 194 return c == ' ' || (c >= 0x9 && c <= 0xd); 195} 196 197static __inline int isdigit(int c) 198{ 199 return c >= '0' && c <= '9'; 200} 201 202static __inline int isxdigit(int c) 203{ 204 return isdigit(c) || (c >= 'a' && c <= 'f') || (c >= 'A' && c <= 'F'); 205} 206 207static __inline int isalpha(int c) 208{ 209 return isupper(c) || islower(c); 210} 211 212static __inline int isalnum(int c) 213{ 214 return isalpha(c) || isdigit(c); 215} 216 217static __inline int toupper(int c) 218{ 219 return islower(c) ? c - 'a' + 'A' : c; 220} 221 222static __inline int tolower(int c) 223{ 224 return isupper(c) ? c - 'A' + 'a' : c; 225} 226 227/* sbrk emulation */ 228extern void setheap(void *base, void *top); 229extern char *sbrk(int incr); 230 231/* Matt Dillon's zalloc/zmalloc */ 232extern void *malloc(size_t bytes); 233extern void free(void *ptr); 234/*#define free(p) {CHK("free %p", p); free(p);} */ /* use for catching guard violations */ 235extern void *calloc(size_t n1, size_t n2); 236extern void *realloc(void *ptr, size_t size); 237extern void *reallocf(void *ptr, size_t size); 238extern void mallocstats(void); 239#ifdef __alpha__ 240extern void free_region(void *start, void *end); 241#endif 242 243/* disklabel support (undocumented, may be junk) */ 244struct disklabel; 245extern char *getdisklabel(const char *, struct disklabel *); 246 247extern int printf(const char *fmt, ...) __printflike(1, 2); 248extern void vprintf(const char *fmt, _BSD_VA_LIST_); 249extern int sprintf(char *buf, const char *cfmt, ...) __printflike(2, 3); 250extern void vsprintf(char *buf, const char *cfmt, _BSD_VA_LIST_); 251 252extern void twiddle(void); 253 254extern void ngets(char *, int); 255#define gets(x) ngets((x), 0) 256extern int fgetstr(char *buf, int size, int fd); 257 258extern int open(const char *, int); 259#define O_RDONLY 0x0 260#define O_WRONLY 0x1 261#define O_RDWR 0x2 262extern int close(int); 263extern void closeall(void); 264extern ssize_t read(int, void *, size_t); 265extern ssize_t write(int, void *, size_t); 266extern struct dirent *readdirfd(int); 267 268extern void srandom(u_long seed); 269extern u_long random(void); 270 271/* imports from stdlib, locally modified */ 272extern long strtol(const char *, char **, int); 273extern char *optarg; /* getopt(3) external variables */ 274extern int optind, opterr, optopt, optreset; 275extern int getopt(int, char * const [], const char *); 276 277/* pager.c */ 278extern void pager_open(void); 279extern void pager_close(void); 280extern int pager_output(const char *lines); 281extern int pager_file(const char *fname); 282 283/* No signal state to preserve */ 284#define setjmp _setjmp 285#define longjmp _longjmp 286 287/* environment.c */ 288#define EV_DYNAMIC (1<<0) /* value was dynamically allocated, free if changed/unset */ 289#define EV_VOLATILE (1<<1) /* value is volatile, make a copy of it */ 290#define EV_NOHOOK (1<<2) /* don't call hook when setting */ 291 292struct env_var; 293typedef char *(ev_format_t)(struct env_var *ev); 294typedef int (ev_sethook_t)(struct env_var *ev, int flags, void *value); 295typedef int (ev_unsethook_t)(struct env_var *ev); 296 297struct env_var 298{ 299 char *ev_name; 300 int ev_flags; 301 void *ev_value; 302 ev_sethook_t *ev_sethook; 303 ev_unsethook_t *ev_unsethook; 304 struct env_var *ev_next, *ev_prev; 305}; 306extern struct env_var *environ; 307 308extern struct env_var *env_getenv(const char *name); 309extern int env_setenv(const char *name, int flags, 310 const void *value, ev_sethook_t sethook, 311 ev_unsethook_t unsethook); 312extern char *getenv(const char *name); 313extern int setenv(const char *name, const char *value, 314 int overwrite); 315extern int putenv(const char *string); 316extern int unsetenv(const char *name); 317 318extern ev_sethook_t env_noset; /* refuse set operation */ 319extern ev_unsethook_t env_nounset; /* refuse unset operation */ 320 321/* BCD conversions (undocumented) */ 322extern u_char const bcd2bin_data[]; 323extern u_char const bin2bcd_data[]; 324extern char const hex2ascii_data[]; 325 326#define bcd2bin(bcd) (bcd2bin_data[bcd]) 327#define bin2bcd(bin) (bin2bcd_data[bin]) 328#define hex2ascii(hex) (hex2ascii_data[hex]) 329 330/* min/max (undocumented) */ 331static __inline int imax(int a, int b) { return (a > b ? a : b); } 332static __inline int imin(int a, int b) { return (a < b ? a : b); } 333static __inline long lmax(long a, long b) { return (a > b ? a : b); } 334static __inline long lmin(long a, long b) { return (a < b ? a : b); } 335static __inline u_int max(u_int a, u_int b) { return (a > b ? a : b); } 336static __inline u_int min(u_int a, u_int b) { return (a < b ? a : b); } 337static __inline quad_t qmax(quad_t a, quad_t b) { return (a > b ? a : b); } 338static __inline quad_t qmin(quad_t a, quad_t b) { return (a < b ? a : b); } 339static __inline u_long ulmax(u_long a, u_long b) { return (a > b ? a : b); } 340static __inline u_long ulmin(u_long a, u_long b) { return (a < b ? a : b); } 341 342/* swaps (undocumented, useful?) */ 343#ifdef __i386__ 344extern u_int32_t bswap32(u_int32_t x); 345extern u_int64_t bswap64(u_int64_t x); 346#endif 347 348/* null functions for device/filesystem switches (undocumented) */ 349extern int nodev(void); 350extern int noioctl(struct open_file *, u_long, void *); 351extern void nullsys(void); 352 353extern int null_open(const char *path, struct open_file *f); 354extern int null_close(struct open_file *f); 355extern int null_read(struct open_file *f, void *buf, size_t size, size_t *resid); 356extern int null_write(struct open_file *f, void *buf, size_t size, size_t *resid); 357extern off_t null_seek(struct open_file *f, off_t offset, int where); 358extern int null_stat(struct open_file *f, struct stat *sb); 359extern int null_readdir(struct open_file *f, struct dirent *d); 360 361 362/* 363 * Machine dependent functions and data, must be provided or stubbed by 364 * the consumer 365 */ 366extern int getchar(void); 367extern int ischar(void); 368extern void putchar(int); 369extern int devopen(struct open_file *, const char *, const char **); 370extern int devclose(struct open_file *f); 371extern void panic(const char *, ...) __dead2; 372extern struct fs_ops *file_system[]; 373extern struct devsw *devsw[]; 374 375/* 376 * Expose byteorder(3) functions. 377 */ 378#ifndef _BYTEORDER_PROTOTYPED 379#define _BYTEORDER_PROTOTYPED 380extern uint32_t htonl(uint32_t); 381extern uint16_t htons(uint16_t); 382extern uint32_t ntohl(uint32_t); 383extern uint16_t ntohs(uint16_t); 384#endif 385 386#ifndef _BYTEORDER_FUNC_DEFINED 387#define _BYTEORDER_FUNC_DEFINED 388#define htonl(x) __htonl(x) 389#define htons(x) __htons(x) 390#define ntohl(x) __ntohl(x) 391#define ntohs(x) __ntohs(x) 392#endif 393 394void *Malloc(size_t, const char *, int); 395void *Calloc(size_t, size_t, const char *, int); 396void *Realloc(void *, size_t, const char *, int); 397void Free(void *, const char *, int); 398 399#if 1 400#define malloc(x) Malloc(x, __FILE__, __LINE__) 401#define calloc(x, y) Calloc(x, y, __FILE__, __LINE__) 402#define free(x) Free(x, __FILE__, __LINE__) 403#define realloc(x, y) Realloc(x, y, __FILE__, __LINE__) 404#else 405#define malloc(x) Malloc(x, NULL 0) 406#define calloc(x, y) Calloc(x, y, NULL, 0) 407#define free(x) Free(x, NULL, 0) 408#define realloc(x, y) Realloc(x, y, NULL, 0) 409#endif 410