NAME

stdlib.h — standard library definitions

SYNOPSIS

#include <stdlib.h>

DESCRIPTION

^[CX] Some of the functionality described on this reference page extends the ISO C standard. Applications shall define the appropriate feature test macro (see XSH 2.2 The Compilation Environment) to enable the visibility of these symbols in this header.

The <stdlib.h> header shall define the following macros which shall expand to integer constant expressions:

EXIT_FAILURE

Unsuccessful termination for exit(); ^[CX]  the value shall be between 1 and 125 inclusive.

EXIT_SUCCESS

Successful termination for exit(); the value shall be 0.

{RAND_MAX}

Maximum value returned by rand(); at least 32767.

The <stdlib.h> header shall define the following macro which shall expand to a positive integer expression with type size_t:

{MB_CUR_MAX}

Maximum number of bytes in a character specified by the current locale (category LC_CTYPE ).

^[CX] In the POSIX locale the value of {MB_CUR_MAX} shall be 1.

The <stdlib.h> header shall define NULL as described in <stddef.h>.

The <stdlib.h> header shall define the following data types through typedef:

div_t

Structure type returned by the div() function.

ldiv_t

Structure type returned by the ldiv() function.

lldiv_t

Structure type returned by the lldiv() function.

size_t

As described in <stddef.h>.

wchar_t

As described in <stddef.h>.

^[CX] In addition, the <stdlib.h> header shall define the following symbolic constants and macros as described in <sys/wait.h>:

WCOREDUMP
WEXITSTATUS
WIFEXITED
WIFSIGNALED
WIFSTOPPED
WNOHANG
WSTOPSIG
WTERMSIG
WUNTRACED

^[CX] The <stdlib.h> header shall define the following symbolic constants as described in <fcntl.h>:

O_APPEND
O_CLOEXEC
O_CLOFORK

^[SIO]
O_DSYNC

^[XSI]
O_NOCTTY
O_RDWR

^[SIO]
O_RSYNC

^[CX]
O_SYNC

The following shall be declared as functions and may also be defined as macros. Function prototypes shall be provided.

_Noreturn void  _Exit(int);
[XSI]
long            a64l(const char *);

_Noreturn void  abort(void);
int             abs(int);
void           *aligned_alloc(size_t, size_t);
int             at_quick_exit(void (*)(void));
int             atexit(void (*)(void));
double          atof(const char *);
int             atoi(const char *);
long            atol(const char *);
long long       atoll(const char *);
void           *bsearch(const void *, const void *, size_t, size_t,
                    int (*)(const void *, const void *));
void           *calloc(size_t, size_t);
div_t           div(int, int);
[XSI]
double          drand48(void);
double          erand48(unsigned short [3]);

_Noreturn void  exit(int);
void            free(void *);
char           *getenv(const char *);
[CX]
int             getsubopt(char **restrict, char *const *restrict,
                    char **restrict);

[XSI]
int             grantpt(int);
char           *initstate(unsigned, char *, size_t);
long            jrand48(unsigned short [3]);
char           *l64a(long);

long            labs(long);
[XSI]
void            lcong48(unsigned short [7]);

ldiv_t          ldiv(long, long);
long long       llabs(long long);
lldiv_t         lldiv(long long, long long);
[XSI]
long            lrand48(void);

void           *malloc(size_t);
int             mblen(const char *, size_t);
size_t          mbstowcs(wchar_t *restrict, const char *restrict,
                    size_t);
int             mbtowc(wchar_t *restrict, const char *restrict, size_t);
[CX]
char           *mkdtemp(char *);
int             mkostemp(char *, int);
int             mkstemp(char *);

[XSI]
long            mrand48(void);
long            nrand48(unsigned short [3]);

[ADV]
int             posix_memalign(void **, size_t, size_t);

[XSI]
int             posix_openpt(int);
char           *ptsname(int);
int             ptsname_r(int, char *, size_t);
int             putenv(char *);

void            qsort(void *, size_t, size_t, int (*)(const void *,
                    const void *));
_Noreturn void  quick_exit(int);
[CX]
void            qsort_r(void *, size_t, size_t, int (*)(const void *,
                    const void *, void *), void *);

int             rand(void);
[XSI]
long            random(void);

void           *realloc(void *, size_t);
[CX]
void           *reallocarray(void *, size_t, size_t);
char           *realpath(const char *restrict, char *restrict);
char           *secure_getenv(const char *);

[XSI]
unsigned short *seed48(unsigned short [3]);

[CX]
int             setenv(const char *, const char *, int);

[OB XSI]
void            setkey(const char *);

[XSI]
char            *setstate(char *);

void            srand(unsigned);
[XSI]
void            srand48(long);
void            srandom(unsigned);

double          strtod(const char *restrict, char **restrict);
float           strtof(const char *restrict, char **restrict);
long            strtol(const char *restrict, char **restrict, int);
long double     strtold(const char *restrict, char **restrict);
long long       strtoll(const char *restrict, char **restrict, int);
unsigned long   strtoul(const char *restrict, char **restrict, int);
unsigned long long
                strtoull(const char *restrict, char **restrict, int);
