stand.h revision 182748
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 182748 2008-09-04 10:05:44Z raj $ 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 * 4. Neither the name of the University nor the names of its contributors 43 * may be used to endorse or promote products derived from this software 44 * without specific prior written permission. 45 * 46 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 47 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 48 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 49 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 50 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 51 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 52 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 53 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 54 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 55 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 56 * SUCH DAMAGE. 57 * 58 * @(#)stand.h 8.1 (Berkeley) 6/11/93 59 */ 60 61#ifndef STAND_H 62#define STAND_H 63 64#include <sys/types.h> 65#include <sys/cdefs.h> 66#include <sys/stat.h> 67#include <sys/dirent.h> 68#include <string.h> 69 70#define CHK(fmt, args...) printf("%s(%d): " fmt "\n", __func__, __LINE__ , ##args) 71#define PCHK(fmt, args...) {printf("%s(%d): " fmt "\n", __func__, __LINE__ , ##args); getchar();} 72 73#ifndef NULL 74#define NULL 0 75#endif 76 77/* Avoid unwanted userlandish components */ 78#define _KERNEL 79#include <sys/errno.h> 80#undef _KERNEL 81 82/* special stand error codes */ 83#define EADAPT (ELAST+1) /* bad adaptor */ 84#define ECTLR (ELAST+2) /* bad controller */ 85#define EUNIT (ELAST+3) /* bad unit */ 86#define ESLICE (ELAST+4) /* bad slice */ 87#define EPART (ELAST+5) /* bad partition */ 88#define ERDLAB (ELAST+6) /* can't read disk label */ 89#define EUNLAB (ELAST+7) /* unlabeled disk */ 90#define EOFFSET (ELAST+8) /* relative seek not supported */ 91#define ESALAST (ELAST+8) /* */ 92 93struct open_file; 94 95/* 96 * This structure is used to define file system operations in a file system 97 * independent way. 98 * 99 * XXX note that filesystem providers should export a pointer to their fs_ops 100 * struct, so that consumers can reference this and thus include the 101 * filesystems that they require. 102 */ 103struct fs_ops { 104 const char *fs_name; 105 int (*fo_open)(const char *path, struct open_file *f); 106 int (*fo_close)(struct open_file *f); 107 int (*fo_read)(struct open_file *f, void *buf, 108 size_t size, size_t *resid); 109 int (*fo_write)(struct open_file *f, void *buf, 110 size_t size, size_t *resid); 111 off_t (*fo_seek)(struct open_file *f, off_t offset, int where); 112 int (*fo_stat)(struct open_file *f, struct stat *sb); 113 int (*fo_readdir)(struct open_file *f, struct dirent *d); 114}; 115 116/* 117 * libstand-supplied filesystems 118 */ 119extern struct fs_ops ufs_fsops; 120extern struct fs_ops tftp_fsops; 121extern struct fs_ops nfs_fsops; 122extern struct fs_ops cd9660_fsops; 123extern struct fs_ops gzipfs_fsops; 124extern struct fs_ops bzipfs_fsops; 125extern struct fs_ops dosfs_fsops; 126extern struct fs_ops ext2fs_fsops; 127extern struct fs_ops splitfs_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 239/* disklabel support (undocumented, may be junk) */ 240struct disklabel; 241extern char *getdisklabel(const char *, struct disklabel *); 242 243extern int printf(const char *fmt, ...) __printflike(1, 2); 244extern void vprintf(const char *fmt, __va_list); 245extern int sprintf(char *buf, const char *cfmt, ...) __printflike(2, 3); 246extern void vsprintf(char *buf, const char *cfmt, __va_list); 247 248extern void twiddle(void); 249 250extern void ngets(char *, int); 251#define gets(x) ngets((x), 0) 252extern int fgetstr(char *buf, int size, int fd); 253 254extern int open(const char *, int); 255#define O_RDONLY 0x0 256#define O_WRONLY 0x1 257#define O_RDWR 0x2 258extern int close(int); 259extern void closeall(void); 260extern ssize_t read(int, void *, size_t); 261extern ssize_t write(int, void *, size_t); 262extern struct dirent *readdirfd(int); 263 264extern void srandom(u_long seed); 265extern u_long random(void); 266 267/* imports from stdlib, locally modified */ 268extern long strtol(const char *, char **, int); 269extern char *optarg; /* getopt(3) external variables */ 270extern int optind, opterr, optopt, optreset; 271extern int getopt(int, char * const [], const char *); 272 273/* pager.c */ 274extern void pager_open(void); 275extern void pager_close(void); 276extern int pager_output(const char *lines); 277extern int pager_file(const char *fname); 278 279/* No signal state to preserve */ 280#define setjmp _setjmp 281#define longjmp _longjmp 282 283/* environment.c */ 284#define EV_DYNAMIC (1<<0) /* value was dynamically allocated, free if changed/unset */ 285#define EV_VOLATILE (1<<1) /* value is volatile, make a copy of it */ 286#define EV_NOHOOK (1<<2) /* don't call hook when setting */ 287 288struct env_var; 289typedef char *(ev_format_t)(struct env_var *ev); 290typedef int (ev_sethook_t)(struct env_var *ev, int flags, 291 const void *value); 292typedef int (ev_unsethook_t)(struct env_var *ev); 293 294struct env_var 295{ 296 char *ev_name; 297 int ev_flags; 298 void *ev_value; 299 ev_sethook_t *ev_sethook; 300 ev_unsethook_t *ev_unsethook; 301 struct env_var *ev_next, *ev_prev; 302}; 303extern struct env_var *environ; 304 305extern struct env_var *env_getenv(const char *name); 306extern int env_setenv(const char *name, int flags, 307 const void *value, ev_sethook_t sethook, 308 ev_unsethook_t unsethook); 309extern char *getenv(const char *name); 310extern int setenv(const char *name, const char *value, 311 int overwrite); 312extern int putenv(const char *string); 313extern int unsetenv(const char *name); 314 315extern ev_sethook_t env_noset; /* refuse set operation */ 316extern ev_unsethook_t env_nounset; /* refuse unset operation */ 317 318/* BCD conversions (undocumented) */ 319extern u_char const bcd2bin_data[]; 320extern u_char const bin2bcd_data[]; 321extern char const hex2ascii_data[]; 322 323#define bcd2bin(bcd) (bcd2bin_data[bcd]) 324#define bin2bcd(bin) (bin2bcd_data[bin]) 325#define hex2ascii(hex) (hex2ascii_data[hex]) 326 327/* min/max (undocumented) */ 328static __inline int imax(int a, int b) { return (a > b ? a : b); } 329static __inline int imin(int a, int b) { return (a < b ? a : b); } 330static __inline long lmax(long a, long b) { return (a > b ? a : b); } 331static __inline long lmin(long a, long b) { return (a < b ? a : b); } 332static __inline u_int max(u_int a, u_int b) { return (a > b ? a : b); } 333static __inline u_int min(u_int a, u_int b) { return (a < b ? a : b); } 334static __inline quad_t qmax(quad_t a, quad_t b) { return (a > b ? a : b); } 335static __inline quad_t qmin(quad_t a, quad_t b) { return (a < b ? a : b); } 336static __inline u_long ulmax(u_long a, u_long b) { return (a > b ? a : b); } 337static __inline u_long ulmin(u_long a, u_long b) { return (a < b ? a : b); } 338 339/* swaps (undocumented, useful?) */ 340#ifdef __i386__ 341extern u_int32_t bswap32(u_int32_t x); 342extern u_int64_t bswap64(u_int64_t x); 343#endif 344 345/* null functions for device/filesystem switches (undocumented) */ 346extern int nodev(void); 347extern int noioctl(struct open_file *, u_long, void *); 348extern void nullsys(void); 349 350extern int null_open(const char *path, struct open_file *f); 351extern int null_close(struct open_file *f); 352extern int null_read(struct open_file *f, void *buf, size_t size, size_t *resid); 353extern int null_write(struct open_file *f, void *buf, size_t size, size_t *resid); 354extern off_t null_seek(struct open_file *f, off_t offset, int where); 355extern int null_stat(struct open_file *f, struct stat *sb); 356extern int null_readdir(struct open_file *f, struct dirent *d); 357 358 359/* 360 * Machine dependent functions and data, must be provided or stubbed by 361 * the consumer 362 */ 363extern int getchar(void); 364extern int ischar(void); 365extern void putchar(int); 366extern int devopen(struct open_file *, const char *, const char **); 367extern int devclose(struct open_file *f); 368extern void panic(const char *, ...) __dead2 __printflike(1, 2); 369extern struct fs_ops *file_system[]; 370extern struct devsw *devsw[]; 371 372/* 373 * Expose byteorder(3) functions. 374 */ 375#ifndef _BYTEORDER_PROTOTYPED 376#define _BYTEORDER_PROTOTYPED 377extern uint32_t htonl(uint32_t); 378extern uint16_t htons(uint16_t); 379extern uint32_t ntohl(uint32_t); 380extern uint16_t ntohs(uint16_t); 381#endif 382 383#ifndef _BYTEORDER_FUNC_DEFINED 384#define _BYTEORDER_FUNC_DEFINED 385#define htonl(x) __htonl(x) 386#define htons(x) __htons(x) 387#define ntohl(x) __ntohl(x) 388#define ntohs(x) __ntohs(x) 389#endif 390 391void *Malloc(size_t, const char *, int); 392void *Calloc(size_t, size_t, const char *, int); 393void *Realloc(void *, size_t, const char *, int); 394void Free(void *, const char *, int); 395 396#if 1 397#define malloc(x) Malloc(x, __FILE__, __LINE__) 398#define calloc(x, y) Calloc(x, y, __FILE__, __LINE__) 399#define free(x) Free(x, __FILE__, __LINE__) 400#define realloc(x, y) Realloc(x, y, __FILE__, __LINE__) 401#else 402#define malloc(x) Malloc(x, NULL, 0) 403#define calloc(x, y) Calloc(x, y, NULL, 0) 404#define free(x) Free(x, NULL, 0) 405#define realloc(x, y) Realloc(x, y, NULL, 0) 406#endif 407 408#endif /* STAND_H */ 409