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