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$ 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 69/* this header intentionally exports NULL from <string.h> */ 70#include <string.h> 71 72#define CHK(fmt, args...) printf("%s(%d): " fmt "\n", __func__, __LINE__ , ##args) 73#define PCHK(fmt, args...) {printf("%s(%d): " fmt "\n", __func__, __LINE__ , ##args); getchar();} 74 75/* Avoid unwanted userlandish components */ 76#define _KERNEL 77#include <sys/errno.h> 78#undef _KERNEL 79 80/* special stand error codes */ 81#define EADAPT (ELAST+1) /* bad adaptor */ 82#define ECTLR (ELAST+2) /* bad controller */ 83#define EUNIT (ELAST+3) /* bad unit */ 84#define ESLICE (ELAST+4) /* bad slice */ 85#define EPART (ELAST+5) /* bad partition */ 86#define ERDLAB (ELAST+6) /* can't read disk label */ 87#define EUNLAB (ELAST+7) /* unlabeled disk */ 88#define EOFFSET (ELAST+8) /* relative seek not supported */ 89#define ESALAST (ELAST+8) /* */ 90 91struct open_file; 92 93/* 94 * This structure is used to define file system operations in a file system 95 * independent way. 96 * 97 * XXX note that filesystem providers should export a pointer to their fs_ops 98 * struct, so that consumers can reference this and thus include the 99 * filesystems that they require. 100 */ 101struct fs_ops { 102 const char *fs_name; 103 int (*fo_open)(const char *path, struct open_file *f); 104 int (*fo_close)(struct open_file *f); 105 int (*fo_read)(struct open_file *f, void *buf, 106 size_t size, size_t *resid); 107 int (*fo_write)(struct open_file *f, void *buf, 108 size_t size, size_t *resid); 109 off_t (*fo_seek)(struct open_file *f, off_t offset, int where); 110 int (*fo_stat)(struct open_file *f, struct stat *sb); 111 int (*fo_readdir)(struct open_file *f, struct dirent *d); 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 nandfs_fsops; 122extern struct fs_ops gzipfs_fsops; 123extern struct fs_ops bzipfs_fsops; 124extern struct fs_ops dosfs_fsops; 125extern struct fs_ops ext2fs_fsops; 126extern struct fs_ops splitfs_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 64 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 isascii(c) (((c) & ~0x7F) == 0) 179 180static __inline int isupper(int c) 181{ 182 return c >= 'A' && c <= 'Z'; 183} 184 185static __inline int islower(int c) 186{ 187 return c >= 'a' && c <= 'z'; 188} 189 190static __inline int isspace(int c) 191{ 192 return c == ' ' || (c >= 0x9 && c <= 0xd); 193} 194 195static __inline int isdigit(int c) 196{ 197 return c >= '0' && c <= '9'; 198} 199 200static __inline int isxdigit(int c) 201{ 202 return isdigit(c) || (c >= 'a' && c <= 'f') || (c >= 'A' && c <= 'F'); 203} 204 205static __inline int isalpha(int c) 206{ 207 return isupper(c) || islower(c); 208} 209 210static __inline int isalnum(int c) 211{ 212 return isalpha(c) || isdigit(c); 213} 214 215static __inline int toupper(int c) 216{ 217 return islower(c) ? c - 'a' + 'A' : c; 218} 219 220static __inline int tolower(int c) 221{ 222 return isupper(c) ? c - 'A' + 'a' : c; 223} 224 225/* sbrk emulation */ 226extern void setheap(void *base, void *top); 227extern char *sbrk(int incr); 228 229/* Matt Dillon's zalloc/zmalloc */ 230extern void *malloc(size_t bytes); 231extern void free(void *ptr); 232/*#define free(p) {CHK("free %p", p); free(p);} */ /* use for catching guard violations */ 233extern void *calloc(size_t n1, size_t n2); 234extern void *realloc(void *ptr, size_t size); 235extern void *reallocf(void *ptr, size_t size); 236extern void mallocstats(void); 237 238extern int printf(const char *fmt, ...) __printflike(1, 2); 239extern void vprintf(const char *fmt, __va_list); 240extern int sprintf(char *buf, const char *cfmt, ...) __printflike(2, 3); 241extern void vsprintf(char *buf, const char *cfmt, __va_list); 242 243extern void twiddle(void); 244 245extern void ngets(char *, int); 246#define gets(x) ngets((x), 0) 247extern int fgetstr(char *buf, int size, int fd); 248 249extern int open(const char *, int); 250#define O_RDONLY 0x0 251#define O_WRONLY 0x1 252#define O_RDWR 0x2 253extern int close(int); 254extern void closeall(void); 255extern ssize_t read(int, void *, size_t); 256extern ssize_t write(int, void *, size_t); 257extern struct dirent *readdirfd(int); 258 259extern void srandom(u_long seed); 260extern u_long random(void); 261 262/* imports from stdlib, locally modified */ 263extern long strtol(const char *, char **, int); 264extern unsigned long strtoul(const char *, char **, int); 265extern char *optarg; /* getopt(3) external variables */ 266extern int optind, opterr, optopt, optreset; 267extern int getopt(int, char * const [], const char *); 268 269/* pager.c */ 270extern void pager_open(void); 271extern void pager_close(void); 272extern int pager_output(const char *lines); 273extern int pager_file(const char *fname); 274 275/* No signal state to preserve */ 276#define setjmp _setjmp 277#define longjmp _longjmp 278 279/* environment.c */ 280#define EV_DYNAMIC (1<<0) /* value was dynamically allocated, free if changed/unset */ 281#define EV_VOLATILE (1<<1) /* value is volatile, make a copy of it */ 282#define EV_NOHOOK (1<<2) /* don't call hook when setting */ 283 284struct env_var; 285typedef char *(ev_format_t)(struct env_var *ev); 286typedef int (ev_sethook_t)(struct env_var *ev, int flags, 287 const void *value); 288typedef int (ev_unsethook_t)(struct env_var *ev); 289 290struct env_var 291{ 292 char *ev_name; 293 int ev_flags; 294 void *ev_value; 295 ev_sethook_t *ev_sethook; 296 ev_unsethook_t *ev_unsethook; 297 struct env_var *ev_next, *ev_prev; 298}; 299extern struct env_var *environ; 300 301extern struct env_var *env_getenv(const char *name); 302extern int env_setenv(const char *name, int flags, 303 const void *value, ev_sethook_t sethook, 304 ev_unsethook_t unsethook); 305extern char *getenv(const char *name); 306extern int setenv(const char *name, const char *value, 307 int overwrite); 308extern int putenv(const char *string); 309extern int unsetenv(const char *name); 310 311extern ev_sethook_t env_noset; /* refuse set operation */ 312extern ev_unsethook_t env_nounset; /* refuse unset operation */ 313 314/* BCD conversions (undocumented) */ 315extern u_char const bcd2bin_data[]; 316extern u_char const bin2bcd_data[]; 317extern char const hex2ascii_data[]; 318 319#define bcd2bin(bcd) (bcd2bin_data[bcd]) 320#define bin2bcd(bin) (bin2bcd_data[bin]) 321#define hex2ascii(hex) (hex2ascii_data[hex]) 322 323/* min/max (undocumented) */ 324static __inline int imax(int a, int b) { return (a > b ? a : b); } 325static __inline int imin(int a, int b) { return (a < b ? a : b); } 326static __inline long lmax(long a, long b) { return (a > b ? a : b); } 327static __inline long lmin(long a, long b) { return (a < b ? a : b); } 328static __inline u_int max(u_int a, u_int b) { return (a > b ? a : b); } 329static __inline u_int min(u_int a, u_int b) { return (a < b ? a : b); } 330static __inline quad_t qmax(quad_t a, quad_t b) { return (a > b ? a : b); } 331static __inline quad_t qmin(quad_t a, quad_t b) { return (a < b ? a : b); } 332static __inline u_long ulmax(u_long a, u_long b) { return (a > b ? a : b); } 333static __inline u_long ulmin(u_long a, u_long b) { return (a < b ? a : b); } 334 335/* swaps (undocumented, useful?) */ 336#ifdef __i386__ 337extern u_int32_t bswap32(u_int32_t x); 338extern u_int64_t bswap64(u_int64_t x); 339#endif 340 341/* null functions for device/filesystem switches (undocumented) */ 342extern int nodev(void); 343extern int noioctl(struct open_file *, u_long, void *); 344extern void nullsys(void); 345 346extern int null_open(const char *path, struct open_file *f); 347extern int null_close(struct open_file *f); 348extern int null_read(struct open_file *f, void *buf, size_t size, size_t *resid); 349extern int null_write(struct open_file *f, void *buf, size_t size, size_t *resid); 350extern off_t null_seek(struct open_file *f, off_t offset, int where); 351extern int null_stat(struct open_file *f, struct stat *sb); 352extern int null_readdir(struct open_file *f, struct dirent *d); 353 354 355/* 356 * Machine dependent functions and data, must be provided or stubbed by 357 * the consumer 358 */ 359extern int getchar(void); 360extern int ischar(void); 361extern void putchar(int); 362extern int devopen(struct open_file *, const char *, const char **); 363extern int devclose(struct open_file *f); 364extern void panic(const char *, ...) __dead2 __printflike(1, 2); 365extern struct fs_ops *file_system[]; 366extern struct devsw *devsw[]; 367 368/* 369 * Expose byteorder(3) functions. 370 */ 371#ifndef _BYTEORDER_PROTOTYPED 372#define _BYTEORDER_PROTOTYPED 373extern uint32_t htonl(uint32_t); 374extern uint16_t htons(uint16_t); 375extern uint32_t ntohl(uint32_t); 376extern uint16_t ntohs(uint16_t); 377#endif 378 379#ifndef _BYTEORDER_FUNC_DEFINED 380#define _BYTEORDER_FUNC_DEFINED 381#define htonl(x) __htonl(x) 382#define htons(x) __htons(x) 383#define ntohl(x) __ntohl(x) 384#define ntohs(x) __ntohs(x) 385#endif 386 387void *Malloc(size_t, const char *, int); 388void *Calloc(size_t, size_t, const char *, int); 389void *Realloc(void *, size_t, const char *, int); 390void Free(void *, const char *, int); 391 392#if 1 393#define malloc(x) Malloc(x, __FILE__, __LINE__) 394#define calloc(x, y) Calloc(x, y, __FILE__, __LINE__) 395#define free(x) Free(x, __FILE__, __LINE__) 396#define realloc(x, y) Realloc(x, y, __FILE__, __LINE__) 397#else 398#define malloc(x) Malloc(x, NULL, 0) 399#define calloc(x, y) Calloc(x, y, NULL, 0) 400#define free(x) Free(x, NULL, 0) 401#define realloc(x, y) Realloc(x, y, NULL, 0) 402#endif 403 404#endif /* STAND_H */ 405