2 * Copyright (c) 1998 Michael Smith.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
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 $
32 * The Regents of the University of California. All rights reserved.
34 * Redistribution and use in source and binary forms, with or without
35 * modification, are permitted provided that the following conditions
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. All advertising materials mentioning features or use of this software
43 * must display the following acknowledgement:
44 * This product includes software developed by the University of
45 * California, Berkeley and its contributors.
46 * 4. Neither the name of the University nor the names of its contributors
47 * may be used to endorse or promote products derived from this software
48 * without specific prior written permission.
50 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
51 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
52 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
53 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
54 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
55 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
56 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
57 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
58 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
59 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
62 * @(#)stand.h 8.1 (Berkeley) 6/11/93
65 #include <machine/stdarg.h> /* __va_list */
66 #include <sys/types.h>
67 #include <sys/cdefs.h>
69 #include <sys/dirent.h>
72 #define CHK(fmt, args...) printf("%s(%d): " fmt "\n", __func__, __LINE__ , ##args)
73 #define PCHK(fmt, args...) {printf("%s(%d): " fmt "\n", __func__, __LINE__ , ##args); getchar();}
75 /* Avoid unwanted userlandish components */
77 #include <sys/errno.h>
80 /* special stand error codes */
81 #define EADAPT (ELAST+1) /* bad adaptor */
82 #define ECTLR (ELAST+2) /* bad controller */
83 #define EUNIT (ELAST+3) /* bad unit */
84 #define ESLICE (ELAST+4) /* bad slice */
85 #define EPART (ELAST+5) /* bad partition */
86 #define ERDLAB (ELAST+6) /* can't read disk label */
87 #define EUNLAB (ELAST+7) /* unlabeled disk */
88 #define EOFFSET (ELAST+8) /* relative seek not supported */
89 #define ESALAST (ELAST+8) /* */
94 * This structure is used to define file system operations in a file system
97 * XXX note that filesystem providers should export a pointer to their fs_ops
98 * struct, so that consumers can reference this and thus include the
99 * filesystems that they require.
103 int (*fo_open)(const char *, struct open_file *);
104 int (*fo_close)(struct open_file *);
105 int (*fo_read)(struct open_file *, void *,
107 int (*fo_write)(struct open_file *, void *,
109 off_t (*fo_seek)(struct open_file *, off_t, int);
110 int (*fo_stat)(struct open_file *, struct stat *);
111 int (*fo_readdir)(struct open_file *, struct dirent *);
115 * libstand-supplied filesystems
117 extern struct fs_ops ufs_fsops;
118 extern struct fs_ops hammer_fsops;
119 extern struct fs_ops tftp_fsops;
120 extern struct fs_ops nfs_fsops;
121 extern struct fs_ops cd9660_fsops;
122 extern struct fs_ops gzipfs_fsops;
123 extern struct fs_ops zipfs_fsops;
124 extern struct fs_ops bzipfs_fsops;
125 extern struct fs_ops dosfs_fsops;
126 extern struct fs_ops ext2fs_fsops;
127 extern struct fs_ops splitfs_fsops;
129 /* where values for lseek(2) */
130 #define SEEK_SET 0 /* set file offset to offset */
131 #define SEEK_CUR 1 /* set file offset to current plus offset */
132 #define SEEK_END 2 /* set file offset to EOF plus offset */
138 const char dv_name[8];
139 int dv_type; /* opaque type constant, arch-dependant */
140 int (*dv_init)(void); /* early probe call */
141 int (*dv_strategy)(void *, int, daddr_t, size_t, char *, size_t *);
142 int (*dv_open)(struct open_file *, ...);
143 int (*dv_close)(struct open_file *);
144 int (*dv_ioctl)(struct open_file *, u_long, void *);
145 void (*dv_print)(int); /* print device information */
146 void (*dv_cleanup)(void);
150 * libstand-supplied device switch
152 extern struct devsw netdev;
155 extern int no_io_error;
158 int f_flags; /* see F_* below */
159 struct devsw *f_dev; /* pointer to device operations */
160 void *f_devdata; /* device specific data */
161 struct fs_ops *f_ops; /* pointer to file system operations */
162 void *f_fsdata; /* file system specific data */
163 off_t f_offset; /* current file offset */
164 char *f_rabuf; /* readahead buffer pointer */
165 size_t f_ralen; /* valid data in readahead buffer */
166 off_t f_raoffset; /* consumer offset in readahead buffer */
167 #define SOPEN_RASIZE 512
171 extern struct open_file files[];
174 #define F_READ 0x0001 /* file opened for reading */
175 #define F_WRITE 0x0002 /* file opened for writing */
176 #define F_RAW 0x0004 /* raw device open - no file system */
177 #define F_DEVDESC 0x0008 /* generic devdesc, else specific */
179 #define isascii(c) (((c) & ~0x7F) == 0)
184 return c >= 'A' && c <= 'Z';
190 return c >= 'a' && c <= 'z';
196 return c == ' ' || (c >= 0x9 && c <= 0xd);
202 return c >= '0' && c <= '9';
208 return isdigit(c) || (c >= 'a' && c <= 'f') || (c >= 'A' && c <= 'F');
214 return isupper(c) || islower(c);
220 return isalpha(c) || isdigit(c);
226 return islower(c) ? c - 'a' + 'A' : c;
232 return isupper(c) ? c - 'A' + 'a' : c;
236 extern void setheap(void *, void *);
237 extern char *getheap(size_t *sizep);
238 extern char *sbrk(int);
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);
249 extern int printf(const char *, ...) __printflike(1, 2);
250 extern void vprintf(const char *, __va_list) __printflike(1, 0);
251 extern int sprintf(char *, const char *, ...) __printflike(2, 3);
252 extern void vsprintf(char *, const char *, __va_list) __printflike(2, 0);
253 int snprintf(char *, size_t, const char *, ...) __printflike(3, 4);
254 int vsnprintf(char *, size_t, const char *, __va_list)
257 extern void twiddle(void);
259 extern void ngets(char *, int);
260 #define gets(x) ngets((x), 0)
261 extern char *fgets(char *, int, int);
262 extern int fgetstr(char *, int, int);
264 extern int open(const char *, int);
266 #define O_WRONLY 0x1 /* writing not (yet?) supported */
268 extern int close(int);
269 extern void closeall(void);
270 extern ssize_t read(int, void *, size_t);
271 extern ssize_t write(int, void *, size_t);
272 extern struct dirent *readdirfd(int);
274 extern void srandom(u_long);
275 extern u_long random(void);
277 extern void exit(int);
279 /* imports from stdlib, locally modified */
280 extern long strtol(const char *, char **, int);
281 extern char *optarg; /* getopt(3) external variables */
282 extern int optind, opterr, optopt, optreset;
283 extern int getopt(int, char * const [], const char *);
286 extern char *ether_sprintf(u_char *);
289 extern void pager_open(void);
290 extern void pager_close(void);
291 extern int pager_output(const char *);
292 extern int pager_file(const char *);
294 /* No signal state to preserve */
295 #define setjmp _setjmp
296 #define longjmp _longjmp
299 #define EV_DYNAMIC (1<<0) /* value was dynamically allocated, free if changed/unset */
300 #define EV_VOLATILE (1<<1) /* value is volatile, make a copy of it */
301 #define EV_NOHOOK (1<<2) /* don't call hook when setting */
304 typedef char *(ev_format_t)(struct env_var *);
305 typedef int (ev_sethook_t)(struct env_var *, int, const void *);
306 typedef int (ev_unsethook_t)(struct env_var *);
313 ev_sethook_t *ev_sethook;
314 ev_unsethook_t *ev_unsethook;
315 struct env_var *ev_next, *ev_prev;
317 extern struct env_var *environ;
319 extern struct env_var *env_getenv(const char *);
320 extern int env_setenv(const char *, int, const void *, ev_sethook_t,
322 extern char *getenv(const char *);
323 extern int setenv(const char *, const char *, int);
324 extern int putenv(const char *);
325 extern int unsetenv(const char *);
327 extern ev_sethook_t env_noset; /* refuse set operation */
328 extern ev_unsethook_t env_nounset; /* refuse unset operation */
330 /* BCD conversions (undocumented) */
331 extern u_char const bcd2bin_data[];
332 extern u_char const bin2bcd_data[];
333 extern char const hex2ascii_data[];
335 #define bcd2bin(bcd) (bcd2bin_data[bcd])
336 #define bin2bcd(bin) (bin2bcd_data[bin])
337 #define hex2ascii(hex) (hex2ascii_data[hex])
339 /* min/max (undocumented) */
340 static __inline int imax(int a, int b) { return (a > b ? a : b); }
341 static __inline int imin(int a, int b) { return (a < b ? a : b); }
342 static __inline long lmax(long a, long b) { return (a > b ? a : b); }
343 static __inline long lmin(long a, long b) { return (a < b ? a : b); }
344 static __inline u_int max(u_int a, u_int b) { return (a > b ? a : b); }
345 static __inline u_int min(u_int a, u_int b) { return (a < b ? a : b); }
346 static __inline quad_t qmax(quad_t a, quad_t b) { return (a > b ? a : b); }
347 static __inline quad_t qmin(quad_t a, quad_t b) { return (a < b ? a : b); }
348 static __inline u_long ulmax(u_long a, u_long b) { return (a > b ? a : b); }
349 static __inline u_long ulmin(u_long a, u_long b) { return (a < b ? a : b); }
350 static __inline size_t szmax(size_t a, size_t b) { return (a > b ? a : b); }
351 static __inline size_t szmin(size_t a, size_t b) { return (a < b ? a : b); }
353 /* swaps (undocumented, useful?) */
355 extern u_int32_t bswap32(u_int32_t);
356 extern u_int64_t bswap64(u_int64_t);
359 /* null functions for device/filesystem switches (undocumented) */
360 extern int nodev(void);
361 extern int noioctl(struct open_file *, u_long, void *);
362 extern void nullsys(void);
364 extern int null_open(const char *, struct open_file *);
365 extern int null_close(struct open_file *);
366 extern int null_read(struct open_file *, void *, size_t, size_t *);
367 extern int null_write(struct open_file *, void *, size_t, size_t *);
368 extern off_t null_seek(struct open_file *, off_t, int);
369 extern int null_stat(struct open_file *, struct stat *);
370 extern int null_readdir(struct open_file *, struct dirent *);
374 * Machine dependent functions and data, must be provided or stubbed by
377 extern int getchar(void);
378 extern int ischar(void);
379 extern void putchar(int);
380 extern int devopen(struct open_file *, const char *, const char **);
381 extern int devclose(struct open_file *);
382 extern void devreplace(struct open_file *, void *devdata);
383 extern void panic(const char *, ...) __dead2 __printflike(1, 2);
384 extern struct fs_ops *file_system[];
385 extern struct devsw *devsw[];
390 malloc_debug(size_t size, const char *file, int line)
393 printf("%s:%d malloc(%ld)", file, line, size);
400 free_debug(void *p, const char *file, int line)
402 printf("%s:%d free(%p)\n", file, line, p);
406 #define malloc(x) malloc_debug(x, __FILE__, __LINE__)
407 #define free(x) free_debug(x, __FILE__, __LINE__)