stdio.h revision fb994f4c040da968b7271860535f07daba182069
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__BEGIN_DECLS 51 52typedef off_t fpos_t; /* stdio file position type */ 53 54struct __sFILE; 55typedef struct __sFILE FILE; 56 57extern FILE* stdin; 58extern FILE* stdout; 59extern FILE* stderr; 60/* C99 and earlier plus current C++ standards say these must be macros. */ 61#define stdin stdin 62#define stdout stdout 63#define stderr stderr 64 65#define __SLBF 0x0001 /* line buffered */ 66#define __SNBF 0x0002 /* unbuffered */ 67#define __SRD 0x0004 /* OK to read */ 68#define __SWR 0x0008 /* OK to write */ 69 /* RD and WR are never simultaneously asserted */ 70#define __SRW 0x0010 /* open for reading & writing */ 71#define __SEOF 0x0020 /* found EOF */ 72#define __SERR 0x0040 /* found error */ 73#define __SMBF 0x0080 /* _buf is from malloc */ 74#define __SAPP 0x0100 /* fdopen()ed in append mode */ 75#define __SSTR 0x0200 /* this is an sprintf/snprintf string */ 76#define __SOPT 0x0400 /* do fseek() optimization */ 77#define __SNPT 0x0800 /* do not do fseek() optimization */ 78#define __SOFF 0x1000 /* set iff _offset is in fact correct */ 79#define __SMOD 0x2000 /* true => fgetln modified _p text */ 80#define __SALC 0x4000 /* allocate string space dynamically */ 81#define __SIGN 0x8000 /* ignore this file in _fwalk */ 82 83/* 84 * The following three definitions are for ANSI C, which took them 85 * from System V, which brilliantly took internal interface macros and 86 * made them official arguments to setvbuf(), without renaming them. 87 * Hence, these ugly _IOxxx names are *supposed* to appear in user code. 88 * 89 * Although numbered as their counterparts above, the implementation 90 * does not rely on this. 91 */ 92#define _IOFBF 0 /* setvbuf should set fully buffered */ 93#define _IOLBF 1 /* setvbuf should set line buffered */ 94#define _IONBF 2 /* setvbuf should set unbuffered */ 95 96#define BUFSIZ 1024 /* size of buffer used by setbuf */ 97#define EOF (-1) 98 99/* 100 * FOPEN_MAX is a minimum maximum, and is the number of streams that 101 * stdio can provide without attempting to allocate further resources 102 * (which could fail). Do not use this for anything. 103 */ 104 105#define FOPEN_MAX 20 /* must be <= OPEN_MAX <sys/syslimits.h> */ 106#define FILENAME_MAX 1024 /* must be <= PATH_MAX <sys/syslimits.h> */ 107 108/* System V/ANSI C; this is the wrong way to do this, do *not* use these. */ 109#if __BSD_VISIBLE || __XPG_VISIBLE 110#define P_tmpdir "/tmp/" 111#endif 112#define L_tmpnam 1024 /* XXX must be == PATH_MAX */ 113#define TMP_MAX 308915776 114 115#define SEEK_SET 0 116#define SEEK_CUR 1 117#define SEEK_END 2 118 119/* 120 * Functions defined in ANSI C standard. 121 */ 122void clearerr(FILE *); 123int fclose(FILE *); 124int feof(FILE *); 125int ferror(FILE *); 126int fflush(FILE *); 127int fgetc(FILE *); 128char *fgets(char * __restrict, int, FILE * __restrict); 129FILE *fopen(const char * __restrict , const char * __restrict); 130int fprintf(FILE * __restrict , const char * __restrict, ...) 131 __printflike(2, 3); 132int fputc(int, FILE *); 133int fputs(const char * __restrict, FILE * __restrict); 134size_t fread(void * __restrict, size_t, size_t, FILE * __restrict); 135FILE *freopen(const char * __restrict, const char * __restrict, 136 FILE * __restrict); 137int fscanf(FILE * __restrict, const char * __restrict, ...) 138 __scanflike(2, 3); 139int fseek(FILE *, long, int); 140long ftell(FILE *); 141size_t fwrite(const void * __restrict, size_t, size_t, FILE * __restrict); 142int getc(FILE *); 143int getchar(void); 144ssize_t getdelim(char ** __restrict, size_t * __restrict, int, 145 FILE * __restrict); 146ssize_t getline(char ** __restrict, size_t * __restrict, FILE * __restrict); 147 148void perror(const char *); 149int printf(const char * __restrict, ...) 150 __printflike(1, 2); 151int putc(int, FILE *); 152int putchar(int); 153int puts(const char *); 154int remove(const char *); 155void rewind(FILE *); 156int scanf(const char * __restrict, ...) 157 __scanflike(1, 2); 158void setbuf(FILE * __restrict, char * __restrict); 159int setvbuf(FILE * __restrict, char * __restrict, int, size_t); 160int sscanf(const char * __restrict, const char * __restrict, ...) 161 __scanflike(2, 3); 162FILE *tmpfile(void); 163int ungetc(int, FILE *); 164int vfprintf(FILE * __restrict, const char * __restrict, __va_list) 165 __printflike(2, 0); 166int vprintf(const char * __restrict, __va_list) 167 __printflike(1, 0); 168 169int dprintf(int, const char * __restrict, ...) __printflike(2, 3); 170int vdprintf(int, const char * __restrict, __va_list) __printflike(2, 0); 171 172#ifndef __AUDIT__ 173#if !defined(__STDC_VERSION__) || __STDC_VERSION__ < 201112L 174char* gets(char*) __attribute__((deprecated("gets is unsafe, use fgets instead"))); 175#endif 176int sprintf(char* __restrict, const char* __restrict, ...) 177 __printflike(2, 3) __warnattr("sprintf is often misused; please use snprintf"); 178int vsprintf(char* __restrict, const char* __restrict, __va_list) 179 __printflike(2, 0) __warnattr("vsprintf is often misused; please use vsnprintf"); 180char* tmpnam(char*) __attribute__((deprecated("tmpnam is unsafe, use mkstemp or tmpfile instead"))); 181#if __XPG_VISIBLE 182char* tempnam(const char*, const char*) 183 __attribute__((deprecated("tempnam is unsafe, use mkstemp or tmpfile instead"))); 184#endif 185#endif 186 187extern int rename(const char*, const char*); 188extern int renameat(int, const char*, int, const char*); 189 190#if defined(__USE_FILE_OFFSET64) 191/* Not possible. */ 192int fgetpos(FILE * __restrict, fpos_t * __restrict) 193 __attribute__((__error__("not available with _FILE_OFFSET_BITS=64"))); 194int fsetpos(FILE *, const fpos_t *) 195 __attribute__((__error__("not available with _FILE_OFFSET_BITS=64"))); 196int fseeko(FILE *, off_t, int) 197 __attribute__((__error__("not available with _FILE_OFFSET_BITS=64"))); 198off_t ftello(FILE *) 199 __attribute__((__error__("not available with _FILE_OFFSET_BITS=64"))); 200#else 201int fgetpos(FILE * __restrict, fpos_t * __restrict); 202int fsetpos(FILE *, const fpos_t *); 203int fseeko(FILE *, off_t, int); 204off_t ftello(FILE *); 205#endif 206 207#if __ISO_C_VISIBLE >= 1999 || __BSD_VISIBLE 208int snprintf(char * __restrict, size_t, const char * __restrict, ...) 209 __printflike(3, 4); 210int vfscanf(FILE * __restrict, const char * __restrict, __va_list) 211 __scanflike(2, 0); 212int vscanf(const char *, __va_list) 213 __scanflike(1, 0); 214int vsnprintf(char * __restrict, size_t, const char * __restrict, __va_list) 215 __printflike(3, 0); 216int vsscanf(const char * __restrict, const char * __restrict, __va_list) 217 __scanflike(2, 0); 218#endif /* __ISO_C_VISIBLE >= 1999 || __BSD_VISIBLE */ 219 220/* 221 * Functions defined in POSIX 1003.1. 222 */ 223#if __BSD_VISIBLE || __POSIX_VISIBLE || __XPG_VISIBLE 224#define L_ctermid 1024 /* size for ctermid(); PATH_MAX */ 225 226FILE *fdopen(int, const char *); 227int fileno(FILE *); 228 229#if (__POSIX_VISIBLE >= 199209) 230int pclose(FILE *); 231FILE *popen(const char *, const char *); 232#endif 233 234#if __POSIX_VISIBLE >= 199506 235void flockfile(FILE *); 236int ftrylockfile(FILE *); 237void funlockfile(FILE *); 238 239/* 240 * These are normally used through macros as defined below, but POSIX 241 * requires functions as well. 242 */ 243int getc_unlocked(FILE *); 244int getchar_unlocked(void); 245int putc_unlocked(int, FILE *); 246int putchar_unlocked(int); 247#endif /* __POSIX_VISIBLE >= 199506 */ 248 249#if __POSIX_VISIBLE >= 200809 250FILE* fmemopen(void*, size_t, const char*); 251FILE* open_memstream(char**, size_t*); 252#endif /* __POSIX_VISIBLE >= 200809 */ 253 254#endif /* __BSD_VISIBLE || __POSIX_VISIBLE || __XPG_VISIBLE */ 255 256/* 257 * Routines that are purely local. 258 */ 259#if __BSD_VISIBLE 260int asprintf(char ** __restrict, const char * __restrict, ...) 261 __printflike(2, 3); 262char *fgetln(FILE * __restrict, size_t * __restrict); 263int fpurge(FILE *); 264void setbuffer(FILE *, char *, int); 265int setlinebuf(FILE *); 266int vasprintf(char ** __restrict, const char * __restrict, 267 __va_list) 268 __printflike(2, 0); 269 270void clearerr_unlocked(FILE*); 271int feof_unlocked(FILE*); 272int ferror_unlocked(FILE*); 273int fileno_unlocked(FILE*); 274 275/* 276 * Stdio function-access interface. 277 */ 278FILE *funopen(const void *, 279 int (*)(void *, char *, int), 280 int (*)(void *, const char *, int), 281 fpos_t (*)(void *, fpos_t, int), 282 int (*)(void *)); 283 284#define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0) 285#define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0) 286#endif /* __BSD_VISIBLE */ 287 288extern char* __fgets_chk(char*, int, FILE*, size_t); 289extern char* __fgets_real(char*, int, FILE*) __RENAME(fgets); 290__errordecl(__fgets_too_big_error, "fgets called with size bigger than buffer"); 291__errordecl(__fgets_too_small_error, "fgets called with size less than zero"); 292 293extern size_t __fread_chk(void * __restrict, size_t, size_t, FILE * __restrict, size_t); 294extern size_t __fread_real(void * __restrict, size_t, size_t, FILE * __restrict) __RENAME(fread); 295__errordecl(__fread_too_big_error, "fread called with size * count bigger than buffer"); 296__errordecl(__fread_overflow, "fread called with overflowing size * count"); 297 298extern size_t __fwrite_chk(const void * __restrict, size_t, size_t, FILE * __restrict, size_t); 299extern size_t __fwrite_real(const void * __restrict, size_t, size_t, FILE * __restrict) __RENAME(fwrite); 300__errordecl(__fwrite_too_big_error, "fwrite called with size * count bigger than buffer"); 301__errordecl(__fwrite_overflow, "fwrite called with overflowing size * count"); 302 303#if defined(__BIONIC_FORTIFY) 304 305__BIONIC_FORTIFY_INLINE 306__printflike(3, 0) 307int vsnprintf(char *dest, size_t size, const char *format, __va_list ap) 308{ 309 return __builtin___vsnprintf_chk(dest, size, 0, __bos(dest), format, ap); 310} 311 312__BIONIC_FORTIFY_INLINE 313__printflike(2, 0) 314int vsprintf(char *dest, const char *format, __va_list ap) 315{ 316 return __builtin___vsprintf_chk(dest, 0, __bos(dest), format, ap); 317} 318 319#if defined(__clang__) 320 #if !defined(snprintf) 321 #define __wrap_snprintf(dest, size, ...) __builtin___snprintf_chk(dest, size, 0, __bos(dest), __VA_ARGS__) 322 #define snprintf(...) __wrap_snprintf(__VA_ARGS__) 323 #endif 324#else 325__BIONIC_FORTIFY_INLINE 326__printflike(3, 4) 327int snprintf(char *dest, size_t size, const char *format, ...) 328{ 329 return __builtin___snprintf_chk(dest, size, 0, 330 __bos(dest), format, __builtin_va_arg_pack()); 331} 332#endif 333 334#if defined(__clang__) 335 #if !defined(sprintf) 336 #define __wrap_sprintf(dest, ...) __builtin___sprintf_chk(dest, 0, __bos(dest), __VA_ARGS__) 337 #define sprintf(...) __wrap_sprintf(__VA_ARGS__) 338 #endif 339#else 340__BIONIC_FORTIFY_INLINE 341__printflike(2, 3) 342int sprintf(char *dest, const char *format, ...) 343{ 344 return __builtin___sprintf_chk(dest, 0, 345 __bos(dest), format, __builtin_va_arg_pack()); 346} 347#endif 348 349__BIONIC_FORTIFY_INLINE 350size_t fread(void * __restrict buf, size_t size, size_t count, FILE * __restrict stream) { 351 size_t bos = __bos0(buf); 352 353#if !defined(__clang__) 354 if (bos == __BIONIC_FORTIFY_UNKNOWN_SIZE) { 355 return __fread_real(buf, size, count, stream); 356 } 357 358 if (__builtin_constant_p(size) && __builtin_constant_p(count)) { 359 size_t total; 360 if (__size_mul_overflow(size, count, &total)) { 361 __fread_overflow(); 362 } 363 364 if (total > bos) { 365 __fread_too_big_error(); 366 } 367 368 return __fread_real(buf, size, count, stream); 369 } 370#endif 371 372 return __fread_chk(buf, size, count, stream, bos); 373} 374 375__BIONIC_FORTIFY_INLINE 376size_t fwrite(const void * __restrict buf, size_t size, size_t count, FILE * __restrict stream) { 377 size_t bos = __bos0(buf); 378 379#if !defined(__clang__) 380 if (bos == __BIONIC_FORTIFY_UNKNOWN_SIZE) { 381 return __fwrite_real(buf, size, count, stream); 382 } 383 384 if (__builtin_constant_p(size) && __builtin_constant_p(count)) { 385 size_t total; 386 if (__size_mul_overflow(size, count, &total)) { 387 __fwrite_overflow(); 388 } 389 390 if (total > bos) { 391 __fwrite_too_big_error(); 392 } 393 394 return __fwrite_real(buf, size, count, stream); 395 } 396#endif 397 398 return __fwrite_chk(buf, size, count, stream, bos); 399} 400 401#if !defined(__clang__) 402 403__BIONIC_FORTIFY_INLINE 404char *fgets(char* dest, int size, FILE* stream) { 405 size_t bos = __bos(dest); 406 407 // Compiler can prove, at compile time, that the passed in size 408 // is always negative. Force a compiler error. 409 if (__builtin_constant_p(size) && (size < 0)) { 410 __fgets_too_small_error(); 411 } 412 413 // Compiler doesn't know destination size. Don't call __fgets_chk 414 if (bos == __BIONIC_FORTIFY_UNKNOWN_SIZE) { 415 return __fgets_real(dest, size, stream); 416 } 417 418 // Compiler can prove, at compile time, that the passed in size 419 // is always <= the actual object size. Don't call __fgets_chk 420 if (__builtin_constant_p(size) && (size <= (int) bos)) { 421 return __fgets_real(dest, size, stream); 422 } 423 424 // Compiler can prove, at compile time, that the passed in size 425 // is always > the actual object size. Force a compiler error. 426 if (__builtin_constant_p(size) && (size > (int) bos)) { 427 __fgets_too_big_error(); 428 } 429 430 return __fgets_chk(dest, size, stream, bos); 431} 432 433#endif /* !defined(__clang__) */ 434 435#endif /* defined(__BIONIC_FORTIFY) */ 436 437__END_DECLS 438 439#endif /* _STDIO_H_ */ 440