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...) \
73 printf("%s(%d): " fmt "\n", __func__, __LINE__, ##args)
74 #define PCHK(fmt, args...) {\
75 printf("%s(%d): " fmt "\n", __func__, __LINE__, ##args); getchar();\
76 }
77
78 /* Avoid unwanted userlandish components */
79 #define _KERNEL
80 #include <sys/errno.h>
81 #undef _KERNEL
82
83 /* special stand error codes */
84 #define EADAPT (ELAST+1) /* bad adaptor */
85 #define ECTLR (ELAST+2) /* bad controller */
86 #define EUNIT (ELAST+3) /* bad unit */
87 #define ESLICE (ELAST+4) /* bad slice */
88 #define EPART (ELAST+5) /* bad partition */
89 #define ERDLAB (ELAST+6) /* can't read disk label */
90 #define EUNLAB (ELAST+7) /* unlabeled disk */
91 #define EOFFSET (ELAST+8) /* relative seek not supported */
92 #define ESALAST (ELAST+8) /* */
93
94 struct open_file;
95
96 /*
97 * This structure is used to define file system operations in a file system
98 * independent way.
99 *
100 * XXX note that filesystem providers should export a pointer to their fs_ops
101 * struct, so that consumers can reference this and thus include the
102 * filesystems that they require.
103 */
104 struct fs_ops {
105 const char *fs_name;
106 int (*fo_open)(const char *path, struct open_file *f);
107 int (*fo_close)(struct open_file *f);
108 int (*fo_read)(struct open_file *f, void *buf,
109 size_t size, size_t *resid);
110 int (*fo_write)(struct open_file *f, const void *buf,
111 size_t size, size_t *resid);
112 off_t (*fo_seek)(struct open_file *f, off_t offset, int where);
113 int (*fo_stat)(struct open_file *f, struct stat *sb);
114 int (*fo_readdir)(struct open_file *f, struct dirent *d);
115 };
116
117 /*
118 * libstand-supplied filesystems
119 */
120 extern struct fs_ops ufs_fsops;
121 extern struct fs_ops tftp_fsops;
122 extern struct fs_ops nfs_fsops;
123 extern struct fs_ops cd9660_fsops;
124 extern struct fs_ops gzipfs_fsops;
125 extern struct fs_ops bzipfs_fsops;
126 extern struct fs_ops dosfs_fsops;
127 extern struct fs_ops ext2fs_fsops;
128 extern struct fs_ops splitfs_fsops;
129 extern struct fs_ops pkgfs_fsops;
130
131 /* where values for lseek(2) */
132 #define SEEK_SET 0 /* set file offset to offset */
133 #define SEEK_CUR 1 /* set file offset to current plus offset */
134 #define SEEK_END 2 /* set file offset to EOF plus offset */
135
136 /*
137 * Device switch
138 */
139 struct devsw {
140 const char dv_name[8];
141 int dv_type; /* opaque type constant, arch-dependant */
142 #define DEVT_NONE 0
143 #define DEVT_DISK 1
144 #define DEVT_NET 2
145 #define DEVT_CD 3
146 #define DEVT_ZFS 4
147 #define DEVT_FD 5
148 int (*dv_init)(void); /* early probe call */
149 int (*dv_strategy)(void *devdata, int rw, daddr_t blk,
150 size_t size, char *buf, size_t *rsize);
151 int (*dv_open)(struct open_file *f, ...);
152 int (*dv_close)(struct open_file *f);
153 int (*dv_ioctl)(struct open_file *f, ulong_t cmd, void *data);
154 int (*dv_print)(int verbose); /* print device information */
155 void (*dv_cleanup)(void);
156 };
157
158 /*
159 * libstand-supplied device switch
160 */
161 extern struct devsw netdev;
162
163 extern int errno;
164
165 /*
166 * Generic device specifier; architecture-dependent
167 * versions may be larger, but should be allowed to
168 * overlap.
169 */
170 struct devdesc {
171 struct devsw *d_dev;
172 int d_unit;
173 void *d_opendata;
174 };
175
176 struct open_file {
177 int f_flags; /* see F_* below */
178 struct devsw *f_dev; /* pointer to device operations */
179 void *f_devdata; /* device specific data */
180 struct fs_ops *f_ops; /* pointer to file system operations */
181 void *f_fsdata; /* file system specific data */
182 off_t f_offset; /* current file offset */
183 char *f_rabuf; /* readahead buffer pointer */
184 size_t f_ralen; /* valid data in readahead buffer */
185 off_t f_raoffset; /* consumer offset in readahead buffer */
186 #define SOPEN_RASIZE 512
187 };
188
189 #define SOPEN_MAX 64
190 extern struct open_file files[];
191
192 /* f_flags values */
193 #define F_READ 0x0001 /* file opened for reading */
194 #define F_WRITE 0x0002 /* file opened for writing */
195 #define F_RAW 0x0004 /* raw device open - no file system */
196 #define F_NODEV 0x0008 /* network open - no device */
197 #define F_GZIP 0x0010 /* file is compressed by gzip */
198 #define F_BZIP 0x0020 /* file is compressed by bzip */
199 #define F_MASK 0xFFFF
200 /* Mode modifier for strategy() */
201 #define F_NORA (0x01 << 16) /* Disable Read-Ahead */
202
203 #define isascii(c) (((c) & ~0x7F) == 0)
204
isupper(int c)205 static __inline int isupper(int c)
206 {
207 return (c >= 'A' && c <= 'Z');
208 }
209
islower(int c)210 static __inline int islower(int c)
211 {
212 return (c >= 'a' && c <= 'z');
213 }
214
isspace(int c)215 static __inline int isspace(int c)
216 {
217 return (c == ' ' || (c >= 0x9 && c <= 0xd));
218 }
219
isdigit(int c)220 static __inline int isdigit(int c)
221 {
222 return (c >= '0' && c <= '9');
223 }
224
isxdigit(int c)225 static __inline int isxdigit(int c)
226 {
227 return (isdigit(c) || (c >= 'a' && c <= 'f') || (c >= 'A' && c <= 'F'));
228 }
229
isalpha(int c)230 static __inline int isalpha(int c)
231 {
232 return (isupper(c) || islower(c));
233 }
234
isalnum(int c)235 static __inline int isalnum(int c)
236 {
237 return (isalpha(c) || isdigit(c));
238 }
239
iscntrl(int c)240 static __inline int iscntrl(int c)
241 {
242 return ((c >= 0 && c < ' ') || c == 127);
243 }
244
isgraph(int c)245 static __inline int isgraph(int c)
246 {
247 return (c >= '!' && c <= '~');
248 }
249
ispunct(int c)250 static __inline int ispunct(int c)
251 {
252 return ((c >= '!' && c <= '/') || (c >= ':' && c <= '@') ||
253 (c >= '[' && c <= '`') || (c >= '{' && c <= '~'));
254 }
255
toupper(int c)256 static __inline int toupper(int c)
257 {
258 return (islower(c) ? c - 'a' + 'A' : c);
259 }
260
tolower(int c)261 static __inline int tolower(int c)
262 {
263 return (isupper(c) ? c - 'A' + 'a' : c);
264 }
265
266 /* sbrk emulation */
267 extern void setheap(void *base, void *top);
268 extern char *sbrk(int incr);
269
270 extern void mallocstats(void);
271
272 extern int printf(const char *fmt, ...) __printflike(1, 2);
273 extern void vprintf(const char *fmt, __va_list);
274 extern int asprintf(char **buf, const char *cfmt, ...) __printflike(2, 3);
275 extern int sprintf(char *buf, const char *cfmt, ...) __printflike(2, 3);
276 extern int snprintf(char *buf, size_t size, const char *cfmt, ...) \
277 __printflike(3, 4);
278 extern void vsprintf(char *buf, const char *cfmt, __va_list);
279 extern void vsnprintf(char *buf, size_t size, const char *cfmt, __va_list);
280
281 extern void twiddle(uint_t callerdiv);
282 extern void twiddle_divisor(uint_t globaldiv);
283
284 extern void ngets(char *, int);
285 #define gets(x) ngets((x), 0)
286 extern int fgetstr(char *buf, int size, int fd);
287
288 extern int open(const char *, int);
289 #define O_RDONLY 0x0
290 #define O_WRONLY 0x1
291 #define O_RDWR 0x2
292 extern int close(int);
293 extern void closeall(void);
294 extern ssize_t read(int, void *, size_t);
295 extern ssize_t write(int, const void *, size_t);
296 extern struct dirent *readdirfd(int);
297
298 extern void srandom(ulong_t seed);
299 extern ulong_t random(void);
300
301 extern char *optarg; /* getopt(3) external variables */
302 extern int optind, opterr, optopt, optreset;
303 extern int getopt(int, char * const [], const char *);
304
305 /* pager.c */
306 extern void pager_open(void);
307 extern void pager_close(void);
308 extern int pager_output(const char *lines);
309 extern int pager_file(const char *fname);
310
311 /* No signal state to preserve */
312 #define setjmp _setjmp
313 #define longjmp _longjmp
314
315 /* environment.c */
316 /* value was dynamically allocated, free if changed/unset */
317 #define EV_DYNAMIC (1<<0)
318 /* value is volatile, make a copy of it */
319 #define EV_VOLATILE (1<<1)
320 /* don't call hook when setting */
321 #define EV_NOHOOK (1<<2)
322
323 struct env_var;
324 typedef char *(ev_format_t)(struct env_var *ev);
325 typedef int (ev_sethook_t)(struct env_var *ev, int flags,
326 const void *value);
327 typedef int (ev_unsethook_t)(struct env_var *ev);
328
329 struct env_var
330 {
331 char *ev_name;
332 int ev_flags;
333 void *ev_value;
334 ev_sethook_t *ev_sethook;
335 ev_unsethook_t *ev_unsethook;
336 struct env_var *ev_next, *ev_prev;
337 };
338 extern struct env_var *environ;
339
340 extern struct env_var *env_getenv(const char *name);
341 extern int env_setenv(const char *name, int flags,
342 const void *value, ev_sethook_t sethook,
343 ev_unsethook_t unsethook);
344 extern void env_discard(struct env_var *);
345 extern char *getenv(const char *name);
346 extern int setenv(const char *name, const char *value,
347 int overwrite);
348 extern int putenv(const char *string);
349 extern int unsetenv(const char *name);
350
351 extern ev_sethook_t env_noset; /* refuse set operation */
352 extern ev_unsethook_t env_nounset; /* refuse unset operation */
353
354 /* stdlib.h routines */
355 extern long strtol(const char *__restrict, char **__restrict, int);
356 extern long long strtoll(const char *__restrict, char **__restrict, int);
357 extern unsigned long strtoul(const char *__restrict, char **__restrict, int);
358 extern unsigned long long strtoull(const char *__restrict, char **__restrict,
359 int);
360
361 /* BCD conversions (undocumented) */
362 extern uchar_t const bcd2bin_data[];
363 extern uchar_t const bin2bcd_data[];
364 extern char const hex2ascii_data[];
365
366 #define bcd2bin(bcd) (bcd2bin_data[bcd])
367 #define bin2bcd(bin) (bin2bcd_data[bin])
368 #define hex2ascii(hex) (hex2ascii_data[hex])
369
370 /* min/max (undocumented) */
imax(int a,int b)371 static __inline int imax(int a, int b) { return (a > b ? a : b); }
imin(int a,int b)372 static __inline int imin(int a, int b) { return (a < b ? a : b); }
lmax(long a,long b)373 static __inline long lmax(long a, long b) { return (a > b ? a : b); }
lmin(long a,long b)374 static __inline long lmin(long a, long b) { return (a < b ? a : b); }
max(uint_t a,uint_t b)375 static __inline uint_t max(uint_t a, uint_t b) { return (a > b ? a : b); }
min(uint_t a,uint_t b)376 static __inline uint_t min(uint_t a, uint_t b) { return (a < b ? a : b); }
qmax(quad_t a,quad_t b)377 static __inline quad_t qmax(quad_t a, quad_t b) { return (a > b ? a : b); }
qmin(quad_t a,quad_t b)378 static __inline quad_t qmin(quad_t a, quad_t b) { return (a < b ? a : b); }
ulmax(ulong_t a,ulong_t b)379 static __inline ulong_t ulmax(ulong_t a, ulong_t b) { return (a > b ? a : b); }
ulmin(ulong_t a,ulong_t b)380 static __inline ulong_t ulmin(ulong_t a, ulong_t b) { return (a < b ? a : b); }
381
382 /* null functions for device/filesystem switches (undocumented) */
383 extern int nodev(void);
384 extern int noioctl(struct open_file *, ulong_t, void *);
385 extern void nullsys(void);
386
387 extern int null_open(const char *, struct open_file *);
388 extern int null_close(struct open_file *);
389 extern int null_read(struct open_file *, void *, size_t, size_t *);
390 extern int null_write(struct open_file *, const void *, size_t, size_t *);
391 extern off_t null_seek(struct open_file *, off_t, int);
392 extern int null_stat(struct open_file *, struct stat *);
393 extern int null_readdir(struct open_file *, struct dirent *);
394
395
396 /*
397 * Machine dependent functions and data, must be provided or stubbed by
398 * the consumer
399 */
400 extern void exit(int) __dead2;
401 extern int getchar(void);
402 extern int ischar(void);
403 extern void putchar(int);
404 extern int devopen(struct open_file *, const char *, const char **);
405 extern int devclose(struct open_file *f);
406 extern void panic(const char *, ...) __dead2 __printflike(1, 2);
407 extern void panic_action(void) __weak_symbol __dead2;
408 extern time_t getsecs(void);
409 extern struct fs_ops *file_system[];
410 extern struct fs_ops *exclusive_file_system;
411 extern struct devsw *devsw[];
412
413 /*
414 * Expose byteorder(3) functions.
415 */
416 #ifndef _BYTEORDER_PROTOTYPED
417 #define _BYTEORDER_PROTOTYPED
418 extern uint32_t htonl(uint32_t);
419 extern uint16_t htons(uint16_t);
420 extern uint32_t ntohl(uint32_t);
421 extern uint16_t ntohs(uint16_t);
422 #endif
423
424 #ifndef _BYTEORDER_FUNC_DEFINED
425 #define _BYTEORDER_FUNC_DEFINED
426 #define htonl(x) __htonl(x)
427 #define htons(x) __htons(x)
428 #define ntohl(x) __ntohl(x)
429 #define ntohs(x) __ntohs(x)
430 #endif
431
432 void *Malloc(size_t, const char *, int);
433 void *Memalign(size_t, size_t, const char *, int);
434 void *Calloc(size_t, size_t, const char *, int);
435 void *Realloc(void *, size_t, const char *, int);
436 void *Reallocf(void *, size_t, const char *, int);
437 void Free(void *, const char *, int);
438
439 #if DEBUG_MALLOC
440 #define malloc(x) Malloc(x, __FILE__, __LINE__)
441 #define memalign(x, y) Memalign(x, y, __FILE__, __LINE__)
442 #define calloc(x, y) Calloc(x, y, __FILE__, __LINE__)
443 #define free(x) Free(x, __FILE__, __LINE__)
444 #define realloc(x, y) Realloc(x, y, __FILE__, __LINE__)
445 #define reallocf(x, y) Reallocf(x, y, __FILE__, __LINE__)
446 #else
447 #define malloc(x) Malloc(x, NULL, 0)
448 #define memalign(x, y) Memalign(x, y, NULL, 0)
449 #define calloc(x, y) Calloc(x, y, NULL, 0)
450 #define free(x) Free(x, NULL, 0)
451 #define realloc(x, y) Realloc(x, y, NULL, 0)
452 #define reallocf(x, y) Reallocf(x, y, NULL, 0)
453 #endif
454
455 #endif /* STAND_H */
456