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