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