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: stable/9/lib/libstand/stand.h 223905 2011-07-10 07:25:34Z avatar $
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 * 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.
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 <sys/types.h>
65 #include <sys/cdefs.h>
66 #include <sys/stat.h>
67 #include <sys/dirent.h>
68
69 /* this header intentionally exports NULL from <string.h> */
70 #include <string.h>
71
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();}
74
75 /* Avoid unwanted userlandish components */
76 #define _KERNEL
77 #include <sys/errno.h>
78 #undef _KERNEL
79
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) /* */
90
91 struct open_file;
92
93 /*
94 * This structure is used to define file system operations in a file system
95 * independent way.
96 *
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.
100 */
101 struct fs_ops {
102 const char *fs_name;
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);
112 };
113
114 /*
115 * libstand-supplied filesystems
116 */
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 gzipfs_fsops;
122 extern struct fs_ops bzipfs_fsops;
123 extern struct fs_ops dosfs_fsops;
124 extern struct fs_ops ext2fs_fsops;
125 extern struct fs_ops splitfs_fsops;
126
127 /* where values for lseek(2) */
128 #define SEEK_SET 0 /* set file offset to offset */
129 #define SEEK_CUR 1 /* set file offset to current plus offset */
130 #define SEEK_END 2 /* set file offset to EOF plus offset */
131
132 /*
133 * Device switch
134 */
135 struct devsw {
136 const char dv_name[8];
137 int dv_type; /* opaque type constant, arch-dependant */
138 int (*dv_init)(void); /* early probe call */
139 int (*dv_strategy)(void *devdata, int rw, daddr_t blk, size_t size,
140 char *buf, size_t *rsize);
141 int (*dv_open)(struct open_file *f, ...);
142 int (*dv_close)(struct open_file *f);
143 int (*dv_ioctl)(struct open_file *f, u_long cmd, void *data);
144 void (*dv_print)(int verbose); /* 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
155 struct open_file {
156 int f_flags; /* see F_* below */
157 struct devsw *f_dev; /* pointer to device operations */
158 void *f_devdata; /* device specific data */
159 struct fs_ops *f_ops; /* pointer to file system operations */
160 void *f_fsdata; /* file system specific data */
161 off_t f_offset; /* current file offset */
162 char *f_rabuf; /* readahead buffer pointer */
163 size_t f_ralen; /* valid data in readahead buffer */
164 off_t f_raoffset; /* consumer offset in readahead buffer */
165 #define SOPEN_RASIZE 512
166 };
167
168 #define SOPEN_MAX 64
169 extern struct open_file files[];
170
171 /* f_flags values */
172 #define F_READ 0x0001 /* file opened for reading */
173 #define F_WRITE 0x0002 /* file opened for writing */
174 #define F_RAW 0x0004 /* raw device open - no file system */
175 #define F_NODEV 0x0008 /* network open - no device */
176
177 #define isascii(c) (((c) & ~0x7F) == 0)
178
isupper(int c)179 static __inline int isupper(int c)
180 {
181 return c >= 'A' && c <= 'Z';
182 }
183
islower(int c)184 static __inline int islower(int c)
185 {
186 return c >= 'a' && c <= 'z';
187 }
188
isspace(int c)189 static __inline int isspace(int c)
190 {
191 return c == ' ' || (c >= 0x9 && c <= 0xd);
192 }
193
isdigit(int c)194 static __inline int isdigit(int c)
195 {
196 return c >= '0' && c <= '9';
197 }
198
isxdigit(int c)199 static __inline int isxdigit(int c)
200 {
201 return isdigit(c) || (c >= 'a' && c <= 'f') || (c >= 'A' && c <= 'F');
202 }
203
isalpha(int c)204 static __inline int isalpha(int c)
205 {
206 return isupper(c) || islower(c);
207 }
208
isalnum(int c)209 static __inline int isalnum(int c)
210 {
211 return isalpha(c) || isdigit(c);
212 }
213
toupper(int c)214 static __inline int toupper(int c)
215 {
216 return islower(c) ? c - 'a' + 'A' : c;
217 }
218
tolower(int c)219 static __inline int tolower(int c)
220 {
221 return isupper(c) ? c - 'A' + 'a' : c;
222 }
223
224 /* sbrk emulation */
225 extern void setheap(void *base, void *top);
226 extern char *sbrk(int incr);
227
228 /* Matt Dillon's zalloc/zmalloc */
229 extern void *malloc(size_t bytes);
230 extern void free(void *ptr);
231 /*#define free(p) {CHK("free %p", p); free(p);} */ /* use for catching guard violations */
232 extern void *calloc(size_t n1, size_t n2);
233 extern void *realloc(void *ptr, size_t size);
234 extern void *reallocf(void *ptr, size_t size);
235 extern void mallocstats(void);
236
237 extern int printf(const char *fmt, ...) __printflike(1, 2);
238 extern void vprintf(const char *fmt, __va_list);
239 extern int sprintf(char *buf, const char *cfmt, ...) __printflike(2, 3);
240 extern void vsprintf(char *buf, const char *cfmt, __va_list);
241
242 extern void twiddle(void);
243
244 extern void ngets(char *, int);
245 #define gets(x) ngets((x), 0)
246 extern int fgetstr(char *buf, int size, int fd);
247
248 extern int open(const char *, int);
249 #define O_RDONLY 0x0
250 #define O_WRONLY 0x1
251 #define O_RDWR 0x2
252 extern int close(int);
253 extern void closeall(void);
254 extern ssize_t read(int, void *, size_t);
255 extern ssize_t write(int, void *, size_t);
256 extern struct dirent *readdirfd(int);
257
258 extern void srandom(u_long seed);
259 extern u_long random(void);
260
261 /* imports from stdlib, locally modified */
262 extern long strtol(const char *, char **, int);
263 extern char *optarg; /* getopt(3) external variables */
264 extern int optind, opterr, optopt, optreset;
265 extern int getopt(int, char * const [], const char *);
266
267 /* pager.c */
268 extern void pager_open(void);
269 extern void pager_close(void);
270 extern int pager_output(const char *lines);
271 extern int pager_file(const char *fname);
272
273 /* No signal state to preserve */
274 #define setjmp _setjmp
275 #define longjmp _longjmp
276
277 /* environment.c */
278 #define EV_DYNAMIC (1<<0) /* value was dynamically allocated, free if changed/unset */
279 #define EV_VOLATILE (1<<1) /* value is volatile, make a copy of it */
280 #define EV_NOHOOK (1<<2) /* don't call hook when setting */
281
282 struct env_var;
283 typedef char *(ev_format_t)(struct env_var *ev);
284 typedef int (ev_sethook_t)(struct env_var *ev, int flags,
285 const void *value);
286 typedef int (ev_unsethook_t)(struct env_var *ev);
287
288 struct env_var
289 {
290 char *ev_name;
291 int ev_flags;
292 void *ev_value;
293 ev_sethook_t *ev_sethook;
294 ev_unsethook_t *ev_unsethook;
295 struct env_var *ev_next, *ev_prev;
296 };
297 extern struct env_var *environ;
298
299 extern struct env_var *env_getenv(const char *name);
300 extern int env_setenv(const char *name, int flags,
301 const void *value, ev_sethook_t sethook,
302 ev_unsethook_t unsethook);
303 extern char *getenv(const char *name);
304 extern int setenv(const char *name, const char *value,
305 int overwrite);
306 extern int putenv(const char *string);
307 extern int unsetenv(const char *name);
308
309 extern ev_sethook_t env_noset; /* refuse set operation */
310 extern ev_unsethook_t env_nounset; /* refuse unset operation */
311
312 /* BCD conversions (undocumented) */
313 extern u_char const bcd2bin_data[];
314 extern u_char const bin2bcd_data[];
315 extern char const hex2ascii_data[];
316
317 #define bcd2bin(bcd) (bcd2bin_data[bcd])
318 #define bin2bcd(bin) (bin2bcd_data[bin])
319 #define hex2ascii(hex) (hex2ascii_data[hex])
320
321 /* min/max (undocumented) */
imax(int a,int b)322 static __inline int imax(int a, int b) { return (a > b ? a : b); }
imin(int a,int b)323 static __inline int imin(int a, int b) { return (a < b ? a : b); }
lmax(long a,long b)324 static __inline long lmax(long a, long b) { return (a > b ? a : b); }
lmin(long a,long b)325 static __inline long lmin(long a, long b) { return (a < b ? a : b); }
max(u_int a,u_int b)326 static __inline u_int max(u_int a, u_int b) { return (a > b ? a : b); }
min(u_int a,u_int b)327 static __inline u_int min(u_int a, u_int b) { return (a < b ? a : b); }
qmax(quad_t a,quad_t b)328 static __inline quad_t qmax(quad_t a, quad_t b) { return (a > b ? a : b); }
qmin(quad_t a,quad_t b)329 static __inline quad_t qmin(quad_t a, quad_t b) { return (a < b ? a : b); }
ulmax(u_long a,u_long b)330 static __inline u_long ulmax(u_long a, u_long b) { return (a > b ? a : b); }
ulmin(u_long a,u_long b)331 static __inline u_long ulmin(u_long a, u_long b) { return (a < b ? a : b); }
332
333 /* swaps (undocumented, useful?) */
334 #ifdef __i386__
335 extern u_int32_t bswap32(u_int32_t x);
336 extern u_int64_t bswap64(u_int64_t x);
337 #endif
338
339 /* null functions for device/filesystem switches (undocumented) */
340 extern int nodev(void);
341 extern int noioctl(struct open_file *, u_long, void *);
342 extern void nullsys(void);
343
344 extern int null_open(const char *path, struct open_file *f);
345 extern int null_close(struct open_file *f);
346 extern int null_read(struct open_file *f, void *buf, size_t size, size_t *resid);
347 extern int null_write(struct open_file *f, void *buf, size_t size, size_t *resid);
348 extern off_t null_seek(struct open_file *f, off_t offset, int where);
349 extern int null_stat(struct open_file *f, struct stat *sb);
350 extern int null_readdir(struct open_file *f, struct dirent *d);
351
352
353 /*
354 * Machine dependent functions and data, must be provided or stubbed by
355 * the consumer
356 */
357 extern int getchar(void);
358 extern int ischar(void);
359 extern void putchar(int);
360 extern int devopen(struct open_file *, const char *, const char **);
361 extern int devclose(struct open_file *f);
362 extern void panic(const char *, ...) __dead2 __printflike(1, 2);
363 extern struct fs_ops *file_system[];
364 extern struct devsw *devsw[];
365
366 /*
367 * Expose byteorder(3) functions.
368 */
369 #ifndef _BYTEORDER_PROTOTYPED
370 #define _BYTEORDER_PROTOTYPED
371 extern uint32_t htonl(uint32_t);
372 extern uint16_t htons(uint16_t);
373 extern uint32_t ntohl(uint32_t);
374 extern uint16_t ntohs(uint16_t);
375 #endif
376
377 #ifndef _BYTEORDER_FUNC_DEFINED
378 #define _BYTEORDER_FUNC_DEFINED
379 #define htonl(x) __htonl(x)
380 #define htons(x) __htons(x)
381 #define ntohl(x) __ntohl(x)
382 #define ntohs(x) __ntohs(x)
383 #endif
384
385 void *Malloc(size_t, const char *, int);
386 void *Calloc(size_t, size_t, const char *, int);
387 void *Realloc(void *, size_t, const char *, int);
388 void Free(void *, const char *, int);
389
390 #if 1
391 #define malloc(x) Malloc(x, __FILE__, __LINE__)
392 #define calloc(x, y) Calloc(x, y, __FILE__, __LINE__)
393 #define free(x) Free(x, __FILE__, __LINE__)
394 #define realloc(x, y) Realloc(x, y, __FILE__, __LINE__)
395 #else
396 #define malloc(x) Malloc(x, NULL, 0)
397 #define calloc(x, y) Calloc(x, y, NULL, 0)
398 #define free(x) Free(x, NULL, 0)
399 #define realloc(x, y) Realloc(x, y, NULL, 0)
400 #endif
401
402 #endif /* STAND_H */
403