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
94struct 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 */
104struct 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 */
120extern struct fs_ops ufs_fsops;
121extern struct fs_ops tftp_fsops;
122extern struct fs_ops nfs_fsops;
123extern struct fs_ops cd9660_fsops;
124extern struct fs_ops nandfs_fsops;
125extern struct fs_ops gzipfs_fsops;
126extern struct fs_ops bzipfs_fsops;
127extern struct fs_ops dosfs_fsops;
128extern struct fs_ops ext2fs_fsops;
129extern struct fs_ops splitfs_fsops;
130extern 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 */
140struct 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 */
162extern struct devsw netdev;
163
164extern int errno;
165
166/*
167 * Generic device specifier; architecture-dependent
168 * versions may be larger, but should be allowed to
169 * overlap.
170 */
171struct devdesc {
172	struct devsw	*d_dev;
173	int		d_unit;
174	void		*d_opendata;
175};
176
177struct 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
191extern 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
206static __inline int isupper(int c)
207{
208	return (c >= 'A' && c <= 'Z');
209}
210
211static __inline int islower(int c)
212{
213	return (c >= 'a' && c <= 'z');
214}
215
216static __inline int isspace(int c)
217{
218	return (c == ' ' || (c >= 0x9 && c <= 0xd));
219}
220
221static __inline int isdigit(int c)
222{
223	return (c >= '0' && c <= '9');
224}
225
226static __inline int isxdigit(int c)
227{
228	return (isdigit(c) || (c >= 'a' && c <= 'f') || (c >= 'A' && c <= 'F'));
229}
230
231static __inline int isalpha(int c)
232{
233	return (isupper(c) || islower(c));
234}
235
236static __inline int isalnum(int c)
237{
238	return (isalpha(c) || isdigit(c));
239}
240
241static __inline int toupper(int c)
242{
243	return (islower(c) ? c - 'a' + 'A' : c);
244}
245
246static __inline int tolower(int c)
247{
248	return (isupper(c) ? c - 'A' + 'a' : c);
249}
250
251/* sbrk emulation */
252extern void	setheap(void *base, void *top);
253extern char	*sbrk(int incr);
254
255extern void	mallocstats(void);
256
257extern int	printf(const char *fmt, ...) __printflike(1, 2);
258extern void	vprintf(const char *fmt, __va_list);
259extern int	asprintf(char **buf, const char *cfmt, ...) __printflike(2, 3);
260extern int	sprintf(char *buf, const char *cfmt, ...) __printflike(2, 3);
261extern int	snprintf(char *buf, size_t size, const char *cfmt, ...) \
262		__printflike(3, 4);
263extern void	vsprintf(char *buf, const char *cfmt, __va_list);
264extern void	vsnprintf(char *buf, size_t size, const char *cfmt, __va_list);
265
266extern void	twiddle(uint_t callerdiv);
267extern void	twiddle_divisor(uint_t globaldiv);
268
269extern void	ngets(char *, int);
270#define	gets(x)	ngets((x), 0)
271extern int	fgetstr(char *buf, int size, int fd);
272
273extern int	open(const char *, int);
274#define	O_RDONLY	0x0
275#define	O_WRONLY	0x1
276#define	O_RDWR		0x2
277extern int	close(int);
278extern void	closeall(void);
279extern ssize_t	read(int, void *, size_t);
280extern ssize_t	write(int, const void *, size_t);
281extern struct	dirent *readdirfd(int);
282
283extern void	srandom(ulong_t seed);
284extern ulong_t	random(void);
285
286/* imports from stdlib, locally modified */
287extern long	strtol(const char *, char **, int);
288extern unsigned long	strtoul(const char *, char **, int);
289extern char	*optarg;		/* getopt(3) external variables */
290extern int	optind, opterr, optopt, optreset;
291extern int	getopt(int, char * const [], const char *);
292
293/* pager.c */
294extern void	pager_open(void);
295extern void	pager_close(void);
296extern int	pager_output(const char *lines);
297extern int	pager_file(const char *fname);
298
299/* No signal state to preserve */
300#define	setjmp	_setjmp
301#define	longjmp	_longjmp
302
303/* environment.c */
304/* value was dynamically allocated, free if changed/unset */
305#define	EV_DYNAMIC	(1<<0)
306/* value is volatile, make a copy of it */
307#define	EV_VOLATILE	(1<<1)
308/* don't call hook when setting */
309#define	EV_NOHOOK	(1<<2)
310
311struct env_var;
312typedef char	*(ev_format_t)(struct env_var *ev);
313typedef int	(ev_sethook_t)(struct env_var *ev, int flags,
314		    const void *value);
315typedef int	(ev_unsethook_t)(struct env_var *ev);
316
317struct 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};
326extern struct env_var	*environ;
327
328extern struct env_var	*env_getenv(const char *name);
329extern int		env_setenv(const char *name, int flags,
330				const void *value, ev_sethook_t sethook,
331				ev_unsethook_t unsethook);
332extern char		*getenv(const char *name);
333extern int		setenv(const char *name, const char *value,
334				int overwrite);
335extern int		putenv(const char *string);
336extern int		unsetenv(const char *name);
337
338extern ev_sethook_t	env_noset;		/* refuse set operation */
339extern ev_unsethook_t	env_nounset;		/* refuse unset operation */
340
341/* BCD conversions (undocumented) */
342extern uchar_t const	bcd2bin_data[];
343extern uchar_t const	bin2bcd_data[];
344extern 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) */
351static __inline int imax(int a, int b) { return (a > b ? a : b); }
352static __inline int imin(int a, int b) { return (a < b ? a : b); }
353static __inline long lmax(long a, long b) { return (a > b ? a : b); }
354static __inline long lmin(long a, long b) { return (a < b ? a : b); }
355static __inline uint_t max(uint_t a, uint_t b) { return (a > b ? a : b); }
356static __inline uint_t min(uint_t a, uint_t b) { return (a < b ? a : b); }
357static __inline quad_t qmax(quad_t a, quad_t b) { return (a > b ? a : b); }
358static __inline quad_t qmin(quad_t a, quad_t b) { return (a < b ? a : b); }
359static __inline ulong_t ulmax(ulong_t a, ulong_t b) { return (a > b ? a : b); }
360static __inline ulong_t ulmin(ulong_t a, ulong_t b) { return (a < b ? a : b); }
361
362/* null functions for device/filesystem switches (undocumented) */
363extern int	nodev(void);
364extern int	noioctl(struct open_file *, ulong_t, void *);
365extern void	nullsys(void);
366
367extern int	null_open(const char *, struct open_file *);
368extern int	null_close(struct open_file *);
369extern int	null_read(struct open_file *, void *, size_t, size_t *);
370extern int	null_write(struct open_file *, const void *, size_t, size_t *);
371extern off_t	null_seek(struct open_file *, off_t, int);
372extern int	null_stat(struct open_file *, struct stat *);
373extern int	null_readdir(struct open_file *, struct dirent *);
374
375
376/*
377 * Machine dependent functions and data, must be provided or stubbed by
378 * the consumer
379 */
380extern void	exit(int) __dead2;
381extern int	getchar(void);
382extern int	ischar(void);
383extern void	putchar(int);
384extern int	devopen(struct open_file *, const char *, const char **);
385extern int	devclose(struct open_file *f);
386extern void	panic(const char *, ...) __dead2 __printflike(1, 2);
387extern void	panic_action(void) __weak_symbol __dead2;
388extern time_t	getsecs(void);
389extern struct fs_ops	*file_system[];
390extern struct fs_ops	*exclusive_file_system;
391extern struct devsw	*devsw[];
392
393/*
394 * Expose byteorder(3) functions.
395 */
396#ifndef _BYTEORDER_PROTOTYPED
397#define	_BYTEORDER_PROTOTYPED
398extern uint32_t		htonl(uint32_t);
399extern uint16_t		htons(uint16_t);
400extern uint32_t		ntohl(uint32_t);
401extern uint16_t		ntohs(uint16_t);
402#endif
403
404#ifndef _BYTEORDER_FUNC_DEFINED
405#define	_BYTEORDER_FUNC_DEFINED
406#define	htonl(x)	__htonl(x)
407#define	htons(x)	__htons(x)
408#define	ntohl(x)	__ntohl(x)
409#define	ntohs(x)	__ntohs(x)
410#endif
411
412void *Malloc(size_t, const char *, int);
413void *Memalign(size_t, size_t, const char *, int);
414void *Calloc(size_t, size_t, const char *, int);
415void *Realloc(void *, size_t, const char *, int);
416void *Reallocf(void *, size_t, const char *, int);
417void Free(void *, const char *, int);
418
419#if DEBUG_MALLOC
420#define	malloc(x)	Malloc(x, __FILE__, __LINE__)
421#define	memalign(x, y)	Memalign(x, y, __FILE__, __LINE__)
422#define	calloc(x, y)	Calloc(x, y, __FILE__, __LINE__)
423#define	free(x)		Free(x, __FILE__, __LINE__)
424#define	realloc(x, y)	Realloc(x, y, __FILE__, __LINE__)
425#define	reallocf(x, y)	Reallocf(x, y, __FILE__, __LINE__)
426#else
427#define	malloc(x)	Malloc(x, NULL, 0)
428#define	memalign(x, y)	Memalign(x, y, NULL, 0)
429#define	calloc(x, y)	Calloc(x, y, NULL, 0)
430#define	free(x)		Free(x, NULL, 0)
431#define	realloc(x, y)	Realloc(x, y, NULL, 0)
432#define	reallocf(x, y)	Reallocf(x, y, NULL, 0)
433#endif
434
435#endif	/* STAND_H */
436