]> git.ipfire.org Git - thirdparty/glibc.git/blame - stdlib/stdlib.h
Fix typos.
[thirdparty/glibc.git] / stdlib / stdlib.h
CommitLineData
568035b7 1/* Copyright (C) 1991-2013 Free Software Foundation, Inc.
ba1ffaa1 2 This file is part of the GNU C Library.
28f540f4 3
ba1ffaa1 4 The GNU C Library is free software; you can redistribute it and/or
41bdb6e2
AJ
5 modify it under the terms of the GNU Lesser General Public
6 License as published by the Free Software Foundation; either
7 version 2.1 of the License, or (at your option) any later version.
28f540f4 8
ba1ffaa1
UD
9 The GNU C Library is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
41bdb6e2 12 Lesser General Public License for more details.
28f540f4 13
41bdb6e2 14 You should have received a copy of the GNU Lesser General Public
59ba27a6
PE
15 License along with the GNU C Library; if not, see
16 <http://www.gnu.org/licenses/>. */
28f540f4
RM
17
18/*
d1646309 19 * ISO C99 Standard: 7.20 General utilities <stdlib.h>
28f540f4
RM
20 */
21
22#ifndef _STDLIB_H
5107cf1d 23
28f540f4
RM
24#include <features.h>
25
26/* Get size_t, wchar_t and NULL from <stddef.h>. */
7ef90c15
UD
27#define __need_size_t
28#ifndef __need_malloc_and_calloc
29# define __need_wchar_t
30# define __need_NULL
31#endif
28f540f4
RM
32#include <stddef.h>
33
50497a16
UD
34__BEGIN_DECLS
35
36#ifndef __need_malloc_and_calloc
37#define _STDLIB_H 1
38
f095bb72 39#if (defined __USE_XOPEN || defined __USE_XOPEN2K8) && !defined _SYS_WAIT_H
9323b58f
UD
40/* XPG requires a few symbols from <sys/wait.h> being defined. */
41# include <bits/waitflags.h>
42# include <bits/waitstatus.h>
43
c3fb74d3 44# ifdef __USE_BSD
9323b58f
UD
45
46/* Lots of hair to allow traditional BSD use of `union wait'
47 as well as POSIX.1 use of `int' for the status word. */
48
c3fb74d3 49# if defined __GNUC__ && !defined __cplusplus
a64039b0
UD
50# define __WAIT_INT(status) \
51 (__extension__ (((union { __typeof(status) __in; int __i; }) \
7f3146e7 52 { .__in = (status) }).__i))
c3fb74d3
UD
53# else
54# define __WAIT_INT(status) (*(int *) &(status))
55# endif
9323b58f
UD
56
57/* This is the type of the argument to `wait'. The funky union
8f0d3f49 58 causes redeclarations with either `int *' or `union wait *' to be
9323b58f
UD
59 allowed without complaint. __WAIT_STATUS_DEFN is the type used in
60 the actual function definitions. */
61
c3fb74d3
UD
62# if !defined __GNUC__ || __GNUC__ < 2 || defined __cplusplus
63# define __WAIT_STATUS void *
64# define __WAIT_STATUS_DEFN void *
65# else
9323b58f
UD
66/* This works in GCC 2.6.1 and later. */
67typedef union
68 {
69 union wait *__uptr;
70 int *__iptr;
71 } __WAIT_STATUS __attribute__ ((__transparent_union__));
c3fb74d3
UD
72# define __WAIT_STATUS_DEFN int *
73# endif
9323b58f 74
c3fb74d3 75# else /* Don't use BSD. */
9323b58f 76
c3fb74d3 77# define __WAIT_INT(status) (status)
145b8413 78# define __WAIT_STATUS int *
c3fb74d3 79# define __WAIT_STATUS_DEFN int *
9323b58f 80
c3fb74d3 81# endif /* Use BSD. */
9323b58f
UD
82
83/* Define the macros <sys/wait.h> also would define this way. */
8f0d3f49
UD
84# define WEXITSTATUS(status) __WEXITSTATUS (__WAIT_INT (status))
85# define WTERMSIG(status) __WTERMSIG (__WAIT_INT (status))
86# define WSTOPSIG(status) __WSTOPSIG (__WAIT_INT (status))
87# define WIFEXITED(status) __WIFEXITED (__WAIT_INT (status))
88# define WIFSIGNALED(status) __WIFSIGNALED (__WAIT_INT (status))
89# define WIFSTOPPED(status) __WIFSTOPPED (__WAIT_INT (status))
a044c713 90# ifdef __WIFCONTINUED
8f0d3f49 91# define WIFCONTINUED(status) __WIFCONTINUED (__WAIT_INT (status))
a044c713 92# endif
f095bb72 93#endif /* X/Open or XPG7 and <sys/wait.h> not included. */
9323b58f 94
7a5affeb 95__BEGIN_NAMESPACE_STD
28f540f4
RM
96/* Returned by `div'. */
97typedef struct
98 {
99 int quot; /* Quotient. */
100 int rem; /* Remainder. */
101 } div_t;
102
103/* Returned by `ldiv'. */
e518937a 104#ifndef __ldiv_t_defined
28f540f4
RM
105typedef struct
106 {
107 long int quot; /* Quotient. */
108 long int rem; /* Remainder. */
109 } ldiv_t;
e518937a
UD
110# define __ldiv_t_defined 1
111#endif
7a5affeb 112__END_NAMESPACE_STD
28f540f4 113
ec751a23 114#if defined __USE_ISOC99 && !defined __lldiv_t_defined
7a5affeb 115__BEGIN_NAMESPACE_C99
59dd8641 116/* Returned by `lldiv'. */
7782d0bf 117__extension__ typedef struct
59dd8641
RM
118 {
119 long long int quot; /* Quotient. */
120 long long int rem; /* Remainder. */
121 } lldiv_t;
e518937a 122# define __lldiv_t_defined 1
7a5affeb 123__END_NAMESPACE_C99
59dd8641
RM
124#endif
125
28f540f4
RM
126
127/* The largest number rand will return (same as INT_MAX). */
128#define RAND_MAX 2147483647
129
130
131/* We define these the same for all machines.
132 Changes from this to the outside world should be done in `_exit'. */
133#define EXIT_FAILURE 1 /* Failing exit status. */
134#define EXIT_SUCCESS 0 /* Successful exit status. */
135
136
0200214b
RM
137/* Maximum length of a multibyte character in the current locale. */
138#define MB_CUR_MAX (__ctype_get_mb_cur_max ())
0476597b 139extern size_t __ctype_get_mb_cur_max (void) __THROW __wur;
28f540f4
RM
140
141
7a5affeb 142__BEGIN_NAMESPACE_STD
28f540f4 143/* Convert a string to a floating-point number. */
a784e502 144extern double atof (const char *__nptr)
0476597b 145 __THROW __attribute_pure__ __nonnull ((1)) __wur;
28f540f4 146/* Convert a string to an integer. */
a784e502 147extern int atoi (const char *__nptr)
0476597b 148 __THROW __attribute_pure__ __nonnull ((1)) __wur;
28f540f4 149/* Convert a string to a long integer. */
a784e502 150extern long int atol (const char *__nptr)
0476597b 151 __THROW __attribute_pure__ __nonnull ((1)) __wur;
7a5affeb 152__END_NAMESPACE_STD
28f540f4 153
6a57d931 154#if defined __USE_ISOC99 || defined __USE_MISC
7a5affeb 155__BEGIN_NAMESPACE_C99
fb4dfa0c 156/* Convert a string to a long long integer. */
a784e502 157__extension__ extern long long int atoll (const char *__nptr)
0476597b 158 __THROW __attribute_pure__ __nonnull ((1)) __wur;
7a5affeb 159__END_NAMESPACE_C99
7cc27f44
UD
160#endif
161
7a5affeb 162__BEGIN_NAMESPACE_STD
28f540f4 163/* Convert a string to a floating-point number. */
a784e502 164extern double strtod (const char *__restrict __nptr,
0476597b 165 char **__restrict __endptr)
c0baea34 166 __THROW __nonnull ((1));
7a5affeb 167__END_NAMESPACE_STD
28f540f4 168
ec751a23 169#ifdef __USE_ISOC99
7a5affeb 170__BEGIN_NAMESPACE_C99
28f540f4 171/* Likewise for `float' and `long double' sizes of floating-point numbers. */
a784e502 172extern float strtof (const char *__restrict __nptr,
c0baea34 173 char **__restrict __endptr) __THROW __nonnull ((1));
2f6d1f1b 174
a784e502 175extern long double strtold (const char *__restrict __nptr,
be27d08c 176 char **__restrict __endptr)
c0baea34 177 __THROW __nonnull ((1));
7a5affeb 178__END_NAMESPACE_C99
28f540f4
RM
179#endif
180
7a5affeb 181__BEGIN_NAMESPACE_STD
28f540f4 182/* Convert a string to a long integer. */
a784e502 183extern long int strtol (const char *__restrict __nptr,
be27d08c 184 char **__restrict __endptr, int __base)
c0baea34 185 __THROW __nonnull ((1));
28f540f4 186/* Convert a string to an unsigned long integer. */
a784e502 187extern unsigned long int strtoul (const char *__restrict __nptr,
c1422e5b 188 char **__restrict __endptr, int __base)
c0baea34 189 __THROW __nonnull ((1));
4708f2b1 190__END_NAMESPACE_STD
28f540f4 191
6a57d931 192#ifdef __USE_BSD
28f540f4 193/* Convert a string to a quadword integer. */
7782d0bf 194__extension__
a784e502 195extern long long int strtoq (const char *__restrict __nptr,
be27d08c 196 char **__restrict __endptr, int __base)
c0baea34 197 __THROW __nonnull ((1));
28f540f4 198/* Convert a string to an unsigned quadword integer. */
7782d0bf 199__extension__
a784e502 200extern unsigned long long int strtouq (const char *__restrict __nptr,
c1422e5b 201 char **__restrict __endptr, int __base)
c0baea34 202 __THROW __nonnull ((1));
6a57d931 203#endif /* Use BSD. */
28f540f4 204
6a57d931 205#if defined __USE_ISOC99 || defined __USE_MISC
7a5affeb 206__BEGIN_NAMESPACE_C99
76060ec0 207/* Convert a string to a quadword integer. */
7782d0bf 208__extension__
a784e502 209extern long long int strtoll (const char *__restrict __nptr,
be27d08c 210 char **__restrict __endptr, int __base)
c0baea34 211 __THROW __nonnull ((1));
76060ec0 212/* Convert a string to an unsigned quadword integer. */
7782d0bf 213__extension__
a784e502 214extern unsigned long long int strtoull (const char *__restrict __nptr,
c1422e5b 215 char **__restrict __endptr, int __base)
c0baea34 216 __THROW __nonnull ((1));
7a5affeb 217__END_NAMESPACE_C99
6a57d931 218#endif /* ISO C99 or use MISC. */
76060ec0
RM
219
220
0501d603
UD
221#ifdef __USE_GNU
222/* The concept of one static locale per category is not very well
223 thought out. Many applications will need to process its data using
8f0d3f49 224 information from several different locales. Another problem is
0501d603 225 the implementation of the internationalization handling in the
8f0d3f49
UD
226 ISO C++ standard library. To support this another set of
227 the functions using locale data exist which take an additional
0501d603
UD
228 argument.
229
8f0d3f49
UD
230 Attention: even though several *_l interfaces are part of POSIX:2008,
231 these are not. */
0501d603
UD
232
233/* Structure for reentrant locale using functions. This is an
234 (almost) opaque type for the user level programs. */
235# include <xlocale.h>
236
237/* Special versions of the functions above which take the locale to
238 use as an additional parameter. */
a784e502 239extern long int strtol_l (const char *__restrict __nptr,
1ab62b32 240 char **__restrict __endptr, int __base,
c0baea34 241 __locale_t __loc) __THROW __nonnull ((1, 4));
0501d603 242
a784e502 243extern unsigned long int strtoul_l (const char *__restrict __nptr,
1ab62b32 244 char **__restrict __endptr,
be27d08c 245 int __base, __locale_t __loc)
c0baea34 246 __THROW __nonnull ((1, 4));
0501d603 247
7782d0bf 248__extension__
a784e502 249extern long long int strtoll_l (const char *__restrict __nptr,
1ab62b32 250 char **__restrict __endptr, int __base,
be27d08c 251 __locale_t __loc)
c0baea34 252 __THROW __nonnull ((1, 4));
0501d603 253
7782d0bf 254__extension__
a784e502 255extern unsigned long long int strtoull_l (const char *__restrict __nptr,
1ab62b32
RM
256 char **__restrict __endptr,
257 int __base, __locale_t __loc)
c0baea34 258 __THROW __nonnull ((1, 4));
0501d603 259
a784e502 260extern double strtod_l (const char *__restrict __nptr,
1ab62b32 261 char **__restrict __endptr, __locale_t __loc)
c0baea34 262 __THROW __nonnull ((1, 3));
0501d603 263
a784e502 264extern float strtof_l (const char *__restrict __nptr,
be27d08c 265 char **__restrict __endptr, __locale_t __loc)
c0baea34 266 __THROW __nonnull ((1, 3));
0501d603 267
a784e502 268extern long double strtold_l (const char *__restrict __nptr,
1ab62b32 269 char **__restrict __endptr,
0476597b 270 __locale_t __loc)
c0baea34 271 __THROW __nonnull ((1, 3));
0501d603
UD
272#endif /* GNU */
273
f0bf9cb9 274
07c416ed 275#ifdef __USE_EXTERN_INLINES
7a5affeb 276__BEGIN_NAMESPACE_STD
b037a293 277__extern_inline int
a784e502 278__NTH (atoi (const char *__nptr))
2604afb1
UD
279{
280 return (int) strtol (__nptr, (char **) NULL, 10);
281}
b037a293 282__extern_inline long int
a784e502 283__NTH (atol (const char *__nptr))
2604afb1
UD
284{
285 return strtol (__nptr, (char **) NULL, 10);
286}
7a5affeb 287__END_NAMESPACE_STD
2604afb1 288
ec751a23 289# if defined __USE_MISC || defined __USE_ISOC99
7a5affeb 290__BEGIN_NAMESPACE_C99
b037a293 291__extension__ __extern_inline long long int
a784e502 292__NTH (atoll (const char *__nptr))
2604afb1
UD
293{
294 return strtoll (__nptr, (char **) NULL, 10);
295}
7a5affeb 296__END_NAMESPACE_C99
2604afb1 297# endif
0c6cee5d 298#endif /* Optimizing and Inlining. */
28f540f4
RM
299
300
377a515b 301#if defined __USE_SVID || defined __USE_XOPEN_EXTENDED
bbed653c
RM
302/* Convert N to base 64 using the digits "./0-9A-Za-z", least-significant
303 digit first. Returns a pointer to static storage overwritten by the
304 next call. */
0476597b 305extern char *l64a (long int __n) __THROW __wur;
bbed653c 306
036cc82f 307/* Read a number from a string S in base 64 as above. */
a784e502 308extern long int a64l (const char *__s)
0476597b 309 __THROW __attribute_pure__ __nonnull ((1)) __wur;
28f540f4 310
7ed33cba 311#endif /* Use SVID || extended X/Open. */
b20e47cb 312
7ed33cba 313#if defined __USE_SVID || defined __USE_XOPEN_EXTENDED || defined __USE_BSD
dfd2257a 314# include <sys/types.h> /* we need int32_t... */
b20e47cb 315
28f540f4
RM
316/* These are the functions that actually do things. The `random', `srandom',
317 `initstate' and `setstate' functions are those from BSD Unices.
318 The `rand' and `srand' functions are required by the ANSI standard.
319 We provide both interfaces to the same random number generator. */
320/* Return a random long integer between 0 and RAND_MAX inclusive. */
61f9d0a3 321extern long int random (void) __THROW;
9ebb936d 322
28f540f4 323/* Seed the random number generator with the given number. */
c1422e5b 324extern void srandom (unsigned int __seed) __THROW;
28f540f4
RM
325
326/* Initialize the random number generator to use state buffer STATEBUF,
327 of length STATELEN, and seed it with SEED. Optimal lengths are 8, 16,
328 32, 64, 128 and 256, the bigger the better; values less than 8 will
329 cause an error and values greater than 256 will be rounded down. */
9323b58f 330extern char *initstate (unsigned int __seed, char *__statebuf,
be27d08c 331 size_t __statelen) __THROW __nonnull ((2));
9ebb936d 332
28f540f4
RM
333/* Switch the random number generator to state buffer STATEBUF,
334 which should have been previously initialized by `initstate'. */
be27d08c 335extern char *setstate (char *__statebuf) __THROW __nonnull ((1));
28f540f4 336
60478656 337
2604afb1 338# ifdef __USE_MISC
60478656
RM
339/* Reentrant versions of the `random' family of functions.
340 These functions all use the following data structure to contain
341 state, rather than global state variables. */
342
343struct random_data
344 {
b20e47cb
RM
345 int32_t *fptr; /* Front pointer. */
346 int32_t *rptr; /* Rear pointer. */
347 int32_t *state; /* Array of state values. */
60478656
RM
348 int rand_type; /* Type of random number generator. */
349 int rand_deg; /* Degree of random number generator. */
350 int rand_sep; /* Distance between front and rear. */
b20e47cb 351 int32_t *end_ptr; /* Pointer behind state table. */
60478656
RM
352 };
353
c1422e5b 354extern int random_r (struct random_data *__restrict __buf,
be27d08c 355 int32_t *__restrict __result) __THROW __nonnull ((1, 2));
8a523922 356
be27d08c
UD
357extern int srandom_r (unsigned int __seed, struct random_data *__buf)
358 __THROW __nonnull ((2));
8a523922 359
9323b58f 360extern int initstate_r (unsigned int __seed, char *__restrict __statebuf,
c1422e5b 361 size_t __statelen,
be27d08c
UD
362 struct random_data *__restrict __buf)
363 __THROW __nonnull ((2, 4));
8a523922 364
9323b58f 365extern int setstate_r (char *__restrict __statebuf,
be27d08c
UD
366 struct random_data *__restrict __buf)
367 __THROW __nonnull ((1, 2));
2604afb1 368# endif /* Use misc. */
7ed33cba 369#endif /* Use SVID || extended X/Open || BSD. */
60478656
RM
370
371
7a5affeb 372__BEGIN_NAMESPACE_STD
2c6fe0bd 373/* Return a random integer between 0 and RAND_MAX inclusive. */
c1422e5b 374extern int rand (void) __THROW;
2c6fe0bd 375/* Seed the random number generator with the given number. */
c1422e5b 376extern void srand (unsigned int __seed) __THROW;
7a5affeb 377__END_NAMESPACE_STD
2c6fe0bd 378
4bae5567 379#ifdef __USE_POSIX
47707456 380/* Reentrant interface according to POSIX.1. */
c1422e5b 381extern int rand_r (unsigned int *__seed) __THROW;
47707456
UD
382#endif
383
2c6fe0bd 384
377a515b 385#if defined __USE_SVID || defined __USE_XOPEN
60478656
RM
386/* System V style 48-bit random number generator functions. */
387
2c6fe0bd 388/* Return non-negative, double-precision floating-point value in [0.0,1.0). */
c1422e5b 389extern double drand48 (void) __THROW;
be27d08c 390extern double erand48 (unsigned short int __xsubi[3]) __THROW __nonnull ((1));
2c6fe0bd
UD
391
392/* Return non-negative, long integer in [0,2^31). */
c1422e5b 393extern long int lrand48 (void) __THROW;
be27d08c
UD
394extern long int nrand48 (unsigned short int __xsubi[3])
395 __THROW __nonnull ((1));
2c6fe0bd
UD
396
397/* Return signed, long integers in [-2^31,2^31). */
c1422e5b 398extern long int mrand48 (void) __THROW;
be27d08c
UD
399extern long int jrand48 (unsigned short int __xsubi[3])
400 __THROW __nonnull ((1));
2c6fe0bd
UD
401
402/* Seed random number generator. */
c1422e5b 403extern void srand48 (long int __seedval) __THROW;
be27d08c
UD
404extern unsigned short int *seed48 (unsigned short int __seed16v[3])
405 __THROW __nonnull ((1));
406extern void lcong48 (unsigned short int __param[7]) __THROW __nonnull ((1));
2c6fe0bd 407
d17c01f9
UD
408# ifdef __USE_MISC
409/* Data structure for communication with thread safe versions. This
410 type is to be regarded as opaque. It's only exported because users
411 have to allocate objects of this type. */
60478656
RM
412struct drand48_data
413 {
d17c01f9
UD
414 unsigned short int __x[3]; /* Current state. */
415 unsigned short int __old_x[3]; /* Old state. */
416 unsigned short int __c; /* Additive const. in congruential formula. */
417 unsigned short int __init; /* Flag for initializing. */
828beb13
JM
418 __extension__ unsigned long long int __a; /* Factor in congruential
419 formula. */
60478656
RM
420 };
421
422/* Return non-negative, double-precision floating-point value in [0.0,1.0). */
c1422e5b 423extern int drand48_r (struct drand48_data *__restrict __buffer,
be27d08c 424 double *__restrict __result) __THROW __nonnull ((1, 2));
c1422e5b
UD
425extern int erand48_r (unsigned short int __xsubi[3],
426 struct drand48_data *__restrict __buffer,
be27d08c 427 double *__restrict __result) __THROW __nonnull ((1, 2));
2c6fe0bd 428
60478656 429/* Return non-negative, long integer in [0,2^31). */
c1422e5b 430extern int lrand48_r (struct drand48_data *__restrict __buffer,
be27d08c
UD
431 long int *__restrict __result)
432 __THROW __nonnull ((1, 2));
c1422e5b
UD
433extern int nrand48_r (unsigned short int __xsubi[3],
434 struct drand48_data *__restrict __buffer,
be27d08c
UD
435 long int *__restrict __result)
436 __THROW __nonnull ((1, 2));
2c6fe0bd 437
60478656 438/* Return signed, long integers in [-2^31,2^31). */
c1422e5b 439extern int mrand48_r (struct drand48_data *__restrict __buffer,
be27d08c
UD
440 long int *__restrict __result)
441 __THROW __nonnull ((1, 2));
c1422e5b
UD
442extern int jrand48_r (unsigned short int __xsubi[3],
443 struct drand48_data *__restrict __buffer,
be27d08c
UD
444 long int *__restrict __result)
445 __THROW __nonnull ((1, 2));
2c6fe0bd 446
60478656 447/* Seed random number generator. */
c1422e5b 448extern int srand48_r (long int __seedval, struct drand48_data *__buffer)
be27d08c 449 __THROW __nonnull ((2));
47f13fd4 450
c1422e5b 451extern int seed48_r (unsigned short int __seed16v[3],
be27d08c 452 struct drand48_data *__buffer) __THROW __nonnull ((1, 2));
47f13fd4 453
c1422e5b 454extern int lcong48_r (unsigned short int __param[7],
be27d08c
UD
455 struct drand48_data *__buffer)
456 __THROW __nonnull ((1, 2));
dfd2257a 457# endif /* Use misc. */
2c6fe0bd 458#endif /* Use SVID or X/Open. */
28f540f4 459
7ef90c15 460#endif /* don't just need malloc and calloc */
28f540f4 461
7ef90c15 462#ifndef __malloc_and_calloc_defined
7a5affeb
UD
463# define __malloc_and_calloc_defined
464__BEGIN_NAMESPACE_STD
28f540f4 465/* Allocate SIZE bytes of memory. */
0476597b 466extern void *malloc (size_t __size) __THROW __attribute_malloc__ __wur;
7ef90c15 467/* Allocate NMEMB elements of SIZE bytes each, all initialized to 0. */
e9e9b245 468extern void *calloc (size_t __nmemb, size_t __size)
0476597b 469 __THROW __attribute_malloc__ __wur;
7a5affeb 470__END_NAMESPACE_STD
7ef90c15
UD
471#endif
472
473#ifndef __need_malloc_and_calloc
7a5affeb 474__BEGIN_NAMESPACE_STD
28f540f4 475/* Re-allocate the previously allocated block
c1422e5b 476 in PTR, making the new block SIZE bytes long. */
1c3e748e
UD
477/* __attribute_malloc__ is not used, because if realloc returns
478 the same pointer that was passed to it, aliasing needs to be allowed
479 between objects pointed by the old and new pointers. */
0476597b 480extern void *realloc (void *__ptr, size_t __size)
1c3e748e 481 __THROW __attribute_warn_unused_result__;
28f540f4 482/* Free a block allocated by `malloc', `realloc' or `calloc'. */
c1422e5b 483extern void free (void *__ptr) __THROW;
7a5affeb 484__END_NAMESPACE_STD
28f540f4
RM
485
486#ifdef __USE_MISC
487/* Free a block. An alias for `free'. (Sun Unices). */
c1422e5b 488extern void cfree (void *__ptr) __THROW;
28f540f4
RM
489#endif /* Use misc. */
490
377a515b 491#if defined __USE_GNU || defined __USE_BSD || defined __USE_MISC
2604afb1 492# include <alloca.h>
28f540f4
RM
493#endif /* Use GNU, BSD, or misc. */
494
c589e093
UD
495#if (defined __USE_XOPEN_EXTENDED && !defined __USE_XOPEN2K) \
496 || defined __USE_BSD
28f540f4 497/* Allocate SIZE bytes on a page boundary. The storage cannot be freed. */
0476597b 498extern void *valloc (size_t __size) __THROW __attribute_malloc__ __wur;
28f540f4
RM
499#endif
500
0758ea0c 501#ifdef __USE_XOPEN2K
c8c73ac3 502/* Allocate memory of SIZE bytes with an alignment of ALIGNMENT. */
61f9d0a3 503extern int posix_memalign (void **__memptr, size_t __alignment, size_t __size)
5bcbe69f 504 __THROW __nonnull ((1)) __wur;
0758ea0c 505#endif
28f540f4 506
380d7e87
UD
507#ifdef __USE_ISOC11
508/* ISO C variant of aligned allocation. */
8b43a4cc 509extern void *aligned_alloc (size_t __alignment, size_t __size)
4be9b544 510 __THROW __attribute_malloc__ __attribute_alloc_size__ ((2)) __wur;
380d7e87
UD
511#endif
512
7a5affeb 513__BEGIN_NAMESPACE_STD
28f540f4 514/* Abort execution and generate a core-dump. */
c1422e5b 515extern void abort (void) __THROW __attribute__ ((__noreturn__));
28f540f4
RM
516
517
518/* Register a function to be called when `exit' is called. */
be27d08c 519extern int atexit (void (*__func) (void)) __THROW __nonnull ((1));
610e67ed 520
4e9e7a35 521#if defined __USE_ISOC11 || defined __USE_ISOCXX11
610e67ed
UD
522/* Register a function to be called when `quick_exit' is called. */
523# ifdef __cplusplus
524extern "C++" int at_quick_exit (void (*__func) (void))
525 __THROW __asm ("at_quick_exit") __nonnull ((1));
526# else
527extern int at_quick_exit (void (*__func) (void)) __THROW __nonnull ((1));
528# endif
529#endif
7a5affeb 530__END_NAMESPACE_STD
28f540f4
RM
531
532#ifdef __USE_MISC
533/* Register a function to be called with the status
534 given to `exit' and the given argument. */
c1422e5b 535extern int on_exit (void (*__func) (int __status, void *__arg), void *__arg)
be27d08c 536 __THROW __nonnull ((1));
28f540f4
RM
537#endif
538
7a5affeb 539__BEGIN_NAMESPACE_STD
28f540f4 540/* Call all functions registered with `atexit' and `on_exit',
610e67ed 541 in the reverse of the order in which they were registered,
28f540f4 542 perform stdio cleanup, and terminate program execution with STATUS. */
c1422e5b 543extern void exit (int __status) __THROW __attribute__ ((__noreturn__));
610e67ed 544
4e9e7a35 545#if defined __USE_ISOC11 || defined __USE_ISOCXX11
610e67ed
UD
546/* Call all functions registered with `at_quick_exit' in the reverse
547 of the order in which they were registered and terminate program
548 execution with STATUS. */
549extern void quick_exit (int __status) __THROW __attribute__ ((__noreturn__));
550#endif
7a5affeb 551__END_NAMESPACE_STD
28f540f4 552
ec751a23 553#ifdef __USE_ISOC99
7a5affeb 554__BEGIN_NAMESPACE_C99
e518937a
UD
555/* Terminate the program with STATUS without calling any of the
556 functions registered with `atexit' or `on_exit'. */
c1422e5b 557extern void _Exit (int __status) __THROW __attribute__ ((__noreturn__));
7a5affeb 558__END_NAMESPACE_C99
e518937a
UD
559#endif
560
28f540f4 561
7a5affeb 562__BEGIN_NAMESPACE_STD
28f540f4 563/* Return the value of envariable NAME, or NULL if it doesn't exist. */
a784e502 564extern char *getenv (const char *__name) __THROW __nonnull ((1)) __wur;
7a5affeb 565__END_NAMESPACE_STD
28f540f4 566
84b3fd84 567#ifdef __USE_GNU
d68171ed
UD
568/* This function is similar to the above but returns NULL if the
569 programs is running with SUID or SGID enabled. */
84b3fd84 570extern char *secure_getenv (const char *__name)
0476597b 571 __THROW __nonnull ((1)) __wur;
84b3fd84 572#endif
d68171ed 573
377a515b 574#if defined __USE_SVID || defined __USE_XOPEN
28f540f4
RM
575/* The SVID says this is in <stdio.h>, but this seems a better place. */
576/* Put STRING, which is of the form "NAME=VALUE", in the environment.
577 If there is no `=', remove NAME from the environment. */
be27d08c 578extern int putenv (char *__string) __THROW __nonnull ((1));
28f540f4
RM
579#endif
580
61f9d0a3 581#if defined __USE_BSD || defined __USE_XOPEN2K
28f540f4
RM
582/* Set NAME to VALUE in the environment.
583 If REPLACE is nonzero, overwrite an existing value. */
a784e502 584extern int setenv (const char *__name, const char *__value, int __replace)
90692538 585 __THROW __nonnull ((2));
196980f5
RM
586
587/* Remove the variable NAME from the environment. */
a784e502 588extern int unsetenv (const char *__name) __THROW __nonnull ((1));
28f540f4
RM
589#endif
590
f0e44959
UD
591#ifdef __USE_MISC
592/* The `clearenv' was planned to be added to POSIX.1 but probably
593 never made it. Nevertheless the POSIX.9 standard (POSIX bindings
594 for Fortran 77) requires this function. */
c1422e5b 595extern int clearenv (void) __THROW;
f0e44959
UD
596#endif
597
2c6fe0bd 598
52e96a80 599#if defined __USE_MISC \
9bde902c 600 || (defined __USE_XOPEN_EXTENDED && !defined __USE_XOPEN2K8)
2c6fe0bd
UD
601/* Generate a unique temporary file name from TEMPLATE.
602 The last six characters of TEMPLATE must be "XXXXXX";
603 they are replaced with a string that makes the file name unique.
349fa79f
AJ
604 Always returns TEMPLATE, it's either a temporary file name or a null
605 string if it cannot get a unique file name. */
606extern char *mktemp (char *__template) __THROW __nonnull ((1));
f095bb72 607#endif
2c6fe0bd 608
f095bb72
UD
609#if defined __USE_MISC || defined __USE_XOPEN_EXTENDED \
610 || defined __USE_XOPEN2K8
2c6fe0bd
UD
611/* Generate a unique temporary file name from TEMPLATE.
612 The last six characters of TEMPLATE must be "XXXXXX";
613 they are replaced with a string that makes the filename unique.
614 Returns a file descriptor open on the file for reading and writing,
2c008571
UD
615 or -1 if it cannot create a uniquely-named file.
616
7f3146e7 617 This function is a possible cancellation point and therefore not
2c008571 618 marked with __THROW. */
85adf316 619# ifndef __USE_FILE_OFFSET64
0476597b 620extern int mkstemp (char *__template) __nonnull ((1)) __wur;
85adf316
UD
621# else
622# ifdef __REDIRECT
0476597b
UD
623extern int __REDIRECT (mkstemp, (char *__template), mkstemp64)
624 __nonnull ((1)) __wur;
85adf316
UD
625# else
626# define mkstemp mkstemp64
627# endif
628# endif
629# ifdef __USE_LARGEFILE64
0476597b 630extern int mkstemp64 (char *__template) __nonnull ((1)) __wur;
85adf316 631# endif
2c6fe0bd
UD
632#endif
633
7f3146e7
UD
634#ifdef __USE_MISC
635/* Similar to mkstemp, but the template can have a suffix after the
636 XXXXXX. The length of the suffix is specified in the second
637 parameter.
638
639 This function is a possible cancellation point and therefore not
640 marked with __THROW. */
641# ifndef __USE_FILE_OFFSET64
642extern int mkstemps (char *__template, int __suffixlen) __nonnull ((1)) __wur;
643# else
644# ifdef __REDIRECT
645extern int __REDIRECT (mkstemps, (char *__template, int __suffixlen),
646 mkstemps64) __nonnull ((1)) __wur;
647# else
648# define mkstemps mkstemps64
649# endif
650# endif
651# ifdef __USE_LARGEFILE64
652extern int mkstemps64 (char *__template, int __suffixlen)
653 __nonnull ((1)) __wur;
654# endif
655#endif
656
6cbe890a 657#if defined __USE_BSD || defined __USE_XOPEN2K8
2e65ca2b
UD
658/* Create a unique temporary directory from TEMPLATE.
659 The last six characters of TEMPLATE must be "XXXXXX";
660 they are replaced with a string that makes the directory name unique.
661 Returns TEMPLATE, or a null pointer if it cannot get a unique name.
662 The directory is created mode 700. */
0476597b 663extern char *mkdtemp (char *__template) __THROW __nonnull ((1)) __wur;
2e65ca2b
UD
664#endif
665
d7e23b02
UD
666#ifdef __USE_GNU
667/* Generate a unique temporary file name from TEMPLATE similar to
668 mkstemp. But allow the caller to pass additional flags which are
669 used in the open call to create the file..
670
4c1423ed 671 This function is a possible cancellation point and therefore not
d7e23b02
UD
672 marked with __THROW. */
673# ifndef __USE_FILE_OFFSET64
674extern int mkostemp (char *__template, int __flags) __nonnull ((1)) __wur;
675# else
676# ifdef __REDIRECT
677extern int __REDIRECT (mkostemp, (char *__template, int __flags), mkostemp64)
678 __nonnull ((1)) __wur;
679# else
680# define mkostemp mkostemp64
681# endif
682# endif
683# ifdef __USE_LARGEFILE64
684extern int mkostemp64 (char *__template, int __flags) __nonnull ((1)) __wur;
685# endif
3a83202d
UD
686
687/* Similar to mkostemp, but the template can have a suffix after the
688 XXXXXX. The length of the suffix is specified in the second
689 parameter.
690
691 This function is a possible cancellation point and therefore not
692 marked with __THROW. */
693# ifndef __USE_FILE_OFFSET64
694extern int mkostemps (char *__template, int __suffixlen, int __flags)
695 __nonnull ((1)) __wur;
696# else
697# ifdef __REDIRECT
698extern int __REDIRECT (mkostemps, (char *__template, int __suffixlen,
699 int __flags), mkostemps64)
700 __nonnull ((1)) __wur;
701# else
702# define mkostemps mkostemps64
703# endif
704# endif
705# ifdef __USE_LARGEFILE64
706extern int mkostemps64 (char *__template, int __suffixlen, int __flags)
707 __nonnull ((1)) __wur;
708# endif
d7e23b02
UD
709#endif
710
2c6fe0bd 711
7a5affeb 712__BEGIN_NAMESPACE_STD
2c008571
UD
713/* Execute the given line as a shell command.
714
715 This function is a cancellation point and therefore not marked with
716 __THROW. */
a784e502 717extern int system (const char *__command) __wur;
7a5affeb 718__END_NAMESPACE_STD
28f540f4
RM
719
720
fa0bc87c
RM
721#ifdef __USE_GNU
722/* Return a malloc'd string containing the canonical absolute name of the
11bf311e 723 existing named file. */
a784e502 724extern char *canonicalize_file_name (const char *__name)
0476597b 725 __THROW __nonnull ((1)) __wur;
fa0bc87c
RM
726#endif
727
377a515b 728#if defined __USE_BSD || defined __USE_XOPEN_EXTENDED
b7674b11
UD
729/* Return the canonical absolute name of file NAME. If RESOLVED is
730 null, the result is malloc'd; otherwise, if the canonical name is
731 PATH_MAX chars or more, returns null with `errno' set to
732 ENAMETOOLONG; if the name fits in fewer than PATH_MAX chars,
733 returns the name in RESOLVED. */
a784e502 734extern char *realpath (const char *__restrict __name,
0476597b 735 char *__restrict __resolved) __THROW __wur;
fa0bc87c
RM
736#endif
737
738
28f540f4 739/* Shorthand for type of comparison functions. */
60478656 740#ifndef __COMPAR_FN_T
2604afb1 741# define __COMPAR_FN_T
a784e502 742typedef int (*__compar_fn_t) (const void *, const void *);
28f540f4 743
2604afb1 744# ifdef __USE_GNU
28f540f4 745typedef __compar_fn_t comparison_fn_t;
2604afb1 746# endif
28f540f4 747#endif
e458144c 748#ifdef __USE_GNU
a784e502 749typedef int (*__compar_d_fn_t) (const void *, const void *, void *);
e458144c 750#endif
28f540f4 751
7a5affeb 752__BEGIN_NAMESPACE_STD
28f540f4
RM
753/* Do a binary search for KEY in BASE, which consists of NMEMB elements
754 of SIZE bytes each, using COMPAR to perform the comparisons. */
a784e502 755extern void *bsearch (const void *__key, const void *__base,
be27d08c 756 size_t __nmemb, size_t __size, __compar_fn_t __compar)
0476597b 757 __nonnull ((1, 2, 5)) __wur;
28f540f4 758
41eda41d
OB
759#ifdef __USE_EXTERN_INLINES
760# include <bits/stdlib-bsearch.h>
761#endif
762
28f540f4
RM
763/* Sort NMEMB elements of BASE, of SIZE bytes each,
764 using COMPAR to perform the comparisons. */
c1422e5b 765extern void qsort (void *__base, size_t __nmemb, size_t __size,
be27d08c 766 __compar_fn_t __compar) __nonnull ((1, 4));
e458144c
UD
767#ifdef __USE_GNU
768extern void qsort_r (void *__base, size_t __nmemb, size_t __size,
769 __compar_d_fn_t __compar, void *__arg)
770 __nonnull ((1, 4));
771#endif
28f540f4
RM
772
773
28f540f4 774/* Return the absolute value of X. */
0476597b
UD
775extern int abs (int __x) __THROW __attribute__ ((__const__)) __wur;
776extern long int labs (long int __x) __THROW __attribute__ ((__const__)) __wur;
7a5affeb
UD
777__END_NAMESPACE_STD
778
ec751a23 779#ifdef __USE_ISOC99
c1422e5b 780__extension__ extern long long int llabs (long long int __x)
0476597b 781 __THROW __attribute__ ((__const__)) __wur;
59dd8641 782#endif
28f540f4
RM
783
784
7a5affeb 785__BEGIN_NAMESPACE_STD
59dd8641 786/* Return the `div_t', `ldiv_t' or `lldiv_t' representation
28f540f4
RM
787 of the value of NUMER over DENOM. */
788/* GCC may have built-ins for these someday. */
c1422e5b 789extern div_t div (int __numer, int __denom)
0476597b 790 __THROW __attribute__ ((__const__)) __wur;
c1422e5b 791extern ldiv_t ldiv (long int __numer, long int __denom)
0476597b 792 __THROW __attribute__ ((__const__)) __wur;
7a5affeb
UD
793__END_NAMESPACE_STD
794
ec751a23 795#ifdef __USE_ISOC99
7a5affeb 796__BEGIN_NAMESPACE_C99
c1422e5b
UD
797__extension__ extern lldiv_t lldiv (long long int __numer,
798 long long int __denom)
0476597b 799 __THROW __attribute__ ((__const__)) __wur;
7a5affeb 800__END_NAMESPACE_C99
59dd8641 801#endif
28f540f4
RM
802
803
9bde902c 804#if (defined __USE_XOPEN_EXTENDED && !defined __USE_XOPEN2K8) \
c589e093 805 || defined __USE_SVID
60478656
RM
806/* Convert floating point numbers to strings. The returned values are
807 valid only until another call to the same function. */
808
809/* Convert VALUE to a string with NDIGIT digits and return a pointer to
810 this. Set *DECPT with the position of the decimal character and *SIGN
811 with the sign of the number. */
c1422e5b 812extern char *ecvt (double __value, int __ndigit, int *__restrict __decpt,
0476597b 813 int *__restrict __sign) __THROW __nonnull ((3, 4)) __wur;
60478656
RM
814
815/* Convert VALUE to a string rounded to NDIGIT decimal digits. Set *DECPT
816 with the position of the decimal character and *SIGN with the sign of
817 the number. */
c1422e5b 818extern char *fcvt (double __value, int __ndigit, int *__restrict __decpt,
0476597b 819 int *__restrict __sign) __THROW __nonnull ((3, 4)) __wur;
60478656
RM
820
821/* If possible convert VALUE to a string with NDIGIT significant digits.
822 Otherwise use exponential representation. The resulting string will
823 be written to BUF. */
be27d08c 824extern char *gcvt (double __value, int __ndigit, char *__buf)
0476597b 825 __THROW __nonnull ((3)) __wur;
4220c3ef 826#endif
60478656 827
4220c3ef 828#ifdef __USE_MISC
2064087b 829/* Long double versions of above functions. */
c1422e5b 830extern char *qecvt (long double __value, int __ndigit,
be27d08c 831 int *__restrict __decpt, int *__restrict __sign)
0476597b 832 __THROW __nonnull ((3, 4)) __wur;
c1422e5b 833extern char *qfcvt (long double __value, int __ndigit,
be27d08c 834 int *__restrict __decpt, int *__restrict __sign)
0476597b 835 __THROW __nonnull ((3, 4)) __wur;
be27d08c 836extern char *qgcvt (long double __value, int __ndigit, char *__buf)
0476597b 837 __THROW __nonnull ((3)) __wur;
2064087b
RM
838
839
60478656
RM
840/* Reentrant version of the functions above which provide their own
841 buffers. */
c1422e5b
UD
842extern int ecvt_r (double __value, int __ndigit, int *__restrict __decpt,
843 int *__restrict __sign, char *__restrict __buf,
be27d08c 844 size_t __len) __THROW __nonnull ((3, 4, 5));
c1422e5b
UD
845extern int fcvt_r (double __value, int __ndigit, int *__restrict __decpt,
846 int *__restrict __sign, char *__restrict __buf,
be27d08c 847 size_t __len) __THROW __nonnull ((3, 4, 5));
c1422e5b
UD
848
849extern int qecvt_r (long double __value, int __ndigit,
850 int *__restrict __decpt, int *__restrict __sign,
be27d08c
UD
851 char *__restrict __buf, size_t __len)
852 __THROW __nonnull ((3, 4, 5));
c1422e5b
UD
853extern int qfcvt_r (long double __value, int __ndigit,
854 int *__restrict __decpt, int *__restrict __sign,
be27d08c
UD
855 char *__restrict __buf, size_t __len)
856 __THROW __nonnull ((3, 4, 5));
4220c3ef 857#endif /* misc */
60478656
RM
858
859
7a5affeb 860__BEGIN_NAMESPACE_STD
28f540f4
RM
861/* Return the length of the multibyte character
862 in S, which is no longer than N. */
a065ceff 863extern int mblen (const char *__s, size_t __n) __THROW;
28f540f4
RM
864/* Return the length of the given multibyte character,
865 putting its `wchar_t' representation in *PWC. */
c1422e5b 866extern int mbtowc (wchar_t *__restrict __pwc,
a065ceff 867 const char *__restrict __s, size_t __n) __THROW;
28f540f4
RM
868/* Put the multibyte character represented
869 by WCHAR in S, returning its length. */
a065ceff 870extern int wctomb (char *__s, wchar_t __wchar) __THROW;
28f540f4 871
28f540f4
RM
872
873/* Convert a multibyte string to a wide char string. */
c1422e5b 874extern size_t mbstowcs (wchar_t *__restrict __pwcs,
a784e502 875 const char *__restrict __s, size_t __n) __THROW;
28f540f4 876/* Convert a wide char string to multibyte string. */
c1422e5b 877extern size_t wcstombs (char *__restrict __s,
a784e502 878 const wchar_t *__restrict __pwcs, size_t __n)
c1422e5b 879 __THROW;
7a5affeb 880__END_NAMESPACE_STD
28f540f4
RM
881
882
857fa1b8
RM
883#ifdef __USE_SVID
884/* Determine whether the string value of RESPONSE matches the affirmation
885 or negative response expression as specified by the LC_MESSAGES category
886 in the program's current locale. Returns 1 if affirmative, 0 if
887 negative, and -1 if not matching. */
a784e502 888extern int rpmatch (const char *__response) __THROW __nonnull ((1)) __wur;
857fa1b8
RM
889#endif
890
891
f095bb72 892#if defined __USE_XOPEN_EXTENDED || defined __USE_XOPEN2K8
2064087b
RM
893/* Parse comma separated suboption from *OPTIONP and match against
894 strings in TOKENS. If found return index and set *VALUEP to
895 optional value introduced by an equal sign. If the suboption is
896 not part of TOKENS return in *VALUEP beginning of unknown
897 suboption. On exit *OPTIONP is set to the beginning of the next
2604afb1 898 token or at the terminating NUL character. */
c1422e5b 899extern int getsubopt (char **__restrict __optionp,
a784e502 900 char *const *__restrict __tokens,
be27d08c 901 char **__restrict __valuep)
0476597b 902 __THROW __nonnull ((1, 2, 3)) __wur;
2064087b
RM
903#endif
904
905
2c6fe0bd 906#ifdef __USE_XOPEN
2c6fe0bd 907/* Setup DES tables according KEY. */
a784e502 908extern void setkey (const char *__key) __THROW __nonnull ((1));
0101a56f
UD
909#endif
910
6591c335
UD
911
912/* X/Open pseudo terminal handling. */
913
f095bb72 914#ifdef __USE_XOPEN2KXSI
0101a56f 915/* Return a master pseudo-terminal handle. */
0476597b 916extern int posix_openpt (int __oflag) __wur;
0101a56f
UD
917#endif
918
919#ifdef __USE_XOPEN
6591c335
UD
920/* The next four functions all take a master pseudo-tty fd and
921 perform an operation on the associated slave: */
922
923/* Chown the slave to the calling user. */
c1422e5b 924extern int grantpt (int __fd) __THROW;
6591c335
UD
925
926/* Release an internal lock so the slave can be opened.
927 Call after grantpt(). */
c1422e5b 928extern int unlockpt (int __fd) __THROW;
6591c335 929
6f65e668 930/* Return the pathname of the pseudo terminal slave associated with
4bca4c17
UD
931 the master FD is open on, or NULL on errors.
932 The returned storage is good until the next call to this function. */
0476597b 933extern char *ptsname (int __fd) __THROW __wur;
2c6fe0bd
UD
934#endif
935
6591c335 936#ifdef __USE_GNU
4bca4c17
UD
937/* Store at most BUFLEN characters of the pathname of the slave pseudo
938 terminal associated with the master FD is open on in BUF.
939 Return 0 on success, otherwise an error number. */
be27d08c
UD
940extern int ptsname_r (int __fd, char *__buf, size_t __buflen)
941 __THROW __nonnull ((2));
6591c335 942
4bca4c17 943/* Open a master pseudo terminal and return its file descriptor. */
f1c30c98 944extern int getpt (void);
6591c335 945#endif
2c6fe0bd 946
b2277c15
RM
947#ifdef __USE_BSD
948/* Put the 1 minute, 5 minute and 15 minute load averages into the first
949 NELEM elements of LOADAVG. Return the number written (never more than
950 three, but may be less than NELEM), or -1 if an error occurred. */
be27d08c
UD
951extern int getloadavg (double __loadavg[], int __nelem)
952 __THROW __nonnull ((1));
b2277c15
RM
953#endif
954
f62c8abc 955#include <bits/stdlib-float.h>
b799f91d
UD
956
957/* Define some macros helping to catch buffer overflows. */
5ac3ea17 958#if __USE_FORTIFY_LEVEL > 0 && defined __fortify_function
b799f91d
UD
959# include <bits/stdlib.h>
960#endif
c6251f03
RM
961#ifdef __LDBL_COMPAT
962# include <bits/stdlib-ldbl.h>
963#endif
b799f91d 964
7ef90c15
UD
965#endif /* don't just need malloc and calloc */
966#undef __need_malloc_and_calloc
967
28f540f4
RM
968__END_DECLS
969
970#endif /* stdlib.h */