vfs: check userland buffers before reading them.
[haiku.git] / src / system / libroot / posix / glibc / libio / libio.h
blob45eff3d258ea8c1156fc2820202e24dc66b9f2c8
1 /* Copyright (C) 1991-1995, 1997-2001, 2002 Free Software Foundation, Inc.
2 This file is part of the GNU C Library.
3 Written by Per Bothner <bothner@cygnus.com>.
5 The GNU C Library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Lesser General Public
7 License as published by the Free Software Foundation; either
8 version 2.1 of the License, or (at your option) any later version.
10 The GNU C Library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public
16 License along with the GNU C Library; if not, write to the Free
17 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
18 02111-1307 USA.
20 As a special exception, if you link the code in this file with
21 files compiled with a GNU compiler to produce an executable,
22 that does not cause the resulting executable to be covered by
23 the GNU Lesser General Public License. This exception does not
24 however invalidate any other reasons why the executable file
25 might be covered by the GNU Lesser General Public License.
26 This exception applies to code released by its copyright holders
27 in files containing the exception. */
29 #ifndef _IO_STDIO_H
30 #define _IO_STDIO_H
32 #include <_G_config.h>
33 /* ALL of these should be defined in _G_config.h */
34 #define _IO_pos_t _G_fpos_t /* obsolete */
35 #define _IO_fpos_t _G_fpos_t
36 #define _IO_fpos64_t _G_fpos64_t
37 #define _IO_size_t _G_size_t
38 #define _IO_ssize_t _G_ssize_t
39 #define _IO_off_t _G_off_t
40 #define _IO_off64_t _G_off64_t
41 #define _IO_pid_t _G_pid_t
42 #define _IO_uid_t _G_uid_t
43 #define _IO_iconv_t _G_iconv_t
44 #define _IO_HAVE_SYS_WAIT _G_HAVE_SYS_WAIT
45 #define _IO_HAVE_ST_BLKSIZE _G_HAVE_ST_BLKSIZE
46 #define _IO_BUFSIZ _G_BUFSIZ
47 #define _IO_va_list _G_va_list
48 #define _IO_wint_t _G_wint_t
49 #define __mbstate_t __c_mbstate_t
51 #ifdef _G_NEED_STDARG_H
52 /* This define avoids name pollution if we're using GNU stdarg.h */
53 # define __need___va_list
54 # include <stdarg.h>
55 # ifdef __GNUC_VA_LIST
56 # undef _IO_va_list
57 # define _IO_va_list __gnuc_va_list
58 # endif /* __GNUC_VA_LIST */
59 #endif
61 #ifndef __P
62 # if _G_HAVE_SYS_CDEFS
63 # include <sys/cdefs.h>
64 # else
65 # ifdef __STDC__
66 # define __P(p) p
67 # define __PMT(p) p
68 # else
69 # define __P(p) ()
70 # define __PMT(p) ()
71 # endif
72 # endif
73 #endif /*!__P*/
75 /* For backward compatibility */
76 #ifndef _PARAMS
77 # define _PARAMS(protos) __P(protos)
78 #endif /*!_PARAMS*/
80 #ifndef __STDC__
81 # ifndef const
82 # define const
83 # endif
84 #endif
85 #define _IO_UNIFIED_JUMPTABLES 1
86 #ifndef _G_HAVE_PRINTF_FP
87 # define _IO_USE_DTOA 1
88 #endif
90 #ifndef EOF
91 # define EOF (-1)
92 #endif
93 #ifndef NULL
94 # if defined __GNUG__ && \
95 (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 8))
96 # define NULL (__null)
97 # else
98 # if !defined(__cplusplus)
99 # define NULL ((void*)0)
100 # else
101 # define NULL (0)
102 # endif
103 # endif
104 #endif
106 #define _IOS_INPUT 1
107 #define _IOS_OUTPUT 2
108 #define _IOS_ATEND 4
109 #define _IOS_APPEND 8
110 #define _IOS_TRUNC 16
111 #define _IOS_NOCREATE 32
112 #define _IOS_NOREPLACE 64
113 #define _IOS_BIN 128
115 /* Magic numbers and bits for the _flags field.
116 The magic numbers use the high-order bits of _flags;
117 the remaining bits are available for variable flags.
118 Note: The magic numbers must all be negative if stdio
119 emulation is desired. */
121 #define _IO_MAGIC 0xFBAD0000 /* Magic number */
122 #define _OLD_STDIO_MAGIC 0xFABC0000 /* Emulate old stdio. */
123 #define _IO_MAGIC_MASK 0xFFFF0000
124 #define _IO_USER_BUF 1 /* User owns buffer; don't delete it on close. */
125 #define _IO_UNBUFFERED 2
126 #define _IO_NO_READS 4 /* Reading not allowed */
127 #define _IO_NO_WRITES 8 /* Writing not allowd */
128 #define _IO_EOF_SEEN 0x10
129 #define _IO_ERR_SEEN 0x20
130 #define _IO_DELETE_DONT_CLOSE 0x40 /* Don't call close(_fileno) on cleanup. */
131 #define _IO_LINKED 0x80 /* Set if linked (using _chain) to streambuf::_list_all.*/
132 #define _IO_IN_BACKUP 0x100
133 #define _IO_LINE_BUF 0x200
134 #define _IO_TIED_PUT_GET 0x400 /* Set if put and get pointer logicly tied. */
135 #define _IO_CURRENTLY_PUTTING 0x800
136 #define _IO_IS_APPENDING 0x1000
137 #define _IO_IS_FILEBUF 0x2000
138 #define _IO_BAD_SEEN 0x4000
139 #define _IO_USER_LOCK 0x8000
141 #define _IO_FLAGS2_MMAP 1
142 #define _IO_FLAGS2_USER_WBUF 8
144 /* These are "formatting flags" matching the iostream fmtflags enum values. */
145 #define _IO_SKIPWS 01
146 #define _IO_LEFT 02
147 #define _IO_RIGHT 04
148 #define _IO_INTERNAL 010
149 #define _IO_DEC 020
150 #define _IO_OCT 040
151 #define _IO_HEX 0100
152 #define _IO_SHOWBASE 0200
153 #define _IO_SHOWPOINT 0400
154 #define _IO_UPPERCASE 01000
155 #define _IO_SHOWPOS 02000
156 #define _IO_SCIENTIFIC 04000
157 #define _IO_FIXED 010000
158 #define _IO_UNITBUF 020000
159 #define _IO_STDIO 040000
160 #define _IO_DONT_CLOSE 0100000
161 #define _IO_BOOLALPHA 0200000
164 struct _IO_jump_t; struct _IO_FILE;
166 /* Handle lock. */
167 #ifdef _IO_MTSAFE_IO
168 # if defined __GLIBC__ && __GLIBC__ >= 2
169 # include <bits/stdio-lock.h>
170 # else
171 /*# include <comthread.h>*/
172 # endif
173 #else
174 typedef void _IO_lock_t;
175 #endif
178 /* A streammarker remembers a position in a buffer. */
180 struct _IO_marker {
181 struct _IO_marker *_next;
182 struct _IO_FILE *_sbuf;
183 /* If _pos >= 0
184 it points to _buf->Gbase()+_pos. FIXME comment */
185 /* if _pos < 0, it points to _buf->eBptr()+_pos. FIXME comment */
186 int _pos;
187 #if 0
188 void set_streampos(streampos sp) { _spos = sp; }
189 void set_offset(int offset) { _pos = offset; _spos = (streampos)(-2); }
190 public:
191 streammarker(streambuf *sb);
192 ~streammarker();
193 int saving() { return _spos == -2; }
194 int delta(streammarker&);
195 int delta();
196 #endif
199 /* This is the structure from the libstdc++ codecvt class. */
200 enum __codecvt_result
202 __codecvt_ok,
203 __codecvt_partial,
204 __codecvt_error,
205 __codecvt_noconv
208 #if defined _LIBC || defined _GLIBCPP_USE_WCHAR_T
209 /* The order of the elements in the following struct must match the order
210 of the virtual functions in the libstdc++ codecvt class. */
211 struct _IO_codecvt
213 void (*__codecvt_destr) (struct _IO_codecvt *);
214 enum __codecvt_result (*__codecvt_do_out) (struct _IO_codecvt *,
215 __mbstate_t *,
216 const wchar_t *,
217 const wchar_t *,
218 const wchar_t **, char *,
219 char *, char **);
220 enum __codecvt_result (*__codecvt_do_unshift) (struct _IO_codecvt *,
221 __mbstate_t *, char *,
222 char *, char **);
223 enum __codecvt_result (*__codecvt_do_in) (struct _IO_codecvt *,
224 __mbstate_t *,
225 const char *, const char *,
226 const char **, wchar_t *,
227 wchar_t *, wchar_t **);
228 int (*__codecvt_do_encoding) (struct _IO_codecvt *);
229 int (*__codecvt_do_always_noconv) (struct _IO_codecvt *);
230 int (*__codecvt_do_length) (struct _IO_codecvt *, __mbstate_t *,
231 const char *, const char *, _IO_size_t);
232 int (*__codecvt_do_max_length) (struct _IO_codecvt *);
234 _IO_iconv_t __cd_in;
235 _IO_iconv_t __cd_out;
238 /* Extra data for wide character streams. */
239 struct _IO_wide_data
241 wchar_t *_IO_read_ptr; /* Current read pointer */
242 wchar_t *_IO_read_end; /* End of get area. */
243 wchar_t *_IO_read_base; /* Start of putback+get area. */
244 wchar_t *_IO_write_base; /* Start of put area. */
245 wchar_t *_IO_write_ptr; /* Current put pointer. */
246 wchar_t *_IO_write_end; /* End of put area. */
247 wchar_t *_IO_buf_base; /* Start of reserve area. */
248 wchar_t *_IO_buf_end; /* End of reserve area. */
249 /* The following fields are used to support backing up and undo. */
250 wchar_t *_IO_save_base; /* Pointer to start of non-current get area. */
251 wchar_t *_IO_backup_base; /* Pointer to first valid character of
252 backup area */
253 wchar_t *_IO_save_end; /* Pointer to end of non-current get area. */
255 __mbstate_t _IO_state;
256 __mbstate_t _IO_last_state;
257 struct _IO_codecvt _codecvt;
259 wchar_t _shortbuf[1];
261 struct _IO_jump_t *_wide_vtable;
263 #endif
265 struct _IO_FILE {
266 int _flags; /* High-order word is _IO_MAGIC; rest is flags. */
267 #define _IO_file_flags _flags
269 /* The following pointers correspond to the C++ streambuf protocol. */
270 /* Note: Tk uses the _IO_read_ptr and _IO_read_end fields directly. */
271 char* _IO_read_ptr; /* Current read pointer */
272 char* _IO_read_end; /* End of get area. */
273 char* _IO_read_base; /* Start of putback+get area. */
274 char* _IO_write_base; /* Start of put area. */
275 char* _IO_write_ptr; /* Current put pointer. */
276 char* _IO_write_end; /* End of put area. */
277 char* _IO_buf_base; /* Start of reserve area. */
278 char* _IO_buf_end; /* End of reserve area. */
279 /* The following fields are used to support backing up and undo. */
280 char *_IO_save_base; /* Pointer to start of non-current get area. */
281 char *_IO_backup_base; /* Pointer to first valid character of backup area */
282 char *_IO_save_end; /* Pointer to end of non-current get area. */
284 struct _IO_marker *_markers;
286 struct _IO_FILE *_chain;
288 int _fileno;
289 #if 0
290 int _blksize;
291 #else
292 int _flags2;
293 #endif
294 _IO_off_t _old_offset; /* This used to be _offset but it's too small. */
296 #define __HAVE_COLUMN /* temporary */
297 /* 1+column number of pbase(); 0 is unknown. */
298 unsigned short _cur_column;
299 signed char _vtable_offset;
300 char _shortbuf[1];
302 /* char* _save_gptr; char* _save_egptr; */
304 _IO_lock_t *_lock;
305 #ifdef _IO_USE_OLD_IO_FILE
308 struct _IO_FILE_complete
310 struct _IO_FILE _file;
311 #endif
312 #if defined _G_IO_IO_FILE_VERSION && _G_IO_IO_FILE_VERSION == 0x20001
313 _IO_off64_t _offset;
314 # if defined _LIBC || defined _GLIBCPP_USE_WCHAR_T
315 /* Wide character stream stuff. */
316 struct _IO_codecvt *_codecvt;
317 struct _IO_wide_data *_wide_data;
318 # else
319 void *__pad1;
320 void *__pad2;
321 # endif
322 int _mode;
323 /* Make sure we don't get into trouble again. */
324 char _unused2[15 * sizeof (int) - 2 * sizeof (void *)];
325 #endif
328 #ifndef __cplusplus
329 typedef struct _IO_FILE _IO_FILE;
330 #endif
332 struct _IO_FILE_plus;
334 #if defined(_G_IO_IO_FILE_VERSION) && _G_IO_IO_FILE_VERSION == 0x20001
335 #define _IO_stdin_ _IO_2_1_stdin_
336 #define _IO_stdout_ _IO_2_1_stdout_
337 #define _IO_stderr_ _IO_2_1_stderr_
338 #endif
340 extern struct _IO_FILE_plus _IO_2_1_stdin_;
341 extern struct _IO_FILE_plus _IO_2_1_stdout_;
342 extern struct _IO_FILE_plus _IO_2_1_stderr_;
343 #ifndef _LIBC
344 #define _IO_stdin ((_IO_FILE*)(&_IO_2_1_stdin_))
345 #define _IO_stdout ((_IO_FILE*)(&_IO_2_1_stdout_))
346 #define _IO_stderr ((_IO_FILE*)(&_IO_2_1_stderr_))
347 #else
348 extern _IO_FILE *_IO_stdin attribute_hidden;
349 extern _IO_FILE *_IO_stdout attribute_hidden;
350 extern _IO_FILE *_IO_stderr attribute_hidden;
351 #endif
353 /* Functions to do I/O and file management for a stream. */
355 /* Read NBYTES bytes from COOKIE into a buffer pointed to by BUF.
356 Return number of bytes read. */
357 typedef __ssize_t __io_read_fn (void *__cookie, char *__buf, size_t __nbytes);
359 /* Write N bytes pointed to by BUF to COOKIE. Write all N bytes
360 unless there is an error. Return number of bytes written, or -1 if
361 there is an error without writing anything. If the file has been
362 opened for append (__mode.__append set), then set the file pointer
363 to the end of the file and then do the write; if not, just write at
364 the current file pointer. */
365 typedef __ssize_t __io_write_fn (void *__cookie, __const char *__buf,
366 size_t __n);
368 /* Move COOKIE's file position to *POS bytes from the
369 beginning of the file (if W is SEEK_SET),
370 the current position (if W is SEEK_CUR),
371 or the end of the file (if W is SEEK_END).
372 Set *POS to the new file position.
373 Returns zero if successful, nonzero if not. */
374 typedef int __io_seek_fn (void *__cookie, _IO_off64_t *__pos, int __w);
376 /* Close COOKIE. */
377 typedef int __io_close_fn (void *__cookie);
380 #ifdef _GNU_SOURCE
381 /* User-visible names for the above. */
382 typedef __io_read_fn cookie_read_function_t;
383 typedef __io_write_fn cookie_write_function_t;
384 typedef __io_seek_fn cookie_seek_function_t;
385 typedef __io_close_fn cookie_close_function_t;
387 /* The structure with the cookie function pointers. */
388 typedef struct
390 __io_read_fn *read; /* Read bytes. */
391 __io_write_fn *write; /* Write bytes. */
392 __io_seek_fn *seek; /* Seek/tell file position. */
393 __io_close_fn *close; /* Close file. */
394 } _IO_cookie_io_functions_t;
395 typedef _IO_cookie_io_functions_t cookie_io_functions_t;
397 struct _IO_cookie_file;
399 /* Initialize one of those. */
400 extern void _IO_cookie_init (struct _IO_cookie_file *__cfile, int __read_write,
401 void *__cookie, _IO_cookie_io_functions_t __fns);
402 #endif
405 #ifdef __cplusplus
406 extern "C" {
407 #endif
409 extern int __underflow (_IO_FILE *) __THROW;
410 extern int __uflow (_IO_FILE *) __THROW;
411 extern int __overflow (_IO_FILE *, int) __THROW;
412 extern _IO_wint_t __wunderflow (_IO_FILE *) __THROW;
413 extern _IO_wint_t __wuflow (_IO_FILE *) __THROW;
414 extern _IO_wint_t __woverflow (_IO_FILE *, _IO_wint_t) __THROW;
416 #define _IO_getc_unlocked(_fp) \
417 ((_fp)->_IO_read_ptr >= (_fp)->_IO_read_end ? __uflow (_fp) \
418 : *(unsigned char *) (_fp)->_IO_read_ptr++)
419 #define _IO_peekc_unlocked(_fp) \
420 ((_fp)->_IO_read_ptr >= (_fp)->_IO_read_end \
421 && __underflow (_fp) == EOF ? EOF \
422 : *(unsigned char *) (_fp)->_IO_read_ptr)
423 #define _IO_putc_unlocked(_ch, _fp) \
424 (((_fp)->_IO_write_ptr >= (_fp)->_IO_write_end) \
425 ? __overflow (_fp, (unsigned char) (_ch)) \
426 : (unsigned char) (*(_fp)->_IO_write_ptr++ = (_ch)))
428 #define _IO_getwc_unlocked(_fp) \
429 ((_fp)->_wide_data->_IO_read_ptr >= (_fp)->_wide_data->_IO_read_end \
430 ? __wuflow (_fp) : (_IO_wint_t) *(_fp)->_wide_data->_IO_read_ptr++)
431 #define _IO_putwc_unlocked(_wch, _fp) \
432 ((_fp)->_wide_data->_IO_write_ptr >= (_fp)->_wide_data->_IO_write_end \
433 ? __woverflow (_fp, _wch) \
434 : (_IO_wint_t) (*(_fp)->_wide_data->_IO_write_ptr++ = (_wch)))
436 #define _IO_feof_unlocked(__fp) (((__fp)->_flags & _IO_EOF_SEEN) != 0)
437 #define _IO_ferror_unlocked(__fp) (((__fp)->_flags & _IO_ERR_SEEN) != 0)
439 extern int _IO_getc (_IO_FILE *__fp) __THROW;
440 extern int _IO_putc (int __c, _IO_FILE *__fp) __THROW;
441 extern int _IO_feof (_IO_FILE *__fp) __THROW;
442 extern int _IO_ferror (_IO_FILE *__fp) __THROW;
444 extern int _IO_peekc_locked (_IO_FILE *__fp) __THROW;
446 /* This one is for Emacs. */
447 #define _IO_PENDING_OUTPUT_COUNT(_fp) \
448 ((_fp)->_IO_write_ptr - (_fp)->_IO_write_base)
450 extern void _IO_flockfile (_IO_FILE *) __THROW;
451 extern void _IO_funlockfile (_IO_FILE *) __THROW;
452 extern int _IO_ftrylockfile (_IO_FILE *) __THROW;
454 #ifdef _IO_MTSAFE_IO
455 # define _IO_peekc(_fp) _IO_peekc_locked (_fp)
456 # define _IO_flockfile(_fp) \
457 if (((_fp)->_flags & _IO_USER_LOCK) == 0) _IO_flockfile (_fp)
458 # define _IO_funlockfile(_fp) \
459 if (((_fp)->_flags & _IO_USER_LOCK) == 0) _IO_funlockfile (_fp)
460 #else
461 # define _IO_peekc(_fp) _IO_peekc_unlocked (_fp)
462 # define _IO_flockfile(_fp) /**/
463 # define _IO_funlockfile(_fp) /**/
464 # define _IO_ftrylockfile(_fp) /**/
465 # define _IO_cleanup_region_start(_fct, _fp) /**/
466 # define _IO_cleanup_region_end(_Doit) /**/
467 #endif /* !_IO_MTSAFE_IO */
469 extern int _IO_vfscanf (_IO_FILE * __restrict, const char * __restrict,
470 _IO_va_list, int *__restrict) __THROW;
471 extern int _IO_vfprintf (_IO_FILE *__restrict, const char *__restrict,
472 _IO_va_list) __THROW;
473 extern _IO_ssize_t _IO_padn (_IO_FILE *, int, _IO_ssize_t) __THROW;
474 extern _IO_size_t _IO_sgetn (_IO_FILE *, void *, _IO_size_t) __THROW;
476 extern _IO_off64_t _IO_seekoff (_IO_FILE *, _IO_off64_t, int, int) __THROW;
477 extern _IO_off64_t _IO_seekpos (_IO_FILE *, _IO_off64_t, int) __THROW;
479 extern void _IO_free_backup_area (_IO_FILE *) __THROW;
481 #if defined _LIBC || defined _GLIBCPP_USE_WCHAR_T
482 extern _IO_wint_t _IO_getwc (_IO_FILE *__fp) __THROW;
483 extern _IO_wint_t _IO_putwc (wchar_t __wc, _IO_FILE *__fp) __THROW;
484 extern int _IO_fwide (_IO_FILE *__fp, int __mode) __THROW;
485 # if __GNUC__ >= 2
486 /* While compiling glibc we have to handle compatibility with very old
487 versions. */
488 # if defined _LIBC && defined SHARED
489 # include <shlib-compat.h>
490 # if SHLIB_COMPAT (libc, GLIBC_2_0, GLIBC_2_1)
491 # define _IO_fwide_maybe_incompatible \
492 (__builtin_expect (&_IO_stdin_used == NULL, 0))
493 extern const int _IO_stdin_used;
494 weak_extern (_IO_stdin_used);
495 # endif
496 # endif
497 # ifndef _IO_fwide_maybe_incompatible
498 # define _IO_fwide_maybe_incompatible (0)
499 # endif
500 /* A special optimized version of the function above. It optimizes the
501 case of initializing an unoriented byte stream. */
502 # define _IO_fwide(__fp, __mode) \
503 ({ int __result = (__mode); \
504 if (__result < 0 && ! _IO_fwide_maybe_incompatible) \
506 if ((__fp)->_mode == 0) \
507 /* We know that all we have to do is to set the flag. */ \
508 (__fp)->_mode = -1; \
509 __result = (__fp)->_mode; \
511 else if (__builtin_constant_p (__mode) && (__mode) == 0) \
512 __result = (__fp)->_mode; \
513 else \
514 __result = _IO_fwide (__fp, __result); \
515 __result; })
516 # endif
518 extern int _IO_vfwscanf (_IO_FILE * __restrict, const wchar_t * __restrict,
519 _IO_va_list, int *__restrict) __THROW;
520 extern int _IO_vfwprintf (_IO_FILE *__restrict, const wchar_t *__restrict,
521 _IO_va_list) __THROW;
522 extern _IO_ssize_t _IO_wpadn (_IO_FILE *, wint_t, _IO_ssize_t) __THROW;
523 extern void _IO_free_wbackup_area (_IO_FILE *) __THROW;
524 #endif
526 #ifdef __cplusplus
528 #endif
530 #endif /* _IO_STDIO_H */