libstand: Add strtoul().
[dragonfly.git] / lib / libstand / stand.h
CommitLineData
984263bc
MD
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: src/lib/libstand/stand.h,v 1.18.2.8 2002/06/17 11:22:39 sobomax Exp $
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.
0f0f9bbd 42 * 3. Neither the name of the University nor the names of its contributors
984263bc
MD
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
b20f5c9e
IV
61#ifndef _STAND_H_
62#define _STAND_H_
63
41e8adcb 64#include <machine/stdarg.h> /* __va_list */
984263bc
MD
65#include <sys/types.h>
66#include <sys/cdefs.h>
67#include <sys/stat.h>
68#include <sys/dirent.h>
69#include <string.h>
70
5e2195bf
JS
71#define CHK(fmt, args...) printf("%s(%d): " fmt "\n", __func__, __LINE__ , ##args)
72#define PCHK(fmt, args...) {printf("%s(%d): " fmt "\n", __func__, __LINE__ , ##args); getchar();}
984263bc 73
984263bc
MD
74/* Avoid unwanted userlandish components */
75#define _KERNEL
76#include <sys/errno.h>
77#undef _KERNEL
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
90struct open_file;
91
92/*
93 * This structure is used to define file system operations in a file system
94 * independent way.
95 *
96 * XXX note that filesystem providers should export a pointer to their fs_ops
97 * struct, so that consumers can reference this and thus include the
98 * filesystems that they require.
99 */
100struct fs_ops {
101 const char *fs_name;
ff2aef30
SW
102 int (*fo_open)(const char *, struct open_file *);
103 int (*fo_close)(struct open_file *);
104 int (*fo_read)(struct open_file *, void *,
105 size_t, size_t *);
106 int (*fo_write)(struct open_file *, void *,
107 size_t, size_t *);
108 off_t (*fo_seek)(struct open_file *, off_t, int);
109 int (*fo_stat)(struct open_file *, struct stat *);
110 int (*fo_readdir)(struct open_file *, struct dirent *);
984263bc
MD
111};
112
113/*
114 * libstand-supplied filesystems
115 */
116extern struct fs_ops ufs_fsops;
bc767f46 117extern struct fs_ops hammer_fsops;
984263bc
MD
118extern struct fs_ops tftp_fsops;
119extern struct fs_ops nfs_fsops;
120extern struct fs_ops cd9660_fsops;
6af3b87d 121extern struct fs_ops gzipfs_fsops;
984263bc
MD
122extern struct fs_ops zipfs_fsops;
123extern struct fs_ops bzipfs_fsops;
124extern struct fs_ops dosfs_fsops;
125extern struct fs_ops ext2fs_fsops;
126extern struct fs_ops splitfs_fsops;
127
128/* where values for lseek(2) */
129#define SEEK_SET 0 /* set file offset to offset */
130#define SEEK_CUR 1 /* set file offset to current plus offset */
131#define SEEK_END 2 /* set file offset to EOF plus offset */
132
133/*
134 * Device switch
135 */
136struct devsw {
137 const char dv_name[8];
138 int dv_type; /* opaque type constant, arch-dependant */
139 int (*dv_init)(void); /* early probe call */
ff2aef30
SW
140 int (*dv_strategy)(void *, int, daddr_t, size_t, char *, size_t *);
141 int (*dv_open)(struct open_file *, ...);
142 int (*dv_close)(struct open_file *);
143 int (*dv_ioctl)(struct open_file *, u_long, void *);
144 void (*dv_print)(int); /* print device information */
984263bc
MD
145 void (*dv_cleanup)(void);
146};
147
148/*
149 * libstand-supplied device switch
150 */
151extern struct devsw netdev;
152
153extern int errno;
cdfd0a3e 154extern int no_io_error;
984263bc
MD
155
156struct open_file {
157 int f_flags; /* see F_* below */
158 struct devsw *f_dev; /* pointer to device operations */
159 void *f_devdata; /* device specific data */
160 struct fs_ops *f_ops; /* pointer to file system operations */
161 void *f_fsdata; /* file system specific data */
162 off_t f_offset; /* current file offset */
163 char *f_rabuf; /* readahead buffer pointer */
164 size_t f_ralen; /* valid data in readahead buffer */
165 off_t f_raoffset; /* consumer offset in readahead buffer */
166#define SOPEN_RASIZE 512
167};
168
169#define SOPEN_MAX 8
170extern struct open_file files[];
171
172/* f_flags values */
173#define F_READ 0x0001 /* file opened for reading */
174#define F_WRITE 0x0002 /* file opened for writing */
175#define F_RAW 0x0004 /* raw device open - no file system */
63ad7bd4 176#define F_DEVDESC 0x0008 /* generic devdesc, else specific */
984263bc
MD
177
178#define isascii(c) (((c) & ~0x7F) == 0)
179
ff2aef30
SW
180static __inline int
181isupper(int c)
984263bc
MD
182{
183 return c >= 'A' && c <= 'Z';
184}
185
ff2aef30
SW
186static __inline int
187islower(int c)
984263bc
MD
188{
189 return c >= 'a' && c <= 'z';
190}
191
ff2aef30
SW
192static __inline int
193isspace(int c)
984263bc
MD
194{
195 return c == ' ' || (c >= 0x9 && c <= 0xd);
196}
197
ff2aef30
SW
198static __inline int
199isdigit(int c)
984263bc
MD
200{
201 return c >= '0' && c <= '9';
202}
203
ff2aef30
SW
204static __inline int
205isxdigit(int c)
984263bc
MD
206{
207 return isdigit(c) || (c >= 'a' && c <= 'f') || (c >= 'A' && c <= 'F');
208}
209
ff2aef30
SW
210static __inline int
211isalpha(int c)
984263bc
MD
212{
213 return isupper(c) || islower(c);
214}
215
ff2aef30
SW
216static __inline int
217isalnum(int c)
984263bc
MD
218{
219 return isalpha(c) || isdigit(c);
220}
221
ff2aef30
SW
222static __inline int
223toupper(int c)
984263bc
MD
224{
225 return islower(c) ? c - 'a' + 'A' : c;
226}
227
ff2aef30
SW
228static __inline int
229tolower(int c)
984263bc
MD
230{
231 return isupper(c) ? c - 'A' + 'a' : c;
232}
233
234/* sbrk emulation */
ff2aef30 235extern void setheap(void *, void *);
f5ad3ecb 236extern char *getheap(size_t *sizep);
db248f66 237extern char *sbrk(intptr_t);
984263bc
MD
238
239/* Matt Dillon's zalloc/zmalloc */
ff2aef30
SW
240extern void *malloc(size_t);
241extern void free(void *);
984263bc 242/*#define free(p) {CHK("free %p", p); free(p);} */ /* use for catching guard violations */
ff2aef30
SW
243extern void *calloc(size_t, size_t);
244extern void *realloc(void *, size_t);
245extern void *reallocf(void *, size_t);
984263bc 246extern void mallocstats(void);
984263bc 247
f71b7d86
SW
248extern int printf(const char *, ...) __printflike(1, 2);
249extern void vprintf(const char *, __va_list) __printflike(1, 0);
250extern int sprintf(char *, const char *, ...) __printflike(2, 3);
251extern void vsprintf(char *, const char *, __va_list) __printflike(2, 0);
252int snprintf(char *, size_t, const char *, ...) __printflike(3, 4);
253int vsnprintf(char *, size_t, const char *, __va_list)
254 __printflike(3, 0);
984263bc
MD
255
256extern void twiddle(void);
257
258extern void ngets(char *, int);
259#define gets(x) ngets((x), 0)
368f90fe 260extern char *fgets(char *, int, int);
ff2aef30 261extern int fgetstr(char *, int, int);
984263bc
MD
262
263extern int open(const char *, int);
264#define O_RDONLY 0x0
265#define O_WRONLY 0x1 /* writing not (yet?) supported */
266#define O_RDWR 0x2
267extern int close(int);
268extern void closeall(void);
269extern ssize_t read(int, void *, size_t);
270extern ssize_t write(int, void *, size_t);
271extern struct dirent *readdirfd(int);
272
ff2aef30 273extern void srandom(u_long);
984263bc 274extern u_long random(void);
ff2aef30 275
984263bc
MD
276/* imports from stdlib, locally modified */
277extern long strtol(const char *, char **, int);
20125565 278extern unsigned long strtoul(const char *, char **, int);
984263bc
MD
279extern char *optarg; /* getopt(3) external variables */
280extern int optind, opterr, optopt, optreset;
281extern int getopt(int, char * const [], const char *);
282
a84e1aa8
AHJ
283/* ether.c */
284extern char *ether_sprintf(u_char *);
285
984263bc
MD
286/* pager.c */
287extern void pager_open(void);
288extern void pager_close(void);
ff2aef30
SW
289extern int pager_output(const char *);
290extern int pager_file(const char *);
984263bc
MD
291
292/* No signal state to preserve */
293#define setjmp _setjmp
294#define longjmp _longjmp
295
296/* environment.c */
297#define EV_DYNAMIC (1<<0) /* value was dynamically allocated, free if changed/unset */
298#define EV_VOLATILE (1<<1) /* value is volatile, make a copy of it */
299#define EV_NOHOOK (1<<2) /* don't call hook when setting */
300
301struct env_var;
ff2aef30 302typedef char *(ev_format_t)(struct env_var *);
a9f4a7f2 303typedef int (ev_sethook_t)(struct env_var *, int, const void *);
ff2aef30 304typedef int (ev_unsethook_t)(struct env_var *);
984263bc
MD
305
306struct env_var
307{
308 char *ev_name;
309 int ev_flags;
310 void *ev_value;
311 ev_sethook_t *ev_sethook;
312 ev_unsethook_t *ev_unsethook;
313 struct env_var *ev_next, *ev_prev;
314};
315extern struct env_var *environ;
316
ff2aef30
SW
317extern struct env_var *env_getenv(const char *);
318extern int env_setenv(const char *, int, const void *, ev_sethook_t,
319 ev_unsethook_t);
320extern char *getenv(const char *);
321extern int setenv(const char *, const char *, int);
322extern int putenv(const char *);
323extern int unsetenv(const char *);
984263bc
MD
324
325extern ev_sethook_t env_noset; /* refuse set operation */
326extern ev_unsethook_t env_nounset; /* refuse unset operation */
327
328/* BCD conversions (undocumented) */
329extern u_char const bcd2bin_data[];
330extern u_char const bin2bcd_data[];
331extern char const hex2ascii_data[];
332
333#define bcd2bin(bcd) (bcd2bin_data[bcd])
334#define bin2bcd(bin) (bin2bcd_data[bin])
335#define hex2ascii(hex) (hex2ascii_data[hex])
336
337/* min/max (undocumented) */
338static __inline int imax(int a, int b) { return (a > b ? a : b); }
339static __inline int imin(int a, int b) { return (a < b ? a : b); }
340static __inline long lmax(long a, long b) { return (a > b ? a : b); }
341static __inline long lmin(long a, long b) { return (a < b ? a : b); }
342static __inline u_int max(u_int a, u_int b) { return (a > b ? a : b); }
343static __inline u_int min(u_int a, u_int b) { return (a < b ? a : b); }
344static __inline quad_t qmax(quad_t a, quad_t b) { return (a > b ? a : b); }
345static __inline quad_t qmin(quad_t a, quad_t b) { return (a < b ? a : b); }
346static __inline u_long ulmax(u_long a, u_long b) { return (a > b ? a : b); }
347static __inline u_long ulmin(u_long a, u_long b) { return (a < b ? a : b); }
88bf1145
MD
348static __inline size_t szmax(size_t a, size_t b) { return (a > b ? a : b); }
349static __inline size_t szmin(size_t a, size_t b) { return (a < b ? a : b); }
984263bc
MD
350
351/* swaps (undocumented, useful?) */
352#ifdef __i386__
ff2aef30
SW
353extern u_int32_t bswap32(u_int32_t);
354extern u_int64_t bswap64(u_int64_t);
984263bc
MD
355#endif
356
357/* null functions for device/filesystem switches (undocumented) */
358extern int nodev(void);
359extern int noioctl(struct open_file *, u_long, void *);
360extern void nullsys(void);
361
ff2aef30
SW
362extern int null_open(const char *, struct open_file *);
363extern int null_close(struct open_file *);
364extern int null_read(struct open_file *, void *, size_t, size_t *);
365extern int null_write(struct open_file *, void *, size_t, size_t *);
366extern off_t null_seek(struct open_file *, off_t, int);
367extern int null_stat(struct open_file *, struct stat *);
368extern int null_readdir(struct open_file *, struct dirent *);
984263bc
MD
369
370
371/*
372 * Machine dependent functions and data, must be provided or stubbed by
373 * the consumer
374 */
375extern int getchar(void);
376extern int ischar(void);
377extern void putchar(int);
378extern int devopen(struct open_file *, const char *, const char **);
ff2aef30 379extern int devclose(struct open_file *);
63ad7bd4 380extern void devreplace(struct open_file *, void *devdata);
f71b7d86 381extern void panic(const char *, ...) __dead2 __printflike(1, 2);
984263bc
MD
382extern struct fs_ops *file_system[];
383extern struct devsw *devsw[];
384
385#if 0
386
387static inline void *
388malloc_debug(size_t size, const char *file, int line)
389{
390 void *p;
391 printf("%s:%d malloc(%ld)", file, line, size);
392 p = malloc(size);
393 printf("=%p\n", p);
394 return p;
395}
396
397static inline void
398free_debug(void *p, const char *file, int line)
399{
400 printf("%s:%d free(%p)\n", file, line, p);
401 free(p);
402}
403
404#define malloc(x) malloc_debug(x, __FILE__, __LINE__)
405#define free(x) free_debug(x, __FILE__, __LINE__)
406
407#endif
b20f5c9e
IV
408
409#endif /* !_STAND_H_ */