1/* Copyright (C) 1993-2020 Free Software Foundation, Inc.
2 This file is part of the GNU C Library.
3
4 The GNU C Library is free software; you can redistribute it and/or
5 modify it under the terms of the GNU Lesser General Public
6 License as published by the Free Software Foundation; either
7 version 2.1 of the License, or (at your option) any later version.
8
9 The GNU C Library is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 Lesser General Public License for more details.
13
14 You should have received a copy of the GNU Lesser General Public
15 License along with the GNU C Library; if not, see
16 <https://www.gnu.org/licenses/>.
17
18 As a special exception, if you link the code in this file with
19 files compiled with a GNU compiler to produce an executable,
20 that does not cause the resulting executable to be covered by
21 the GNU Lesser General Public License. This exception does not
22 however invalidate any other reasons why the executable file
23 might be covered by the GNU Lesser General Public License.
24 This exception applies to code released by its copyright holders
25 in files containing the exception. */
26
27/* NOTE: libio is now exclusively used only by glibc since libstdc++ has its
28 own implementation. As a result, functions that were implemented for C++
29 (like *sputn) may no longer have C++ semantics. This is of course only
30 relevant for internal callers of these functions since these functions are
31 not intended for external use otherwise.
32
33 FIXME: All of the C++ cruft eventually needs to go away. */
34
35#ifndef _LIBIOP_H
36#define _LIBIOP_H 1
37
38#include <stddef.h>
39
40#include <errno.h>
41#include <libc-lock.h>
42
43#include <math_ldbl_opt.h>
44
45#include <stdio.h>
46#include <libio/libio.h>
47#include "iolibio.h"
48
49#include <shlib-compat.h>
50
51/* For historical reasons this is the name of the sysdeps header that
52 adjusts the libio configuration. */
53#include <_G_config.h>
54
55#define _IO_seek_set 0
56#define _IO_seek_cur 1
57#define _IO_seek_end 2
58
59/* THE JUMPTABLE FUNCTIONS.
60
61 * The _IO_FILE type is used to implement the FILE type in GNU libc,
62 * as well as the streambuf class in GNU iostreams for C++.
63 * These are all the same, just used differently.
64 * An _IO_FILE (or FILE) object is allows followed by a pointer to
65 * a jump table (of pointers to functions). The pointer is accessed
66 * with the _IO_JUMPS macro. The jump table has an eccentric format,
67 * so as to be compatible with the layout of a C++ virtual function table.
68 * (as implemented by g++). When a pointer to a streambuf object is
69 * coerced to an (FILE*), then _IO_JUMPS on the result just
70 * happens to point to the virtual function table of the streambuf.
71 * Thus the _IO_JUMPS function table used for C stdio/libio does
72 * double duty as the virtual function table for C++ streambuf.
73 *
74 * The entries in the _IO_JUMPS function table (and hence also the
75 * virtual functions of a streambuf) are described below.
76 * The first parameter of each function entry is the _IO_FILE/streambuf
77 * object being acted on (i.e. the 'this' parameter).
78 */
79
80/* Setting this macro to 1 enables the use of the _vtable_offset bias
81 in _IO_JUMPS_FUNCS, below. This is only needed for new-format
82 _IO_FILE in libc that must support old binaries (see oldfileops.c). */
83#if SHLIB_COMPAT (libc, GLIBC_2_0, GLIBC_2_1) && !defined _IO_USE_OLD_IO_FILE
84# define _IO_JUMPS_OFFSET 1
85#else
86# define _IO_JUMPS_OFFSET 0
87#endif
88
89/* Type of MEMBER in struct type TYPE. */
90#define _IO_MEMBER_TYPE(TYPE, MEMBER) __typeof__ (((TYPE){}).MEMBER)
91
92/* Essentially ((TYPE *) THIS)->MEMBER, but avoiding the aliasing
93 violation in case THIS has a different pointer type. */
94#define _IO_CAST_FIELD_ACCESS(THIS, TYPE, MEMBER) \
95 (*(_IO_MEMBER_TYPE (TYPE, MEMBER) *)(((char *) (THIS)) \
96 + offsetof(TYPE, MEMBER)))
97
98#define _IO_JUMPS(THIS) (THIS)->vtable
99#define _IO_JUMPS_FILE_plus(THIS) \
100 _IO_CAST_FIELD_ACCESS ((THIS), struct _IO_FILE_plus, vtable)
101#define _IO_WIDE_JUMPS(THIS) \
102 _IO_CAST_FIELD_ACCESS ((THIS), struct _IO_FILE, _wide_data)->_wide_vtable
103#define _IO_CHECK_WIDE(THIS) \
104 (_IO_CAST_FIELD_ACCESS ((THIS), struct _IO_FILE, _wide_data) != NULL)
105
106#if _IO_JUMPS_OFFSET
107# define _IO_JUMPS_FUNC(THIS) \
108 (IO_validate_vtable \
109 (*(struct _IO_jump_t **) ((void *) &_IO_JUMPS_FILE_plus (THIS) \
110 + (THIS)->_vtable_offset)))
111# define _IO_JUMPS_FUNC_UPDATE(THIS, VTABLE) \
112 (*(const struct _IO_jump_t **) ((void *) &_IO_JUMPS_FILE_plus (THIS) \
113 + (THIS)->_vtable_offset) = (VTABLE))
114# define _IO_vtable_offset(THIS) (THIS)->_vtable_offset
115#else
116# define _IO_JUMPS_FUNC(THIS) (IO_validate_vtable (_IO_JUMPS_FILE_plus (THIS)))
117# define _IO_JUMPS_FUNC_UPDATE(THIS, VTABLE) \
118 (_IO_JUMPS_FILE_plus (THIS) = (VTABLE))
119# define _IO_vtable_offset(THIS) 0
120#endif
121#define _IO_WIDE_JUMPS_FUNC(THIS) _IO_WIDE_JUMPS(THIS)
122#define JUMP_FIELD(TYPE, NAME) TYPE NAME
123#define JUMP0(FUNC, THIS) (_IO_JUMPS_FUNC(THIS)->FUNC) (THIS)
124#define JUMP1(FUNC, THIS, X1) (_IO_JUMPS_FUNC(THIS)->FUNC) (THIS, X1)
125#define JUMP2(FUNC, THIS, X1, X2) (_IO_JUMPS_FUNC(THIS)->FUNC) (THIS, X1, X2)
126#define JUMP3(FUNC, THIS, X1,X2,X3) (_IO_JUMPS_FUNC(THIS)->FUNC) (THIS, X1,X2, X3)
127#define JUMP_INIT(NAME, VALUE) VALUE
128#define JUMP_INIT_DUMMY JUMP_INIT(dummy, 0), JUMP_INIT (dummy2, 0)
129
130#define WJUMP0(FUNC, THIS) (_IO_WIDE_JUMPS_FUNC(THIS)->FUNC) (THIS)
131#define WJUMP1(FUNC, THIS, X1) (_IO_WIDE_JUMPS_FUNC(THIS)->FUNC) (THIS, X1)
132#define WJUMP2(FUNC, THIS, X1, X2) (_IO_WIDE_JUMPS_FUNC(THIS)->FUNC) (THIS, X1, X2)
133#define WJUMP3(FUNC, THIS, X1,X2,X3) (_IO_WIDE_JUMPS_FUNC(THIS)->FUNC) (THIS, X1,X2, X3)
134
135/* The 'finish' function does any final cleaning up of an _IO_FILE object.
136 It does not delete (free) it, but does everything else to finalize it.
137 It matches the streambuf::~streambuf virtual destructor. */
138typedef void (*_IO_finish_t) (FILE *, int); /* finalize */
139#define _IO_FINISH(FP) JUMP1 (__finish, FP, 0)
140#define _IO_WFINISH(FP) WJUMP1 (__finish, FP, 0)
141
142/* The 'overflow' hook flushes the buffer.
143 The second argument is a character, or EOF.
144 It matches the streambuf::overflow virtual function. */
145typedef int (*_IO_overflow_t) (FILE *, int);
146#define _IO_OVERFLOW(FP, CH) JUMP1 (__overflow, FP, CH)
147#define _IO_WOVERFLOW(FP, CH) WJUMP1 (__overflow, FP, CH)
148
149/* The 'underflow' hook tries to fills the get buffer.
150 It returns the next character (as an unsigned char) or EOF. The next
151 character remains in the get buffer, and the get position is not changed.
152 It matches the streambuf::underflow virtual function. */
153typedef int (*_IO_underflow_t) (FILE *);
154#define _IO_UNDERFLOW(FP) JUMP0 (__underflow, FP)
155#define _IO_WUNDERFLOW(FP) WJUMP0 (__underflow, FP)
156
157/* The 'uflow' hook returns the next character in the input stream
158 (cast to unsigned char), and increments the read position;
159 EOF is returned on failure.
160 It matches the streambuf::uflow virtual function, which is not in the
161 cfront implementation, but was added to C++ by the ANSI/ISO committee. */
162#define _IO_UFLOW(FP) JUMP0 (__uflow, FP)
163#define _IO_WUFLOW(FP) WJUMP0 (__uflow, FP)
164
165/* The 'pbackfail' hook handles backing up.
166 It matches the streambuf::pbackfail virtual function. */
167typedef int (*_IO_pbackfail_t) (FILE *, int);
168#define _IO_PBACKFAIL(FP, CH) JUMP1 (__pbackfail, FP, CH)
169#define _IO_WPBACKFAIL(FP, CH) WJUMP1 (__pbackfail, FP, CH)
170
171/* The 'xsputn' hook writes upto N characters from buffer DATA.
172 Returns EOF or the number of character actually written.
173 It matches the streambuf::xsputn virtual function. */
174typedef size_t (*_IO_xsputn_t) (FILE *FP, const void *DATA,
175 size_t N);
176#define _IO_XSPUTN(FP, DATA, N) JUMP2 (__xsputn, FP, DATA, N)
177#define _IO_WXSPUTN(FP, DATA, N) WJUMP2 (__xsputn, FP, DATA, N)
178
179/* The 'xsgetn' hook reads upto N characters into buffer DATA.
180 Returns the number of character actually read.
181 It matches the streambuf::xsgetn virtual function. */
182typedef size_t (*_IO_xsgetn_t) (FILE *FP, void *DATA, size_t N);
183#define _IO_XSGETN(FP, DATA, N) JUMP2 (__xsgetn, FP, DATA, N)
184#define _IO_WXSGETN(FP, DATA, N) WJUMP2 (__xsgetn, FP, DATA, N)
185
186/* The 'seekoff' hook moves the stream position to a new position
187 relative to the start of the file (if DIR==0), the current position
188 (MODE==1), or the end of the file (MODE==2).
189 It matches the streambuf::seekoff virtual function.
190 It is also used for the ANSI fseek function. */
191typedef off64_t (*_IO_seekoff_t) (FILE *FP, off64_t OFF, int DIR,
192 int MODE);
193#define _IO_SEEKOFF(FP, OFF, DIR, MODE) JUMP3 (__seekoff, FP, OFF, DIR, MODE)
194#define _IO_WSEEKOFF(FP, OFF, DIR, MODE) WJUMP3 (__seekoff, FP, OFF, DIR, MODE)
195
196/* The 'seekpos' hook also moves the stream position,
197 but to an absolute position given by a fpos64_t (seekpos).
198 It matches the streambuf::seekpos virtual function.
199 It is also used for the ANSI fgetpos and fsetpos functions. */
200/* The _IO_seek_cur and _IO_seek_end options are not allowed. */
201typedef off64_t (*_IO_seekpos_t) (FILE *, off64_t, int);
202#define _IO_SEEKPOS(FP, POS, FLAGS) JUMP2 (__seekpos, FP, POS, FLAGS)
203#define _IO_WSEEKPOS(FP, POS, FLAGS) WJUMP2 (__seekpos, FP, POS, FLAGS)
204
205/* The 'setbuf' hook gives a buffer to the file.
206 It matches the streambuf::setbuf virtual function. */
207typedef FILE* (*_IO_setbuf_t) (FILE *, char *, ssize_t);
208#define _IO_SETBUF(FP, BUFFER, LENGTH) JUMP2 (__setbuf, FP, BUFFER, LENGTH)
209#define _IO_WSETBUF(FP, BUFFER, LENGTH) WJUMP2 (__setbuf, FP, BUFFER, LENGTH)
210
211/* The 'sync' hook attempts to synchronize the internal data structures
212 of the file with the external state.
213 It matches the streambuf::sync virtual function. */
214typedef int (*_IO_sync_t) (FILE *);
215#define _IO_SYNC(FP) JUMP0 (__sync, FP)
216#define _IO_WSYNC(FP) WJUMP0 (__sync, FP)
217
218/* The 'doallocate' hook is used to tell the file to allocate a buffer.
219 It matches the streambuf::doallocate virtual function, which is not
220 in the ANSI/ISO C++ standard, but is part traditional implementations. */
221typedef int (*_IO_doallocate_t) (FILE *);
222#define _IO_DOALLOCATE(FP) JUMP0 (__doallocate, FP)
223#define _IO_WDOALLOCATE(FP) WJUMP0 (__doallocate, FP)
224
225/* The following four hooks (sysread, syswrite, sysclose, sysseek, and
226 sysstat) are low-level hooks specific to this implementation.
227 There is no correspondence in the ANSI/ISO C++ standard library.
228 The hooks basically correspond to the Unix system functions
229 (read, write, close, lseek, and stat) except that a FILE*
230 parameter is used instead of an integer file descriptor; the default
231 implementation used for normal files just calls those functions.
232 The advantage of overriding these functions instead of the higher-level
233 ones (underflow, overflow etc) is that you can leave all the buffering
234 higher-level functions. */
235
236/* The 'sysread' hook is used to read data from the external file into
237 an existing buffer. It generalizes the Unix read(2) function.
238 It matches the streambuf::sys_read virtual function, which is
239 specific to this implementation. */
240typedef ssize_t (*_IO_read_t) (FILE *, void *, ssize_t);
241#define _IO_SYSREAD(FP, DATA, LEN) JUMP2 (__read, FP, DATA, LEN)
242#define _IO_WSYSREAD(FP, DATA, LEN) WJUMP2 (__read, FP, DATA, LEN)
243
244/* The 'syswrite' hook is used to write data from an existing buffer
245 to an external file. It generalizes the Unix write(2) function.
246 It matches the streambuf::sys_write virtual function, which is
247 specific to this implementation. */
248typedef ssize_t (*_IO_write_t) (FILE *, const void *, ssize_t);
249#define _IO_SYSWRITE(FP, DATA, LEN) JUMP2 (__write, FP, DATA, LEN)
250#define _IO_WSYSWRITE(FP, DATA, LEN) WJUMP2 (__write, FP, DATA, LEN)
251
252/* The 'sysseek' hook is used to re-position an external file.
253 It generalizes the Unix lseek(2) function.
254 It matches the streambuf::sys_seek virtual function, which is
255 specific to this implementation. */
256typedef off64_t (*_IO_seek_t) (FILE *, off64_t, int);
257#define _IO_SYSSEEK(FP, OFFSET, MODE) JUMP2 (__seek, FP, OFFSET, MODE)
258#define _IO_WSYSSEEK(FP, OFFSET, MODE) WJUMP2 (__seek, FP, OFFSET, MODE)
259
260/* The 'sysclose' hook is used to finalize (close, finish up) an
261 external file. It generalizes the Unix close(2) function.
262 It matches the streambuf::sys_close virtual function, which is
263 specific to this implementation. */
264typedef int (*_IO_close_t) (FILE *); /* finalize */
265#define _IO_SYSCLOSE(FP) JUMP0 (__close, FP)
266#define _IO_WSYSCLOSE(FP) WJUMP0 (__close, FP)
267
268/* The 'sysstat' hook is used to get information about an external file
269 into a struct stat buffer. It generalizes the Unix fstat(2) call.
270 It matches the streambuf::sys_stat virtual function, which is
271 specific to this implementation. */
272typedef int (*_IO_stat_t) (FILE *, void *);
273#define _IO_SYSSTAT(FP, BUF) JUMP1 (__stat, FP, BUF)
274#define _IO_WSYSSTAT(FP, BUF) WJUMP1 (__stat, FP, BUF)
275
276/* The 'showmany' hook can be used to get an image how much input is
277 available. In many cases the answer will be 0 which means unknown
278 but some cases one can provide real information. */
279typedef int (*_IO_showmanyc_t) (FILE *);
280#define _IO_SHOWMANYC(FP) JUMP0 (__showmanyc, FP)
281#define _IO_WSHOWMANYC(FP) WJUMP0 (__showmanyc, FP)
282
283/* The 'imbue' hook is used to get information about the currently
284 installed locales. */
285typedef void (*_IO_imbue_t) (FILE *, void *);
286#define _IO_IMBUE(FP, LOCALE) JUMP1 (__imbue, FP, LOCALE)
287#define _IO_WIMBUE(FP, LOCALE) WJUMP1 (__imbue, FP, LOCALE)
288
289
290#define _IO_CHAR_TYPE char /* unsigned char ? */
291#define _IO_INT_TYPE int
292
293struct _IO_jump_t
294{
295 JUMP_FIELD(size_t, __dummy);
296 JUMP_FIELD(size_t, __dummy2);
297 JUMP_FIELD(_IO_finish_t, __finish);
298 JUMP_FIELD(_IO_overflow_t, __overflow);
299 JUMP_FIELD(_IO_underflow_t, __underflow);
300 JUMP_FIELD(_IO_underflow_t, __uflow);
301 JUMP_FIELD(_IO_pbackfail_t, __pbackfail);
302 /* showmany */
303 JUMP_FIELD(_IO_xsputn_t, __xsputn);
304 JUMP_FIELD(_IO_xsgetn_t, __xsgetn);
305 JUMP_FIELD(_IO_seekoff_t, __seekoff);
306 JUMP_FIELD(_IO_seekpos_t, __seekpos);
307 JUMP_FIELD(_IO_setbuf_t, __setbuf);
308 JUMP_FIELD(_IO_sync_t, __sync);
309 JUMP_FIELD(_IO_doallocate_t, __doallocate);
310 JUMP_FIELD(_IO_read_t, __read);
311 JUMP_FIELD(_IO_write_t, __write);
312 JUMP_FIELD(_IO_seek_t, __seek);
313 JUMP_FIELD(_IO_close_t, __close);
314 JUMP_FIELD(_IO_stat_t, __stat);
315 JUMP_FIELD(_IO_showmanyc_t, __showmanyc);
316 JUMP_FIELD(_IO_imbue_t, __imbue);
317};
318
319/* We always allocate an extra word following an _IO_FILE.
320 This contains a pointer to the function jump table used.
321 This is for compatibility with C++ streambuf; the word can
322 be used to smash to a pointer to a virtual function table. */
323
324struct _IO_FILE_plus
325{
326 FILE file;
327 const struct _IO_jump_t *vtable;
328};
329
330#ifdef _IO_USE_OLD_IO_FILE
331/* This structure is used by the compatibility code as if it were an
332 _IO_FILE_plus, but has enough space to initialize the _mode argument
333 of an _IO_FILE_complete. */
334struct _IO_FILE_complete_plus
335{
336 struct _IO_FILE_complete file;
337 const struct _IO_jump_t *vtable;
338};
339#endif
340
341/* Special file type for fopencookie function. */
342struct _IO_cookie_file
343{
344 struct _IO_FILE_plus __fp;
345 void *__cookie;
346 cookie_io_functions_t __io_functions;
347};
348
349FILE *_IO_fopencookie (void *cookie, const char *mode,
350 cookie_io_functions_t io_functions);
351
352
353/* Iterator type for walking global linked list of _IO_FILE objects. */
354
355typedef FILE *_IO_ITER;
356
357/* Generic functions */
358
359extern void _IO_switch_to_main_get_area (FILE *) __THROW;
360extern void _IO_switch_to_backup_area (FILE *) __THROW;
361extern int _IO_switch_to_get_mode (FILE *);
362libc_hidden_proto (_IO_switch_to_get_mode)
363extern void _IO_init_internal (FILE *, int) attribute_hidden;
364extern int _IO_sputbackc (FILE *, int) __THROW;
365libc_hidden_proto (_IO_sputbackc)
366extern int _IO_sungetc (FILE *) __THROW;
367extern void _IO_un_link (struct _IO_FILE_plus *) __THROW;
368libc_hidden_proto (_IO_un_link)
369extern void _IO_link_in (struct _IO_FILE_plus *) __THROW;
370libc_hidden_proto (_IO_link_in)
371extern void _IO_doallocbuf (FILE *) __THROW;
372libc_hidden_proto (_IO_doallocbuf)
373extern void _IO_unsave_markers (FILE *) __THROW;
374libc_hidden_proto (_IO_unsave_markers)
375extern void _IO_setb (FILE *, char *, char *, int) __THROW;
376libc_hidden_proto (_IO_setb)
377extern unsigned _IO_adjust_column (unsigned, const char *, int) __THROW;
378libc_hidden_proto (_IO_adjust_column)
379#define _IO_sputn(__fp, __s, __n) _IO_XSPUTN (__fp, __s, __n)
380
381ssize_t _IO_least_wmarker (FILE *, wchar_t *) __THROW;
382libc_hidden_proto (_IO_least_wmarker)
383extern void _IO_switch_to_main_wget_area (FILE *) __THROW;
384libc_hidden_proto (_IO_switch_to_main_wget_area)
385extern void _IO_switch_to_wbackup_area (FILE *) __THROW;
386libc_hidden_proto (_IO_switch_to_wbackup_area)
387extern int _IO_switch_to_wget_mode (FILE *);
388libc_hidden_proto (_IO_switch_to_wget_mode)
389extern void _IO_wsetb (FILE *, wchar_t *, wchar_t *, int) __THROW;
390libc_hidden_proto (_IO_wsetb)
391extern wint_t _IO_sputbackwc (FILE *, wint_t) __THROW;
392libc_hidden_proto (_IO_sputbackwc)
393extern wint_t _IO_sungetwc (FILE *) __THROW;
394extern void _IO_wdoallocbuf (FILE *) __THROW;
395libc_hidden_proto (_IO_wdoallocbuf)
396extern void _IO_unsave_wmarkers (FILE *) __THROW;
397extern unsigned _IO_adjust_wcolumn (unsigned, const wchar_t *, int) __THROW;
398extern off64_t get_file_offset (FILE *fp);
399
400/* Marker-related function. */
401
402extern void _IO_init_marker (struct _IO_marker *, FILE *);
403extern void _IO_init_wmarker (struct _IO_marker *, FILE *);
404extern void _IO_remove_marker (struct _IO_marker *) __THROW;
405extern int _IO_marker_difference (struct _IO_marker *, struct _IO_marker *)
406 __THROW;
407extern int _IO_marker_delta (struct _IO_marker *) __THROW;
408extern int _IO_wmarker_delta (struct _IO_marker *) __THROW;
409extern int _IO_seekmark (FILE *, struct _IO_marker *, int) __THROW;
410extern int _IO_seekwmark (FILE *, struct _IO_marker *, int) __THROW;
411
412/* Functions for iterating global list and dealing with its lock */
413
414extern _IO_ITER _IO_iter_begin (void) __THROW;
415libc_hidden_proto (_IO_iter_begin)
416extern _IO_ITER _IO_iter_end (void) __THROW;
417libc_hidden_proto (_IO_iter_end)
418extern _IO_ITER _IO_iter_next (_IO_ITER) __THROW;
419libc_hidden_proto (_IO_iter_next)
420extern FILE *_IO_iter_file (_IO_ITER) __THROW;
421libc_hidden_proto (_IO_iter_file)
422extern void _IO_list_lock (void) __THROW;
423libc_hidden_proto (_IO_list_lock)
424extern void _IO_list_unlock (void) __THROW;
425libc_hidden_proto (_IO_list_unlock)
426extern void _IO_list_resetlock (void) __THROW;
427libc_hidden_proto (_IO_list_resetlock)
428extern void _IO_enable_locks (void) __THROW;
429libc_hidden_proto (_IO_enable_locks)
430
431/* Default jumptable functions. */
432
433extern int _IO_default_underflow (FILE *) __THROW;
434extern int _IO_default_uflow (FILE *);
435libc_hidden_proto (_IO_default_uflow)
436extern wint_t _IO_wdefault_uflow (FILE *);
437libc_hidden_proto (_IO_wdefault_uflow)
438extern int _IO_default_doallocate (FILE *) __THROW;
439libc_hidden_proto (_IO_default_doallocate)
440extern int _IO_wdefault_doallocate (FILE *) __THROW;
441libc_hidden_proto (_IO_wdefault_doallocate)
442extern void _IO_default_finish (FILE *, int) __THROW;
443libc_hidden_proto (_IO_default_finish)
444extern void _IO_wdefault_finish (FILE *, int) __THROW;
445libc_hidden_proto (_IO_wdefault_finish)
446extern int _IO_default_pbackfail (FILE *, int) __THROW;
447libc_hidden_proto (_IO_default_pbackfail)
448extern wint_t _IO_wdefault_pbackfail (FILE *, wint_t) __THROW;
449libc_hidden_proto (_IO_wdefault_pbackfail)
450extern FILE* _IO_default_setbuf (FILE *, char *, ssize_t);
451extern size_t _IO_default_xsputn (FILE *, const void *, size_t);
452libc_hidden_proto (_IO_default_xsputn)
453extern size_t _IO_wdefault_xsputn (FILE *, const void *, size_t);
454libc_hidden_proto (_IO_wdefault_xsputn)
455extern size_t _IO_default_xsgetn (FILE *, void *, size_t);
456libc_hidden_proto (_IO_default_xsgetn)
457extern size_t _IO_wdefault_xsgetn (FILE *, void *, size_t);
458libc_hidden_proto (_IO_wdefault_xsgetn)
459extern off64_t _IO_default_seekoff (FILE *, off64_t, int, int)
460 __THROW;
461extern off64_t _IO_default_seekpos (FILE *, off64_t, int);
462extern ssize_t _IO_default_write (FILE *, const void *, ssize_t);
463extern ssize_t _IO_default_read (FILE *, void *, ssize_t);
464extern int _IO_default_stat (FILE *, void *) __THROW;
465extern off64_t _IO_default_seek (FILE *, off64_t, int) __THROW;
466extern int _IO_default_sync (FILE *) __THROW;
467#define _IO_default_close ((_IO_close_t) _IO_default_sync)
468extern int _IO_default_showmanyc (FILE *) __THROW;
469extern void _IO_default_imbue (FILE *, void *) __THROW;
470
471extern const struct _IO_jump_t _IO_file_jumps;
472libc_hidden_proto (_IO_file_jumps)
473extern const struct _IO_jump_t _IO_file_jumps_mmap attribute_hidden;
474extern const struct _IO_jump_t _IO_file_jumps_maybe_mmap attribute_hidden;
475extern const struct _IO_jump_t _IO_wfile_jumps;
476libc_hidden_proto (_IO_wfile_jumps)
477extern const struct _IO_jump_t _IO_wfile_jumps_mmap attribute_hidden;
478extern const struct _IO_jump_t _IO_wfile_jumps_maybe_mmap attribute_hidden;
479extern const struct _IO_jump_t _IO_old_file_jumps attribute_hidden;
480extern const struct _IO_jump_t _IO_streambuf_jumps;
481extern const struct _IO_jump_t _IO_old_proc_jumps attribute_hidden;
482extern const struct _IO_jump_t _IO_str_jumps attribute_hidden;
483extern const struct _IO_jump_t _IO_wstr_jumps attribute_hidden;
484extern int _IO_do_write (FILE *, const char *, size_t);
485libc_hidden_proto (_IO_do_write)
486extern int _IO_new_do_write (FILE *, const char *, size_t);
487extern int _IO_old_do_write (FILE *, const char *, size_t);
488extern int _IO_wdo_write (FILE *, const wchar_t *, size_t);
489libc_hidden_proto (_IO_wdo_write)
490extern int _IO_flush_all_lockp (int);
491extern int _IO_flush_all (void);
492libc_hidden_proto (_IO_flush_all)
493extern int _IO_cleanup (void);
494extern void _IO_flush_all_linebuffered (void);
495libc_hidden_proto (_IO_flush_all_linebuffered)
496extern int _IO_new_fgetpos (FILE *, __fpos_t *);
497extern int _IO_old_fgetpos (FILE *, __fpos_t *);
498extern int _IO_new_fsetpos (FILE *, const __fpos_t *);
499extern int _IO_old_fsetpos (FILE *, const __fpos_t *);
500extern int _IO_new_fgetpos64 (FILE *, __fpos64_t *);
501extern int _IO_old_fgetpos64 (FILE *, __fpos64_t *);
502extern int _IO_new_fsetpos64 (FILE *, const __fpos64_t *);
503extern int _IO_old_fsetpos64 (FILE *, const __fpos64_t *);
504extern void _IO_old_init (FILE *fp, int flags) __THROW;
505
506
507#define _IO_do_flush(_f) \
508 ((_f)->_mode <= 0 \
509 ? _IO_do_write(_f, (_f)->_IO_write_base, \
510 (_f)->_IO_write_ptr-(_f)->_IO_write_base) \
511 : _IO_wdo_write(_f, (_f)->_wide_data->_IO_write_base, \
512 ((_f)->_wide_data->_IO_write_ptr \
513 - (_f)->_wide_data->_IO_write_base)))
514#define _IO_old_do_flush(_f) \
515 _IO_old_do_write(_f, (_f)->_IO_write_base, \
516 (_f)->_IO_write_ptr-(_f)->_IO_write_base)
517#define _IO_in_put_mode(_fp) ((_fp)->_flags & _IO_CURRENTLY_PUTTING)
518#define _IO_mask_flags(fp, f, mask) \
519 ((fp)->_flags = ((fp)->_flags & ~(mask)) | ((f) & (mask)))
520#define _IO_setg(fp, eb, g, eg) ((fp)->_IO_read_base = (eb),\
521 (fp)->_IO_read_ptr = (g), (fp)->_IO_read_end = (eg))
522#define _IO_wsetg(fp, eb, g, eg) ((fp)->_wide_data->_IO_read_base = (eb),\
523 (fp)->_wide_data->_IO_read_ptr = (g), \
524 (fp)->_wide_data->_IO_read_end = (eg))
525#define _IO_setp(__fp, __p, __ep) \
526 ((__fp)->_IO_write_base = (__fp)->_IO_write_ptr \
527 = __p, (__fp)->_IO_write_end = (__ep))
528#define _IO_wsetp(__fp, __p, __ep) \
529 ((__fp)->_wide_data->_IO_write_base \
530 = (__fp)->_wide_data->_IO_write_ptr = __p, \
531 (__fp)->_wide_data->_IO_write_end = (__ep))
532#define _IO_have_backup(fp) ((fp)->_IO_save_base != NULL)
533#define _IO_have_wbackup(fp) ((fp)->_wide_data->_IO_save_base != NULL)
534#define _IO_in_backup(fp) ((fp)->_flags & _IO_IN_BACKUP)
535#define _IO_have_markers(fp) ((fp)->_markers != NULL)
536#define _IO_blen(fp) ((fp)->_IO_buf_end - (fp)->_IO_buf_base)
537#define _IO_wblen(fp) ((fp)->_wide_data->_IO_buf_end \
538 - (fp)->_wide_data->_IO_buf_base)
539
540/* Jumptable functions for files. */
541
542extern int _IO_file_doallocate (FILE *) __THROW;
543libc_hidden_proto (_IO_file_doallocate)
544extern FILE* _IO_file_setbuf (FILE *, char *, ssize_t);
545libc_hidden_proto (_IO_file_setbuf)
546extern off64_t _IO_file_seekoff (FILE *, off64_t, int, int);
547libc_hidden_proto (_IO_file_seekoff)
548extern off64_t _IO_file_seekoff_mmap (FILE *, off64_t, int, int)
549 __THROW;
550extern size_t _IO_file_xsputn (FILE *, const void *, size_t);
551libc_hidden_proto (_IO_file_xsputn)
552extern size_t _IO_file_xsgetn (FILE *, void *, size_t);
553libc_hidden_proto (_IO_file_xsgetn)
554extern int _IO_file_stat (FILE *, void *) __THROW;
555libc_hidden_proto (_IO_file_stat)
556extern int _IO_file_close (FILE *) __THROW;
557libc_hidden_proto (_IO_file_close)
558extern int _IO_file_close_mmap (FILE *) __THROW;
559extern int _IO_file_underflow (FILE *);
560libc_hidden_proto (_IO_file_underflow)
561extern int _IO_file_underflow_mmap (FILE *);
562extern int _IO_file_underflow_maybe_mmap (FILE *);
563extern int _IO_file_overflow (FILE *, int);
564libc_hidden_proto (_IO_file_overflow)
565#define _IO_file_is_open(__fp) ((__fp)->_fileno != -1)
566extern FILE* _IO_file_attach (FILE *, int);
567libc_hidden_proto (_IO_file_attach)
568extern FILE* _IO_file_open (FILE *, const char *, int, int, int, int);
569libc_hidden_proto (_IO_file_open)
570extern FILE* _IO_file_fopen (FILE *, const char *, const char *, int);
571libc_hidden_proto (_IO_file_fopen)
572extern ssize_t _IO_file_write (FILE *, const void *, ssize_t);
573extern ssize_t _IO_file_read (FILE *, void *, ssize_t);
574libc_hidden_proto (_IO_file_read)
575extern int _IO_file_sync (FILE *);
576libc_hidden_proto (_IO_file_sync)
577extern int _IO_file_close_it (FILE *);
578libc_hidden_proto (_IO_file_close_it)
579extern off64_t _IO_file_seek (FILE *, off64_t, int) __THROW;
580libc_hidden_proto (_IO_file_seek)
581extern void _IO_file_finish (FILE *, int);
582libc_hidden_proto (_IO_file_finish)
583
584extern FILE* _IO_new_file_attach (FILE *, int);
585extern int _IO_new_file_close_it (FILE *);
586extern void _IO_new_file_finish (FILE *, int);
587extern FILE* _IO_new_file_fopen (FILE *, const char *, const char *,
588 int);
589extern void _IO_no_init (FILE *, int, int, struct _IO_wide_data *,
590 const struct _IO_jump_t *) __THROW;
591extern void _IO_new_file_init_internal (struct _IO_FILE_plus *)
592 __THROW attribute_hidden;
593extern FILE* _IO_new_file_setbuf (FILE *, char *, ssize_t);
594extern FILE* _IO_file_setbuf_mmap (FILE *, char *, ssize_t);
595extern int _IO_new_file_sync (FILE *);
596extern int _IO_new_file_underflow (FILE *);
597extern int _IO_new_file_overflow (FILE *, int);
598extern off64_t _IO_new_file_seekoff (FILE *, off64_t, int, int);
599extern ssize_t _IO_new_file_write (FILE *, const void *, ssize_t);
600extern size_t _IO_new_file_xsputn (FILE *, const void *, size_t);
601
602extern FILE* _IO_old_file_setbuf (FILE *, char *, ssize_t);
603extern off64_t _IO_old_file_seekoff (FILE *, off64_t, int, int);
604extern size_t _IO_old_file_xsputn (FILE *, const void *, size_t);
605extern int _IO_old_file_underflow (FILE *);
606extern int _IO_old_file_overflow (FILE *, int);
607extern void _IO_old_file_init_internal (struct _IO_FILE_plus *)
608 __THROW attribute_hidden;
609extern FILE* _IO_old_file_attach (FILE *, int);
610extern FILE* _IO_old_file_fopen (FILE *, const char *, const char *);
611extern ssize_t _IO_old_file_write (FILE *, const void *, ssize_t);
612extern int _IO_old_file_sync (FILE *);
613extern int _IO_old_file_close_it (FILE *);
614extern void _IO_old_file_finish (FILE *, int);
615
616extern int _IO_wfile_doallocate (FILE *) __THROW;
617extern size_t _IO_wfile_xsputn (FILE *, const void *, size_t);
618libc_hidden_proto (_IO_wfile_xsputn)
619extern FILE* _IO_wfile_setbuf (FILE *, wchar_t *, ssize_t);
620extern wint_t _IO_wfile_sync (FILE *);
621libc_hidden_proto (_IO_wfile_sync)
622extern wint_t _IO_wfile_underflow (FILE *);
623libc_hidden_proto (_IO_wfile_underflow)
624extern wint_t _IO_wfile_overflow (FILE *, wint_t);
625libc_hidden_proto (_IO_wfile_overflow)
626extern off64_t _IO_wfile_seekoff (FILE *, off64_t, int, int);
627libc_hidden_proto (_IO_wfile_seekoff)
628
629/* Jumptable functions for proc_files. */
630extern FILE* _IO_proc_open (FILE *, const char *, const char *)
631 __THROW;
632extern FILE* _IO_new_proc_open (FILE *, const char *, const char *)
633 __THROW;
634extern FILE* _IO_old_proc_open (FILE *, const char *, const char *);
635extern int _IO_proc_close (FILE *) __THROW;
636extern int _IO_new_proc_close (FILE *) __THROW;
637extern int _IO_old_proc_close (FILE *);
638
639/* Jumptable functions for strfiles. */
640extern int _IO_str_underflow (FILE *) __THROW;
641libc_hidden_proto (_IO_str_underflow)
642extern int _IO_str_overflow (FILE *, int) __THROW;
643libc_hidden_proto (_IO_str_overflow)
644extern int _IO_str_pbackfail (FILE *, int) __THROW;
645libc_hidden_proto (_IO_str_pbackfail)
646extern off64_t _IO_str_seekoff (FILE *, off64_t, int, int) __THROW;
647libc_hidden_proto (_IO_str_seekoff)
648extern void _IO_str_finish (FILE *, int) __THROW;
649
650/* Other strfile functions */
651struct _IO_strfile_;
652extern ssize_t _IO_str_count (FILE *) __THROW;
653
654/* And the wide character versions. */
655extern void _IO_wstr_init_static (FILE *, wchar_t *, size_t, wchar_t *)
656 __THROW;
657extern ssize_t _IO_wstr_count (FILE *) __THROW;
658extern wint_t _IO_wstr_overflow (FILE *, wint_t) __THROW;
659extern wint_t _IO_wstr_underflow (FILE *) __THROW;
660extern off64_t _IO_wstr_seekoff (FILE *, off64_t, int, int)
661 __THROW;
662extern wint_t _IO_wstr_pbackfail (FILE *, wint_t) __THROW;
663extern void _IO_wstr_finish (FILE *, int) __THROW;
664
665/* Internal versions of v*printf that take an additional flags
666 parameter. */
667extern int __vfprintf_internal (FILE *fp, const char *format, va_list ap,
668 unsigned int mode_flags)
669 attribute_hidden;
670extern int __vfwprintf_internal (FILE *fp, const wchar_t *format, va_list ap,
671 unsigned int mode_flags)
672 attribute_hidden;
673
674extern int __vasprintf_internal (char **result_ptr, const char *format,
675 va_list ap, unsigned int mode_flags)
676 attribute_hidden;
677extern int __vdprintf_internal (int d, const char *format, va_list ap,
678 unsigned int mode_flags)
679 attribute_hidden;
680extern int __obstack_vprintf_internal (struct obstack *ob, const char *fmt,
681 va_list ap, unsigned int mode_flags)
682 attribute_hidden;
683
684/* Note: __vsprintf_internal, unlike vsprintf, does take a maxlen argument,
685 because it's called by both vsprintf and vsprintf_chk. If maxlen is
686 not set to -1, overrunning the buffer will cause a prompt crash.
687 This is the behavior of ordinary (v)sprintf functions, thus they call
688 __vsprintf_internal with that argument set to -1. */
689extern int __vsprintf_internal (char *string, size_t maxlen,
690 const char *format, va_list ap,
691 unsigned int mode_flags)
692 attribute_hidden;
693
694extern int __vsnprintf_internal (char *string, size_t maxlen,
695 const char *format, va_list ap,
696 unsigned int mode_flags)
697 attribute_hidden;
698extern int __vswprintf_internal (wchar_t *string, size_t maxlen,
699 const wchar_t *format, va_list ap,
700 unsigned int mode_flags)
701 attribute_hidden;
702
703/* Flags for __v*printf_internal.
704
705 PRINTF_LDBL_IS_DBL indicates whether long double values are to be
706 handled as having the same format as double, in which case the flag
707 should be set to one, or as another format, otherwise.
708
709 PRINTF_FORTIFY, when set to one, indicates that fortification checks
710 are to be performed in input parameters. This is used by the
711 __*printf_chk functions, which are used when _FORTIFY_SOURCE is
712 defined to 1 or 2. Otherwise, such checks are ignored.
713
714 PRINTF_CHK indicates, to the internal function being called, that the
715 call is originated from one of the __*printf_chk functions.
716
717 PRINTF_LDBL_USES_FLOAT128 is used on platforms where the long double
718 format used to be different from the IEC 60559 double format *and*
719 also different from the Quadruple 128-bits IEC 60559 format (such as
720 the IBM Extended Precision format on powerpc or the 80-bits IEC 60559
721 format on x86), but was later converted to the Quadruple 128-bits IEC
722 60559 format, which is the same format that the _Float128 always has
723 (hence the `USES_FLOAT128' suffix in the name of the flag). When set
724 to one, this macro indicates that long double values are to be
725 handled as having this new format. Otherwise, they should be handled
726 as the previous format on that platform. */
727#define PRINTF_LDBL_IS_DBL 0x0001
728#define PRINTF_FORTIFY 0x0002
729#define PRINTF_CHK 0x0004
730#define PRINTF_LDBL_USES_FLOAT128 0x0008
731
732extern size_t _IO_getline (FILE *,char *, size_t, int, int);
733libc_hidden_proto (_IO_getline)
734extern size_t _IO_getline_info (FILE *,char *, size_t,
735 int, int, int *);
736libc_hidden_proto (_IO_getline_info)
737extern ssize_t _IO_getdelim (char **, size_t *, int, FILE *);
738extern size_t _IO_getwline (FILE *,wchar_t *, size_t, wint_t, int);
739extern size_t _IO_getwline_info (FILE *,wchar_t *, size_t,
740 wint_t, int, wint_t *);
741
742extern struct _IO_FILE_plus *_IO_list_all;
743libc_hidden_proto (_IO_list_all)
744extern void (*_IO_cleanup_registration_needed) (void);
745
746extern void _IO_str_init_static_internal (struct _IO_strfile_ *, char *,
747 size_t, char *) __THROW;
748extern off64_t _IO_seekoff_unlocked (FILE *, off64_t, int, int)
749 attribute_hidden;
750extern off64_t _IO_seekpos_unlocked (FILE *, off64_t, int)
751 attribute_hidden;
752
753#if _G_HAVE_MMAP
754
755# include <unistd.h>
756# include <fcntl.h>
757# include <sys/mman.h>
758# include <sys/param.h>
759
760# if !defined(MAP_ANONYMOUS) && defined(MAP_ANON)
761# define MAP_ANONYMOUS MAP_ANON
762# endif
763
764# if !defined(MAP_ANONYMOUS) || !defined(EXEC_PAGESIZE)
765# undef _G_HAVE_MMAP
766# define _G_HAVE_MMAP 0
767# endif
768
769#endif /* _G_HAVE_MMAP */
770
771/* Flags for __vfscanf_internal and __vfwscanf_internal.
772
773 SCANF_LDBL_IS_DBL indicates whether long double values are to be
774 handled as having the same format as double, in which case the flag
775 should be set to one, or as another format, otherwise.
776
777 SCANF_ISOC99_A, when set to one, indicates that the ISO C99 or POSIX
778 behavior of the scanf functions is to be used, i.e. automatic
779 allocation for input strings with %as, %aS and %a[, a GNU extension,
780 is disabled. This is the behavior that the __isoc99_scanf family of
781 functions use. When the flag is set to zero, automatic allocation is
782 enabled.
783
784 SCANF_LDBL_USES_FLOAT128 is used on platforms where the long double
785 format used to be different from the IEC 60559 double format *and*
786 also different from the Quadruple 128-bits IEC 60559 format (such as
787 the IBM Extended Precision format on powerpc or the 80-bits IEC 60559
788 format on x86), but was later converted to the Quadruple 128-bits IEC
789 60559 format, which is the same format that the _Float128 always has
790 (hence the `USES_FLOAT128' suffix in the name of the flag). When set
791 to one, this macros indicates that long double values are to be
792 handled as having this new format. Otherwise, they should be handled
793 as the previous format on that platform. */
794#define SCANF_LDBL_IS_DBL 0x0001
795#define SCANF_ISOC99_A 0x0002
796#define SCANF_LDBL_USES_FLOAT128 0x0004
797
798extern int __vfscanf_internal (FILE *fp, const char *format, va_list argp,
799 unsigned int flags)
800 attribute_hidden;
801extern int __vfwscanf_internal (FILE *fp, const wchar_t *format, va_list argp,
802 unsigned int flags)
803 attribute_hidden;
804
805extern int _IO_vscanf (const char *, va_list) __THROW;
806
807#ifdef _IO_MTSAFE_IO
808/* check following! */
809# ifdef _IO_USE_OLD_IO_FILE
810# define FILEBUF_LITERAL(CHAIN, FLAGS, FD, WDP) \
811 { _IO_MAGIC+_IO_LINKED+_IO_IS_FILEBUF+FLAGS, \
812 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, (FILE *) CHAIN, FD, \
813 0, _IO_pos_BAD, 0, 0, { 0 }, &_IO_stdfile_##FD##_lock }
814# else
815# define FILEBUF_LITERAL(CHAIN, FLAGS, FD, WDP) \
816 { _IO_MAGIC+_IO_LINKED+_IO_IS_FILEBUF+FLAGS, \
817 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, (FILE *) CHAIN, FD, \
818 0, _IO_pos_BAD, 0, 0, { 0 }, &_IO_stdfile_##FD##_lock, _IO_pos_BAD,\
819 NULL, WDP, 0 }
820# endif
821#else
822# ifdef _IO_USE_OLD_IO_FILE
823# define FILEBUF_LITERAL(CHAIN, FLAGS, FD, WDP) \
824 { _IO_MAGIC+_IO_LINKED+_IO_IS_FILEBUF+FLAGS, \
825 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, (FILE *) CHAIN, FD, \
826 0, _IO_pos_BAD }
827# else
828# define FILEBUF_LITERAL(CHAIN, FLAGS, FD, WDP) \
829 { _IO_MAGIC+_IO_LINKED+_IO_IS_FILEBUF+FLAGS, \
830 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, (FILE *) CHAIN, FD, \
831 0, _IO_pos_BAD, 0, 0, { 0 }, 0, _IO_pos_BAD, \
832 NULL, WDP, 0 }
833# endif
834#endif
835
836#if SHLIB_COMPAT (libc, GLIBC_2_0, GLIBC_2_1)
837/* See oldstdfiles.c. These are the old stream variables. */
838extern struct _IO_FILE_plus _IO_stdin_;
839extern struct _IO_FILE_plus _IO_stdout_;
840extern struct _IO_FILE_plus _IO_stderr_;
841
842static inline bool
843_IO_legacy_file (FILE *fp)
844{
845 return fp == (FILE *) &_IO_stdin_ || fp == (FILE *) &_IO_stdout_
846 || fp == (FILE *) &_IO_stderr_;
847}
848#endif
849
850/* Deallocate a stream if it is heap-allocated. Preallocated
851 stdin/stdout/stderr streams are not deallocated. */
852static inline void
853_IO_deallocate_file (FILE *fp)
854{
855 /* The current stream variables. */
856 if (fp == (FILE *) &_IO_2_1_stdin_ || fp == (FILE *) &_IO_2_1_stdout_
857 || fp == (FILE *) &_IO_2_1_stderr_)
858 return;
859#if SHLIB_COMPAT (libc, GLIBC_2_0, GLIBC_2_1)
860 if (_IO_legacy_file (fp))
861 return;
862#endif
863 free (fp);
864}
865
866#ifdef IO_DEBUG
867# define CHECK_FILE(FILE, RET) do { \
868 if ((FILE) == NULL \
869 || ((FILE)->_flags & _IO_MAGIC_MASK) != _IO_MAGIC) \
870 { \
871 __set_errno (EINVAL); \
872 return RET; \
873 } \
874 } while (0)
875#else
876# define CHECK_FILE(FILE, RET) do { } while (0)
877#endif
878
879static inline void
880__attribute__ ((__always_inline__))
881_IO_acquire_lock_fct (FILE **p)
882{
883 FILE *fp = *p;
884 if ((fp->_flags & _IO_USER_LOCK) == 0)
885 _IO_funlockfile (fp);
886}
887
888#if !defined _IO_MTSAFE_IO && IS_IN (libc)
889# define _IO_acquire_lock(_fp) \
890 do {
891# define _IO_release_lock(_fp) \
892 } while (0)
893#endif
894
895/* Collect all vtables in a special section for vtable verification.
896 These symbols cover the extent of this section. */
897symbol_set_declare (__libc_IO_vtables)
898
899/* libio vtables need to carry this attribute so that they pass
900 validation. */
901#define libio_vtable __attribute__ ((section ("__libc_IO_vtables")))
902
903#ifdef SHARED
904/* If equal to &_IO_vtable_check (with pointer guard protection),
905 unknown vtable pointers are valid. This function pointer is solely
906 used as a flag. */
907extern void (*IO_accept_foreign_vtables) (void) attribute_hidden;
908
909/* Assigns the passed function pointer (either NULL or
910 &_IO_vtable_check) to IO_accept_foreign_vtables. */
911static inline void
912IO_set_accept_foreign_vtables (void (*flag) (void))
913{
914#ifdef PTR_MANGLE
915 PTR_MANGLE (flag);
916#endif
917 atomic_store_relaxed (&IO_accept_foreign_vtables, flag);
918}
919
920#else /* !SHARED */
921
922/* The statically-linked version does nothing. */
923static inline void
924IO_set_accept_foreign_vtables (void (*flag) (void))
925{
926}
927
928#endif
929
930/* Check if unknown vtable pointers are permitted; otherwise,
931 terminate the process. */
932void _IO_vtable_check (void) attribute_hidden;
933
934/* Perform vtable pointer validation. If validation fails, terminate
935 the process. */
936static inline const struct _IO_jump_t *
937IO_validate_vtable (const struct _IO_jump_t *vtable)
938{
939 /* Fast path: The vtable pointer is within the __libc_IO_vtables
940 section. */
941 uintptr_t section_length = __stop___libc_IO_vtables - __start___libc_IO_vtables;
942 uintptr_t ptr = (uintptr_t) vtable;
943 uintptr_t offset = ptr - (uintptr_t) __start___libc_IO_vtables;
944 if (__glibc_unlikely (offset >= section_length))
945 /* The vtable pointer is not in the expected section. Use the
946 slow path, which will terminate the process if necessary. */
947 _IO_vtable_check ();
948 return vtable;
949}
950
951/* Character set conversion. */
952
953enum __codecvt_result
954{
955 __codecvt_ok,
956 __codecvt_partial,
957 __codecvt_error,
958 __codecvt_noconv
959};
960
961enum __codecvt_result __libio_codecvt_out (struct _IO_codecvt *,
962 __mbstate_t *,
963 const wchar_t *,
964 const wchar_t *,
965 const wchar_t **, char *,
966 char *, char **)
967 attribute_hidden;
968enum __codecvt_result __libio_codecvt_in (struct _IO_codecvt *,
969 __mbstate_t *,
970 const char *, const char *,
971 const char **, wchar_t *,
972 wchar_t *, wchar_t **)
973 attribute_hidden;
974int __libio_codecvt_encoding (struct _IO_codecvt *) attribute_hidden;
975int __libio_codecvt_length (struct _IO_codecvt *, __mbstate_t *,
976 const char *, const char *, size_t)
977 attribute_hidden;
978
979#endif /* libioP.h. */
980