libc -- stdlib: Implement quick_exit and at_quick_exit from C11.
[dragonfly.git] / include / stdlib.h
CommitLineData
984263bc
MD
1/*-
2 * Copyright (c) 1990, 1993
3 * The Regents of the University of California. All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 * must display the following acknowledgement:
15 * This product includes software developed by the University of
16 * California, Berkeley and its contributors.
17 * 4. Neither the name of the University nor the names of its contributors
18 * may be used to endorse or promote products derived from this software
19 * without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
32 *
33 * @(#)stdlib.h 8.5 (Berkeley) 5/19/95
5d0641a4 34 * $FreeBSD: src/include/stdlib.h,v 1.67 2008/07/22 11:40:42 ache Exp $
e4dcda4d 35 * $DragonFly: src/include/stdlib.h,v 1.22 2008/06/05 17:53:10 swildner Exp $
984263bc
MD
36 */
37
38#ifndef _STDLIB_H_
39#define _STDLIB_H_
40
41#include <sys/cdefs.h>
5d0641a4 42#include <sys/_null.h>
fa261b1d 43#include <sys/types.h>
984263bc 44
5d0641a4
PA
45#ifndef _SIZE_T_DECLARED
46typedef __size_t size_t;
47#define _SIZE_T_DECLARED
e2565a42 48#endif
984263bc 49
5d0641a4 50#ifndef __cplusplus
a81b3ef3 51#ifndef _WCHAR_T_DECLARED
5d0641a4
PA
52typedef __wchar_t wchar_t;
53#define _WCHAR_T_DECLARED
984263bc 54#endif
984263bc 55#endif
e2565a42 56
984263bc 57typedef struct {
5d0641a4
PA
58 int quot; /* quotient */
59 int rem; /* remainder */
984263bc
MD
60} div_t;
61
62typedef struct {
5d0641a4
PA
63 long quot;
64 long rem;
984263bc
MD
65} ldiv_t;
66
984263bc
MD
67#define EXIT_FAILURE 1
68#define EXIT_SUCCESS 0
69
70#define RAND_MAX 0x7fffffff
71
72extern int __mb_cur_max;
73#define MB_CUR_MAX __mb_cur_max
74
75__BEGIN_DECLS
5baeefc7 76void abort(void) __dead2;
5d0641a4 77/* void abort2(const char *, int, void **) __dead2; */
4d42eed2 78#if !defined(_KERNEL_VIRTUAL)
5baeefc7 79int abs(int) __pure2;
4d42eed2 80#endif
5baeefc7
JS
81int atexit(void (*)(void));
82double atof(const char *);
83int atoi(const char *);
84long atol(const char *);
85void *bsearch(const void *, const void *, size_t,
86 size_t, int (*)(const void *, const void *));
87void *calloc(size_t, size_t);
88div_t div(int, int) __pure2;
89void exit(int) __dead2;
90void free(void *);
91char *getenv(const char *);
4d42eed2 92#if !defined(_KERNEL_VIRTUAL)
5baeefc7 93long labs(long) __pure2;
4d42eed2 94#endif
5baeefc7
JS
95ldiv_t ldiv(long, long) __pure2;
96void *malloc(size_t);
11e45f67 97int posix_memalign(void **, size_t, size_t);
5d0641a4
PA
98int mblen(const char *, size_t);
99size_t mbstowcs(wchar_t * __restrict , const char * __restrict, size_t);
100int mbtowc(wchar_t * __restrict, const char * __restrict, size_t);
101void qsort(void *, size_t, size_t, int (*)(const void *, const void *));
5baeefc7
JS
102int rand(void);
103void *realloc(void *, size_t);
104void srand(unsigned);
5d0641a4 105double strtod(const char * __restrict, char ** __restrict);
f202adf7 106float strtof(const char * __restrict, char ** __restrict);
5d0641a4
PA
107#if !defined(_KERNEL_VIRTUAL)
108long strtol(const char * __restrict, char ** __restrict, int);
984263bc 109#endif
f202adf7
PA
110long double
111 strtold(const char * __restrict, char ** __restrict);
44a09dd6 112#if !defined(_KERNEL_VIRTUAL)
5d0641a4
PA
113unsigned long
114 strtoul(const char * __restrict, char ** __restrict, int);
44a09dd6 115#endif
5d0641a4 116int system(const char *);
5baeefc7 117int wctomb(char *, wchar_t);
5d0641a4
PA
118size_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
131#ifdef __LONG_LONG_SUPPORTED
132/* LONGLONG */
133typedef struct {
134 long long quot;
135 long long rem;
136} lldiv_t;
984263bc 137
5d0641a4
PA
138/* LONGLONG */
139long long
140 atoll(const char *);
141/* LONGLONG */
142long long
143 llabs(long long) __pure2;
144/* LONGLONG */
145lldiv_t lldiv(long long, long long) __pure2;
146/* LONGLONG */
147long long
148 strtoll(const char * __restrict, char ** __restrict, int);
149/* LONGLONG */
150unsigned long long
151 strtoull(const char * __restrict, char ** __restrict, int);
152#endif /* __LONG_LONG_SUPPORTED */
153
154void _Exit(int) __dead2;
155#endif /* __ISO_C_VISIBLE >= 1999 */
156
157/*
158 * Extensions made by POSIX relative to C. We don't know yet which edition
159 * of POSIX made these extensions, so assume they've always been there until
160 * research can be done.
161 */
162#if __POSIX_VISIBLE /* >= ??? */
163/*int posix_memalign(void **, size_t, size_t); (ADV) */
164int rand_r(unsigned *); /* (TSF) */
5baeefc7 165int setenv(const char *, const char *, int);
5d0641a4
PA
166int unsetenv(const char *);
167#endif
5baeefc7 168
330f6769
SW
169#if __POSIX_VISIBLE >= 200809 || __XSI_VISIBLE
170#ifndef _MKDTEMP_DECLARED
171char *mkdtemp(char *);
172#define _MKDTEMP_DECLARED
173#endif
174#ifndef _MKSTEMP_DECLARED
175int mkstemp(char *);
176#define _MKSTEMP_DECLARED
177#endif
178#endif /* __POSIX_VISIBLE >= 200809 || __XSI_VISIBLE */
179
5d0641a4
PA
180/*
181 * The only changes to the XSI namespace in revision 6 were the deletion
182 * of the ttyslot() and valloc() functions, which we never declared
183 * in this header. For revision 7, ecvt(), fcvt(), and gcvt(), which
184 * we also do not have, and mktemp(), are to be deleted.
185 */
186#if __XSI_VISIBLE
187/* XXX XSI requires pollution from <sys/wait.h> here. We'd rather not. */
188long a64l(const char *);
5baeefc7 189double drand48(void);
5d0641a4 190/* char *ecvt(double, int, int * __restrict, int * __restrict); */
5baeefc7 191double erand48(unsigned short[3]);
5d0641a4
PA
192/* char *fcvt(double, int, int * __restrict, int * __restrict); */
193/* char *gcvt(double, int, int * __restrict, int * __restrict); */
194int getsubopt(char **, char *const *, char **);
c578a286 195int grantpt(int);
5d0641a4 196char *initstate(unsigned long /* XSI requires u_int */, char *, long);
5baeefc7 197long jrand48(unsigned short[3]);
5d0641a4 198char *l64a(long);
5baeefc7
JS
199void lcong48(unsigned short[7]);
200long lrand48(void);
330f6769
SW
201#if !defined(_MKTEMP_DECLARED) && (__BSD_VISIBLE || __XSI_VISIBLE <= 600)
202char *mktemp(char *);
203#define _MKTEMP_DECLARED
204#endif
5baeefc7
JS
205long mrand48(void);
206long nrand48(unsigned short[3]);
c578a286
AH
207int posix_openpt(int);
208char *ptsname(int);
5d0641a4
PA
209int putenv(char *);
210long random(void);
211char *realpath(const char *, char resolved_path[]);
212unsigned short
213 *seed48(unsigned short[3]);
214int setkey(const char *);
215char *setstate(/* const */ char *);
5baeefc7 216void srand48(long);
5d0641a4 217void srandom(unsigned long);
c578a286 218int unlockpt(int);
5d0641a4 219#endif /* __XSI_VISIBLE */
5baeefc7 220
5d0641a4
PA
221#if __BSD_VISIBLE
222/* extern const char *_malloc_options;
223extern void (*_malloc_message)(const char *, const char *, const char *,
224 const char *); */
225
226/*
227 * The alloca() function can't be implemented in C, and on some
228 * platforms it can't be implemented at all as a callable function.
229 * The GNU C compiler provides a built-in alloca() which we can use;
230 * in all other cases, provide a prototype, mainly to pacify various
231 * incarnations of lint. On platforms where alloca() is not in libc,
232 * programs which use it will fail to link when compiled with non-GNU
233 * compilers.
234 */
235#if __GNUC__ >= 2 || defined(__INTEL_COMPILER)
236#undef alloca /* some GNU bits try to get cute and define this on their own */
237#define alloca(sz) __builtin_alloca(sz)
238#elif defined(lint)
239void *alloca(size_t);
240#endif
241
242__uint32_t
243 arc4random(void);
d82b6b65 244void arc4random_addrandom(__uint8_t *, size_t);
5d0641a4 245void arc4random_buf(void *, size_t);
5baeefc7 246void arc4random_stir(void);
5d0641a4
PA
247__uint32_t
248 arc4random_uniform(__uint32_t);
5baeefc7 249char *getbsize(int *, long *);
f736c3f8
SW
250
251/* getcap(3) functions */
6a7eb1f6 252char *cgetcap(char *, const char *, int);
5baeefc7 253int cgetclose(void);
6a7eb1f6 254int cgetent(char **, char **, const char *);
5baeefc7 255int cgetfirst(char **, char **);
6a7eb1f6 256int cgetmatch(const char *, const char *);
5baeefc7 257int cgetnext(char **, char **);
6a7eb1f6
PA
258int cgetnum(char *, const char *, long *);
259int cgetset(const char *);
260int cgetstr(char *, const char *, char **);
261int cgetustr(char *, const char *, char **);
5baeefc7
JS
262
263int daemon(int, int);
24d00e84
JS
264char *devname(dev_t, mode_t);
265char *devname_r(dev_t, mode_t, char *, size_t);
f736c3f8
SW
266char *fdevname(int);
267int fdevname_r(int, char *, size_t);
3eaaad2c 268int getloadavg(double [], int);
5d0641a4
PA
269__const char *
270 getprogname(void);
5baeefc7 271
5baeefc7 272int heapsort(void *, size_t, size_t, int (*)(const void *, const void *));
5d0641a4 273int l64a_r(long, char *, int);
5baeefc7 274int mergesort(void *, size_t, size_t, int (*)(const void *, const void *));
5d0641a4
PA
275void qsort_r(void *, size_t, size_t, void *,
276 int (*)(void *, const void *, const void *));
5baeefc7
JS
277int radixsort(const unsigned char **, int, const unsigned char *,
278 unsigned int);
5baeefc7 279void *reallocf(void *, size_t);
5d0641a4 280int rpmatch(const char *);
5baeefc7 281void setprogname(const char *);
5d0641a4
PA
282int sradixsort(const unsigned char **, int, const unsigned char *,
283 unsigned int);
284void sranddev(void);
5baeefc7 285void srandomdev(void);
5d0641a4 286long long
f736c3f8 287 strtonum(const char *, long long, long long, const char **);
44a09dd6 288
22ab97ca
VS
289/*
290 * C11 functions.
291 */
292int at_quick_exit(void (*func)(void));
293void quick_exit(int);
294
5d0641a4
PA
295/* Deprecated interfaces. */
296#if !defined(_KERNEL_VIRTUAL)
297__int64_t
298 strtoq(const char *, char **, int);
299__uint64_t
300 strtouq(const char *, char **, int);
44a09dd6 301#endif
70e9d14e 302
5d0641a4
PA
303extern char *suboptarg; /* getsubopt(3) external variable */
304#endif /* __BSD_VISIBLE */
984263bc
MD
305__END_DECLS
306
307#endif /* !_STDLIB_H_ */