Update and reformat copyright. Protect use of weak_alias. Use _IO_*
[kopensolaris-gnu/glibc.git] / libio / libioP.h
1 /* Copyright (C) 1993, 1997 Free Software Foundation, Inc.
2    This file is part of the GNU IO Library.
3
4    This library is free software; you can redistribute it and/or
5    modify it under the terms of the GNU General Public License as
6    published by the Free Software Foundation; either version 2, or (at
7    your option) any later version.
8
9    This library is distributed in the hope that it will be useful, but
10    WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12    General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this library; see the file COPYING.  If not, write to
16    the Free Software Foundation, 59 Temple Place - Suite 330, Boston,
17    MA 02111-1307, USA.
18
19    As a special exception, if you link this library with files
20    compiled with a GNU compiler to produce an executable, this does
21    not cause the resulting executable to be covered by the GNU General
22    Public License.  This exception does not however invalidate any
23    other reasons why the executable file might be covered by the GNU
24    General Public License.  */
25
26 #include <errno.h>
27 #include <bits/libc-lock.h>
28
29 #include "iolibio.h"
30
31 __BEGIN_DECLS
32
33 #define _IO_seek_set 0
34 #define _IO_seek_cur 1
35 #define _IO_seek_end 2
36
37 /* THE JUMPTABLE FUNCTIONS.
38
39  * The _IO_FILE type is used to implement the FILE type in GNU libc,
40  * as well as the streambuf class in GNU iostreams for C++.
41  * These are all the same, just used differently.
42  * An _IO_FILE (or FILE) object is allows followed by a pointer to
43  * a jump table (of pointers to functions).  The pointer is accessed
44  * with the _IO_JUMPS macro.  The jump table has a eccentric format,
45  * so as to be compatible with the layout of a C++ virtual function table.
46  * (as implemented by g++).  When a pointer to a streambuf object is
47  * coerced to an (_IO_FILE*), then _IO_JUMPS on the result just
48  * happens to point to the virtual function table of the streambuf.
49  * Thus the _IO_JUMPS function table used for C stdio/libio does
50  * double duty as the virtual function table for C++ streambuf.
51  *
52  * The entries in the _IO_JUMPS function table (and hence also the
53  * virtual functions of a streambuf) are described below.
54  * The first parameter of each function entry is the _IO_FILE/streambuf
55  * object being acted on (i.e. the 'this' parameter).
56  */
57
58 #define _IO_JUMPS(THIS) ((struct _IO_FILE_plus *) (THIS))->vtable
59 #ifdef _G_USING_THUNKS
60 # define JUMP_FIELD(TYPE, NAME) TYPE NAME
61 # define JUMP0(FUNC, THIS) _IO_JUMPS(THIS)->FUNC (THIS)
62 # define JUMP1(FUNC, THIS, X1) _IO_JUMPS(THIS)->FUNC (THIS, X1)
63 # define JUMP2(FUNC, THIS, X1, X2) _IO_JUMPS(THIS)->FUNC (THIS, X1, X2)
64 # define JUMP3(FUNC, THIS, X1,X2,X3) _IO_JUMPS(THIS)->FUNC (THIS, X1,X2, X3)
65 # define JUMP_INIT(NAME, VALUE) VALUE
66 # define JUMP_INIT_DUMMY JUMP_INIT(dummy, 0), JUMP_INIT (dummy2, 0)
67 #else
68 /* These macros will change when we re-implement vtables to use "thunks"! */
69 # define JUMP_FIELD(TYPE, NAME) struct { short delta1, delta2; TYPE pfn; } NAME
70 # define JUMP0(FUNC, THIS) _IO_JUMPS(THIS)->FUNC.pfn (THIS)
71 # define JUMP1(FUNC, THIS, X1) _IO_JUMPS(THIS)->FUNC.pfn (THIS, X1)
72 # define JUMP2(FUNC, THIS, X1, X2) _IO_JUMPS(THIS)->FUNC.pfn (THIS, X1, X2)
73 # define JUMP3(FUNC, THIS, X1,X2,X3) _IO_JUMPS(THIS)->FUNC.pfn (THIS, X1,X2,X3)
74 # define JUMP_INIT(NAME, VALUE) {0, 0, VALUE}
75 # define JUMP_INIT_DUMMY JUMP_INIT(dummy, 0)
76 #endif
77
78 /* The 'finish' function does any final cleaning up of an _IO_FILE object.
79    It does not delete (free) it, but does everything else to finalize it/
80    It matches the streambuf::~streambuf virtual destructor.  */
81 typedef void (*_IO_finish_t) __P ((_IO_FILE *, int)); /* finalize */
82 #define _IO_FINISH(FP) JUMP1 (__finish, FP, 0)
83
84 /* The 'overflow' hook flushes the buffer.
85    The second argument is a character, or EOF.
86    It matches the streambuf::overflow virtual function. */
87 typedef int (*_IO_overflow_t) __P ((_IO_FILE *, int));
88 #define _IO_OVERFLOW(FP, CH) JUMP1 (__overflow, FP, CH)
89
90 /* The 'underflow' hook tries to fills the get buffer.
91    It returns the next character (as an unsigned char) or EOF.  The next
92    character remains in the get buffer, and the get position is not changed.
93    It matches the streambuf::underflow virtual function. */
94 typedef int (*_IO_underflow_t) __P ((_IO_FILE *));
95 #define _IO_UNDERFLOW(FP) JUMP0 (__underflow, FP)
96
97 /* The 'uflow' hook returns the next character in the input stream
98    (cast to unsigned char), and increments the read position;
99    EOF is returned on failure.
100    It matches the streambuf::uflow virtual function, which is not in the
101    cfront implementation, but was added to C++ by the ANSI/ISO committee. */
102 #define _IO_UFLOW(FP) JUMP0 (__uflow, FP)
103
104 /* The 'pbackfail' hook handles backing up.
105    It matches the streambuf::pbackfail virtual function. */
106 typedef int (*_IO_pbackfail_t) __P ((_IO_FILE *, int));
107 #define _IO_PBACKFAIL(FP, CH) JUMP1 (__pbackfail, FP, CH)
108
109 /* The 'xsputn' hook writes upto N characters from buffer DATA.
110    Returns the number of character actually written.
111    It matches the streambuf::xsputn virtual function. */
112 typedef _IO_size_t (*_IO_xsputn_t) __P ((_IO_FILE *FP, const void *DATA,
113                                          _IO_size_t N));
114 #define _IO_XSPUTN(FP, DATA, N) JUMP2 (__xsputn, FP, DATA, N)
115
116 /* The 'xsgetn' hook reads upto N characters into buffer DATA.
117    Returns the number of character actually read.
118    It matches the streambuf::xsgetn virtual function. */
119 typedef _IO_size_t (*_IO_xsgetn_t) __P ((_IO_FILE *FP, void *DATA,
120                                          _IO_size_t N));
121 #define _IO_XSGETN(FP, DATA, N) JUMP2 (__xsgetn, FP, DATA, N)
122
123 /* The 'seekoff' hook moves the stream position to a new position
124    relative to the start of the file (if DIR==0), the current position
125    (MODE==1), or the end of the file (MODE==2).
126    It matches the streambuf::seekoff virtual function.
127    It is also used for the ANSI fseek function. */
128 typedef _IO_fpos_t (*_IO_seekoff_t) __P ((_IO_FILE *FP, _IO_off_t OFF,
129                                           int DIR, int MODE));
130 #define _IO_SEEKOFF(FP, OFF, DIR, MODE) JUMP3 (__seekoff, FP, OFF, DIR, MODE)
131
132 /* The 'seekpos' hook also moves the stream position,
133    but to an absolute position given by a fpos_t (seekpos).
134    It matches the streambuf::seekpos virtual function.
135    It is also used for the ANSI fgetpos and fsetpos functions.  */
136 /* The _IO_seek_cur and _IO_seek_end options are not allowed. */
137 typedef _IO_fpos_t (*_IO_seekpos_t) __P ((_IO_FILE *, _IO_fpos_t, int));
138 #define _IO_SEEKPOS(FP, POS, FLAGS) JUMP2 (__seekpos, FP, POS, FLAGS)
139
140 /* The 'setbuf' hook gives a buffer to the file.
141    It matches the streambuf::setbuf virtual function. */
142 typedef _IO_FILE* (*_IO_setbuf_t) __P ((_IO_FILE *, char *, _IO_ssize_t));
143 #define _IO_SETBUF(FP, BUFFER, LENGTH) JUMP2 (__setbuf, FP, BUFFER, LENGTH)
144
145 /* The 'sync' hook attempts to synchronize the internal data structures
146    of the file with the external state.
147    It matches the streambuf::sync virtual function. */
148 typedef int (*_IO_sync_t) __P ((_IO_FILE *));
149 #define _IO_SYNC(FP) JUMP0 (__sync, FP)
150
151 /* The 'doallocate' hook is used to tell the file to allocate a buffer.
152    It matches the streambuf::doallocate virtual function, which is not
153    in the ANSI/ISO C++ standard, but is part traditional implementations. */
154 typedef int (*_IO_doallocate_t) __P ((_IO_FILE *));
155 #define _IO_DOALLOCATE(FP) JUMP0 (__doallocate, FP)
156
157 /* The following four hooks (sysread, syswrite, sysclose, sysseek, and
158    sysstat) are low-level hooks specific to this implementation.
159    There is no correspondence in the ANSI/ISO C++ standard library.
160    The hooks basically correspond to the Unix system functions
161    (read, write, close, lseek, and stat) except that a _IO_FILE*
162    parameter is used instead of a integer file descriptor;  the default
163    implementation used for normal files just calls those functions.
164    The advantage of overriding these functions instead of the higher-level
165    ones (underflow, overflow etc) is that you can leave all the buffering
166    higher-level functions.  */
167
168 /* The 'sysread' hook is used to read data from the external file into
169    an existing buffer.  It generalizes the Unix read(2) function.
170    It matches the streambuf::sys_read virtual function, which is
171    specific to this implementation. */
172 typedef _IO_ssize_t (*_IO_read_t) __P ((_IO_FILE *, void *, _IO_ssize_t));
173 #define _IO_SYSREAD(FP, DATA, LEN) JUMP2 (__read, FP, DATA, LEN)
174
175 /* The 'syswrite' hook is used to write data from an existing buffer
176    to an external file.  It generalizes the Unix write(2) function.
177    It matches the streambuf::sys_write virtual function, which is
178    specific to this implementation. */
179 typedef _IO_ssize_t (*_IO_write_t) __P ((_IO_FILE *,const void *,_IO_ssize_t));
180 #define _IO_SYSWRITE(FP, DATA, LEN) JUMP2 (__write, FP, DATA, LEN)
181
182 /* The 'sysseek' hook is used to re-position an external file.
183    It generalizes the Unix lseek(2) function.
184    It matches the streambuf::sys_seek virtual function, which is
185    specific to this implementation. */
186 typedef _IO_fpos_t (*_IO_seek_t) __P ((_IO_FILE *, _IO_off_t, int));
187 #define _IO_SYSSEEK(FP, OFFSET, MODE) JUMP2 (__seek, FP, OFFSET, MODE)
188
189 /* The 'sysclose' hook is used to finalize (close, finish up) an
190    external file.  It generalizes the Unix close(2) function.
191    It matches the streambuf::sys_close virtual function, which is
192    specific to this implementation. */
193 typedef int (*_IO_close_t) __P ((_IO_FILE *)); /* finalize */
194 #define _IO_SYSCLOSE(FP) JUMP0 (__close, FP)
195
196 /* The 'sysstat' hook is used to get information about an external file
197    into a struct stat buffer.  It generalizes the Unix fstat(2) call.
198    It matches the streambuf::sys_stat virtual function, which is
199    specific to this implementation. */
200 typedef int (*_IO_stat_t) __P ((_IO_FILE *, void *));
201 #define _IO_SYSSTAT(FP, BUF) JUMP1 (__stat, FP, BUF)
202
203
204 #define _IO_CHAR_TYPE char /* unsigned char ? */
205 #define _IO_INT_TYPE int
206
207 struct _IO_jump_t
208 {
209     JUMP_FIELD(_G_size_t, __dummy);
210 #ifdef _G_USING_THUNKS
211     JUMP_FIELD(_G_size_t, __dummy2);
212 #endif
213     JUMP_FIELD(_IO_finish_t, __finish);
214     JUMP_FIELD(_IO_overflow_t, __overflow);
215     JUMP_FIELD(_IO_underflow_t, __underflow);
216     JUMP_FIELD(_IO_underflow_t, __uflow);
217     JUMP_FIELD(_IO_pbackfail_t, __pbackfail);
218     /* showmany */
219     JUMP_FIELD(_IO_xsputn_t, __xsputn);
220     JUMP_FIELD(_IO_xsgetn_t, __xsgetn);
221     JUMP_FIELD(_IO_seekoff_t, __seekoff);
222     JUMP_FIELD(_IO_seekpos_t, __seekpos);
223     JUMP_FIELD(_IO_setbuf_t, __setbuf);
224     JUMP_FIELD(_IO_sync_t, __sync);
225     JUMP_FIELD(_IO_doallocate_t, __doallocate);
226     JUMP_FIELD(_IO_read_t, __read);
227     JUMP_FIELD(_IO_write_t, __write);
228     JUMP_FIELD(_IO_seek_t, __seek);
229     JUMP_FIELD(_IO_close_t, __close);
230     JUMP_FIELD(_IO_stat_t, __stat);
231 #if 0
232     get_column;
233     set_column;
234 #endif
235 };
236
237 /* We always allocate an extra word following an _IO_FILE.
238    This contains a pointer to the function jump table used.
239    This is for compatibility with C++ streambuf; the word can
240    be used to smash to a pointer to a virtual function table. */
241
242 struct _IO_FILE_plus
243 {
244   _IO_FILE file;
245   const struct _IO_jump_t *vtable;
246 };
247
248 /* Generic functions */
249
250 extern _IO_fpos_t _IO_seekoff __P ((_IO_FILE *, _IO_off_t, int, int));
251 extern _IO_fpos_t _IO_seekpos __P ((_IO_FILE *, _IO_fpos_t, int));
252
253 extern void _IO_switch_to_main_get_area __P ((_IO_FILE *));
254 extern void _IO_switch_to_backup_area __P ((_IO_FILE *));
255 extern int _IO_switch_to_get_mode __P ((_IO_FILE *));
256 extern void _IO_init __P ((_IO_FILE *, int));
257 extern int _IO_sputbackc __P ((_IO_FILE *, int));
258 extern int _IO_sungetc __P ((_IO_FILE *));
259 extern void _IO_un_link __P ((_IO_FILE *));
260 extern void _IO_link_in __P ((_IO_FILE *));
261 extern void _IO_doallocbuf __P ((_IO_FILE *));
262 extern void _IO_unsave_markers __P ((_IO_FILE *));
263 extern void _IO_setb __P ((_IO_FILE *, char *, char *, int));
264 extern unsigned _IO_adjust_column __P ((unsigned, const char *, int));
265 #define _IO_sputn(__fp, __s, __n) _IO_XSPUTN (__fp, __s, __n)
266
267 /* Marker-related function. */
268
269 extern void _IO_init_marker __P ((struct _IO_marker *, _IO_FILE *));
270 extern void _IO_remove_marker __P ((struct _IO_marker *));
271 extern int _IO_marker_difference __P ((struct _IO_marker *,
272                                        struct _IO_marker *));
273 extern int _IO_marker_delta __P ((struct _IO_marker *));
274 extern int _IO_seekmark __P ((_IO_FILE *, struct _IO_marker *, int));
275
276 /* Default jumptable functions. */
277
278 extern int _IO_default_underflow __P ((_IO_FILE *));
279 extern int _IO_default_uflow __P ((_IO_FILE *));
280 extern int _IO_default_doallocate __P ((_IO_FILE *));
281 extern void _IO_default_finish __P ((_IO_FILE *, int));
282 extern int _IO_default_pbackfail __P ((_IO_FILE *, int));
283 extern _IO_FILE* _IO_default_setbuf __P ((_IO_FILE *, char *, _IO_ssize_t));
284 extern _IO_size_t _IO_default_xsputn __P ((_IO_FILE *, const void *,
285                                            _IO_size_t));
286 extern _IO_size_t _IO_default_xsgetn __P ((_IO_FILE *, void *, _IO_size_t));
287 extern _IO_fpos_t _IO_default_seekoff __P ((_IO_FILE *, _IO_off_t, int, int));
288 extern _IO_fpos_t _IO_default_seekpos __P ((_IO_FILE *, _IO_fpos_t, int));
289 extern _IO_ssize_t _IO_default_write __P ((_IO_FILE *, const void *,
290                                            _IO_ssize_t));
291 extern _IO_ssize_t _IO_default_read __P ((_IO_FILE *, void *, _IO_ssize_t));
292 extern int _IO_default_stat __P ((_IO_FILE *, void *));
293 extern _IO_fpos_t _IO_default_seek __P ((_IO_FILE *, _IO_off_t, int));
294 extern int _IO_default_sync __P ((_IO_FILE *));
295 #define _IO_default_close ((_IO_close_t) _IO_default_sync)
296
297 extern struct _IO_jump_t _IO_file_jumps;
298 extern struct _IO_jump_t _IO_streambuf_jumps;
299 extern struct _IO_jump_t _IO_proc_jumps;
300 extern struct _IO_jump_t _IO_str_jumps;
301 extern int _IO_do_write __P ((_IO_FILE *, const char *, _IO_size_t));
302 extern int _IO_flush_all __P ((void));
303 extern void _IO_cleanup __P ((void));
304 extern void _IO_flush_all_linebuffered __P ((void));
305
306 #define _IO_do_flush(_f) \
307   _IO_do_write(_f, (_f)->_IO_write_base, \
308                (_f)->_IO_write_ptr-(_f)->_IO_write_base)
309 #define _IO_in_put_mode(_fp) ((_fp)->_flags & _IO_CURRENTLY_PUTTING)
310 #define _IO_mask_flags(fp, f, mask) \
311        ((fp)->_flags = ((fp)->_flags & ~(mask)) | ((f) & (mask)))
312 #define _IO_setg(fp, eb, g, eg)  ((fp)->_IO_read_base = (eb),\
313         (fp)->_IO_read_ptr = (g), (fp)->_IO_read_end = (eg))
314 #define _IO_setp(__fp, __p, __ep) \
315        ((__fp)->_IO_write_base = (__fp)->_IO_write_ptr = __p, (__fp)->_IO_write_end = (__ep))
316 #define _IO_have_backup(fp) ((fp)->_IO_save_base != NULL)
317 #define _IO_in_backup(fp) ((fp)->_flags & _IO_IN_BACKUP)
318 #define _IO_have_markers(fp) ((fp)->_markers != NULL)
319 #define _IO_blen(fp) ((fp)->_IO_buf_end - (fp)->_IO_buf_base)
320
321 /* Jumptable functions for files. */
322
323 extern int _IO_file_doallocate __P ((_IO_FILE *));
324 extern _IO_FILE* _IO_file_setbuf __P ((_IO_FILE *, char *, _IO_ssize_t));
325 extern _IO_fpos_t _IO_file_seekoff __P ((_IO_FILE *, _IO_off_t, int, int));
326 extern _IO_size_t _IO_file_xsputn __P ((_IO_FILE *, const void *, _IO_size_t));
327 extern int _IO_file_stat __P ((_IO_FILE *, void *));
328 extern int _IO_file_close __P ((_IO_FILE *));
329 extern int _IO_file_underflow __P ((_IO_FILE *));
330 extern int _IO_file_overflow __P ((_IO_FILE *, int));
331 #define _IO_file_is_open(__fp) ((__fp)->_fileno >= 0)
332 extern void _IO_file_init __P ((_IO_FILE *));
333 extern _IO_FILE* _IO_file_attach __P ((_IO_FILE *, int));
334 extern _IO_FILE* _IO_file_fopen __P ((_IO_FILE *, const char *, const char *));
335 extern _IO_ssize_t _IO_file_write __P ((_IO_FILE *, const void *,
336                                         _IO_ssize_t));
337 extern _IO_ssize_t _IO_file_read __P ((_IO_FILE *, void *, _IO_ssize_t));
338 extern int _IO_file_sync __P ((_IO_FILE *));
339 extern int _IO_file_close_it __P ((_IO_FILE *));
340 extern _IO_fpos_t _IO_file_seek __P ((_IO_FILE *, _IO_off_t, int));
341 extern void _IO_file_finish __P ((_IO_FILE *, int));
342
343 /* Jumptable functions for proc_files. */
344 extern _IO_FILE* _IO_proc_open __P ((_IO_FILE *, const char *, const char *));
345 extern int _IO_proc_close __P ((_IO_FILE *));
346
347 /* Jumptable functions for strfiles. */
348 extern int _IO_str_underflow __P ((_IO_FILE *));
349 extern int _IO_str_overflow __P ((_IO_FILE *, int));
350 extern int _IO_str_pbackfail __P ((_IO_FILE *, int));
351 extern _IO_fpos_t _IO_str_seekoff __P ((_IO_FILE *, _IO_off_t, int, int));
352 extern void _IO_str_finish __P ((_IO_FILE *, int));
353
354 /* Other strfile functions */
355 extern void _IO_str_init_static __P ((_IO_FILE *, char *, int, char *));
356 extern void _IO_str_init_readonly __P ((_IO_FILE *, const char *, int));
357 extern _IO_ssize_t _IO_str_count __P ((_IO_FILE *));
358
359 extern int _IO_vasprintf __P ((char **result_ptr, __const char *format,
360                                _IO_va_list args));
361 extern int _IO_vdprintf __P ((int d, __const char *format, _IO_va_list arg));
362 extern int _IO_vsnprintf __P ((char *string, _IO_size_t maxlen,
363                                __const char *format, _IO_va_list args));
364
365
366 extern _IO_size_t _IO_getline __P ((_IO_FILE *,char *, _IO_size_t, int, int));
367 extern _IO_ssize_t _IO_getdelim __P ((char **, _IO_size_t *, int, _IO_FILE *));
368 extern double _IO_strtod __P ((const char *, char **));
369 extern char *_IO_dtoa __P ((double __d, int __mode, int __ndigits,
370                             int *__decpt, int *__sign, char **__rve));
371 extern int _IO_outfloat __P ((double __value, _IO_FILE *__sb, int __type,
372                               int __width, int __precision, int __flags,
373                               int __sign_mode, int __fill));
374
375 extern _IO_FILE *_IO_list_all;
376 extern void (*_IO_cleanup_registration_needed) __P ((void));
377
378 #ifndef EOF
379 # define EOF (-1)
380 #endif
381 #ifndef NULL
382 # if defined __GNUG__ && \
383     (__GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 8))
384 #  define NULL (__null)
385 # else
386 #  if !defined(__cplusplus)
387 #   define NULL ((void*)0)
388 #  else
389 #   define NULL (0)
390 #  endif
391 # endif
392 #endif
393
394 #if _G_HAVE_MMAP
395
396 # include <unistd.h>
397 # include <fcntl.h>
398 # include <sys/mman.h>
399 # include <sys/param.h>
400
401 # if !defined(MAP_ANONYMOUS) && defined(MAP_ANON)
402 #  define MAP_ANONYMOUS MAP_ANON
403 # endif
404
405 # if !defined(MAP_ANONYMOUS) || !defined(EXEC_PAGESIZE)
406 #  undef _G_HAVE_MMAP
407 #  define _G_HAVE_MMAP 0
408 # endif
409
410 #endif /* _G_HAVE_MMAP */
411
412 #if _G_HAVE_MMAP
413
414 # ifdef _LIBC
415 /* When using this code in the GNU libc we must not pollute the name space.  */
416 #  define mmap __mmap
417 #  define munmap __munmap
418 # endif
419
420 # define ROUND_TO_PAGE(_S) \
421        (((_S) + EXEC_PAGESIZE - 1) & ~(EXEC_PAGESIZE - 1))
422
423 # define FREE_BUF(_B, _S) \
424        munmap ((_B), ROUND_TO_PAGE (_S))
425 # define ALLOC_BUF(_B, _S, _R) \
426        do {                                                                   \
427           (_B) = (char *) mmap (0, ROUND_TO_PAGE (_S),                        \
428                                 PROT_READ | PROT_WRITE,                       \
429                                 MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);          \
430           if ((_B) == (char *) -1)                                            \
431             return (_R);                                                      \
432        } while (0)
433
434 #else /* _G_HAVE_MMAP */
435
436 # define FREE_BUF(_B, _S) \
437        free(_B)
438 # define ALLOC_BUF(_B, _S, _R) \
439        do {                                                                   \
440           (_B) = (char*)malloc(_S);                                           \
441           if ((_B) == NULL)                                                   \
442             return (_R);                                                      \
443        } while (0)
444
445 #endif /* _G_HAVE_MMAP */
446
447 #ifndef OS_FSTAT
448 # define OS_FSTAT fstat
449 #endif
450 struct stat;
451 extern _IO_ssize_t _IO_read __P ((int, void *, _IO_size_t));
452 extern _IO_ssize_t _IO_write __P ((int, const void *, _IO_size_t));
453 extern _IO_off_t _IO_lseek __P ((int, _IO_off_t, int));
454 extern int _IO_close __P ((int));
455 extern int _IO_fstat __P ((int, struct stat *));
456 extern int _IO_vscanf __P ((const char *, _IO_va_list));
457
458 /* Operations on _IO_fpos_t.
459    Normally, these are trivial, but we provide hooks for configurations
460    where an _IO_fpos_t is a struct.
461    Note that _IO_off_t must be an integral type. */
462
463 /* _IO_pos_BAD is an _IO_fpos_t value indicating error, unknown, or EOF. */
464 #ifndef _IO_pos_BAD
465 # define _IO_pos_BAD ((_IO_fpos_t) -1)
466 #endif
467 /* _IO_pos_as_off converts an _IO_fpos_t value to an _IO_off_t value. */
468 #ifndef _IO_pos_as_off
469 # define _IO_pos_as_off(__pos) ((_IO_off_t) (__pos))
470 #endif
471 /* _IO_pos_adjust adjust an _IO_fpos_t by some number of bytes. */
472 #ifndef _IO_pos_adjust
473 # define _IO_pos_adjust(__pos, __delta) ((__pos) += (__delta))
474 #endif
475 /* _IO_pos_0 is an _IO_fpos_t value indicating beginning of file. */
476 #ifndef _IO_pos_0
477 # define _IO_pos_0 ((_IO_fpos_t) 0)
478 #endif
479
480 __END_DECLS
481
482 #ifdef _IO_MTSAFE_IO
483 /* check following! */
484 # define FILEBUF_LITERAL(CHAIN, FLAGS, FD) \
485        { _IO_MAGIC+_IO_LINKED+_IO_IS_FILEBUF+FLAGS, \
486          0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, CHAIN, FD, \
487            0, 0, 0, 0, { 0 }, &_IO_stdfile_##FD##_lock }
488 #else
489 /* check following! */
490 # define FILEBUF_LITERAL(CHAIN, FLAGS, FD) \
491        { _IO_MAGIC+_IO_LINKED+_IO_IS_FILEBUF+FLAGS, \
492            0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, CHAIN, FD }
493 #endif
494
495 /* VTABLE_LABEL defines NAME as of the CLASS class.
496    CNLENGTH is strlen(#CLASS).  */
497 #ifdef __GNUC__
498 # if _G_VTABLE_LABEL_HAS_LENGTH
499 #  define VTABLE_LABEL(NAME, CLASS, CNLENGTH) \
500   extern char NAME[] asm (_G_VTABLE_LABEL_PREFIX #CNLENGTH #CLASS);
501 # else
502 #  define VTABLE_LABEL(NAME, CLASS, CNLENGTH) \
503   extern char NAME[] asm (_G_VTABLE_LABEL_PREFIX #CLASS);
504 # endif
505 #endif /* __GNUC__ */
506
507 #if !defined(builtinbuf_vtable) && defined(__cplusplus)
508 # ifdef __GNUC__
509 VTABLE_LABEL(builtinbuf_vtable, builtinbuf, 10)
510 # else
511 #  if _G_VTABLE_LABEL_HAS_LENGTH
512 #   define builtinbuf_vtable _G_VTABLE_LABEL_PREFIX_ID##10builtinbuf
513 #  else
514 #   define builtinbuf_vtable _G_VTABLE_LABEL_PREFIX_ID##builtinbuf
515 #  endif
516 # endif
517 #endif /* !defined(builtinbuf_vtable) && defined(__cplusplus) */
518
519 #if defined(__STDC__) || defined(__cplusplus)
520 # define _IO_va_start(args, last) va_start(args, last)
521 #else
522 # define _IO_va_start(args, last) va_start(args)
523 #endif
524
525 extern struct _IO_fake_stdiobuf _IO_stdin_buf, _IO_stdout_buf, _IO_stderr_buf;
526
527 #if 1
528 # define COERCE_FILE(FILE) /* Nothing */
529 #else
530 /* This is part of the kludge for binary compatibility with old stdio. */
531 # define COERCE_FILE(FILE) \
532   (((FILE)->_IO_file_flags & _IO_MAGIC_MASK) == _OLD_MAGIC_MASK \
533     && (FILE) = *(FILE**)&((int*)fp)[1])
534 #endif
535
536 #ifdef EINVAL
537 # define MAYBE_SET_EINVAL __set_errno (EINVAL)
538 #else
539 # define MAYBE_SET_EINVAL /* nothing */
540 #endif
541
542 #ifdef IO_DEBUG
543 # define CHECK_FILE(FILE, RET) \
544         if ((FILE) == NULL) { MAYBE_SET_EINVAL; return RET; } \
545         else { COERCE_FILE(FILE); \
546                if (((FILE)->_IO_file_flags & _IO_MAGIC_MASK) != _IO_MAGIC) \
547           { MAYBE_SET_EINVAL; return RET; }}
548 #else
549 # define CHECK_FILE(FILE, RET) COERCE_FILE (FILE)
550 #endif