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