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