2 * Copyright (c) 1990, 1993
3 * The Regents of the University of California. All rights reserved.
5 * This code is derived from software contributed to Berkeley by
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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. All advertising materials mentioning features or use of this software
17 * must display the following acknowledgement:
18 * This product includes software developed by the University of
19 * California, Berkeley and its contributors.
20 * 4. Neither the name of the University nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 * @(#)stdio.h 8.5 (Berkeley) 4/29/95
43 #include <sys/cdefs.h>
44 #include <sys/_null.h>
45 #include <sys/_types.h>
47 typedef __off_t fpos_t;
49 #ifndef _SIZE_T_DECLARED
50 typedef __size_t size_t;
51 #define _SIZE_T_DECLARED
54 #if __BSD_VISIBLE || __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE
55 #ifndef _VA_LIST_DECLARED
56 typedef __va_list va_list;
57 #define _VA_LIST_DECLARED
61 #define _FSTDIO /* Define for new stdio with functions. */
64 * NB: to fit things in six character monocase externals, the stdio
65 * code uses the prefix `__s' for stdio objects, typically followed
66 * by a three-character attempt at a mnemonic.
76 * stdio state variables.
78 * The following always hold:
80 * if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR),
81 * _lbfsize is -_bf._size, else _lbfsize is 0
82 * if _flags&__SRD, _w is 0
83 * if _flags&__SWR, _r is 0
85 * This ensures that the getc and putc macros (or inline functions) never
86 * try to write or read from a file that is in `read' or `write' mode.
87 * (Moreover, they can, and do, automatically switch from read mode to
88 * write mode, and back, on "r+" and "w+" files.)
90 * _lbfsize is used only to make the inline line-buffered output stream
91 * code as compact as possible.
93 * _ub, _up, and _ur are used when ungetc() pushes back more characters
94 * than fit in the current _bf, or when ungetc() pushes back a character
95 * that does not match the previous one in _bf. When this happens,
96 * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff
97 * _ub._base!=NULL) and _up and _ur save the current values of _p and _r.
99 * Certain members of __sFILE are accessed directly via macros or
100 * inline functions. To preserve ABI compat, these members must not
101 * be disturbed. These members are marked below with (*).
103 typedef struct __sFILE {
104 unsigned char *_p; /* (*) current position in (some) buffer */
105 int _r; /* (*) read space left for getc() */
106 int _w; /* (*) write space left for putc() */
107 short _flags; /* (*) flags, below; this FILE is free if 0 */
108 short _file; /* (*) fileno, if Unix descriptor, else -1 */
109 struct __sbuf _bf; /* the buffer (at least 1 byte, if !NULL) */
110 int _lbfsize; /* (*) 0 or -_bf._size, for inline putc */
113 void *_cookie; /* (*) cookie passed to io functions */
114 int (*_close)(void *);
115 int (*_read)(void *, char *, int);
116 fpos_t (*_seek)(void *, fpos_t, int);
117 int (*_write)(void *, const char *, int);
119 /* separate buffer for long sequences of ungetc() */
120 struct __sbuf _ub; /* ungetc buffer */
121 unsigned char *_up; /* saved _p when _p is doing ungetc data */
122 int _ur; /* saved _r when _r is counting ungetc data */
124 /* tricks to meet minimum requirements even when malloc() fails */
125 unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */
126 unsigned char _nbuf[1]; /* guarantee a getc() buffer */
128 /* separate buffer for fgetln() when line crosses buffer boundary */
129 struct __sbuf _lb; /* buffer for fgetln() */
131 /* Unix stdio files get aligned to block boundaries on fseek() */
132 int _blksize; /* stat.st_blksize (may be != _bf._size) */
133 fpos_t _offset; /* current lseek offset */
135 struct pthread_mutex *_fl_mutex; /* used for MT-safety */
136 struct pthread *_fl_owner; /* current owner */
137 int _fl_count; /* recursive lock count */
138 int _orientation; /* orientation for fwide() */
139 __mbstate_t _mbstate; /* multibyte conversion state */
142 #ifndef _STDSTREAM_DECLARED
144 extern FILE *__stdinp;
145 extern FILE *__stdoutp;
146 extern FILE *__stderrp;
148 #define _STDSTREAM_DECLARED
151 #define __SLBF 0x0001 /* line buffered */
152 #define __SNBF 0x0002 /* unbuffered */
153 #define __SRD 0x0004 /* OK to read */
154 #define __SWR 0x0008 /* OK to write */
155 /* RD and WR are never simultaneously asserted */
156 #define __SRW 0x0010 /* open for reading & writing */
157 #define __SEOF 0x0020 /* found EOF */
158 #define __SERR 0x0040 /* found error */
159 #define __SMBF 0x0080 /* _buf is from malloc */
160 #define __SAPP 0x0100 /* fdopen()ed in append mode */
161 #define __SSTR 0x0200 /* this is an sprintf/snprintf string */
162 #define __SOPT 0x0400 /* do fseek() optimization */
163 #define __SNPT 0x0800 /* do not do fseek() optimization */
164 #define __SOFF 0x1000 /* set iff _offset is in fact correct */
165 #define __SMOD 0x2000 /* true => fgetln modified _p text */
166 #define __SALC 0x4000 /* allocate string space dynamically */
167 #define __SIGN 0x8000 /* ignore this file in _fwalk */
170 * The following three definitions are for ANSI C, which took them
171 * from System V, which brilliantly took internal interface macros and
172 * made them official arguments to setvbuf(), without renaming them.
173 * Hence, these ugly _IOxxx names are *supposed* to appear in user code.
175 * Although numbered as their counterparts above, the implementation
176 * does not rely on this.
178 #define _IOFBF 0 /* setvbuf should set fully buffered */
179 #define _IOLBF 1 /* setvbuf should set line buffered */
180 #define _IONBF 2 /* setvbuf should set unbuffered */
182 #define BUFSIZ 1024 /* size of buffer used by setbuf */
186 * FOPEN_MAX is a minimum maximum, and is the number of streams that
187 * stdio can provide without attempting to allocate further resources
188 * (which could fail). Do not use this for anything.
190 /* must be == _POSIX_STREAM_MAX <limits.h> */
192 #define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */
194 #define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */
196 /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */
198 #define P_tmpdir "/var/tmp/"
200 #define L_tmpnam 1024 /* XXX must be == PATH_MAX */
201 #define TMP_MAX 308915776
204 #define SEEK_SET 0 /* set file offset to offset */
207 #define SEEK_CUR 1 /* set file offset to current plus offset */
210 #define SEEK_END 2 /* set file offset to EOF plus offset */
213 #define stdin __stdinp
214 #define stdout __stdoutp
215 #define stderr __stderrp
219 * Functions defined in ANSI C standard.
221 void clearerr(FILE *);
227 int fgetpos(FILE * __restrict, fpos_t * __restrict);
228 char *fgets(char * __restrict, int, FILE * __restrict);
229 FILE *fopen(const char * __restrict, const char * __restrict);
230 int fprintf(FILE * __restrict, const char * __restrict, ...);
231 int fputc(int, FILE *);
232 int fputs(const char * __restrict, FILE * __restrict);
233 size_t fread(void * __restrict, size_t, size_t, FILE * __restrict);
234 FILE *freopen(const char * __restrict, const char * __restrict, FILE * __restrict);
235 int fscanf(FILE * __restrict, const char * __restrict, ...);
236 int fseek(FILE *, long, int);
237 int fsetpos(FILE *, const fpos_t *);
239 size_t fwrite(const void * __restrict, size_t, size_t, FILE * __restrict);
243 void perror(const char *);
244 int printf(const char * __restrict, ...);
245 int putc(int, FILE *);
247 int puts(const char *);
248 int remove(const char *);
249 int rename(const char *, const char *);
251 int scanf(const char * __restrict, ...);
252 void setbuf(FILE * __restrict, char * __restrict);
253 int setvbuf(FILE * __restrict, char * __restrict, int, size_t);
254 int sprintf(char * __restrict, const char * __restrict, ...);
255 int sscanf(const char * __restrict, const char * __restrict, ...);
257 char *tmpnam(char *);
258 int ungetc(int, FILE *);
259 int vfprintf(FILE * __restrict, const char * __restrict,
261 int vprintf(const char * __restrict, __va_list);
262 int vsprintf(char * __restrict, const char * __restrict,
265 #if __ISO_C_VISIBLE >= 1999
266 int snprintf(char * __restrict, size_t, const char * __restrict,
267 ...) __printflike(3, 4);
268 int vfscanf(FILE * __restrict, const char * __restrict, __va_list)
270 int vscanf(const char * __restrict, __va_list) __scanflike(1, 0);
271 int vsnprintf(char * __restrict, size_t, const char * __restrict,
272 __va_list) __printflike(3, 0);
273 int vsscanf(const char * __restrict, const char * __restrict, __va_list)
278 * Functions defined in all versions of POSIX 1003.1.
280 #if __BSD_VISIBLE || __POSIX_VISIBLE <= 199506
281 /* size for cuserid(3); UT_NAMESIZE + 1, see <utmp.h> */
282 #define L_cuserid 17 /* legacy */
286 #define L_ctermid 1024 /* size for ctermid(3); PATH_MAX */
288 char *ctermid(char *);
289 FILE *fdopen(int, const char *);
291 #endif /* __POSIX_VISIBLE */
293 #if __POSIX_VISIBLE >= 199209
295 FILE *popen(const char *, const char *);
298 #if __POSIX_VISIBLE >= 199506
299 int ftrylockfile(FILE *);
300 void flockfile(FILE *);
301 void funlockfile(FILE *);
304 * These are normally used through macros as defined below, but POSIX
305 * requires functions as well.
307 int getc_unlocked(FILE *);
308 int getchar_unlocked(void);
309 int putc_unlocked(int, FILE *);
310 int putchar_unlocked(int);
313 void clearerr_unlocked(FILE *);
314 int feof_unlocked(FILE *);
315 int ferror_unlocked(FILE *);
316 int fileno_unlocked(FILE *);
319 #if __POSIX_VISIBLE >= 200112
320 int fseeko(FILE *, __off_t, int);
321 __off_t ftello(FILE *);
324 #if __BSD_VISIBLE || __XSI_VISIBLE > 0 && __XSI_VISIBLE < 600
326 int putw(int, FILE *);
327 #endif /* BSD or X/Open before issue 6 */
330 char *tempnam(const char *, const char *);
334 * Routines that are purely local.
337 int asprintf(char **, const char *, ...) __printflike(2, 3);
338 char *ctermid_r(char *);
339 void fcloseall(void);
340 char *fgetln(FILE *, size_t *);
341 __const char *fmtcheck(const char *, const char *) __format_arg(2);
343 int renameat(int, const char *, int, const char *);
344 void setbuffer(FILE *, char *, int);
345 int setlinebuf(FILE *);
346 int vasprintf(char **, const char *, __va_list)
350 * The system error table contains messages for the first sys_nerr
351 * positive errno values. Use strerror() or strerror_r() from <string.h>
354 extern __const int sys_nerr;
355 extern __const char *__const sys_errlist[];
358 * Stdio function-access interface.
360 FILE *funopen(const void *,
361 int (*)(void *, char *, int),
362 int (*)(void *, const char *, int),
363 fpos_t (*)(void *, fpos_t, int),
365 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
366 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
369 * Portability hacks. See <sys/types.h>.
371 #ifndef _FTRUNCATE_DECLARED
372 #define _FTRUNCATE_DECLARED
373 int ftruncate(int, __off_t);
375 #ifndef _LSEEK_DECLARED
376 #define _LSEEK_DECLARED
377 __off_t lseek(int, __off_t, int);
379 #ifndef _MMAP_DECLARED
380 #define _MMAP_DECLARED
381 void *mmap(void *, size_t, int, int, int, __off_t);
383 #ifndef _TRUNCATE_DECLARED
384 #define _TRUNCATE_DECLARED
385 int truncate(const char *, __off_t);
387 #endif /* __BSD_VISIBLE */
390 * Functions internal to the implementation.
393 int __swbuf(int, FILE *);
396 * The __sfoo macros are here so that we can
397 * define function versions in the C library.
399 #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++))
400 #if defined(__GNUC__) && defined(__STDC__)
401 static __inline int __sputc(int _c, FILE *_p) {
402 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n'))
403 return (*_p->_p++ = _c);
405 return (__swbuf(_c, _p));
409 * This has been tuned to generate reasonable code on the vax using pcc.
411 #define __sputc(c, p) \
413 (p)->_w >= (p)->_lbfsize ? \
414 (*(p)->_p = (c)), *(p)->_p != '\n' ? \
417 __swbuf((int)(c), p) : \
418 (*(p)->_p = (c), (int)*(p)->_p++))
421 #define __sfeof(p) (((p)->_flags & __SEOF) != 0)
422 #define __sferror(p) (((p)->_flags & __SERR) != 0)
423 #define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF)))
424 #define __sfileno(p) ((p)->_file)
426 extern int __isthreaded;
428 #define feof(p) (!__isthreaded ? __sfeof(p) : (feof)(p))
429 #define ferror(p) (!__isthreaded ? __sferror(p) : (ferror)(p))
430 #define clearerr(p) (!__isthreaded ? __sclearerr(p) : (clearerr)(p))
433 #define fileno(p) (!__isthreaded ? __sfileno(p) : (fileno)(p))
436 #define getc(fp) (!__isthreaded ? __sgetc(fp) : (getc)(fp))
437 #define putc(x, fp) (!__isthreaded ? __sputc(x, fp) : (putc)(x, fp))
439 #define getchar() getc(stdin)
440 #define putchar(x) putc(x, stdout)
444 * See ISO/IEC 9945-1 ANSI/IEEE Std 1003.1 Second Edition 1996-07-12
445 * B.8.2.7 for the rationale behind the *_unlocked() macros.
447 #define feof_unlocked(p) __sfeof(p)
448 #define ferror_unlocked(p) __sferror(p)
449 #define clearerr_unlocked(p) __sclearerr(p)
450 #define fileno_unlocked(p) __sfileno(p)
452 #if __POSIX_VISIBLE >= 199506
453 #define getc_unlocked(fp) __sgetc(fp)
454 #define putc_unlocked(x, fp) __sputc(x, fp)
456 #define getchar_unlocked() getc_unlocked(stdin)
457 #define putchar_unlocked(x) putc_unlocked(x, stdout)
461 #endif /* !_STDIO_H_ */