xref: /illumos-gate/usr/src/boot/lib/libstand/stand.h (revision 5fae793b)
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 nandfs_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 #define	SOPEN_RASIZE	512
188 };
189 
190 #define	SOPEN_MAX	64
191 extern struct open_file files[];
192 
193 /* f_flags values */
194 #define	F_READ		0x0001	/* file opened for reading */
195 #define	F_WRITE		0x0002	/* file opened for writing */
196 #define	F_RAW		0x0004	/* raw device open - no file system */
197 #define	F_NODEV		0x0008	/* network open - no device */
198 #define	F_GZIP		0x0010  /* file is compressed by gzip */
199 #define	F_BZIP		0x0020	/* file is compressed by bzip */
200 #define	F_MASK		0xFFFF
201 /* Mode modifier for strategy() */
202 #define	F_NORA		(0x01 << 16)	/* Disable Read-Ahead */
203 
204 #define	isascii(c)	(((c) & ~0x7F) == 0)
205 
206 static __inline int isupper(int c)
207 {
208 	return (c >= 'A' && c <= 'Z');
209 }
210 
211 static __inline int islower(int c)
212 {
213 	return (c >= 'a' && c <= 'z');
214 }
215 
216 static __inline int isspace(int c)
217 {
218 	return (c == ' ' || (c >= 0x9 && c <= 0xd));
219 }
220 
221 static __inline int isdigit(int c)
222 {
223 	return (c >= '0' && c <= '9');
224 }
225 
226 static __inline int isxdigit(int c)
227 {
228 	return (isdigit(c) || (c >= 'a' && c <= 'f') || (c >= 'A' && c <= 'F'));
229 }
230 
231 static __inline int isalpha(int c)
232 {
233 	return (isupper(c) || islower(c));
234 }
235 
236 static __inline int isalnum(int c)
237 {
238 	return (isalpha(c) || isdigit(c));
239 }
240 
241 static __inline int iscntrl(int c)
242 {
243 	return ((c >= 0 && c < ' ') || c == 127);
244 }
245 
246 static __inline int isgraph(int c)
247 {
248 	return (c >= '!' && c <= '~');
249 }
250 
251 static __inline int ispunct(int c)
252 {
253 	return ((c >= '!' && c <= '/') || (c >= ':' && c <= '@') ||
254 	    (c >= '[' && c <= '`') || (c >= '{' && c <= '~'));
255 }
256 
257 static __inline int toupper(int c)
258 {
259 	return (islower(c) ? c - 'a' + 'A' : c);
260 }
261 
262 static __inline int tolower(int c)
263 {
264 	return (isupper(c) ? c - 'A' + 'a' : c);
265 }
266 
267 /* sbrk emulation */
268 extern void	setheap(void *base, void *top);
269 extern char	*sbrk(int incr);
270 
271 extern void	mallocstats(void);
272 
273 extern int	printf(const char *fmt, ...) __printflike(1, 2);
274 extern void	vprintf(const char *fmt, __va_list);
275 extern int	asprintf(char **buf, const char *cfmt, ...) __printflike(2, 3);
276 extern int	sprintf(char *buf, const char *cfmt, ...) __printflike(2, 3);
277 extern int	snprintf(char *buf, size_t size, const char *cfmt, ...) \
278 		__printflike(3, 4);
279 extern void	vsprintf(char *buf, const char *cfmt, __va_list);
280 extern void	vsnprintf(char *buf, size_t size, const char *cfmt, __va_list);
281 
282 extern void	twiddle(uint_t callerdiv);
283 extern void	twiddle_divisor(uint_t globaldiv);
284 
285 extern void	ngets(char *, int);
286 #define	gets(x)	ngets((x), 0)
287 extern int	fgetstr(char *buf, int size, int fd);
288 
289 extern int	open(const char *, int);
290 #define	O_RDONLY	0x0
291 #define	O_WRONLY	0x1
292 #define	O_RDWR		0x2
293 extern int	close(int);
294 extern void	closeall(void);
295 extern ssize_t	read(int, void *, size_t);
296 extern ssize_t	write(int, const void *, size_t);
297 extern struct	dirent *readdirfd(int);
298 
299 extern void	srandom(ulong_t seed);
300 extern ulong_t	random(void);
301 
302 /* imports from stdlib, locally modified */
303 extern long	strtol(const char *, char **, int);
304 extern unsigned long	strtoul(const char *, char **, int);
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 /* BCD conversions (undocumented) */
359 extern uchar_t const	bcd2bin_data[];
360 extern uchar_t const	bin2bcd_data[];
361 extern char const	hex2ascii_data[];
362 
363 #define	bcd2bin(bcd)	(bcd2bin_data[bcd])
364 #define	bin2bcd(bin)	(bin2bcd_data[bin])
365 #define	hex2ascii(hex)	(hex2ascii_data[hex])
366 
367 /* min/max (undocumented) */
368 static __inline int imax(int a, int b) { return (a > b ? a : b); }
369 static __inline int imin(int a, int b) { return (a < b ? a : b); }
370 static __inline long lmax(long a, long b) { return (a > b ? a : b); }
371 static __inline long lmin(long a, long b) { return (a < b ? a : b); }
372 static __inline uint_t max(uint_t a, uint_t b) { return (a > b ? a : b); }
373 static __inline uint_t min(uint_t a, uint_t b) { return (a < b ? a : b); }
374 static __inline quad_t qmax(quad_t a, quad_t b) { return (a > b ? a : b); }
375 static __inline quad_t qmin(quad_t a, quad_t b) { return (a < b ? a : b); }
376 static __inline ulong_t ulmax(ulong_t a, ulong_t b) { return (a > b ? a : b); }
377 static __inline ulong_t ulmin(ulong_t a, ulong_t b) { return (a < b ? a : b); }
378 
379 /* null functions for device/filesystem switches (undocumented) */
380 extern int	nodev(void);
381 extern int	noioctl(struct open_file *, ulong_t, void *);
382 extern void	nullsys(void);
383 
384 extern int	null_open(const char *, struct open_file *);
385 extern int	null_close(struct open_file *);
386 extern int	null_read(struct open_file *, void *, size_t, size_t *);
387 extern int	null_write(struct open_file *, const void *, size_t, size_t *);
388 extern off_t	null_seek(struct open_file *, off_t, int);
389 extern int	null_stat(struct open_file *, struct stat *);
390 extern int	null_readdir(struct open_file *, struct dirent *);
391 
392 
393 /*
394  * Machine dependent functions and data, must be provided or stubbed by
395  * the consumer
396  */
397 extern void	exit(int) __dead2;
398 extern int	getchar(void);
399 extern int	ischar(void);
400 extern void	putchar(int);
401 extern int	devopen(struct open_file *, const char *, const char **);
402 extern int	devclose(struct open_file *f);
403 extern void	panic(const char *, ...) __dead2 __printflike(1, 2);
404 extern void	panic_action(void) __weak_symbol __dead2;
405 extern time_t	getsecs(void);
406 extern struct fs_ops	*file_system[];
407 extern struct fs_ops	*exclusive_file_system;
408 extern struct devsw	*devsw[];
409 
410 /*
411  * Expose byteorder(3) functions.
412  */
413 #ifndef _BYTEORDER_PROTOTYPED
414 #define	_BYTEORDER_PROTOTYPED
415 extern uint32_t		htonl(uint32_t);
416 extern uint16_t		htons(uint16_t);
417 extern uint32_t		ntohl(uint32_t);
418 extern uint16_t		ntohs(uint16_t);
419 #endif
420 
421 #ifndef _BYTEORDER_FUNC_DEFINED
422 #define	_BYTEORDER_FUNC_DEFINED
423 #define	htonl(x)	__htonl(x)
424 #define	htons(x)	__htons(x)
425 #define	ntohl(x)	__ntohl(x)
426 #define	ntohs(x)	__ntohs(x)
427 #endif
428 
429 void *Malloc(size_t, const char *, int);
430 void *Memalign(size_t, size_t, const char *, int);
431 void *Calloc(size_t, size_t, const char *, int);
432 void *Realloc(void *, size_t, const char *, int);
433 void *Reallocf(void *, size_t, const char *, int);
434 void Free(void *, const char *, int);
435 
436 #if DEBUG_MALLOC
437 #define	malloc(x)	Malloc(x, __FILE__, __LINE__)
438 #define	memalign(x, y)	Memalign(x, y, __FILE__, __LINE__)
439 #define	calloc(x, y)	Calloc(x, y, __FILE__, __LINE__)
440 #define	free(x)		Free(x, __FILE__, __LINE__)
441 #define	realloc(x, y)	Realloc(x, y, __FILE__, __LINE__)
442 #define	reallocf(x, y)	Reallocf(x, y, __FILE__, __LINE__)
443 #else
444 #define	malloc(x)	Malloc(x, NULL, 0)
445 #define	memalign(x, y)	Memalign(x, y, NULL, 0)
446 #define	calloc(x, y)	Calloc(x, y, NULL, 0)
447 #define	free(x)		Free(x, NULL, 0)
448 #define	realloc(x, y)	Realloc(x, y, NULL, 0)
449 #define	reallocf(x, y)	Reallocf(x, y, NULL, 0)
450 #endif
451 
452 #endif	/* STAND_H */
453