stdlib/stdlib.h

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