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 __NULLABILITY_PRAGMA_PUSH
43
44 typedef __off_t fpos_t;
45
46 #ifndef _SIZE_T_DECLARED
47 typedef __size_t size_t;
48 #define _SIZE_T_DECLARED
49 #endif
50
51 #if __EXT1_VISIBLE
52 /* ISO/IEC 9899:2011 K.3.3.2 */
53 #ifndef _RSIZE_T_DEFINED
54 #define _RSIZE_T_DEFINED
55 typedef size_t rsize_t;
56 #endif
57 #endif /* __EXT1_VISIBLE */
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 /*
245 * Functions defined in all versions of POSIX 1003.1.
246 */
247 #if __BSD_VISIBLE || (__POSIX_VISIBLE && __POSIX_VISIBLE <= 199506)
248 #define L_cuserid 17 /* size for cuserid(3); MAXLOGNAME, legacy */
249 #endif
250
251 #if __POSIX_VISIBLE
252 #define L_ctermid 1024 /* size for ctermid(3); PATH_MAX */
253 #endif /* __POSIX_VISIBLE */
254
255 #if !defined(_STANDALONE) && defined(_FORTIFY_SOURCE) && _FORTIFY_SOURCE > 0
256 #include <ssp/stdio.h>
257 #endif
258
259 __BEGIN_DECLS
260 #ifdef _XLOCALE_H_
261 #include <xlocale/_stdio.h>
262 #endif
263 /*
264 * Functions defined in ANSI C standard.
265 */
266 void clearerr(FILE *);
267 int fclose(FILE *);
268 int feof(FILE *);
269 int ferror(FILE *);
270 int fflush(FILE *);
271 int fgetc(FILE *);
272 int fgetpos(FILE * __restrict, fpos_t * __restrict);
273 char *(fgets)(char * __restrict, int, FILE * __restrict);
274 FILE *fopen(const char * __restrict, const char * __restrict);
275 int fprintf(FILE * __restrict, const char * __restrict, ...);
276 int fputc(int, FILE *);
277 int fputs(const char * __restrict, FILE * __restrict);
278 size_t fread(void * __restrict, size_t, size_t, FILE * __restrict);
279 FILE *freopen(const char * __restrict, const char * __restrict, FILE * __restrict);
280 int fscanf(FILE * __restrict, const char * __restrict, ...);
281 int fseek(FILE *, long, int);
282 int fsetpos(FILE *, const fpos_t *);
283 long ftell(FILE *);
284 size_t fwrite(const void * __restrict, size_t, size_t, FILE * __restrict);
285 int getc(FILE *);
286 int getchar(void);
287 #if __EXT1_VISIBLE
288 char *gets_s(char *, rsize_t);
289 #endif
290 void perror(const char *);
291 int printf(const char * __restrict, ...);
292 int putc(int, FILE *);
293 int putchar(int);
294 int puts(const char *);
295 int remove(const char *);
296 int rename(const char *, const char *);
297 void rewind(FILE *);
298 int scanf(const char * __restrict, ...);
299 void setbuf(FILE * __restrict, char * __restrict);
300 int setvbuf(FILE * __restrict, char * __restrict, int, size_t);
301 int (sprintf)(char * __restrict, const char * __restrict, ...);
302 int sscanf(const char * __restrict, const char * __restrict, ...);
303 FILE *tmpfile(void);
304 char *tmpnam(char *);
305 int ungetc(int, FILE *);
306 int vfprintf(FILE * __restrict, const char * __restrict,
307 __va_list);
308 int vprintf(const char * __restrict, __va_list);
309 int (vsprintf)(char * __restrict, const char * __restrict,
310 __va_list);
311
312 #if __ISO_C_VISIBLE >= 1999 || __POSIX_VISIBLE >= 199506
313 int (snprintf)(char * __restrict, size_t, const char * __restrict,
314 ...) __printflike(3, 4);
315 int (vsnprintf)(char * __restrict, size_t, const char * __restrict,
316 __va_list) __printflike(3, 0);
317 #endif
318 #if __ISO_C_VISIBLE >= 1999
319 int vfscanf(FILE * __restrict, const char * __restrict, __va_list)
320 __scanflike(2, 0);
321 int vscanf(const char * __restrict, __va_list) __scanflike(1, 0);
322 int vsscanf(const char * __restrict, const char * __restrict, __va_list)
323 __scanflike(2, 0);
324 #endif
325
326 #if __POSIX_VISIBLE
327 char *ctermid(char *);
328 FILE *fdopen(int, const char *);
329 int fileno(FILE *);
330 #endif /* __POSIX_VISIBLE */
331
332 #if __POSIX_VISIBLE >= 199209
333 int pclose(FILE *);
334 FILE *popen(const char *, const char *);
335 #endif
336
337 #if __POSIX_VISIBLE >= 199506
338 int ftrylockfile(FILE *);
339 void flockfile(FILE *);
340 void funlockfile(FILE *);
341
342 /*
343 * These are normally used through macros as defined below, but POSIX
344 * requires functions as well.
345 */
346 int getc_unlocked(FILE *);
347 int getchar_unlocked(void);
348 int putc_unlocked(int, FILE *);
349 int putchar_unlocked(int);
350 #endif
351 #if __BSD_VISIBLE
352 void clearerr_unlocked(FILE *);
353 int feof_unlocked(FILE *);
354 int ferror_unlocked(FILE *);
355 int fflush_unlocked(FILE *);
356 int fileno_unlocked(FILE *);
357 int fputc_unlocked(int, FILE *);
358 int fputs_unlocked(const char * __restrict, FILE * __restrict);
359 size_t fread_unlocked(void * __restrict, size_t, size_t, FILE * __restrict);
360 size_t fwrite_unlocked(const void * __restrict, size_t, size_t,
361 FILE * __restrict);
362 #endif
363
364 #if __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE >= 500
365 int fseeko(FILE *, __off_t, int);
366 __off_t ftello(FILE *);
367 #endif
368
369 #if __BSD_VISIBLE || __XSI_VISIBLE > 0 && __XSI_VISIBLE < 600
370 int getw(FILE *);
371 int putw(int, FILE *);
372 #endif /* BSD or X/Open before issue 6 */
373
374 #if __XSI_VISIBLE
375 char *tempnam(const char *, const char *);
376 #endif
377
378 #if __POSIX_VISIBLE >= 200809
379 FILE *fmemopen(void * __restrict, size_t, const char * __restrict);
380 ssize_t getdelim(char ** __restrict, size_t * __restrict, int,
381 FILE * __restrict);
382 FILE *open_memstream(char **, size_t *);
383 int renameat(int, const char *, int, const char *);
384 int vdprintf(int, const char * __restrict, __va_list) __printflike(2, 0);
385 /* _WITH_GETLINE to allow pre 11 sources to build on 11+ systems */
386 ssize_t getline(char ** __restrict, size_t * __restrict, FILE * __restrict);
387 int dprintf(int, const char * __restrict, ...) __printflike(2, 3);
388 #endif /* __POSIX_VISIBLE >= 200809 */
389
390 /*
391 * Routines that are purely local.
392 */
393 #if __BSD_VISIBLE
394 int asprintf(char **, const char *, ...) __printflike(2, 3);
395 char *ctermid_r(char *);
396 void fcloseall(void);
397 int fdclose(FILE *, int *);
398 char *fgetln(FILE *, size_t *);
399 const char *fmtcheck(const char *, const char *) __format_arg(2);
400 int fpurge(FILE *);
401 void setbuffer(FILE *, char *, int);
402 int setlinebuf(FILE *);
403 int vasprintf(char **, const char *, __va_list)
404 __printflike(2, 0);
405
406 /*
407 * The system error table contains messages for the first sys_nerr
408 * positive errno values. Use strerror() or strerror_r() from <string.h>
409 * instead.
410 */
411 extern const int sys_nerr;
412 extern const char * const sys_errlist[];
413
414 /*
415 * Stdio function-access interface.
416 */
417 FILE *funopen(const void *,
418 int (* _Nullable)(void *, char *, int),
419 int (* _Nullable)(void *, const char *, int),
420 fpos_t (* _Nullable)(void *, fpos_t, int),
421 int (* _Nullable)(void *));
422 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
423 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
424
425 #if __BSD_VISIBLE
426 typedef __ssize_t cookie_read_function_t(void *, char *, size_t);
427 typedef __ssize_t cookie_write_function_t(void *, const char *, size_t);
428 typedef int cookie_seek_function_t(void *, off64_t *, int);
429 typedef int cookie_close_function_t(void *);
430 typedef struct {
431 cookie_read_function_t *read;
432 cookie_write_function_t *write;
433 cookie_seek_function_t *seek;
434 cookie_close_function_t *close;
435 } cookie_io_functions_t;
436 FILE *fopencookie(void *, const char *, cookie_io_functions_t);
437 #endif
438
439 /*
440 * Portability hacks. See <sys/types.h>.
441 */
442 #ifndef _FTRUNCATE_DECLARED
443 #define _FTRUNCATE_DECLARED
444 int ftruncate(int, __off_t);
445 #endif
446 #ifndef _LSEEK_DECLARED
447 #define _LSEEK_DECLARED
448 __off_t lseek(int, __off_t, int);
449 #endif
450 #ifndef _MMAP_DECLARED
451 #define _MMAP_DECLARED
452 void *mmap(void *, size_t, int, int, int, __off_t);
453 #endif
454 #ifndef _TRUNCATE_DECLARED
455 #define _TRUNCATE_DECLARED
456 int truncate(const char *, __off_t);
457 #endif
458 #endif /* __BSD_VISIBLE */
459
460 /*
461 * Functions internal to the implementation.
462 */
463 int __srget(FILE *);
464 int __swbuf(int, FILE *);
465
466 /*
467 * The __sfoo macros are here so that we can
468 * define function versions in the C library.
469 */
470 #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++))
471 #if defined(__GNUC__) && defined(__STDC__)
__sputc(int _c,FILE * _p)472 static __inline int __sputc(int _c, FILE *_p) {
473 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n'))
474 return (*_p->_p++ = _c);
475 else
476 return (__swbuf(_c, _p));
477 }
478 #else
479 /*
480 * This has been tuned to generate reasonable code on the vax using pcc.
481 */
482 #define __sputc(c, p) \
483 (--(p)->_w < 0 ? \
484 (p)->_w >= (p)->_lbfsize ? \
485 (*(p)->_p = (c)), *(p)->_p != '\n' ? \
486 (int)*(p)->_p++ : \
487 __swbuf('\n', p) : \
488 __swbuf((int)(c), p) : \
489 (*(p)->_p = (c), (int)*(p)->_p++))
490 #endif
491
492 #ifndef __LIBC_ISTHREADED_DECLARED
493 #define __LIBC_ISTHREADED_DECLARED
494 extern int __isthreaded;
495 #endif
496
497 #ifndef __cplusplus
498
499 #define __sfeof(p) (((p)->_flags & __SEOF) != 0)
500 #define __sferror(p) (((p)->_flags & __SERR) != 0)
501 #define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF)))
502 #define __sfileno(p) ((p)->_file)
503
504
505 #define feof(p) (!__isthreaded ? __sfeof(p) : (feof)(p))
506 #define ferror(p) (!__isthreaded ? __sferror(p) : (ferror)(p))
507 #define clearerr(p) (!__isthreaded ? __sclearerr(p) : (clearerr)(p))
508
509 #if __POSIX_VISIBLE
510 #define fileno(p) (!__isthreaded ? __sfileno(p) : (fileno)(p))
511 #endif
512
513 #define getc(fp) (!__isthreaded ? __sgetc(fp) : (getc)(fp))
514 #define putc(x, fp) (!__isthreaded ? __sputc(x, fp) : (putc)(x, fp))
515
516 #define getchar() getc(stdin)
517 #define putchar(x) putc(x, stdout)
518
519 #if __BSD_VISIBLE
520 /*
521 * See ISO/IEC 9945-1 ANSI/IEEE Std 1003.1 Second Edition 1996-07-12
522 * B.8.2.7 for the rationale behind the *_unlocked() macros.
523 */
524 #define clearerr_unlocked(p) __sclearerr(p)
525 #define feof_unlocked(p) __sfeof(p)
526 #define ferror_unlocked(p) __sferror(p)
527 #define fileno_unlocked(p) __sfileno(p)
528 #define fputc_unlocked(s, p) __sputc(s, p)
529 #endif
530 #if __POSIX_VISIBLE >= 199506
531 #define getc_unlocked(fp) __sgetc(fp)
532 #define putc_unlocked(x, fp) __sputc(x, fp)
533
534 #define getchar_unlocked() getc_unlocked(stdin)
535 #define putchar_unlocked(x) putc_unlocked(x, stdout)
536 #endif
537 #endif /* __cplusplus */
538
539 __END_DECLS
540 __NULLABILITY_PRAGMA_POP
541
542 #endif /* !_STDIO_H_ */
543