46030e03abac589814449256f18f6f976c4eada8
[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 int      abs(int) __pure2;
79 int      atexit(void (*)(void));
80 double   atof(const char *);
81 int      atoi(const char *);
82 long     atol(const char *);
83 void    *bsearch(const void *, const void *, size_t,
84                  size_t, int (*)(const void *, const void *));
85 void    *calloc(size_t, size_t);
86 div_t    div(int, int) __pure2;
87 void     exit(int) __dead2;
88 void     free(void *);
89 char    *getenv(const char *);
90 long     labs(long) __pure2;
91 ldiv_t   ldiv(long, long) __pure2;
92 void    *malloc(size_t);
93 int      mblen(const char *, size_t);
94 size_t   mbstowcs(wchar_t * __restrict , const char * __restrict, size_t);
95 int      mbtowc(wchar_t * __restrict, const char * __restrict, size_t);
96 void     qsort(void *, size_t, size_t, int (*)(const void *, const void *));
97 int      rand(void);
98 void    *realloc(void *, size_t);
99 void     srand(unsigned);
100 double   strtod(const char * __restrict, char ** __restrict);
101 float    strtof(const char * __restrict, char ** __restrict);
102 #if !defined(_KERNEL_VIRTUAL)
103 long     strtol(const char * __restrict, char ** __restrict, int);
104 #endif
105 long double
106          strtold(const char * __restrict, char ** __restrict);
107 #if !defined(_KERNEL_VIRTUAL)
108 unsigned long
109          strtoul(const char * __restrict, char ** __restrict, int);
110 #endif
111 int      system(const char *);
112 int      wctomb(char *, wchar_t);
113 size_t   wcstombs(char * __restrict, const wchar_t * __restrict, size_t);
114
115 /*
116  * Functions added in C99 which we make conditionally available in the
117  * BSD^C89 namespace if the compiler supports `long long'.
118  * The #if test is more complicated than it ought to be because
119  * __BSD_VISIBLE implies __ISO_C_VISIBLE == 1999 *even if* `long long'
120  * is not supported in the compilation environment (which therefore means
121  * that it can't really be ISO C99).
122  *
123  * (The only other extension made by C99 in this header is _Exit().)
124  */
125 #if __ISO_C_VISIBLE >= 1999
126 #ifdef __LONG_LONG_SUPPORTED
127 /* LONGLONG */
128 typedef struct {
129         long long quot;
130         long long rem;
131 } lldiv_t;
132
133 /* LONGLONG */
134 long long
135          atoll(const char *);
136 /* LONGLONG */
137 long long
138          llabs(long long) __pure2;
139 /* LONGLONG */
140 lldiv_t  lldiv(long long, long long) __pure2;
141 /* LONGLONG */
142 long long
143          strtoll(const char * __restrict, char ** __restrict, int);
144 /* LONGLONG */
145 unsigned long long
146          strtoull(const char * __restrict, char ** __restrict, int);
147 #endif /* __LONG_LONG_SUPPORTED */
148
149 void     _Exit(int) __dead2;
150 #endif /* __ISO_C_VISIBLE >= 1999 */
151
152 /*
153  * Extensions made by POSIX relative to C.  We don't know yet which edition
154  * of POSIX made these extensions, so assume they've always been there until
155  * research can be done.
156  */
157 #if __POSIX_VISIBLE /* >= ??? */
158 /*int    posix_memalign(void **, size_t, size_t); (ADV) */
159 int      rand_r(unsigned *);                    /* (TSF) */
160 int      setenv(const char *, const char *, int);
161 int      unsetenv(const char *);
162 #endif
163
164 #if __POSIX_VISIBLE >= 200809 || __XSI_VISIBLE
165 #ifndef _MKDTEMP_DECLARED
166 char    *mkdtemp(char *);
167 #define _MKDTEMP_DECLARED
168 #endif
169 #ifndef _MKSTEMP_DECLARED
170 int      mkstemp(char *);
171 #define _MKSTEMP_DECLARED
172 #endif
173 #endif /* __POSIX_VISIBLE >= 200809 || __XSI_VISIBLE */
174
175 /*
176  * The only changes to the XSI namespace in revision 6 were the deletion
177  * of the ttyslot() and valloc() functions, which we never declared
178  * in this header.  For revision 7, ecvt(), fcvt(), and gcvt(), which
179  * we also do not have, and mktemp(), are to be deleted.
180  */
181 #if __XSI_VISIBLE
182 /* XXX XSI requires pollution from <sys/wait.h> here.  We'd rather not. */
183 long     a64l(const char *);
184 double   drand48(void);
185 /* char *ecvt(double, int, int * __restrict, int * __restrict); */
186 double   erand48(unsigned short[3]);
187 /* char *fcvt(double, int, int * __restrict, int * __restrict); */
188 /* char *gcvt(double, int, int * __restrict, int * __restrict); */
189 int      getsubopt(char **, char *const *, char **);
190 int      grantpt(int);
191 char    *initstate(unsigned long /* XSI requires u_int */, char *, long);
192 long     jrand48(unsigned short[3]);
193 char    *l64a(long);
194 void     lcong48(unsigned short[7]);
195 long     lrand48(void);
196 #if !defined(_MKTEMP_DECLARED) && (__BSD_VISIBLE || __XSI_VISIBLE <= 600)
197 char    *mktemp(char *);
198 #define _MKTEMP_DECLARED
199 #endif
200 long     mrand48(void);
201 long     nrand48(unsigned short[3]);
202 /* int   posix_openpt(int); */
203 /* char *ptsname(int); */
204 int      putenv(char *);
205 long     random(void);
206 char    *realpath(const char *, char resolved_path[]);
207 unsigned short
208         *seed48(unsigned short[3]);
209 int      setkey(const char *);
210 char    *setstate(/* const */ char *);
211 void     srand48(long);
212 void     srandom(unsigned long);
213 /* int   unlockpt(int); */
214 #endif /* __XSI_VISIBLE */
215
216 #if __BSD_VISIBLE
217 /* extern const char *_malloc_options;
218 extern void (*_malloc_message)(const char *, const char *, const char *,
219             const char *); */
220
221 /*
222  * The alloca() function can't be implemented in C, and on some
223  * platforms it can't be implemented at all as a callable function.
224  * The GNU C compiler provides a built-in alloca() which we can use;
225  * in all other cases, provide a prototype, mainly to pacify various
226  * incarnations of lint.  On platforms where alloca() is not in libc,
227  * programs which use it will fail to link when compiled with non-GNU
228  * compilers.
229  */
230 #if __GNUC__ >= 2 || defined(__INTEL_COMPILER)
231 #undef  alloca  /* some GNU bits try to get cute and define this on their own */
232 #define alloca(sz) __builtin_alloca(sz)
233 #elif defined(lint)
234 void    *alloca(size_t);
235 #endif
236
237 __uint32_t
238          arc4random(void);
239 void     arc4random_addrandom(__uint8_t *, size_t);
240 void     arc4random_buf(void *, size_t);
241 void     arc4random_stir(void);
242 __uint32_t
243          arc4random_uniform(__uint32_t);
244 char    *getbsize(int *, long *);
245                                         /* getcap(3) functions */
246 char    *cgetcap(char *, const char *, int);
247 int      cgetclose(void);
248 int      cgetent(char **, char **, const char *);
249 int      cgetfirst(char **, char **);
250 int      cgetmatch(const char *, const char *);
251 int      cgetnext(char **, char **);
252 int      cgetnum(char *, const char *, long *);
253 int      cgetset(const char *);
254 int      cgetstr(char *, const char *, char **);
255 int      cgetustr(char *, const char *, char **);
256
257 int      daemon(int, int);
258 char    *devname(dev_t, mode_t);
259 char    *devname_r(dev_t, mode_t, char *, size_t);
260 int      getloadavg(double [], int);
261 __const char *
262          getprogname(void);
263
264 int      heapsort(void *, size_t, size_t, int (*)(const void *, const void *));
265 int      l64a_r(long, char *, int);
266 int      mergesort(void *, size_t, size_t, int (*)(const void *, const void *));
267 void     qsort_r(void *, size_t, size_t, void *,
268                  int (*)(void *, const void *, const void *));
269 int      radixsort(const unsigned char **, int, const unsigned char *,
270                    unsigned int);
271 void    *reallocf(void *, size_t);
272 int      rpmatch(const char *);
273 void     setprogname(const char *);
274 int      sradixsort(const unsigned char **, int, const unsigned char *,
275                     unsigned int);
276 void     sranddev(void);
277 void     srandomdev(void);
278 long long
279         strtonum(const char *, long long, long long, const char **);
280
281 /* Deprecated interfaces. */
282 #if !defined(_KERNEL_VIRTUAL)
283 __int64_t
284          strtoq(const char *, char **, int);
285 __uint64_t
286          strtouq(const char *, char **, int);
287 #endif
288
289 extern char *suboptarg;                 /* getsubopt(3) external variable */
290 #endif /* __BSD_VISIBLE */
291 __END_DECLS
292
293 #endif /* !_STDLIB_H_ */