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