stdio: add __printflike() to ANSI C functions
[barrelfish] / 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 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             __printflike(2, 3);
253 int      fputc(int, FILE *);
254 int      fputs(const char * __restrict, FILE * __restrict);
255 size_t   fread(void * __restrict, size_t, size_t, FILE * __restrict);
256 FILE    *freopen(const char * __restrict, const char * __restrict, FILE * __restrict);
257 int      fscanf(FILE * __restrict, const char * __restrict, ...)
258             __scanflike(2, 3);
259 int      fseek(FILE *, long, int);
260 int      fsetpos(FILE *, const fpos_t *);
261 long     ftell(FILE *);
262 size_t   fwrite(const void * __restrict, size_t, size_t, FILE * __restrict);
263 int      getc(FILE *);
264 int      getchar(void);
265 char    *gets(char *);
266 void     perror(const char *);
267 int      printf(const char * __restrict, ...) __printflike(1, 2);
268 int      putc(int, FILE *);
269 int      putchar(int);
270 int      puts(const char *);
271 int      remove(const char *);
272 int      rename(const char *, const char *);
273 void     rewind(FILE *);
274 int      scanf(const char * __restrict, ...) __scanflike(1, 2);
275 void     setbuf(FILE * __restrict, char * __restrict);
276 int      setvbuf(FILE * __restrict, char * __restrict, int, size_t);
277 int      sprintf(char * __restrict, const char * __restrict, ...)
278             __printflike(2, 3);
279 int      sscanf(const char * __restrict, const char * __restrict, ...)
280             __scanflike(2, 3);
281 FILE    *tmpfile(void);
282 char    *tmpnam(char *);
283 int      ungetc(int, FILE *);
284 int      vfprintf(FILE * __restrict, const char * __restrict,
285             __va_list) __printflike(2, 0);
286 int      vprintf(const char * __restrict, __va_list) __printflike(1, 0);
287 int      vsprintf(char * __restrict, const char * __restrict,
288             __va_list) __printflike(2, 0);
289
290 #if __ISO_C_VISIBLE >= 1999
291 int      snprintf(char * __restrict, size_t, const char * __restrict,
292             ...) __printflike(3, 4);
293 int      vfscanf(FILE * __restrict, const char * __restrict, __va_list)
294             __scanflike(2, 0);
295 int      vscanf(const char * __restrict, __va_list) __scanflike(1, 0);
296 int      vsnprintf(char * __restrict, size_t, const char * __restrict,
297             __va_list) __printflike(3, 0);
298 int      vsscanf(const char * __restrict, const char * __restrict, __va_list)
299             __scanflike(2, 0);
300 #endif
301
302 /*
303  * Functions defined in all versions of POSIX 1003.1.
304  */
305 #if __BSD_VISIBLE || (__POSIX_VISIBLE && __POSIX_VISIBLE <= 199506)
306 #define L_cuserid       17      /* size for cuserid(3); MAXLOGNAME, legacy */
307 #endif
308
309 #if __POSIX_VISIBLE
310 #define L_ctermid       1024    /* size for ctermid(3); PATH_MAX */
311
312 char    *ctermid(char *);
313 FILE    *fdopen(int, const char *);
314 int      fileno(FILE *);
315 #endif /* __POSIX_VISIBLE */
316
317 #if __POSIX_VISIBLE >= 199209
318 int      pclose(FILE *);
319 FILE    *popen(const char *, const char *);
320 #endif
321
322 #if __POSIX_VISIBLE >= 199506
323 int      ftrylockfile(FILE *);
324 void     flockfile(FILE *);
325 void     funlockfile(FILE *);
326
327 /*
328  * These are normally used through macros as defined below, but POSIX
329  * requires functions as well.
330  */
331 int      getc_unlocked(FILE *);
332 int      getchar_unlocked(void);
333 int      putc_unlocked(int, FILE *);
334 int      putchar_unlocked(int);
335 #endif
336 #if __BSD_VISIBLE
337 void     clearerr_unlocked(FILE *);
338 int      feof_unlocked(FILE *);
339 int      ferror_unlocked(FILE *);
340 int      fileno_unlocked(FILE *);
341 #endif
342
343 #if __POSIX_VISIBLE >= 200112
344 int      fseeko(FILE *, __off_t, int);
345 __off_t  ftello(FILE *);
346 #endif
347
348 #if __BSD_VISIBLE || __XSI_VISIBLE > 0 && __XSI_VISIBLE < 600
349 int      getw(FILE *);
350 int      putw(int, FILE *);
351 #endif /* BSD or X/Open before issue 6 */
352
353 #if __XSI_VISIBLE
354 char    *tempnam(const char *, const char *);
355 #endif
356
357 #if __POSIX_VISIBLE >= 200809
358 FILE    *fmemopen(void * __restrict, size_t, const char * __restrict);
359 ssize_t  getdelim(char ** __restrict, size_t * __restrict, int,
360             FILE * __restrict);
361 FILE    *open_memstream(char **, size_t *);
362 int      renameat(int, const char *, int, const char *);
363 int      vdprintf(int, const char * __restrict, __va_list);
364 /* _WITH_GETLINE to allow pre 11 sources to build on 11+ systems */
365 ssize_t  getline(char ** __restrict, size_t * __restrict, FILE * __restrict);
366 int      dprintf(int, const char * __restrict, ...);
367 #endif /* __POSIX_VISIBLE >= 200809 */
368
369 /*
370  * Routines that are purely local.
371  */
372 #if __BSD_VISIBLE
373 int      asprintf(char **, const char *, ...) __printflike(2, 3);
374 char    *ctermid_r(char *);
375 void     fcloseall(void);
376 int      fdclose(FILE *, int *);
377 char    *fgetln(FILE *, size_t *);
378 const char *fmtcheck(const char *, const char *) __format_arg(2);
379 int      fpurge(FILE *);
380 void     setbuffer(FILE *, char *, int);
381 int      setlinebuf(FILE *);
382 int      vasprintf(char **, const char *, __va_list)
383             __printflike(2, 0);
384
385 /*
386  * The system error table contains messages for the first sys_nerr
387  * positive errno values.  Use strerror() or strerror_r() from <string.h>
388  * instead.
389  */
390 extern const int sys_nerr;
391 extern const char * const sys_errlist[];
392
393 /*
394  * Stdio function-access interface.
395  */
396 FILE    *funopen(const void *,
397             int (*)(void *, char *, int),
398             int (*)(void *, const char *, int),
399             fpos_t (*)(void *, fpos_t, int),
400             int (*)(void *));
401 #define fropen(cookie, fn) funopen(cookie, fn, 0, 0, 0)
402 #define fwopen(cookie, fn) funopen(cookie, 0, fn, 0, 0)
403
404 typedef __ssize_t cookie_read_function_t(void *, char *, size_t);
405 typedef __ssize_t cookie_write_function_t(void *, const char *, size_t);
406 typedef int cookie_seek_function_t(void *, off64_t *, int);
407 typedef int cookie_close_function_t(void *);
408 typedef struct {
409         cookie_read_function_t  *read;
410         cookie_write_function_t *write;
411         cookie_seek_function_t  *seek;
412         cookie_close_function_t *close;
413 } cookie_io_functions_t;
414 FILE    *fopencookie(void *, const char *, cookie_io_functions_t);
415
416 /*
417  * Portability hacks.  See <sys/types.h>.
418  */
419 #ifndef _FTRUNCATE_DECLARED
420 #define _FTRUNCATE_DECLARED
421 int      ftruncate(int, __off_t);
422 #endif
423 #ifndef _LSEEK_DECLARED
424 #define _LSEEK_DECLARED
425 __off_t  lseek(int, __off_t, int);
426 #endif
427 #ifndef _MMAP_DECLARED
428 #define _MMAP_DECLARED
429 void    *mmap(void *, size_t, int, int, int, __off_t);
430 #endif
431 #ifndef _TRUNCATE_DECLARED
432 #define _TRUNCATE_DECLARED
433 int      truncate(const char *, __off_t);
434 #endif
435 #endif /* __BSD_VISIBLE */
436
437 /*
438  * Functions internal to the implementation.
439  */
440 int     __srget(FILE *);
441 int     __swbuf(int, FILE *);
442
443 /*
444  * The __sfoo macros are here so that we can
445  * define function versions in the C library.
446  */
447 #define __sgetc(p) (--(p)->_r < 0 ? __srget(p) : (int)(*(p)->_p++))
448 #if defined(__GNUC__) && defined(__STDC__)
449 static __inline int __sputc(int _c, FILE *_p) {
450         if (--_p->_w >= 0 || (_p->_w >= _p->_lbfsize && (char)_c != '\n'))
451                 return (*_p->_p++ = _c);
452         else
453                 return (__swbuf(_c, _p));
454 }
455 #else
456 /*
457  * This has been tuned to generate reasonable code on the vax using pcc.
458  */
459 #define __sputc(c, p) \
460         (--(p)->_w < 0 ? \
461                 (p)->_w >= (p)->_lbfsize ? \
462                         (*(p)->_p = (c)), *(p)->_p != '\n' ? \
463                                 (int)*(p)->_p++ : \
464                                 __swbuf('\n', p) : \
465                         __swbuf((int)(c), p) : \
466                 (*(p)->_p = (c), (int)*(p)->_p++))
467 #endif
468
469 extern int __isthreaded;
470
471 #ifndef __cplusplus
472
473 #define __sfeof(p)      (((p)->_flags & __SEOF) != 0)
474 #define __sferror(p)    (((p)->_flags & __SERR) != 0)
475 #define __sclearerr(p)  ((void)((p)->_flags &= ~(__SERR|__SEOF)))
476 #define __sfileno(p)    ((p)->_file)
477
478
479 #define feof(p)         (!__isthreaded ? __sfeof(p) : (feof)(p))
480 #define ferror(p)       (!__isthreaded ? __sferror(p) : (ferror)(p))
481 #define clearerr(p)     (!__isthreaded ? __sclearerr(p) : (clearerr)(p))
482
483 #if __POSIX_VISIBLE
484 #define fileno(p)       (!__isthreaded ? __sfileno(p) : (fileno)(p))
485 #endif
486
487 #define getc(fp)        (!__isthreaded ? __sgetc(fp) : (getc)(fp))
488 #define putc(x, fp)     (!__isthreaded ? __sputc(x, fp) : (putc)(x, fp))
489
490 #define getchar()       getc(stdin)
491 #define putchar(x)      putc(x, stdout)
492
493 #if __BSD_VISIBLE
494 /*
495  * See ISO/IEC 9945-1 ANSI/IEEE Std 1003.1 Second Edition 1996-07-12
496  * B.8.2.7 for the rationale behind the *_unlocked() macros.
497  */
498 #define feof_unlocked(p)        __sfeof(p)
499 #define ferror_unlocked(p)      __sferror(p)
500 #define clearerr_unlocked(p)    __sclearerr(p)
501 #define fileno_unlocked(p)      __sfileno(p)
502 #endif
503 #if __POSIX_VISIBLE >= 199506
504 #define getc_unlocked(fp)       __sgetc(fp)
505 #define putc_unlocked(x, fp)    __sputc(x, fp)
506
507 #define getchar_unlocked()      getc_unlocked(stdin)
508 #define putchar_unlocked(x)     putc_unlocked(x, stdout)
509 #endif
510 #endif /* __cplusplus */
511
512 __END_DECLS
513 #endif /* !_STDIO_H_ */