stand.h revision 65470
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 65470 2000-09-05 09:52:50Z msmith $ 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 dosfs_fsops; 126extern struct fs_ops ext2fs_fsops; 127 128/* where values for lseek(2) */ 129#define SEEK_SET 0 /* set file offset to offset */ 130#define SEEK_CUR 1 /* set file offset to current plus offset */ 131#define SEEK_END 2 /* set file offset to EOF plus offset */ 132 133/* 134 * Device switch 135 */ 136struct devsw { 137 const char dv_name[8]; 138 int dv_type; /* opaque type constant, arch-dependant */ 139 int (*dv_init)(void); /* early probe call */ 140 int (*dv_strategy)(void *devdata, int rw, daddr_t blk, size_t size, 141 char *buf, size_t *rsize); 142 int (*dv_open)(struct open_file *f, ...); 143 int (*dv_close)(struct open_file *f); 144 int (*dv_ioctl)(struct open_file *f, u_long cmd, void *data); 145 void (*dv_print)(int verbose); /* print device information */ 146 void (*dv_cleanup)(void); 147}; 148 149/* 150 * libstand-supplied device switch 151 */ 152extern struct devsw netdev; 153 154extern int errno; 155 156struct open_file { 157 int f_flags; /* see F_* below */ 158 struct devsw *f_dev; /* pointer to device operations */ 159 void *f_devdata; /* device specific data */ 160 struct fs_ops *f_ops; /* pointer to file system operations */ 161 void *f_fsdata; /* file system specific data */ 162 off_t f_offset; /* current file offset */ 163 char *f_rabuf; /* readahead buffer pointer */ 164 size_t f_ralen; /* valid data in readahead buffer */ 165 off_t f_raoffset; /* consumer offset in readahead buffer */ 166#define SOPEN_RASIZE 512 167}; 168 169#define SOPEN_MAX 8 170extern struct open_file files[]; 171 172/* f_flags values */ 173#define F_READ 0x0001 /* file opened for reading */ 174#define F_WRITE 0x0002 /* file opened for writing */ 175#define F_RAW 0x0004 /* raw device open - no file system */ 176#define F_NODEV 0x0008 /* network open - no device */ 177 178#define isupper(c) ((c) >= 'A' && (c) <= 'Z') 179#define islower(c) ((c) >= 'a' && (c) <= 'z') 180#define isspace(c) ((c) == ' ' || ((c) >= 0x9 && (c) <= 0xd)) 181#define isdigit(c) ((c) >= '0' && (c) <= '9') 182#define isxdigit(c) (isdigit(c) || ((c) >= 'a' && (c) <= 'f') || ((c) >= 'A' && (c) <= 'F')) 183#define isascii(c) (((c) & ~0x7F) == 0) 184#define isalpha(c) (isupper(c) || (islower(c))) 185 186static __inline int toupper(int c) 187{ 188 return islower(c) ? c - 'a' + 'A' : c; 189} 190 191static __inline int tolower(int c) 192{ 193 return isupper(c) ? c - 'A' + 'a' : c; 194} 195 196/* sbrk emulation */ 197extern void setheap(void *base, void *top); 198extern char *sbrk(int incr); 199 200/* Matt Dillon's zalloc/zmalloc */ 201extern void *malloc(size_t bytes); 202extern void free(void *ptr); 203/*#define free(p) {CHK("free %p", p); free(p);} */ /* use for catching guard violations */ 204extern void *calloc(size_t n1, size_t n2); 205extern void *realloc(void *ptr, size_t size); 206extern void *reallocf(void *ptr, size_t size); 207extern void mallocstats(void); 208#ifdef __alpha__ 209extern void free_region(void *start, void *end); 210#endif 211 212/* disklabel support (undocumented, may be junk) */ 213struct disklabel; 214extern char *getdisklabel(const char *, struct disklabel *); 215extern int dkcksum(struct disklabel *); 216 217extern int printf(const char *fmt, ...); 218extern void vprintf(const char *fmt, _BSD_VA_LIST_); 219extern int sprintf(char *buf, const char *cfmt, ...); 220extern void vsprintf(char *buf, const char *cfmt, _BSD_VA_LIST_); 221 222extern void twiddle(void); 223 224extern void ngets(char *, int); 225#define gets(x) ngets((x), 0) 226extern int fgetstr(char *buf, int size, int fd); 227 228extern int open(const char *, int); 229#define O_RDONLY 0x0 230#define O_WRONLY 0x1 /* writing not (yet?) supported */ 231#define O_RDWR 0x2 232extern int close(int); 233extern void closeall(void); 234extern ssize_t read(int, void *, size_t); 235extern ssize_t write(int, void *, size_t); 236extern struct dirent *readdirfd(int); 237 238extern void srandom(u_long seed); 239extern u_long random(void); 240 241/* imports from stdlib, locally modified */ 242extern long strtol(const char *, char **, int); 243extern char *optarg; /* getopt(3) external variables */ 244extern int optind, opterr, optopt, optreset; 245extern int getopt(int, char * const [], const char *); 246 247/* pager.c */ 248extern void pager_open(void); 249extern void pager_close(void); 250extern int pager_output(const char *lines); 251extern int pager_file(const char *fname); 252 253/* No signal state to preserve */ 254#define setjmp _setjmp 255#define longjmp _longjmp 256 257/* environment.c */ 258#define EV_DYNAMIC (1<<0) /* value was dynamically allocated, free if changed/unset */ 259#define EV_VOLATILE (1<<1) /* value is volatile, make a copy of it */ 260#define EV_NOHOOK (1<<2) /* don't call hook when setting */ 261 262struct env_var; 263typedef char *(ev_format_t)(struct env_var *ev); 264typedef int (ev_sethook_t)(struct env_var *ev, int flags, void *value); 265typedef int (ev_unsethook_t)(struct env_var *ev); 266 267struct env_var 268{ 269 char *ev_name; 270 int ev_flags; 271 void *ev_value; 272 ev_sethook_t *ev_sethook; 273 ev_unsethook_t *ev_unsethook; 274 struct env_var *ev_next, *ev_prev; 275}; 276extern struct env_var *environ; 277 278extern struct env_var *env_getenv(const char *name); 279extern int env_setenv(const char *name, int flags, 280 const void *value, ev_sethook_t sethook, 281 ev_unsethook_t unsethook); 282extern char *getenv(const char *name); 283extern int setenv(const char *name, const char *value, 284 int overwrite); 285extern int putenv(const char *string); 286extern int unsetenv(const char *name); 287 288extern ev_sethook_t env_noset; /* refuse set operation */ 289extern ev_unsethook_t env_nounset; /* refuse unset operation */ 290 291/* BCD conversions (undocumented) */ 292extern u_char const bcd2bin_data[]; 293extern u_char const bin2bcd_data[]; 294extern char const hex2ascii_data[]; 295 296#define bcd2bin(bcd) (bcd2bin_data[bcd]) 297#define bin2bcd(bin) (bin2bcd_data[bin]) 298#define hex2ascii(hex) (hex2ascii_data[hex]) 299 300/* min/max (undocumented) */ 301static __inline int imax(int a, int b) { return (a > b ? a : b); } 302static __inline int imin(int a, int b) { return (a < b ? a : b); } 303static __inline long lmax(long a, long b) { return (a > b ? a : b); } 304static __inline long lmin(long a, long b) { return (a < b ? a : b); } 305static __inline u_int max(u_int a, u_int b) { return (a > b ? a : b); } 306static __inline u_int min(u_int a, u_int b) { return (a < b ? a : b); } 307static __inline quad_t qmax(quad_t a, quad_t b) { return (a > b ? a : b); } 308static __inline quad_t qmin(quad_t a, quad_t b) { return (a < b ? a : b); } 309static __inline u_long ulmax(u_long a, u_long b) { return (a > b ? a : b); } 310static __inline u_long ulmin(u_long a, u_long b) { return (a < b ? a : b); } 311 312/* swaps (undocumented, useful?) */ 313#ifdef __i386__ 314extern u_int32_t bswap32(u_int32_t x); 315extern u_int64_t bswap64(u_int32_t x); 316#endif 317 318/* null functions for device/filesystem switches (undocumented) */ 319extern int nodev(void); 320extern int noioctl(struct open_file *, u_long, void *); 321extern void nullsys(void); 322 323extern int null_open(const char *path, struct open_file *f); 324extern int null_close(struct open_file *f); 325extern int null_read(struct open_file *f, void *buf, size_t size, size_t *resid); 326extern int null_write(struct open_file *f, void *buf, size_t size, size_t *resid); 327extern off_t null_seek(struct open_file *f, off_t offset, int where); 328extern int null_stat(struct open_file *f, struct stat *sb); 329extern int null_readdir(struct open_file *f, struct dirent *d); 330 331 332/* 333 * Machine dependent functions and data, must be provided or stubbed by 334 * the consumer 335 */ 336extern int getchar(void); 337extern int ischar(void); 338extern void putchar(int); 339extern int devopen(struct open_file *, const char *, const char **); 340extern int devclose(struct open_file *f); 341extern void panic(const char *, ...) __dead2; 342extern struct fs_ops *file_system[]; 343extern struct devsw *devsw[]; 344 345#if 0 346 347static inline void * 348malloc_debug(size_t size, const char *file, int line) 349{ 350 void *p; 351 printf("%s:%d malloc(%ld)", file, line, size); 352 p = malloc(size); 353 printf("=%p\n", p); 354 return p; 355} 356 357static inline void 358free_debug(void *p, const char *file, int line) 359{ 360 printf("%s:%d free(%p)\n", file, line, p); 361 free(p); 362} 363 364#define malloc(x) malloc_debug(x, __FILE__, __LINE__) 365#define free(x) free_debug(x, __FILE__, __LINE__) 366 367#endif 368