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