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