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$
  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        0x7ffffffd
  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 _Noreturn void   abort(void);
  83 int      abs(int) __pure2;
  84 int      atexit(void (*)(void));
  85 double   atof(const char *);
  86 int      atoi(const char *);
  87 long     atol(const char *);
  88 void    *bsearch(const void *, const void *, size_t,
  89             size_t, int (*)(const void *, const void *));
  90 void    *calloc(size_t, size_t) __malloc_like;
  91 div_t    div(int, int) __pure2;
  92 _Noreturn void   exit(int);
  93 void     free(void *);
  94 char    *getenv(const char *);
  95 long     labs(long) __pure2;
  96 ldiv_t   ldiv(long, long) __pure2;
  97 void    *malloc(size_t) __malloc_like;
  98 int      mblen(const char *, size_t);
  99 size_t   mbstowcs(wchar_t * __restrict , const char * __restrict, size_t);
 100 int      mbtowc(wchar_t * __restrict, const char * __restrict, size_t);
 101 void     qsort(void *, size_t, size_t,
 102             int (*)(const void *, const void *));
 103 int      rand(void);
 104 void    *realloc(void *, size_t);
 105 void     srand(unsigned);
 106 double   strtod(const char * __restrict, char ** __restrict);
 107 float    strtof(const char * __restrict, char ** __restrict);
 108 long     strtol(const char * __restrict, char ** __restrict, int);
 109 long double
 110          strtold(const char * __restrict, char ** __restrict);
 111 unsigned long
 112          strtoul(const char * __restrict, char ** __restrict, int);
 113 int      system(const char *);
 114 int      wctomb(char *, wchar_t);
 115 size_t   wcstombs(char * __restrict, const wchar_t * __restrict, size_t);
 116
 117 /*
 118  * Functions added in C99 which we make conditionally available in the
 119  * BSD^C89 namespace if the compiler supports `long long'.
 120  * The #if test is more complicated than it ought to be because
 121  * __BSD_VISIBLE implies __ISO_C_VISIBLE == 1999 *even if* `long long'
 122  * is not supported in the compilation environment (which therefore means
 123  * that it can't really be ISO C99).
 124  *
 125  * (The only other extension made by C99 in thie header is _Exit().)
 126  */
 127 #if __ISO_C_VISIBLE >= 1999 || defined(__cplusplus)
 128 #ifdef __LONG_LONG_SUPPORTED
 129 /* LONGLONG */
 130 typedef struct {
 131         long long quot;
 132         long long rem;
 133 } lldiv_t;
 134
 135 /* LONGLONG */
 136 long long
 137          atoll(const char *);
 138 /* LONGLONG */
 139 long long
 140          llabs(long long) __pure2;
 141 /* LONGLONG */
 142 lldiv_t  lldiv(long long, long long) __pure2;
 143 /* LONGLONG */
 144 long long
 145          strtoll(const char * __restrict, char ** __restrict, int);
 146 /* LONGLONG */
 147 unsigned long long
 148          strtoull(const char * __restrict, char ** __restrict, int);
 149 #endif /* __LONG_LONG_SUPPORTED */
 150
 151 _Noreturn void   _Exit(int);
 152 #endif /* __ISO_C_VISIBLE >= 1999 */
 153
 154 /*
 155  * If we're in a mode greater than C99, expose C11 functions.
 156  */
 157 #if __ISO_C_VISIBLE >= 2011 || __cplusplus >= 201103L
 158 void *  aligned_alloc(size_t, size_t) __malloc_like;
 159 int     at_quick_exit(void (*)(void));
 160 _Noreturn void
 161         quick_exit(int);
 162 #endif /* __ISO_C_VISIBLE >= 2011 */
 163 /*
 164  * Extensions made by POSIX relative to C.
 165  */
 166 #if __POSIX_VISIBLE >= 199506 || __XSI_VISIBLE
 167 char    *realpath(const char * __restrict, char * __restrict);
 168 #endif
 169 #if __POSIX_VISIBLE >= 199506
 170 int      rand_r(unsigned *);                    /* (TSF) */
 171 #endif
 172 #if __POSIX_VISIBLE >= 200112
 173 int      posix_memalign(void **, size_t, size_t); /* (ADV) */
 174 int      setenv(const char *, const char *, int);
 175 int      unsetenv(const char *);
 176 #endif
 177
 178 #if __POSIX_VISIBLE >= 200809 || __XSI_VISIBLE
 179 int      getsubopt(char **, char *const *, char **);
 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 FreeBSD never declared
 193  * in this header.  For revision 7, ecvt(), fcvt(), and gcvt(), which
 194  * FreeBSD also does 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 /* char *ecvt(double, int, int * __restrict, int * __restrict); */
 201 double   erand48(unsigned short[3]);
 202 /* char *fcvt(double, int, int * __restrict, int * __restrict); */
 203 /* char *gcvt(double, int, int * __restrict, int * __restrict); */
 204 int      grantpt(int);
 205 char    *initstate(unsigned long /* XSI requires u_int */, char *, long);
 206 long     jrand48(unsigned short[3]);
 207 char    *l64a(long);
 208 void     lcong48(unsigned short[7]);
 209 long     lrand48(void);
 210 #if !defined(_MKTEMP_DECLARED) && (__BSD_VISIBLE || __XSI_VISIBLE <= 600)
 211 char    *mktemp(char *);
 212 #define _MKTEMP_DECLARED
 213 #endif
 214 long     mrand48(void);
 215 long     nrand48(unsigned short[3]);
 216 int      posix_openpt(int);
 217 char    *ptsname(int);
 218 int      putenv(char *);
 219 long     random(void);
 220 unsigned short
 221         *seed48(unsigned short[3]);
 222 #ifndef _SETKEY_DECLARED
 223 int      setkey(const char *);
 224 #define _SETKEY_DECLARED
 225 #endif
 226 char    *setstate(/* const */ char *);
 227 void     srand48(long);
 228 void     srandom(unsigned long);
 229 int      unlockpt(int);
 230 #endif /* __XSI_VISIBLE */
 231
 232 #if __BSD_VISIBLE
 233 extern const char *malloc_conf;
 234 extern void (*malloc_message)(void *, 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 void     abort2(const char *, int, void **) __dead2;
 253 __uint32_t
 254          arc4random(void);
 255 void     arc4random_addrandom(unsigned char *, int);
 256 void     arc4random_buf(void *, size_t);
 257 void     arc4random_stir(void);
 258 __uint32_t
 259          arc4random_uniform(__uint32_t);
 260 char    *getbsize(int *, long *);
 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 *, int);
 276 char    *fdevname(int);
 277 char    *fdevname_r(int, char *, int);
 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);
 291 void    *reallocf(void *, size_t);
 292 int      rpmatch(const char *);
 293 void     setprogname(const char *);
 294 int      sradixsort(const unsigned char **, int, const unsigned char *,
 295             unsigned);
 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, to be removed. */
 302 __int64_t
 303          strtoq(const char *, char **, int);
 304 __uint64_t
 305          strtouq(const char *, char **, int);
 306
 307 extern char *suboptarg;                 /* getsubopt(3) external variable */
 308 #endif /* __BSD_VISIBLE */
 309 __END_DECLS
 310
 311 #endif /* !_STDLIB_H_ */