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
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 * 4. 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
64 #include <sys/types.h>
65 #include <sys/cdefs.h>
67 #include <sys/dirent.h>
69 /* this header intentionally exports NULL from <string.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 *path
, struct open_file
*f
);
104 int (*fo_close
)(struct open_file
*f
);
105 int (*fo_read
)(struct open_file
*f
, void *buf
,
106 size_t size
, size_t *resid
);
107 int (*fo_write
)(struct open_file
*f
, void *buf
,
108 size_t size
, size_t *resid
);
109 off_t (*fo_seek
)(struct open_file
*f
, off_t offset
, int where
);
110 int (*fo_stat
)(struct open_file
*f
, struct stat
*sb
);
111 int (*fo_readdir
)(struct open_file
*f
, struct dirent
*d
);
115 * libstand-supplied filesystems
117 extern struct fs_ops ufs_fsops
;
118 extern struct fs_ops tftp_fsops
;
119 extern struct fs_ops nfs_fsops
;
120 extern struct fs_ops cd9660_fsops
;
121 extern struct fs_ops nandfs_fsops
;
122 extern struct fs_ops gzipfs_fsops
;
123 extern struct fs_ops bzipfs_fsops
;
124 extern struct fs_ops dosfs_fsops
;
125 extern struct fs_ops ext2fs_fsops
;
126 extern struct fs_ops splitfs_fsops
;
127 extern struct fs_ops pkgfs_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 *devdata
, int rw
, daddr_t blk
,
142 size_t offset
, size_t size
, char *buf
, size_t *rsize
);
143 int (*dv_open
)(struct open_file
*f
, ...);
144 int (*dv_close
)(struct open_file
*f
);
145 int (*dv_ioctl
)(struct open_file
*f
, u_long cmd
, void *data
);
146 int (*dv_print
)(int verbose
); /* print device information */
147 void (*dv_cleanup
)(void);
151 * libstand-supplied device switch
153 extern struct devsw netdev
;
158 * Generic device specifier; architecture-dependent
159 * versions may be larger, but should be allowed to
176 int f_flags
; /* see F_* below */
177 struct devsw
*f_dev
; /* pointer to device operations */
178 void *f_devdata
; /* device specific data */
179 struct fs_ops
*f_ops
; /* pointer to file system operations */
180 void *f_fsdata
; /* file system specific data */
181 off_t f_offset
; /* current file offset */
182 char *f_rabuf
; /* readahead buffer pointer */
183 size_t f_ralen
; /* valid data in readahead buffer */
184 off_t f_raoffset
; /* consumer offset in readahead buffer */
185 #define SOPEN_RASIZE 512
189 extern struct open_file files
[];
192 #define F_READ 0x0001 /* file opened for reading */
193 #define F_WRITE 0x0002 /* file opened for writing */
194 #define F_RAW 0x0004 /* raw device open - no file system */
195 #define F_NODEV 0x0008 /* network open - no device */
196 #define F_GZIP 0x0010 /* file is compressed by gzip */
197 #define F_BZIP 0x0020 /* file is compressed by bzip */
199 #define isascii(c) (((c) & ~0x7F) == 0)
201 static __inline
int isupper(int c
)
203 return c
>= 'A' && c
<= 'Z';
206 static __inline
int islower(int c
)
208 return c
>= 'a' && c
<= 'z';
211 static __inline
int isspace(int c
)
213 return c
== ' ' || (c
>= 0x9 && c
<= 0xd);
216 static __inline
int isdigit(int c
)
218 return c
>= '0' && c
<= '9';
221 static __inline
int isxdigit(int c
)
223 return isdigit(c
) || (c
>= 'a' && c
<= 'f') || (c
>= 'A' && c
<= 'F');
226 static __inline
int isalpha(int c
)
228 return isupper(c
) || islower(c
);
231 static __inline
int isalnum(int c
)
233 return isalpha(c
) || isdigit(c
);
236 static __inline
int toupper(int c
)
238 return islower(c
) ? c
- 'a' + 'A' : c
;
241 static __inline
int tolower(int c
)
243 return isupper(c
) ? c
- 'A' + 'a' : c
;
247 extern void setheap(void *base
, void *top
);
248 extern char *sbrk(int incr
);
250 /* Matt Dillon's zalloc/zmalloc */
251 extern void *malloc(size_t bytes
);
252 extern void free(void *ptr
);
253 /*#define free(p) {CHK("free %p", p); free(p);} */ /* use for catching guard violations */
254 extern void *calloc(size_t n1
, size_t n2
);
255 extern void *realloc(void *ptr
, size_t size
);
256 extern void *reallocf(void *ptr
, size_t size
);
257 extern void mallocstats(void);
259 extern int printf(const char *fmt
, ...) __printflike(1, 2);
260 extern void vprintf(const char *fmt
, __va_list
);
261 extern int sprintf(char *buf
, const char *cfmt
, ...) __printflike(2, 3);
262 extern int snprintf(char *buf
, size_t size
, const char *cfmt
, ...) __printflike(3, 4);
263 extern void vsprintf(char *buf
, const char *cfmt
, __va_list
);
264 extern void vsnprintf(char *buf
, size_t size
, const char *cfmt
, __va_list
);
266 extern void twiddle(u_int callerdiv
);
267 extern void twiddle_divisor(u_int globaldiv
);
269 extern void ngets(char *, int);
270 #define gets(x) ngets((x), 0)
271 extern int fgetstr(char *buf
, int size
, int fd
);
273 extern int open(const char *, int);
277 extern int close(int);
278 extern void closeall(void);
279 extern ssize_t
read(int, void *, size_t);
280 extern ssize_t
write(int, void *, size_t);
281 extern struct dirent
*readdirfd(int);
283 extern void srandom(u_long seed
);
284 extern u_long
random(void);
286 /* imports from stdlib, locally modified */
287 extern long strtol(const char *, char **, int);
288 extern unsigned long strtoul(const char *, char **, int);
289 extern char *optarg
; /* getopt(3) external variables */
290 extern int optind
, opterr
, optopt
, optreset
;
291 extern int getopt(int, char * const [], const char *);
294 extern void pager_open(void);
295 extern void pager_close(void);
296 extern int pager_output(const char *lines
);
297 extern int pager_file(const char *fname
);
299 /* No signal state to preserve */
300 #define setjmp _setjmp
301 #define longjmp _longjmp
304 #define EV_DYNAMIC (1<<0) /* value was dynamically allocated, free if changed/unset */
305 #define EV_VOLATILE (1<<1) /* value is volatile, make a copy of it */
306 #define EV_NOHOOK (1<<2) /* don't call hook when setting */
309 typedef char *(ev_format_t
)(struct env_var
*ev
);
310 typedef int (ev_sethook_t
)(struct env_var
*ev
, int flags
,
312 typedef int (ev_unsethook_t
)(struct env_var
*ev
);
319 ev_sethook_t
*ev_sethook
;
320 ev_unsethook_t
*ev_unsethook
;
321 struct env_var
*ev_next
, *ev_prev
;
323 extern struct env_var
*environ
;
325 extern struct env_var
*env_getenv(const char *name
);
326 extern int env_setenv(const char *name
, int flags
,
327 const void *value
, ev_sethook_t sethook
,
328 ev_unsethook_t unsethook
);
329 extern char *getenv(const char *name
);
330 extern int setenv(const char *name
, const char *value
,
332 extern int putenv(const char *string
);
333 extern int unsetenv(const char *name
);
335 extern ev_sethook_t env_noset
; /* refuse set operation */
336 extern ev_unsethook_t env_nounset
; /* refuse unset operation */
338 /* BCD conversions (undocumented) */
339 extern u_char
const bcd2bin_data
[];
340 extern u_char
const bin2bcd_data
[];
341 extern char const hex2ascii_data
[];
343 #define bcd2bin(bcd) (bcd2bin_data[bcd])
344 #define bin2bcd(bin) (bin2bcd_data[bin])
345 #define hex2ascii(hex) (hex2ascii_data[hex])
347 /* min/max (undocumented) */
348 static __inline
int imax(int a
, int b
) { return (a
> b
? a
: b
); }
349 static __inline
int imin(int a
, int b
) { return (a
< b
? a
: b
); }
350 static __inline
long lmax(long a
, long b
) { return (a
> b
? a
: b
); }
351 static __inline
long lmin(long a
, long b
) { return (a
< b
? a
: b
); }
352 static __inline u_int
max(u_int a
, u_int b
) { return (a
> b
? a
: b
); }
353 static __inline u_int
min(u_int a
, u_int b
) { return (a
< b
? a
: b
); }
354 static __inline quad_t
qmax(quad_t a
, quad_t b
) { return (a
> b
? a
: b
); }
355 static __inline quad_t
qmin(quad_t a
, quad_t b
) { return (a
< b
? a
: b
); }
356 static __inline u_long
ulmax(u_long a
, u_long b
) { return (a
> b
? a
: b
); }
357 static __inline u_long
ulmin(u_long a
, u_long b
) { return (a
< b
? a
: b
); }
359 /* swaps (undocumented, useful?) */
361 extern u_int32_t
bswap32(u_int32_t x
);
362 extern u_int64_t
bswap64(u_int64_t x
);
365 /* null functions for device/filesystem switches (undocumented) */
366 extern int nodev(void);
367 extern int noioctl(struct open_file
*, u_long
, void *);
368 extern void nullsys(void);
370 extern int null_open(const char *path
, struct open_file
*f
);
371 extern int null_close(struct open_file
*f
);
372 extern int null_read(struct open_file
*f
, void *buf
, size_t size
, size_t *resid
);
373 extern int null_write(struct open_file
*f
, void *buf
, size_t size
, size_t *resid
);
374 extern off_t
null_seek(struct open_file
*f
, off_t offset
, int where
);
375 extern int null_stat(struct open_file
*f
, struct stat
*sb
);
376 extern int null_readdir(struct open_file
*f
, struct dirent
*d
);
380 * Machine dependent functions and data, must be provided or stubbed by
383 extern int getchar(void);
384 extern int ischar(void);
385 extern void putchar(int);
386 extern int devopen(struct open_file
*, const char *, const char **);
387 extern int devclose(struct open_file
*f
);
388 extern void panic(const char *, ...) __dead2
__printflike(1, 2);
389 extern struct fs_ops
*file_system
[];
390 extern struct fs_ops
*exclusive_file_system
;
391 extern struct devsw
*devsw
[];
394 * Expose byteorder(3) functions.
396 #ifndef _BYTEORDER_PROTOTYPED
397 #define _BYTEORDER_PROTOTYPED
398 extern uint32_t htonl(uint32_t);
399 extern uint16_t htons(uint16_t);
400 extern uint32_t ntohl(uint32_t);
401 extern uint16_t ntohs(uint16_t);
404 #ifndef _BYTEORDER_FUNC_DEFINED
405 #define _BYTEORDER_FUNC_DEFINED
406 #define htonl(x) __htonl(x)
407 #define htons(x) __htons(x)
408 #define ntohl(x) __ntohl(x)
409 #define ntohs(x) __ntohs(x)
412 void *Malloc(size_t, const char *, int);
413 void *Calloc(size_t, size_t, const char *, int);
414 void *Realloc(void *, size_t, const char *, int);
415 void Free(void *, const char *, int);
418 #define malloc(x) Malloc(x, __FILE__, __LINE__)
419 #define calloc(x, y) Calloc(x, y, __FILE__, __LINE__)
420 #define free(x) Free(x, __FILE__, __LINE__)
421 #define realloc(x, y) Realloc(x, y, __FILE__, __LINE__)
423 #define malloc(x) Malloc(x, NULL, 0)
424 #define calloc(x, y) Calloc(x, y, NULL, 0)
425 #define free(x) Free(x, NULL, 0)
426 #define realloc(x, y) Realloc(x, y, NULL, 0)