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