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