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
43 typedef __off_t fpos_t;
44
45 #ifndef _SIZE_T_DECLARED
46 typedef __size_t size_t;
47 #define _SIZE_T_DECLARED
48 #endif
49
50 #if __BSD_VISIBLE || __POSIX_VISIBLE >= 200809
51 #ifndef _OFF_T_DECLARED
52 #define _OFF_T_DECLARED
53 typedef __off_t off_t;
54 #endif
55 #ifndef _SSIZE_T_DECLARED
56 #define _SSIZE_T_DECLARED
57 typedef __ssize_t ssize_t;
58 #endif
59 #endif
60
61 #if __BSD_VISIBLE || __POSIX_VISIBLE >= 200112 || __XSI_VISIBLE
62 #ifndef _VA_LIST_DECLARED
63 typedef __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 */
77 struct __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 */
110 struct __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 };
148 #ifndef _STDFILE_DECLARED
149 #define _STDFILE_DECLARED
150 typedef struct __sFILE FILE;
151 #endif
152 #ifndef _STDSTREAM_DECLARED
153 __BEGIN_DECLS
154 extern FILE *__stdinp;
155 extern FILE *__stdoutp;
156 extern FILE *__stderrp;
157 __END_DECLS
158 #define _STDSTREAM_DECLARED
159 #endif
160
161 #define __SLBF 0x0001 /* line buffered */
162 #define __SNBF 0x0002 /* unbuffered */
163 #define __SRD 0x0004 /* OK to read */
164 #define __SWR 0x0008 /* OK to write */
165 /* RD and WR are never simultaneously asserted */
166 #define __SRW 0x0010 /* open for reading & writing */
167 #define __SEOF 0x0020 /* found EOF */
168 #define __SERR 0x0040 /* found error */
169 #define __SMBF 0x0080 /* _bf._base is from malloc */
170 #define __SAPP 0x0100 /* fdopen()ed in append mode */
171 #define __SSTR 0x0200 /* this is an sprintf/snprintf string */
172 #define __SOPT 0x0400 /* do fseek() optimization */
173 #define __SNPT 0x0800 /* do not do fseek() optimization */
174 #define __SOFF 0x1000 /* set iff _offset is in fact correct */
175 #define __SMOD 0x2000 /* true => fgetln modified _p text */
176 #define __SALC 0x4000 /* allocate string space dynamically */
177 #define __SIGN 0x8000 /* ignore this file in _fwalk */
178
179 /*
180 * The following three definitions are for ANSI C, which took them
181 * from System V, which brilliantly took internal interface macros and
182 * made them official arguments to setvbuf(), without renaming them.
183 * Hence, these ugly _IOxxx names are *supposed* to appear in user code.
184 *
185 * Although numbered as their counterparts above, the implementation
186 * does not rely on this.
187 */
188 #define _IOFBF 0 /* setvbuf should set fully buffered */
189 #define _IOLBF 1 /* setvbuf should set line buffered */
190 #define _IONBF 2 /* setvbuf should set unbuffered */
191
192 #define BUFSIZ 1024 /* size of buffer used by setbuf */
193 #define EOF (-1)
194
195 /*
196 * FOPEN_MAX is a minimum maximum, and is the number of streams that
197 * stdio can provide without attempting to allocate further resources
198 * (which could fail). Do not use this for anything.
199 */
200 /* must be == _POSIX_STREAM_MAX <limits.h> */
201 #ifndef FOPEN_MAX
202 #define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */
203 #endif
204 #define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */
205
206 /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */
207 #if __XSI_VISIBLE
208 #define P_tmpdir "/tmp/"
209 #endif
210 #define L_tmpnam 1024 /* XXX must be == PATH_MAX */
211 #define TMP_MAX 308915776
212
213 #ifndef SEEK_SET
214 #define SEEK_SET 0 /* set file offset to offset */
215 #endif
216 #ifndef SEEK_CUR
217 #define SEEK_CUR 1 /* set file offset to current plus offset */
218 #endif
219 #ifndef SEEK_END
220 #define SEEK_END 2 /* set file offset to EOF plus offset */
221 #endif
222
223 #define stdin __stdinp
224 #define stdout __stdoutp
225 #define stderr __stderrp
226
227 __BEGIN_DECLS
228 #ifdef _XLOCALE_H_
229 #include <xlocale/_stdio.h>
230 #endif
231 /*
232 * Functions defined in ANSI C standard.
233 */
234 void clearerr(FILE *);
235 int fclose(FILE *);
236 int feof(FILE *);
237 int ferror(FILE *);
238 int fflush(FILE *);
239 int fgetc(FILE *);
240 int fgetpos(FILE * __restrict, fpos_t * __restrict);
241 char *fgets(char * __restrict, int, FILE * __restrict);
242 FILE *fopen(const char * __restrict, const char * __restrict);
243 int fprintf(FILE * __restrict, const char * __restrict, ...);
244 int fputc(int, FILE *);
245 int fputs(const char * __restrict, FILE * __restrict);
246 size_t fread(void * __restrict, size_t, size_t, FILE * __restrict);
247 FILE *freopen(const char * __restrict, const char * __restrict, FILE * __restrict);
248 int fscanf(FILE * __restrict, const char * __restrict, ...);
249 int fseek(FILE *, long, int);
250 int fsetpos(FILE *, const fpos_t *);
251 long ftell(FILE *);
252 size_t fwrite(const void * __restrict, size_t, size_t, FILE * __restrict);
253 int getc(FILE *);
254 int getchar(void);
255 char *gets(char *);
256 void perror(const char *);
257 int printf(const char * __restrict, ...);
258 int putc(int, FILE *);
259 int putchar(int);
260 int puts(const char *);
261 int remove(const char *);
262 int rename(const char *, const char *);
263 void rewind(FILE *);
264 int scanf(const char * __restrict, ...);
265 void setbuf(FILE * __restrict, char * __restrict);
266 int setvbuf(FILE * __restrict, char * __restrict, int, size_t);
267 int sprintf(char * __restrict, const char * __restrict, ...);
268 int sscanf(const char * __restrict, const char * __restrict, ...);
269 FILE *tmpfile(void);
270 char *tmpnam(char *);
271 int ungetc(int, FILE *);
272 int vfprintf(FILE * __restrict, const char * __restrict,
273 __va_list);
274 int vprintf(const char * __restrict, __va_list);
275 int vsprintf(char * __restrict, const char * __restrict,
276 __va_list);
277
278 #if __ISO_C_VISIBLE >= 1999
279 int snprintf(char * __restrict, size_t, const char * __restrict,
280 ...) __printflike(3, 4);
281 int vfscanf(FILE * __restrict, const char * __restrict, __va_list)
282 __scanflike(2, 0);
283 int vscanf(const char * __restrict, __va_list) __scanflike(1, 0);
284 int vsnprintf(char * __restrict, size_t, const char * __restrict,
285 __va_list) __printflike(3, 0);
286 int vsscanf(const char * __restrict, const char * __restrict, __va_list)
287 __scanflike(2, 0);
288 #endif
289
290 /*
291 * Functions defined in all versions of POSIX 1003.1.
292 */
293 #if __BSD_VISIBLE || __POSIX_VISIBLE <= 199506
294 #define L_cuserid 17 /* size for cuserid(3); MAXLOGNAME, legacy */
295 #endif
296
297 #if __POSIX_VISIBLE
298 #define L_ctermid 1024 /* size for ctermid(3); PATH_MAX */
299
300 char *ctermid(char *);
301 FILE *fdopen(int, const char *);
302 int fileno(FILE *);
303 #endif /* __POSIX_VISIBLE */
304
305 #if __POSIX_VISIBLE >= 199209
306 int pclose(FILE *);
307 FILE *popen(const char *, const char *);
308 #endif
309
310 #if __POSIX_VISIBLE >= 199506
311 int ftrylockfile(FILE *);
312 void flockfile(FILE *);
313 void funlockfile(FILE *);
314
315 /*
316 * These are normally used through macros as defined below, but POSIX
317 * requires functions as well.
318 */
319 int getc_unlocked(FILE *);
320 int getchar_unlocked(void);
321 int putc_unlocked(int, FILE *);
322 int putchar_unlocked(int);
323 #endif
324 #if __BSD_VISIBLE
325 void clearerr_unlocked(FILE *);
326 int feof_unlocked(FILE *);
327 int ferror_unlocked(FILE *);
328 int fileno_unlocked(FILE *);
329 #endif
330
331 #if __POSIX_VISIBLE >= 200112
332 int fseeko(FILE *, __off_t, int);
333 __off_t ftello(FILE *);
334 #endif
335
336 #if __BSD_VISIBLE || __XSI_VISIBLE > 0 && __XSI_VISIBLE < 600
337 int getw(FILE *);
338 int putw(int, FILE *);
339 #endif /* BSD or X/Open before issue 6 */
340
341 #if __XSI_VISIBLE
342 char *tempnam(const char *, const char *);
343 #endif
344
345 #if __BSD_VISIBLE || __POSIX_VISIBLE >= 200809
346 FILE *fmemopen(void * __restrict, size_t, const char * __restrict);
347 ssize_t getdelim(char ** __restrict, size_t * __restrict, int,
348 FILE * __restrict);
349 FILE *open_memstream(char **, size_t *);
350 int renameat(int, const char *, int, const char *);
351 int vdprintf(int, const char * __restrict, __va_list);
352
353 /*
354 * Every programmer and his dog wrote functions called getline() and dprintf()
355 * before POSIX.1-2008 came along and decided to usurp the names, so we
356 * don't prototype them by default unless one of the following is true:
357 * a) the app has requested them specifically by defining _WITH_GETLINE or
358 * _WITH_DPRINTF, respectively
359 * b) the app has requested a POSIX.1-2008 environment via _POSIX_C_SOURCE
360 * c) the app defines a GNUism such as _BSD_SOURCE or _GNU_SOURCE
361 */
362 #ifndef _WITH_GETLINE
363 #if defined(_BSD_SOURCE) || defined(_GNU_SOURCE)
364 #define _WITH_GETLINE
365 #elif defined(_POSIX_C_SOURCE)
366 #if _POSIX_C_SOURCE >= 200809
367 #define _WITH_GETLINE
368 #endif
369 #endif
370 #endif
371
372 #ifdef _WITH_GETLINE
373 ssize_t getline(char ** __restrict, size_t * __restrict, FILE * __restrict);
374 #endif
375
376 #ifndef _WITH_DPRINTF
377 #if defined(_BSD_SOURCE) || defined(_GNU_SOURCE)
378 #define _WITH_DPRINTF
379 #elif defined(_POSIX_C_SOURCE)
380 #if _POSIX_C_SOURCE >= 200809
381 #define _WITH_DPRINTF
382 #endif
383 #endif
384 #endif
385
386 #ifdef _WITH_DPRINTF
387 int (dprintf)(int, const char * __restrict, ...);
388 #endif
389
390 #endif /* __BSD_VISIBLE || __POSIX_VISIBLE >= 200809 */
391
392 /*
393 * Routines that are purely local.
394 */
395 #if __BSD_VISIBLE
396 int asprintf(char **, const char *, ...) __printflike(2, 3);
397 char *ctermid_r(char *);
398 void fcloseall(void);
399 char *fgetln(FILE *, size_t *);
400 const char *fmtcheck(const char *, const char *) __format_arg(2);
401 int fpurge(FILE *);
402 void setbuffer(FILE *, char *, int);
403 int setlinebuf(FILE *);
404 int vasprintf(char **, const char *, __va_list)
405 __printflike(2, 0);
406
407 /*
408 * The system error table contains messages for the first sys_nerr
409 * positive errno values. Use strerror() or strerror_r() from <string.h>
410 * instead.
411 */
412 extern const int sys_nerr;
413 extern const char * const sys_errlist[];
414
415 /*
416 * Stdio function-access interface.
417 */
418 FILE *funopen(const void *,
419 int (*)(void *, char *, int),
420 int (*)(void *, const char *, int),
421 fpos_t (*)(void *, fpos_t, int),
422 int (*)(void *));
423 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
424 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
425
426 /*
427 * Portability hacks. See <sys/types.h>.
428 */
429 #ifndef _FTRUNCATE_DECLARED
430 #define _FTRUNCATE_DECLARED
431 int ftruncate(int, __off_t);
432 #endif
433 #ifndef _LSEEK_DECLARED
434 #define _LSEEK_DECLARED
435 __off_t lseek(int, __off_t, int);
436 #endif
437 #ifndef _MMAP_DECLARED
438 #define _MMAP_DECLARED
439 void *mmap(void *, size_t, int, int, int, __off_t);
440 #endif
441 #ifndef _TRUNCATE_DECLARED
442 #define _TRUNCATE_DECLARED
443 int truncate(const char *, __off_t);
444 #endif
445 #endif /* __BSD_VISIBLE */
446
447 /*
448 * Functions internal to the implementation.
449 */
450 int __srget(FILE *);
451 int __swbuf(int, FILE *);
452
453 /*
454 * The __sfoo macros are here so that we can
455 * define function versions in the C library.
456 */
457 #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++))
458 #if defined(__GNUC__) && defined(__STDC__)
__sputc(int _c,FILE * _p)459 static __inline int __sputc(int _c, FILE *_p) {
460 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n'))
461 return (*_p->_p++ = _c);
462 else
463 return (__swbuf(_c, _p));
464 }
465 #else
466 /*
467 * This has been tuned to generate reasonable code on the vax using pcc.
468 */
469 #define __sputc(c, p) \
470 (--(p)->_w < 0 ? \
471 (p)->_w >= (p)->_lbfsize ? \
472 (*(p)->_p = (c)), *(p)->_p != '\n' ? \
473 (int)*(p)->_p++ : \
474 __swbuf('\n', p) : \
475 __swbuf((int)(c), p) : \
476 (*(p)->_p = (c), (int)*(p)->_p++))
477 #endif
478
479 extern int __isthreaded;
480
481 #ifndef __cplusplus
482
483 #define __sfeof(p) (((p)->_flags & __SEOF) != 0)
484 #define __sferror(p) (((p)->_flags & __SERR) != 0)
485 #define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF)))
486 #define __sfileno(p) ((p)->_file)
487
488
489 #define feof(p) (!__isthreaded ? __sfeof(p) : (feof)(p))
490 #define ferror(p) (!__isthreaded ? __sferror(p) : (ferror)(p))
491 #define clearerr(p) (!__isthreaded ? __sclearerr(p) : (clearerr)(p))
492
493 #if __POSIX_VISIBLE
494 #define fileno(p) (!__isthreaded ? __sfileno(p) : (fileno)(p))
495 #endif
496
497 #define getc(fp) (!__isthreaded ? __sgetc(fp) : (getc)(fp))
498 #define putc(x, fp) (!__isthreaded ? __sputc(x, fp) : (putc)(x, fp))
499
500 #define getchar() getc(stdin)
501 #define putchar(x) putc(x, stdout)
502
503 #if __BSD_VISIBLE
504 /*
505 * See ISO/IEC 9945-1 ANSI/IEEE Std 1003.1 Second Edition 1996-07-12
506 * B.8.2.7 for the rationale behind the *_unlocked() macros.
507 */
508 #define feof_unlocked(p) __sfeof(p)
509 #define ferror_unlocked(p) __sferror(p)
510 #define clearerr_unlocked(p) __sclearerr(p)
511 #define fileno_unlocked(p) __sfileno(p)
512 #endif
513 #if __POSIX_VISIBLE >= 199506
514 #define getc_unlocked(fp) __sgetc(fp)
515 #define putc_unlocked(x, fp) __sputc(x, fp)
516
517 #define getchar_unlocked() getc_unlocked(stdin)
518 #define putchar_unlocked(x) putc_unlocked(x, stdout)
519 #endif
520 #endif /* __cplusplus */
521
522 __END_DECLS
523 #endif /* !_STDIO_H_ */
524