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