source: mainline/uspace/lib/c/include/stdio.h@ 64d2b10

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 64d2b10 was 9ac2013, checked in by Martin Decky <martin@…>, 15 years ago

add format checking to more printf-like functions (fault_if_from_uspace, panic_common, fprintf, snprintf, asprintf)
  • Property mode set to 100644
File size: 4.7 KB
Line 
1/*
2 * Copyright (c) 2005 Martin Decky
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/** @addtogroup libc
30 * @{
31 */
32/** @file
33 */
34
35#ifndef LIBC_STDIO_H_
36#define LIBC_STDIO_H_
37
38#include <sys/types.h>
39#include <stdarg.h>
40#include <str.h>
41#include <adt/list.h>
42
43#ifndef NVERIFY_PRINTF
44
45#define PRINTF_ATTRIBUTE(start, end) \
46 __attribute__((format(gnu_printf, start, end)))
47
48#else /* NVERIFY_PRINTF */
49
50#define PRINTF_ATTRIBUTE(start, end)
51
52#endif /* NVERIFY_PRINTF */
53
54#define EOF (-1)
55
56/** Default size for stream I/O buffers */
57#define BUFSIZ 4096
58
59#define DEBUG(fmt, ...) \
60 { \
61 char _buf[256]; \
62 int _n = snprintf(_buf, sizeof(_buf), fmt, ##__VA_ARGS__); \
63 if (_n > 0) \
64 (void) __SYSCALL3(SYS_KLOG, 1, (sysarg_t) _buf, str_size(_buf)); \
65 }
66
67#ifndef SEEK_SET
68 #define SEEK_SET 0
69#endif
70
71#ifndef SEEK_CUR
72 #define SEEK_CUR 1
73#endif
74
75#ifndef SEEK_END
76 #define SEEK_END 2
77#endif
78
79enum _buffer_type {
80 /** No buffering */
81 _IONBF,
82 /** Line buffering */
83 _IOLBF,
84 /** Full buffering */
85 _IOFBF
86};
87
88enum _buffer_state {
89 /** Buffer is empty */
90 _bs_empty,
91
92 /** Buffer contains data to be written */
93 _bs_write,
94
95 /** Buffer contains prefetched data for reading */
96 _bs_read
97};
98
99typedef struct {
100 /** Linked list pointer. */
101 link_t link;
102
103 /** Underlying file descriptor. */
104 int fd;
105
106 /** Error indicator. */
107 int error;
108
109 /** End-of-file indicator. */
110 int eof;
111
112 /** Klog indicator */
113 int klog;
114
115 /** Phone to the file provider */
116 int phone;
117
118 /**
119 * Non-zero if the stream needs sync on fflush(). XXX change
120 * console semantics so that sync is not needed.
121 */
122 int need_sync;
123
124 /** Buffering type */
125 enum _buffer_type btype;
126
127 /** Buffer */
128 uint8_t *buf;
129
130 /** Buffer size */
131 size_t buf_size;
132
133 /** Buffer state */
134 enum _buffer_state buf_state;
135
136 /** Buffer I/O pointer */
137 uint8_t *buf_head;
138
139 /** Points to end of occupied space when in read mode. */
140 uint8_t *buf_tail;
141} FILE;
142
143extern FILE *stdin;
144extern FILE *stdout;
145extern FILE *stderr;
146
147/* Character and string input functions */
148extern int fgetc(FILE *);
149extern char *fgets(char *, int, FILE *);
150
151extern int getchar(void);
152extern char *gets(char *, size_t);
153
154/* Character and string output functions */
155extern int fputc(wchar_t, FILE *);
156extern int fputs(const char *, FILE *);
157
158extern int putchar(wchar_t);
159extern int puts(const char *);
160
161/* Formatted string output functions */
162extern int fprintf(FILE *, const char*, ...)
163 PRINTF_ATTRIBUTE(2, 3);
164extern int vfprintf(FILE *, const char *, va_list);
165
166extern int printf(const char *, ...)
167 PRINTF_ATTRIBUTE(1, 2);
168extern int vprintf(const char *, va_list);
169
170extern int snprintf(char *, size_t , const char *, ...)
171 PRINTF_ATTRIBUTE(3, 4);
172extern int asprintf(char **, const char *, ...)
173 PRINTF_ATTRIBUTE(2, 3);
174extern int vsnprintf(char *, size_t, const char *, va_list);
175
176/* File stream functions */
177extern FILE *fopen(const char *, const char *);
178extern FILE *fdopen(int, const char *);
179extern int fclose(FILE *);
180
181extern size_t fread(void *, size_t, size_t, FILE *);
182extern size_t fwrite(const void *, size_t, size_t, FILE *);
183
184extern int fseek(FILE *, off64_t, int);
185extern void rewind(FILE *);
186extern off64_t ftell(FILE *);
187extern int feof(FILE *);
188extern int fileno(FILE *);
189
190extern int fflush(FILE *);
191extern int ferror(FILE *);
192extern void clearerr(FILE *);
193
194extern void setvbuf(FILE *, void *, int, size_t);
195
196/* Misc file functions */
197extern int rename(const char *, const char *);
198
199#endif
200
201/** @}
202 */
Note: See TracBrowser for help on using the repository browser.