Merge branch 'vendor/LIBARCHIVE'
[dragonfly.git] / include / stdlib.h
1 /*-
2  * Copyright (c) 1990, 1993
3  *      The Regents of the University of California.  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  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *      This product includes software developed by the University of
16  *      California, Berkeley and its contributors.
17  * 4. Neither the name of the University nor the names of its contributors
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  *      @(#)stdlib.h    8.5 (Berkeley) 5/19/95
34  * $FreeBSD: src/include/stdlib.h,v 1.67 2008/07/22 11:40:42 ache Exp $
35  * $DragonFly: src/include/stdlib.h,v 1.22 2008/06/05 17:53:10 swildner Exp $
36  */
37
38 #ifndef _STDLIB_H_
39 #define _STDLIB_H_
40
41 #include <sys/cdefs.h>
42 #include <sys/_null.h>
43 #include <sys/types.h>
44
45 #ifndef _SIZE_T_DECLARED
46 typedef __size_t        size_t;
47 #define _SIZE_T_DECLARED
48 #endif
49
50 #ifndef __cplusplus
51 #ifndef _WCHAR_T_DECLARED
52 typedef __wchar_t       wchar_t;
53 #define _WCHAR_T_DECLARED
54 #endif
55 #endif
56
57 typedef struct {
58         int     quot;           /* quotient */
59         int     rem;            /* remainder */
60 } div_t;
61
62 typedef struct {
63         long    quot;
64         long    rem;
65 } ldiv_t;
66
67 #define EXIT_FAILURE    1
68 #define EXIT_SUCCESS    0
69
70 #define RAND_MAX        0x7fffffff
71
72 extern int __mb_cur_max;
73 #define MB_CUR_MAX      __mb_cur_max
74
75 __BEGIN_DECLS
76 void     abort(void) __dead2;
77 /* void  abort2(const char *, int, void **) __dead2; */
78 #if !defined(_KERNEL_VIRTUAL)
79 int      abs(int) __pure2;
80 #endif
81 int      atexit(void (*)(void));
82 double   atof(const char *);
83 int      atoi(const char *);
84 long     atol(const char *);
85 void    *bsearch(const void *, const void *, size_t,
86                  size_t, int (*)(const void *, const void *));
87 void    *calloc(size_t, size_t);
88 div_t    div(int, int) __pure2;
89 void     exit(int) __dead2;
90 void     free(void *);
91 char    *getenv(const char *);
92 #if !defined(_KERNEL_VIRTUAL)
93 long     labs(long) __pure2;
94 #endif
95 ldiv_t   ldiv(long, long) __pure2;
96 void    *malloc(size_t);
97 int      posix_memalign(void **, size_t, size_t);
98 int      mblen(const char *, size_t);
99 size_t   mbstowcs(wchar_t * __restrict , const char * __restrict, size_t);
100 int      mbtowc(wchar_t * __restrict, const char * __restrict, size_t);
101 void     qsort(void *, size_t, size_t, int (*)(const void *, const void *));
102 int      rand(void);
103 void    *realloc(void *, size_t);
104 void     srand(unsigned);
105 double   strtod(const char * __restrict, char ** __restrict);
106 float    strtof(const char * __restrict, char ** __restrict);
107 #if !defined(_KERNEL_VIRTUAL)
108 long     strtol(const char * __restrict, char ** __restrict, int);
109 #endif
110 long double
111          strtold(const char * __restrict, char ** __restrict);
112 #if !defined(_KERNEL_VIRTUAL)
113 unsigned long
114          strtoul(const char * __restrict, char ** __restrict, int);
115 #endif
116 int      system(const char *);
117 int      wctomb(char *, wchar_t);
118 size_t   wcstombs(char * __restrict, const wchar_t * __restrict, size_t);
119
120 /*
121  * Functions added in C99 which we make conditionally available in the
122  * BSD^C89 namespace if the compiler supports `long long'.
123  * The #if test is more complicated than it ought to be because
124  * __BSD_VISIBLE implies __ISO_C_VISIBLE == 1999 *even if* `long long'
125  * is not supported in the compilation environment (which therefore means
126  * that it can't really be ISO C99).
127  *
128  * (The only other extension made by C99 in this header is _Exit().)
129  */
130 #if __ISO_C_VISIBLE >= 1999
131 #ifdef __LONG_LONG_SUPPORTED
132 /* LONGLONG */
133 typedef struct {
134         long long quot;
135         long long rem;
136 } lldiv_t;
137
138 /* LONGLONG */
139 long long
140          atoll(const char *);
141 /* LONGLONG */
142 long long
143          llabs(long long) __pure2;
144 /* LONGLONG */
145 lldiv_t  lldiv(long long, long long) __pure2;
146 /* LONGLONG */
147 long long
148          strtoll(const char * __restrict, char ** __restrict, int);
149 /* LONGLONG */
150 unsigned long long
151          strtoull(const char * __restrict, char ** __restrict, int);
152 #endif /* __LONG_LONG_SUPPORTED */
153
154 void     _Exit(int) __dead2;
155 #endif /* __ISO_C_VISIBLE >= 1999 */
156
157 /*
158  * Extensions made by POSIX relative to C.  We don't know yet which edition
159  * of POSIX made these extensions, so assume they've always been there until
160  * research can be done.
161  */
162 #if __POSIX_VISIBLE /* >= ??? */
163 /*int    posix_memalign(void **, size_t, size_t); (ADV) */
164 int      rand_r(unsigned *);                    /* (TSF) */
165 int      setenv(const char *, const char *, int);
166 int      unsetenv(const char *);
167 #endif
168
169 #if __POSIX_VISIBLE >= 200809 || __XSI_VISIBLE
170 #ifndef _MKDTEMP_DECLARED
171 char    *mkdtemp(char *);
172 #define _MKDTEMP_DECLARED
173 #endif
174 #ifndef _MKSTEMP_DECLARED
175 int      mkstemp(char *);
176 #define _MKSTEMP_DECLARED
177 #endif
178 #endif /* __POSIX_VISIBLE >= 200809 || __XSI_VISIBLE */
179
180 /*
181  * The only changes to the XSI namespace in revision 6 were the deletion
182  * of the ttyslot() and valloc() functions, which we never declared
183  * in this header.  For revision 7, ecvt(), fcvt(), and gcvt(), which
184  * we also do not have, and mktemp(), are to be deleted.
185  */
186 #if __XSI_VISIBLE
187 /* XXX XSI requires pollution from <sys/wait.h> here.  We'd rather not. */
188 long     a64l(const char *);
189 double   drand48(void);
190 /* char *ecvt(double, int, int * __restrict, int * __restrict); */
191 double   erand48(unsigned short[3]);
192 /* char *fcvt(double, int, int * __restrict, int * __restrict); */
193 /* char *gcvt(double, int, int * __restrict, int * __restrict); */
194 int      getsubopt(char **, char *const *, char **);
195 int      grantpt(int);
196 char    *initstate(unsigned long /* XSI requires u_int */, char *, long);
197 long     jrand48(unsigned short[3]);
198 char    *l64a(long);
199 void     lcong48(unsigned short[7]);
200 long     lrand48(void);
201 #if !defined(_MKTEMP_DECLARED) && (__BSD_VISIBLE || __XSI_VISIBLE <= 600)
202 char    *mktemp(char *);
203 #define _MKTEMP_DECLARED
204 #endif
205 long     mrand48(void);
206 long     nrand48(unsigned short[3]);
207 int      posix_openpt(int);
208 char    *ptsname(int);
209 int      putenv(char *);
210 long     random(void);
211 char    *realpath(const char *, char resolved_path[]);
212 unsigned short
213         *seed48(unsigned short[3]);
214 int      setkey(const char *);
215 char    *setstate(/* const */ char *);
216 void     srand48(long);
217 void     srandom(unsigned long);
218 int      unlockpt(int);
219 #endif /* __XSI_VISIBLE */
220
221 #if __BSD_VISIBLE
222 /* extern const char *_malloc_options;
223 extern void (*_malloc_message)(const char *, const char *, const char *,
224             const char *); */
225
226 /*
227  * The alloca() function can't be implemented in C, and on some
228  * platforms it can't be implemented at all as a callable function.
229  * The GNU C compiler provides a built-in alloca() which we can use;
230  * in all other cases, provide a prototype, mainly to pacify various
231  * incarnations of lint.  On platforms where alloca() is not in libc,
232  * programs which use it will fail to link when compiled with non-GNU
233  * compilers.
234  */
235 #if __GNUC__ >= 2 || defined(__INTEL_COMPILER)
236 #undef  alloca  /* some GNU bits try to get cute and define this on their own */
237 #define alloca(sz) __builtin_alloca(sz)
238 #elif defined(lint)
239 void    *alloca(size_t);
240 #endif
241
242 __uint32_t
243          arc4random(void);
244 void     arc4random_addrandom(__uint8_t *, size_t);
245 void     arc4random_buf(void *, size_t);
246 void     arc4random_stir(void);
247 __uint32_t
248          arc4random_uniform(__uint32_t);
249 char    *getbsize(int *, long *);
250
251 /* getcap(3) functions */
252 char    *cgetcap(char *, const char *, int);
253 int      cgetclose(void);
254 int      cgetent(char **, char **, const char *);
255 int      cgetfirst(char **, char **);
256 int      cgetmatch(const char *, const char *);
257 int      cgetnext(char **, char **);
258 int      cgetnum(char *, const char *, long *);
259 int      cgetset(const char *);
260 int      cgetstr(char *, const char *, char **);
261 int      cgetustr(char *, const char *, char **);
262
263 int      daemon(int, int);
264 char    *devname(dev_t, mode_t);
265 char    *devname_r(dev_t, mode_t, char *, size_t);
266 char    *fdevname(int);
267 int      fdevname_r(int, char *, size_t);
268 int      getloadavg(double [], int);
269 __const char *
270          getprogname(void);
271
272 int      heapsort(void *, size_t, size_t, int (*)(const void *, const void *));
273 int      l64a_r(long, char *, int);
274 int      mergesort(void *, size_t, size_t, int (*)(const void *, const void *));
275 void     qsort_r(void *, size_t, size_t, void *,
276                  int (*)(void *, const void *, const void *));
277 int      radixsort(const unsigned char **, int, const unsigned char *,
278                    unsigned int);
279 void    *reallocf(void *, size_t);
280 int      rpmatch(const char *);
281 void     setprogname(const char *);
282 int      sradixsort(const unsigned char **, int, const unsigned char *,
283                     unsigned int);
284 void     sranddev(void);
285 void     srandomdev(void);
286 long long
287          strtonum(const char *, long long, long long, const char **);
288
289 /* Deprecated interfaces. */
290 #if !defined(_KERNEL_VIRTUAL)
291 __int64_t
292          strtoq(const char *, char **, int);
293 __uint64_t
294          strtouq(const char *, char **, int);
295 #endif
296
297 extern char *suboptarg;                 /* getsubopt(3) external variable */
298 #endif /* __BSD_VISIBLE */
299 __END_DECLS
300
301 #endif /* !_STDLIB_H_ */