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