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 <sys/types.h>
66 #include <sys/cdefs.h>
68 #include <sys/dirent.h>
71 #define CHK(fmt, args...) printf("%s(%d): " fmt "\n", __FUNCTION__, __LINE__ , ##args)
72 #define PCHK(fmt, args...) {printf("%s(%d): " fmt "\n", __FUNCTION__, __LINE__ , ##args); getchar();}
78 /* Avoid unwanted userlandish components */
80 #include <sys/errno.h>
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) /* */
97 * This structure is used to define file system operations in a file system
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.
106 int (*fo_open)(const char *path, struct open_file *f);
107 int (*fo_close)(struct open_file *f);
108 int (*fo_read)(struct open_file *f, void *buf,
109 size_t size, size_t *resid);
110 int (*fo_write)(struct open_file *f, void *buf,
111 size_t size, size_t *resid);
112 off_t (*fo_seek)(struct open_file *f, off_t offset, int where);
113 int (*fo_stat)(struct open_file *f, struct stat *sb);
114 int (*fo_readdir)(struct open_file *f, struct dirent *d);
118 * libstand-supplied filesystems
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 zipfs_fsops;
125 extern struct fs_ops bzipfs_fsops;
126 extern struct fs_ops dosfs_fsops;
127 extern struct fs_ops ext2fs_fsops;
128 extern struct fs_ops splitfs_fsops;
130 /* where values for lseek(2) */
131 #define SEEK_SET 0 /* set file offset to offset */
132 #define SEEK_CUR 1 /* set file offset to current plus offset */
133 #define SEEK_END 2 /* set file offset to EOF plus offset */
139 const char dv_name[8];
140 int dv_type; /* opaque type constant, arch-dependant */
141 int (*dv_init)(void); /* early probe call */
142 int (*dv_strategy)(void *devdata, int rw, daddr_t blk, size_t size,
143 char *buf, size_t *rsize);
144 int (*dv_open)(struct open_file *f, ...);
145 int (*dv_close)(struct open_file *f);
146 int (*dv_ioctl)(struct open_file *f, u_long cmd, void *data);
147 void (*dv_print)(int verbose); /* print device information */
148 void (*dv_cleanup)(void);
152 * libstand-supplied device switch
154 extern struct devsw netdev;
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
172 extern struct open_file files[];
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 */
180 #define isascii(c) (((c) & ~0x7F) == 0)
182 static __inline int isupper(int c)
184 return c >= 'A' && c <= 'Z';
187 static __inline int islower(int c)
189 return c >= 'a' && c <= 'z';
192 static __inline int isspace(int c)
194 return c == ' ' || (c >= 0x9 && c <= 0xd);
197 static __inline int isdigit(int c)
199 return c >= '0' && c <= '9';
202 static __inline int isxdigit(int c)
204 return isdigit(c) || (c >= 'a' && c <= 'f') || (c >= 'A' && c <= 'F');
207 static __inline int isalpha(int c)
209 return isupper(c) || islower(c);
212 static __inline int isalnum(int c)
214 return isalpha(c) || isdigit(c);
217 static __inline int toupper(int c)
219 return islower(c) ? c - 'a' + 'A' : c;
222 static __inline int tolower(int c)
224 return isupper(c) ? c - 'A' + 'a' : c;
228 extern void setheap(void *base, void *top);
229 extern char *sbrk(int incr);
231 /* Matt Dillon's zalloc/zmalloc */
232 extern void *malloc(size_t bytes);
233 extern void free(void *ptr);
234 /*#define free(p) {CHK("free %p", p); free(p);} */ /* use for catching guard violations */
235 extern void *calloc(size_t n1, size_t n2);
236 extern void *realloc(void *ptr, size_t size);
237 extern void *reallocf(void *ptr, size_t size);
238 extern void mallocstats(void);
240 extern void free_region(void *start, void *end);
243 /* disklabel support (undocumented, may be junk) */
245 extern char *getdisklabel(const char *, struct disklabel *);
247 extern int printf(const char *fmt, ...);
248 extern void vprintf(const char *fmt, _BSD_VA_LIST_);
249 extern int sprintf(char *buf, const char *cfmt, ...);
250 extern void vsprintf(char *buf, const char *cfmt, _BSD_VA_LIST_);
252 extern void twiddle(void);
254 extern void ngets(char *, int);
255 #define gets(x) ngets((x), 0)
256 extern int fgetstr(char *buf, int size, int fd);
258 extern int open(const char *, int);
260 #define O_WRONLY 0x1 /* writing not (yet?) supported */
262 extern int close(int);
263 extern void closeall(void);
264 extern ssize_t read(int, void *, size_t);
265 extern ssize_t write(int, void *, size_t);
266 extern struct dirent *readdirfd(int);
268 extern void srandom(u_long seed);
269 extern u_long random(void);
271 /* imports from stdlib, locally modified */
272 extern long strtol(const char *, char **, int);
273 extern char *optarg; /* getopt(3) external variables */
274 extern int optind, opterr, optopt, optreset;
275 extern int getopt(int, char * const [], const char *);
278 extern void pager_open(void);
279 extern void pager_close(void);
280 extern int pager_output(const char *lines);
281 extern int pager_file(const char *fname);
283 /* No signal state to preserve */
284 #define setjmp _setjmp
285 #define longjmp _longjmp
288 #define EV_DYNAMIC (1<<0) /* value was dynamically allocated, free if changed/unset */
289 #define EV_VOLATILE (1<<1) /* value is volatile, make a copy of it */
290 #define EV_NOHOOK (1<<2) /* don't call hook when setting */
293 typedef char *(ev_format_t)(struct env_var *ev);
294 typedef int (ev_sethook_t)(struct env_var *ev, int flags, void *value);
295 typedef int (ev_unsethook_t)(struct env_var *ev);
302 ev_sethook_t *ev_sethook;
303 ev_unsethook_t *ev_unsethook;
304 struct env_var *ev_next, *ev_prev;
306 extern struct env_var *environ;
308 extern struct env_var *env_getenv(const char *name);
309 extern int env_setenv(const char *name, int flags,
310 const void *value, ev_sethook_t sethook,
311 ev_unsethook_t unsethook);
312 extern char *getenv(const char *name);
313 extern int setenv(const char *name, const char *value,
315 extern int putenv(const char *string);
316 extern int unsetenv(const char *name);
318 extern ev_sethook_t env_noset; /* refuse set operation */
319 extern ev_unsethook_t env_nounset; /* refuse unset operation */
321 /* BCD conversions (undocumented) */
322 extern u_char const bcd2bin_data[];
323 extern u_char const bin2bcd_data[];
324 extern char const hex2ascii_data[];
326 #define bcd2bin(bcd) (bcd2bin_data[bcd])
327 #define bin2bcd(bin) (bin2bcd_data[bin])
328 #define hex2ascii(hex) (hex2ascii_data[hex])
330 /* min/max (undocumented) */
331 static __inline int imax(int a, int b) { return (a > b ? a : b); }
332 static __inline int imin(int a, int b) { return (a < b ? a : b); }
333 static __inline long lmax(long a, long b) { return (a > b ? a : b); }
334 static __inline long lmin(long a, long b) { return (a < b ? a : b); }
335 static __inline u_int max(u_int a, u_int b) { return (a > b ? a : b); }
336 static __inline u_int min(u_int a, u_int b) { return (a < b ? a : b); }
337 static __inline quad_t qmax(quad_t a, quad_t b) { return (a > b ? a : b); }
338 static __inline quad_t qmin(quad_t a, quad_t b) { return (a < b ? a : b); }
339 static __inline u_long ulmax(u_long a, u_long b) { return (a > b ? a : b); }
340 static __inline u_long ulmin(u_long a, u_long b) { return (a < b ? a : b); }
342 /* swaps (undocumented, useful?) */
344 extern u_int32_t bswap32(u_int32_t x);
345 extern u_int64_t bswap64(u_int64_t x);
348 /* null functions for device/filesystem switches (undocumented) */
349 extern int nodev(void);
350 extern int noioctl(struct open_file *, u_long, void *);
351 extern void nullsys(void);
353 extern int null_open(const char *path, struct open_file *f);
354 extern int null_close(struct open_file *f);
355 extern int null_read(struct open_file *f, void *buf, size_t size, size_t *resid);
356 extern int null_write(struct open_file *f, void *buf, size_t size, size_t *resid);
357 extern off_t null_seek(struct open_file *f, off_t offset, int where);
358 extern int null_stat(struct open_file *f, struct stat *sb);
359 extern int null_readdir(struct open_file *f, struct dirent *d);
363 * Machine dependent functions and data, must be provided or stubbed by
366 extern int getchar(void);
367 extern int ischar(void);
368 extern void putchar(int);
369 extern int devopen(struct open_file *, const char *, const char **);
370 extern int devclose(struct open_file *f);
371 extern void panic(const char *, ...) __dead2;
372 extern struct fs_ops *file_system[];
373 extern struct devsw *devsw[];
378 malloc_debug(size_t size, const char *file, int line)
381 printf("%s:%d malloc(%ld)", file, line, size);
388 free_debug(void *p, const char *file, int line)
390 printf("%s:%d free(%p)\n", file, line, p);
394 #define malloc(x) malloc_debug(x, __FILE__, __LINE__)
395 #define free(x) free_debug(x, __FILE__, __LINE__)