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