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