xref: /netbsd-src/sys/lib/libsa/stand.h (revision d710132b4b8ce7f7cccaaf660cb16aa16b4077a0)
1 /*	$NetBSD: stand.h,v 1.48 2003/04/15 22:26:42 dsl Exp $	*/
2 
3 /*
4  * Copyright (c) 1999 Christopher G. Demetriou.  All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 3. All advertising materials mentioning features or use of this software
15  *    must display the following acknowledgement:
16  *      This product includes software developed by Christopher G. Demetriou
17  *	for the NetBSD Project.
18  * 4. The name of the author may not be used to endorse or promote products
19  *    derived from this software without specific prior written permission
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 /*-
34  * Copyright (c) 1993
35  *	The Regents of the University of California.  All rights reserved.
36  *
37  * Redistribution and use in source and binary forms, with or without
38  * modification, are permitted provided that the following conditions
39  * are met:
40  * 1. Redistributions of source code must retain the above copyright
41  *    notice, this list of conditions and the following disclaimer.
42  * 2. Redistributions in binary form must reproduce the above copyright
43  *    notice, this list of conditions and the following disclaimer in the
44  *    documentation and/or other materials provided with the distribution.
45  * 3. All advertising materials mentioning features or use of this software
46  *    must display the following acknowledgement:
47  *	This product includes software developed by the University of
48  *	California, Berkeley and its contributors.
49  * 4. Neither the name of the University nor the names of its contributors
50  *    may be used to endorse or promote products derived from this software
51  *    without specific prior written permission.
52  *
53  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
54  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
55  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
56  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
57  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
58  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
59  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
60  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
61  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
62  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
63  * SUCH DAMAGE.
64  *
65  *	@(#)stand.h	8.1 (Berkeley) 6/11/93
66  */
67 
68 #include <sys/types.h>
69 #include <sys/cdefs.h>
70 #include <sys/stat.h>
71 #include "saioctl.h"
72 #include "saerrno.h"
73 
74 #ifndef NULL
75 #define	NULL	0
76 #endif
77 
78 #ifdef LIBSA_RENAME_PRINTF
79 #define getchar		libsa_getchar
80 #define gets		libsa_gets
81 #define printf		libsa_printf
82 #define putchar		libsa_putchar
83 #define sprintf		libsa_sprintf
84 #define vprintf		libsa_vprintf
85 #define vsprintf	libsa_vsprintf
86 #endif
87 #ifdef LIBSA_USE_MEMSET
88 #define	bzero(s, l)	memset(s, 0, l)
89 #endif
90 #ifdef LIBSA_USE_MEMCPY
91 #define	bcopy(s, d, l)	memcpy(d, s, l)	/* For non-overlapping copies only */
92 #endif
93 
94 struct open_file;
95 
96 #define FS_DEF(fs) \
97 	extern int	__CONCAT(fs,_open)(char *, struct open_file *); \
98 	extern int	__CONCAT(fs,_close)(struct open_file *); \
99 	extern int	__CONCAT(fs,_read)(struct open_file *, void *, \
100 						size_t, size_t *); \
101 	extern int	__CONCAT(fs,_write)(struct open_file *, void *, \
102 						size_t, size_t *); \
103 	extern off_t	__CONCAT(fs,_seek)(struct open_file *, off_t, int); \
104 	extern int	__CONCAT(fs,_stat)(struct open_file *, struct stat *)
105 
106 /*
107  * This structure is used to define file system operations in a file system
108  * independent way.
109  */
110 #if !defined(LIBSA_SINGLE_FILESYSTEM)
111 struct fs_ops {
112 	int	(*open)(char *, struct open_file *);
113 	int	(*close)(struct open_file *);
114 	int	(*read)(struct open_file *, void *, size_t, size_t *);
115 	int	(*write)(struct open_file *, void *, size_t size, size_t *);
116 	off_t	(*seek)(struct open_file *, off_t, int);
117 	int	(*stat)(struct open_file *, struct stat *);
118 };
119 
120 extern struct fs_ops file_system[];
121 extern int nfsys;
122 
123 #define FS_OPS(fs) { \
124 	__CONCAT(fs,_open), \
125 	__CONCAT(fs,_close), \
126 	__CONCAT(fs,_read), \
127 	__CONCAT(fs,_write), \
128 	__CONCAT(fs,_seek), \
129 	__CONCAT(fs,_stat) }
130 
131 #define	FS_OPEN(fs)		((fs)->open)
132 #define	FS_CLOSE(fs)		((fs)->close)
133 #define	FS_READ(fs)		((fs)->read)
134 #define	FS_WRITE(fs)		((fs)->write)
135 #define	FS_SEEK(fs)		((fs)->seek)
136 #define	FS_STAT(fs)		((fs)->stat)
137 
138 #else
139 
140 #define	FS_OPEN(fs)		___CONCAT(LIBSA_SINGLE_FILESYSTEM,_open)
141 #define	FS_CLOSE(fs)		___CONCAT(LIBSA_SINGLE_FILESYSTEM,_close)
142 #define	FS_READ(fs)		___CONCAT(LIBSA_SINGLE_FILESYSTEM,_read)
143 #define	FS_WRITE(fs)		___CONCAT(LIBSA_SINGLE_FILESYSTEM,_write)
144 #define	FS_SEEK(fs)		___CONCAT(LIBSA_SINGLE_FILESYSTEM,_seek)
145 #define	FS_STAT(fs)		___CONCAT(LIBSA_SINGLE_FILESYSTEM,_stat)
146 
147 FS_DEF(LIBSA_SINGLE_FILESYSTEM);
148 
149 #endif
150 
151 /* where values for lseek(2) */
152 #define	SEEK_SET	0	/* set file offset to offset */
153 #define	SEEK_CUR	1	/* set file offset to current plus offset */
154 #define	SEEK_END	2	/* set file offset to EOF plus offset */
155 
156 /* Device switch */
157 #if !defined(LIBSA_SINGLE_DEVICE)
158 
159 struct devsw {
160 	char	*dv_name;
161 	int	(*dv_strategy)(void *, int, daddr_t, size_t, void *, size_t *);
162 	int	(*dv_open)(struct open_file *, ...);
163 	int	(*dv_close)(struct open_file *);
164 	int	(*dv_ioctl)(struct open_file *, u_long, void *);
165 };
166 
167 extern struct devsw devsw[];	/* device array */
168 extern int ndevs;		/* number of elements in devsw[] */
169 
170 #define	DEV_NAME(d)		((d)->dv_name)
171 #define	DEV_STRATEGY(d)		((d)->dv_strategy)
172 #define	DEV_OPEN(d)		((d)->dv_open)
173 #define	DEV_CLOSE(d)		((d)->dv_close)
174 #define	DEV_IOCTL(d)		((d)->dv_ioctl)
175 
176 #else
177 
178 #define	DEV_NAME(d)		___STRING(LIBSA_SINGLE_DEVICE)
179 #define	DEV_STRATEGY(d)		___CONCAT(LIBSA_SINGLE_DEVICE,strategy)
180 #define	DEV_OPEN(d)		___CONCAT(LIBSA_SINGLE_DEVICE,open)
181 #define	DEV_CLOSE(d)		___CONCAT(LIBSA_SINGLE_DEVICE,close)
182 #define	DEV_IOCTL(d)		___CONCAT(LIBSA_SINGLE_DEVICE,ioctl)
183 
184 /* These may be #defines which must not be expanded here, hence the extra () */
185 int	(DEV_STRATEGY(unused))(void *, int, daddr_t, size_t, void *, size_t *);
186 int	(DEV_OPEN(unused))(struct open_file *, ...);
187 int	(DEV_CLOSE(unused))(struct open_file *);
188 int	(DEV_IOCTL(unused))(struct open_file *, u_long, void *);
189 
190 #endif
191 
192 struct open_file {
193 	int		f_flags;	/* see F_* below */
194 #if !defined(LIBSA_SINGLE_DEVICE)
195 	const struct devsw	*f_dev;	/* pointer to device operations */
196 #endif
197 	void		*f_devdata;	/* device specific data */
198 #if !defined(LIBSA_SINGLE_FILESYSTEM)
199 	const struct fs_ops	*f_ops;	/* pointer to file system operations */
200 #endif
201 	void		*f_fsdata;	/* file system specific data */
202 #if !defined(LIBSA_NO_RAW_ACCESS)
203 	off_t		f_offset;	/* current file offset (F_RAW) */
204 #endif
205 };
206 
207 #define	SOPEN_MAX	4
208 extern struct open_file files[];
209 
210 /* f_flags values */
211 #define	F_READ		0x0001	/* file opened for reading */
212 #define	F_WRITE		0x0002	/* file opened for writing */
213 #if !defined(LIBSA_NO_RAW_ACCESS)
214 #define	F_RAW		0x0004	/* raw device open - no file system */
215 #endif
216 #define F_NODEV		0x0008	/* network open - no device */
217 
218 int	(devopen)(struct open_file *, const char *, char **);
219 #ifdef HEAP_VARIABLE
220 void	setheap(void *, void *);
221 #endif
222 void	*alloc(unsigned int);
223 void	free(void *, unsigned int);
224 struct	disklabel;
225 char	*getdisklabel(const char *, struct disklabel *);
226 int	dkcksum(struct disklabel *);
227 
228 void	printf(const char *, ...);
229 int	sprintf(char *, const char *, ...);
230 int	snprintf(char *, size_t, const char *, ...);
231 void	vprintf(const char *, _BSD_VA_LIST_);
232 int	vsprintf(char *, const char *, _BSD_VA_LIST_);
233 int	vsnprintf(char *, size_t, const char *, _BSD_VA_LIST_);
234 void	twiddle(void);
235 void	gets(char *);
236 int	getfile(char *prompt, int mode);
237 char	*strerror(int);
238 __dead void	exit(int) __attribute__((noreturn));
239 __dead void	panic(const char *, ...) __attribute__((noreturn));
240 __dead void	_rtt(void) __attribute__((noreturn));
241 void	(bcopy)(const void *, void *, size_t);
242 void	*memcpy(void *, const void *, size_t);
243 void	*memmove(void *, const void *, size_t);
244 int	memcmp(const void *, const void *, size_t);
245 void	exec(char *, char *, int);
246 int	open(const char *, int);
247 int	close(int);
248 void	closeall(void);
249 ssize_t	read(int, void *, size_t);
250 ssize_t	write(int, void *, size_t);
251 off_t	lseek(int, off_t, int);
252 int	ioctl(int, u_long, char *);
253 int	stat(const char *, struct stat *);
254 int	fstat(int, struct stat *);
255 
256 extern int opterr, optind, optopt, optreset;
257 extern char *optarg;
258 int	getopt(int, char * const *, const char *);
259 
260 char	*getpass(const char *);
261 int	checkpasswd(void);
262 int	check_password(const char *);
263 
264 int	nodev(void);
265 int	noioctl(struct open_file *, u_long, void *);
266 void	nullsys(void);
267 
268 FS_DEF(null);
269 
270 /* Machine dependent functions */
271 void	machdep_start(char *, int, char *, char *, char *);
272 int	getchar(void);
273 void	putchar(int);
274 
275 #ifdef __INTERNAL_LIBSA_CREAD
276 int	oopen(const char *, int);
277 int	oclose(int);
278 ssize_t	oread(int, void *, size_t);
279 off_t	olseek(int, off_t, int);
280 #endif
281