stand.h revision 332154
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: stable/11/stand/libsa/stand.h 332154 2018-04-06 21:37:25Z kevans $ 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#define strcoll(a, b) strcmp((a), (b)) 72 73#define CHK(fmt, args...) printf("%s(%d): " fmt "\n", __func__, __LINE__ , ##args) 74#define PCHK(fmt, args...) {printf("%s(%d): " fmt "\n", __func__, __LINE__ , ##args); getchar();} 75 76#include <sys/errno.h> 77 78/* special stand error codes */ 79#define EADAPT (ELAST+1) /* bad adaptor */ 80#define ECTLR (ELAST+2) /* bad controller */ 81#define EUNIT (ELAST+3) /* bad unit */ 82#define ESLICE (ELAST+4) /* bad slice */ 83#define EPART (ELAST+5) /* bad partition */ 84#define ERDLAB (ELAST+6) /* can't read disk label */ 85#define EUNLAB (ELAST+7) /* unlabeled disk */ 86#define EOFFSET (ELAST+8) /* relative seek not supported */ 87#define ESALAST (ELAST+8) /* */ 88 89/* Partial signal emulation for sig_atomic_t */ 90#include <machine/signal.h> 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, const 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 int (*fo_readdir)(struct open_file *f, struct dirent *d); 113}; 114 115/* 116 * libstand-supplied filesystems 117 */ 118extern struct fs_ops ufs_fsops; 119extern struct fs_ops tftp_fsops; 120extern struct fs_ops nfs_fsops; 121extern struct fs_ops cd9660_fsops; 122extern struct fs_ops nandfs_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; 128extern struct fs_ops pkgfs_fsops; 129 130/* where values for lseek(2) */ 131#define SEEK_SET 0 /* set file offset to offset */ 132#define SEEK_CUR 1 /* set file offset to current plus offset */ 133#define SEEK_END 2 /* set file offset to EOF plus offset */ 134 135/* 136 * Device switch 137 */ 138struct devsw { 139 const char dv_name[8]; 140 int dv_type; /* opaque type constant, arch-dependant */ 141#define DEVT_NONE 0 142#define DEVT_DISK 1 143#define DEVT_NET 2 144#define DEVT_CD 3 145#define DEVT_ZFS 4 146#define DEVT_FD 5 147 int (*dv_init)(void); /* early probe call */ 148 int (*dv_strategy)(void *devdata, int rw, daddr_t blk, 149 size_t size, char *buf, size_t *rsize); 150 int (*dv_open)(struct open_file *f, ...); 151 int (*dv_close)(struct open_file *f); 152 int (*dv_ioctl)(struct open_file *f, u_long cmd, void *data); 153 int (*dv_print)(int verbose); /* print device information */ 154 void (*dv_cleanup)(void); 155}; 156 157/* 158 * libstand-supplied device switch 159 */ 160extern struct devsw netdev; 161 162extern int errno; 163 164/* 165 * Generic device specifier; architecture-dependent 166 * versions may be larger, but should be allowed to 167 * overlap. 168 */ 169struct devdesc { 170 struct devsw *d_dev; 171 int d_unit; 172 void *d_opendata; 173}; 174 175struct open_file { 176 int f_flags; /* see F_* below */ 177 struct devsw *f_dev; /* pointer to device operations */ 178 void *f_devdata; /* device specific data */ 179 struct fs_ops *f_ops; /* pointer to file system operations */ 180 void *f_fsdata; /* file system specific data */ 181 off_t f_offset; /* current file offset */ 182 char *f_rabuf; /* readahead buffer pointer */ 183 size_t f_ralen; /* valid data in readahead buffer */ 184 off_t f_raoffset; /* consumer offset in readahead buffer */ 185#define SOPEN_RASIZE 512 186}; 187 188#define SOPEN_MAX 64 189extern struct open_file files[]; 190 191/* f_flags values */ 192#define F_READ 0x0001 /* file opened for reading */ 193#define F_WRITE 0x0002 /* file opened for writing */ 194#define F_RAW 0x0004 /* raw device open - no file system */ 195#define F_NODEV 0x0008 /* network open - no device */ 196#define F_MASK 0xFFFF 197/* Mode modifier for strategy() */ 198#define F_NORA (0x01 << 16) /* Disable Read-Ahead */ 199 200#define isascii(c) (((c) & ~0x7F) == 0) 201 202static __inline int isupper(int c) 203{ 204 return c >= 'A' && c <= 'Z'; 205} 206 207static __inline int islower(int c) 208{ 209 return c >= 'a' && c <= 'z'; 210} 211 212static __inline int isspace(int c) 213{ 214 return c == ' ' || (c >= 0x9 && c <= 0xd); 215} 216 217static __inline int isdigit(int c) 218{ 219 return c >= '0' && c <= '9'; 220} 221 222static __inline int isxdigit(int c) 223{ 224 return isdigit(c) || (c >= 'a' && c <= 'f') || (c >= 'A' && c <= 'F'); 225} 226 227static __inline int isalpha(int c) 228{ 229 return isupper(c) || islower(c); 230} 231 232static __inline int isalnum(int c) 233{ 234 return isalpha(c) || isdigit(c); 235} 236 237static __inline int iscntrl(int c) 238{ 239 return (c >= 0 && c < ' ') || c == 127; 240} 241 242static __inline int isgraph(int c) 243{ 244 return c >= '!' && c <= '~'; 245} 246 247static __inline int ispunct(int c) 248{ 249 return (c >= '!' && c <= '/') || (c >= ':' && c <= '@') || 250 (c >= '[' && c <= '`') || (c >= '{' && c <= '~'); 251} 252 253static __inline int toupper(int c) 254{ 255 return islower(c) ? c - 'a' + 'A' : c; 256} 257 258static __inline int tolower(int c) 259{ 260 return isupper(c) ? c - 'A' + 'a' : c; 261} 262 263/* sbrk emulation */ 264extern void setheap(void *base, void *top); 265extern char *sbrk(int incr); 266 267extern void *reallocf(void *ptr, size_t size); 268extern void mallocstats(void); 269 270extern int printf(const char *fmt, ...) __printflike(1, 2); 271extern void vprintf(const char *fmt, __va_list); 272extern int sprintf(char *buf, const char *cfmt, ...) __printflike(2, 3); 273extern int snprintf(char *buf, size_t size, const char *cfmt, ...) __printflike(3, 4); 274extern void vsprintf(char *buf, const char *cfmt, __va_list); 275 276extern void twiddle(u_int callerdiv); 277extern void twiddle_divisor(u_int globaldiv); 278 279extern void ngets(char *, int); 280#define gets(x) ngets((x), 0) 281extern int fgetstr(char *buf, int size, int fd); 282 283extern int open(const char *, int); 284#define O_RDONLY 0x0 285#define O_WRONLY 0x1 286#define O_RDWR 0x2 287extern int close(int); 288extern void closeall(void); 289extern ssize_t read(int, void *, size_t); 290extern ssize_t write(int, const void *, size_t); 291extern struct dirent *readdirfd(int); 292 293extern void srandom(u_long seed); 294extern long random(void); 295 296/* imports from stdlib, locally modified */ 297extern char *optarg; /* getopt(3) external variables */ 298extern int optind, opterr, optopt, optreset; 299extern int getopt(int, char * const [], const char *); 300 301/* pager.c */ 302extern void pager_open(void); 303extern void pager_close(void); 304extern int pager_output(const char *lines); 305extern int pager_file(const char *fname); 306 307/* No signal state to preserve */ 308#define setjmp _setjmp 309#define longjmp _longjmp 310 311/* environment.c */ 312#define EV_DYNAMIC (1<<0) /* value was dynamically allocated, free if changed/unset */ 313#define EV_VOLATILE (1<<1) /* value is volatile, make a copy of it */ 314#define EV_NOHOOK (1<<2) /* don't call hook when setting */ 315 316struct env_var; 317typedef char *(ev_format_t)(struct env_var *ev); 318typedef int (ev_sethook_t)(struct env_var *ev, int flags, 319 const void *value); 320typedef int (ev_unsethook_t)(struct env_var *ev); 321 322struct env_var 323{ 324 char *ev_name; 325 int ev_flags; 326 void *ev_value; 327 ev_sethook_t *ev_sethook; 328 ev_unsethook_t *ev_unsethook; 329 struct env_var *ev_next, *ev_prev; 330}; 331extern struct env_var *environ; 332 333extern struct env_var *env_getenv(const char *name); 334extern int env_setenv(const char *name, int flags, 335 const void *value, ev_sethook_t sethook, 336 ev_unsethook_t unsethook); 337extern char *getenv(const char *name); 338extern int setenv(const char *name, const char *value, 339 int overwrite); 340extern int putenv(char *string); 341extern int unsetenv(const char *name); 342 343extern ev_sethook_t env_noset; /* refuse set operation */ 344extern ev_unsethook_t env_nounset; /* refuse unset operation */ 345 346/* stdlib.h routines */ 347extern int abs(int a); 348extern void abort(void) __dead2; 349extern long strtol(const char * __restrict, char ** __restrict, int); 350extern long long strtoll(const char * __restrict, char ** __restrict, int); 351extern unsigned long strtoul(const char * __restrict, char ** __restrict, int); 352extern unsigned long long strtoull(const char * __restrict, char ** __restrict, int); 353 354/* BCD conversions (undocumented) */ 355extern u_char const bcd2bin_data[]; 356extern u_char const bin2bcd_data[]; 357extern char const hex2ascii_data[]; 358 359#define bcd2bin(bcd) (bcd2bin_data[bcd]) 360#define bin2bcd(bin) (bin2bcd_data[bin]) 361#define hex2ascii(hex) (hex2ascii_data[hex]) 362#define validbcd(bcd) (bcd == 0 || (bcd > 0 && bcd <= 0x99 && bcd2bin_data[bcd] != 0)) 363 364/* min/max (undocumented) */ 365static __inline int imax(int a, int b) { return (a > b ? a : b); } 366static __inline int imin(int a, int b) { return (a < b ? a : b); } 367static __inline long lmax(long a, long b) { return (a > b ? a : b); } 368static __inline long lmin(long a, long b) { return (a < b ? a : b); } 369static __inline u_int max(u_int a, u_int b) { return (a > b ? a : b); } 370static __inline u_int min(u_int a, u_int b) { return (a < b ? a : b); } 371static __inline quad_t qmax(quad_t a, quad_t b) { return (a > b ? a : b); } 372static __inline quad_t qmin(quad_t a, quad_t b) { return (a < b ? a : b); } 373static __inline u_long ulmax(u_long a, u_long b) { return (a > b ? a : b); } 374static __inline u_long ulmin(u_long a, u_long b) { return (a < b ? a : b); } 375 376/* null functions for device/filesystem switches (undocumented) */ 377extern int nodev(void); 378extern int noioctl(struct open_file *, u_long, void *); 379extern void nullsys(void); 380 381extern int null_open(const char *path, struct open_file *f); 382extern int null_close(struct open_file *f); 383extern int null_read(struct open_file *f, void *buf, size_t size, size_t *resid); 384extern int null_write(struct open_file *f, const void *buf, size_t size, size_t *resid); 385extern off_t null_seek(struct open_file *f, off_t offset, int where); 386extern int null_stat(struct open_file *f, struct stat *sb); 387extern int null_readdir(struct open_file *f, struct dirent *d); 388 389 390/* 391 * Machine dependent functions and data, must be provided or stubbed by 392 * the consumer 393 */ 394extern void exit(int) __dead2; 395extern int getchar(void); 396extern int ischar(void); 397extern void putchar(int); 398extern int devopen(struct open_file *, const char *, const char **); 399extern int devclose(struct open_file *f); 400extern void panic(const char *, ...) __dead2 __printflike(1, 2); 401extern void panic_action(void) __weak_symbol __dead2; 402extern time_t getsecs(void); 403extern struct fs_ops *file_system[]; 404extern struct fs_ops *exclusive_file_system; 405extern struct devsw *devsw[]; 406 407/* 408 * Expose byteorder(3) functions. 409 */ 410#ifndef _BYTEORDER_PROTOTYPED 411#define _BYTEORDER_PROTOTYPED 412extern uint32_t htonl(uint32_t); 413extern uint16_t htons(uint16_t); 414extern uint32_t ntohl(uint32_t); 415extern uint16_t ntohs(uint16_t); 416#endif 417 418#ifndef _BYTEORDER_FUNC_DEFINED 419#define _BYTEORDER_FUNC_DEFINED 420#define htonl(x) __htonl(x) 421#define htons(x) __htons(x) 422#define ntohl(x) __ntohl(x) 423#define ntohs(x) __ntohs(x) 424#endif 425 426void *Malloc(size_t, const char *, int); 427void *Calloc(size_t, size_t, const char *, int); 428void *Realloc(void *, size_t, const char *, int); 429void Free(void *, const char *, int); 430 431#ifdef DEBUG_MALLOC 432#define malloc(x) Malloc(x, __FILE__, __LINE__) 433#define calloc(x, y) Calloc(x, y, __FILE__, __LINE__) 434#define free(x) Free(x, __FILE__, __LINE__) 435#define realloc(x, y) Realloc(x, y, __FILE__, __LINE__) 436#else 437#define malloc(x) Malloc(x, NULL, 0) 438#define calloc(x, y) Calloc(x, y, NULL, 0) 439#define free(x) Free(x, NULL, 0) 440#define realloc(x, y) Realloc(x, y, NULL, 0) 441#endif 442 443#endif /* STAND_H */ 444