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