stdio.h revision 78d6d9888c24c50f65d694dc8283afdcb58db84c
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 52typedef 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 */ 61struct __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 */ 93typedef 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 128extern 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() optimisation */ 143#define __SNPT 0x0800 /* do not do fseek() optimisation */ 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 164#define EOF (-1) 165 166/* 167 * FOPEN_MAX is a minimum maximum, and should be the number of descriptors 168 * that the kernel can provide without allocation of a resource that can 169 * fail without the process sleeping. Do not use this for anything. 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#ifndef SEEK_SET 182#define SEEK_SET 0 /* set file offset to offset */ 183#endif 184#ifndef SEEK_CUR 185#define SEEK_CUR 1 /* set file offset to current plus offset */ 186#endif 187#ifndef SEEK_END 188#define SEEK_END 2 /* set file offset to EOF plus offset */ 189#endif 190 191#define stdin (&__sF[0]) 192#define stdout (&__sF[1]) 193#define stderr (&__sF[2]) 194 195/* 196 * Functions defined in ANSI C standard. 197 */ 198__BEGIN_DECLS 199void clearerr(FILE *); 200int fclose(FILE *); 201int feof(FILE *); 202int ferror(FILE *); 203int fflush(FILE *); 204int fgetc(FILE *); 205int fgetpos(FILE *, fpos_t *); 206char *fgets(char *, int, FILE *); 207FILE *fopen(const char *, const char *); 208int fprintf(FILE *, const char *, ...) 209 __attribute__((__format__ (printf, 2, 3))) 210 __attribute__((__nonnull__ (2))); 211int fputc(int, FILE *); 212int fputs(const char *, FILE *); 213size_t fread(void *, size_t, size_t, FILE *); 214FILE *freopen(const char *, const char *, FILE *); 215int fscanf(FILE *, const char *, ...) 216 __attribute__ ((__format__ (scanf, 2, 3))) 217 __attribute__ ((__nonnull__ (2))); 218int fseek(FILE *, long, int); 219int fseeko(FILE *, off_t, int); 220int fsetpos(FILE *, const fpos_t *); 221long ftell(FILE *); 222off_t ftello(FILE *); 223size_t fwrite(const void *, size_t, size_t, FILE *); 224int getc(FILE *); 225int getchar(void); 226ssize_t getdelim(char ** __restrict, size_t * __restrict, int, 227 FILE * __restrict); 228ssize_t getline(char ** __restrict, size_t * __restrict, FILE * __restrict); 229char *gets(char *); 230#if __BSD_VISIBLE && !defined(__SYS_ERRLIST) 231#define __SYS_ERRLIST 232 233extern int sys_nerr; /* perror(3) external variables */ 234extern char *sys_errlist[]; 235#endif 236void perror(const char *); 237int printf(const char *, ...) 238 __attribute__((__format__ (printf, 1, 2))) 239 __attribute__((__nonnull__ (1))); 240int putc(int, FILE *); 241int putchar(int); 242int puts(const char *); 243int remove(const char *); 244int rename(const char *, const char *); 245void rewind(FILE *); 246int scanf(const char *, ...) 247 __attribute__ ((__format__ (scanf, 1, 2))) 248 __attribute__ ((__nonnull__ (1))); 249void setbuf(FILE *, char *); 250int setvbuf(FILE *, char *, int, size_t); 251int sprintf(char *, const char *, ...) 252 __attribute__((__format__ (printf, 2, 3))) 253 __attribute__((__nonnull__ (2))); 254int sscanf(const char *, const char *, ...) 255 __attribute__ ((__format__ (scanf, 2, 3))) 256 __attribute__ ((__nonnull__ (2))); 257FILE *tmpfile(void); 258char *tmpnam(char *); 259int ungetc(int, FILE *); 260int vfprintf(FILE *, const char *, __va_list) 261 __attribute__((__format__ (printf, 2, 0))) 262 __attribute__((__nonnull__ (2))); 263int vprintf(const char *, __va_list) 264 __attribute__((__format__ (printf, 1, 0))) 265 __attribute__((__nonnull__ (1))); 266int vsprintf(char *, const char *, __va_list) 267 __attribute__((__format__ (printf, 2, 0))) 268 __attribute__((__nonnull__ (2))); 269 270#if __ISO_C_VISIBLE >= 1999 || __BSD_VISIBLE 271int snprintf(char *, size_t, const char *, ...) 272 __attribute__((__format__ (printf, 3, 4))) 273 __attribute__((__nonnull__ (3))); 274int vfscanf(FILE *, const char *, __va_list) 275 __attribute__((__format__ (scanf, 2, 0))) 276 __attribute__((__nonnull__ (2))); 277int vscanf(const char *, __va_list) 278 __attribute__((__format__ (scanf, 1, 0))) 279 __attribute__((__nonnull__ (1))); 280int vsnprintf(char *, size_t, const char *, __va_list) 281 __attribute__((__format__ (printf, 3, 0))) 282 __attribute__((__nonnull__ (3))); 283int vsscanf(const char *, const char *, __va_list) 284 __attribute__((__format__ (scanf, 2, 0))) 285 __attribute__((__nonnull__ (2))); 286#endif /* __ISO_C_VISIBLE >= 1999 || __BSD_VISIBLE */ 287 288__END_DECLS 289 290 291/* 292 * Functions defined in POSIX 1003.1. 293 */ 294#if __BSD_VISIBLE || __POSIX_VISIBLE || __XPG_VISIBLE 295#define L_ctermid 1024 /* size for ctermid(); PATH_MAX */ 296#define L_cuserid 9 /* size for cuserid(); UT_NAMESIZE + 1 */ 297 298__BEGIN_DECLS 299#if 0 /* MISSING FROM BIONIC */ 300char *ctermid(char *); 301char *cuserid(char *); 302#endif /* MISSING */ 303FILE *fdopen(int, const char *); 304int fileno(FILE *); 305 306#if (__POSIX_VISIBLE >= 199209) 307int pclose(FILE *); 308FILE *popen(const char *, const char *); 309#endif 310 311#if __POSIX_VISIBLE >= 199506 312void flockfile(FILE *); 313int ftrylockfile(FILE *); 314void funlockfile(FILE *); 315 316/* 317 * These are normally used through macros as defined below, but POSIX 318 * requires functions as well. 319 */ 320int getc_unlocked(FILE *); 321int getchar_unlocked(void); 322int putc_unlocked(int, FILE *); 323int putchar_unlocked(int); 324#endif /* __POSIX_VISIBLE >= 199506 */ 325 326#if __XPG_VISIBLE 327char *tempnam(const char *, const char *); 328#endif 329__END_DECLS 330 331#endif /* __BSD_VISIBLE || __POSIX_VISIBLE || __XPG_VISIBLE */ 332 333/* 334 * Routines that are purely local. 335 */ 336#if __BSD_VISIBLE 337__BEGIN_DECLS 338int asprintf(char **, const char *, ...) 339 __attribute__((__format__ (printf, 2, 3))) 340 __attribute__((__nonnull__ (2))); 341char *fgetln(FILE *, size_t *); 342int fpurge(FILE *); 343int getw(FILE *); 344int putw(int, FILE *); 345void setbuffer(FILE *, char *, int); 346int setlinebuf(FILE *); 347int vasprintf(char **, const char *, __va_list) 348 __attribute__((__format__ (printf, 2, 0))) 349 __attribute__((__nonnull__ (2))); 350__END_DECLS 351 352/* 353 * Stdio function-access interface. 354 */ 355__BEGIN_DECLS 356FILE *funopen(const void *, 357 int (*)(void *, char *, int), 358 int (*)(void *, const char *, int), 359 fpos_t (*)(void *, fpos_t, int), 360 int (*)(void *)); 361__END_DECLS 362#define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0) 363#define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0) 364#endif /* __BSD_VISIBLE */ 365 366/* 367 * Functions internal to the implementation. 368 */ 369__BEGIN_DECLS 370int __srget(FILE *); 371int __swbuf(int, FILE *); 372__END_DECLS 373 374/* 375 * The __sfoo macros are here so that we can 376 * define function versions in the C library. 377 */ 378#define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++)) 379#if defined(__GNUC__) 380static __inline int __sputc(int _c, FILE *_p) { 381 if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n')) 382 return (*_p->_p++ = _c); 383 else 384 return (__swbuf(_c, _p)); 385} 386#else 387/* 388 * This has been tuned to generate reasonable code on the vax using pcc. 389 */ 390#define __sputc(c, p) \ 391 (--(p)->_w < 0 ? \ 392 (p)->_w >= (p)->_lbfsize ? \ 393 (*(p)->_p = (c)), *(p)->_p != '\n' ? \ 394 (int)*(p)->_p++ : \ 395 __swbuf('\n', p) : \ 396 __swbuf((int)(c), p) : \ 397 (*(p)->_p = (c), (int)*(p)->_p++)) 398#endif 399 400#define __sfeof(p) (((p)->_flags & __SEOF) != 0) 401#define __sferror(p) (((p)->_flags & __SERR) != 0) 402#define __sclearerr(p) ((void)((p)->_flags &= ~(__SERR|__SEOF))) 403#define __sfileno(p) ((p)->_file) 404 405extern int __isthreaded; 406 407#define feof(p) (!__isthreaded ? __sfeof(p) : (feof)(p)) 408#define ferror(p) (!__isthreaded ? __sferror(p) : (ferror)(p)) 409#define clearerr(p) (!__isthreaded ? __sclearerr(p) : (clearerr)(p)) 410 411#if __POSIX_VISIBLE 412#define fileno(p) (!__isthreaded ? __sfileno(p) : (fileno)(p)) 413#endif 414 415#define getc(fp) (!__isthreaded ? __sgetc(fp) : (getc)(fp)) 416 417#if __BSD_VISIBLE 418/* 419 * The macro implementations of putc and putc_unlocked are not 420 * fully POSIX compliant; they do not set errno on failure 421 */ 422#define putc(x, fp) (!__isthreaded ? __sputc(x, fp) : (putc)(x, fp)) 423#endif /* __BSD_VISIBLE */ 424 425#ifndef lint 426#if __POSIX_VISIBLE >= 199506 427#define getc_unlocked(fp) __sgetc(fp) 428/* 429 * The macro implementations of putc and putc_unlocked are not 430 * fully POSIX compliant; they do not set errno on failure 431 */ 432#if __BSD_VISIBLE 433#define putc_unlocked(x, fp) __sputc(x, fp) 434#endif /* __BSD_VISIBLE */ 435#endif /* __POSIX_VISIBLE >= 199506 */ 436#endif /* lint */ 437 438#define getchar() getc(stdin) 439#define putchar(x) putc(x, stdout) 440#define getchar_unlocked() getc_unlocked(stdin) 441#define putchar_unlocked(c) putc_unlocked(c, stdout) 442 443#ifdef _GNU_SOURCE 444/* 445 * glibc defines dprintf(int, const char*, ...), which is poorly named 446 * and likely to conflict with locally defined debugging printfs 447 * fdprintf is a better name, and some programs that use fdprintf use a 448 * #define fdprintf dprintf for compatibility 449 */ 450__BEGIN_DECLS 451int fdprintf(int, const char*, ...) 452 __attribute__((__format__ (printf, 2, 3))) 453 __attribute__((__nonnull__ (2))); 454int vfdprintf(int, const char*, __va_list) 455 __attribute__((__format__ (printf, 2, 0))) 456 __attribute__((__nonnull__ (2))); 457__END_DECLS 458#endif /* _GNU_SOURCE */ 459 460#if defined(__BIONIC_FORTIFY) 461 462__BEGIN_DECLS 463 464__BIONIC_FORTIFY_INLINE 465__attribute__((__format__ (printf, 3, 0))) 466__attribute__((__nonnull__ (3))) 467int vsnprintf(char *dest, size_t size, const char *format, __va_list ap) 468{ 469 return __builtin___vsnprintf_chk(dest, size, 0, 470 __builtin_object_size(dest, 0), format, ap); 471} 472 473__BIONIC_FORTIFY_INLINE 474__attribute__((__format__ (printf, 2, 0))) 475__attribute__((__nonnull__ (2))) 476int vsprintf(char *dest, const char *format, __va_list ap) 477{ 478 return __builtin___vsprintf_chk(dest, 0, 479 __builtin_object_size(dest, 0), format, ap); 480} 481 482__BIONIC_FORTIFY_INLINE 483__attribute__((__format__ (printf, 3, 4))) 484__attribute__((__nonnull__ (3))) 485int snprintf(char *str, size_t size, const char *format, ...) 486{ 487 return __builtin___snprintf_chk(str, size, 0, 488 __builtin_object_size(str, 0), format, __builtin_va_arg_pack()); 489} 490 491__BIONIC_FORTIFY_INLINE 492__attribute__((__format__ (printf, 2, 3))) 493__attribute__((__nonnull__ (2))) 494int sprintf(char *dest, const char *format, ...) 495{ 496 return __builtin___sprintf_chk(dest, 0, 497 __bos(dest), format, __builtin_va_arg_pack()); 498} 499 500extern char *__fgets_real(char *, int, FILE *) 501 __asm__(__USER_LABEL_PREFIX__ "fgets"); 502extern void __fgets_too_big_error() 503 __attribute__((__error__("fgets called with size bigger than buffer"))); 504extern void __fgets_too_small_error() 505 __attribute__((__error__("fgets called with size less than zero"))); 506extern char *__fgets_chk(char *, int, FILE *, size_t); 507 508__BIONIC_FORTIFY_INLINE 509char *fgets(char *dest, int size, FILE *stream) 510{ 511 size_t bos = __builtin_object_size(dest, 0); 512 513 // Compiler can prove, at compile time, that the passed in size 514 // is always negative. Force a compiler error. 515 if (__builtin_constant_p(size) && (size < 0)) { 516 __fgets_too_small_error(); 517 } 518 519 // Compiler doesn't know destination size. Don't call __fgets_chk 520 if (bos == __BIONIC_FORTIFY_UNKNOWN_SIZE) { 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. Don't call __fgets_chk 526 if (__builtin_constant_p(size) && (size <= (int) bos)) { 527 return __fgets_real(dest, size, stream); 528 } 529 530 // Compiler can prove, at compile time, that the passed in size 531 // is always > the actual object size. Force a compiler error. 532 if (__builtin_constant_p(size) && (size > (int) bos)) { 533 __fgets_too_big_error(); 534 } 535 536 return __fgets_chk(dest, size, stream, bos); 537} 538 539__END_DECLS 540 541#endif /* defined(__BIONIC_FORTIFY) */ 542 543#endif /* _STDIO_H_ */ 544