lib/libstand/stand.h

   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: src/lib/libstand/stand.h,v 1.18.2.8 2002/06/17 11:22:39 sobomax Exp $
  27  * $DragonFly: src/lib/libstand/stand.h,v 1.3 2003/11/09 02:34:03 dillon Exp $
  28  * From $NetBSD: stand.h,v 1.22 1997/06/26 19:17:40 drochner Exp $
  29  */
  30
  31 /*-
  32  * Copyright (c) 1993
  33  *      The Regents of the University of California.  All rights reserved.
  34  *
  35  * Redistribution and use in source and binary forms, with or without
  36  * modification, are permitted provided that the following conditions
  37  * are met:
  38  * 1. Redistributions of source code must retain the above copyright
  39  *    notice, this list of conditions and the following disclaimer.
  40  * 2. Redistributions in binary form must reproduce the above copyright
  41  *    notice, this list of conditions and the following disclaimer in the
  42  *    documentation and/or other materials provided with the distribution.
  43  * 3. All advertising materials mentioning features or use of this software
  44  *    must display the following acknowledgement:
  45  *      This product includes software developed by the University of
  46  *      California, Berkeley and its contributors.
  47  * 4. Neither the name of the University nor the names of its contributors
  48  *    may be used to endorse or promote products derived from this software
  49  *    without specific prior written permission.
  50  *
  51  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  52  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  53  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  54  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  55  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  56  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  57  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  58  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  59  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  60  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  61  * SUCH DAMAGE.
  62  *
  63  *      @(#)stand.h     8.1 (Berkeley) 6/11/93
  64  */
  65
  66 #ifndef _MACHINE_STDARG_H_
  67 #include <machine/stdarg.h>     /* __va_list */
  68 #endif
  69 #include <sys/types.h>
  70 #include <sys/cdefs.h>
  71 #include <sys/stat.h>
  72 #include <sys/dirent.h>
  73 #include <string.h>
  74
  75 #define CHK(fmt, args...)       printf("%s(%d): " fmt "\n", __FUNCTION__, __LINE__ , ##args)
  76 #define PCHK(fmt, args...)      {printf("%s(%d): " fmt "\n", __FUNCTION__, __LINE__ , ##args); getchar();}
  77
  78 #ifndef NULL
  79 #define NULL    0
  80 #endif
  81
  82 /* Avoid unwanted userlandish components */
  83 #define _KERNEL
  84 #include <sys/errno.h>
  85 #undef _KERNEL
  86
  87 /* special stand error codes */
  88 #define EADAPT  (ELAST+1)       /* bad adaptor */
  89 #define ECTLR   (ELAST+2)       /* bad controller */
  90 #define EUNIT   (ELAST+3)       /* bad unit */
  91 #define ESLICE  (ELAST+4)       /* bad slice */
  92 #define EPART   (ELAST+5)       /* bad partition */
  93 #define ERDLAB  (ELAST+6)       /* can't read disk label */
  94 #define EUNLAB  (ELAST+7)       /* unlabeled disk */
  95 #define EOFFSET (ELAST+8)       /* relative seek not supported */
  96 #define ESALAST (ELAST+8)       /* */
  97
  98 struct open_file;
  99
 100 /*
 101  * This structure is used to define file system operations in a file system
 102  * independent way.
 103  *
 104  * XXX note that filesystem providers should export a pointer to their fs_ops
 105  *     struct, so that consumers can reference this and thus include the
 106  *     filesystems that they require.
 107  */
 108 struct fs_ops {
 109     const char  *fs_name;
 110     int         (*fo_open)(const char *path, struct open_file *f);
 111     int         (*fo_close)(struct open_file *f);
 112     int         (*fo_read)(struct open_file *f, void *buf,
 113                            size_t size, size_t *resid);
 114     int         (*fo_write)(struct open_file *f, void *buf,
 115                             size_t size, size_t *resid);
 116     off_t       (*fo_seek)(struct open_file *f, off_t offset, int where);
 117     int         (*fo_stat)(struct open_file *f, struct stat *sb);
 118     int         (*fo_readdir)(struct open_file *f, struct dirent *d);
 119 };
 120
 121 /*
 122  * libstand-supplied filesystems
 123  */
 124 extern struct fs_ops ufs_fsops;
 125 extern struct fs_ops tftp_fsops;
 126 extern struct fs_ops nfs_fsops;
 127 extern struct fs_ops cd9660_fsops;
 128 extern struct fs_ops zipfs_fsops;
 129 extern struct fs_ops bzipfs_fsops;
 130 extern struct fs_ops dosfs_fsops;
 131 extern struct fs_ops ext2fs_fsops;
 132 extern struct fs_ops splitfs_fsops;
 133
 134 /* where values for lseek(2) */
 135 #define SEEK_SET        0       /* set file offset to offset */
 136 #define SEEK_CUR        1       /* set file offset to current plus offset */
 137 #define SEEK_END        2       /* set file offset to EOF plus offset */
 138
 139 /*
 140  * Device switch
 141  */
 142 struct devsw {
 143     const char  dv_name[8];
 144     int         dv_type;                /* opaque type constant, arch-dependant */
 145     int         (*dv_init)(void);       /* early probe call */
 146     int         (*dv_strategy)(void *devdata, int rw, daddr_t blk, size_t size,
 147                                char *buf, size_t *rsize);
 148     int         (*dv_open)(struct open_file *f, ...);
 149     int         (*dv_close)(struct open_file *f);
 150     int         (*dv_ioctl)(struct open_file *f, u_long cmd, void *data);
 151     void        (*dv_print)(int verbose);       /* print device information */
 152     void        (*dv_cleanup)(void);
 153 };
 154
 155 /*
 156  * libstand-supplied device switch
 157  */
 158 extern struct devsw netdev;
 159
 160 extern int errno;
 161
 162 struct open_file {
 163     int                 f_flags;        /* see F_* below */
 164     struct devsw        *f_dev;         /* pointer to device operations */
 165     void                *f_devdata;     /* device specific data */
 166     struct fs_ops       *f_ops;         /* pointer to file system operations */
 167     void                *f_fsdata;      /* file system specific data */
 168     off_t               f_offset;       /* current file offset */
 169     char                *f_rabuf;       /* readahead buffer pointer */
 170     size_t              f_ralen;        /* valid data in readahead buffer */
 171     off_t               f_raoffset;     /* consumer offset in readahead buffer */
 172 #define SOPEN_RASIZE    512
 173 };
 174
 175 #define SOPEN_MAX       8
 176 extern struct open_file files[];
 177
 178 /* f_flags values */
 179 #define F_READ          0x0001  /* file opened for reading */
 180 #define F_WRITE         0x0002  /* file opened for writing */
 181 #define F_RAW           0x0004  /* raw device open - no file system */
 182 #define F_NODEV         0x0008  /* network open - no device */
 183
 184 #define isascii(c)      (((c) & ~0x7F) == 0)
 185
 186 static __inline int isupper(int c)
 187 {
 188     return c >= 'A' && c <= 'Z';
 189 }
 190
 191 static __inline int islower(int c)
 192 {
 193     return c >= 'a' && c <= 'z';
 194 }
 195
 196 static __inline int isspace(int c)
 197 {
 198     return c == ' ' || (c >= 0x9 && c <= 0xd);
 199 }
 200
 201 static __inline int isdigit(int c)
 202 {
 203     return c >= '0' && c <= '9';
 204 }
 205
 206 static __inline int isxdigit(int c)
 207 {
 208     return isdigit(c) || (c >= 'a' && c <= 'f') || (c >= 'A' && c <= 'F');
 209 }
 210
 211 static __inline int isalpha(int c)
 212 {
 213     return isupper(c) || islower(c);
 214 }
 215
 216 static __inline int isalnum(int c)
 217 {
 218     return isalpha(c) || isdigit(c);
 219 }
 220
 221 static __inline int toupper(int c)
 222 {
 223     return islower(c) ? c - 'a' + 'A' : c;
 224 }
 225
 226 static __inline int tolower(int c)
 227 {
 228     return isupper(c) ? c - 'A' + 'a' : c;
 229 }
 230
 231 /* sbrk emulation */
 232 extern void     setheap(void *base, void *top);
 233 extern char     *sbrk(int incr);
 234
 235 /* Matt Dillon's zalloc/zmalloc */
 236 extern void     *malloc(size_t bytes);
 237 extern void     free(void *ptr);
 238 /*#define free(p)       {CHK("free %p", p); free(p);} */ /* use for catching guard violations */
 239 extern void     *calloc(size_t n1, size_t n2);
 240 extern void     *realloc(void *ptr, size_t size);
 241 extern void     *reallocf(void *ptr, size_t size);
 242 extern void     mallocstats(void);
 243 #ifdef __alpha__
 244 extern void     free_region(void *start, void *end);
 245 #endif
 246
 247 /* disklabel support (undocumented, may be junk) */
 248 struct          disklabel;
 249 extern char     *getdisklabel(const char *, struct disklabel *);
 250
 251 extern int      printf(const char *fmt, ...);
 252 extern void     vprintf(const char *fmt, __va_list va);
 253 extern int      sprintf(char *buf, const char *cfmt, ...);
 254 extern void     vsprintf(char *buf, const char *cfmt, __va_list va);
 255
 256 extern void     twiddle(void);
 257
 258 extern void     ngets(char *, int);
 259 #define gets(x) ngets((x), 0)
 260 extern int      fgetstr(char *buf, int size, int fd);
 261
 262 extern int      open(const char *, int);
 263 #define O_RDONLY        0x0
 264 #define O_WRONLY        0x1                     /* writing not (yet?) supported */
 265 #define O_RDWR          0x2
 266 extern int      close(int);
 267 extern void     closeall(void);
 268 extern ssize_t  read(int, void *, size_t);
 269 extern ssize_t  write(int, void *, size_t);
 270 extern struct   dirent *readdirfd(int);
 271
 272 extern void     srandom(u_long seed);
 273 extern u_long   random(void);
 274
 275 /* imports from stdlib, locally modified */
 276 extern long     strtol(const char *, char **, int);
 277 extern char     *optarg;                        /* getopt(3) external variables */
 278 extern int      optind, opterr, optopt, optreset;
 279 extern int      getopt(int, char * const [], const char *);
 280
 281 /* pager.c */
 282 extern void     pager_open(void);
 283 extern void     pager_close(void);
 284 extern int      pager_output(const char *lines);
 285 extern int      pager_file(const char *fname);
 286
 287 /* No signal state to preserve */
 288 #define setjmp  _setjmp
 289 #define longjmp _longjmp
 290
 291 /* environment.c */
 292 #define EV_DYNAMIC      (1<<0)          /* value was dynamically allocated, free if changed/unset */
 293 #define EV_VOLATILE     (1<<1)          /* value is volatile, make a copy of it */
 294 #define EV_NOHOOK       (1<<2)          /* don't call hook when setting */
 295
 296 struct env_var;
 297 typedef char    *(ev_format_t)(struct env_var *ev);
 298 typedef int     (ev_sethook_t)(struct env_var *ev, int flags, void *value);
 299 typedef int     (ev_unsethook_t)(struct env_var *ev);
 300
 301 struct env_var
 302 {
 303     char                *ev_name;
 304     int                 ev_flags;
 305     void                *ev_value;
 306     ev_sethook_t        *ev_sethook;
 307     ev_unsethook_t      *ev_unsethook;
 308     struct env_var      *ev_next, *ev_prev;
 309 };
 310 extern struct env_var   *environ;
 311
 312 extern struct env_var   *env_getenv(const char *name);
 313 extern int              env_setenv(const char *name, int flags,
 314                                    const void *value, ev_sethook_t sethook,
 315                                    ev_unsethook_t unsethook);
 316 extern char             *getenv(const char *name);
 317 extern int              setenv(const char *name, const char *value,
 318                                int overwrite);
 319 extern int              putenv(const char *string);
 320 extern int              unsetenv(const char *name);
 321
 322 extern ev_sethook_t     env_noset;              /* refuse set operation */
 323 extern ev_unsethook_t   env_nounset;            /* refuse unset operation */
 324
 325 /* BCD conversions (undocumented) */
 326 extern u_char const     bcd2bin_data[];
 327 extern u_char const     bin2bcd_data[];
 328 extern char const       hex2ascii_data[];
 329
 330 #define bcd2bin(bcd)    (bcd2bin_data[bcd])
 331 #define bin2bcd(bin)    (bin2bcd_data[bin])
 332 #define hex2ascii(hex)  (hex2ascii_data[hex])
 333
 334 /* min/max (undocumented) */
 335 static __inline int imax(int a, int b) { return (a > b ? a : b); }
 336 static __inline int imin(int a, int b) { return (a < b ? a : b); }
 337 static __inline long lmax(long a, long b) { return (a > b ? a : b); }
 338 static __inline long lmin(long a, long b) { return (a < b ? a : b); }
 339 static __inline u_int max(u_int a, u_int b) { return (a > b ? a : b); }
 340 static __inline u_int min(u_int a, u_int b) { return (a < b ? a : b); }
 341 static __inline quad_t qmax(quad_t a, quad_t b) { return (a > b ? a : b); }
 342 static __inline quad_t qmin(quad_t a, quad_t b) { return (a < b ? a : b); }
 343 static __inline u_long ulmax(u_long a, u_long b) { return (a > b ? a : b); }
 344 static __inline u_long ulmin(u_long a, u_long b) { return (a < b ? a : b); }
 345
 346 /* swaps (undocumented, useful?) */
 347 #ifdef __i386__
 348 extern u_int32_t        bswap32(u_int32_t x);
 349 extern u_int64_t        bswap64(u_int64_t x);
 350 #endif
 351
 352 /* null functions for device/filesystem switches (undocumented) */
 353 extern int      nodev(void);
 354 extern int      noioctl(struct open_file *, u_long, void *);
 355 extern void     nullsys(void);
 356
 357 extern int      null_open(const char *path, struct open_file *f);
 358 extern int      null_close(struct open_file *f);
 359 extern int      null_read(struct open_file *f, void *buf, size_t size, size_t *resid);
 360 extern int      null_write(struct open_file *f, void *buf, size_t size, size_t *resid);
 361 extern off_t    null_seek(struct open_file *f, off_t offset, int where);
 362 extern int      null_stat(struct open_file *f, struct stat *sb);
 363 extern int      null_readdir(struct open_file *f, struct dirent *d);
 364
 365
 366 /*
 367  * Machine dependent functions and data, must be provided or stubbed by
 368  * the consumer
 369  */
 370 extern int              getchar(void);
 371 extern int              ischar(void);
 372 extern void             putchar(int);
 373 extern int              devopen(struct open_file *, const char *, const char **);
 374 extern int              devclose(struct open_file *f);
 375 extern void             panic(const char *, ...) __dead2;
 376 extern struct fs_ops    *file_system[];
 377 extern struct devsw     *devsw[];
 378
 379 #if 0
 380
 381 static inline void *
 382 malloc_debug(size_t size, const char *file, int line)
 383 {
 384     void *p;
 385     printf("%s:%d malloc(%ld)", file, line, size);
 386     p = malloc(size);
 387     printf("=%p\n", p);
 388     return p;
 389 }
 390
 391 static inline void
 392 free_debug(void *p, const char *file, int line)
 393 {
 394     printf("%s:%d free(%p)\n", file, line, p);
 395     free(p);
 396 }
 397
 398 #define malloc(x)       malloc_debug(x, __FILE__, __LINE__)
 399 #define free(x)         free_debug(x, __FILE__, __LINE__)
 400
 401 #endif