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 * From $NetBSD: stand.h,v 1.22 1997/06/26 19:17:40 drochner Exp $
26 */
27
28 /*-
29 * Copyright (c) 1993
30 * The Regents of the University of California. All rights reserved.
31 *
32 * Redistribution and use in source and binary forms, with or without
33 * modification, are permitted provided that the following conditions
34 * are met:
35 * 1. Redistributions of source code must retain the above copyright
36 * notice, this list of conditions and the following disclaimer.
37 * 2. Redistributions in binary form must reproduce the above copyright
38 * notice, this list of conditions and the following disclaimer in the
39 * documentation and/or other materials provided with the distribution.
40 * 3. Neither the name of the University nor the names of its contributors
41 * may be used to endorse or promote products derived from this software
42 * without specific prior written permission.
43 *
44 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
45 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
46 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
47 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
48 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
49 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
50 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
51 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
52 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
53 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
54 * SUCH DAMAGE.
55 */
56
57 #ifndef STAND_H
58 #define STAND_H
59
60 #include <sys/types.h>
61 #include <sys/stat.h>
62 #include <sys/dirent.h>
63 #include <sys/queue.h>
64
65 /* this header intentionally exports NULL from <string.h> */
66 #include <string.h>
67 #define strcoll(a, b) strcmp((a), (b))
68
69 #define CHK(fmt, args...) printf("%s(%d): " fmt "\n", __func__, __LINE__ , ##args)
70 #define PCHK(fmt, args...) {printf("%s(%d): " fmt "\n", __func__, __LINE__ , ##args); getchar();}
71
72 #include <sys/errno.h>
73
74 /* special stand error codes */
75 #define EADAPT (ELAST+1) /* bad adaptor */
76 #define ECTLR (ELAST+2) /* bad controller */
77 #define EUNIT (ELAST+3) /* bad unit */
78 #define ESLICE (ELAST+4) /* bad slice */
79 #define EPART (ELAST+5) /* bad partition */
80 #define ERDLAB (ELAST+6) /* can't read disk label */
81 #define EUNLAB (ELAST+7) /* unlabeled disk */
82 #define EOFFSET (ELAST+8) /* relative seek not supported */
83 #define ESALAST (ELAST+8) /* */
84
85 /* Partial signal emulation for sig_atomic_t */
86 #include <machine/signal.h>
87
88 __BEGIN_DECLS
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 *path, struct open_file *f);
103 int (*fo_close)(struct open_file *f);
104 int (*fo_read)(struct open_file *f, void *buf,
105 size_t size, size_t *resid);
106 int (*fo_write)(struct open_file *f, const void *buf,
107 size_t size, size_t *resid);
108 off_t (*fo_seek)(struct open_file *f, off_t offset, int where);
109 int (*fo_stat)(struct open_file *f, struct stat *sb);
110 int (*fo_readdir)(struct open_file *f, struct dirent *d);
111 int (*fo_preload)(struct open_file *f);
112 int (*fo_mount)(const char *, const char *, void **);
113 int (*fo_unmount)(const char *, void *);
114 };
115
116 /*
117 * libsa-supplied filesystems
118 */
119 extern struct fs_ops ufs_fsops;
120 extern struct fs_ops tftp_fsops;
121 extern struct fs_ops nfs_fsops;
122 extern struct fs_ops cd9660_fsops;
123 extern struct fs_ops gzipfs_fsops;
124 extern struct fs_ops bzipfs_fsops;
125 extern struct fs_ops dosfs_fsops;
126 extern struct fs_ops ext2fs_fsops;
127 extern struct fs_ops splitfs_fsops;
128 extern struct fs_ops pkgfs_fsops;
129 extern struct fs_ops efihttp_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 #define DEV_NAMLEN 8 /* Length of name of device class */
140 #define DEV_DEVLEN 128 /* Length of longest device instance name */
141 struct devdesc;
142 struct devsw {
143 const char dv_name[DEV_NAMLEN];
144 int dv_type; /* opaque type constant */
145 #define DEVT_NONE 0
146 #define DEVT_DISK 1
147 #define DEVT_NET 2
148 #define DEVT_CD 3
149 #define DEVT_ZFS 4
150 #define DEVT_FD 5
151 int (*dv_init)(void); /* early probe call */
152 int (*dv_strategy)(void *devdata, int rw, daddr_t blk,
153 size_t size, char *buf, size_t *rsize);
154 int (*dv_open)(struct open_file *f, ...);
155 int (*dv_close)(struct open_file *f);
156 int (*dv_ioctl)(struct open_file *f, u_long cmd, void *data);
157 int (*dv_print)(int verbose); /* print device information */
158 void (*dv_cleanup)(void);
159 char * (*dv_fmtdev)(struct devdesc *);
160 int (*dv_parsedev)(struct devdesc **, const char *, const char **);
161 bool (*dv_match)(struct devsw *, const char *);
162 };
163
164 /*
165 * libsa-supplied device switch
166 */
167 extern struct devsw netdev;
168
169 extern int errno;
170
171 /*
172 * Generic device specifier; architecture-dependent versions may be larger, but
173 * should be allowed to overlap. The larger device specifiers store more data
174 * than can fit in the generic one that's gleaned after parsing the device
175 * string, or used in some cases to indicate wildcards that match a variety of
176 * situations based on what's on the drive itself rather than what the progammer
177 * might know in advance. Information about open files is stored in d_opendata,
178 * though what's passed into the open routine may differ from what's present
179 * after the open on some configurations.
180 */
181 struct devdesc {
182 struct devsw *d_dev;
183 int d_unit;
184 void *d_opendata;
185 };
186
187 char *devformat(struct devdesc *d);
188 int devparse(struct devdesc **, const char *, const char **);
189 int devinit(void);
190 void dev_cleanup(void);
191
192 struct open_file {
193 int f_flags; /* see F_* below */
194 struct devsw *f_dev; /* pointer to device operations */
195 void *f_devdata; /* device specific data */
196 struct fs_ops *f_ops; /* pointer to file system operations */
197 void *f_fsdata; /* file system specific data */
198 off_t f_offset; /* current file offset */
199 char *f_rabuf; /* readahead buffer pointer */
200 size_t f_ralen; /* valid data in readahead buffer */
201 off_t f_raoffset; /* consumer offset in readahead buffer */
202 int f_id; /* file number */
203 TAILQ_ENTRY(open_file) f_link; /* next entry */
204 #define SOPEN_RASIZE 512
205 };
206
207 typedef TAILQ_HEAD(file_list, open_file) file_list_t;
208 extern file_list_t files;
209 extern struct open_file *fd2open_file(int);
210
211 /* f_flags values */
212 #define F_READ 0x0001 /* file opened for reading */
213 #define F_WRITE 0x0002 /* file opened for writing */
214 #define F_RAW 0x0004 /* raw device open - no file system */
215 #define F_NODEV 0x0008 /* network open - no device */
216 #define F_MASK 0xFFFF
217 /* Mode modifier for strategy() */
218 #define F_NORA (0x01 << 16) /* Disable Read-Ahead */
219
220 #define isascii(c) (((c) & ~0x7F) == 0)
221
isupper(int c)222 static __inline int isupper(int c)
223 {
224 return c >= 'A' && c <= 'Z';
225 }
226
islower(int c)227 static __inline int islower(int c)
228 {
229 return c >= 'a' && c <= 'z';
230 }
231
isspace(int c)232 static __inline int isspace(int c)
233 {
234 return c == ' ' || (c >= 0x9 && c <= 0xd);
235 }
236
isdigit(int c)237 static __inline int isdigit(int c)
238 {
239 return c >= '0' && c <= '9';
240 }
241
isxdigit(int c)242 static __inline int isxdigit(int c)
243 {
244 return isdigit(c) || (c >= 'a' && c <= 'f') || (c >= 'A' && c <= 'F');
245 }
246
isalpha(int c)247 static __inline int isalpha(int c)
248 {
249 return isupper(c) || islower(c);
250 }
251
isalnum(int c)252 static __inline int isalnum(int c)
253 {
254 return isalpha(c) || isdigit(c);
255 }
256
iscntrl(int c)257 static __inline int iscntrl(int c)
258 {
259 return (c >= 0 && c < ' ') || c == 127;
260 }
261
isgraph(int c)262 static __inline int isgraph(int c)
263 {
264 return c >= '!' && c <= '~';
265 }
266
ispunct(int c)267 static __inline int ispunct(int c)
268 {
269 return (c >= '!' && c <= '/') || (c >= ':' && c <= '@') ||
270 (c >= '[' && c <= '`') || (c >= '{' && c <= '~');
271 }
272
toupper(int c)273 static __inline int toupper(int c)
274 {
275 return islower(c) ? c - 'a' + 'A' : c;
276 }
277
tolower(int c)278 static __inline int tolower(int c)
279 {
280 return isupper(c) ? c - 'A' + 'a' : c;
281 }
282
283 /* sbrk emulation */
284 extern void setheap(void *base, void *top);
285 extern char *sbrk(int incr);
286
287 extern int printf(const char *fmt, ...) __printflike(1, 2);
288 extern int asprintf(char **buf, const char *cfmt, ...) __printflike(2, 3);
289 extern int sprintf(char *buf, const char *cfmt, ...) __printflike(2, 3);
290 extern int snprintf(char *buf, size_t size, const char *cfmt, ...) __printflike(3, 4);
291 extern int vprintf(const char *fmt, __va_list);
292 extern int vsprintf(char *buf, const char *cfmt, __va_list);
293 extern int vsnprintf(char *buf, size_t size, const char *cfmt, __va_list);
294
295 extern void twiddle(u_int callerdiv);
296 extern void twiddle_divisor(u_int globaldiv);
297
298 extern void ngets(char *, int);
299 #define gets(x) ngets((x), 0)
300 extern int fgetstr(char *buf, int size, int fd);
301
302 extern int mount(const char *dev, const char *path, int flags, void *data);
303 extern int unmount(const char *dev, int flags);
304 extern int open(const char *, int);
305 #define O_RDONLY 0x0
306 #define O_WRONLY 0x1
307 #define O_RDWR 0x2
308 #define O_ACCMODE 0x3
309 /* NOT IMPLEMENTED */
310 #define O_CREAT 0x0200 /* create if nonexistent */
311 #define O_TRUNC 0x0400 /* truncate to zero length */
312 extern int close(int);
313 extern void closeall(void);
314 extern ssize_t read(int, void *, size_t);
315 extern ssize_t write(int, const void *, size_t);
316 extern int ioctl(int, u_long, void *);
317 extern struct dirent *readdirfd(int);
318 extern void preload(int);
319
320 extern void srandom(unsigned int);
321 extern long random(void);
322
323 /* imports from stdlib, locally modified */
324 extern char *optarg; /* getopt(3) external variables */
325 extern int optind, opterr, optopt, optreset;
326 extern int getopt(int, char * const [], const char *);
327
328 /* pager.c */
329 extern void pager_open(void);
330 extern void pager_close(void);
331 extern int pager_output(const char *lines);
332 extern int pager_file(const char *fname);
333
334 /* No signal state to preserve */
335 #define setjmp _setjmp
336 #define longjmp _longjmp
337
338 /* environment.c */
339 #define EV_DYNAMIC (1<<0) /* value was dynamically allocated, free if changed/unset */
340 #define EV_VOLATILE (1<<1) /* value is volatile, make a copy of it */
341 #define EV_NOHOOK (1<<2) /* don't call hook when setting */
342
343 struct env_var;
344 typedef char *(ev_format_t)(struct env_var *ev);
345 typedef int (ev_sethook_t)(struct env_var *ev, int flags,
346 const void *value);
347 typedef int (ev_unsethook_t)(struct env_var *ev);
348
349 struct env_var
350 {
351 char *ev_name;
352 int ev_flags;
353 void *ev_value;
354 ev_sethook_t *ev_sethook;
355 ev_unsethook_t *ev_unsethook;
356 struct env_var *ev_next, *ev_prev;
357 };
358 extern struct env_var *environ;
359
360 extern struct env_var *env_getenv(const char *name);
361 extern int env_setenv(const char *name, int flags,
362 const void *value, ev_sethook_t sethook,
363 ev_unsethook_t unsethook);
364 extern void env_discard(struct env_var *);
365 extern char *getenv(const char *name);
366 extern int setenv(const char *name, const char *value,
367 int overwrite);
368 extern int putenv(char *string);
369 extern int unsetenv(const char *name);
370
371 extern ev_sethook_t env_noset; /* refuse set operation */
372 extern ev_unsethook_t env_nounset; /* refuse unset operation */
373
374 /* stdlib.h routines */
375 extern int abs(int a);
376 extern void abort(void) __dead2;
377 extern long strtol(const char * __restrict, char ** __restrict, int);
378 extern long long strtoll(const char * __restrict, char ** __restrict, int);
379 extern unsigned long strtoul(const char * __restrict, char ** __restrict, int);
380 extern unsigned long long strtoull(const char * __restrict, char ** __restrict, int);
381
382 /* BCD conversions (undocumented) */
383 extern u_char const bcd2bin_data[];
384 extern u_char const bin2bcd_data[];
385 extern char const hex2ascii_data[];
386
387 #define bcd2bin(bcd) (bcd2bin_data[bcd])
388 #define bin2bcd(bin) (bin2bcd_data[bin])
389 #define hex2ascii(hex) (hex2ascii_data[hex])
390 #define validbcd(bcd) (bcd == 0 || (bcd > 0 && bcd <= 0x99 && bcd2bin_data[bcd] != 0))
391
392 /* min/max (undocumented) */
imax(int a,int b)393 static __inline int imax(int a, int b) { return (a > b ? a : b); }
imin(int a,int b)394 static __inline int imin(int a, int b) { return (a < b ? a : b); }
lmax(long a,long b)395 static __inline long lmax(long a, long b) { return (a > b ? a : b); }
lmin(long a,long b)396 static __inline long lmin(long a, long b) { return (a < b ? a : b); }
max(u_int a,u_int b)397 static __inline u_int max(u_int a, u_int b) { return (a > b ? a : b); }
min(u_int a,u_int b)398 static __inline u_int min(u_int a, u_int b) { return (a < b ? a : b); }
qmax(quad_t a,quad_t b)399 static __inline quad_t qmax(quad_t a, quad_t b) { return (a > b ? a : b); }
qmin(quad_t a,quad_t b)400 static __inline quad_t qmin(quad_t a, quad_t b) { return (a < b ? a : b); }
ulmax(u_long a,u_long b)401 static __inline u_long ulmax(u_long a, u_long b) { return (a > b ? a : b); }
ulmin(u_long a,u_long b)402 static __inline u_long ulmin(u_long a, u_long b) { return (a < b ? a : b); }
403
404 /* null functions for device/filesystem switches (undocumented) */
405 extern int nodev(void);
406 extern int noioctl(struct open_file *, u_long, void *);
407 extern void nullsys(void);
408
409 extern int null_open(const char *path, struct open_file *f);
410 extern int null_close(struct open_file *f);
411 extern int null_read(struct open_file *f, void *buf, size_t size, size_t *resid);
412 extern int null_write(struct open_file *f, const void *buf, size_t size, size_t *resid);
413 extern off_t null_seek(struct open_file *f, off_t offset, int where);
414 extern int null_stat(struct open_file *f, struct stat *sb);
415 extern int null_readdir(struct open_file *f, struct dirent *d);
416
417
418 /*
419 * Machine dependent functions and data, must be provided or stubbed by
420 * the consumer
421 */
422 extern void exit(int) __dead2;
423 extern int getchar(void);
424 extern int ischar(void);
425 extern void putchar(int);
426 extern int devopen(struct open_file *, const char *, const char **);
427 extern int devclose(struct open_file *f);
428 extern void panic(const char *, ...) __dead2 __printflike(1, 2);
429 extern void panic_action(void) __weak_symbol __dead2;
430 extern time_t getsecs(void);
431 extern struct fs_ops *file_system[];
432 extern struct fs_ops *exclusive_file_system;
433 extern struct devsw *devsw[];
434
435 /*
436 * Time routines
437 */
438 time_t time(time_t *);
439
440 /*
441 * Expose byteorder(3) functions.
442 */
443 #ifndef _BYTEORDER_PROTOTYPED
444 #define _BYTEORDER_PROTOTYPED
445 extern uint32_t htonl(uint32_t);
446 extern uint16_t htons(uint16_t);
447 extern uint32_t ntohl(uint32_t);
448 extern uint16_t ntohs(uint16_t);
449 #endif
450
451 #ifndef _BYTEORDER_FUNC_DEFINED
452 #define _BYTEORDER_FUNC_DEFINED
453 #define htonl(x) __htonl(x)
454 #define htons(x) __htons(x)
455 #define ntohl(x) __ntohl(x)
456 #define ntohs(x) __ntohs(x)
457 #endif
458
459 void *Malloc(size_t, const char *, int);
460 void *Memalign(size_t, size_t, const char *, int);
461 void *Calloc(size_t, size_t, const char *, int);
462 void *Realloc(void *, size_t, const char *, int);
463 void *Reallocf(void *, size_t, const char *, int);
464 void Free(void *, const char *, int);
465 extern void mallocstats(void);
466
467 const char *x86_hypervisor(void);
468
469 #ifdef USER_MALLOC
470 extern void *malloc(size_t);
471 extern void *memalign(size_t, size_t);
472 extern void *calloc(size_t, size_t);
473 extern void free(void *);
474 extern void *realloc(void *, size_t);
475 extern void *reallocf(void *, size_t);
476 #elif defined(DEBUG_MALLOC)
477 #define malloc(x) Malloc(x, __FILE__, __LINE__)
478 #define memalign(x, y) Memalign(x, y, __FILE__, __LINE__)
479 #define calloc(x, y) Calloc(x, y, __FILE__, __LINE__)
480 #define free(x) Free(x, __FILE__, __LINE__)
481 #define realloc(x, y) Realloc(x, y, __FILE__, __LINE__)
482 #define reallocf(x, y) Reallocf(x, y, __FILE__, __LINE__)
483 #else
484 #define malloc(x) Malloc(x, NULL, 0)
485 #define memalign(x, y) Memalign(x, y, NULL, 0)
486 #define calloc(x, y) Calloc(x, y, NULL, 0)
487 #define free(x) Free(x, NULL, 0)
488 #define realloc(x, y) Realloc(x, y, NULL, 0)
489 #define reallocf(x, y) Reallocf(x, y, NULL, 0)
490 #endif
491
492 /*
493 * va <-> pa routines. MD code must supply.
494 */
495 caddr_t ptov(uintptr_t);
496
497 /* features.c */
498 typedef void (feature_iter_fn)(void *, const char *, const char *, bool);
499
500 extern void feature_enable(uint32_t);
501 extern bool feature_name_is_enabled(const char *);
502 extern void feature_iter(feature_iter_fn *, void *);
503
504 /*
505 * Note that these should also be added to the mapping table in features.c,
506 * which the interpreter may query to provide details from. The name with
507 * FEATURE_ removed is assumed to be the name we'll provide in the loader
508 * features table, just to simplify reasoning about these.
509 */
510 #define FEATURE_EARLY_ACPI 0x0001
511
512 /* hexdump.c */
513 void hexdump(caddr_t region, size_t len);
514
515 /* nvstore.c */
516 typedef int (nvstore_getter_cb_t)(void *, const char *, void **);
517 typedef int (nvstore_setter_cb_t)(void *, int, const char *,
518 const void *, size_t);
519 typedef int (nvstore_setter_str_cb_t)(void *, const char *, const char *,
520 const char *);
521 typedef int (nvstore_unset_cb_t)(void *, const char *);
522 typedef int (nvstore_print_cb_t)(void *, void *);
523 typedef int (nvstore_iterate_cb_t)(void *, int (*)(void *, void *));
524
525 typedef struct nvs_callbacks {
526 nvstore_getter_cb_t *nvs_getter;
527 nvstore_setter_cb_t *nvs_setter;
528 nvstore_setter_str_cb_t *nvs_setter_str;
529 nvstore_unset_cb_t *nvs_unset;
530 nvstore_print_cb_t *nvs_print;
531 nvstore_iterate_cb_t *nvs_iterate;
532 } nvs_callbacks_t;
533
534 int nvstore_init(const char *, nvs_callbacks_t *, void *);
535 int nvstore_fini(const char *);
536 void *nvstore_get_store(const char *);
537 int nvstore_print(void *);
538 int nvstore_get_var(void *, const char *, void **);
539 int nvstore_set_var(void *, int, const char *, void *, size_t);
540 int nvstore_set_var_from_string(void *, const char *, const char *,
541 const char *);
542 int nvstore_unset_var(void *, const char *);
543
544 /* tslog.c */
545 #define TSRAW(a, b, c) tslog(a, b, c)
546 #define TSENTER() TSRAW("ENTER", __func__, NULL)
547 #define TSENTER2(x) TSRAW("ENTER", __func__, x)
548 #define TSEXIT() TSRAW("EXIT", __func__, NULL)
549 #define TSLINE() TSRAW("EVENT", __FILE__, __XSTRING(__LINE__))
550 void tslog(const char *, const char *, const char *);
551 void tslog_setbuf(void * buf, size_t len);
552 void tslog_getbuf(void ** buf, size_t * len);
553
554 __END_DECLS
555
556 #endif /* STAND_H */
557