2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1990, 1993
5 * The Regents of the University of California. All rights reserved.
7 * This code is derived from software contributed to Berkeley by
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
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.
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
34 * @(#)stdio.h 8.5 (Berkeley) 4/29/95
40 #include <sys/cdefs.h>
41 #include <sys/_null.h>
42 #include <sys/_types.h>
44 __NULLABILITY_PRAGMA_PUSH
46 typedef __off_t fpos_t;
48 #ifndef _SIZE_T_DECLARED
49 typedef __size_t size_t;
50 #define _SIZE_T_DECLARED
53 #ifndef _RSIZE_T_DEFINED
54 #define _RSIZE_T_DEFINED
55 typedef size_t rsize_t;
58 #if __POSIX_VISIBLE >= 200809
59 #ifndef _OFF_T_DECLARED
60 #define _OFF_T_DECLARED
61 typedef __off_t off_t;
63 #ifndef _SSIZE_T_DECLARED
64 #define _SSIZE_T_DECLARED
65 typedef __ssize_t ssize_t;
69 #ifndef _OFF64_T_DECLARED
70 #define _OFF64_T_DECLARED
71 typedef __off64_t off64_t;
74 #if __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE
75 #ifndef _VA_LIST_DECLARED
76 typedef __va_list va_list;
77 #define _VA_LIST_DECLARED
81 #define _FSTDIO /* Define for new stdio with functions. */
84 * NB: to fit things in six character monocase externals, the stdio
85 * code uses the prefix `__s' for stdio objects, typically followed
86 * by a three-character attempt at a mnemonic.
96 * stdio state variables.
98 * The following always hold:
100 * if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR),
101 * _lbfsize is -_bf._size, else _lbfsize is 0
102 * if _flags&__SRD, _w is 0
103 * if _flags&__SWR, _r is 0
105 * This ensures that the getc and putc macros (or inline functions) never
106 * try to write or read from a file that is in `read' or `write' mode.
107 * (Moreover, they can, and do, automatically switch from read mode to
108 * write mode, and back, on "r+" and "w+" files.)
110 * _lbfsize is used only to make the inline line-buffered output stream
111 * code as compact as possible.
113 * _ub, _up, and _ur are used when ungetc() pushes back more characters
114 * than fit in the current _bf, or when ungetc() pushes back a character
115 * that does not match the previous one in _bf. When this happens,
116 * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff
117 * _ub._base!=NULL) and _up and _ur save the current values of _p and _r.
119 * Certain members of __sFILE are accessed directly via macros or
120 * inline functions. To preserve ABI compat, these members must not
121 * be disturbed. These members are marked below with (*).
124 unsigned char *_p; /* (*) current position in (some) buffer */
125 int _r; /* (*) read space left for getc() */
126 int _w; /* (*) write space left for putc() */
127 short _flags; /* (*) flags, below; this FILE is free if 0 */
128 short _file; /* (*) fileno, if Unix descriptor, else -1 */
129 struct __sbuf _bf; /* (*) the buffer (at least 1 byte, if !NULL) */
130 int _lbfsize; /* (*) 0 or -_bf._size, for inline putc */
133 void *_cookie; /* (*) cookie passed to io functions */
134 int (* _Nullable _close)(void *);
135 int (* _Nullable _read)(void *, char *, int);
136 fpos_t (* _Nullable _seek)(void *, fpos_t, int);
137 int (* _Nullable _write)(void *, const char *, int);
139 /* separate buffer for long sequences of ungetc() */
140 struct __sbuf _ub; /* ungetc buffer */
141 unsigned char *_up; /* saved _p when _p is doing ungetc data */
142 int _ur; /* saved _r when _r is counting ungetc data */
144 /* tricks to meet minimum requirements even when malloc() fails */
145 unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */
146 unsigned char _nbuf[1]; /* guarantee a getc() buffer */
148 /* separate buffer for fgetln() when line crosses buffer boundary */
149 struct __sbuf _lb; /* buffer for fgetln() */
151 /* Unix stdio files get aligned to block boundaries on fseek() */
152 int _blksize; /* stat.st_blksize (may be != _bf._size) */
153 fpos_t _offset; /* current lseek offset */
155 struct pthread_mutex *_fl_mutex; /* used for MT-safety */
156 struct pthread *_fl_owner; /* current owner */
157 int _fl_count; /* recursive lock count */
158 int _orientation; /* orientation for fwide() */
159 __mbstate_t _mbstate; /* multibyte conversion state */
160 int _flags2; /* additional flags */
162 #ifndef _STDFILE_DECLARED
163 #define _STDFILE_DECLARED
164 typedef struct __sFILE FILE;
166 #ifndef _STDSTREAM_DECLARED
168 extern FILE *__stdinp;
169 extern FILE *__stdoutp;
170 extern FILE *__stderrp;
172 #define _STDSTREAM_DECLARED
175 #define __SLBF 0x0001 /* line buffered */
176 #define __SNBF 0x0002 /* unbuffered */
177 #define __SRD 0x0004 /* OK to read */
178 #define __SWR 0x0008 /* OK to write */
179 /* RD and WR are never simultaneously asserted */
180 #define __SRW 0x0010 /* open for reading & writing */
181 #define __SEOF 0x0020 /* found EOF */
182 #define __SERR 0x0040 /* found error */
183 #define __SMBF 0x0080 /* _bf._base is from malloc */
184 #define __SAPP 0x0100 /* fdopen()ed in append mode */
185 #define __SSTR 0x0200 /* this is an sprintf/snprintf string */
186 #define __SOPT 0x0400 /* do fseek() optimization */
187 #define __SNPT 0x0800 /* do not do fseek() optimization */
188 #define __SOFF 0x1000 /* set iff _offset is in fact correct */
189 #define __SMOD 0x2000 /* true => fgetln modified _p text */
190 #define __SALC 0x4000 /* allocate string space dynamically */
191 #define __SIGN 0x8000 /* ignore this file in _fwalk */
193 #define __S2OAP 0x0001 /* O_APPEND mode is set */
196 * The following three definitions are for ANSI C, which took them
197 * from System V, which brilliantly took internal interface macros and
198 * made them official arguments to setvbuf(), without renaming them.
199 * Hence, these ugly _IOxxx names are *supposed* to appear in user code.
201 * Although numbered as their counterparts above, the implementation
202 * does not rely on this.
204 #define _IOFBF 0 /* setvbuf should set fully buffered */
205 #define _IOLBF 1 /* setvbuf should set line buffered */
206 #define _IONBF 2 /* setvbuf should set unbuffered */
208 #define BUFSIZ 1024 /* size of buffer used by setbuf */
212 * FOPEN_MAX is a minimum maximum, and is the number of streams that
213 * stdio can provide without attempting to allocate further resources
214 * (which could fail). Do not use this for anything.
216 /* must be == _POSIX_STREAM_MAX <limits.h> */
218 #define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */
220 #define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */
222 /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */
224 #define P_tmpdir "/tmp/"
226 #define L_tmpnam 1024 /* XXX must be == PATH_MAX */
227 #define TMP_MAX 308915776
230 #define SEEK_SET 0 /* set file offset to offset */
233 #define SEEK_CUR 1 /* set file offset to current plus offset */
236 #define SEEK_END 2 /* set file offset to EOF plus offset */
239 #define stdin __stdinp
240 #define stdout __stdoutp
241 #define stderr __stderrp
245 #include <xlocale/_stdio.h>
248 * Functions defined in ANSI C standard.
250 void clearerr(FILE *);
256 int fgetpos(FILE * __restrict, fpos_t * __restrict);
257 char *fgets(char * __restrict, int, FILE * __restrict);
258 FILE *fopen(const char * __restrict, const char * __restrict);
259 int fprintf(FILE * __restrict, const char * __restrict, ...);
260 int fputc(int, FILE *);
261 int fputs(const char * __restrict, FILE * __restrict);
262 size_t fread(void * __restrict, size_t, size_t, FILE * __restrict);
263 FILE *freopen(const char * __restrict, const char * __restrict, FILE * __restrict);
264 int fscanf(FILE * __restrict, const char * __restrict, ...);
265 int fseek(FILE *, long, int);
266 int fsetpos(FILE *, const fpos_t *);
268 size_t fwrite(const void * __restrict, size_t, size_t, FILE * __restrict);
272 char *gets_s(char *, rsize_t);
274 void perror(const char *);
275 int printf(const char * __restrict, ...);
276 int putc(int, FILE *);
278 int puts(const char *);
279 int remove(const char *);
280 int rename(const char *, const char *);
282 int scanf(const char * __restrict, ...);
283 void setbuf(FILE * __restrict, char * __restrict);
284 int setvbuf(FILE * __restrict, char * __restrict, int, size_t);
285 int sprintf(char * __restrict, const char * __restrict, ...);
286 int sscanf(const char * __restrict, const char * __restrict, ...);
288 char *tmpnam(char *);
289 int ungetc(int, FILE *);
290 int vfprintf(FILE * __restrict, const char * __restrict,
292 int vprintf(const char * __restrict, __va_list);
293 int vsprintf(char * __restrict, const char * __restrict,
296 #if __ISO_C_VISIBLE >= 1999 || __POSIX_VISIBLE >= 199506
297 int snprintf(char * __restrict, size_t, const char * __restrict,
298 ...) __printflike(3, 4);
299 int vsnprintf(char * __restrict, size_t, const char * __restrict,
300 __va_list) __printflike(3, 0);
302 #if __ISO_C_VISIBLE >= 1999
303 int vfscanf(FILE * __restrict, const char * __restrict, __va_list)
305 int vscanf(const char * __restrict, __va_list) __scanflike(1, 0);
306 int vsscanf(const char * __restrict, const char * __restrict, __va_list)
311 * Functions defined in all versions of POSIX 1003.1.
313 #if __BSD_VISIBLE || (__POSIX_VISIBLE && __POSIX_VISIBLE <= 199506)
314 #define L_cuserid 17 /* size for cuserid(3); MAXLOGNAME, legacy */
318 #define L_ctermid 1024 /* size for ctermid(3); PATH_MAX */
320 char *ctermid(char *);
321 FILE *fdopen(int, const char *);
323 #endif /* __POSIX_VISIBLE */
325 #if __POSIX_VISIBLE >= 199209
327 FILE *popen(const char *, const char *);
330 #if __POSIX_VISIBLE >= 199506
331 int ftrylockfile(FILE *);
332 void flockfile(FILE *);
333 void funlockfile(FILE *);
336 * These are normally used through macros as defined below, but POSIX
337 * requires functions as well.
339 int getc_unlocked(FILE *);
340 int getchar_unlocked(void);
341 int putc_unlocked(int, FILE *);
342 int putchar_unlocked(int);
345 void clearerr_unlocked(FILE *);
346 int feof_unlocked(FILE *);
347 int ferror_unlocked(FILE *);
348 int fflush_unlocked(FILE *);
349 int fileno_unlocked(FILE *);
350 int fputc_unlocked(int, FILE *);
351 int fputs_unlocked(const char * __restrict, FILE * __restrict);
352 size_t fread_unlocked(void * __restrict, size_t, size_t, FILE * __restrict);
353 size_t fwrite_unlocked(const void * __restrict, size_t, size_t,
357 #if __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE >= 500
358 int fseeko(FILE *, __off_t, int);
359 __off_t ftello(FILE *);
362 #if __BSD_VISIBLE || __XSI_VISIBLE > 0 && __XSI_VISIBLE < 600
364 int putw(int, FILE *);
365 #endif /* BSD or X/Open before issue 6 */
368 char *tempnam(const char *, const char *);
371 #if __POSIX_VISIBLE >= 200809
372 FILE *fmemopen(void * __restrict, size_t, const char * __restrict);
373 ssize_t getdelim(char ** __restrict, size_t * __restrict, int,
375 FILE *open_memstream(char **, size_t *);
376 int renameat(int, const char *, int, const char *);
377 int vdprintf(int, const char * __restrict, __va_list) __printflike(2, 0);
378 /* _WITH_GETLINE to allow pre 11 sources to build on 11+ systems */
379 ssize_t getline(char ** __restrict, size_t * __restrict, FILE * __restrict);
380 int dprintf(int, const char * __restrict, ...) __printflike(2, 3);
381 #endif /* __POSIX_VISIBLE >= 200809 */
384 * Routines that are purely local.
387 int asprintf(char **, const char *, ...) __printflike(2, 3);
388 char *ctermid_r(char *);
389 void fcloseall(void);
390 int fdclose(FILE *, int *);
391 char *fgetln(FILE *, size_t *);
392 const char *fmtcheck(const char *, const char *) __format_arg(2);
394 void setbuffer(FILE *, char *, int);
395 int setlinebuf(FILE *);
396 int vasprintf(char **, const char *, __va_list)
400 * The system error table contains messages for the first sys_nerr
401 * positive errno values. Use strerror() or strerror_r() from <string.h>
404 extern const int sys_nerr;
405 extern const char * const sys_errlist[];
408 * Stdio function-access interface.
410 FILE *funopen(const void *,
411 int (* _Nullable)(void *, char *, int),
412 int (* _Nullable)(void *, const char *, int),
413 fpos_t (* _Nullable)(void *, fpos_t, int),
414 int (* _Nullable)(void *));
415 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
416 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
419 typedef __ssize_t cookie_read_function_t(void *, char *, size_t);
420 typedef __ssize_t cookie_write_function_t(void *, const char *, size_t);
421 typedef int cookie_seek_function_t(void *, off64_t *, int);
422 typedef int cookie_close_function_t(void *);
424 cookie_read_function_t *read;
425 cookie_write_function_t *write;
426 cookie_seek_function_t *seek;
427 cookie_close_function_t *close;
428 } cookie_io_functions_t;
429 FILE *fopencookie(void *, const char *, cookie_io_functions_t);
433 * Portability hacks. See <sys/types.h>.
435 #ifndef _FTRUNCATE_DECLARED
436 #define _FTRUNCATE_DECLARED
437 int ftruncate(int, __off_t);
439 #ifndef _LSEEK_DECLARED
440 #define _LSEEK_DECLARED
441 __off_t lseek(int, __off_t, int);
443 #ifndef _MMAP_DECLARED
444 #define _MMAP_DECLARED
445 void *mmap(void *, size_t, int, int, int, __off_t);
447 #ifndef _TRUNCATE_DECLARED
448 #define _TRUNCATE_DECLARED
449 int truncate(const char *, __off_t);
451 #endif /* __BSD_VISIBLE */
454 * Functions internal to the implementation.
457 int __swbuf(int, FILE *);
460 * The __sfoo macros are here so that we can
461 * define function versions in the C library.
463 #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++))
464 #if defined(__GNUC__) && defined(__STDC__)
465 static __inline int __sputc(int _c, FILE *_p) {
466 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n'))
467 return (*_p->_p++ = _c);
469 return (__swbuf(_c, _p));
473 * This has been tuned to generate reasonable code on the vax using pcc.
475 #define __sputc(c, p) \
477 (p)->_w >= (p)->_lbfsize ? \
478 (*(p)->_p = (c)), *(p)->_p != '\n' ? \
481 __swbuf((int)(c), p) : \
482 (*(p)->_p = (c), (int)*(p)->_p++))
485 #ifndef __LIBC_ISTHREADED_DECLARED
486 #define __LIBC_ISTHREADED_DECLARED
487 extern int __isthreaded;
492 #define __sfeof(p) (((p)->_flags & __SEOF) != 0)
493 #define __sferror(p) (((p)->_flags & __SERR) != 0)
494 #define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF)))
495 #define __sfileno(p) ((p)->_file)
498 #define feof(p) (!__isthreaded ? __sfeof(p) : (feof)(p))
499 #define ferror(p) (!__isthreaded ? __sferror(p) : (ferror)(p))
500 #define clearerr(p) (!__isthreaded ? __sclearerr(p) : (clearerr)(p))
503 #define fileno(p) (!__isthreaded ? __sfileno(p) : (fileno)(p))
506 #define getc(fp) (!__isthreaded ? __sgetc(fp) : (getc)(fp))
507 #define putc(x, fp) (!__isthreaded ? __sputc(x, fp) : (putc)(x, fp))
509 #define getchar() getc(stdin)
510 #define putchar(x) putc(x, stdout)
514 * See ISO/IEC 9945-1 ANSI/IEEE Std 1003.1 Second Edition 1996-07-12
515 * B.8.2.7 for the rationale behind the *_unlocked() macros.
517 #define clearerr_unlocked(p) __sclearerr(p)
518 #define feof_unlocked(p) __sfeof(p)
519 #define ferror_unlocked(p) __sferror(p)
520 #define fileno_unlocked(p) __sfileno(p)
521 #define fputc_unlocked(s, p) __sputc(s, p)
523 #if __POSIX_VISIBLE >= 199506
524 #define getc_unlocked(fp) __sgetc(fp)
525 #define putc_unlocked(x, fp) __sputc(x, fp)
527 #define getchar_unlocked() getc_unlocked(stdin)
528 #define putchar_unlocked(x) putc_unlocked(x, stdout)
530 #endif /* __cplusplus */
533 __NULLABILITY_PRAGMA_POP
535 #endif /* !_STDIO_H_ */