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