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