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 #ifndef _SIZE_T_DECLARED
42 typedef __size_t size_t;
43 #define _SIZE_T_DECLARED
44 #endif
45
46 #ifndef __cplusplus
47 #ifndef _WCHAR_T_DECLARED
48 typedef ___wchar_t wchar_t;
49 #define _WCHAR_T_DECLARED
50 #endif
51 #endif
52
53 typedef struct {
54 int quot; /* quotient */
55 int rem; /* remainder */
56 } div_t;
57
58 typedef struct {
59 long quot;
60 long rem;
61 } ldiv_t;
62
63 #define EXIT_FAILURE 1
64 #define EXIT_SUCCESS 0
65
66 /*
67 * I.e., INT_MAX; rand(3) returns a signed integer but must produce output in
68 * the range [0, RAND_MAX], so half of the possible output range is unused.
69 */
70 #define RAND_MAX 0x7fffffff
71
72 #if !defined(_STANDALONE) && defined(_FORTIFY_SOURCE) && _FORTIFY_SOURCE > 0
73 #include <ssp/stdlib.h>
74 #endif
75
76 __BEGIN_DECLS
77 #ifdef _XLOCALE_H_
78 #include <xlocale/_stdlib.h>
79 #endif
80 extern int __mb_cur_max;
81 extern int ___mb_cur_max(void);
82 #define MB_CUR_MAX ((size_t)___mb_cur_max())
83
84 _Noreturn void abort(void) __noexcept;
85 int abs(int) __pure2;
86 int atexit(void (* _Nonnull)(void)) __noexcept;
87 double atof(const char *);
88 int atoi(const char *);
89 long atol(const char *);
90 void *bsearch(const void *, const void *, size_t,
91 size_t, int (*)(const void * _Nonnull, const void *));
92 void *calloc(size_t, size_t) __malloc_like __result_use_check
93 __alloc_size2(1, 2);
94 div_t div(int, int) __pure2;
95 _Noreturn void exit(int);
96 void free(void *);
97 char *getenv(const char *);
98 #if __BSD_VISIBLE
99 int getenv_r(const char *, char * _Nonnull, size_t);
100 #endif
101 long labs(long) __pure2;
102 ldiv_t ldiv(long, long) __pure2;
103 void *malloc(size_t) __malloc_like __result_use_check __alloc_size(1);
104 int mblen(const char *, size_t);
105 size_t mbstowcs(wchar_t * __restrict , const char * __restrict, size_t);
106 int mbtowc(wchar_t * __restrict, const char * __restrict, size_t);
107 void qsort(void *, size_t, size_t,
108 int (* _Nonnull)(const void *, const void *));
109 int rand(void);
110 void *realloc(void *, size_t) __result_use_check __alloc_size(2);
111 void srand(unsigned);
112 double strtod(const char * __restrict, char ** __restrict);
113 float strtof(const char * __restrict, char ** __restrict);
114 long strtol(const char * __restrict, char ** __restrict, int);
115 long double
116 strtold(const char * __restrict, char ** __restrict);
117 unsigned long
118 strtoul(const char * __restrict, char ** __restrict, int);
119 int system(const char *);
120 int wctomb(char *, wchar_t);
121 size_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 */
136 typedef struct {
137 long long quot;
138 long long rem;
139 } lldiv_t;
140
141 /* LONGLONG */
142 long long
143 atoll(const char *);
144 /* LONGLONG */
145 long long
146 llabs(long long) __pure2;
147 /* LONGLONG */
148 lldiv_t lldiv(long long, long long) __pure2;
149 /* LONGLONG */
150 long long
151 strtoll(const char * __restrict, char ** __restrict, int);
152 /* LONGLONG */
153 unsigned 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
164 void * aligned_alloc(size_t, size_t) __malloc_like __alloc_align(1)
165 __alloc_size(2);
166 int 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 /*
172 * C23 extensions
173 */
174 #if __ISO_C_VISIBLE >= 2023
175 size_t memalignment(const void *) __pure2;
176 void free_sized(void *, size_t) __noexcept;
177 void free_aligned_sized(void *, size_t, size_t) __noexcept;
178 int strfromd(char * __restrict, size_t, const char * __restrict, double);
179 int strfromf(char * __restrict, size_t, const char * __restrict, float);
180 int strfroml(char * __restrict, size_t,
181 const char * __restrict, long double);
182 #endif /* __ISO_C_VISIBLE >= 2023 */
183
184 /*
185 * Extensions made by POSIX relative to C.
186 */
187 #if __POSIX_VISIBLE >= 199506 || __XSI_VISIBLE
188 char *realpath(const char * __restrict, char * __restrict);
189 #endif
190 #if __POSIX_VISIBLE >= 199506
191 int rand_r(unsigned *); /* (TSF) */
192 #endif
193 #if __POSIX_VISIBLE >= 200112
194 int posix_memalign(void **, size_t, size_t); /* (ADV) */
195 int setenv(const char *, const char *, int);
196 int unsetenv(const char *);
197 #endif
198
199 #if __POSIX_VISIBLE >= 200809 || __XSI_VISIBLE
200 int getsubopt(char **, char *const *, char **);
201 #ifndef _MKDTEMP_DECLARED
202 char *mkdtemp(char *);
203 #define _MKDTEMP_DECLARED
204 #endif
205 #ifndef _MKSTEMP_DECLARED
206 int mkstemp(char *);
207 #define _MKSTEMP_DECLARED
208 #endif
209 #endif /* __POSIX_VISIBLE >= 200809 || __XSI_VISIBLE */
210
211 /*
212 * The only changes to the XSI namespace in revision 6 were the deletion
213 * of the ttyslot() and valloc() functions, which FreeBSD never declared
214 * in this header. For revision 7, ecvt(), fcvt(), and gcvt(), which
215 * FreeBSD also does not have, and mktemp(), are to be deleted.
216 */
217 #if __XSI_VISIBLE
218 /* XXX XSI requires pollution from <sys/wait.h> here. We'd rather not. */
219 long a64l(const char *);
220 double drand48(void);
221 /* char *ecvt(double, int, int * __restrict, int * __restrict); */
222 double erand48(unsigned short[3]);
223 /* char *fcvt(double, int, int * __restrict, int * __restrict); */
224 /* char *gcvt(double, int, int * __restrict, int * __restrict); */
225 char *initstate(unsigned int, char *, size_t);
226 long jrand48(unsigned short[3]);
227 char *l64a(long);
228 void lcong48(unsigned short[7]);
229 long lrand48(void);
230 #if !defined(_MKTEMP_DECLARED) && (__BSD_VISIBLE || __XSI_VISIBLE <= 600)
231 char *mktemp(char *);
232 #define _MKTEMP_DECLARED
233 #endif
234 long mrand48(void);
235 long nrand48(unsigned short[3]);
236 int putenv(char *);
237 long random(void);
238 unsigned short
239 *seed48(unsigned short[3]);
240 char *setstate(/* const */ char *);
241 void srand48(long);
242 void srandom(unsigned int);
243 #endif /* __XSI_VISIBLE */
244
245 #if __XSI_VISIBLE
246 int grantpt(int);
247 int posix_openpt(int);
248 char *ptsname(int);
249 int unlockpt(int);
250 #endif /* __XSI_VISIBLE */
251 #if __BSD_VISIBLE
252 /* ptsname_r will be included in POSIX issue 8 */
253 int ptsname_r(int, char *, size_t);
254 #endif
255
256 #if __BSD_VISIBLE
257 extern const char *malloc_conf;
258 extern void (*malloc_message)(void *, const char *);
259
260 /*
261 * The alloca() function can't be implemented in C, and on some
262 * platforms it can't be implemented at all as a callable function.
263 * The GNU C compiler provides a built-in alloca() which we can use.
264 * On platforms where alloca() is not in libc, programs which use it
265 * will fail to link when compiled with non-GNU compilers.
266 */
267 #if __GNUC__ >= 2
268 #undef alloca /* some GNU bits try to get cute and define this on their own */
269 #define alloca(sz) __builtin_alloca(sz)
270 #endif
271
272 void abort2(const char *, int, void **) __dead2;
273 __uint32_t
274 arc4random(void);
275 void arc4random_buf(void *, size_t);
276 __uint32_t
277 arc4random_uniform(__uint32_t);
278
279 #ifdef __BLOCKS__
280 int atexit_b(void (^ _Nonnull)(void));
281 void *bsearch_b(const void *, const void *, size_t,
282 size_t, int (^ _Nonnull)(const void *, const void *));
283 #endif
284 char *getbsize(int *, long *);
285 /* getcap(3) functions */
286 char *cgetcap(char *, const char *, int);
287 int cgetclose(void);
288 int cgetent(char **, char **, const char *);
289 int cgetfirst(char **, char **);
290 int cgetmatch(const char *, const char *);
291 int cgetnext(char **, char **);
292 int cgetnum(char *, const char *, long *);
293 int cgetset(const char *);
294 int cgetstr(char *, const char *, char **);
295 int cgetustr(char *, const char *, char **);
296
297 int clearenv(void);
298
299 int daemon(int, int);
300 int daemonfd(int, int);
301 char *devname(__dev_t, __mode_t);
302 char *devname_r(__dev_t, __mode_t, char *, int);
303 char *fdevname(int);
304 char *fdevname_r(int, char *, int);
305 int getloadavg(double [], int);
306 const char *
307 getprogname(void);
308
309 int heapsort(void *, size_t, size_t,
310 int (* _Nonnull)(const void *, const void *));
311 #ifdef __BLOCKS__
312 int heapsort_b(void *, size_t, size_t,
313 int (^ _Nonnull)(const void *, const void *));
314 void qsort_b(void *, size_t, size_t,
315 int (^ _Nonnull)(const void *, const void *));
316 #endif
317 int l64a_r(long, char *, int);
318 int mergesort(void *, size_t, size_t, int (*)(const void *, const void *));
319 #ifdef __BLOCKS__
320 int mergesort_b(void *, size_t, size_t, int (^)(const void *, const void *));
321 #endif
322 int mkostemp(char *, int);
323 int mkostemps(char *, int, int);
324 int mkostempsat(int, char *, int, int);
325 void qsort_r(void *, size_t, size_t,
326 int (*)(const void *, const void *, void *), void *);
327 int radixsort(const unsigned char **, int, const unsigned char *,
328 unsigned);
329 void *reallocarray(void *, size_t, size_t) __result_use_check
330 __alloc_size2(2, 3);
331 void *recallocarray(void *, size_t, size_t, size_t) __result_use_check
332 __alloc_size2(3, 4);
333 void *reallocf(void *, size_t) __result_use_check __alloc_size(2);
334 int rpmatch(const char *);
335 char *secure_getenv(const char *);
336 void setprogname(const char *);
337 int sradixsort(const unsigned char **, int, const unsigned char *,
338 unsigned);
339 void srandomdev(void);
340 long long
341 strtonum(const char *, long long, long long, const char **);
342 long long
343 strtonumx(const char *, long long, long long, const char **, int);
344
345 /* Deprecated interfaces, to be removed. */
346 __int64_t
347 strtoq(const char *, char **, int);
348 __uint64_t
349 strtouq(const char *, char **, int);
350
351 /*
352 * In FreeBSD 14, the prototype of qsort_r() was modified to comply with
353 * POSIX. The standardized qsort_r()'s order of last two parameters was
354 * changed, and the comparator function is now taking thunk as its last
355 * parameter, and both are different from the ones expected by the historical
356 * FreeBSD qsort_r() interface.
357 *
358 * Apply a workaround where we explicitly link against the historical interface,
359 * qsort_r@FBSD_1.0, in case when qsort_r() is called with the last parameter
360 * with a function pointer that exactly matches the historical FreeBSD qsort_r()
361 * comparator signature, so applications written for the historical interface
362 * can continue to work without modification. Toolchains that don't support
363 * symbol versioning don't define __sym_compat, so only provide this symbol in
364 * supported environments.
365 */
366 #ifdef __sym_compat
367 #if defined(__generic) || defined(__cplusplus)
368 void __qsort_r_compat(void *, size_t, size_t, void *,
369 int (*)(void *, const void *, const void *));
370 __sym_compat(qsort_r, __qsort_r_compat, FBSD_1.0);
371 #endif
372 #endif
373 #if defined(__generic) && !defined(__cplusplus)
374 #define qsort_r(base, nel, width, arg4, arg5) \
375 __generic(arg5, int (*)(void *, const void *, const void *), \
376 __qsort_r_compat, qsort_r)(base, nel, width, arg4, arg5)
377 #elif defined(__cplusplus) && defined(__sym_compat)
378 __END_DECLS
379 extern "C++" {
qsort_r(void * base,size_t nmemb,size_t size,void * thunk,int (* compar)(void *,const void *,const void *))380 static inline void qsort_r(void *base, size_t nmemb, size_t size,
381 void *thunk, int (*compar)(void *, const void *, const void *)) {
382 __qsort_r_compat(base, nmemb, size, thunk, compar);
383 }
384 }
385 __BEGIN_DECLS
386 #endif
387
388 extern char *suboptarg; /* getsubopt(3) external variable */
389 #endif /* __BSD_VISIBLE */
390
391 #if __EXT1_VISIBLE
392
393 #ifndef _RSIZE_T_DEFINED
394 #define _RSIZE_T_DEFINED
395 typedef size_t rsize_t;
396 #endif
397
398 #ifndef _ERRNO_T_DEFINED
399 #define _ERRNO_T_DEFINED
400 typedef int errno_t;
401 #endif
402
403 /* K.3.6 */
404 typedef void (*constraint_handler_t)(const char * __restrict,
405 void * __restrict, errno_t);
406 /* K.3.6.1.1 */
407 constraint_handler_t set_constraint_handler_s(constraint_handler_t handler);
408 /* K.3.6.1.2 */
409 _Noreturn void abort_handler_s(const char * __restrict, void * __restrict,
410 errno_t);
411 /* K3.6.1.3 */
412 void ignore_handler_s(const char * __restrict, void * __restrict, errno_t);
413 /* K.3.6.3.2 */
414 void *bsearch_s(const void *, const void *, rsize_t, rsize_t,
415 int (*)(const void *, const void *, void *), void *);
416 /* K.3.6.3.3 */
417 errno_t qsort_s(void *, rsize_t, rsize_t,
418 int (*)(const void *, const void *, void *), void *);
419 #endif /* __EXT1_VISIBLE */
420
421 __END_DECLS
422 __NULLABILITY_PRAGMA_POP
423
424 #if defined(__qualsel) && !defined(__cplusplus) && \
425 defined(__STDC_VERSION__) && __STDC_VERSION__ >= 202311L
426 #define bsearch(key, base, nmemb, size, compar) __qualsel((base), \
427 (const void *)(bsearch)((key), (base), (nmemb), (size), (compar)), \
428 (bsearch)((key), (base), (nmemb), (size), (compar)))
429 #ifdef __BLOCKS__
430 #define bsearch_b(key, base, nmemb, size, compar) __qualsel((base), \
431 (const void *)(bsearch_b)((key), (base), (nmemb), (size), (compar)), \
432 (bsearch_b)((key), (base), (nmemb), (size), (compar)))
433 #endif
434 #if __EXT1_VISIBLE
435 #define bsearch_s(key, base, nmemb, size, compar, context) \
436 __qualsel((base), \
437 (const void *)(bsearch_s)((key), (base), (nmemb), (size), \
438 (compar), (context)), \
439 (bsearch_s)((key), (base), (nmemb), (size), (compar), (context)))
440 #endif
441 #endif
442
443 #endif /* !_STDLIB_H_ */
444