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