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