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;
  49 #define _SIZE_T_DECLARED
  50 #endif
  51
  52 #ifndef __cplusplus
  53 #ifndef _WCHAR_T_DECLARED
  54 typedef __wchar_t       wchar_t;
  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      (___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) __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) __heedresult;
 103 int      posix_memalign(void **, size_t, size_t);
 104 int      mblen(const char *, size_t);
 105 size_t   mbstowcs(wchar_t * __restrict , const char * __restrict, size_t);
 106 int      mbtowc(wchar_t * __restrict, const char * __restrict, size_t);
 107 void     qsort(void *, size_t, size_t, int (*)(const void *, const void *));
 108 int      rand(void);
 109 void    *realloc(void *, size_t) __heedresult;
 110 void     srand(unsigned);
 111 double   strtod(const char * __restrict, char ** __restrict);
 112 float    strtof(const char * __restrict, char ** __restrict);
 113 #if !defined(_KERNEL_VIRTUAL)
 114 long     strtol(const char * __restrict, char ** __restrict, int);
 115 #endif
 116 long double
 117          strtold(const char * __restrict, char ** __restrict);
 118 #if !defined(_KERNEL_VIRTUAL)
 119 unsigned long
 120          strtoul(const char * __restrict, char ** __restrict, int);
 121 #endif
 122 int      system(const char *);
 123 int      wctomb(char *, wchar_t);
 124 size_t   wcstombs(char * __restrict, const wchar_t * __restrict, size_t);
 125
 126 /*
 127  * Functions added in C99 which we make conditionally available in the
 128  * BSD^C89 namespace if the compiler supports `long long'.
 129  * The #if test is more complicated than it ought to be because
 130  * __BSD_VISIBLE implies __ISO_C_VISIBLE == 1999 *even if* `long long'
 131  * is not supported in the compilation environment (which therefore means
 132  * that it can't really be ISO C99).
 133  *
 134  * (The only other extension made by C99 in this header is _Exit().)
 135  */
 136 #if __ISO_C_VISIBLE >= 1999
 137 #ifdef __LONG_LONG_SUPPORTED
 138 /* LONGLONG */
 139 typedef struct {
 140         long long quot;
 141         long long rem;
 142 } lldiv_t;
 143
 144 /* LONGLONG */
 145 long long
 146          atoll(const char *);
 147 /* LONGLONG */
 148 long long
 149          llabs(long long) __pure2;
 150 /* LONGLONG */
 151 lldiv_t  lldiv(long long, long long) __pure2;
 152 /* LONGLONG */
 153 long long
 154          strtoll(const char * __restrict, char ** __restrict, int);
 155 /* LONGLONG */
 156 unsigned long long
 157          strtoull(const char * __restrict, char ** __restrict, int);
 158 #endif /* __LONG_LONG_SUPPORTED */
 159
 160 void     _Exit(int) __dead2;
 161 #endif /* __ISO_C_VISIBLE >= 1999 */
 162
 163 /*
 164  * Extensions made by POSIX relative to C.  We don't know yet which edition
 165  * of POSIX made these extensions, so assume they've always been there until
 166  * research can be done.
 167  */
 168 #if __POSIX_VISIBLE /* >= ??? */
 169 /*int    posix_memalign(void **, size_t, size_t); (ADV) */
 170 int      rand_r(unsigned *);                    /* (TSF) */
 171 int      setenv(const char *, const char *, int);
 172 int      unsetenv(const char *);
 173 #endif
 174
 175 #if __POSIX_VISIBLE >= 200809 || __XSI_VISIBLE
 176 int      getsubopt(char **, char *const *, char **);
 177 #ifndef _MKDTEMP_DECLARED
 178 char    *mkdtemp(char *);
 179 #define _MKDTEMP_DECLARED
 180 #endif
 181 #ifndef _MKSTEMP_DECLARED
 182 int      mkstemp(char *);
 183 #define _MKSTEMP_DECLARED
 184 #endif
 185 #endif /* __POSIX_VISIBLE >= 200809 || __XSI_VISIBLE */
 186
 187 /*
 188  * The only changes to the XSI namespace in revision 6 were the deletion
 189  * of the ttyslot() and valloc() functions, which we never declared
 190  * in this header.  For revision 7, ecvt(), fcvt(), and gcvt(), which
 191  * we also do not have, and mktemp(), are to be deleted.
 192  */
 193 #if __XSI_VISIBLE
 194 /* XXX XSI requires pollution from <sys/wait.h> here.  We'd rather not. */
 195 long     a64l(const char *);
 196 double   drand48(void);
 197 double   erand48(unsigned short[3]);
 198 #if 0
 199 #if __BSD_VISIBLE || __XSI_VISIBLE <= 600
 200 char    *ecvt(double, int, int * __restrict, int * __restrict); /* LEGACY */
 201 char    *fcvt(double, int, int * __restrict, int * __restrict); /* LEGACY */
 202 char    *gcvt(double, int, int * __restrict, int * __restrict); /* LEGACY */
 203 #endif
 204 #endif
 205 int      grantpt(int);
 206 char    *initstate(unsigned long /* XSI requires u_int */, char *, long);
 207 long     jrand48(unsigned short[3]);
 208 char    *l64a(long);
 209 void     lcong48(unsigned short[7]);
 210 long     lrand48(void);
 211 #if !defined(_MKTEMP_DECLARED) && (__BSD_VISIBLE || __XSI_VISIBLE <= 600)
 212 char    *mktemp(char *);                                        /* LEGACY */
 213 #define _MKTEMP_DECLARED
 214 #endif
 215 long     mrand48(void);
 216 long     nrand48(unsigned short[3]);
 217 int      posix_openpt(int);
 218 char    *ptsname(int);
 219 int      putenv(char *);
 220 long     random(void);
 221 char    *realpath(const char * __restrict, char * __restrict);
 222 unsigned short
 223         *seed48(unsigned short[3]);
 224 int      setkey(const char *);
 225 char    *setstate(/* const */ char *);
 226 void     srand48(long);
 227 void     srandom(unsigned long);
 228 int      unlockpt(int);
 229 #endif /* __XSI_VISIBLE */
 230
 231 #if __BSD_VISIBLE
 232 /* extern const char *_malloc_options;
 233 extern void (*_malloc_message)(const char *, const char *, const char *,
 234             const char *); */
 235
 236 /*
 237  * The alloca() function can't be implemented in C, and on some
 238  * platforms it can't be implemented at all as a callable function.
 239  * The GNU C compiler provides a built-in alloca() which we can use;
 240  * in all other cases, provide a prototype, mainly to pacify various
 241  * incarnations of lint.  On platforms where alloca() is not in libc,
 242  * programs which use it will fail to link when compiled with non-GNU
 243  * compilers.
 244  */
 245 #if __GNUC__ >= 2 || defined(__INTEL_COMPILER)
 246 #undef  alloca  /* some GNU bits try to get cute and define this on their own */
 247 #define alloca(sz) __builtin_alloca(sz)
 248 #elif defined(lint)
 249 void    *alloca(size_t);
 250 #endif
 251
 252 __uint32_t
 253          arc4random(void);
 254 void     arc4random_addrandom(__uint8_t *, size_t);
 255 void     arc4random_buf(void *, size_t);
 256 void     arc4random_stir(void);
 257 __uint32_t
 258          arc4random_uniform(__uint32_t);
 259 char    *getbsize(int *, long *);
 260
 261 /* getcap(3) functions */
 262 char    *cgetcap(char *, const char *, int);
 263 int      cgetclose(void);
 264 int      cgetent(char **, char **, const char *);
 265 int      cgetfirst(char **, char **);
 266 int      cgetmatch(const char *, const char *);
 267 int      cgetnext(char **, char **);
 268 int      cgetnum(char *, const char *, long *);
 269 int      cgetset(const char *);
 270 int      cgetstr(char *, const char *, char **);
 271 int      cgetustr(char *, const char *, char **);
 272
 273 int      daemon(int, int);
 274 char    *devname(dev_t, mode_t);
 275 char    *devname_r(dev_t, mode_t, char *, size_t);
 276 char    *fdevname(int);
 277 int      fdevname_r(int, char *, size_t);
 278 int      getloadavg(double [], int);
 279 const char *
 280          getprogname(void);
 281
 282 int      heapsort(void *, size_t, size_t, int (*)(const void *, const void *));
 283 int      l64a_r(long, char *, int);
 284 int      mergesort(void *, size_t, size_t, int (*)(const void *, const void *));
 285 int      mkostemp(char *, int);
 286 int      mkostemps(char *, int, int);
 287 void     qsort_r(void *, size_t, size_t, void *,
 288                  int (*)(void *, const void *, const void *));
 289 int      radixsort(const unsigned char **, int, const unsigned char *,
 290                    unsigned int);
 291 void    *reallocf(void *, size_t) __heedresult;
 292 int      rpmatch(const char *);
 293 void     setprogname(const char *);
 294 int      sradixsort(const unsigned char **, int, const unsigned char *,
 295                     unsigned int);
 296 void     sranddev(void);
 297 void     srandomdev(void);
 298 long long
 299          strtonum(const char *, long long, long long, const char **);
 300
 301 /* Deprecated interfaces. */
 302 #if !defined(_KERNEL_VIRTUAL)
 303 __int64_t
 304          strtoq(const char *, char **, int);
 305 __uint64_t
 306          strtouq(const char *, char **, int);
 307 #endif
 308
 309 extern char *suboptarg;                 /* getsubopt(3) external variable */
 310 #endif /* __BSD_VISIBLE */
 311
 312 /*
 313  * C11 functions.
 314  */
 315 #if __ISO_C_VISIBLE >= 2011 || __cplusplus >= 201103L
 316 int     at_quick_exit(void (*func)(void));
 317 _Noreturn void
 318         quick_exit(int);
 319 void    *aligned_alloc(size_t, size_t) __heedresult;
 320 #endif /* __ISO_C_VISIBLE >= 2011 */
 321
 322 __END_DECLS
 323
 324 #endif /* !_STDLIB_H_ */