1 /* $OpenBSD: stdio.h,v 1.35 2006/01/13 18:10:09 miod Exp $ */
2 /* $NetBSD: stdio.h,v 1.18 1996/04/25 18:29:21 jtc Exp $ */
3
4 /*-
5 * Copyright (c) 1990 The Regents of the University of California.
6 * All rights reserved.
7 *
8 * This code is derived from software contributed to Berkeley by
9 * Chris Torek.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. Neither the name of the University nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * SUCH DAMAGE.
34 *
35 * @(#)stdio.h 5.17 (Berkeley) 6/3/91
36 */
37
38 #ifndef _STDIO_H_
39 #define _STDIO_H_
40
41 #include <sys/cdefs.h>
42 #include <sys/types.h>
43
44 #include <stdarg.h>
45 #include <stddef.h>
46
47 #define __need_NULL
48 #include <stddef.h>
49
50 #define _FSTDIO /* Define for new stdio with functions. */
51
52 typedef off_t fpos_t; /* stdio file position type */
53
54 /*
55 * NB: to fit things in six character monocase externals, the stdio
56 * code uses the prefix `__s' for stdio objects, typically followed
57 * by a three-character attempt at a mnemonic.
58 */
59
60 /* stdio buffers */
61 struct __sbuf {
62 unsigned char *_base;
63 int _size;
64 };
65
66 /*
67 * stdio state variables.
68 *
69 * The following always hold:
70 *
71 * if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR),
72 * _lbfsize is -_bf._size, else _lbfsize is 0
73 * if _flags&__SRD, _w is 0
74 * if _flags&__SWR, _r is 0
75 *
76 * This ensures that the getc and putc macros (or inline functions) never
77 * try to write or read from a file that is in `read' or `write' mode.
78 * (Moreover, they can, and do, automatically switch from read mode to
79 * write mode, and back, on "r+" and "w+" files.)
80 *
81 * _lbfsize is used only to make the inline line-buffered output stream
82 * code as compact as possible.
83 *
84 * _ub, _up, and _ur are used when ungetc() pushes back more characters
85 * than fit in the current _bf, or when ungetc() pushes back a character
86 * that does not match the previous one in _bf. When this happens,
87 * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff
88 * _ub._base!=NULL) and _up and _ur save the current values of _p and _r.
89 *
90 * NOTE: if you change this structure, you also need to update the
91 * std() initializer in findfp.c.
92 */
93 typedef struct __sFILE {
94 unsigned char *_p; /* current position in (some) buffer */
95 int _r; /* read space left for getc() */
96 int _w; /* write space left for putc() */
97 short _flags; /* flags, below; this FILE is free if 0 */
98 short _file; /* fileno, if Unix descriptor, else -1 */
99 struct __sbuf _bf; /* the buffer (at least 1 byte, if !NULL) */
100 int _lbfsize; /* 0 or -_bf._size, for inline putc */
101
102 /* operations */
103 void *_cookie; /* cookie passed to io functions */
104 int (*_close)(void *);
105 int (*_read)(void *, char *, int);
106 fpos_t (*_seek)(void *, fpos_t, int);
107 int (*_write)(void *, const char *, int);
108
109 /* extension data, to avoid further ABI breakage */
110 struct __sbuf _ext;
111 /* data for long sequences of ungetc() */
112 unsigned char *_up; /* saved _p when _p is doing ungetc data */
113 int _ur; /* saved _r when _r is counting ungetc data */
114
115 /* tricks to meet minimum requirements even when malloc() fails */
116 unsigned char _ubuf[3]; /* guarantee an ungetc() buffer */
117 unsigned char _nbuf[1]; /* guarantee a getc() buffer */
118
119 /* separate buffer for fgetln() when line crosses buffer boundary */
120 struct __sbuf _lb; /* buffer for fgetln() */
121
122 /* Unix stdio files get aligned to block boundaries on fseek() */
123 int _blksize; /* stat.st_blksize (may be != _bf._size) */
124 fpos_t _offset; /* current lseek offset */
125 } FILE;
126
127 __BEGIN_DECLS
128 extern FILE __sF[];
129 __END_DECLS
130
131 #define __SLBF 0x0001 /* line buffered */
132 #define __SNBF 0x0002 /* unbuffered */
133 #define __SRD 0x0004 /* OK to read */
134 #define __SWR 0x0008 /* OK to write */
135 /* RD and WR are never simultaneously asserted */
136 #define __SRW 0x0010 /* open for reading & writing */
137 #define __SEOF 0x0020 /* found EOF */
138 #define __SERR 0x0040 /* found error */
139 #define __SMBF 0x0080 /* _buf is from malloc */
140 #define __SAPP 0x0100 /* fdopen()ed in append mode */
141 #define __SSTR 0x0200 /* this is an sprintf/snprintf string */
142 #define __SOPT 0x0400 /* do fseek() optimization */
143 #define __SNPT 0x0800 /* do not do fseek() optimization */
144 #define __SOFF 0x1000 /* set iff _offset is in fact correct */
145 #define __SMOD 0x2000 /* true => fgetln modified _p text */
146 #define __SALC 0x4000 /* allocate string space dynamically */
147 #define __SIGN 0x8000 /* ignore this file in _fwalk */
148
149 /*
150 * The following three definitions are for ANSI C, which took them
151 * from System V, which brilliantly took internal interface macros and
152 * made them official arguments to setvbuf(), without renaming them.
153 * Hence, these ugly _IOxxx names are *supposed* to appear in user code.
154 *
155 * Although numbered as their counterparts above, the implementation
156 * does not rely on this.
157 */
158 #define _IOFBF 0 /* setvbuf should set fully buffered */
159 #define _IOLBF 1 /* setvbuf should set line buffered */
160 #define _IONBF 2 /* setvbuf should set unbuffered */
161
162 #define BUFSIZ 1024 /* size of buffer used by setbuf */
163 #define EOF (-1)
164
165 /*
166 * FOPEN_MAX is a minimum maximum, and is the number of streams that
167 * stdio can provide without attempting to allocate further resources
168 * (which could fail). Do not use this for anything.
169 */
170
171 #define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */
172 #define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */
173
174 /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */
175 #if __BSD_VISIBLE || __XPG_VISIBLE
176 #define P_tmpdir "/tmp/"
177 #endif
178 #define L_tmpnam 1024 /* XXX must be == PATH_MAX */
179 #define TMP_MAX 308915776
180
181 /* Always ensure that these are consistent with <fcntl.h> and <unistd.h>! */
182 #ifndef SEEK_SET
183 #define SEEK_SET 0 /* set file offset to offset */
184 #endif
185 #ifndef SEEK_CUR
186 #define SEEK_CUR 1 /* set file offset to current plus offset */
187 #endif
188 #ifndef SEEK_END
189 #define SEEK_END 2 /* set file offset to EOF plus offset */
190 #endif
191
192 #define stdin (&__sF[0])
193 #define stdout (&__sF[1])
194 #define stderr (&__sF[2])
195
196 /*
197 * Functions defined in ANSI C standard.
198 */
199 __BEGIN_DECLS
200 void clearerr(FILE *);
201 int fclose(FILE *);
202 int feof(FILE *);
203 int ferror(FILE *);
204 int fflush(FILE *);
205 int fgetc(FILE *);
206 char *fgets(char * __restrict, int, FILE * __restrict);
207 FILE *fopen(const char * __restrict , const char * __restrict);
208 int fprintf(FILE * __restrict , const char * __restrict, ...)
209 __printflike(2, 3);
210 int fputc(int, FILE *);
211 int fputs(const char * __restrict, FILE * __restrict);
212 size_t fread(void * __restrict, size_t, size_t, FILE * __restrict);
213 FILE *freopen(const char * __restrict, const char * __restrict,
214 FILE * __restrict);
215 int fscanf(FILE * __restrict, const char * __restrict, ...)
216 __scanflike(2, 3);
217 int fseek(FILE *, long, int);
218 long ftell(FILE *);
219 size_t fwrite(const void * __restrict, size_t, size_t, FILE * __restrict);
220 int getc(FILE *);
221 int getchar(void);
222 ssize_t getdelim(char ** __restrict, size_t * __restrict, int,
223 FILE * __restrict);
224 ssize_t getline(char ** __restrict, size_t * __restrict, FILE * __restrict);
225 char *gets(char *);
226 #if __BSD_VISIBLE && !defined(__SYS_ERRLIST)
227 #define __SYS_ERRLIST
228
229 extern int sys_nerr; /* perror(3) external variables */
230 extern char *sys_errlist[];
231 #endif
232 void perror(const char *);
233 int printf(const char * __restrict, ...)
234 __printflike(1, 2);
235 int putc(int, FILE *);
236 int putchar(int);
237 int puts(const char *);
238 int remove(const char *);
239 void rewind(FILE *);
240 int scanf(const char * __restrict, ...)
241 __scanflike(1, 2);
242 void setbuf(FILE * __restrict, char * __restrict);
243 int setvbuf(FILE * __restrict, char * __restrict, int, size_t);
244 int sscanf(const char * __restrict, const char * __restrict, ...)
245 __scanflike(2, 3);
246 FILE *tmpfile(void);
247 int ungetc(int, FILE *);
248 int vfprintf(FILE * __restrict, const char * __restrict, __va_list)
249 __printflike(2, 0);
250 int vprintf(const char * __restrict, __va_list)
251 __printflike(1, 0);
252
253 #ifndef __AUDIT__
254 char *gets(char *);
255 int sprintf(char * __restrict, const char * __restrict, ...)
256 __printflike(2, 3);
257 char *tmpnam(char *);
258 int vsprintf(char * __restrict, const char * __restrict,
259 __va_list)
260 __printflike(2, 0);
261 #endif
262
263 int rename (const char *, const char *);
264
265 int fgetpos(FILE * __restrict, fpos_t * __restrict);
266 int fsetpos(FILE *, const fpos_t *);
267
268 int fseeko(FILE *, off_t, int);
269 off_t ftello(FILE *);
270
271 #if __ISO_C_VISIBLE >= 1999 || __BSD_VISIBLE
272 int snprintf(char * __restrict, size_t, const char * __restrict, ...)
273 __printflike(3, 4);
274 int vfscanf(FILE * __restrict, const char * __restrict, __va_list)
275 __scanflike(2, 0);
276 int vscanf(const char *, __va_list)
277 __scanflike(1, 0);
278 int vsnprintf(char * __restrict, size_t, const char * __restrict, __va_list)
279 __printflike(3, 0);
280 int vsscanf(const char * __restrict, const char * __restrict, __va_list)
281 __scanflike(2, 0);
282 #endif /* __ISO_C_VISIBLE >= 1999 || __BSD_VISIBLE */
283
284 __END_DECLS
285
286
287 /*
288 * Functions defined in POSIX 1003.1.
289 */
290 #if __BSD_VISIBLE || __POSIX_VISIBLE || __XPG_VISIBLE
291 #define L_ctermid 1024 /* size for ctermid(); PATH_MAX */
292 #define L_cuserid 9 /* size for cuserid(); UT_NAMESIZE + 1 */
293
294 __BEGIN_DECLS
295 #if 0 /* MISSING FROM BIONIC */
296 char *ctermid(char *);
297 char *cuserid(char *);
298 #endif /* MISSING */
299 FILE *fdopen(int, const char *);
300 int fileno(FILE *);
301
302 #if (__POSIX_VISIBLE >= 199209)
303 int pclose(FILE *);
304 FILE *popen(const char *, const char *);
305 #endif
306
307 #if __POSIX_VISIBLE >= 199506
308 void flockfile(FILE *);
309 int ftrylockfile(FILE *);
310 void funlockfile(FILE *);
311
312 /*
313 * These are normally used through macros as defined below, but POSIX
314 * requires functions as well.
315 */
316 int getc_unlocked(FILE *);
317 int getchar_unlocked(void);
318 int putc_unlocked(int, FILE *);
319 int putchar_unlocked(int);
320 #endif /* __POSIX_VISIBLE >= 199506 */
321
322 #if __XPG_VISIBLE
323 char *tempnam(const char *, const char *);
324 #endif
325 __END_DECLS
326
327 #endif /* __BSD_VISIBLE || __POSIX_VISIBLE || __XPG_VISIBLE */
328
329 /*
330 * Routines that are purely local.
331 */
332 #if __BSD_VISIBLE
333 __BEGIN_DECLS
334 int asprintf(char ** __restrict, const char * __restrict, ...)
335 __printflike(2, 3);
336 char *fgetln(FILE * __restrict, size_t * __restrict);
337 int fpurge(FILE *);
338 int getw(FILE *);
339 int putw(int, FILE *);
340 void setbuffer(FILE *, char *, int);
341 int setlinebuf(FILE *);
342 int vasprintf(char ** __restrict, const char * __restrict,
343 __va_list)
344 __printflike(2, 0);
345 __END_DECLS
346
347 /*
348 * Stdio function-access interface.
349 */
350 __BEGIN_DECLS
351 FILE *funopen(const void *,
352 int (*)(void *, char *, int),
353 int (*)(void *, const char *, int),
354 fpos_t (*)(void *, fpos_t, int),
355 int (*)(void *));
356 __END_DECLS
357 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
358 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
359 #endif /* __BSD_VISIBLE */
360
361 /*
362 * Functions internal to the implementation.
363 */
364 __BEGIN_DECLS
365 int __srget(FILE *);
366 int __swbuf(int, FILE *);
367 __END_DECLS
368
369 /*
370 * The __sfoo macros are here so that we can
371 * define function versions in the C library.
372 */
373 #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++))
374 #if defined(__GNUC__)
__sputc(int _c,FILE * _p)375 static __inline int __sputc(int _c, FILE *_p) {
376 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n'))
377 return (*_p->_p++ = _c);
378 else
379 return (__swbuf(_c, _p));
380 }
381 #else
382 /*
383 * This has been tuned to generate reasonable code on the vax using pcc.
384 */
385 #define __sputc(c, p) \
386 (--(p)->_w < 0 ? \
387 (p)->_w >= (p)->_lbfsize ? \
388 (*(p)->_p = (c)), *(p)->_p != '\n' ? \
389 (int)*(p)->_p++ : \
390 __swbuf('\n', p) : \
391 __swbuf((int)(c), p) : \
392 (*(p)->_p = (c), (int)*(p)->_p++))
393 #endif
394
395 #define __sfeof(p) (((p)->_flags & __SEOF) != 0)
396 #define __sferror(p) (((p)->_flags & __SERR) != 0)
397 #define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF)))
398 #define __sfileno(p) ((p)->_file)
399
400 extern int __isthreaded;
401
402 #define feof(p) (!__isthreaded ? __sfeof(p) : (feof)(p))
403 #define ferror(p) (!__isthreaded ? __sferror(p) : (ferror)(p))
404 #define clearerr(p) (!__isthreaded ? __sclearerr(p) : (clearerr)(p))
405
406 #if __POSIX_VISIBLE
407 #define fileno(p) (!__isthreaded ? __sfileno(p) : (fileno)(p))
408 #endif
409
410 #define getc(fp) (!__isthreaded ? __sgetc(fp) : (getc)(fp))
411
412 #if __BSD_VISIBLE
413 /*
414 * The macro implementations of putc and putc_unlocked are not
415 * fully POSIX compliant; they do not set errno on failure
416 */
417 #define putc(x, fp) (!__isthreaded ? __sputc(x, fp) : (putc)(x, fp))
418 #endif /* __BSD_VISIBLE */
419
420 #ifndef lint
421 #if __POSIX_VISIBLE >= 199506
422 #define getc_unlocked(fp) __sgetc(fp)
423 /*
424 * The macro implementations of putc and putc_unlocked are not
425 * fully POSIX compliant; they do not set errno on failure
426 */
427 #if __BSD_VISIBLE
428 #define putc_unlocked(x, fp) __sputc(x, fp)
429 #endif /* __BSD_VISIBLE */
430 #endif /* __POSIX_VISIBLE >= 199506 */
431 #endif /* lint */
432
433 #define getchar() getc(stdin)
434 #define putchar(x) putc(x, stdout)
435 #define getchar_unlocked() getc_unlocked(stdin)
436 #define putchar_unlocked(c) putc_unlocked(c, stdout)
437
438 #ifdef _GNU_SOURCE
439 /*
440 * glibc defines dprintf(int, const char*, ...), which is poorly named
441 * and likely to conflict with locally defined debugging printfs
442 * fdprintf is a better name, and some programs that use fdprintf use a
443 * #define fdprintf dprintf for compatibility
444 */
445 __BEGIN_DECLS
446 int fdprintf(int, const char*, ...)
447 __printflike(2, 3);
448 int vfdprintf(int, const char*, __va_list)
449 __printflike(2, 0);
450 __END_DECLS
451 #endif /* _GNU_SOURCE */
452
453 #if defined(__BIONIC_FORTIFY)
454
455 __BEGIN_DECLS
456
457 __BIONIC_FORTIFY_INLINE
458 __printflike(3, 0)
vsnprintf(char * dest,size_t size,const char * format,__va_list ap)459 int vsnprintf(char *dest, size_t size, const char *format, __va_list ap)
460 {
461 return __builtin___vsnprintf_chk(dest, size, 0, __bos(dest), format, ap);
462 }
463
464 __BIONIC_FORTIFY_INLINE
465 __printflike(2, 0)
vsprintf(char * dest,const char * format,__va_list ap)466 int vsprintf(char *dest, const char *format, __va_list ap)
467 {
468 return __builtin___vsprintf_chk(dest, 0, __bos(dest), format, ap);
469 }
470
471 #if defined(__clang__)
472 #define snprintf(dest, size, ...) __builtin___snprintf_chk(dest, size, 0, __bos(dest), __VA_ARGS__)
473 #else
474 __BIONIC_FORTIFY_INLINE
475 __printflike(3, 4)
snprintf(char * dest,size_t size,const char * format,...)476 int snprintf(char *dest, size_t size, const char *format, ...)
477 {
478 return __builtin___snprintf_chk(dest, size, 0,
479 __bos(dest), format, __builtin_va_arg_pack());
480 }
481 #endif
482
483 #if defined(__clang__)
484 #define sprintf(dest, ...) __builtin___sprintf_chk(dest, 0, __bos(dest), __VA_ARGS__)
485 #else
486 __BIONIC_FORTIFY_INLINE
487 __printflike(2, 3)
sprintf(char * dest,const char * format,...)488 int sprintf(char *dest, const char *format, ...)
489 {
490 return __builtin___sprintf_chk(dest, 0,
491 __bos(dest), format, __builtin_va_arg_pack());
492 }
493 #endif
494
495 #if !defined(__clang__)
496 extern char *__fgets_real(char *, int, FILE *)
497 __asm__(__USER_LABEL_PREFIX__ "fgets");
498 __errordecl(__fgets_too_big_error, "fgets called with size bigger than buffer");
499 __errordecl(__fgets_too_small_error, "fgets called with size less than zero");
500 extern char *__fgets_chk(char *, int, FILE *, size_t);
501
502 __BIONIC_FORTIFY_INLINE
fgets(char * dest,int size,FILE * stream)503 char *fgets(char *dest, int size, FILE *stream)
504 {
505 size_t bos = __bos(dest);
506
507 // Compiler can prove, at compile time, that the passed in size
508 // is always negative. Force a compiler error.
509 if (__builtin_constant_p(size) && (size < 0)) {
510 __fgets_too_small_error();
511 }
512
513 // Compiler doesn't know destination size. Don't call __fgets_chk
514 if (bos == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
515 return __fgets_real(dest, size, stream);
516 }
517
518 // Compiler can prove, at compile time, that the passed in size
519 // is always <= the actual object size. Don't call __fgets_chk
520 if (__builtin_constant_p(size) && (size <= (int) bos)) {
521 return __fgets_real(dest, size, stream);
522 }
523
524 // Compiler can prove, at compile time, that the passed in size
525 // is always > the actual object size. Force a compiler error.
526 if (__builtin_constant_p(size) && (size > (int) bos)) {
527 __fgets_too_big_error();
528 }
529
530 return __fgets_chk(dest, size, stream, bos);
531 }
532
533 #endif /* !defined(__clang__) */
534
535 __END_DECLS
536
537 #endif /* defined(__BIONIC_FORTIFY) */
538
539 #endif /* _STDIO_H_ */
540