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 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 }; 148 #ifndef _STDFILE_DECLARED 149 #define _STDFILE_DECLARED 150 typedef struct __sFILE FILE; 151 #endif 152 #ifndef _STDSTREAM_DECLARED 153 __BEGIN_DECLS 154 extern FILE *__stdinp; 155 extern FILE *__stdoutp; 156 extern FILE *__stderrp; 157 __END_DECLS 158 #define _STDSTREAM_DECLARED 159 #endif 160 161 #define __SLBF 0x0001 /* line buffered */ 162 #define __SNBF 0x0002 /* unbuffered */ 163 #define __SRD 0x0004 /* OK to read */ 164 #define __SWR 0x0008 /* OK to write */ 165 /* RD and WR are never simultaneously asserted */ 166 #define __SRW 0x0010 /* open for reading & writing */ 167 #define __SEOF 0x0020 /* found EOF */ 168 #define __SERR 0x0040 /* found error */ 169 #define __SMBF 0x0080 /* _buf is from malloc */ 170 #define __SAPP 0x0100 /* fdopen()ed in append mode */ 171 #define __SSTR 0x0200 /* this is an sprintf/snprintf string */ 172 #define __SOPT 0x0400 /* do fseek() optimization */ 173 #define __SNPT 0x0800 /* do not do fseek() optimization */ 174 #define __SOFF 0x1000 /* set iff _offset is in fact correct */ 175 #define __SMOD 0x2000 /* true => fgetln modified _p text */ 176 #define __SALC 0x4000 /* allocate string space dynamically */ 177 #define __SIGN 0x8000 /* ignore this file in _fwalk */ 178 179 /* 180 * The following three definitions are for ANSI C, which took them 181 * from System V, which brilliantly took internal interface macros and 182 * made them official arguments to setvbuf(), without renaming them. 183 * Hence, these ugly _IOxxx names are *supposed* to appear in user code. 184 * 185 * Although numbered as their counterparts above, the implementation 186 * does not rely on this. 187 */ 188 #define _IOFBF 0 /* setvbuf should set fully buffered */ 189 #define _IOLBF 1 /* setvbuf should set line buffered */ 190 #define _IONBF 2 /* setvbuf should set unbuffered */ 191 192 #define BUFSIZ 1024 /* size of buffer used by setbuf */ 193 #define EOF (-1) 194 195 /* 196 * FOPEN_MAX is a minimum maximum, and is the number of streams that 197 * stdio can provide without attempting to allocate further resources 198 * (which could fail). Do not use this for anything. 199 */ 200 /* must be == _POSIX_STREAM_MAX <limits.h> */ 201 #ifndef FOPEN_MAX 202 #define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */ 203 #endif 204 #define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */ 205 206 /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */ 207 #if __XSI_VISIBLE 208 #define P_tmpdir "/var/tmp/" 209 #endif 210 #define L_tmpnam 1024 /* XXX must be == PATH_MAX */ 211 #define TMP_MAX 308915776 212 213 #ifndef SEEK_SET 214 #define SEEK_SET 0 /* set file offset to offset */ 215 #endif 216 #ifndef SEEK_CUR 217 #define SEEK_CUR 1 /* set file offset to current plus offset */ 218 #endif 219 #ifndef SEEK_END 220 #define SEEK_END 2 /* set file offset to EOF plus offset */ 221 #endif 222 223 #define stdin __stdinp 224 #define stdout __stdoutp 225 #define stderr __stderrp 226 227 __BEGIN_DECLS 228 /* 229 * Functions defined in ANSI C standard. 230 */ 231 void clearerr(FILE *); 232 int fclose(FILE *); 233 int feof(FILE *); 234 int ferror(FILE *); 235 int fflush(FILE *); 236 int fgetc(FILE *); 237 int fgetpos(FILE * __restrict, fpos_t * __restrict); 238 char *fgets(char * __restrict, int, FILE * __restrict); 239 FILE *fopen(const char * __restrict, const char * __restrict); 240 int fprintf(FILE * __restrict, const char * __restrict, ...); 241 int fputc(int, FILE *); 242 int fputs(const char * __restrict, FILE * __restrict); 243 size_t fread(void * __restrict, size_t, size_t, FILE * __restrict); 244 FILE *freopen(const char * __restrict, const char * __restrict, FILE * __restrict); 245 int fscanf(FILE * __restrict, const char * __restrict, ...); 246 int fseek(FILE *, long, int); 247 int fsetpos(FILE *, const fpos_t *); 248 long ftell(FILE *); 249 size_t fwrite(const void * __restrict, size_t, size_t, FILE * __restrict); 250 int getc(FILE *); 251 int getchar(void); 252 char *gets(char *); 253 void perror(const char *); 254 int printf(const char * __restrict, ...); 255 int putc(int, FILE *); 256 int putchar(int); 257 int puts(const char *); 258 int remove(const char *); 259 int rename(const char *, const char *); 260 void rewind(FILE *); 261 int scanf(const char * __restrict, ...); 262 void setbuf(FILE * __restrict, char * __restrict); 263 int setvbuf(FILE * __restrict, char * __restrict, int, size_t); 264 int sprintf(char * __restrict, const char * __restrict, ...); 265 int sscanf(const char * __restrict, const char * __restrict, ...); 266 FILE *tmpfile(void); 267 char *tmpnam(char *); 268 int ungetc(int, FILE *); 269 int vfprintf(FILE * __restrict, const char * __restrict, 270 __va_list); 271 int vprintf(const char * __restrict, __va_list); 272 int vsprintf(char * __restrict, const char * __restrict, 273 __va_list); 274 275 #if __ISO_C_VISIBLE >= 1999 276 int snprintf(char * __restrict, size_t, const char * __restrict, 277 ...) __printflike(3, 4); 278 int vfscanf(FILE * __restrict, const char * __restrict, __va_list) 279 __scanflike(2, 0); 280 int vscanf(const char * __restrict, __va_list) __scanflike(1, 0); 281 int vsnprintf(char * __restrict, size_t, const char * __restrict, 282 __va_list) __printflike(3, 0); 283 int vsscanf(const char * __restrict, const char * __restrict, __va_list) 284 __scanflike(2, 0); 285 #endif 286 287 /* 288 * Functions defined in all versions of POSIX 1003.1. 289 */ 290 #if __BSD_VISIBLE || __POSIX_VISIBLE <= 199506 291 #define L_cuserid 17 /* size for cuserid(3); MAXLOGNAME, legacy */ 292 #endif 293 294 #if __POSIX_VISIBLE 295 #define L_ctermid 1024 /* size for ctermid(3); PATH_MAX */ 296 297 char *ctermid(char *); 298 FILE *fdopen(int, const char *); 299 int fileno(FILE *); 300 #endif /* __POSIX_VISIBLE */ 301 302 #if __POSIX_VISIBLE >= 199209 303 int pclose(FILE *); 304 FILE *popen(const char *, const char *); 305 #endif 306 307 #if __POSIX_VISIBLE >= 199506 308 int ftrylockfile(FILE *); 309 void flockfile(FILE *); 310 void funlockfile(FILE *); 311 312 /* 313 * These are normally used through macros as defined below, but POSIX 314 * requires functions as well. 315 */ 316 int getc_unlocked(FILE *); 317 int getchar_unlocked(void); 318 int putc_unlocked(int, FILE *); 319 int putchar_unlocked(int); 320 #endif 321 #if __BSD_VISIBLE 322 void clearerr_unlocked(FILE *); 323 int feof_unlocked(FILE *); 324 int ferror_unlocked(FILE *); 325 int fileno_unlocked(FILE *); 326 #endif 327 328 #if __POSIX_VISIBLE >= 200112 329 int fseeko(FILE *, __off_t, int); 330 __off_t ftello(FILE *); 331 #endif 332 333 #if __BSD_VISIBLE || __XSI_VISIBLE > 0 && __XSI_VISIBLE < 600 334 int getw(FILE *); 335 int putw(int, FILE *); 336 #endif /* BSD or X/Open before issue 6 */ 337 338 #if __XSI_VISIBLE 339 char *tempnam(const char *, const char *); 340 #endif 341 342 #if __BSD_VISIBLE || __POSIX_VISIBLE >= 200809 343 ssize_t getdelim(char ** __restrict, size_t * __restrict, int, 344 FILE * __restrict); 345 int renameat(int, const char *, int, const char *); 346 int vdprintf(int, const char * __restrict, __va_list); 347 348 /* 349 * Every programmer and his dog wrote functions called getline() and dprintf() 350 * before POSIX.1-2008 came along and decided to usurp the names, so we 351 * don't prototype them by default unless one of the following is true: 352 * a) the app has requested them specifically by defining _WITH_GETLINE or 353 * _WITH_DPRINTF, respectively 354 * b) the app has requested a POSIX.1-2008 environment via _POSIX_C_SOURCE 355 * c) the app defines a GNUism such as _BSD_SOURCE or _GNU_SOURCE 356 */ 357 #ifndef _WITH_GETLINE 358 #if defined(_BSD_SOURCE) || defined(_GNU_SOURCE) 359 #define _WITH_GETLINE 360 #elif defined(_POSIX_C_SOURCE) 361 #if _POSIX_C_SOURCE >= 200809 362 #define _WITH_GETLINE 363 #endif 364 #endif 365 #endif 366 367 #ifdef _WITH_GETLINE 368 ssize_t getline(char ** __restrict, size_t * __restrict, FILE * __restrict); 369 #endif 370 371 #ifndef _WITH_DPRINTF 372 #if defined(_BSD_SOURCE) || defined(_GNU_SOURCE) 373 #define _WITH_DPRINTF 374 #elif defined(_POSIX_C_SOURCE) 375 #if _POSIX_C_SOURCE >= 200809 376 #define _WITH_DPRINTF 377 #endif 378 #endif 379 #endif 380 381 #ifdef _WITH_DPRINTF 382 int (dprintf)(int, const char * __restrict, ...); 383 #endif 384 385 #endif /* __BSD_VISIBLE || __POSIX_VISIBLE >= 200809 */ 386 387 /* 388 * Routines that are purely local. 389 */ 390 #if __BSD_VISIBLE 391 int asprintf(char **, const char *, ...) __printflike(2, 3); 392 char *ctermid_r(char *); 393 void fcloseall(void); 394 char *fgetln(FILE *, size_t *); 395 const char *fmtcheck(const char *, const char *) __format_arg(2); 396 int fpurge(FILE *); 397 void setbuffer(FILE *, char *, int); 398 int setlinebuf(FILE *); 399 int vasprintf(char **, const char *, __va_list) 400 __printflike(2, 0); 401 402 /* 403 * The system error table contains messages for the first sys_nerr 404 * positive errno values. Use strerror() or strerror_r() from <string.h> 405 * instead. 406 */ 407 extern const int sys_nerr; 408 extern const char * const sys_errlist[]; 409 410 /* 411 * Stdio function-access interface. 412 */ 413 FILE *funopen(const void *, 414 int (*)(void *, char *, int), 415 int (*)(void *, const char *, int), 416 fpos_t (*)(void *, fpos_t, int), 417 int (*)(void *)); 418 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0) 419 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0) 420 421 /* 422 * Portability hacks. See <sys/types.h>. 423 */ 424 #ifndef _FTRUNCATE_DECLARED 425 #define _FTRUNCATE_DECLARED 426 int ftruncate(int, __off_t); 427 #endif 428 #ifndef _LSEEK_DECLARED 429 #define _LSEEK_DECLARED 430 __off_t lseek(int, __off_t, int); 431 #endif 432 #ifndef _MMAP_DECLARED 433 #define _MMAP_DECLARED 434 void *mmap(void *, size_t, int, int, int, __off_t); 435 #endif 436 #ifndef _TRUNCATE_DECLARED 437 #define _TRUNCATE_DECLARED 438 int truncate(const char *, __off_t); 439 #endif 440 #endif /* __BSD_VISIBLE */ 441 442 /* 443 * Functions internal to the implementation. 444 */ 445 int __srget(FILE *); 446 int __swbuf(int, FILE *); 447 448 /* 449 * The __sfoo macros are here so that we can 450 * define function versions in the C library. 451 */ 452 #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++)) 453 #if defined(__GNUC__) && defined(__STDC__) 454 static __inline int __sputc(int _c, FILE *_p) { 455 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n')) 456 return (*_p->_p++ = _c); 457 else 458 return (__swbuf(_c, _p)); 459 } 460 #else 461 /* 462 * This has been tuned to generate reasonable code on the vax using pcc. 463 */ 464 #define __sputc(c, p) \ 465 (--(p)->_w < 0 ? \ 466 (p)->_w >= (p)->_lbfsize ? \ 467 (*(p)->_p = (c)), *(p)->_p != '\n' ? \ 468 (int)*(p)->_p++ : \ 469 __swbuf('\n', p) : \ 470 __swbuf((int)(c), p) : \ 471 (*(p)->_p = (c), (int)*(p)->_p++)) 472 #endif 473 #ifndef __cplusplus 474 475 #define __sfeof(p) (((p)->_flags & __SEOF) != 0) 476 #define __sferror(p) (((p)->_flags & __SERR) != 0) 477 #define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF))) 478 #define __sfileno(p) ((p)->_file) 479 480 extern int __isthreaded; 481 482 #define feof(p) (!__isthreaded ? __sfeof(p) : (feof)(p)) 483 #define ferror(p) (!__isthreaded ? __sferror(p) : (ferror)(p)) 484 #define clearerr(p) (!__isthreaded ? __sclearerr(p) : (clearerr)(p)) 485 486 #if __POSIX_VISIBLE 487 #define fileno(p) (!__isthreaded ? __sfileno(p) : (fileno)(p)) 488 #endif 489 490 #define getc(fp) (!__isthreaded ? __sgetc(fp) : (getc)(fp)) 491 #define putc(x, fp) (!__isthreaded ? __sputc(x, fp) : (putc)(x, fp)) 492 493 #define getchar() getc(stdin) 494 #define putchar(x) putc(x, stdout) 495 496 #if __BSD_VISIBLE 497 /* 498 * See ISO/IEC 9945-1 ANSI/IEEE Std 1003.1 Second Edition 1996-07-12 499 * B.8.2.7 for the rationale behind the *_unlocked() macros. 500 */ 501 #define feof_unlocked(p) __sfeof(p) 502 #define ferror_unlocked(p) __sferror(p) 503 #define clearerr_unlocked(p) __sclearerr(p) 504 #define fileno_unlocked(p) __sfileno(p) 505 #endif 506 #if __POSIX_VISIBLE >= 199506 507 #define getc_unlocked(fp) __sgetc(fp) 508 #define putc_unlocked(x, fp) __sputc(x, fp) 509 510 #define getchar_unlocked() getc_unlocked(stdin) 511 #define putchar_unlocked(x) putc_unlocked(x, stdout) 512 #endif 513 #endif /* __cplusplus */ 514 515 __END_DECLS 516 #endif /* !_STDIO_H_ */ 517