int             system(const char *);
[XSI]
int             unlockpt(int);

[CX]
int             unsetenv(const char *);

size_t          wcstombs(char *restrict, const wchar_t *restrict,
                    size_t);
int             wctomb(char *, wchar_t);

^[CX] Inclusion of the <stdlib.h> header may also make visible all symbols from <fcntl.h>, <limits.h>, <math.h>, <stddef.h>, and <sys/wait.h>.

APPLICATION USAGE

None.

RATIONALE

The ISO C standard requires that exit(EXIT_FAILURE) returns "unsuccessful termination status" to the host environment. In a POSIX host environment this means that the lower 8 bits of EXIT_FAILURE must have at least one bit set. The standard developers decided to further restrict the allowed values for the following reasons:

• Exit statuses of 126 and greater are ambiguous in certain circumstances because they have special meanings in the shell (see XCU 2.8.2 Exit Status for Commands and the EXIT STATUS section of sh).

• The xargs utility quits when a command execution exits with status 255 (see XCU xargs).

• Calling exit() with a value greater than 255 or less than 0 is something that only programs which are specifically designed to have their exit status obtained by waitid() should do (since it does not truncate the exit status to 8 bits). "Pure ISO C" programs that call exit(EXIT_FAILURE) do not meet this design criterion.

The requirement that the value of EXIT_SUCCESS is 0 is not shaded CX because this matches the requirement in the ISO C standard that exit(EXIT_SUCCESS) returns "successful termination status" to the host environment (when the host environment is a POSIX implementation).

FUTURE DIRECTIONS

None.

SEE ALSO

<limits.h>, <math.h>, <stddef.h>, <sys/types.h>, <sys/wait.h>

XSH 2.2 The Compilation Environment, _Exit, a64l, abort, abs, atexit, atof, atoi, atol, bsearch, calloc, div, drand48, exit, free, getenv, getsubopt, grantpt, initstate, labs, ldiv, malloc, mblen, mbstowcs, mbtowc, mkdtemp, posix_memalign, posix_openpt, ptsname, putenv, qsort, rand, realloc, realpath, setenv, setkey, strtod, strtol, strtoul, system, unlockpt, unsetenv, waitid, wcstombs, wctomb

CHANGE HISTORY

First released in Issue 3.

Issue 5

The DESCRIPTION is updated for alignment with the POSIX Threads Extension.

The ttyslot() and valloc() functions are marked LEGACY.

The type of the third argument to initstate() is changed from int to size_t. The type of the return value from setstate() is changed from char to char *, and the type of the first argument is changed from char * to const char *.

Issue 6

The Open Group Corrigendum U021/1 is applied, correcting the prototype for realpath() to be consistent with the reference page.

The Open Group Corrigendum U028/13 is applied, correcting the prototype for putenv() to be consistent with the reference page.

The rand_r() function is marked as part of the Thread-Safe Functions option.

Function prototypes for setenv() and unsetenv() are added.

The posix_memalign() function is added for alignment with IEEE Std 1003.1d-1999.

This reference page is updated to align with the ISO/IEC 9899:1999 standard.

The ecvt(), fcvt(), gcvt(), and mktemp() functions are marked LEGACY.

The ttyslot() and valloc() functions are removed as they were previously marked LEGACY.

Extensions beyond the ISO C standard are marked.

Issue 7

SD5-XBD-ERN-79 and SD5-XBD-ERN-105 are applied.

The LEGACY functions are removed.

The mkdtemp() function is added from The Open Group Technical Standard, 2006, Extended API Set Part 1.

The rand_r() function is marked obsolescent.

This reference page is clarified with respect to macros and symbolic constants.

The type of the first argument to setstate() is changed from const char * to char *.

POSIX.1-2008, Technical Corrigendum 1, XBD/TC1-2008/0066 [197] is applied.

POSIX.1-2008, Technical Corrigendum 2, XBD/TC2-2008/0075 [663] is applied.

Issue 8

Austin Group Defect 411 is applied, adding mkostemp().

Austin Group Defect 444 is applied, adding the restrict keyword to the getsubopt() prototype.

Austin Group Defect 508 is applied, adding the ptsname_r() function.

Austin Group Defects 593 and 1350 are applied, adding some O_* symbolic constants and allowing <stdlib.h> to make visible all symbols from <fcntl.h>.

Austin Group Defect 900 is applied, adding the qsort_r() function.

Austin Group Defect 922 is applied, adding the secure_getenv() function.

Austin Group Defect 1141 is applied, adding WCOREDUMP.

Austin Group Defect 1192 is applied, marking the setkey() function as obsolescent.

Austin Group Defect 1218 is applied, adding reallocarray().

Austin Group Defect 1229 is applied, changing the descriptions of EXIT_FAILURE and EXIT_SUCCESS, and the RATIONALE section.

Austin Group Defect 1302 is applied, aligning this header with the ISO/IEC 9899:2018 standard.

Austin Group Defect 1330 is applied, removing obsolescent interfaces.

Austin Group Defect 1629 is applied, changing the RATIONALE section.

Austin Group Defect 1663 is applied, removing XSI shading from realpath().