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 long labs(long) __pure2;
99 ldiv_t ldiv(long, long) __pure2;
100 void *malloc(size_t) __malloc_like __result_use_check __alloc_size(1);
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 (* _Nonnull)(const void *, const void *));
106 int rand(void);
107 void *realloc(void *, size_t) __result_use_check __alloc_size(2);
108 void srand(unsigned);
109 double strtod(const char * __restrict, char ** __restrict);
110 float strtof(const char * __restrict, char ** __restrict);
111 long strtol(const char * __restrict, char ** __restrict, int);
112 long double
113 strtold(const char * __restrict, char ** __restrict);
114 unsigned long
115 strtoul(const char * __restrict, char ** __restrict, int);
116 int system(const char *);
117 int wctomb(char *, wchar_t);
118 size_t wcstombs(char * __restrict, const wchar_t * __restrict, size_t);
119
120 /*
121 * Functions added in C99 which we make conditionally available in the
122 * BSD^C89 namespace if the compiler supports `long long'.
123 * The #if test is more complicated than it ought to be because
124 * __BSD_VISIBLE implies __ISO_C_VISIBLE == 1999 *even if* `long long'
125 * is not supported in the compilation environment (which therefore means
126 * that it can't really be ISO C99).
127 *
128 * (The only other extension made by C99 in this header is _Exit().)
129 */
130 #if __ISO_C_VISIBLE >= 1999 || defined(__cplusplus)
131 #ifdef __LONG_LONG_SUPPORTED
132 /* LONGLONG */
133 typedef struct {
134 long long quot;
135 long long rem;
136 } lldiv_t;
137
138 /* LONGLONG */
139 long long
140 atoll(const char *);
141 /* LONGLONG */
142 long long
143 llabs(long long) __pure2;
144 /* LONGLONG */
145 lldiv_t lldiv(long long, long long) __pure2;
146 /* LONGLONG */
147 long long
148 strtoll(const char * __restrict, char ** __restrict, int);
149 /* LONGLONG */
150 unsigned long long
151 strtoull(const char * __restrict, char ** __restrict, int);
152 #endif /* __LONG_LONG_SUPPORTED */
153
154 _Noreturn void _Exit(int) __noexcept;
155 #endif /* __ISO_C_VISIBLE >= 1999 */
156
157 /*
158 * If we're in a mode greater than C99, expose C11 functions.
159 */
160 #if __ISO_C_VISIBLE >= 2011 || __cplusplus >= 201103L
161 void * aligned_alloc(size_t, size_t) __malloc_like __alloc_align(1)
162 __alloc_size(2);
163 int at_quick_exit(void (*)(void)) __noexcept;
164 _Noreturn void
165 quick_exit(int) /* __noexcept -- not ready ABI issues? */;
166 #endif /* __ISO_C_VISIBLE >= 2011 */
167 /*
168 * Extensions made by POSIX relative to C.
169 */
170 #if __POSIX_VISIBLE >= 199506 || __XSI_VISIBLE
171 char *realpath(const char * __restrict, char * __restrict);
172 #endif
173 #if __POSIX_VISIBLE >= 199506
174 int rand_r(unsigned *); /* (TSF) */
175 #endif
176 #if __POSIX_VISIBLE >= 200112
177 int posix_memalign(void **, size_t, size_t); /* (ADV) */
178 int setenv(const char *, const char *, int);
179 int unsetenv(const char *);
180 #endif
181
182 #if __POSIX_VISIBLE >= 200809 || __XSI_VISIBLE
183 int getsubopt(char **, char *const *, char **);
184 #ifndef _MKDTEMP_DECLARED
185 char *mkdtemp(char *);
186 #define _MKDTEMP_DECLARED
187 #endif
188 #ifndef _MKSTEMP_DECLARED
189 int mkstemp(char *);
190 #define _MKSTEMP_DECLARED
191 #endif
192 #endif /* __POSIX_VISIBLE >= 200809 || __XSI_VISIBLE */
193
194 /*
195 * The only changes to the XSI namespace in revision 6 were the deletion
196 * of the ttyslot() and valloc() functions, which FreeBSD never declared
197 * in this header. For revision 7, ecvt(), fcvt(), and gcvt(), which
198 * FreeBSD also does not have, and mktemp(), are to be deleted.
199 */
200 #if __XSI_VISIBLE
201 /* XXX XSI requires pollution from <sys/wait.h> here. We'd rather not. */
202 long a64l(const char *);
203 double drand48(void);
204 /* char *ecvt(double, int, int * __restrict, int * __restrict); */
205 double erand48(unsigned short[3]);
206 /* char *fcvt(double, int, int * __restrict, int * __restrict); */
207 /* char *gcvt(double, int, int * __restrict, int * __restrict); */
208 char *initstate(unsigned int, char *, size_t);
209 long jrand48(unsigned short[3]);
210 char *l64a(long);
211 void lcong48(unsigned short[7]);
212 long lrand48(void);
213 #if !defined(_MKTEMP_DECLARED) && (__BSD_VISIBLE || __XSI_VISIBLE <= 600)
214 char *mktemp(char *);
215 #define _MKTEMP_DECLARED
216 #endif
217 long mrand48(void);
218 long nrand48(unsigned short[3]);
219 int putenv(char *);
220 long random(void);
221 unsigned short
222 *seed48(unsigned short[3]);
223 char *setstate(/* const */ char *);
224 void srand48(long);
225 void srandom(unsigned int);
226 #endif /* __XSI_VISIBLE */
227
228 #if __XSI_VISIBLE
229 int grantpt(int);
230 int posix_openpt(int);
231 char *ptsname(int);
232 int unlockpt(int);
233 #endif /* __XSI_VISIBLE */
234 #if __BSD_VISIBLE
235 /* ptsname_r will be included in POSIX issue 8 */
236 int ptsname_r(int, char *, size_t);
237 #endif
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 * On platforms where alloca() is not in libc, programs which use it
248 * will fail to link when compiled with non-GNU compilers.
249 */
250 #if __GNUC__ >= 2
251 #undef alloca /* some GNU bits try to get cute and define this on their own */
252 #define alloca(sz) __builtin_alloca(sz)
253 #endif
254
255 void abort2(const char *, int, void **) __dead2;
256 __uint32_t
257 arc4random(void);
258 void arc4random_buf(void *, size_t);
259 __uint32_t
260 arc4random_uniform(__uint32_t);
261
262 #ifdef __BLOCKS__
263 int atexit_b(void (^ _Nonnull)(void));
264 void *bsearch_b(const void *, const void *, size_t,
265 size_t, int (^ _Nonnull)(const void *, const void *));
266 #endif
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 clearenv(void);
281
282 int daemon(int, int);
283 int daemonfd(int, int);
284 char *devname(__dev_t, __mode_t);
285 char *devname_r(__dev_t, __mode_t, char *, int);
286 char *fdevname(int);
287 char *fdevname_r(int, char *, int);
288 int getloadavg(double [], int);
289 const char *
290 getprogname(void);
291
292 int heapsort(void *, size_t, size_t,
293 int (* _Nonnull)(const void *, const void *));
294 #ifdef __BLOCKS__
295 int heapsort_b(void *, size_t, size_t,
296 int (^ _Nonnull)(const void *, const void *));
297 void qsort_b(void *, size_t, size_t,
298 int (^ _Nonnull)(const void *, const void *));
299 #endif
300 int l64a_r(long, char *, int);
301 int mergesort(void *, size_t, size_t, int (*)(const void *, const void *));
302 #ifdef __BLOCKS__
303 int mergesort_b(void *, size_t, size_t, int (^)(const void *, const void *));
304 #endif
305 int mkostemp(char *, int);
306 int mkostemps(char *, int, int);
307 int mkostempsat(int, char *, int, int);
308 void qsort_r(void *, size_t, size_t,
309 int (*)(const void *, const void *, void *), void *);
310 int radixsort(const unsigned char **, int, const unsigned char *,
311 unsigned);
312 void *reallocarray(void *, size_t, size_t) __result_use_check
313 __alloc_size2(2, 3);
314 void *reallocf(void *, size_t) __result_use_check __alloc_size(2);
315 int rpmatch(const char *);
316 char *secure_getenv(const char *);
317 void setprogname(const char *);
318 int sradixsort(const unsigned char **, int, const unsigned char *,
319 unsigned);
320 void srandomdev(void);
321 long long
322 strtonum(const char *, long long, long long, const char **);
323
324 /* Deprecated interfaces, to be removed. */
325 __int64_t
326 strtoq(const char *, char **, int);
327 __uint64_t
328 strtouq(const char *, char **, int);
329
330 /*
331 * In FreeBSD 14, the prototype of qsort_r() was modified to comply with
332 * POSIX. The standardized qsort_r()'s order of last two parameters was
333 * changed, and the comparator function is now taking thunk as its last
334 * parameter, and both are different from the ones expected by the historical
335 * FreeBSD qsort_r() interface.
336 *
337 * Apply a workaround where we explicitly link against the historical interface,
338 * qsort_r@FBSD_1.0, in case when qsort_r() is called with the last parameter
339 * with a function pointer that exactly matches the historical FreeBSD qsort_r()
340 * comparator signature, so applications written for the historical interface
341 * can continue to work without modification. Toolchains that don't support
342 * symbol versioning don't define __sym_compat, so only provide this symbol in
343 * supported environments.
344 */
345 #ifdef __sym_compat
346 #if defined(__generic) || defined(__cplusplus)
347 void __qsort_r_compat(void *, size_t, size_t, void *,
348 int (*)(void *, const void *, const void *));
349 __sym_compat(qsort_r, __qsort_r_compat, FBSD_1.0);
350 #endif
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) && defined(__sym_compat)
357 __END_DECLS
358 extern "C++" {
qsort_r(void * base,size_t nmemb,size_t size,void * thunk,int (* compar)(void *,const void *,const void *))359 static 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
367 extern 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
374 typedef size_t rsize_t;
375 #endif
376
377 #ifndef _ERRNO_T_DEFINED
378 #define _ERRNO_T_DEFINED
379 typedef int errno_t;
380 #endif
381
382 /* K.3.6 */
383 typedef void (*constraint_handler_t)(const char * __restrict,
384 void * __restrict, errno_t);
385 /* K.3.6.1.1 */
386 constraint_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 */
391 void ignore_handler_s(const char * __restrict, void * __restrict, errno_t);
392 /* K.3.6.3.2 */
393 errno_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