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