include/stdio.h

   1 /*-
   2  * Copyright (c) 1990, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * This code is derived from software contributed to Berkeley by
   6  * Chris Torek.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. Neither the name of the University nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  *
  32  *      @(#)stdio.h     8.5 (Berkeley) 4/29/95
  33  * $FreeBSD$
  34  */
  35
  36 #ifndef _STDIO_H_
  37 #define _STDIO_H_
  38
  39 #include <sys/cdefs.h>
  40 #include <sys/_null.h>
  41 #include <sys/_types.h>
  42
  43 typedef __off_t         fpos_t;
  44
  45 #ifndef _SIZE_T_DECLARED
  46 typedef __size_t        size_t;
  47 #define _SIZE_T_DECLARED
  48 #endif
  49
  50 #if __BSD_VISIBLE || __POSIX_VISIBLE >= 200809
  51 #ifndef _OFF_T_DECLARED
  52 #define _OFF_T_DECLARED
  53 typedef __off_t         off_t;
  54 #endif
  55 #ifndef _SSIZE_T_DECLARED
  56 #define _SSIZE_T_DECLARED
  57 typedef __ssize_t       ssize_t;
  58 #endif
  59 #endif
  60
  61 #if __BSD_VISIBLE || __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE
  62 #ifndef _VA_LIST_DECLARED
  63 typedef __va_list       va_list;
  64 #define _VA_LIST_DECLARED
  65 #endif
  66 #endif
  67
  68 #define _FSTDIO                 /* Define for new stdio with functions. */
  69
  70 /*
  71  * NB: to fit things in six character monocase externals, the stdio
  72  * code uses the prefix `__s' for stdio objects, typically followed
  73  * by a three-character attempt at a mnemonic.
  74  */
  75
  76 /* stdio buffers */
  77 struct __sbuf {
  78         unsigned char *_base;
  79         int     _size;
  80 };
  81
  82 /*
  83  * stdio state variables.
  84  *
  85  * The following always hold:
  86  *
  87  *      if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR),
  88  *              _lbfsize is -_bf._size, else _lbfsize is 0
  89  *      if _flags&__SRD, _w is 0
  90  *      if _flags&__SWR, _r is 0
  91  *
  92  * This ensures that the getc and putc macros (or inline functions) never
  93  * try to write or read from a file that is in `read' or `write' mode.
  94  * (Moreover, they can, and do, automatically switch from read mode to
  95  * write mode, and back, on "r+" and "w+" files.)
  96  *
  97  * _lbfsize is used only to make the inline line-buffered output stream
  98  * code as compact as possible.
  99  *
 100  * _ub, _up, and _ur are used when ungetc() pushes back more characters
 101  * than fit in the current _bf, or when ungetc() pushes back a character
 102  * that does not match the previous one in _bf.  When this happens,
 103  * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff
 104  * _ub._base!=NULL) and _up and _ur save the current values of _p and _r.
 105  *
 106  * Certain members of __sFILE are accessed directly via macros or
 107  * inline functions.  To preserve ABI compat, these members must not
 108  * be disturbed.  These members are marked below with (*).
 109  */
 110 typedef struct __sFILE {
 111         unsigned char *_p;      /* (*) current position in (some) buffer */
 112         int     _r;             /* (*) read space left for getc() */
 113         int     _w;             /* (*) write space left for putc() */
 114         short   _flags;         /* (*) flags, below; this FILE is free if 0 */
 115         short   _file;          /* (*) fileno, if Unix descriptor, else -1 */
 116         struct  __sbuf _bf;     /* (*) the buffer (at least 1 byte, if !NULL) */
 117         int     _lbfsize;       /* (*) 0 or -_bf._size, for inline putc */
 118
 119         /* operations */
 120         void    *_cookie;       /* (*) cookie passed to io functions */
 121         int     (*_close)(void *);
 122         int     (*_read)(void *, char *, int);
 123         fpos_t  (*_seek)(void *, fpos_t, int);
 124         int     (*_write)(void *, const char *, int);
 125
 126         /* separate buffer for long sequences of ungetc() */
 127         struct  __sbuf _ub;     /* ungetc buffer */
 128         unsigned char   *_up;   /* saved _p when _p is doing ungetc data */
 129         int     _ur;            /* saved _r when _r is counting ungetc data */
 130
 131         /* tricks to meet minimum requirements even when malloc() fails */
 132         unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */
 133         unsigned char _nbuf[1]; /* guarantee a getc() buffer */
 134
 135         /* separate buffer for fgetln() when line crosses buffer boundary */
 136         struct  __sbuf _lb;     /* buffer for fgetln() */
 137
 138         /* Unix stdio files get aligned to block boundaries on fseek() */
 139         int     _blksize;       /* stat.st_blksize (may be != _bf._size) */
 140         fpos_t  _offset;        /* current lseek offset */
 141
 142         struct pthread_mutex *_fl_mutex;        /* used for MT-safety */
 143         struct pthread *_fl_owner;      /* current owner */
 144         int     _fl_count;      /* recursive lock count */
 145         int     _orientation;   /* orientation for fwide() */
 146         __mbstate_t _mbstate;   /* multibyte conversion state */
 147 } FILE;
 148
 149 #ifndef _STDSTREAM_DECLARED
 150 __BEGIN_DECLS
 151 extern FILE *__stdinp;
 152 extern FILE *__stdoutp;
 153 extern FILE *__stderrp;
 154 __END_DECLS
 155 #define _STDSTREAM_DECLARED
 156 #endif
 157
 158 #define __SLBF  0x0001          /* line buffered */
 159 #define __SNBF  0x0002          /* unbuffered */
 160 #define __SRD   0x0004          /* OK to read */
 161 #define __SWR   0x0008          /* OK to write */
 162         /* RD and WR are never simultaneously asserted */
 163 #define __SRW   0x0010          /* open for reading & writing */
 164 #define __SEOF  0x0020          /* found EOF */
 165 #define __SERR  0x0040          /* found error */
 166 #define __SMBF  0x0080          /* _buf is from malloc */
 167 #define __SAPP  0x0100          /* fdopen()ed in append mode */
 168 #define __SSTR  0x0200          /* this is an sprintf/snprintf string */
 169 #define __SOPT  0x0400          /* do fseek() optimization */
 170 #define __SNPT  0x0800          /* do not do fseek() optimization */
 171 #define __SOFF  0x1000          /* set iff _offset is in fact correct */
 172 #define __SMOD  0x2000          /* true => fgetln modified _p text */
 173 #define __SALC  0x4000          /* allocate string space dynamically */
 174 #define __SIGN  0x8000          /* ignore this file in _fwalk */
 175
 176 /*
 177  * The following three definitions are for ANSI C, which took them
 178  * from System V, which brilliantly took internal interface macros and
 179  * made them official arguments to setvbuf(), without renaming them.
 180  * Hence, these ugly _IOxxx names are *supposed* to appear in user code.
 181  *
 182  * Although numbered as their counterparts above, the implementation
 183  * does not rely on this.
 184  */
 185 #define _IOFBF  0               /* setvbuf should set fully buffered */
 186 #define _IOLBF  1               /* setvbuf should set line buffered */
 187 #define _IONBF  2               /* setvbuf should set unbuffered */
 188
 189 #define BUFSIZ  1024            /* size of buffer used by setbuf */
 190 #define EOF     (-1)
 191
 192 /*
 193  * FOPEN_MAX is a minimum maximum, and is the number of streams that
 194  * stdio can provide without attempting to allocate further resources
 195  * (which could fail).  Do not use this for anything.
 196  */
 197                                 /* must be == _POSIX_STREAM_MAX <limits.h> */
 198 #ifndef FOPEN_MAX
 199 #define FOPEN_MAX       20      /* must be <= OPEN_MAX <sys/syslimits.h> */
 200 #endif
 201 #define FILENAME_MAX    1024    /* must be <= PATH_MAX <sys/syslimits.h> */
 202
 203 /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */
 204 #if __XSI_VISIBLE
 205 #define P_tmpdir        "/var/tmp/"
 206 #endif
 207 #define L_tmpnam        1024    /* XXX must be == PATH_MAX */
 208 #define TMP_MAX         308915776
 209
 210 #ifndef SEEK_SET
 211 #define SEEK_SET        0       /* set file offset to offset */
 212 #endif
 213 #ifndef SEEK_CUR
 214 #define SEEK_CUR        1       /* set file offset to current plus offset */
 215 #endif
 216 #ifndef SEEK_END
 217 #define SEEK_END        2       /* set file offset to EOF plus offset */
 218 #endif
 219
 220 #define stdin   __stdinp
 221 #define stdout  __stdoutp
 222 #define stderr  __stderrp
 223
 224 __BEGIN_DECLS
 225 /*
 226  * Functions defined in ANSI C standard.
 227  */
 228 void     clearerr(FILE *);
 229 int      fclose(FILE *);
 230 int      feof(FILE *);
 231 int      ferror(FILE *);
 232 int      fflush(FILE *);
 233 int      fgetc(FILE *);
 234 int      fgetpos(FILE * __restrict, fpos_t * __restrict);
 235 char    *fgets(char * __restrict, int, FILE * __restrict);
 236 FILE    *fopen(const char * __restrict, const char * __restrict);
 237 int      fprintf(FILE * __restrict, const char * __restrict, ...);
 238 int      fputc(int, FILE *);
 239 int      fputs(const char * __restrict, FILE * __restrict);
 240 size_t   fread(void * __restrict, size_t, size_t, FILE * __restrict);
 241 FILE    *freopen(const char * __restrict, const char * __restrict, FILE * __restrict);
 242 int      fscanf(FILE * __restrict, const char * __restrict, ...);
 243 int      fseek(FILE *, long, int);
 244 int      fsetpos(FILE *, const fpos_t *);
 245 long     ftell(FILE *);
 246 size_t   fwrite(const void * __restrict, size_t, size_t, FILE * __restrict);
 247 int      getc(FILE *);
 248 int      getchar(void);
 249 char    *gets(char *);
 250 void     perror(const char *);
 251 int      printf(const char * __restrict, ...);
 252 int      putc(int, FILE *);
 253 int      putchar(int);
 254 int      puts(const char *);
 255 int      remove(const char *);
 256 int      rename(const char *, const char *);
 257 void     rewind(FILE *);
 258 int      scanf(const char * __restrict, ...);
 259 void     setbuf(FILE * __restrict, char * __restrict);
 260 int      setvbuf(FILE * __restrict, char * __restrict, int, size_t);
 261 int      sprintf(char * __restrict, const char * __restrict, ...);
 262 int      sscanf(const char * __restrict, const char * __restrict, ...);
 263 FILE    *tmpfile(void);
 264 char    *tmpnam(char *);
 265 int      ungetc(int, FILE *);
 266 int      vfprintf(FILE * __restrict, const char * __restrict,
 267             __va_list);
 268 int      vprintf(const char * __restrict, __va_list);
 269 int      vsprintf(char * __restrict, const char * __restrict,
 270             __va_list);
 271
 272 #if __ISO_C_VISIBLE >= 1999
 273 int      snprintf(char * __restrict, size_t, const char * __restrict,
 274             ...) __printflike(3, 4);
 275 int      vfscanf(FILE * __restrict, const char * __restrict, __va_list)
 276             __scanflike(2, 0);
 277 int      vscanf(const char * __restrict, __va_list) __scanflike(1, 0);
 278 int      vsnprintf(char * __restrict, size_t, const char * __restrict,
 279             __va_list) __printflike(3, 0);
 280 int      vsscanf(const char * __restrict, const char * __restrict, __va_list)
 281             __scanflike(2, 0);
 282 #endif
 283
 284 /*
 285  * Functions defined in all versions of POSIX 1003.1.
 286  */
 287 #if __BSD_VISIBLE || __POSIX_VISIBLE <= 199506
 288 #define L_cuserid       17      /* size for cuserid(3); MAXLOGNAME, legacy */
 289 #endif
 290
 291 #if __POSIX_VISIBLE
 292 #define L_ctermid       1024    /* size for ctermid(3); PATH_MAX */
 293
 294 char    *ctermid(char *);
 295 FILE    *fdopen(int, const char *);
 296 int      fileno(FILE *);
 297 #endif /* __POSIX_VISIBLE */
 298
 299 #if __POSIX_VISIBLE >= 199209
 300 int      pclose(FILE *);
 301 FILE    *popen(const char *, const char *);
 302 #endif
 303
 304 #if __POSIX_VISIBLE >= 199506
 305 int      ftrylockfile(FILE *);
 306 void     flockfile(FILE *);
 307 void     funlockfile(FILE *);
 308
 309 /*
 310  * These are normally used through macros as defined below, but POSIX
 311  * requires functions as well.
 312  */
 313 int      getc_unlocked(FILE *);
 314 int      getchar_unlocked(void);
 315 int      putc_unlocked(int, FILE *);
 316 int      putchar_unlocked(int);
 317 #endif
 318 #if __BSD_VISIBLE
 319 void     clearerr_unlocked(FILE *);
 320 int      feof_unlocked(FILE *);
 321 int      ferror_unlocked(FILE *);
 322 int      fileno_unlocked(FILE *);
 323 #endif
 324
 325 #if __POSIX_VISIBLE >= 200112
 326 int      fseeko(FILE *, __off_t, int);
 327 __off_t  ftello(FILE *);
 328 #endif
 329
 330 #if __BSD_VISIBLE || __XSI_VISIBLE > 0 && __XSI_VISIBLE < 600
 331 int      getw(FILE *);
 332 int      putw(int, FILE *);
 333 #endif /* BSD or X/Open before issue 6 */
 334
 335 #if __XSI_VISIBLE
 336 char    *tempnam(const char *, const char *);
 337 #endif
 338
 339 #if __BSD_VISIBLE || __POSIX_VISIBLE >= 200809
 340 ssize_t  getdelim(char ** __restrict, size_t * __restrict, int,
 341             FILE * __restrict);
 342 int      renameat(int, const char *, int, const char *);
 343 int      vdprintf(int, const char * __restrict, __va_list);
 344
 345 /*
 346  * Every programmer and his dog wrote functions called getline() and dprintf()
 347  * before POSIX.1-2008 came along and decided to usurp the names, so we
 348  * don't prototype them by default unless one of the following is true:
 349  *   a) the app has requested them specifically by defining _WITH_GETLINE or
 350  *      _WITH_DPRINTF, respectively
 351  *   b) the app has requested a POSIX.1-2008 environment via _POSIX_C_SOURCE
 352  *   c) the app defines a GNUism such as _BSD_SOURCE or _GNU_SOURCE
 353  */
 354 #ifndef _WITH_GETLINE
 355 #if defined(_BSD_SOURCE) || defined(_GNU_SOURCE)
 356 #define _WITH_GETLINE
 357 #elif defined(_POSIX_C_SOURCE)
 358 #if _POSIX_C_SOURCE >= 200809
 359 #define _WITH_GETLINE
 360 #endif
 361 #endif
 362 #endif
 363
 364 #ifdef _WITH_GETLINE
 365 ssize_t  getline(char ** __restrict, size_t * __restrict, FILE * __restrict);
 366 #endif
 367
 368 #ifndef _WITH_DPRINTF
 369 #if defined(_BSD_SOURCE) || defined(_GNU_SOURCE)
 370 #define _WITH_DPRINTF
 371 #elif defined(_POSIX_C_SOURCE)
 372 #if _POSIX_C_SOURCE >= 200809
 373 #define _WITH_DPRINTF
 374 #endif
 375 #endif
 376 #endif
 377
 378 #ifdef _WITH_DPRINTF
 379 int      (dprintf)(int, const char * __restrict, ...);
 380 #endif
 381
 382 #endif /* __BSD_VISIBLE || __POSIX_VISIBLE >= 200809 */
 383
 384 /*
 385  * Routines that are purely local.
 386  */
 387 #if __BSD_VISIBLE
 388 int      asprintf(char **, const char *, ...) __printflike(2, 3);
 389 char    *ctermid_r(char *);
 390 void     fcloseall(void);
 391 char    *fgetln(FILE *, size_t *);
 392 const char *fmtcheck(const char *, const char *) __format_arg(2);
 393 int      fpurge(FILE *);
 394 void     setbuffer(FILE *, char *, int);
 395 int      setlinebuf(FILE *);
 396 int      vasprintf(char **, const char *, __va_list)
 397             __printflike(2, 0);
 398
 399 /*
 400  * The system error table contains messages for the first sys_nerr
 401  * positive errno values.  Use strerror() or strerror_r() from <string.h>
 402  * instead.
 403  */
 404 extern __const int sys_nerr;
 405 extern __const char *__const sys_errlist[];
 406
 407 /*
 408  * Stdio function-access interface.
 409  */
 410 FILE    *funopen(const void *,
 411             int (*)(void *, char *, int),
 412             int (*)(void *, const char *, int),
 413             fpos_t (*)(void *, fpos_t, int),
 414             int (*)(void *));
 415 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
 416 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
 417
 418 /*
 419  * Portability hacks.  See <sys/types.h>.
 420  */
 421 #ifndef _FTRUNCATE_DECLARED
 422 #define _FTRUNCATE_DECLARED
 423 int      ftruncate(int, __off_t);
 424 #endif
 425 #ifndef _LSEEK_DECLARED
 426 #define _LSEEK_DECLARED
 427 __off_t  lseek(int, __off_t, int);
 428 #endif
 429 #ifndef _MMAP_DECLARED
 430 #define _MMAP_DECLARED
 431 void    *mmap(void *, size_t, int, int, int, __off_t);
 432 #endif
 433 #ifndef _TRUNCATE_DECLARED
 434 #define _TRUNCATE_DECLARED
 435 int      truncate(const char *, __off_t);
 436 #endif
 437 #endif /* __BSD_VISIBLE */
 438
 439 /*
 440  * Functions internal to the implementation.
 441  */
 442 int     __srget(FILE *);
 443 int     __swbuf(int, FILE *);
 444
 445 /*
 446  * The __sfoo macros are here so that we can
 447  * define function versions in the C library.
 448  */
 449 #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++))
 450 #if defined(__GNUC__) && defined(__STDC__)
 451 static __inline int __sputc(int _c, FILE *_p) {
 452         if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n'))
 453                 return (*_p->_p++ = _c);
 454         else
 455                 return (__swbuf(_c, _p));
 456 }
 457 #else
 458 /*
 459  * This has been tuned to generate reasonable code on the vax using pcc.
 460  */
 461 #define __sputc(c, p) \
 462         (--(p)->_w < 0 ? \
 463                 (p)->_w >= (p)->_lbfsize ? \
 464                         (*(p)->_p = (c)), *(p)->_p != '\n' ? \
 465                                 (int)*(p)->_p++ : \
 466                                 __swbuf('\n', p) : \
 467                         __swbuf((int)(c), p) : \
 468                 (*(p)->_p = (c), (int)*(p)->_p++))
 469 #endif
 470
 471 #define __sfeof(p)      (((p)->_flags & __SEOF) != 0)
 472 #define __sferror(p)    (((p)->_flags & __SERR) != 0)
 473 #define __sclearerr(p)  ((void)((p)->_flags &= ~(__SERR|__SEOF)))
 474 #define __sfileno(p)    ((p)->_file)
 475
 476 extern int __isthreaded;
 477
 478 #define feof(p)         (!__isthreaded ? __sfeof(p) : (feof)(p))
 479 #define ferror(p)       (!__isthreaded ? __sferror(p) : (ferror)(p))
 480 #define clearerr(p)     (!__isthreaded ? __sclearerr(p) : (clearerr)(p))
 481
 482 #if __POSIX_VISIBLE
 483 #define fileno(p)       (!__isthreaded ? __sfileno(p) : (fileno)(p))
 484 #endif
 485
 486 #define getc(fp)        (!__isthreaded ? __sgetc(fp) : (getc)(fp))
 487 #define putc(x, fp)     (!__isthreaded ? __sputc(x, fp) : (putc)(x, fp))
 488
 489 #define getchar()       getc(stdin)
 490 #define putchar(x)      putc(x, stdout)
 491
 492 #if __BSD_VISIBLE
 493 /*
 494  * See ISO/IEC 9945-1 ANSI/IEEE Std 1003.1 Second Edition 1996-07-12
 495  * B.8.2.7 for the rationale behind the *_unlocked() macros.
 496  */
 497 #define feof_unlocked(p)        __sfeof(p)
 498 #define ferror_unlocked(p)      __sferror(p)
 499 #define clearerr_unlocked(p)    __sclearerr(p)
 500 #define fileno_unlocked(p)      __sfileno(p)
 501 #endif
 502 #if __POSIX_VISIBLE >= 199506
 503 #define getc_unlocked(fp)       __sgetc(fp)
 504 #define putc_unlocked(x, fp)    __sputc(x, fp)
 505
 506 #define getchar_unlocked()      getc_unlocked(stdin)
 507 #define putchar_unlocked(x)     putc_unlocked(x, stdout)
 508 #endif
 509
 510 __END_DECLS
 511 #endif /* !_STDIO_H_ */