1/*-
2 * Copyright (c) 1990, 1993
3 *	The Regents of the University of California.  All rights reserved.
4 *
5 * This code is derived from software contributed to Berkeley by
6 * Chris Torek.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in the
15 *    documentation and/or other materials provided with the distribution.
16 * 3. Neither the name of the University nor the names of its contributors
17 *    may be used to endorse or promote products derived from this software
18 *    without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * SUCH DAMAGE.
31 *
32 *	@(#)stdio.h	8.5 (Berkeley) 4/29/95
33 * $FreeBSD$
34 */
35
36#ifndef	_STDIO_H_
37#define	_STDIO_H_
38
39#include <sys/cdefs.h>
40#include <sys/_null.h>
41#include <sys/_types.h>
42
43typedef	__off_t		fpos_t;
44
45#ifndef _SIZE_T_DECLARED
46typedef	__size_t	size_t;
47#define	_SIZE_T_DECLARED
48#endif
49
50#if __POSIX_VISIBLE >= 200809
51#ifndef _OFF_T_DECLARED
52#define	_OFF_T_DECLARED
53typedef	__off_t		off_t;
54#endif
55#ifndef _SSIZE_T_DECLARED
56#define	_SSIZE_T_DECLARED
57typedef	__ssize_t	ssize_t;
58#endif
59#endif
60
61#if __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE
62#ifndef _VA_LIST_DECLARED
63typedef	__va_list	va_list;
64#define	_VA_LIST_DECLARED
65#endif
66#endif
67
68#define	_FSTDIO			/* Define for new stdio with functions. */
69
70/*
71 * NB: to fit things in six character monocase externals, the stdio
72 * code uses the prefix `__s' for stdio objects, typically followed
73 * by a three-character attempt at a mnemonic.
74 */
75
76/* stdio buffers */
77struct __sbuf {
78	unsigned char *_base;
79	int	_size;
80};
81
82/*
83 * stdio state variables.
84 *
85 * The following always hold:
86 *
87 *	if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR),
88 *		_lbfsize is -_bf._size, else _lbfsize is 0
89 *	if _flags&__SRD, _w is 0
90 *	if _flags&__SWR, _r is 0
91 *
92 * This ensures that the getc and putc macros (or inline functions) never
93 * try to write or read from a file that is in `read' or `write' mode.
94 * (Moreover, they can, and do, automatically switch from read mode to
95 * write mode, and back, on "r+" and "w+" files.)
96 *
97 * _lbfsize is used only to make the inline line-buffered output stream
98 * code as compact as possible.
99 *
100 * _ub, _up, and _ur are used when ungetc() pushes back more characters
101 * than fit in the current _bf, or when ungetc() pushes back a character
102 * that does not match the previous one in _bf.  When this happens,
103 * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff
104 * _ub._base!=NULL) and _up and _ur save the current values of _p and _r.
105 *
106 * Certain members of __sFILE are accessed directly via macros or
107 * inline functions.  To preserve ABI compat, these members must not
108 * be disturbed.  These members are marked below with (*).
109 */
110struct __sFILE {
111	unsigned char *_p;	/* (*) current position in (some) buffer */
112	int	_r;		/* (*) read space left for getc() */
113	int	_w;		/* (*) write space left for putc() */
114	short	_flags;		/* (*) flags, below; this FILE is free if 0 */
115	short	_file;		/* (*) fileno, if Unix descriptor, else -1 */
116	struct	__sbuf _bf;	/* (*) the buffer (at least 1 byte, if !NULL) */
117	int	_lbfsize;	/* (*) 0 or -_bf._size, for inline putc */
118
119	/* operations */
120	void	*_cookie;	/* (*) cookie passed to io functions */
121	int	(*_close)(void *);
122	int	(*_read)(void *, char *, int);
123	fpos_t	(*_seek)(void *, fpos_t, int);
124	int	(*_write)(void *, const char *, int);
125
126	/* separate buffer for long sequences of ungetc() */
127	struct	__sbuf _ub;	/* ungetc buffer */
128	unsigned char	*_up;	/* saved _p when _p is doing ungetc data */
129	int	_ur;		/* saved _r when _r is counting ungetc data */
130
131	/* tricks to meet minimum requirements even when malloc() fails */
132	unsigned char _ubuf[3];	/* guarantee an ungetc() buffer */
133	unsigned char _nbuf[1];	/* guarantee a getc() buffer */
134
135	/* separate buffer for fgetln() when line crosses buffer boundary */
136	struct	__sbuf _lb;	/* buffer for fgetln() */
137
138	/* Unix stdio files get aligned to block boundaries on fseek() */
139	int	_blksize;	/* stat.st_blksize (may be != _bf._size) */
140	fpos_t	_offset;	/* current lseek offset */
141
142	struct pthread_mutex *_fl_mutex;	/* used for MT-safety */
143	struct pthread *_fl_owner;	/* current owner */
144	int	_fl_count;	/* recursive lock count */
145	int	_orientation;	/* orientation for fwide() */
146	__mbstate_t _mbstate;	/* multibyte conversion state */
147	int	_flags2;	/* additional flags */
148};
149#ifndef _STDFILE_DECLARED
150#define _STDFILE_DECLARED
151typedef struct __sFILE FILE;
152#endif
153#ifndef _STDSTREAM_DECLARED
154__BEGIN_DECLS
155extern FILE *__stdinp;
156extern FILE *__stdoutp;
157extern FILE *__stderrp;
158__END_DECLS
159#define	_STDSTREAM_DECLARED
160#endif
161
162#define	__SLBF	0x0001		/* line buffered */
163#define	__SNBF	0x0002		/* unbuffered */
164#define	__SRD	0x0004		/* OK to read */
165#define	__SWR	0x0008		/* OK to write */
166	/* RD and WR are never simultaneously asserted */
167#define	__SRW	0x0010		/* open for reading & writing */
168#define	__SEOF	0x0020		/* found EOF */
169#define	__SERR	0x0040		/* found error */
170#define	__SMBF	0x0080		/* _bf._base is from malloc */
171#define	__SAPP	0x0100		/* fdopen()ed in append mode */
172#define	__SSTR	0x0200		/* this is an sprintf/snprintf string */
173#define	__SOPT	0x0400		/* do fseek() optimization */
174#define	__SNPT	0x0800		/* do not do fseek() optimization */
175#define	__SOFF	0x1000		/* set iff _offset is in fact correct */
176#define	__SMOD	0x2000		/* true => fgetln modified _p text */
177#define	__SALC	0x4000		/* allocate string space dynamically */
178#define	__SIGN	0x8000		/* ignore this file in _fwalk */
179
180#define	__S2OAP	0x0001		/* O_APPEND mode is set */
181
182/*
183 * The following three definitions are for ANSI C, which took them
184 * from System V, which brilliantly took internal interface macros and
185 * made them official arguments to setvbuf(), without renaming them.
186 * Hence, these ugly _IOxxx names are *supposed* to appear in user code.
187 *
188 * Although numbered as their counterparts above, the implementation
189 * does not rely on this.
190 */
191#define	_IOFBF	0		/* setvbuf should set fully buffered */
192#define	_IOLBF	1		/* setvbuf should set line buffered */
193#define	_IONBF	2		/* setvbuf should set unbuffered */
194
195#define	BUFSIZ	1024		/* size of buffer used by setbuf */
196#define	EOF	(-1)
197
198/*
199 * FOPEN_MAX is a minimum maximum, and is the number of streams that
200 * stdio can provide without attempting to allocate further resources
201 * (which could fail).  Do not use this for anything.
202 */
203				/* must be == _POSIX_STREAM_MAX <limits.h> */
204#ifndef FOPEN_MAX
205#define	FOPEN_MAX	20	/* must be <= OPEN_MAX <sys/syslimits.h> */
206#endif
207#define	FILENAME_MAX	1024	/* must be <= PATH_MAX <sys/syslimits.h> */
208
209/* System V/ANSI C; this is the wrong way to do this, do *not* use these. */
210#if __XSI_VISIBLE
211#define	P_tmpdir	"/tmp/"
212#endif
213#define	L_tmpnam	1024	/* XXX must be == PATH_MAX */
214#define	TMP_MAX		308915776
215
216#ifndef SEEK_SET
217#define	SEEK_SET	0	/* set file offset to offset */
218#endif
219#ifndef SEEK_CUR
220#define	SEEK_CUR	1	/* set file offset to current plus offset */
221#endif
222#ifndef SEEK_END
223#define	SEEK_END	2	/* set file offset to EOF plus offset */
224#endif
225
226#define	stdin	__stdinp
227#define	stdout	__stdoutp
228#define	stderr	__stderrp
229
230__BEGIN_DECLS
231#ifdef _XLOCALE_H_
232#include <xlocale/_stdio.h>
233#endif
234/*
235 * Functions defined in ANSI C standard.
236 */
237void	 clearerr(FILE *);
238int	 fclose(FILE *);
239int	 feof(FILE *);
240int	 ferror(FILE *);
241int	 fflush(FILE *);
242int	 fgetc(FILE *);
243int	 fgetpos(FILE * __restrict, fpos_t * __restrict);
244char	*fgets(char * __restrict, int, FILE * __restrict);
245FILE	*fopen(const char * __restrict, const char * __restrict);
246int	 fprintf(FILE * __restrict, const char * __restrict, ...);
247int	 fputc(int, FILE *);
248int	 fputs(const char * __restrict, FILE * __restrict);
249size_t	 fread(void * __restrict, size_t, size_t, FILE * __restrict);
250FILE	*freopen(const char * __restrict, const char * __restrict, FILE * __restrict);
251int	 fscanf(FILE * __restrict, const char * __restrict, ...);
252int	 fseek(FILE *, long, int);
253int	 fsetpos(FILE *, const fpos_t *);
254long	 ftell(FILE *);
255size_t	 fwrite(const void * __restrict, size_t, size_t, FILE * __restrict);
256int	 getc(FILE *);
257int	 getchar(void);
258char	*gets(char *);
259void	 perror(const char *);
260int	 printf(const char * __restrict, ...);
261int	 putc(int, FILE *);
262int	 putchar(int);
263int	 puts(const char *);
264int	 remove(const char *);
265int	 rename(const char *, const char *);
266void	 rewind(FILE *);
267int	 scanf(const char * __restrict, ...);
268void	 setbuf(FILE * __restrict, char * __restrict);
269int	 setvbuf(FILE * __restrict, char * __restrict, int, size_t);
270int	 sprintf(char * __restrict, const char * __restrict, ...);
271int	 sscanf(const char * __restrict, const char * __restrict, ...);
272FILE	*tmpfile(void);
273char	*tmpnam(char *);
274int	 ungetc(int, FILE *);
275int	 vfprintf(FILE * __restrict, const char * __restrict,
276	    __va_list);
277int	 vprintf(const char * __restrict, __va_list);
278int	 vsprintf(char * __restrict, const char * __restrict,
279	    __va_list);
280
281#if __ISO_C_VISIBLE >= 1999
282int	 snprintf(char * __restrict, size_t, const char * __restrict,
283	    ...) __printflike(3, 4);
284int	 vfscanf(FILE * __restrict, const char * __restrict, __va_list)
285	    __scanflike(2, 0);
286int	 vscanf(const char * __restrict, __va_list) __scanflike(1, 0);
287int	 vsnprintf(char * __restrict, size_t, const char * __restrict,
288	    __va_list) __printflike(3, 0);
289int	 vsscanf(const char * __restrict, const char * __restrict, __va_list)
290	    __scanflike(2, 0);
291#endif
292
293/*
294 * Functions defined in all versions of POSIX 1003.1.
295 */
296#if __BSD_VISIBLE || (__POSIX_VISIBLE && __POSIX_VISIBLE <= 199506)
297#define	L_cuserid	17	/* size for cuserid(3); MAXLOGNAME, legacy */
298#endif
299
300#if __POSIX_VISIBLE
301#define	L_ctermid	1024	/* size for ctermid(3); PATH_MAX */
302
303char	*ctermid(char *);
304FILE	*fdopen(int, const char *);
305int	 fileno(FILE *);
306#endif /* __POSIX_VISIBLE */
307
308#if __POSIX_VISIBLE >= 199209
309int	 pclose(FILE *);
310FILE	*popen(const char *, const char *);
311#endif
312
313#if __POSIX_VISIBLE >= 199506
314int	 ftrylockfile(FILE *);
315void	 flockfile(FILE *);
316void	 funlockfile(FILE *);
317
318/*
319 * These are normally used through macros as defined below, but POSIX
320 * requires functions as well.
321 */
322int	 getc_unlocked(FILE *);
323int	 getchar_unlocked(void);
324int	 putc_unlocked(int, FILE *);
325int	 putchar_unlocked(int);
326#endif
327#if __BSD_VISIBLE
328void	 clearerr_unlocked(FILE *);
329int	 feof_unlocked(FILE *);
330int	 ferror_unlocked(FILE *);
331int	 fileno_unlocked(FILE *);
332#endif
333
334#if __POSIX_VISIBLE >= 200112
335int	 fseeko(FILE *, __off_t, int);
336__off_t	 ftello(FILE *);
337#endif
338
339#if __BSD_VISIBLE || __XSI_VISIBLE > 0 && __XSI_VISIBLE < 600
340int	 getw(FILE *);
341int	 putw(int, FILE *);
342#endif /* BSD or X/Open before issue 6 */
343
344#if __XSI_VISIBLE
345char	*tempnam(const char *, const char *);
346#endif
347
348#if __POSIX_VISIBLE >= 200809
349FILE	*fmemopen(void * __restrict, size_t, const char * __restrict);
350ssize_t	 getdelim(char ** __restrict, size_t * __restrict, int,
351	    FILE * __restrict);
352FILE	*open_memstream(char **, size_t *);
353int	 renameat(int, const char *, int, const char *);
354int	 vdprintf(int, const char * __restrict, __va_list);
355
356/*
357 * Every programmer and his dog wrote functions called getline() and dprintf()
358 * before POSIX.1-2008 came along and decided to usurp the names, so we
359 * don't prototype them by default unless one of the following is true:
360 *   a) the app has requested them specifically by defining _WITH_GETLINE or
361 *      _WITH_DPRINTF, respectively
362 *   b) the app has requested a POSIX.1-2008 environment via _POSIX_C_SOURCE
363 *   c) the app defines a GNUism such as _BSD_SOURCE or _GNU_SOURCE
364 */
365#ifndef _WITH_GETLINE
366#if defined(_BSD_SOURCE) || defined(_GNU_SOURCE)
367#define	_WITH_GETLINE
368#elif defined(_POSIX_C_SOURCE)
369#if _POSIX_C_SOURCE >= 200809
370#define	_WITH_GETLINE
371#endif
372#endif
373#endif
374
375#ifdef _WITH_GETLINE
376ssize_t	 getline(char ** __restrict, size_t * __restrict, FILE * __restrict);
377#endif
378
379#ifndef _WITH_DPRINTF
380#if defined(_BSD_SOURCE) || defined(_GNU_SOURCE)
381#define	_WITH_DPRINTF
382#elif defined(_POSIX_C_SOURCE)
383#if _POSIX_C_SOURCE >= 200809
384#define	_WITH_DPRINTF
385#endif
386#endif
387#endif
388
389#ifdef _WITH_DPRINTF
390int	 (dprintf)(int, const char * __restrict, ...);
391#endif
392
393#endif /* __POSIX_VISIBLE >= 200809 */
394
395/*
396 * Routines that are purely local.
397 */
398#if __BSD_VISIBLE
399int	 asprintf(char **, const char *, ...) __printflike(2, 3);
400char	*ctermid_r(char *);
401void	 fcloseall(void);
402int	 fdclose(FILE *, int *);
403char	*fgetln(FILE *, size_t *);
404const char *fmtcheck(const char *, const char *) __format_arg(2);
405int	 fpurge(FILE *);
406void	 setbuffer(FILE *, char *, int);
407int	 setlinebuf(FILE *);
408int	 vasprintf(char **, const char *, __va_list)
409	    __printflike(2, 0);
410
411/*
412 * The system error table contains messages for the first sys_nerr
413 * positive errno values.  Use strerror() or strerror_r() from <string.h>
414 * instead.
415 */
416extern const int sys_nerr;
417extern const char * const sys_errlist[];
418
419/*
420 * Stdio function-access interface.
421 */
422FILE	*funopen(const void *,
423	    int (*)(void *, char *, int),
424	    int (*)(void *, const char *, int),
425	    fpos_t (*)(void *, fpos_t, int),
426	    int (*)(void *));
427#define	fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
428#define	fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
429
430/*
431 * Portability hacks.  See <sys/types.h>.
432 */
433#ifndef _FTRUNCATE_DECLARED
434#define	_FTRUNCATE_DECLARED
435int	 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
443void	*mmap(void *, size_t, int, int, int, __off_t);
444#endif
445#ifndef _TRUNCATE_DECLARED
446#define	_TRUNCATE_DECLARED
447int	 truncate(const char *, __off_t);
448#endif
449#endif /* __BSD_VISIBLE */
450
451/*
452 * Functions internal to the implementation.
453 */
454int	__srget(FILE *);
455int	__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__)
463static __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
483extern int __isthreaded;
484
485#ifndef __cplusplus
486
487#define	__sfeof(p)	(((p)->_flags & __SEOF) != 0)
488#define	__sferror(p)	(((p)->_flags & __SERR) != 0)
489#define	__sclearerr(p)	((void)((p)->_flags &= ~(__SERR|__SEOF)))
490#define	__sfileno(p)	((p)->_file)
491
492
493#define	feof(p)		(!__isthreaded ? __sfeof(p) : (feof)(p))
494#define	ferror(p)	(!__isthreaded ? __sferror(p) : (ferror)(p))
495#define	clearerr(p)	(!__isthreaded ? __sclearerr(p) : (clearerr)(p))
496
497#if __POSIX_VISIBLE
498#define	fileno(p)	(!__isthreaded ? __sfileno(p) : (fileno)(p))
499#endif
500
501#define	getc(fp)	(!__isthreaded ? __sgetc(fp) : (getc)(fp))
502#define	putc(x, fp)	(!__isthreaded ? __sputc(x, fp) : (putc)(x, fp))
503
504#define	getchar()	getc(stdin)
505#define	putchar(x)	putc(x, stdout)
506
507#if __BSD_VISIBLE
508/*
509 * See ISO/IEC 9945-1 ANSI/IEEE Std 1003.1 Second Edition 1996-07-12
510 * B.8.2.7 for the rationale behind the *_unlocked() macros.
511 */
512#define	feof_unlocked(p)	__sfeof(p)
513#define	ferror_unlocked(p)	__sferror(p)
514#define	clearerr_unlocked(p)	__sclearerr(p)
515#define	fileno_unlocked(p)	__sfileno(p)
516#endif
517#if __POSIX_VISIBLE >= 199506
518#define	getc_unlocked(fp)	__sgetc(fp)
519#define	putc_unlocked(x, fp)	__sputc(x, fp)
520
521#define	getchar_unlocked()	getc_unlocked(stdin)
522#define	putchar_unlocked(x)	putc_unlocked(x, stdout)
523#endif
524#endif /* __cplusplus */
525
526__END_DECLS
527#endif /* !_STDIO_H_ */
528