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. 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.
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
58 * @(#)stand.h 8.1 (Berkeley) 6/11/93
61 #include <machine/stdarg.h> /* __va_list */
62 #include <sys/types.h>
63 #include <sys/cdefs.h>
65 #include <sys/dirent.h>
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();}
71 /* Avoid unwanted userlandish components */
73 #include <sys/errno.h>
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) /* */
90 * This structure is used to define file system operations in a file system
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.
99 int (*fo_open
)(const char *, struct open_file
*);
100 int (*fo_close
)(struct open_file
*);
101 int (*fo_read
)(struct open_file
*, void *,
103 int (*fo_write
)(struct open_file
*, void *,
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
*);
111 * libstand-supplied filesystems
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
;
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 */
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);
146 * libstand-supplied device switch
148 extern struct devsw netdev
;
151 extern int no_io_error
;
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
167 extern struct open_file files
[];
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 */
175 #define isascii(c) (((c) & ~0x7F) == 0)
180 return c
>= 'A' && c
<= 'Z';
186 return c
>= 'a' && c
<= 'z';
192 return c
== ' ' || (c
>= 0x9 && c
<= 0xd);
198 return c
>= '0' && c
<= '9';
204 return isdigit(c
) || (c
>= 'a' && c
<= 'f') || (c
>= 'A' && c
<= 'F');
210 return isupper(c
) || islower(c
);
216 return isalpha(c
) || isdigit(c
);
222 return islower(c
) ? c
- 'a' + 'A' : c
;
228 return isupper(c
) ? c
- 'A' + 'a' : c
;
232 extern void setheap(void *, void *);
233 extern char *getheap(size_t *sizep
);
234 extern char *sbrk(intptr_t);
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);
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
)
253 extern void twiddle(void);
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);
260 extern int open(const char *, int);
262 #define O_WRONLY 0x1 /* writing not (yet?) supported */
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);
270 extern void srandom(u_long
);
271 extern u_long
random(void);
273 extern void exit(int);
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 *);
282 extern char *ether_sprintf(u_char
*);
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 *);
290 /* No signal state to preserve */
291 #define setjmp _setjmp
292 #define longjmp _longjmp
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 */
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
*);
309 ev_sethook_t
*ev_sethook
;
310 ev_unsethook_t
*ev_unsethook
;
311 struct env_var
*ev_next
, *ev_prev
;
313 extern struct env_var
*environ
;
315 extern struct env_var
*env_getenv(const char *);
316 extern int env_setenv(const char *, int, const void *, ev_sethook_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 *);
323 extern ev_sethook_t env_noset
; /* refuse set operation */
324 extern ev_unsethook_t env_nounset
; /* refuse unset operation */
326 /* BCD conversions (undocumented) */
327 extern u_char
const bcd2bin_data
[];
328 extern u_char
const bin2bcd_data
[];
329 extern char const hex2ascii_data
[];
331 #define bcd2bin(bcd) (bcd2bin_data[bcd])
332 #define bin2bcd(bin) (bin2bcd_data[bin])
333 #define hex2ascii(hex) (hex2ascii_data[hex])
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
); }
349 /* swaps (undocumented, useful?) */
351 extern u_int32_t
bswap32(u_int32_t
);
352 extern u_int64_t
bswap64(u_int64_t
);
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);
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
*);
370 * Machine dependent functions and data, must be provided or stubbed by
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
[];
386 malloc_debug(size_t size
, const char *file
, int line
)
389 printf("%s:%d malloc(%ld)", file
, line
, size
);
396 free_debug(void *p
, const char *file
, int line
)
398 printf("%s:%d free(%p)\n", file
, line
, p
);
402 #define malloc(x) malloc_debug(x, __FILE__, __LINE__)
403 #define free(x) free_debug(x, __FILE__, __LINE__)