include/stdlib.h

   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. Neither the name of the University nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  *      @(#)stdlib.h    8.5 (Berkeley) 5/19/95
  30  * $FreeBSD: src/include/stdlib.h,v 1.67 2008/07/22 11:40:42 ache Exp $
  31  */
  32
  33 #ifndef _STDLIB_H_
  34 #define _STDLIB_H_
  35
  36 #include <sys/cdefs.h>
  37 #include <sys/_null.h>
  38 #include <sys/types.h>
  39
  40 #if __BSD_VISIBLE
  41 #ifndef _RUNE_T_DECLARED
  42 typedef __rune_t        rune_t;
  43 #define _RUNE_T_DECLARED
  44 #endif
  45 #endif
  46
  47 #ifndef _SIZE_T_DECLARED
  48 typedef __size_t        size_t;         /* _GCC_SIZE_T OK */
  49 #define _SIZE_T_DECLARED
  50 #endif
  51
  52 #ifndef __cplusplus
  53 #ifndef _WCHAR_T_DECLARED
  54 typedef __wchar_t       wchar_t;        /* _GCC_WCHAR_T OK */
  55 #define _WCHAR_T_DECLARED
  56 #endif
  57 #endif
  58
  59 #if __EXT1_VISIBLE
  60 #ifndef _ERRNO_T_DEFINED
  61 typedef int             errno_t;
  62 #define _ERRNO_T_DEFINED
  63 #endif
  64 #endif
  65
  66 typedef struct {
  67         int     quot;           /* quotient */
  68         int     rem;            /* remainder */
  69 } div_t;
  70
  71 typedef struct {
  72         long    quot;
  73         long    rem;
  74 } ldiv_t;
  75
  76 #define EXIT_FAILURE    1
  77 #define EXIT_SUCCESS    0
  78
  79 #define RAND_MAX        0x7fffffff
  80
  81 __BEGIN_DECLS
  82 #ifdef _XLOCALE_H_
  83 #include <xlocale/_stdlib.h>
  84 #endif
  85 extern int __mb_cur_max;
  86 extern int ___mb_cur_max(void);
  87 #define MB_CUR_MAX      ((size_t)___mb_cur_max())
  88
  89 void     abort(void) __dead2;
  90 /* void  abort2(const char *, int, void **) __dead2; */
  91 #if !defined(_KERNEL_VIRTUAL)
  92 int      abs(int) __pure2;
  93 #endif
  94 int      atexit(void (*)(void));
  95 double   atof(const char *);
  96 int      atoi(const char *);
  97 long     atol(const char *);
  98 void    *bsearch(const void *, const void *, size_t,
  99                  size_t, int (*)(const void *, const void *));
 100 void    *calloc(size_t, size_t) __alloc_size2(1, 2) __malloclike __heedresult;
 101 div_t    div(int, int) __pure2;
 102 void     exit(int) __dead2;
 103 void     free(void *);
 104 char    *getenv(const char *);
 105 #if !defined(_KERNEL_VIRTUAL)
 106 long     labs(long) __pure2;
 107 #endif
 108 ldiv_t   ldiv(long, long) __pure2;
 109 void    *malloc(size_t) __malloclike __heedresult __alloc_size(1);
 110 int      mblen(const char *, size_t);
 111 size_t   mbstowcs(wchar_t * __restrict , const char * __restrict, size_t);
 112 int      mbtowc(wchar_t * __restrict, const char * __restrict, size_t);
 113 void     qsort(void *, size_t, size_t, int (*)(const void *, const void *));
 114 int      rand(void);
 115 void    *realloc(void *, size_t) __heedresult __alloc_size(2);
 116 void     srand(unsigned);
 117 double   strtod(const char * __restrict, char ** __restrict);
 118 float    strtof(const char * __restrict, char ** __restrict);
 119 #if !defined(_KERNEL_VIRTUAL)
 120 long     strtol(const char * __restrict, char ** __restrict, int);
 121 #endif
 122 long double
 123          strtold(const char * __restrict, char ** __restrict);
 124 #if !defined(_KERNEL_VIRTUAL)
 125 unsigned long
 126          strtoul(const char * __restrict, char ** __restrict, int);
 127 #endif
 128 int      system(const char *);
 129 int      wctomb(char *, wchar_t);
 130 size_t   wcstombs(char * __restrict, const wchar_t * __restrict, size_t);
 131
 132 /*
 133  * Functions added in C99 which we make conditionally available in the
 134  * BSD^C89 namespace if the compiler supports `long long'.
 135  * The #if test is more complicated than it ought to be because
 136  * __BSD_VISIBLE implies __ISO_C_VISIBLE == 1999 *even if* `long long'
 137  * is not supported in the compilation environment (which therefore means
 138  * that it can't really be ISO C99).
 139  *
 140  * (The only other extension made by C99 in this header is _Exit().)
 141  */
 142 #if __ISO_C_VISIBLE >= 1999 || defined(__cplusplus)
 143 #ifdef __LONG_LONG_SUPPORTED
 144 /* LONGLONG */
 145 typedef struct {
 146         long long quot;
 147         long long rem;
 148 } lldiv_t;
 149
 150 /* LONGLONG */
 151 long long
 152          atoll(const char *);
 153 /* LONGLONG */
 154 long long
 155          llabs(long long) __pure2;
 156 /* LONGLONG */
 157 lldiv_t  lldiv(long long, long long) __pure2;
 158 /* LONGLONG */
 159 long long
 160          strtoll(const char * __restrict, char ** __restrict, int);
 161 /* LONGLONG */
 162 unsigned long long
 163          strtoull(const char * __restrict, char ** __restrict, int);
 164 #endif /* __LONG_LONG_SUPPORTED */
 165
 166 void     _Exit(int) __dead2;
 167 #endif /* __ISO_C_VISIBLE >= 1999 */
 168
 169 /*
 170  * C11 functions.
 171  */
 172 #if __ISO_C_VISIBLE >= 2011 || __cplusplus >= 201103L
 173 void    *aligned_alloc(size_t, size_t) __malloclike __heedresult
 174             __alloc_align(1) __alloc_size(2);
 175 int     at_quick_exit(void (*)(void));  /* extra extern case for __cplusplus? */
 176 void    quick_exit(int) __dead2;
 177 #endif /* __ISO_C_VISIBLE >= 2011 */
 178
 179 /*
 180  * Extensions made by POSIX relative to C.
 181  */
 182 #if __POSIX_VISIBLE >= 199506
 183 int      rand_r(unsigned *);                    /* (TSF) */
 184 #endif
 185 #if __POSIX_VISIBLE >= 200112
 186 int      posix_memalign(void **, size_t, size_t) __nonnull(1); /* (ADV) */
 187 int      setenv(const char *, const char *, int);
 188 int      unsetenv(const char *);
 189 #endif
 190
 191 #if __POSIX_VISIBLE >= 200809 || __XSI_VISIBLE
 192 int      getsubopt(char **, char *const *, char **);
 193 #ifndef _MKDTEMP_DECLARED
 194 char    *mkdtemp(char *);
 195 #define _MKDTEMP_DECLARED
 196 #endif
 197 #ifndef _MKSTEMP_DECLARED
 198 int      mkstemp(char *);
 199 #define _MKSTEMP_DECLARED
 200 #endif
 201 #endif /* __POSIX_VISIBLE >= 200809 || __XSI_VISIBLE */
 202
 203 /*
 204  * The only changes to the XSI namespace in revision 6 were the deletion
 205  * of the ttyslot() and valloc() functions, which we never declared
 206  * in this header.  For revision 7, ecvt(), fcvt(), and gcvt(), which
 207  * we also do not have, and mktemp(), are to be deleted.
 208  */
 209 #if __XSI_VISIBLE
 210 /* XXX XSI requires pollution from <sys/wait.h> here.  We'd rather not. */
 211 long     a64l(const char *);
 212 double   drand48(void);
 213 double   erand48(unsigned short[3]);
 214 #if 0
 215 #if __BSD_VISIBLE || (__XSI_VISIBLE && __XSI_VISIBLE < 700)
 216 char    *ecvt(double, int, int * __restrict, int * __restrict); /* LEGACY */
 217 char    *fcvt(double, int, int * __restrict, int * __restrict); /* LEGACY */
 218 char    *gcvt(double, int, int * __restrict, int * __restrict); /* LEGACY */
 219 #endif
 220 #endif
 221 int      grantpt(int);
 222 char    *initstate(unsigned long /* XSI requires u_int */, char *, long);
 223 long     jrand48(unsigned short[3]);
 224 char    *l64a(long);
 225 void     lcong48(unsigned short[7]);
 226 long     lrand48(void);
 227 #if __BSD_VISIBLE || (__XSI_VISIBLE && __XSI_VISIBLE < 700)
 228 #if !defined(_MKTEMP_DECLARED)
 229 char    *mktemp(char *);                                        /* LEGACY */
 230 #define _MKTEMP_DECLARED
 231 #endif
 232 #endif
 233 long     mrand48(void);
 234 long     nrand48(unsigned short[3]);
 235 int      posix_openpt(int);
 236 char    *ptsname(int);
 237 int      putenv(char *);
 238 long     random(void);
 239 char    *realpath(const char * __restrict, char * __restrict);
 240 unsigned short
 241         *seed48(unsigned short[3]);
 242 int      setkey(const char *);
 243 char    *setstate(/* const */ char *);
 244 void     srand48(long);
 245 void     srandom(unsigned long);
 246 int      unlockpt(int);
 247 #endif /* __XSI_VISIBLE */
 248
 249 #if __BSD_VISIBLE
 250 /* extern const char *_malloc_options;
 251 extern void (*_malloc_message)(const char *, const char *, const char *,
 252             const char *); */
 253
 254 /*
 255  * The alloca() function can't be implemented in C, and on some
 256  * platforms it can't be implemented at all as a callable function.
 257  * The GNU C compiler provides a built-in alloca() which we can use.
 258  * On platforms where alloca() is not in libc, programs which use it
 259  * will fail to link when compiled with non-GNU compilers.
 260  */
 261 #if __GNUC__ >= 2 || defined(__INTEL_COMPILER)
 262 #undef  alloca  /* some GNU bits try to get cute and define this on their own */
 263 #define alloca(sz) __builtin_alloca(sz)
 264 #endif
 265
 266 __uint32_t
 267          arc4random(void);
 268 void     arc4random_addrandom(__uint8_t *, size_t);
 269 void     arc4random_buf(void *, size_t);
 270 void     arc4random_stir(void);
 271 __uint32_t
 272          arc4random_uniform(__uint32_t);
 273 char    *getbsize(int *, long *);
 274
 275 /* getcap(3) functions */
 276 char    *cgetcap(char *, const char *, int);
 277 int      cgetclose(void);
 278 int      cgetent(char **, char **, const char *);
 279 int      cgetfirst(char **, char **);
 280 int      cgetmatch(const char *, const char *);
 281 int      cgetnext(char **, char **);
 282 int      cgetnum(char *, const char *, long *);
 283 int      cgetset(const char *);
 284 int      cgetstr(char *, const char *, char **);
 285 int      cgetustr(char *, const char *, char **);
 286
 287 int      daemon(int, int);
 288 char    *devname(dev_t, mode_t);
 289 char    *devname_r(dev_t, mode_t, char *, size_t);
 290 char    *fdevname(int);
 291 int      fdevname_r(int, char *, size_t);
 292 void     freezero(void *, size_t);
 293 int      getloadavg(double [], int);
 294 const char *
 295          getprogname(void);
 296
 297 int      heapsort(void *, size_t, size_t, int (*)(const void *, const void *));
 298 int      l64a_r(long, char *, int);
 299 int      mergesort(void *, size_t, size_t, int (*)(const void *, const void *));
 300 int      mkostemp(char *, int);
 301 int      mkostemps(char *, int, int);
 302 void     qsort_r(void *, size_t, size_t, void *,
 303                  int (*)(void *, const void *, const void *));
 304 int      radixsort(const unsigned char **, int, const unsigned char *,
 305                    unsigned int);
 306 void    *reallocarray(void *, size_t, size_t) __heedresult __alloc_size2(2, 3);
 307 void    *recallocarray(void *, size_t, size_t, size_t) __heedresult
 308             __alloc_size2(3, 4);
 309 void    *reallocf(void *, size_t) __heedresult __alloc_size(2);
 310 int      rpmatch(const char *);
 311 void     setprogname(const char *);
 312 int      sradixsort(const unsigned char **, int, const unsigned char *,
 313                     unsigned int);
 314 void     sranddev(void);
 315 void     srandomdev(void);
 316 long long
 317          strsuftoll(const char *, const char *, long long, long long);
 318 long long
 319          strsuftollx(const char *, const char *, long long, long long, char *,
 320             size_t);
 321 long long
 322          strtonum(const char *, long long, long long, const char **);
 323
 324 /* Deprecated interfaces. */
 325 #if !defined(_KERNEL_VIRTUAL)
 326 __int64_t
 327          strtoq(const char *, char **, int);
 328 __uint64_t
 329          strtouq(const char *, char **, int);
 330 #endif
 331
 332 extern char *suboptarg;                 /* getsubopt(3) external variable */
 333 #endif /* __BSD_VISIBLE */
 334
 335 #if __EXT1_VISIBLE
 336 /* K.3.6 */
 337 typedef void (*constraint_handler_t)(const char * __restrict,
 338     void * __restrict, errno_t);
 339 /* K.3.6.1.1 */
 340 constraint_handler_t set_constraint_handler_s(constraint_handler_t handler);
 341 /* K.3.6.1.2 */
 342 _Noreturn void abort_handler_s(const char * __restrict, void * __restrict,
 343     errno_t);
 344 /* K3.6.1.3 */
 345 void ignore_handler_s(const char * __restrict, void * __restrict, errno_t);
 346 #endif /* __EXT1_VISIBLE */
 347 __END_DECLS
 348
 349 #endif /* !_STDLIB_H_ */