xref: /freebsd/stand/libsa/stand.h (revision 3332f1b444d4a73238e9f59cca27bfc95fe936bd)
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  * 3. 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 #define strcoll(a, b)	strcmp((a), (b))
73 
74 #define CHK(fmt, args...)	printf("%s(%d): " fmt "\n", __func__, __LINE__ , ##args)
75 #define PCHK(fmt, args...)	{printf("%s(%d): " fmt "\n", __func__, __LINE__ , ##args); getchar();}
76 
77 #include <sys/errno.h>
78 
79 /* special stand error codes */
80 #define	EADAPT	(ELAST+1)	/* bad adaptor */
81 #define	ECTLR	(ELAST+2)	/* bad controller */
82 #define	EUNIT	(ELAST+3)	/* bad unit */
83 #define ESLICE	(ELAST+4)	/* bad slice */
84 #define	EPART	(ELAST+5)	/* bad partition */
85 #define	ERDLAB	(ELAST+6)	/* can't read disk label */
86 #define	EUNLAB	(ELAST+7)	/* unlabeled disk */
87 #define	EOFFSET	(ELAST+8)	/* relative seek not supported */
88 #define	ESALAST	(ELAST+8)	/* */
89 
90 /* Partial signal emulation for sig_atomic_t */
91 #include <machine/signal.h>
92 
93 struct open_file;
94 
95 /*
96  * This structure is used to define file system operations in a file system
97  * independent way.
98  *
99  * XXX note that filesystem providers should export a pointer to their fs_ops
100  *     struct, so that consumers can reference this and thus include the
101  *     filesystems that they require.
102  */
103 struct fs_ops {
104     const char	*fs_name;
105     int		(*fo_open)(const char *path, struct open_file *f);
106     int		(*fo_close)(struct open_file *f);
107     int		(*fo_read)(struct open_file *f, void *buf,
108 			   size_t size, size_t *resid);
109     int		(*fo_write)(struct open_file *f, const void *buf,
110 			    size_t size, size_t *resid);
111     off_t	(*fo_seek)(struct open_file *f, off_t offset, int where);
112     int		(*fo_stat)(struct open_file *f, struct stat *sb);
113     int		(*fo_readdir)(struct open_file *f, struct dirent *d);
114     int		(*fo_mount)(const char *, const char *, void **);
115     int		(*fo_unmount)(const char *, void *);
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 extern struct fs_ops efihttp_fsops;
132 
133 /* where values for lseek(2) */
134 #define	SEEK_SET	0	/* set file offset to offset */
135 #define	SEEK_CUR	1	/* set file offset to current plus offset */
136 #define	SEEK_END	2	/* set file offset to EOF plus offset */
137 
138 /*
139  * Device switch
140  */
141 struct devsw {
142     const char	dv_name[8];
143     int		dv_type;		/* opaque type constant, arch-dependant */
144 #define DEVT_NONE	0
145 #define DEVT_DISK	1
146 #define DEVT_NET	2
147 #define DEVT_CD		3
148 #define DEVT_ZFS	4
149 #define DEVT_FD		5
150     int		(*dv_init)(void);	/* early probe call */
151     int		(*dv_strategy)(void *devdata, int rw, daddr_t blk,
152 			size_t size, char *buf, size_t *rsize);
153     int		(*dv_open)(struct open_file *f, ...);
154     int		(*dv_close)(struct open_file *f);
155     int		(*dv_ioctl)(struct open_file *f, u_long cmd, void *data);
156     int		(*dv_print)(int verbose);	/* print device information */
157     void	(*dv_cleanup)(void);
158 };
159 
160 /*
161  * libstand-supplied device switch
162  */
163 extern struct devsw netdev;
164 
165 extern int errno;
166 
167 /*
168  * Generic device specifier; architecture-dependent
169  * versions may be larger, but should be allowed to
170  * overlap.
171  */
172 struct devdesc {
173     struct devsw	*d_dev;
174     int			d_unit;
175     void		*d_opendata;
176 };
177 
178 struct open_file {
179     int			f_flags;	/* see F_* below */
180     struct devsw	*f_dev;		/* pointer to device operations */
181     void		*f_devdata;	/* device specific data */
182     struct fs_ops	*f_ops;		/* pointer to file system operations */
183     void		*f_fsdata;	/* file system specific data */
184     off_t		f_offset;	/* current file offset */
185     char		*f_rabuf;	/* readahead buffer pointer */
186     size_t		f_ralen;	/* valid data in readahead buffer */
187     off_t		f_raoffset;	/* consumer offset in readahead buffer */
188     int			f_id;		/* file number */
189     TAILQ_ENTRY(open_file) f_link;	/* next entry */
190 #define SOPEN_RASIZE	512
191 };
192 
193 typedef TAILQ_HEAD(file_list, open_file) file_list_t;
194 extern file_list_t files;
195 extern struct open_file *fd2open_file(int);
196 
197 /* f_flags values */
198 #define	F_READ		0x0001	/* file opened for reading */
199 #define	F_WRITE		0x0002	/* file opened for writing */
200 #define	F_RAW		0x0004	/* raw device open - no file system */
201 #define F_NODEV		0x0008	/* network open - no device */
202 #define	F_MASK		0xFFFF
203 /* Mode modifier for strategy() */
204 #define	F_NORA		(0x01 << 16)	/* Disable Read-Ahead */
205 
206 #define isascii(c)	(((c) & ~0x7F) == 0)
207 
208 static __inline int isupper(int c)
209 {
210     return c >= 'A' && c <= 'Z';
211 }
212 
213 static __inline int islower(int c)
214 {
215     return c >= 'a' && c <= 'z';
216 }
217 
218 static __inline int isspace(int c)
219 {
220     return c == ' ' || (c >= 0x9 && c <= 0xd);
221 }
222 
223 static __inline int isdigit(int c)
224 {
225     return c >= '0' && c <= '9';
226 }
227 
228 static __inline int isxdigit(int c)
229 {
230     return isdigit(c) || (c >= 'a' && c <= 'f') || (c >= 'A' && c <= 'F');
231 }
232 
233 static __inline int isalpha(int c)
234 {
235     return isupper(c) || islower(c);
236 }
237 
238 static __inline int isalnum(int c)
239 {
240     return isalpha(c) || isdigit(c);
241 }
242 
243 static __inline int iscntrl(int c)
244 {
245 	return (c >= 0 && c < ' ') || c == 127;
246 }
247 
248 static __inline int isgraph(int c)
249 {
250 	return c >= '!' && c <= '~';
251 }
252 
253 static __inline int ispunct(int c)
254 {
255 	return (c >= '!' && c <= '/') || (c >= ':' && c <= '@') ||
256 	    (c >= '[' && c <= '`') || (c >= '{' && c <= '~');
257 }
258 
259 static __inline int toupper(int c)
260 {
261     return islower(c) ? c - 'a' + 'A' : c;
262 }
263 
264 static __inline int tolower(int c)
265 {
266     return isupper(c) ? c - 'A' + 'a' : c;
267 }
268 
269 /* sbrk emulation */
270 extern void	setheap(void *base, void *top);
271 extern char	*sbrk(int incr);
272 
273 extern int	printf(const char *fmt, ...) __printflike(1, 2);
274 extern int	asprintf(char **buf, const char *cfmt, ...) __printflike(2, 3);
275 extern int	sprintf(char *buf, const char *cfmt, ...) __printflike(2, 3);
276 extern int	snprintf(char *buf, size_t size, const char *cfmt, ...) __printflike(3, 4);
277 extern int	vprintf(const char *fmt, __va_list);
278 extern int	vsprintf(char *buf, const char *cfmt, __va_list);
279 extern int	vsnprintf(char *buf, size_t size, const char *cfmt, __va_list);
280 
281 extern void	twiddle(u_int callerdiv);
282 extern void	twiddle_divisor(u_int globaldiv);
283 
284 extern void	ngets(char *, int);
285 #define gets(x)	ngets((x), 0)
286 extern int	fgetstr(char *buf, int size, int fd);
287 
288 extern int	mount(const char *dev, const char *path, int flags, void *data);
289 extern int	unmount(const char *dev, int flags);
290 extern int	open(const char *, int);
291 #define	O_RDONLY	0x0
292 #define O_WRONLY	0x1
293 #define O_RDWR		0x2
294 #define O_ACCMODE	0x3
295 /* NOT IMPLEMENTED */
296 #define	O_CREAT		0x0200		/* create if nonexistent */
297 #define	O_TRUNC		0x0400		/* truncate to zero length */
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(unsigned int);
305 extern long	random(void);
306 
307 /* imports from stdlib, locally modified */
308 extern char	*optarg;			/* getopt(3) external variables */
309 extern int	optind, opterr, optopt, optreset;
310 extern int	getopt(int, char * const [], const char *);
311 
312 /* pager.c */
313 extern void	pager_open(void);
314 extern void	pager_close(void);
315 extern int	pager_output(const char *lines);
316 extern int	pager_file(const char *fname);
317 
318 /* No signal state to preserve */
319 #define setjmp	_setjmp
320 #define longjmp	_longjmp
321 
322 /* environment.c */
323 #define EV_DYNAMIC	(1<<0)		/* value was dynamically allocated, free if changed/unset */
324 #define EV_VOLATILE	(1<<1)		/* value is volatile, make a copy of it */
325 #define EV_NOHOOK	(1<<2)		/* don't call hook when setting */
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(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 int		abs(int a);
360 extern void		abort(void) __dead2;
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, int);
365 
366 /* BCD conversions (undocumented) */
367 extern u_char const	bcd2bin_data[];
368 extern u_char const	bin2bcd_data[];
369 extern char const	hex2ascii_data[];
370 
371 #define	bcd2bin(bcd)	(bcd2bin_data[bcd])
372 #define	bin2bcd(bin)	(bin2bcd_data[bin])
373 #define	hex2ascii(hex)	(hex2ascii_data[hex])
374 #define	validbcd(bcd)	(bcd == 0 || (bcd > 0 && bcd <= 0x99 && bcd2bin_data[bcd] != 0))
375 
376 /* min/max (undocumented) */
377 static __inline int imax(int a, int b) { return (a > b ? a : b); }
378 static __inline int imin(int a, int b) { return (a < b ? a : b); }
379 static __inline long lmax(long a, long b) { return (a > b ? a : b); }
380 static __inline long lmin(long a, long b) { return (a < b ? a : b); }
381 static __inline u_int max(u_int a, u_int b) { return (a > b ? a : b); }
382 static __inline u_int min(u_int a, u_int b) { return (a < b ? a : b); }
383 static __inline quad_t qmax(quad_t a, quad_t b) { return (a > b ? a : b); }
384 static __inline quad_t qmin(quad_t a, quad_t b) { return (a < b ? a : b); }
385 static __inline u_long ulmax(u_long a, u_long b) { return (a > b ? a : b); }
386 static __inline u_long ulmin(u_long a, u_long 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 *, u_long, void *);
391 extern void	nullsys(void);
392 
393 extern int	null_open(const char *path, struct open_file *f);
394 extern int	null_close(struct open_file *f);
395 extern int	null_read(struct open_file *f, void *buf, size_t size, size_t *resid);
396 extern int	null_write(struct open_file *f, const void *buf, size_t size, size_t *resid);
397 extern off_t	null_seek(struct open_file *f, off_t offset, int where);
398 extern int	null_stat(struct open_file *f, struct stat *sb);
399 extern int	null_readdir(struct open_file *f, struct dirent *d);
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  * Time routines
421  */
422 time_t time(time_t *);
423 
424 /*
425  * Expose byteorder(3) functions.
426  */
427 #ifndef _BYTEORDER_PROTOTYPED
428 #define	_BYTEORDER_PROTOTYPED
429 extern uint32_t		htonl(uint32_t);
430 extern uint16_t		htons(uint16_t);
431 extern uint32_t		ntohl(uint32_t);
432 extern uint16_t		ntohs(uint16_t);
433 #endif
434 
435 #ifndef _BYTEORDER_FUNC_DEFINED
436 #define	_BYTEORDER_FUNC_DEFINED
437 #define	htonl(x)	__htonl(x)
438 #define	htons(x)	__htons(x)
439 #define	ntohl(x)	__ntohl(x)
440 #define	ntohs(x)	__ntohs(x)
441 #endif
442 
443 void *Malloc(size_t, const char *, int);
444 void *Memalign(size_t, size_t, const char *, int);
445 void *Calloc(size_t, size_t, const char *, int);
446 void *Realloc(void *, size_t, const char *, int);
447 void *Reallocf(void *, size_t, const char *, int);
448 void Free(void *, const char *, int);
449 extern void	mallocstats(void);
450 
451 const char *x86_hypervisor(void);
452 
453 #ifdef USER_MALLOC
454 extern void *malloc(size_t);
455 extern void *memalign(size_t, size_t);
456 extern void *calloc(size_t, size_t);
457 extern void free(void *);
458 extern void *realloc(void *, size_t);
459 extern void *reallocf(void *, size_t);
460 #elif defined(DEBUG_MALLOC)
461 #define malloc(x)	Malloc(x, __FILE__, __LINE__)
462 #define memalign(x, y)	Memalign(x, y, __FILE__, __LINE__)
463 #define calloc(x, y)	Calloc(x, y, __FILE__, __LINE__)
464 #define free(x)		Free(x, __FILE__, __LINE__)
465 #define realloc(x, y)	Realloc(x, y, __FILE__, __LINE__)
466 #define reallocf(x, y)	Reallocf(x, y, __FILE__, __LINE__)
467 #else
468 #define malloc(x)	Malloc(x, NULL, 0)
469 #define memalign(x, y)	Memalign(x, y, NULL, 0)
470 #define calloc(x, y)	Calloc(x, y, NULL, 0)
471 #define free(x)		Free(x, NULL, 0)
472 #define realloc(x, y)	Realloc(x, y, NULL, 0)
473 #define reallocf(x, y)	Reallocf(x, y, NULL, 0)
474 #endif
475 
476 /*
477  * va <-> pa routines. MD code must supply.
478  */
479 caddr_t ptov(uintptr_t);
480 
481 /* hexdump.c */
482 void	hexdump(caddr_t region, size_t len);
483 
484 /* tslog.c */
485 #define TSRAW(a, b, c) tslog(a, b, c)
486 #define TSENTER() TSRAW("ENTER", __func__, NULL)
487 #define TSEXIT() TSRAW("EXIT", __func__, NULL)
488 #define TSLINE() TSRAW("EVENT", __FILE__, __XSTRING(__LINE__))
489 void tslog(const char *, const char *, const char *);
490 void tslog_setbuf(void * buf, size_t len);
491 void tslog_getbuf(void ** buf, size_t * len);
492 
493 #endif	/* STAND_H */
494