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.6 2005/03/13 15:10:03 swildner 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", __func__, __LINE__ , ##args)
  76 #define PCHK(fmt, args...)      {printf("%s(%d): " fmt "\n", __func__, __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 gzipfs_fsops;
 129 extern struct fs_ops zipfs_fsops;
 130 extern struct fs_ops bzipfs_fsops;
 131 extern struct fs_ops dosfs_fsops;
 132 extern struct fs_ops ext2fs_fsops;
 133 extern struct fs_ops splitfs_fsops;
 134
 135 /* where values for lseek(2) */
 136 #define SEEK_SET        0       /* set file offset to offset */
 137 #define SEEK_CUR        1       /* set file offset to current plus offset */
 138 #define SEEK_END        2       /* set file offset to EOF plus offset */
 139
 140 /*
 141  * Device switch
 142  */
 143 struct devsw {
 144     const char  dv_name[8];
 145     int         dv_type;                /* opaque type constant, arch-dependant */
 146     int         (*dv_init)(void);       /* early probe call */
 147     int         (*dv_strategy)(void *devdata, int rw, daddr_t blk, size_t size,
 148                                char *buf, size_t *rsize);
 149     int         (*dv_open)(struct open_file *f, ...);
 150     int         (*dv_close)(struct open_file *f);
 151     int         (*dv_ioctl)(struct open_file *f, u_long cmd, void *data);
 152     void        (*dv_print)(int verbose);       /* print device information */
 153     void        (*dv_cleanup)(void);
 154 };
 155
 156 /*
 157  * libstand-supplied device switch
 158  */
 159 extern struct devsw netdev;
 160
 161 extern int errno;
 162
 163 struct open_file {
 164     int                 f_flags;        /* see F_* below */
 165     struct devsw        *f_dev;         /* pointer to device operations */
 166     void                *f_devdata;     /* device specific data */
 167     struct fs_ops       *f_ops;         /* pointer to file system operations */
 168     void                *f_fsdata;      /* file system specific data */
 169     off_t               f_offset;       /* current file offset */
 170     char                *f_rabuf;       /* readahead buffer pointer */
 171     size_t              f_ralen;        /* valid data in readahead buffer */
 172     off_t               f_raoffset;     /* consumer offset in readahead buffer */
 173 #define SOPEN_RASIZE    512
 174 };
 175
 176 #define SOPEN_MAX       8
 177 extern struct open_file files[];
 178
 179 /* f_flags values */
 180 #define F_READ          0x0001  /* file opened for reading */
 181 #define F_WRITE         0x0002  /* file opened for writing */
 182 #define F_RAW           0x0004  /* raw device open - no file system */
 183 #define F_NODEV         0x0008  /* network open - no device */
 184
 185 #define isascii(c)      (((c) & ~0x7F) == 0)
 186
 187 static __inline int isupper(int c)
 188 {
 189     return c >= 'A' && c <= 'Z';
 190 }
 191
 192 static __inline int islower(int c)
 193 {
 194     return c >= 'a' && c <= 'z';
 195 }
 196
 197 static __inline int isspace(int c)
 198 {
 199     return c == ' ' || (c >= 0x9 && c <= 0xd);
 200 }
 201
 202 static __inline int isdigit(int c)
 203 {
 204     return c >= '0' && c <= '9';
 205 }
 206
 207 static __inline int isxdigit(int c)
 208 {
 209     return isdigit(c) || (c >= 'a' && c <= 'f') || (c >= 'A' && c <= 'F');
 210 }
 211
 212 static __inline int isalpha(int c)
 213 {
 214     return isupper(c) || islower(c);
 215 }
 216
 217 static __inline int isalnum(int c)
 218 {
 219     return isalpha(c) || isdigit(c);
 220 }
 221
 222 static __inline int toupper(int c)
 223 {
 224     return islower(c) ? c - 'a' + 'A' : c;
 225 }
 226
 227 static __inline int tolower(int c)
 228 {
 229     return isupper(c) ? c - 'A' + 'a' : c;
 230 }
 231
 232 /* sbrk emulation */
 233 extern void     setheap(void *base, void *top);
 234 extern char     *sbrk(int incr);
 235
 236 /* Matt Dillon's zalloc/zmalloc */
 237 extern void     *malloc(size_t bytes);
 238 extern void     free(void *ptr);
 239 /*#define free(p)       {CHK("free %p", p); free(p);} */ /* use for catching guard violations */
 240 extern void     *calloc(size_t n1, size_t n2);
 241 extern void     *realloc(void *ptr, size_t size);
 242 extern void     *reallocf(void *ptr, size_t size);
 243 extern void     mallocstats(void);
 244
 245 /* disklabel support (undocumented, may be junk) */
 246 struct          disklabel;
 247 extern char     *getdisklabel(const char *, struct disklabel *);
 248
 249 extern int      printf(const char *fmt, ...);
 250 extern void     vprintf(const char *fmt, __va_list va);
 251 extern int      sprintf(char *buf, const char *cfmt, ...);
 252 extern void     vsprintf(char *buf, const char *cfmt, __va_list va);
 253
 254 extern void     twiddle(void);
 255
 256 extern void     ngets(char *, int);
 257 #define gets(x) ngets((x), 0)
 258 extern int      fgetstr(char *buf, int size, int fd);
 259
 260 extern int      open(const char *, int);
 261 #define O_RDONLY        0x0
 262 #define O_WRONLY        0x1                     /* writing not (yet?) supported */
 263 #define O_RDWR          0x2
 264 extern int      close(int);
 265 extern void     closeall(void);
 266 extern ssize_t  read(int, void *, size_t);
 267 extern ssize_t  write(int, void *, size_t);
 268 extern struct   dirent *readdirfd(int);
 269
 270 extern void     srandom(u_long seed);
 271 extern u_long   random(void);
 272
 273 /* imports from stdlib, locally modified */
 274 extern long     strtol(const char *, char **, int);
 275 extern char     *optarg;                        /* getopt(3) external variables */
 276 extern int      optind, opterr, optopt, optreset;
 277 extern int      getopt(int, char * const [], const char *);
 278
 279 /* pager.c */
 280 extern void     pager_open(void);
 281 extern void     pager_close(void);
 282 extern int      pager_output(const char *lines);
 283 extern int      pager_file(const char *fname);
 284
 285 /* No signal state to preserve */
 286 #define setjmp  _setjmp
 287 #define longjmp _longjmp
 288
 289 /* environment.c */
 290 #define EV_DYNAMIC      (1<<0)          /* value was dynamically allocated, free if changed/unset */
 291 #define EV_VOLATILE     (1<<1)          /* value is volatile, make a copy of it */
 292 #define EV_NOHOOK       (1<<2)          /* don't call hook when setting */
 293
 294 struct env_var;
 295 typedef char    *(ev_format_t)(struct env_var *ev);
 296 typedef int     (ev_sethook_t)(struct env_var *ev, int flags, void *value);
 297 typedef int     (ev_unsethook_t)(struct env_var *ev);
 298
 299 struct env_var
 300 {
 301     char                *ev_name;
 302     int                 ev_flags;
 303     void                *ev_value;
 304     ev_sethook_t        *ev_sethook;
 305     ev_unsethook_t      *ev_unsethook;
 306     struct env_var      *ev_next, *ev_prev;
 307 };
 308 extern struct env_var   *environ;
 309
 310 extern struct env_var   *env_getenv(const char *name);
 311 extern int              env_setenv(const char *name, int flags,
 312                                    const void *value, ev_sethook_t sethook,
 313                                    ev_unsethook_t unsethook);
 314 extern char             *getenv(const char *name);
 315 extern int              setenv(const char *name, const char *value,
 316                                int overwrite);
 317 extern int              putenv(const char *string);
 318 extern int              unsetenv(const char *name);
 319
 320 extern ev_sethook_t     env_noset;              /* refuse set operation */
 321 extern ev_unsethook_t   env_nounset;            /* refuse unset operation */
 322
 323 /* BCD conversions (undocumented) */
 324 extern u_char const     bcd2bin_data[];
 325 extern u_char const     bin2bcd_data[];
 326 extern char const       hex2ascii_data[];
 327
 328 #define bcd2bin(bcd)    (bcd2bin_data[bcd])
 329 #define bin2bcd(bin)    (bin2bcd_data[bin])
 330 #define hex2ascii(hex)  (hex2ascii_data[hex])
 331
 332 /* min/max (undocumented) */
 333 static __inline int imax(int a, int b) { return (a > b ? a : b); }
 334 static __inline int imin(int a, int b) { return (a < b ? a : b); }
 335 static __inline long lmax(long a, long b) { return (a > b ? a : b); }
 336 static __inline long lmin(long a, long b) { return (a < b ? a : b); }
 337 static __inline u_int max(u_int a, u_int b) { return (a > b ? a : b); }
 338 static __inline u_int min(u_int a, u_int b) { return (a < b ? a : b); }
 339 static __inline quad_t qmax(quad_t a, quad_t b) { return (a > b ? a : b); }
 340 static __inline quad_t qmin(quad_t a, quad_t b) { return (a < b ? a : b); }
 341 static __inline u_long ulmax(u_long a, u_long b) { return (a > b ? a : b); }
 342 static __inline u_long ulmin(u_long a, u_long b) { return (a < b ? a : b); }
 343
 344 /* swaps (undocumented, useful?) */
 345 #ifdef __i386__
 346 extern u_int32_t        bswap32(u_int32_t x);
 347 extern u_int64_t        bswap64(u_int64_t x);
 348 #endif
 349
 350 /* null functions for device/filesystem switches (undocumented) */
 351 extern int      nodev(void);
 352 extern int      noioctl(struct open_file *, u_long, void *);
 353 extern void     nullsys(void);
 354
 355 extern int      null_open(const char *path, struct open_file *f);
 356 extern int      null_close(struct open_file *f);
 357 extern int      null_read(struct open_file *f, void *buf, size_t size, size_t *resid);
 358 extern int      null_write(struct open_file *f, void *buf, size_t size, size_t *resid);
 359 extern off_t    null_seek(struct open_file *f, off_t offset, int where);
 360 extern int      null_stat(struct open_file *f, struct stat *sb);
 361 extern int      null_readdir(struct open_file *f, struct dirent *d);
 362
 363
 364 /*
 365  * Machine dependent functions and data, must be provided or stubbed by
 366  * the consumer
 367  */
 368 extern int              getchar(void);
 369 extern int              ischar(void);
 370 extern void             putchar(int);
 371 extern int              devopen(struct open_file *, const char *, const char **);
 372 extern int              devclose(struct open_file *f);
 373 extern void             panic(const char *, ...) __dead2;
 374 extern struct fs_ops    *file_system[];
 375 extern struct devsw     *devsw[];
 376
 377 #if 0
 378
 379 static inline void *
 380 malloc_debug(size_t size, const char *file, int line)
 381 {
 382     void *p;
 383     printf("%s:%d malloc(%ld)", file, line, size);
 384     p = malloc(size);
 385     printf("=%p\n", p);
 386     return p;
 387 }
 388
 389 static inline void
 390 free_debug(void *p, const char *file, int line)
 391 {
 392     printf("%s:%d free(%p)\n", file, line, p);
 393     free(p);
 394 }
 395
 396 #define malloc(x)       malloc_debug(x, __FILE__, __LINE__)
 397 #define free(x)         free_debug(x, __FILE__, __LINE__)
 398
 399 #endif