]> git.saurik.com Git - apple/libc.git/blame - include/stdlib.h
Libc-1244.1.7.tar.gz
[apple/libc.git] / include / stdlib.h
CommitLineData
5b2abdfb 1/*
b5d655f7 2 * Copyright (c) 2000, 2002 - 2008 Apple Inc. All rights reserved.
5b2abdfb
A
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
734aad71
A
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. Please obtain a copy of the License at
10 * http://www.opensource.apple.com/apsl/ and read it before using this
11 * file.
12 *
13 * The Original Code and all software distributed under the License are
14 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
5b2abdfb
A
15 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
16 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
734aad71
A
17 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
18 * Please see the License for the specific language governing rights and
19 * limitations under the License.
5b2abdfb
A
20 *
21 * @APPLE_LICENSE_HEADER_END@
22 */
23/*-
24 * Copyright (c) 1990, 1993
25 * The Regents of the University of California. All rights reserved.
26 *
27 * Redistribution and use in source and binary forms, with or without
28 * modification, are permitted provided that the following conditions
29 * are met:
30 * 1. Redistributions of source code must retain the above copyright
31 * notice, this list of conditions and the following disclaimer.
32 * 2. Redistributions in binary form must reproduce the above copyright
33 * notice, this list of conditions and the following disclaimer in the
34 * documentation and/or other materials provided with the distribution.
35 * 3. All advertising materials mentioning features or use of this software
36 * must display the following acknowledgement:
37 * This product includes software developed by the University of
38 * California, Berkeley and its contributors.
39 * 4. Neither the name of the University nor the names of its contributors
40 * may be used to endorse or promote products derived from this software
41 * without specific prior written permission.
42 *
43 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
44 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
45 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
46 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
47 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
48 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
49 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
50 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
51 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
52 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
53 * SUCH DAMAGE.
54 *
55 * @(#)stdlib.h 8.5 (Berkeley) 5/19/95
56 */
57
58#ifndef _STDLIB_H_
59#define _STDLIB_H_
60
b5d655f7 61#include <Availability.h>
224c7076 62
3d9156a7
A
63#include <_types.h>
64#if !defined(_ANSI_SOURCE)
65#include <sys/wait.h>
224c7076 66#if (!defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE))
9385eb3d 67#include <alloca.h>
224c7076 68#endif /* (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
3d9156a7 69#endif /* !_ANSI_SOURCE */
5b2abdfb 70
3d9156a7
A
71/* DO NOT REMOVE THIS COMMENT: fixincludes needs to see:
72 * _GCC_SIZE_T */
6465356a 73#include <sys/_types/_size_t.h>
5b2abdfb 74
224c7076 75#if !defined(_ANSI_SOURCE) && (!defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE))
6465356a
A
76#include <sys/_types/_ct_rune_t.h>
77#include <sys/_types/_rune_t.h>
224c7076 78#endif /* !_ANSI_SOURCE && (!_POSIX_C_SOURCE || _DARWIN_C_SOURCE) */
5b2abdfb 79
6465356a 80#include <sys/_types/_wchar_t.h>
9385eb3d 81
5b2abdfb
A
82typedef struct {
83 int quot; /* quotient */
84 int rem; /* remainder */
85} div_t;
86
87typedef struct {
88 long quot; /* quotient */
89 long rem; /* remainder */
90} ldiv_t;
91
3d9156a7
A
92#if !__DARWIN_NO_LONG_LONG
93typedef struct {
94 long long quot;
95 long long rem;
96} lldiv_t;
97#endif /* !__DARWIN_NO_LONG_LONG */
98
6465356a 99#include <sys/_types/_null.h>
5b2abdfb
A
100
101#define EXIT_FAILURE 1
102#define EXIT_SUCCESS 0
103
104#define RAND_MAX 0x7fffffff
105
3d9156a7
A
106#ifdef _USE_EXTENDED_LOCALES_
107#include <_xlocale.h>
108#endif /* _USE_EXTENDED_LOCALES_ */
109
110#ifndef MB_CUR_MAX
111#ifdef _USE_EXTENDED_LOCALES_
112#define MB_CUR_MAX (___mb_cur_max())
113#ifndef MB_CUR_MAX_L
114#define MB_CUR_MAX_L(x) (___mb_cur_max_l(x))
115#endif /* !MB_CUR_MAX_L */
116#else /* !_USE_EXTENDED_LOCALES_ */
5b2abdfb
A
117extern int __mb_cur_max;
118#define MB_CUR_MAX __mb_cur_max
3d9156a7
A
119#endif /* _USE_EXTENDED_LOCALES_ */
120#endif /* MB_CUR_MAX */
5b2abdfb 121
224c7076 122#if !defined(_ANSI_SOURCE) && (!defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)) \
3d9156a7
A
123 && defined(_USE_EXTENDED_LOCALES_) && !defined(MB_CUR_MAX_L)
124#define MB_CUR_MAX_L(x) (___mb_cur_max_l(x))
125#endif
34e8f829 126//Begin-Libc
5f125488 127#include "libc_private.h"
34e8f829
A
128/* f must be a literal string */
129#define LIBC_ABORT(f,...) abort_report_np("%s:%s:%u: " f, __FILE__, __func__, __LINE__, ## __VA_ARGS__)
130//End-Libc
5b2abdfb 131
b061a43b
A
132#ifndef __alloc_size
133#if __has_attribute(alloc_size)
134#define __alloc_size(...) __attribute__((alloc_size(__VA_ARGS__)))
135#else
136#define __alloc_size(...)
137#endif
138#endif // __alloc_size
139
5b2abdfb 140__BEGIN_DECLS
9385eb3d
A
141void abort(void) __dead2;
142int abs(int) __pure2;
974e3884 143int atexit(void (* _Nonnull)(void));
9385eb3d
A
144double atof(const char *);
145int atoi(const char *);
146long atol(const char *);
3d9156a7
A
147#if !__DARWIN_NO_LONG_LONG
148long long
149 atoll(const char *);
150#endif /* !__DARWIN_NO_LONG_LONG */
974e3884
A
151void *bsearch(const void *__key, const void *__base, size_t __nel,
152 size_t __width, int (* _Nonnull __compar)(const void *, const void *));
b061a43b 153void *calloc(size_t __count, size_t __size) __result_use_check __alloc_size(1,2);
9385eb3d
A
154div_t div(int, int) __pure2;
155void exit(int) __dead2;
156void free(void *);
157char *getenv(const char *);
158long labs(long) __pure2;
159ldiv_t ldiv(long, long) __pure2;
3d9156a7
A
160#if !__DARWIN_NO_LONG_LONG
161long long
162 llabs(long long);
163lldiv_t lldiv(long long, long long);
164#endif /* !__DARWIN_NO_LONG_LONG */
b061a43b 165void *malloc(size_t __size) __result_use_check __alloc_size(1);
974e3884 166int mblen(const char *__s, size_t __n);
9385eb3d
A
167size_t mbstowcs(wchar_t * __restrict , const char * __restrict, size_t);
168int mbtowc(wchar_t * __restrict, const char * __restrict, size_t);
974e3884
A
169int posix_memalign(void **__memptr, size_t __alignment, size_t __size) __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_3_0);
170void qsort(void *__base, size_t __nel, size_t __width,
171 int (* _Nonnull __compar)(const void *, const void *));
172int rand(void) __swift_unavailable("Use arc4random instead.");
b061a43b 173void *realloc(void *__ptr, size_t __size) __result_use_check __alloc_size(2);
974e3884 174void srand(unsigned) __swift_unavailable("Use arc4random instead.");
224c7076
A
175double strtod(const char *, char **) __DARWIN_ALIAS(strtod);
176float strtof(const char *, char **) __DARWIN_ALIAS(strtof);
974e3884 177long strtol(const char *__str, char **__endptr, int __base);
9385eb3d 178long double
ad3c9f2a 179 strtold(const char *, char **);
3d9156a7
A
180#if !__DARWIN_NO_LONG_LONG
181long long
974e3884 182 strtoll(const char *__str, char **__endptr, int __base);
3d9156a7 183#endif /* !__DARWIN_NO_LONG_LONG */
5b2abdfb 184unsigned long
974e3884 185 strtoul(const char *__str, char **__endptr, int __base);
3d9156a7
A
186#if !__DARWIN_NO_LONG_LONG
187unsigned long long
974e3884 188 strtoull(const char *__str, char **__endptr, int __base);
3d9156a7 189#endif /* !__DARWIN_NO_LONG_LONG */
224c7076
A
190//Begin-Libc
191#ifndef LIBC_ALIAS_SYSTEM
192//End-Libc
974e3884
A
193
194#if TARGET_OS_EMBEDDED
195#define __swift_unavailable_on(osx_msg, ios_msg) __swift_unavailable(ios_msg)
196#else
197#define __swift_unavailable_on(osx_msg, ios_msg) __swift_unavailable(osx_msg)
198#endif
199
200__swift_unavailable_on("Use posix_spawn APIs or NSTask instead.", "Process spawning is unavailable")
b061a43b 201__API_AVAILABLE(macos(10.0)) __IOS_PROHIBITED
974e3884
A
202__WATCHOS_PROHIBITED __TVOS_PROHIBITED
203int system(const char *) __DARWIN_ALIAS_C(system);
224c7076
A
204//Begin-Libc
205#else /* LIBC_ALIAS_SYSTEM */
206int system(const char *) LIBC_ALIAS_C(system);
207#endif /* !LIBC_ALIAS_SYSTEM */
208//End-Libc
974e3884
A
209
210#undef __swift_unavailable_on
211
9385eb3d 212size_t wcstombs(char * __restrict, const wchar_t * __restrict, size_t);
3d9156a7 213int wctomb(char *, wchar_t);
5b2abdfb
A
214
215#ifndef _ANSI_SOURCE
3d9156a7
A
216void _Exit(int) __dead2;
217long a64l(const char *);
9385eb3d 218double drand48(void);
3d9156a7 219char *ecvt(double, int, int *__restrict, int *__restrict); /* LEGACY */
974e3884 220double erand48(unsigned short[3]);
3d9156a7
A
221char *fcvt(double, int, int *__restrict, int *__restrict); /* LEGACY */
222char *gcvt(double, int, char *); /* LEGACY */
223int getsubopt(char **, char * const *, char **);
224int grantpt(int);
225#if __DARWIN_UNIX03
226char *initstate(unsigned, char *, size_t); /* no __DARWIN_ALIAS needed */
227#else /* !__DARWIN_UNIX03 */
228char *initstate(unsigned long, char *, long);
229#endif /* __DARWIN_UNIX03 */
974e3884 230long jrand48(unsigned short[3]) __swift_unavailable("Use arc4random instead.");
3d9156a7 231char *l64a(long);
9385eb3d 232void lcong48(unsigned short[7]);
974e3884 233long lrand48(void) __swift_unavailable("Use arc4random instead.");
3d9156a7
A
234char *mktemp(char *);
235int mkstemp(char *);
974e3884
A
236long mrand48(void) __swift_unavailable("Use arc4random instead.");
237long nrand48(unsigned short[3]) __swift_unavailable("Use arc4random instead.");
3d9156a7
A
238int posix_openpt(int);
239char *ptsname(int);
224c7076
A
240//Begin-Libc
241#ifndef LIBC_ALIAS_PUTENV
242//End-Libc
3d9156a7 243int putenv(char *) __DARWIN_ALIAS(putenv);
224c7076
A
244//Begin-Libc
245#else /* LIBC_ALIAS_PUTENV */
246int putenv(char *) LIBC_ALIAS(putenv);
247#endif /* !LIBC_ALIAS_PUTENV */
248//End-Libc
974e3884
A
249long random(void) __swift_unavailable("Use arc4random instead.");
250int rand_r(unsigned *) __swift_unavailable("Use arc4random instead.");
224c7076
A
251//Begin-Libc
252#ifdef __LIBC__
253#ifndef LIBC_ALIAS_REALPATH
254char *realpath(const char * __restrict, char * __restrict) __DARWIN_EXTSN(realpath);
255#else /* LIBC_ALIAS_REALPATH */
256#ifdef VARIANT_DARWINEXTSN
257char *realpath(const char * __restrict, char * __restrict) LIBC_EXTSN(realpath);
258#else /* !VARIANT_DARWINEXTSN */
259char *realpath(const char * __restrict, char * __restrict) LIBC_ALIAS(realpath);
260#endif /* VARIANT_DARWINEXTSN */
261#endif /* !LIBC_ALIAS_REALPATH */
262#else /* !__LIBC__ */
263//End-Libc
264#if (__DARWIN_UNIX03 && !defined(_POSIX_C_SOURCE)) || defined(_DARWIN_C_SOURCE) || defined(_DARWIN_BETTER_REALPATH)
265char *realpath(const char * __restrict, char * __restrict) __DARWIN_EXTSN(realpath);
266#else /* (!__DARWIN_UNIX03 || _POSIX_C_SOURCE) && !_DARWIN_C_SOURCE && !_DARWIN_BETTER_REALPATH */
267char *realpath(const char * __restrict, char * __restrict) __DARWIN_ALIAS(realpath);
268#endif /* (__DARWIN_UNIX03 && _POSIX_C_SOURCE) || _DARWIN_C_SOURCE || _DARWIN_BETTER_REALPATH */
269//Begin-Libc
270#endif /* __LIBC__ */
271//End-Libc
9385eb3d
A
272unsigned short
273 *seed48(unsigned short[3]);
224c7076
A
274//Begin-Libc
275#ifndef LIBC_ALIAS_SETENV
276//End-Libc
974e3884 277int setenv(const char * __name, const char * __value, int __overwrite) __DARWIN_ALIAS(setenv);
224c7076
A
278//Begin-Libc
279#else /* LIBC_ALIAS_SETENV */
974e3884 280int setenv(const char * __name, const char * __value, int __overwrite) LIBC_ALIAS(setenv);
224c7076
A
281#endif /* !LIBC_ALIAS_SETENV */
282//End-Libc
3d9156a7 283#if __DARWIN_UNIX03
224c7076
A
284//Begin-Libc
285#ifndef LIBC_ALIAS_SETKEY
286//End-Libc
3d9156a7 287void setkey(const char *) __DARWIN_ALIAS(setkey);
224c7076
A
288//Begin-Libc
289#else /* LIBC_ALIAS_SETKEY */
290void setkey(const char *) LIBC_ALIAS(setkey);
291#endif /* !LIBC_ALIAS_SETKEY */
292//End-Libc
3d9156a7
A
293#else /* !__DARWIN_UNIX03 */
294int setkey(const char *);
295#endif /* __DARWIN_UNIX03 */
296char *setstate(const char *);
9385eb3d 297void srand48(long);
3d9156a7
A
298#if __DARWIN_UNIX03
299void srandom(unsigned);
300#else /* !__DARWIN_UNIX03 */
301void srandom(unsigned long);
302#endif /* __DARWIN_UNIX03 */
303int unlockpt(int);
304#if __DARWIN_UNIX03
224c7076
A
305//Begin-Libc
306#ifndef LIBC_ALIAS_UNSETENV
307//End-Libc
3d9156a7 308int unsetenv(const char *) __DARWIN_ALIAS(unsetenv);
224c7076
A
309//Begin-Libc
310#else /* LIBC_ALIAS_UNSETENV */
311int unsetenv(const char *) LIBC_ALIAS(unsetenv);
312#endif /* !LIBC_ALIAS_UNSETENV */
313//End-Libc
3d9156a7
A
314#else /* !__DARWIN_UNIX03 */
315void unsetenv(const char *);
316#endif /* __DARWIN_UNIX03 */
224c7076 317#endif /* !_ANSI_SOURCE */
3d9156a7 318
224c7076 319#if !defined(_ANSI_SOURCE) && (!defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE))
3d9156a7
A
320#include <machine/types.h>
321
6465356a
A
322#include <sys/_types/_dev_t.h>
323#include <sys/_types/_mode_t.h>
974e3884 324#include <_types/_uint32_t.h>
3d9156a7 325
974e3884
A
326uint32_t arc4random(void);
327void arc4random_addrandom(unsigned char * /*dat*/, int /*datlen*/)
328 __OSX_DEPRECATED(10.0, 10.12, "use arc4random_stir")
329 __IOS_DEPRECATED(2.0, 10.0, "use arc4random_stir")
330 __TVOS_DEPRECATED(2.0, 10.0, "use arc4random_stir")
331 __WATCHOS_DEPRECATED(1.0, 3.0, "use arc4random_stir");
332void arc4random_buf(void * __buf, size_t __nbytes) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
3d9156a7 333void arc4random_stir(void);
974e3884
A
334uint32_t
335 arc4random_uniform(uint32_t __upper_bound) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_4_3);
34e8f829 336#ifdef __BLOCKS__
974e3884
A
337int atexit_b(void (^ _Nonnull)(void)) __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_3_2);
338void *bsearch_b(const void *__key, const void *__base, size_t __nel,
339 size_t __width, int (^ _Nonnull __compar)(const void *, const void *)) __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_3_2);
34e8f829 340#endif /* __BLOCKS__ */
9385eb3d
A
341
342 /* getcap(3) functions */
343char *cgetcap(char *, const char *, int);
344int cgetclose(void);
345int cgetent(char **, char **, const char *);
346int cgetfirst(char **, char **);
347int cgetmatch(const char *, const char *);
348int cgetnext(char **, char **);
349int cgetnum(char *, const char *, long *);
350int cgetset(const char *);
351int cgetstr(char *, const char *, char **);
352int cgetustr(char *, const char *, char **);
353
5f125488 354int daemon(int, int) __DARWIN_1050(daemon) __OSX_AVAILABLE_BUT_DEPRECATED_MSG(__MAC_10_0, __MAC_10_5, __IPHONE_2_0, __IPHONE_2_0, "Use posix_spawn APIs instead.") __WATCHOS_PROHIBITED __TVOS_PROHIBITED;
3d9156a7
A
355char *devname(dev_t, mode_t);
356char *devname_r(dev_t, mode_t, char *buf, int len);
9385eb3d
A
357char *getbsize(int *, long *);
358int getloadavg(double [], int);
359const char
360 *getprogname(void);
361
974e3884
A
362int heapsort(void *__base, size_t __nel, size_t __width,
363 int (* _Nonnull __compar)(const void *, const void *));
34e8f829 364#ifdef __BLOCKS__
974e3884
A
365int heapsort_b(void *__base, size_t __nel, size_t __width,
366 int (^ _Nonnull __compar)(const void *, const void *)) __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_3_2);
34e8f829 367#endif /* __BLOCKS__ */
974e3884
A
368int mergesort(void *__base, size_t __nel, size_t __width,
369 int (* _Nonnull __compar)(const void *, const void *));
34e8f829 370#ifdef __BLOCKS__
974e3884
A
371int mergesort_b(void *__base, size_t __nel, size_t __width,
372 int (^ _Nonnull __compar)(const void *, const void *)) __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_3_2);
34e8f829 373#endif /* __BLOCKS__ */
974e3884
A
374void psort(void *__base, size_t __nel, size_t __width,
375 int (* _Nonnull __compar)(const void *, const void *)) __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_3_2);
34e8f829 376#ifdef __BLOCKS__
974e3884
A
377void psort_b(void *__base, size_t __nel, size_t __width,
378 int (^ _Nonnull __compar)(const void *, const void *)) __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_3_2);
34e8f829 379#endif /* __BLOCKS__ */
974e3884
A
380void psort_r(void *__base, size_t __nel, size_t __width, void *,
381 int (* _Nonnull __compar)(void *, const void *, const void *)) __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_3_2);
34e8f829 382#ifdef __BLOCKS__
974e3884
A
383void qsort_b(void *__base, size_t __nel, size_t __width,
384 int (^ _Nonnull __compar)(const void *, const void *)) __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_3_2);
34e8f829 385#endif /* __BLOCKS__ */
974e3884
A
386void qsort_r(void *__base, size_t __nel, size_t __width, void *,
387 int (* _Nonnull __compar)(void *, const void *, const void *));
388int radixsort(const unsigned char **__base, int __nel, const unsigned char *__table,
389 unsigned __endbyte);
9385eb3d 390void setprogname(const char *);
974e3884
A
391int sradixsort(const unsigned char **__base, int __nel, const unsigned char *__table,
392 unsigned __endbyte);
9385eb3d
A
393void sranddev(void);
394void srandomdev(void);
b061a43b 395void *reallocf(void *__ptr, size_t __size) __alloc_size(2);
3d9156a7 396#if !__DARWIN_NO_LONG_LONG
5b2abdfb 397long long
974e3884 398 strtoq(const char *__str, char **__endptr, int __base);
5b2abdfb 399unsigned long long
974e3884 400 strtouq(const char *__str, char **__endptr, int __base);
3d9156a7
A
401#endif /* !__DARWIN_NO_LONG_LONG */
402extern char *suboptarg; /* getsubopt(3) external variable */
b061a43b 403void *valloc(size_t) __alloc_size(1);
224c7076
A
404#endif /* !_ANSI_SOURCE && !_POSIX_SOURCE */
405
406/* Poison the following routines if -fshort-wchar is set */
407#if !defined(__cplusplus) && defined(__WCHAR_MAX__) && __WCHAR_MAX__ <= 0xffffU
408#pragma GCC poison mbstowcs mbtowc wcstombs wctomb
5b2abdfb
A
409#endif
410__END_DECLS
411
3d9156a7
A
412#ifdef _USE_EXTENDED_LOCALES_
413#include <xlocale/_stdlib.h>
414#endif /* _USE_EXTENDED_LOCALES_ */
415
5b2abdfb 416#endif /* _STDLIB_H_ */