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