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