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 >= 200809
55 #ifndef _OFF_T_DECLARED
56 #define _OFF_T_DECLARED
57 typedef __off_t off_t;
59 #ifndef _SSIZE_T_DECLARED
60 #define _SSIZE_T_DECLARED
61 typedef __ssize_t ssize_t;
65 #if __BSD_VISIBLE || __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE
66 #ifndef _VA_LIST_DECLARED
67 typedef __va_list va_list;
68 #define _VA_LIST_DECLARED
72 #define _FSTDIO /* Define for new stdio with functions. */
75 * NB: to fit things in six character monocase externals, the stdio
76 * code uses the prefix `__s' for stdio objects, typically followed
77 * by a three-character attempt at a mnemonic.
87 * stdio state variables.
89 * The following always hold:
91 * if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR),
92 * _lbfsize is -_bf._size, else _lbfsize is 0
93 * if _flags&__SRD, _w is 0
94 * if _flags&__SWR, _r is 0
96 * This ensures that the getc and putc macros (or inline functions) never
97 * try to write or read from a file that is in `read' or `write' mode.
98 * (Moreover, they can, and do, automatically switch from read mode to
99 * write mode, and back, on "r+" and "w+" files.)
101 * _lbfsize is used only to make the inline line-buffered output stream
102 * code as compact as possible.
104 * _ub, _up, and _ur are used when ungetc() pushes back more characters
105 * than fit in the current _bf, or when ungetc() pushes back a character
106 * that does not match the previous one in _bf. When this happens,
107 * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff
108 * _ub._base!=NULL) and _up and _ur save the current values of _p and _r.
110 * Certain members of __sFILE are accessed directly via macros or
111 * inline functions. To preserve ABI compat, these members must not
112 * be disturbed. These members are marked below with (*).
114 typedef struct __sFILE {
115 unsigned char *_p; /* (*) current position in (some) buffer */
116 int _r; /* (*) read space left for getc() */
117 int _w; /* (*) write space left for putc() */
118 short _flags; /* (*) flags, below; this FILE is free if 0 */
119 short _file; /* (*) fileno, if Unix descriptor, else -1 */
120 struct __sbuf _bf; /* (*) the buffer (at least 1 byte, if !NULL) */
121 int _lbfsize; /* (*) 0 or -_bf._size, for inline putc */
124 void *_cookie; /* (*) cookie passed to io functions */
125 int (*_close)(void *);
126 int (*_read)(void *, char *, int);
127 fpos_t (*_seek)(void *, fpos_t, int);
128 int (*_write)(void *, const char *, int);
130 /* separate buffer for long sequences of ungetc() */
131 struct __sbuf _ub; /* ungetc buffer */
132 unsigned char *_up; /* saved _p when _p is doing ungetc data */
133 int _ur; /* saved _r when _r is counting ungetc data */
135 /* tricks to meet minimum requirements even when malloc() fails */
136 unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */
137 unsigned char _nbuf[1]; /* guarantee a getc() buffer */
139 /* separate buffer for fgetln() when line crosses buffer boundary */
140 struct __sbuf _lb; /* buffer for fgetln() */
142 /* Unix stdio files get aligned to block boundaries on fseek() */
143 int _blksize; /* stat.st_blksize (may be != _bf._size) */
144 fpos_t _offset; /* current lseek offset */
146 struct pthread_mutex *_fl_mutex; /* used for MT-safety */
147 struct pthread *_fl_owner; /* current owner */
148 int _fl_count; /* recursive lock count */
149 int _orientation; /* orientation for fwide() */
150 __mbstate_t _mbstate; /* multibyte conversion state */
153 #ifndef _STDSTREAM_DECLARED
155 extern FILE *__stdinp;
156 extern FILE *__stdoutp;
157 extern FILE *__stderrp;
159 #define _STDSTREAM_DECLARED
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 /* _buf 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 */
181 * The following three definitions are for ANSI C, which took them
182 * from System V, which brilliantly took internal interface macros and
183 * made them official arguments to setvbuf(), without renaming them.
184 * Hence, these ugly _IOxxx names are *supposed* to appear in user code.
186 * Although numbered as their counterparts above, the implementation
187 * does not rely on this.
189 #define _IOFBF 0 /* setvbuf should set fully buffered */
190 #define _IOLBF 1 /* setvbuf should set line buffered */
191 #define _IONBF 2 /* setvbuf should set unbuffered */
193 #define BUFSIZ 1024 /* size of buffer used by setbuf */
197 * FOPEN_MAX is a minimum maximum, and is the number of streams that
198 * stdio can provide without attempting to allocate further resources
199 * (which could fail). Do not use this for anything.
201 /* must be == _POSIX_STREAM_MAX <limits.h> */
203 #define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */
205 #define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */
207 /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */
209 #define P_tmpdir "/var/tmp/"
211 #define L_tmpnam 1024 /* XXX must be == PATH_MAX */
212 #define TMP_MAX 308915776
215 #define SEEK_SET 0 /* set file offset to offset */
218 #define SEEK_CUR 1 /* set file offset to current plus offset */
221 #define SEEK_END 2 /* set file offset to EOF plus offset */
224 #define stdin __stdinp
225 #define stdout __stdoutp
226 #define stderr __stderrp
230 * Functions defined in ANSI C standard.
232 void clearerr(FILE *);
238 int fgetpos(FILE * __restrict, fpos_t * __restrict);
239 char *fgets(char * __restrict, int, FILE * __restrict);
240 FILE *fopen(const char * __restrict, const char * __restrict);
241 int fprintf(FILE * __restrict, const char * __restrict, ...);
242 int fputc(int, FILE *);
243 int fputs(const char * __restrict, FILE * __restrict);
244 size_t fread(void * __restrict, size_t, size_t, FILE * __restrict);
245 FILE *freopen(const char * __restrict, const char * __restrict, FILE * __restrict);
246 int fscanf(FILE * __restrict, const char * __restrict, ...);
247 int fseek(FILE *, long, int);
248 int fsetpos(FILE *, const fpos_t *);
250 size_t fwrite(const void * __restrict, size_t, size_t, FILE * __restrict);
254 void perror(const char *);
255 int printf(const char * __restrict, ...);
256 int putc(int, FILE *);
258 int puts(const char *);
259 int remove(const char *);
260 int rename(const char *, const char *);
262 int scanf(const char * __restrict, ...);
263 void setbuf(FILE * __restrict, char * __restrict);
264 int setvbuf(FILE * __restrict, char * __restrict, int, size_t);
265 int sprintf(char * __restrict, const char * __restrict, ...);
266 int sscanf(const char * __restrict, const char * __restrict, ...);
268 char *tmpnam(char *);
269 int ungetc(int, FILE *);
270 int vfprintf(FILE * __restrict, const char * __restrict,
272 int vprintf(const char * __restrict, __va_list);
273 int vsprintf(char * __restrict, const char * __restrict,
276 #if __ISO_C_VISIBLE >= 1999
277 int snprintf(char * __restrict, size_t, const char * __restrict,
278 ...) __printflike(3, 4);
279 int vfscanf(FILE * __restrict, const char * __restrict, __va_list)
281 int vscanf(const char * __restrict, __va_list) __scanflike(1, 0);
282 int vsnprintf(char * __restrict, size_t, const char * __restrict,
283 __va_list) __printflike(3, 0);
284 int vsscanf(const char * __restrict, const char * __restrict, __va_list)
289 * Functions defined in all versions of POSIX 1003.1.
291 #if __BSD_VISIBLE || __POSIX_VISIBLE <= 199506
292 /* size for cuserid(3); UT_NAMESIZE + 1, see <utmp.h> */
293 #define L_cuserid 17 /* legacy */
297 #define L_ctermid 1024 /* size for ctermid(3); PATH_MAX */
299 char *ctermid(char *);
300 FILE *fdopen(int, const char *);
302 #endif /* __POSIX_VISIBLE */
304 #if __POSIX_VISIBLE >= 199209
306 FILE *popen(const char *, const char *);
309 #if __POSIX_VISIBLE >= 199506
310 int ftrylockfile(FILE *);
311 void flockfile(FILE *);
312 void funlockfile(FILE *);
315 * These are normally used through macros as defined below, but POSIX
316 * requires functions as well.
318 int getc_unlocked(FILE *);
319 int getchar_unlocked(void);
320 int putc_unlocked(int, FILE *);
321 int putchar_unlocked(int);
324 void clearerr_unlocked(FILE *);
325 int feof_unlocked(FILE *);
326 int ferror_unlocked(FILE *);
327 int fileno_unlocked(FILE *);
330 #if __POSIX_VISIBLE >= 200112
331 int fseeko(FILE *, __off_t, int);
332 __off_t ftello(FILE *);
335 #if __BSD_VISIBLE || __XSI_VISIBLE > 0 && __XSI_VISIBLE < 600
337 int putw(int, FILE *);
338 #endif /* BSD or X/Open before issue 6 */
341 char *tempnam(const char *, const char *);
344 #if __BSD_VISIBLE || __POSIX_VISIBLE >= 200809
345 ssize_t getdelim(char ** __restrict, size_t * __restrict, int,
347 int renameat(int, const char *, int, const char *);
348 int vdprintf(int, const char * __restrict, __va_list);
351 * Every programmer and his dog wrote functions called getline() and dprintf()
352 * before POSIX.1-2008 came along and decided to usurp the names, so we
353 * don't prototype them by default unless one of the following is true:
354 * a) the app has requested them specifically by defining _WITH_GETLINE or
355 * _WITH_DPRINTF, respectively
356 * b) the app has requested a POSIX.1-2008 environment via _POSIX_C_SOURCE
357 * c) the app defines a GNUism such as _BSD_SOURCE or _GNU_SOURCE
359 #ifndef _WITH_GETLINE
360 #if defined(_BSD_SOURCE) || defined(_GNU_SOURCE)
361 #define _WITH_GETLINE
362 #elif defined(_POSIX_C_SOURCE)
363 #if _POSIX_C_SOURCE >= 200809
364 #define _WITH_GETLINE
370 ssize_t getline(char ** __restrict, size_t * __restrict, FILE * __restrict);
373 #ifndef _WITH_DPRINTF
374 #if defined(_BSD_SOURCE) || defined(_GNU_SOURCE)
375 #define _WITH_DPRINTF
376 #elif defined(_POSIX_C_SOURCE)
377 #if _POSIX_C_SOURCE >= 200809
378 #define _WITH_DPRINTF
384 int (dprintf)(int, const char * __restrict, ...);
387 #endif /* __BSD_VISIBLE || __POSIX_VISIBLE >= 200809 */
390 * Routines that are purely local.
393 int asprintf(char **, const char *, ...) __printflike(2, 3);
394 char *ctermid_r(char *);
395 void fcloseall(void);
396 char *fgetln(FILE *, size_t *);
397 const char *fmtcheck(const char *, const char *) __format_arg(2);
399 void setbuffer(FILE *, char *, int);
400 int setlinebuf(FILE *);
401 int vasprintf(char **, const char *, __va_list)
405 * The system error table contains messages for the first sys_nerr
406 * positive errno values. Use strerror() or strerror_r() from <string.h>
409 extern __const int sys_nerr;
410 extern __const char *__const sys_errlist[];
413 * Stdio function-access interface.
415 FILE *funopen(const void *,
416 int (*)(void *, char *, int),
417 int (*)(void *, const char *, int),
418 fpos_t (*)(void *, fpos_t, int),
420 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
421 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
424 * Portability hacks. See <sys/types.h>.
426 #ifndef _FTRUNCATE_DECLARED
427 #define _FTRUNCATE_DECLARED
428 int ftruncate(int, __off_t);
430 #ifndef _LSEEK_DECLARED
431 #define _LSEEK_DECLARED
432 __off_t lseek(int, __off_t, int);
434 #ifndef _MMAP_DECLARED
435 #define _MMAP_DECLARED
436 void *mmap(void *, size_t, int, int, int, __off_t);
438 #ifndef _TRUNCATE_DECLARED
439 #define _TRUNCATE_DECLARED
440 int truncate(const char *, __off_t);
442 #endif /* __BSD_VISIBLE */
445 * Functions internal to the implementation.
448 int __swbuf(int, FILE *);
451 * The __sfoo macros are here so that we can
452 * define function versions in the C library.
454 #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++))
455 #if defined(__GNUC__) && defined(__STDC__)
456 static __inline int __sputc(int _c, FILE *_p) {
457 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n'))
458 return (*_p->_p++ = _c);
460 return (__swbuf(_c, _p));
464 * This has been tuned to generate reasonable code on the vax using pcc.
466 #define __sputc(c, p) \
468 (p)->_w >= (p)->_lbfsize ? \
469 (*(p)->_p = (c)), *(p)->_p != '\n' ? \
472 __swbuf((int)(c), p) : \
473 (*(p)->_p = (c), (int)*(p)->_p++))
476 #define __sfeof(p) (((p)->_flags & __SEOF) != 0)
477 #define __sferror(p) (((p)->_flags & __SERR) != 0)
478 #define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF)))
479 #define __sfileno(p) ((p)->_file)
481 extern int __isthreaded;
483 #define feof(p) (!__isthreaded ? __sfeof(p) : (feof)(p))
484 #define ferror(p) (!__isthreaded ? __sferror(p) : (ferror)(p))
485 #define clearerr(p) (!__isthreaded ? __sclearerr(p) : (clearerr)(p))
488 #define fileno(p) (!__isthreaded ? __sfileno(p) : (fileno)(p))
491 #define getc(fp) (!__isthreaded ? __sgetc(fp) : (getc)(fp))
492 #define putc(x, fp) (!__isthreaded ? __sputc(x, fp) : (putc)(x, fp))
494 #define getchar() getc(stdin)
495 #define putchar(x) putc(x, stdout)
499 * See ISO/IEC 9945-1 ANSI/IEEE Std 1003.1 Second Edition 1996-07-12
500 * B.8.2.7 for the rationale behind the *_unlocked() macros.
502 #define feof_unlocked(p) __sfeof(p)
503 #define ferror_unlocked(p) __sferror(p)
504 #define clearerr_unlocked(p) __sclearerr(p)
505 #define fileno_unlocked(p) __sfileno(p)
507 #if __POSIX_VISIBLE >= 199506
508 #define getc_unlocked(fp) __sgetc(fp)
509 #define putc_unlocked(x, fp) __sputc(x, fp)
511 #define getchar_unlocked() getc_unlocked(stdin)
512 #define putchar_unlocked(x) putc_unlocked(x, stdout)
516 #endif /* !_STDIO_H_ */