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