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