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