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
32#ifndef _STDLIB_H_
33#define	_STDLIB_H_
34
35#include <sys/cdefs.h>
36#include <sys/_null.h>
37#include <sys/_types.h>
38
39__NULLABILITY_PRAGMA_PUSH
40
41#if __BSD_VISIBLE
42#ifndef _RUNE_T_DECLARED
43typedef	__rune_t	rune_t;
44#define	_RUNE_T_DECLARED
45#endif
46#endif
47
48#ifndef _SIZE_T_DECLARED
49typedef	__size_t	size_t;
50#define	_SIZE_T_DECLARED
51#endif
52
53#ifndef	__cplusplus
54#ifndef _WCHAR_T_DECLARED
55typedef	___wchar_t	wchar_t;
56#define	_WCHAR_T_DECLARED
57#endif
58#endif
59
60typedef struct {
61	int	quot;		/* quotient */
62	int	rem;		/* remainder */
63} div_t;
64
65typedef struct {
66	long	quot;
67	long	rem;
68} ldiv_t;
69
70#define	EXIT_FAILURE	1
71#define	EXIT_SUCCESS	0
72
73/*
74 * I.e., INT_MAX; rand(3) returns a signed integer but must produce output in
75 * the range [0, RAND_MAX], so half of the possible output range is unused.
76 */
77#define	RAND_MAX	0x7fffffff
78
79__BEGIN_DECLS
80#ifdef _XLOCALE_H_
81#include <xlocale/_stdlib.h>
82#endif
83extern int __mb_cur_max;
84extern int ___mb_cur_max(void);
85#define	MB_CUR_MAX	((size_t)___mb_cur_max())
86
87_Noreturn void	 abort(void) __noexcept;
88int	 abs(int) __pure2;
89int	 atexit(void (* _Nonnull)(void)) __noexcept;
90double	 atof(const char *);
91int	 atoi(const char *);
92long	 atol(const char *);
93void	*bsearch(const void *, const void *, size_t,
94	    size_t, int (*)(const void * _Nonnull, const void *));
95void	*calloc(size_t, size_t) __malloc_like __result_use_check
96	     __alloc_size2(1, 2);
97div_t	 div(int, int) __pure2;
98_Noreturn void	 exit(int);
99void	 free(void *);
100char	*getenv(const char *);
101long	 labs(long) __pure2;
102ldiv_t	 ldiv(long, long) __pure2;
103void	*malloc(size_t) __malloc_like __result_use_check __alloc_size(1);
104int	 mblen(const char *, size_t);
105size_t	 mbstowcs(wchar_t * __restrict , const char * __restrict, size_t);
106int	 mbtowc(wchar_t * __restrict, const char * __restrict, size_t);
107void	 qsort(void *, size_t, size_t,
108	    int (* _Nonnull)(const void *, const void *));
109int	 rand(void);
110void	*realloc(void *, size_t) __result_use_check __alloc_size(2);
111void	 srand(unsigned);
112double	 strtod(const char * __restrict, char ** __restrict);
113float	 strtof(const char * __restrict, char ** __restrict);
114long	 strtol(const char * __restrict, char ** __restrict, int);
115long double
116	 strtold(const char * __restrict, char ** __restrict);
117unsigned long
118	 strtoul(const char * __restrict, char ** __restrict, int);
119int	 system(const char *);
120int	 wctomb(char *, wchar_t);
121size_t	 wcstombs(char * __restrict, const wchar_t * __restrict, size_t);
122
123/*
124 * Functions added in C99 which we make conditionally available in the
125 * BSD^C89 namespace if the compiler supports `long long'.
126 * The #if test is more complicated than it ought to be because
127 * __BSD_VISIBLE implies __ISO_C_VISIBLE == 1999 *even if* `long long'
128 * is not supported in the compilation environment (which therefore means
129 * that it can't really be ISO C99).
130 *
131 * (The only other extension made by C99 in this header is _Exit().)
132 */
133#if __ISO_C_VISIBLE >= 1999 || defined(__cplusplus)
134#ifdef __LONG_LONG_SUPPORTED
135/* LONGLONG */
136typedef struct {
137	long long quot;
138	long long rem;
139} lldiv_t;
140
141/* LONGLONG */
142long long
143	 atoll(const char *);
144/* LONGLONG */
145long long
146	 llabs(long long) __pure2;
147/* LONGLONG */
148lldiv_t	 lldiv(long long, long long) __pure2;
149/* LONGLONG */
150long long
151	 strtoll(const char * __restrict, char ** __restrict, int);
152/* LONGLONG */
153unsigned long long
154	 strtoull(const char * __restrict, char ** __restrict, int);
155#endif /* __LONG_LONG_SUPPORTED */
156
157_Noreturn void	 _Exit(int) __noexcept;
158#endif /* __ISO_C_VISIBLE >= 1999 */
159
160/*
161 * If we're in a mode greater than C99, expose C11 functions.
162 */
163#if __ISO_C_VISIBLE >= 2011 || __cplusplus >= 201103L
164void *	aligned_alloc(size_t, size_t) __malloc_like __alloc_align(1)
165	    __alloc_size(2);
166int	at_quick_exit(void (*)(void)) __noexcept;
167_Noreturn void
168	quick_exit(int) /* __noexcept -- not ready ABI issues? */;
169#endif /* __ISO_C_VISIBLE >= 2011 */
170/*
171 * Extensions made by POSIX relative to C.
172 */
173#if __POSIX_VISIBLE >= 199506 || __XSI_VISIBLE
174char	*realpath(const char * __restrict, char * __restrict);
175#endif
176#if __POSIX_VISIBLE >= 199506
177int	 rand_r(unsigned *);			/* (TSF) */
178#endif
179#if __POSIX_VISIBLE >= 200112
180int	 posix_memalign(void **, size_t, size_t); /* (ADV) */
181int	 setenv(const char *, const char *, int);
182int	 unsetenv(const char *);
183#endif
184
185#if __POSIX_VISIBLE >= 200809 || __XSI_VISIBLE
186int	 getsubopt(char **, char *const *, char **);
187#ifndef _MKDTEMP_DECLARED
188char	*mkdtemp(char *);
189#define	_MKDTEMP_DECLARED
190#endif
191#ifndef _MKSTEMP_DECLARED
192int	 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. */
205long	 a64l(const char *);
206double	 drand48(void);
207/* char	*ecvt(double, int, int * __restrict, int * __restrict); */
208double	 erand48(unsigned short[3]);
209/* char	*fcvt(double, int, int * __restrict, int * __restrict); */
210/* char	*gcvt(double, int, int * __restrict, int * __restrict); */
211char	*initstate(unsigned int, char *, size_t);
212long	 jrand48(unsigned short[3]);
213char	*l64a(long);
214void	 lcong48(unsigned short[7]);
215long	 lrand48(void);
216#if !defined(_MKTEMP_DECLARED) && (__BSD_VISIBLE || __XSI_VISIBLE <= 600)
217char	*mktemp(char *);
218#define	_MKTEMP_DECLARED
219#endif
220long	 mrand48(void);
221long	 nrand48(unsigned short[3]);
222int	 putenv(char *);
223long	 random(void);
224unsigned short
225	*seed48(unsigned short[3]);
226char	*setstate(/* const */ char *);
227void	 srand48(long);
228void	 srandom(unsigned int);
229#endif /* __XSI_VISIBLE */
230
231#if __XSI_VISIBLE
232int	 grantpt(int);
233int	 posix_openpt(int);
234char	*ptsname(int);
235int	 unlockpt(int);
236#endif /* __XSI_VISIBLE */
237#if __BSD_VISIBLE
238/* ptsname_r will be included in POSIX issue 8 */
239int	 ptsname_r(int, char *, size_t);
240#endif
241
242#if __BSD_VISIBLE
243extern const char *malloc_conf;
244extern void (*malloc_message)(void *, const char *);
245
246/*
247 * The alloca() function can't be implemented in C, and on some
248 * platforms it can't be implemented at all as a callable function.
249 * The GNU C compiler provides a built-in alloca() which we can use.
250 * On platforms where alloca() is not in libc, programs which use it
251 * will fail to link when compiled with non-GNU compilers.
252 */
253#if __GNUC__ >= 2
254#undef  alloca	/* some GNU bits try to get cute and define this on their own */
255#define alloca(sz) __builtin_alloca(sz)
256#endif
257
258void	 abort2(const char *, int, void **) __dead2;
259__uint32_t
260	 arc4random(void);
261void	 arc4random_buf(void *, size_t);
262__uint32_t
263	 arc4random_uniform(__uint32_t);
264
265#ifdef __BLOCKS__
266int	 atexit_b(void (^ _Nonnull)(void));
267void	*bsearch_b(const void *, const void *, size_t,
268	    size_t, int (^ _Nonnull)(const void *, const void *));
269#endif
270char	*getbsize(int *, long *);
271					/* getcap(3) functions */
272char	*cgetcap(char *, const char *, int);
273int	 cgetclose(void);
274int	 cgetent(char **, char **, const char *);
275int	 cgetfirst(char **, char **);
276int	 cgetmatch(const char *, const char *);
277int	 cgetnext(char **, char **);
278int	 cgetnum(char *, const char *, long *);
279int	 cgetset(const char *);
280int	 cgetstr(char *, const char *, char **);
281int	 cgetustr(char *, const char *, char **);
282
283int	 clearenv(void);
284
285int	 daemon(int, int);
286int	 daemonfd(int, int);
287char	*devname(__dev_t, __mode_t);
288char	*devname_r(__dev_t, __mode_t, char *, int);
289char	*fdevname(int);
290char	*fdevname_r(int, char *, int);
291int	 getloadavg(double [], int);
292const char *
293	 getprogname(void);
294
295int	 heapsort(void *, size_t, size_t,
296	    int (* _Nonnull)(const void *, const void *));
297#ifdef __BLOCKS__
298int	 heapsort_b(void *, size_t, size_t,
299	    int (^ _Nonnull)(const void *, const void *));
300void	 qsort_b(void *, size_t, size_t,
301	    int (^ _Nonnull)(const void *, const void *));
302#endif
303int	 l64a_r(long, char *, int);
304int	 mergesort(void *, size_t, size_t, int (*)(const void *, const void *));
305#ifdef __BLOCKS__
306int	 mergesort_b(void *, size_t, size_t, int (^)(const void *, const void *));
307#endif
308int	 mkostemp(char *, int);
309int	 mkostemps(char *, int, int);
310int	 mkostempsat(int, char *, int, int);
311void	 qsort_r(void *, size_t, size_t,
312	    int (*)(const void *, const void *, void *), void *);
313int	 radixsort(const unsigned char **, int, const unsigned char *,
314	    unsigned);
315void	*reallocarray(void *, size_t, size_t) __result_use_check
316	    __alloc_size2(2, 3);
317void	*reallocf(void *, size_t) __result_use_check __alloc_size(2);
318int	 rpmatch(const char *);
319char	*secure_getenv(const char *);
320void	 setprogname(const char *);
321int	 sradixsort(const unsigned char **, int, const unsigned char *,
322	    unsigned);
323void	 srandomdev(void);
324long long
325	strtonum(const char *, long long, long long, const char **);
326
327/* Deprecated interfaces, to be removed. */
328__int64_t
329	 strtoq(const char *, char **, int);
330__uint64_t
331	 strtouq(const char *, char **, int);
332
333/*
334 * In FreeBSD 14, the prototype of qsort_r() was modified to comply with
335 * POSIX.  The standardized qsort_r()'s order of last two parameters was
336 * changed, and the comparator function is now taking thunk as its last
337 * parameter, and both are different from the ones expected by the historical
338 * FreeBSD qsort_r() interface.
339 *
340 * Apply a workaround where we explicitly link against the historical
341 * interface, qsort_r@FBSD_1.0, in case when qsort_r() is called with
342 * the last parameter with a function pointer that exactly matches the
343 * historical FreeBSD qsort_r() comparator signature, so applications
344 * written for the historical interface can continue to work without
345 * modification.
346 */
347#if defined(__generic) || defined(__cplusplus)
348void __qsort_r_compat(void *, size_t, size_t, void *,
349	    int (*)(void *, const void *, const void *));
350__sym_compat(qsort_r, __qsort_r_compat, FBSD_1.0);
351#endif
352#if defined(__generic) && !defined(__cplusplus)
353#define	qsort_r(base, nel, width, arg4, arg5)				\
354    __generic(arg5, int (*)(void *, const void *, const void *),	\
355        __qsort_r_compat, qsort_r)(base, nel, width, arg4, arg5)
356#elif defined(__cplusplus)
357__END_DECLS
358extern "C++" {
359static inline void qsort_r(void *base, size_t nmemb, size_t size,
360    void *thunk, int (*compar)(void *, const void *, const void *)) {
361	__qsort_r_compat(base, nmemb, size, thunk, compar);
362}
363}
364__BEGIN_DECLS
365#endif
366
367extern char *suboptarg;			/* getsubopt(3) external variable */
368#endif /* __BSD_VISIBLE */
369
370#if __EXT1_VISIBLE
371
372#ifndef _RSIZE_T_DEFINED
373#define _RSIZE_T_DEFINED
374typedef size_t rsize_t;
375#endif
376
377#ifndef _ERRNO_T_DEFINED
378#define _ERRNO_T_DEFINED
379typedef int errno_t;
380#endif
381
382/* K.3.6 */
383typedef void (*constraint_handler_t)(const char * __restrict,
384    void * __restrict, errno_t);
385/* K.3.6.1.1 */
386constraint_handler_t set_constraint_handler_s(constraint_handler_t handler);
387/* K.3.6.1.2 */
388_Noreturn void abort_handler_s(const char * __restrict, void * __restrict,
389    errno_t);
390/* K3.6.1.3 */
391void ignore_handler_s(const char * __restrict, void * __restrict, errno_t);
392/* K.3.6.3.2 */
393errno_t	 qsort_s(void *, rsize_t, rsize_t,
394    int (*)(const void *, const void *, void *), void *);
395#endif /* __EXT1_VISIBLE */
396
397__END_DECLS
398__NULLABILITY_PRAGMA_POP
399
400#endif /* !_STDLIB_H_ */
401