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 /*
42 * This file must contain a reference to __gnuc_va_list so that GCC's
43 * fixincludes knows that that's what's being used for va_list, and so
44 * to leave our <stdio.h> alone. (fixincludes gets in the way of pointing
45 * one toolchain at various different sets of platform headers.)
46 * If you alter this comment, be sure to keep "__gnuc_va_list" in it!
47 */
48
49 #include <sys/cdefs.h>
50 #include <sys/types.h>
51
52 #include <stdarg.h>
53 #include <stddef.h>
54
55 #define __need_NULL
56 #include <stddef.h>
57
58 __BEGIN_DECLS
59
60 typedef off_t fpos_t; /* stdio file position type */
61
62 /*
63 * NB: to fit things in six character monocase externals, the stdio
64 * code uses the prefix `__s' for stdio objects, typically followed
65 * by a three-character attempt at a mnemonic.
66 */
67
68 /* stdio buffers */
69 #if defined(__LP64__)
70 struct __sbuf {
71 unsigned char* _base;
72 size_t _size;
73 };
74 #else
75 struct __sbuf {
76 unsigned char *_base;
77 int _size;
78 };
79 #endif
80
81 /*
82 * stdio state variables.
83 *
84 * The following always hold:
85 *
86 * if (_flags&(__SLBF|__SWR)) == (__SLBF|__SWR),
87 * _lbfsize is -_bf._size, else _lbfsize is 0
88 * if _flags&__SRD, _w is 0
89 * if _flags&__SWR, _r is 0
90 *
91 * This ensures that the getc and putc macros (or inline functions) never
92 * try to write or read from a file that is in `read' or `write' mode.
93 * (Moreover, they can, and do, automatically switch from read mode to
94 * write mode, and back, on "r+" and "w+" files.)
95 *
96 * _lbfsize is used only to make the inline line-buffered output stream
97 * code as compact as possible.
98 *
99 * _ub, _up, and _ur are used when ungetc() pushes back more characters
100 * than fit in the current _bf, or when ungetc() pushes back a character
101 * that does not match the previous one in _bf. When this happens,
102 * _ub._base becomes non-nil (i.e., a stream has ungetc() data iff
103 * _ub._base!=NULL) and _up and _ur save the current values of _p and _r.
104 *
105 * NOTE: if you change this structure, you also need to update the
106 * std() initializer in findfp.c.
107 */
108 typedef struct __sFILE {
109 unsigned char *_p; /* current position in (some) buffer */
110 int _r; /* read space left for getc() */
111 int _w; /* write space left for putc() */
112 #if defined(__LP64__)
113 int _flags; /* flags, below; this FILE is free if 0 */
114 int _file; /* fileno, if Unix descriptor, else -1 */
115 #else
116 short _flags; /* flags, below; this FILE is free if 0 */
117 short _file; /* fileno, if Unix descriptor, else -1 */
118 #endif
119 struct __sbuf _bf; /* the buffer (at least 1 byte, if !NULL) */
120 int _lbfsize; /* 0 or -_bf._size, for inline putc */
121
122 /* operations */
123 void *_cookie; /* cookie passed to io functions */
124 int (*_close)(void *);
125 int (*_read)(void *, char *, int);
126 fpos_t (*_seek)(void *, fpos_t, int);
127 int (*_write)(void *, const char *, int);
128
129 /* extension data, to avoid further ABI breakage */
130 struct __sbuf _ext;
131 /* data for long sequences of ungetc() */
132 unsigned char *_up; /* saved _p when _p is doing ungetc data */
133 int _ur; /* saved _r when _r is counting ungetc data */
134
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 */
138
139 /* separate buffer for fgetln() when line crosses buffer boundary */
140 struct __sbuf _lb; /* buffer for fgetln() */
141
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 */
145 } FILE;
146
147 /* Legacy BSD implementation of stdin/stdout/stderr. */
148 extern FILE __sF[];
149 /* More obvious implementation. */
150 extern FILE* stdin;
151 extern FILE* stdout;
152 extern FILE* stderr;
153 /* C99 and earlier plus current C++ standards say these must be macros. */
154 #define stdin stdin
155 #define stdout stdout
156 #define stderr stderr
157
158 #define __SLBF 0x0001 /* line buffered */
159 #define __SNBF 0x0002 /* unbuffered */
160 #define __SRD 0x0004 /* OK to read */
161 #define __SWR 0x0008 /* OK to write */
162 /* RD and WR are never simultaneously asserted */
163 #define __SRW 0x0010 /* open for reading & writing */
164 #define __SEOF 0x0020 /* found EOF */
165 #define __SERR 0x0040 /* found error */
166 #define __SMBF 0x0080 /* _buf is from malloc */
167 #define __SAPP 0x0100 /* fdopen()ed in append mode */
168 #define __SSTR 0x0200 /* this is an sprintf/snprintf string */
169 #define __SOPT 0x0400 /* do fseek() optimization */
170 #define __SNPT 0x0800 /* do not do fseek() optimization */
171 #define __SOFF 0x1000 /* set iff _offset is in fact correct */
172 #define __SMOD 0x2000 /* true => fgetln modified _p text */
173 #define __SALC 0x4000 /* allocate string space dynamically */
174 #define __SIGN 0x8000 /* ignore this file in _fwalk */
175
176 /*
177 * The following three definitions are for ANSI C, which took them
178 * from System V, which brilliantly took internal interface macros and
179 * made them official arguments to setvbuf(), without renaming them.
180 * Hence, these ugly _IOxxx names are *supposed* to appear in user code.
181 *
182 * Although numbered as their counterparts above, the implementation
183 * does not rely on this.
184 */
185 #define _IOFBF 0 /* setvbuf should set fully buffered */
186 #define _IOLBF 1 /* setvbuf should set line buffered */
187 #define _IONBF 2 /* setvbuf should set unbuffered */
188
189 #define BUFSIZ 1024 /* size of buffer used by setbuf */
190 #define EOF (-1)
191
192 /*
193 * FOPEN_MAX is a minimum maximum, and is the number of streams that
194 * stdio can provide without attempting to allocate further resources
195 * (which could fail). Do not use this for anything.
196 */
197
198 #define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */
199 #define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */
200
201 /* System V/ANSI C; this is the wrong way to do this, do *not* use these. */
202 #if __BSD_VISIBLE || __XPG_VISIBLE
203 #define P_tmpdir "/tmp/"
204 #endif
205 #define L_tmpnam 1024 /* XXX must be == PATH_MAX */
206 #define TMP_MAX 308915776
207
208 #define SEEK_SET 0
209 #define SEEK_CUR 1
210 #define SEEK_END 2
211
212 /*
213 * Functions defined in ANSI C standard.
214 */
215 void clearerr(FILE *);
216 int fclose(FILE *);
217 int feof(FILE *);
218 int ferror(FILE *);
219 int fflush(FILE *);
220 int fgetc(FILE *);
221 char *fgets(char * __restrict, int, FILE * __restrict);
222 FILE *fopen(const char * __restrict , const char * __restrict);
223 int fprintf(FILE * __restrict , const char * __restrict, ...)
224 __printflike(2, 3);
225 int fputc(int, FILE *);
226 int fputs(const char * __restrict, FILE * __restrict);
227 size_t fread(void * __restrict, size_t, size_t, FILE * __restrict);
228 FILE *freopen(const char * __restrict, const char * __restrict,
229 FILE * __restrict);
230 int fscanf(FILE * __restrict, const char * __restrict, ...)
231 __scanflike(2, 3);
232 int fseek(FILE *, long, int);
233 long ftell(FILE *);
234 size_t fwrite(const void * __restrict, size_t, size_t, FILE * __restrict);
235 int getc(FILE *);
236 int getchar(void);
237 ssize_t getdelim(char ** __restrict, size_t * __restrict, int,
238 FILE * __restrict);
239 ssize_t getline(char ** __restrict, size_t * __restrict, FILE * __restrict);
240
241 void perror(const char *);
242 int printf(const char * __restrict, ...)
243 __printflike(1, 2);
244 int putc(int, FILE *);
245 int putchar(int);
246 int puts(const char *);
247 int remove(const char *);
248 void rewind(FILE *);
249 int scanf(const char * __restrict, ...)
250 __scanflike(1, 2);
251 void setbuf(FILE * __restrict, char * __restrict);
252 int setvbuf(FILE * __restrict, char * __restrict, int, size_t);
253 int sscanf(const char * __restrict, const char * __restrict, ...)
254 __scanflike(2, 3);
255 FILE *tmpfile(void);
256 int ungetc(int, FILE *);
257 int vfprintf(FILE * __restrict, const char * __restrict, __va_list)
258 __printflike(2, 0);
259 int vprintf(const char * __restrict, __va_list)
260 __printflike(1, 0);
261
262 int dprintf(int, const char * __restrict, ...) __printflike(2, 3);
263 int vdprintf(int, const char * __restrict, __va_list) __printflike(2, 0);
264
265 #ifndef __AUDIT__
266 #if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 201112L
267 char* gets(char*) __attribute__((deprecated("gets is unsafe, use fgets instead")));
268 #endif
269 int sprintf(char* __restrict, const char* __restrict, ...)
270 __printflike(2, 3) __warnattr("sprintf is often misused; please use snprintf");
271 int vsprintf(char* __restrict, const char* __restrict, __va_list)
272 __printflike(2, 0) __warnattr("vsprintf is often misused; please use vsnprintf");
273 char* tmpnam(char*) __attribute__((deprecated("tmpnam is unsafe, use mkstemp or tmpfile instead")));
274 #if __XPG_VISIBLE
275 char* tempnam(const char*, const char*)
276 __attribute__((deprecated("tempnam is unsafe, use mkstemp or tmpfile instead")));
277 #endif
278 #endif
279
280 extern int rename(const char*, const char*);
281 extern int renameat(int, const char*, int, const char*);
282
283 #if defined(__USE_FILE_OFFSET64)
284 /* Not possible. */
285 int fgetpos(FILE * __restrict, fpos_t * __restrict)
286 __attribute__((__error__("not available with _FILE_OFFSET_BITS=64")));
287 int fsetpos(FILE *, const fpos_t *)
288 __attribute__((__error__("not available with _FILE_OFFSET_BITS=64")));
289 int fseeko(FILE *, off_t, int)
290 __attribute__((__error__("not available with _FILE_OFFSET_BITS=64")));
291 off_t ftello(FILE *)
292 __attribute__((__error__("not available with _FILE_OFFSET_BITS=64")));
293 #else
294 int fgetpos(FILE * __restrict, fpos_t * __restrict);
295 int fsetpos(FILE *, const fpos_t *);
296 int fseeko(FILE *, off_t, int);
297 off_t ftello(FILE *);
298 #endif
299
300 #if __ISO_C_VISIBLE >= 1999 || __BSD_VISIBLE
301 int snprintf(char * __restrict, size_t, const char * __restrict, ...)
302 __printflike(3, 4);
303 int vfscanf(FILE * __restrict, const char * __restrict, __va_list)
304 __scanflike(2, 0);
305 int vscanf(const char *, __va_list)
306 __scanflike(1, 0);
307 int vsnprintf(char * __restrict, size_t, const char * __restrict, __va_list)
308 __printflike(3, 0);
309 int vsscanf(const char * __restrict, const char * __restrict, __va_list)
310 __scanflike(2, 0);
311 #endif /* __ISO_C_VISIBLE >= 1999 || __BSD_VISIBLE */
312
313 /*
314 * Functions defined in POSIX 1003.1.
315 */
316 #if __BSD_VISIBLE || __POSIX_VISIBLE || __XPG_VISIBLE
317 #define L_ctermid 1024 /* size for ctermid(); PATH_MAX */
318
319 FILE *fdopen(int, const char *);
320 int fileno(FILE *);
321
322 #if (__POSIX_VISIBLE >= 199209)
323 int pclose(FILE *);
324 FILE *popen(const char *, const char *);
325 #endif
326
327 #if __POSIX_VISIBLE >= 199506
328 void flockfile(FILE *);
329 int ftrylockfile(FILE *);
330 void funlockfile(FILE *);
331
332 /*
333 * These are normally used through macros as defined below, but POSIX
334 * requires functions as well.
335 */
336 int getc_unlocked(FILE *);
337 int getchar_unlocked(void);
338 int putc_unlocked(int, FILE *);
339 int putchar_unlocked(int);
340 #endif /* __POSIX_VISIBLE >= 199506 */
341
342 #if __POSIX_VISIBLE >= 200809
343 FILE* fmemopen(void*, size_t, const char*);
344 FILE* open_memstream(char**, size_t*);
345 #endif /* __POSIX_VISIBLE >= 200809 */
346
347 #endif /* __BSD_VISIBLE || __POSIX_VISIBLE || __XPG_VISIBLE */
348
349 /*
350 * Routines that are purely local.
351 */
352 #if __BSD_VISIBLE
353 int asprintf(char ** __restrict, const char * __restrict, ...)
354 __printflike(2, 3);
355 char *fgetln(FILE * __restrict, size_t * __restrict);
356 int fpurge(FILE *);
357 void setbuffer(FILE *, char *, int);
358 int setlinebuf(FILE *);
359 int vasprintf(char ** __restrict, const char * __restrict,
360 __va_list)
361 __printflike(2, 0);
362
363 void clearerr_unlocked(FILE*);
364 int feof_unlocked(FILE*);
365 int ferror_unlocked(FILE*);
366
367 /*
368 * Stdio function-access interface.
369 */
370 FILE *funopen(const void *,
371 int (*)(void *, char *, int),
372 int (*)(void *, const char *, int),
373 fpos_t (*)(void *, fpos_t, int),
374 int (*)(void *));
375
376 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
377 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
378 #endif /* __BSD_VISIBLE */
379
380 extern char* __fgets_chk(char*, int, FILE*, size_t);
381 extern char* __fgets_real(char*, int, FILE*) __RENAME(fgets);
382 __errordecl(__fgets_too_big_error, "fgets called with size bigger than buffer");
383 __errordecl(__fgets_too_small_error, "fgets called with size less than zero");
384
385 #if defined(__BIONIC_FORTIFY)
386
387 __BIONIC_FORTIFY_INLINE
388 __printflike(3, 0)
vsnprintf(char * dest,size_t size,const char * format,__va_list ap)389 int vsnprintf(char *dest, size_t size, const char *format, __va_list ap)
390 {
391 return __builtin___vsnprintf_chk(dest, size, 0, __bos(dest), format, ap);
392 }
393
394 __BIONIC_FORTIFY_INLINE
395 __printflike(2, 0)
vsprintf(char * dest,const char * format,__va_list ap)396 int vsprintf(char *dest, const char *format, __va_list ap)
397 {
398 return __builtin___vsprintf_chk(dest, 0, __bos(dest), format, ap);
399 }
400
401 #if defined(__clang__)
402 #if !defined(snprintf)
403 #define __wrap_snprintf(dest, size, ...) __builtin___snprintf_chk(dest, size, 0, __bos(dest), __VA_ARGS__)
404 #define snprintf(...) __wrap_snprintf(__VA_ARGS__)
405 #endif
406 #else
407 __BIONIC_FORTIFY_INLINE
408 __printflike(3, 4)
snprintf(char * dest,size_t size,const char * format,...)409 int snprintf(char *dest, size_t size, const char *format, ...)
410 {
411 return __builtin___snprintf_chk(dest, size, 0,
412 __bos(dest), format, __builtin_va_arg_pack());
413 }
414 #endif
415
416 #if defined(__clang__)
417 #if !defined(sprintf)
418 #define __wrap_sprintf(dest, ...) __builtin___sprintf_chk(dest, 0, __bos(dest), __VA_ARGS__)
419 #define sprintf(...) __wrap_sprintf(__VA_ARGS__)
420 #endif
421 #else
422 __BIONIC_FORTIFY_INLINE
423 __printflike(2, 3)
sprintf(char * dest,const char * format,...)424 int sprintf(char *dest, const char *format, ...)
425 {
426 return __builtin___sprintf_chk(dest, 0,
427 __bos(dest), format, __builtin_va_arg_pack());
428 }
429 #endif
430
431 #if !defined(__clang__)
432
433 __BIONIC_FORTIFY_INLINE
fgets(char * dest,int size,FILE * stream)434 char *fgets(char* dest, int size, FILE* stream) {
435 size_t bos = __bos(dest);
436
437 // Compiler can prove, at compile time, that the passed in size
438 // is always negative. Force a compiler error.
439 if (__builtin_constant_p(size) && (size < 0)) {
440 __fgets_too_small_error();
441 }
442
443 // Compiler doesn't know destination size. Don't call __fgets_chk
444 if (bos == __BIONIC_FORTIFY_UNKNOWN_SIZE) {
445 return __fgets_real(dest, size, stream);
446 }
447
448 // Compiler can prove, at compile time, that the passed in size
449 // is always <= the actual object size. Don't call __fgets_chk
450 if (__builtin_constant_p(size) && (size <= (int) bos)) {
451 return __fgets_real(dest, size, stream);
452 }
453
454 // Compiler can prove, at compile time, that the passed in size
455 // is always > the actual object size. Force a compiler error.
456 if (__builtin_constant_p(size) && (size > (int) bos)) {
457 __fgets_too_big_error();
458 }
459
460 return __fgets_chk(dest, size, stream, bos);
461 }
462
463 #endif /* !defined(__clang__) */
464
465 #endif /* defined(__BIONIC_FORTIFY) */
466
467 __END_DECLS
468
469 #endif /* _STDIO_H_ */
470