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