stand.h revision 83610
147195Sdcs/* 247195Sdcs * Copyright (c) 1998 Michael Smith. 350476Speter * All rights reserved. 447195Sdcs * 547195Sdcs * Redistribution and use in source and binary forms, with or without 647195Sdcs * modification, are permitted provided that the following conditions 747195Sdcs * are met: 847195Sdcs * 1. Redistributions of source code must retain the above copyright 947195Sdcs * notice, this list of conditions and the following disclaimer. 1047195Sdcs * 2. Redistributions in binary form must reproduce the above copyright 1147195Sdcs * notice, this list of conditions and the following disclaimer in the 1247195Sdcs * documentation and/or other materials provided with the distribution. 1347195Sdcs * 1447195Sdcs * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 1547195Sdcs * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1687636Sjhb * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 1747195Sdcs * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 1847195Sdcs * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 1947195Sdcs * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2087636Sjhb * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2147195Sdcs * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2247195Sdcs * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2347195Sdcs * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2487636Sjhb * SUCH DAMAGE. 2547195Sdcs * 2647195Sdcs * $FreeBSD: head/lib/libstand/stand.h 83610 2001-09-18 13:01:12Z sobomax $ 2747195Sdcs * From $NetBSD: stand.h,v 1.22 1997/06/26 19:17:40 drochner Exp $ 2847195Sdcs */ 2947199Sdcs 3047195Sdcs/*- 3147195Sdcs * Copyright (c) 1993 3247195Sdcs * The Regents of the University of California. All rights reserved. 3347195Sdcs * 3447195Sdcs * 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; 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, size_t size, 142 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 void (*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 157struct open_file { 158 int f_flags; /* see F_* below */ 159 struct devsw *f_dev; /* pointer to device operations */ 160 void *f_devdata; /* device specific data */ 161 struct fs_ops *f_ops; /* pointer to file system operations */ 162 void *f_fsdata; /* file system specific data */ 163 off_t f_offset; /* current file offset */ 164 char *f_rabuf; /* readahead buffer pointer */ 165 size_t f_ralen; /* valid data in readahead buffer */ 166 off_t f_raoffset; /* consumer offset in readahead buffer */ 167#define SOPEN_RASIZE 512 168}; 169 170#define SOPEN_MAX 8 171extern struct open_file files[]; 172 173/* f_flags values */ 174#define F_READ 0x0001 /* file opened for reading */ 175#define F_WRITE 0x0002 /* file opened for writing */ 176#define F_RAW 0x0004 /* raw device open - no file system */ 177#define F_NODEV 0x0008 /* network open - no device */ 178 179#define isascii(c) (((c) & ~0x7F) == 0) 180 181static __inline int isupper(int c) 182{ 183 return c >= 'A' && c <= 'Z'; 184} 185 186static __inline int islower(int c) 187{ 188 return c >= 'a' && c <= 'z'; 189} 190 191static __inline int isspace(int c) 192{ 193 return c == ' ' || (c >= 0x9 && c <= 0xd); 194} 195 196static __inline int isdigit(int c) 197{ 198 return c >= '0' && c <= '9'; 199} 200 201static __inline int isxdigit(int c) 202{ 203 return isdigit(c) || (c >= 'a' && c <= 'f') || (c >= 'A' && c <= 'F'); 204} 205 206static __inline int isalpha(int c) 207{ 208 return isupper(c) || islower(c); 209} 210 211static __inline int isalnum(int c) 212{ 213 return isalpha(c) || isdigit(c); 214} 215 216static __inline int toupper(int c) 217{ 218 return islower(c) ? c - 'a' + 'A' : c; 219} 220 221static __inline int tolower(int c) 222{ 223 return isupper(c) ? c - 'A' + 'a' : c; 224} 225 226/* sbrk emulation */ 227extern void setheap(void *base, void *top); 228extern char *sbrk(int incr); 229 230/* Matt Dillon's zalloc/zmalloc */ 231extern void *malloc(size_t bytes); 232extern void free(void *ptr); 233/*#define free(p) {CHK("free %p", p); free(p);} */ /* use for catching guard violations */ 234extern void *calloc(size_t n1, size_t n2); 235extern void *realloc(void *ptr, size_t size); 236extern void *reallocf(void *ptr, size_t size); 237extern void mallocstats(void); 238#ifdef __alpha__ 239extern void free_region(void *start, void *end); 240#endif 241 242/* disklabel support (undocumented, may be junk) */ 243struct disklabel; 244extern char *getdisklabel(const char *, struct disklabel *); 245 246extern int printf(const char *fmt, ...); 247extern void vprintf(const char *fmt, _BSD_VA_LIST_); 248extern int sprintf(char *buf, const char *cfmt, ...); 249extern void vsprintf(char *buf, const char *cfmt, _BSD_VA_LIST_); 250 251extern void twiddle(void); 252 253extern void ngets(char *, int); 254#define gets(x) ngets((x), 0) 255extern int fgetstr(char *buf, int size, int fd); 256 257extern int open(const char *, int); 258#define O_RDONLY 0x0 259#define O_WRONLY 0x1 /* writing not (yet?) supported */ 260#define O_RDWR 0x2 261extern int close(int); 262extern void closeall(void); 263extern ssize_t read(int, void *, size_t); 264extern ssize_t write(int, void *, size_t); 265extern struct dirent *readdirfd(int); 266 267extern void srandom(u_long seed); 268extern u_long random(void); 269 270/* imports from stdlib, locally modified */ 271extern long strtol(const char *, char **, int); 272extern char *optarg; /* getopt(3) external variables */ 273extern int optind, opterr, optopt, optreset; 274extern int getopt(int, char * const [], const char *); 275 276/* pager.c */ 277extern void pager_open(void); 278extern void pager_close(void); 279extern int pager_output(const char *lines); 280extern int pager_file(const char *fname); 281 282/* No signal state to preserve */ 283#define setjmp _setjmp 284#define longjmp _longjmp 285 286/* environment.c */ 287#define EV_DYNAMIC (1<<0) /* value was dynamically allocated, free if changed/unset */ 288#define EV_VOLATILE (1<<1) /* value is volatile, make a copy of it */ 289#define EV_NOHOOK (1<<2) /* don't call hook when setting */ 290 291struct env_var; 292typedef char *(ev_format_t)(struct env_var *ev); 293typedef int (ev_sethook_t)(struct env_var *ev, int flags, void *value); 294typedef int (ev_unsethook_t)(struct env_var *ev); 295 296struct env_var 297{ 298 char *ev_name; 299 int ev_flags; 300 void *ev_value; 301 ev_sethook_t *ev_sethook; 302 ev_unsethook_t *ev_unsethook; 303 struct env_var *ev_next, *ev_prev; 304}; 305extern struct env_var *environ; 306 307extern struct env_var *env_getenv(const char *name); 308extern int env_setenv(const char *name, int flags, 309 const void *value, ev_sethook_t sethook, 310 ev_unsethook_t unsethook); 311extern char *getenv(const char *name); 312extern int setenv(const char *name, const char *value, 313 int overwrite); 314extern int putenv(const char *string); 315extern int unsetenv(const char *name); 316 317extern ev_sethook_t env_noset; /* refuse set operation */ 318extern ev_unsethook_t env_nounset; /* refuse unset operation */ 319 320/* BCD conversions (undocumented) */ 321extern u_char const bcd2bin_data[]; 322extern u_char const bin2bcd_data[]; 323extern char const hex2ascii_data[]; 324 325#define bcd2bin(bcd) (bcd2bin_data[bcd]) 326#define bin2bcd(bin) (bin2bcd_data[bin]) 327#define hex2ascii(hex) (hex2ascii_data[hex]) 328 329/* min/max (undocumented) */ 330static __inline int imax(int a, int b) { return (a > b ? a : b); } 331static __inline int imin(int a, int b) { return (a < b ? a : b); } 332static __inline long lmax(long a, long b) { return (a > b ? a : b); } 333static __inline long lmin(long a, long b) { return (a < b ? a : b); } 334static __inline u_int max(u_int a, u_int b) { return (a > b ? a : b); } 335static __inline u_int min(u_int a, u_int b) { return (a < b ? a : b); } 336static __inline quad_t qmax(quad_t a, quad_t b) { return (a > b ? a : b); } 337static __inline quad_t qmin(quad_t a, quad_t b) { return (a < b ? a : b); } 338static __inline u_long ulmax(u_long a, u_long b) { return (a > b ? a : b); } 339static __inline u_long ulmin(u_long a, u_long b) { return (a < b ? a : b); } 340 341/* swaps (undocumented, useful?) */ 342#ifdef __i386__ 343extern u_int32_t bswap32(u_int32_t x); 344extern u_int64_t bswap64(u_int32_t x); 345#endif 346 347/* null functions for device/filesystem switches (undocumented) */ 348extern int nodev(void); 349extern int noioctl(struct open_file *, u_long, void *); 350extern void nullsys(void); 351 352extern int null_open(const char *path, struct open_file *f); 353extern int null_close(struct open_file *f); 354extern int null_read(struct open_file *f, void *buf, size_t size, size_t *resid); 355extern int null_write(struct open_file *f, void *buf, size_t size, size_t *resid); 356extern off_t null_seek(struct open_file *f, off_t offset, int where); 357extern int null_stat(struct open_file *f, struct stat *sb); 358extern int null_readdir(struct open_file *f, struct dirent *d); 359 360 361/* 362 * Machine dependent functions and data, must be provided or stubbed by 363 * the consumer 364 */ 365extern int getchar(void); 366extern int ischar(void); 367extern void putchar(int); 368extern int devopen(struct open_file *, const char *, const char **); 369extern int devclose(struct open_file *f); 370extern void panic(const char *, ...) __dead2; 371extern struct fs_ops *file_system[]; 372extern struct devsw *devsw[]; 373 374#if 0 375 376static inline void * 377malloc_debug(size_t size, const char *file, int line) 378{ 379 void *p; 380 printf("%s:%d malloc(%ld)", file, line, size); 381 p = malloc(size); 382 printf("=%p\n", p); 383 return p; 384} 385 386static inline void 387free_debug(void *p, const char *file, int line) 388{ 389 printf("%s:%d free(%p)\n", file, line, p); 390 free(p); 391} 392 393#define malloc(x) malloc_debug(x, __FILE__, __LINE__) 394#define free(x) free_debug(x, __FILE__, __LINE__) 395 396#endif 397