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