xref: /illumos-gate/usr/src/boot/lib/libstand/stand.h (revision a2027c5d)
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 extern int	printf(const char *fmt, ...) __printflike(1, 2);
277 extern void	vprintf(const char *fmt, __va_list);
278 extern int	asprintf(char **buf, const char *cfmt, ...) __printflike(2, 3);
279 extern int	sprintf(char *buf, const char *cfmt, ...) __printflike(2, 3);
280 extern int	snprintf(char *buf, size_t size, const char *cfmt, ...) \
281 		__printflike(3, 4);
282 extern void	vsprintf(char *buf, const char *cfmt, __va_list);
283 extern void	vsnprintf(char *buf, size_t size, const char *cfmt, __va_list);
284 
285 extern void	twiddle(uint_t callerdiv);
286 extern void	twiddle_divisor(uint_t globaldiv);
287 
288 extern void	ngets(char *, int);
289 #define	gets(x)	ngets((x), 0)
290 extern int	fgetstr(char *buf, int size, int fd);
291 
292 extern int	open(const char *, int);
293 #define	O_RDONLY	0x0
294 #define	O_WRONLY	0x1
295 #define	O_RDWR		0x2
296 extern int	close(int);
297 extern void	closeall(void);
298 extern ssize_t	read(int, void *, size_t);
299 extern ssize_t	write(int, const void *, size_t);
300 extern struct	dirent *readdirfd(int);
301 
302 extern void	srandom(ulong_t seed);
303 extern ulong_t	random(void);
304 
305 extern char	*optarg;		/* getopt(3) external variables */
306 extern int	optind, opterr, optopt, optreset;
307 extern int	getopt(int, char * const [], const char *);
308 
309 /* pager.c */
310 extern void	pager_open(void);
311 extern void	pager_close(void);
312 extern int	pager_output(const char *lines);
313 extern int	pager_file(const char *fname);
314 
315 /* No signal state to preserve */
316 #define	setjmp	_setjmp
317 #define	longjmp	_longjmp
318 
319 /* environment.c */
320 /* value was dynamically allocated, free if changed/unset */
321 #define	EV_DYNAMIC	(1<<0)
322 /* value is volatile, make a copy of it */
323 #define	EV_VOLATILE	(1<<1)
324 /* don't call hook when setting */
325 #define	EV_NOHOOK	(1<<2)
326 
327 struct env_var;
328 typedef char	*(ev_format_t)(struct env_var *ev);
329 typedef int	(ev_sethook_t)(struct env_var *ev, int flags,
330 		    const void *value);
331 typedef int	(ev_unsethook_t)(struct env_var *ev);
332 
333 struct env_var
334 {
335     char		*ev_name;
336     int			ev_flags;
337     void		*ev_value;
338     ev_sethook_t	*ev_sethook;
339     ev_unsethook_t	*ev_unsethook;
340     struct env_var	*ev_next, *ev_prev;
341 };
342 extern struct env_var	*environ;
343 
344 extern struct env_var	*env_getenv(const char *name);
345 extern int		env_setenv(const char *name, int flags,
346 				const void *value, ev_sethook_t sethook,
347 				ev_unsethook_t unsethook);
348 extern void		env_discard(struct env_var *);
349 extern char		*getenv(const char *name);
350 extern int		setenv(const char *name, const char *value,
351 				int overwrite);
352 extern int		putenv(const char *string);
353 extern int		unsetenv(const char *name);
354 
355 extern ev_sethook_t	env_noset;		/* refuse set operation */
356 extern ev_unsethook_t	env_nounset;		/* refuse unset operation */
357 
358 /* stdlib.h routines */
359 extern long strtol(const char *__restrict, char **__restrict, int);
360 extern long long strtoll(const char *__restrict, char **__restrict, int);
361 extern unsigned long strtoul(const char *__restrict, char **__restrict, int);
362 extern unsigned long long strtoull(const char *__restrict, char **__restrict,
363     int);
364 
365 /* BCD conversions (undocumented) */
366 extern uchar_t const	bcd2bin_data[];
367 extern uchar_t const	bin2bcd_data[];
368 extern char const	hex2ascii_data[];
369 
370 #define	bcd2bin(bcd)	(bcd2bin_data[bcd])
371 #define	bin2bcd(bin)	(bin2bcd_data[bin])
372 #define	hex2ascii(hex)	(hex2ascii_data[hex])
373 
374 /* min/max (undocumented) */
imax(int a,int b)375 static __inline int imax(int a, int b) { return (a > b ? a : b); }
imin(int a,int b)376 static __inline int imin(int a, int b) { return (a < b ? a : b); }
lmax(long a,long b)377 static __inline long lmax(long a, long b) { return (a > b ? a : b); }
lmin(long a,long b)378 static __inline long lmin(long a, long b) { return (a < b ? a : b); }
max(uint_t a,uint_t b)379 static __inline uint_t max(uint_t a, uint_t b) { return (a > b ? a : b); }
min(uint_t a,uint_t b)380 static __inline uint_t min(uint_t a, uint_t b) { return (a < b ? a : b); }
qmax(quad_t a,quad_t b)381 static __inline quad_t qmax(quad_t a, quad_t b) { return (a > b ? a : b); }
qmin(quad_t a,quad_t b)382 static __inline quad_t qmin(quad_t a, quad_t b) { return (a < b ? a : b); }
ulmax(ulong_t a,ulong_t b)383 static __inline ulong_t ulmax(ulong_t a, ulong_t b) { return (a > b ? a : b); }
ulmin(ulong_t a,ulong_t b)384 static __inline ulong_t ulmin(ulong_t a, ulong_t b) { return (a < b ? a : b); }
385 
386 /* null functions for device/filesystem switches (undocumented) */
387 extern int	nodev(void);
388 extern int	noioctl(struct open_file *, ulong_t, void *);
389 extern void	nullsys(void);
390 
391 extern int	null_open(const char *, struct open_file *);
392 extern int	null_close(struct open_file *);
393 extern int	null_read(struct open_file *, void *, size_t, size_t *);
394 extern int	null_write(struct open_file *, const void *, size_t, size_t *);
395 extern off_t	null_seek(struct open_file *, off_t, int);
396 extern int	null_stat(struct open_file *, struct stat *);
397 extern int	null_readdir(struct open_file *, struct dirent *);
398 
399 
400 /*
401  * Machine dependent functions and data, must be provided or stubbed by
402  * the consumer
403  */
404 extern void	exit(int) __dead2;
405 extern int	getchar(void);
406 extern int	ischar(void);
407 extern void	putchar(int);
408 extern int	devopen(struct open_file *, const char *, const char **);
409 extern int	devclose(struct open_file *f);
410 extern void	panic(const char *, ...) __dead2 __printflike(1, 2);
411 extern void	panic_action(void) __weak_symbol __dead2;
412 extern time_t	getsecs(void);
413 extern struct fs_ops	*file_system[];
414 extern struct fs_ops	*exclusive_file_system;
415 extern struct devsw	*devsw[];
416 
417 /*
418  * Expose byteorder(3) functions.
419  */
420 #ifndef _BYTEORDER_PROTOTYPED
421 #define	_BYTEORDER_PROTOTYPED
422 extern uint32_t		htonl(uint32_t);
423 extern uint16_t		htons(uint16_t);
424 extern uint32_t		ntohl(uint32_t);
425 extern uint16_t		ntohs(uint16_t);
426 #endif
427 
428 #ifndef _BYTEORDER_FUNC_DEFINED
429 #define	_BYTEORDER_FUNC_DEFINED
430 #define	htonl(x)	__htonl(x)
431 #define	htons(x)	__htons(x)
432 #define	ntohl(x)	__ntohl(x)
433 #define	ntohs(x)	__ntohs(x)
434 #endif
435 
436 void *Malloc(size_t, const char *, int);
437 void *Memalign(size_t, size_t, const char *, int);
438 void *Calloc(size_t, size_t, const char *, int);
439 void *Realloc(void *, size_t, const char *, int);
440 void *Reallocf(void *, size_t, const char *, int);
441 void Free(void *, const char *, int);
442 
443 #if DEBUG_MALLOC
444 #define	malloc(x)	Malloc(x, __FILE__, __LINE__)
445 #define	memalign(x, y)	Memalign(x, y, __FILE__, __LINE__)
446 #define	calloc(x, y)	Calloc(x, y, __FILE__, __LINE__)
447 #define	free(x)		Free(x, __FILE__, __LINE__)
448 #define	realloc(x, y)	Realloc(x, y, __FILE__, __LINE__)
449 #define	reallocf(x, y)	Reallocf(x, y, __FILE__, __LINE__)
450 #else
451 #define	malloc(x)	Malloc(x, NULL, 0)
452 #define	memalign(x, y)	Memalign(x, y, NULL, 0)
453 #define	calloc(x, y)	Calloc(x, y, NULL, 0)
454 #define	free(x)		Free(x, NULL, 0)
455 #define	realloc(x, y)	Realloc(x, y, NULL, 0)
456 #define	reallocf(x, y)	Reallocf(x, y, NULL, 0)
457 #endif
458 
459 #endif	/* STAND_H */
460