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