1/* Copyright (C) 1993-2023 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#include <pointer_guard.h>
51
52/* For historical reasons this is the name of the sysdeps header that
53 adjusts the libio configuration. */
54#include <_G_config.h>
55
56#define _IO_seek_set 0
57#define _IO_seek_cur 1
58#define _IO_seek_end 2
59
60/* THE JUMPTABLE FUNCTIONS.
61
62 * The _IO_FILE type is used to implement the FILE type in GNU libc,
63 * as well as the streambuf class in GNU iostreams for C++.
64 * These are all the same, just used differently.
65 * An _IO_FILE (or FILE) object is allows followed by a pointer to
66 * a jump table (of pointers to functions). The pointer is accessed
67 * with the _IO_JUMPS macro. The jump table has an eccentric format,
68 * so as to be compatible with the layout of a C++ virtual function table.
69 * (as implemented by g++). When a pointer to a streambuf object is
70 * coerced to an (FILE*), then _IO_JUMPS on the result just
71 * happens to point to the virtual function table of the streambuf.
72 * Thus the _IO_JUMPS function table used for C stdio/libio does
73 * double duty as the virtual function table for C++ streambuf.
74 *
75 * The entries in the _IO_JUMPS function table (and hence also the
76 * virtual functions of a streambuf) are described below.
77 * The first parameter of each function entry is the _IO_FILE/streambuf
78 * object being acted on (i.e. the 'this' parameter).
79 */
80
81/* Setting this macro to 1 enables the use of the _vtable_offset bias
82 in _IO_JUMPS_FUNCS, below. This is only needed for new-format
83 _IO_FILE in libc that must support old binaries (see oldfileops.c). */
84#if SHLIB_COMPAT (libc, GLIBC_2_0, GLIBC_2_1) && !defined _IO_USE_OLD_IO_FILE
85# define _IO_JUMPS_OFFSET 1
86#else
87# define _IO_JUMPS_OFFSET 0
88#endif
89
90/* Type of MEMBER in struct type TYPE. */
91#define _IO_MEMBER_TYPE(TYPE, MEMBER) __typeof__ (((TYPE){}).MEMBER)
92
93/* Essentially ((TYPE *) THIS)->MEMBER, but avoiding the aliasing
94 violation in case THIS has a different pointer type. */
95#define _IO_CAST_FIELD_ACCESS(THIS, TYPE, MEMBER) \
96 (*(_IO_MEMBER_TYPE (TYPE, MEMBER) *)(((char *) (THIS)) \
97 + offsetof(TYPE, MEMBER)))
98
99#define _IO_JUMPS(THIS) (THIS)->vtable
100#define _IO_JUMPS_FILE_plus(THIS) \
101 _IO_CAST_FIELD_ACCESS ((THIS), struct _IO_FILE_plus, vtable)
102#define _IO_WIDE_JUMPS(THIS) \
103 _IO_CAST_FIELD_ACCESS ((THIS), struct _IO_FILE, _wide_data)->_wide_vtable
104#define _IO_CHECK_WIDE(THIS) \
105 (_IO_CAST_FIELD_ACCESS ((THIS), struct _IO_FILE, _wide_data) != NULL)
106
107#if _IO_JUMPS_OFFSET
108# define _IO_JUMPS_FUNC(THIS) \
109 (IO_validate_vtable \
110 (*(struct _IO_jump_t **) ((void *) &_IO_JUMPS_FILE_plus (THIS) \
111 + (THIS)->_vtable_offset)))
112# define _IO_JUMPS_FUNC_UPDATE(THIS, VTABLE) \
113 (*(const struct _IO_jump_t **) ((void *) &_IO_JUMPS_FILE_plus (THIS) \
114 + (THIS)->_vtable_offset) = (VTABLE))
115# define _IO_vtable_offset(THIS) (THIS)->_vtable_offset
116#else
117# define _IO_JUMPS_FUNC(THIS) (IO_validate_vtable (_IO_JUMPS_FILE_plus (THIS)))
118# define _IO_JUMPS_FUNC_UPDATE(THIS, VTABLE) \
119 (_IO_JUMPS_FILE_plus (THIS) = (VTABLE))
120# define _IO_vtable_offset(THIS) 0
121#endif
122#define _IO_WIDE_JUMPS_FUNC(THIS) _IO_WIDE_JUMPS(THIS)
123#define JUMP_FIELD(TYPE, NAME) TYPE NAME
124#define JUMP0(FUNC, THIS) (_IO_JUMPS_FUNC(THIS)->FUNC) (THIS)
125#define JUMP1(FUNC, THIS, X1) (_IO_JUMPS_FUNC(THIS)->FUNC) (THIS, X1)
126#define JUMP2(FUNC, THIS, X1, X2) (_IO_JUMPS_FUNC(THIS)->FUNC) (THIS, X1, X2)
127#define JUMP3(FUNC, THIS, X1,X2,X3) (_IO_JUMPS_FUNC(THIS)->FUNC) (THIS, X1,X2, X3)
128#define JUMP_INIT(NAME, VALUE) VALUE
129#define JUMP_INIT_DUMMY JUMP_INIT(dummy, 0), JUMP_INIT (dummy2, 0)
130
131#define WJUMP0(FUNC, THIS) (_IO_WIDE_JUMPS_FUNC(THIS)->FUNC) (THIS)
132#define WJUMP1(FUNC, THIS, X1) (_IO_WIDE_JUMPS_FUNC(THIS)->FUNC) (THIS, X1)
133#define WJUMP2(FUNC, THIS, X1, X2) (_IO_WIDE_JUMPS_FUNC(THIS)->FUNC) (THIS, X1, X2)
134#define WJUMP3(FUNC, THIS, X1,X2,X3) (_IO_WIDE_JUMPS_FUNC(THIS)->FUNC) (THIS, X1,X2, X3)
135
136/* The 'finish' function does any final cleaning up of an _IO_FILE object.
137 It does not delete (free) it, but does everything else to finalize it.
138 It matches the streambuf::~streambuf virtual destructor. */
139typedef void (*_IO_finish_t) (FILE *, int); /* finalize */
140#define _IO_FINISH(FP) JUMP1 (__finish, FP, 0)
141#define _IO_WFINISH(FP) WJUMP1 (__finish, FP, 0)
142
143/* The 'overflow' hook flushes the buffer.
144 The second argument is a character, or EOF.
145 It matches the streambuf::overflow virtual function. */
146typedef int (*_IO_overflow_t) (FILE *, int);
147#define _IO_OVERFLOW(FP, CH) JUMP1 (__overflow, FP, CH)
148#define _IO_WOVERFLOW(FP, CH) WJUMP1 (__overflow, FP, CH)
149
150/* The 'underflow' hook tries to fills the get buffer.
151 It returns the next character (as an unsigned char) or EOF. The next
152 character remains in the get buffer, and the get position is not changed.
153 It matches the streambuf::underflow virtual function. */
154typedef int (*_IO_underflow_t) (FILE *);
155#define _IO_UNDERFLOW(FP) JUMP0 (__underflow, FP)
156#define _IO_WUNDERFLOW(FP) WJUMP0 (__underflow, FP)
157
158/* The 'uflow' hook returns the next character in the input stream
159 (cast to unsigned char), and increments the read position;
160 EOF is returned on failure.
161 It matches the streambuf::uflow virtual function, which is not in the
162 cfront implementation, but was added to C++ by the ANSI/ISO committee. */
163#define _IO_UFLOW(FP) JUMP0 (__uflow, FP)
164#define _IO_WUFLOW(FP) WJUMP0 (__uflow, FP)
165
166/* The 'pbackfail' hook handles backing up.
167 It matches the streambuf::pbackfail virtual function. */
168typedef int (*_IO_pbackfail_t) (FILE *, int);
169#define _IO_PBACKFAIL(FP, CH) JUMP1 (__pbackfail, FP, CH)
170#define _IO_WPBACKFAIL(FP, CH) WJUMP1 (__pbackfail, FP, CH)
171
172/* The 'xsputn' hook writes upto N characters from buffer DATA.
173 Returns EOF or the number of character actually written.
174 It matches the streambuf::xsputn virtual function. */
175typedef size_t (*_IO_xsputn_t) (FILE *FP, const void *DATA,
176 size_t N);
177#define _IO_XSPUTN(FP, DATA, N) JUMP2 (__xsputn, FP, DATA, N)
178#define _IO_WXSPUTN(FP, DATA, N) WJUMP2 (__xsputn, FP, DATA, N)
179
180/* The 'xsgetn' hook reads upto N characters into buffer DATA.
181 Returns the number of character actually read.
182 It matches the streambuf::xsgetn virtual function. */
183typedef size_t (*_IO_xsgetn_t) (FILE *FP, void *DATA, size_t N);
184#define _IO_XSGETN(FP, DATA, N) JUMP2 (__xsgetn, FP, DATA, N)
185#define _IO_WXSGETN(FP, DATA, N) WJUMP2 (__xsgetn, FP, DATA, N)
186
187/* The 'seekoff' hook moves the stream position to a new position
188 relative to the start of the file (if DIR==0), the current position
189 (MODE==1), or the end of the file (MODE==2).
190 It matches the streambuf::seekoff virtual function.
191 It is also used for the ANSI fseek function. */
192typedef off64_t (*_IO_seekoff_t) (FILE *FP, off64_t OFF, int DIR,
193 int MODE);
194#define _IO_SEEKOFF(FP, OFF, DIR, MODE) JUMP3 (__seekoff, FP, OFF, DIR, MODE)
195#define _IO_WSEEKOFF(FP, OFF, DIR, MODE) WJUMP3 (__seekoff, FP, OFF, DIR, MODE)
196
197/* The 'seekpos' hook also moves the stream position,
198 but to an absolute position given by a fpos64_t (seekpos).
199 It matches the streambuf::seekpos virtual function.
200 It is also used for the ANSI fgetpos and fsetpos functions. */
201/* The _IO_seek_cur and _IO_seek_end options are not allowed. */
202typedef off64_t (*_IO_seekpos_t) (FILE *, off64_t, int);
203#define _IO_SEEKPOS(FP, POS, FLAGS) JUMP2 (__seekpos, FP, POS, FLAGS)
204#define _IO_WSEEKPOS(FP, POS, FLAGS) WJUMP2 (__seekpos, FP, POS, FLAGS)
205
206/* The 'setbuf' hook gives a buffer to the file.
207 It matches the streambuf::setbuf virtual function. */
208typedef FILE* (*_IO_setbuf_t) (FILE *, char *, ssize_t);
209#define _IO_SETBUF(FP, BUFFER, LENGTH) JUMP2 (__setbuf, FP, BUFFER, LENGTH)
210#define _IO_WSETBUF(FP, BUFFER, LENGTH) WJUMP2 (__setbuf, FP, BUFFER, LENGTH)
211
212/* The 'sync' hook attempts to synchronize the internal data structures
213 of the file with the external state.
214 It matches the streambuf::sync virtual function. */
215typedef int (*_IO_sync_t) (FILE *);
216#define _IO_SYNC(FP) JUMP0 (__sync, FP)
217#define _IO_WSYNC(FP) WJUMP0 (__sync, FP)
218
219/* The 'doallocate' hook is used to tell the file to allocate a buffer.
220 It matches the streambuf::doallocate virtual function, which is not
221 in the ANSI/ISO C++ standard, but is part traditional implementations. */
222typedef int (*_IO_doallocate_t) (FILE *);
223#define _IO_DOALLOCATE(FP) JUMP0 (__doallocate, FP)
224#define _IO_WDOALLOCATE(FP) WJUMP0 (__doallocate, FP)
225
226/* The following four hooks (sysread, syswrite, sysclose, sysseek, and
227 sysstat) are low-level hooks specific to this implementation.
228 There is no correspondence in the ANSI/ISO C++ standard library.
229 The hooks basically correspond to the Unix system functions
230 (read, write, close, lseek, and stat) except that a FILE*
231 parameter is used instead of an integer file descriptor; the default
232 implementation used for normal files just calls those functions.
233 The advantage of overriding these functions instead of the higher-level
234 ones (underflow, overflow etc) is that you can leave all the buffering
235 higher-level functions. */
236
237/* The 'sysread' hook is used to read data from the external file into
238 an existing buffer. It generalizes the Unix read(2) function.
239 It matches the streambuf::sys_read virtual function, which is
240 specific to this implementation. */
241typedef ssize_t (*_IO_read_t) (FILE *, void *, ssize_t);
242#define _IO_SYSREAD(FP, DATA, LEN) JUMP2 (__read, FP, DATA, LEN)
243#define _IO_WSYSREAD(FP, DATA, LEN) WJUMP2 (__read, FP, DATA, LEN)
244
245/* The 'syswrite' hook is used to write data from an existing buffer
246 to an external file. It generalizes the Unix write(2) function.
247 It matches the streambuf::sys_write virtual function, which is
248 specific to this implementation. */
249typedef ssize_t (*_IO_write_t) (FILE *, const void *, ssize_t);
250#define _IO_SYSWRITE(FP, DATA, LEN) JUMP2 (__write, FP, DATA, LEN)
251#define _IO_WSYSWRITE(FP, DATA, LEN) WJUMP2 (__write, FP, DATA, LEN)
252
253/* The 'sysseek' hook is used to re-position an external file.
254 It generalizes the Unix lseek(2) function.
255 It matches the streambuf::sys_seek virtual function, which is
256 specific to this implementation. */
257typedef off64_t (*_IO_seek_t) (FILE *, off64_t, int);
258#define _IO_SYSSEEK(FP, OFFSET, MODE) JUMP2 (__seek, FP, OFFSET, MODE)
259#define _IO_WSYSSEEK(FP, OFFSET, MODE) WJUMP2 (__seek, FP, OFFSET, MODE)
260
261/* The 'sysclose' hook is used to finalize (close, finish up) an
262 external file. It generalizes the Unix close(2) function.
263 It matches the streambuf::sys_close virtual function, which is
264 specific to this implementation. */
265typedef int (*_IO_close_t) (FILE *); /* finalize */
266#define _IO_SYSCLOSE(FP) JUMP0 (__close, FP)
267#define _IO_WSYSCLOSE(FP) WJUMP0 (__close, FP)
268
269/* The 'sysstat' hook is used to get information about an external file
270 into a struct stat buffer. It generalizes the Unix fstat(2) call.
271 It matches the streambuf::sys_stat virtual function, which is
272 specific to this implementation. */
273typedef int (*_IO_stat_t) (FILE *, void *);
274#define _IO_SYSSTAT(FP, BUF) JUMP1 (__stat, FP, BUF)
275#define _IO_WSYSSTAT(FP, BUF) WJUMP1 (__stat, FP, BUF)
276
277/* The 'showmany' hook can be used to get an image how much input is
278 available. In many cases the answer will be 0 which means unknown
279 but some cases one can provide real information. */
280typedef int (*_IO_showmanyc_t) (FILE *);
281#define _IO_SHOWMANYC(FP) JUMP0 (__showmanyc, FP)
282#define _IO_WSHOWMANYC(FP) WJUMP0 (__showmanyc, FP)
283
284/* The 'imbue' hook is used to get information about the currently
285 installed locales. */
286typedef void (*_IO_imbue_t) (FILE *, void *);
287#define _IO_IMBUE(FP, LOCALE) JUMP1 (__imbue, FP, LOCALE)
288#define _IO_WIMBUE(FP, LOCALE) WJUMP1 (__imbue, FP, LOCALE)
289
290
291#define _IO_CHAR_TYPE char /* unsigned char ? */
292#define _IO_INT_TYPE int
293
294struct _IO_jump_t
295{
296 JUMP_FIELD(size_t, __dummy);
297 JUMP_FIELD(size_t, __dummy2);
298 JUMP_FIELD(_IO_finish_t, __finish);
299 JUMP_FIELD(_IO_overflow_t, __overflow);
300 JUMP_FIELD(_IO_underflow_t, __underflow);
301 JUMP_FIELD(_IO_underflow_t, __uflow);
302 JUMP_FIELD(_IO_pbackfail_t, __pbackfail);
303 /* showmany */
304 JUMP_FIELD(_IO_xsputn_t, __xsputn);
305 JUMP_FIELD(_IO_xsgetn_t, __xsgetn);
306 JUMP_FIELD(_IO_seekoff_t, __seekoff);
307 JUMP_FIELD(_IO_seekpos_t, __seekpos);
308 JUMP_FIELD(_IO_setbuf_t, __setbuf);
309 JUMP_FIELD(_IO_sync_t, __sync);
310 JUMP_FIELD(_IO_doallocate_t, __doallocate);
311 JUMP_FIELD(_IO_read_t, __read);
312 JUMP_FIELD(_IO_write_t, __write);
313 JUMP_FIELD(_IO_seek_t, __seek);
314 JUMP_FIELD(_IO_close_t, __close);
315 JUMP_FIELD(_IO_stat_t, __stat);
316 JUMP_FIELD(_IO_showmanyc_t, __showmanyc);
317 JUMP_FIELD(_IO_imbue_t, __imbue);
318};
319
320/* We always allocate an extra word following an _IO_FILE.
321 This contains a pointer to the function jump table used.
322 This is for compatibility with C++ streambuf; the word can
323 be used to smash to a pointer to a virtual function table. */
324
325struct _IO_FILE_plus
326{
327 FILE file;
328 const struct _IO_jump_t *vtable;
329};
330
331#ifdef _IO_USE_OLD_IO_FILE
332/* This structure is used by the compatibility code as if it were an
333 _IO_FILE_plus, but has enough space to initialize the _mode argument
334 of an _IO_FILE_complete. */
335struct _IO_FILE_complete_plus
336{
337 struct _IO_FILE_complete file;
338 const struct _IO_jump_t *vtable;
339};
340#endif
341
342/* Special file type for fopencookie function. */
343struct _IO_cookie_file
344{
345 struct _IO_FILE_plus __fp;
346 void *__cookie;
347 cookie_io_functions_t __io_functions;
348};
349
350FILE *_IO_fopencookie (void *cookie, const char *mode,
351 cookie_io_functions_t io_functions);
352
353
354/* Iterator type for walking global linked list of _IO_FILE objects. */
355
356typedef FILE *_IO_ITER;
357
358/* Generic functions */
359
360extern void _IO_switch_to_main_get_area (FILE *) __THROW;
361extern void _IO_switch_to_backup_area (FILE *) __THROW;
362extern int _IO_switch_to_get_mode (FILE *);
363libc_hidden_proto (_IO_switch_to_get_mode)
364extern void _IO_init_internal (FILE *, int) attribute_hidden;
365extern int _IO_sputbackc (FILE *, int) __THROW;
366libc_hidden_proto (_IO_sputbackc)
367extern int _IO_sungetc (FILE *) __THROW;
368extern void _IO_un_link (struct _IO_FILE_plus *) __THROW;
369libc_hidden_proto (_IO_un_link)
370extern void _IO_link_in (struct _IO_FILE_plus *) __THROW;
371libc_hidden_proto (_IO_link_in)
372extern void _IO_doallocbuf (FILE *) __THROW;
373libc_hidden_proto (_IO_doallocbuf)
374extern void _IO_unsave_markers (FILE *) __THROW;
375libc_hidden_proto (_IO_unsave_markers)
376extern void _IO_setb (FILE *, char *, char *, int) __THROW;
377libc_hidden_proto (_IO_setb)
378extern unsigned _IO_adjust_column (unsigned, const char *, int) __THROW;
379libc_hidden_proto (_IO_adjust_column)
380#define _IO_sputn(__fp, __s, __n) _IO_XSPUTN (__fp, __s, __n)
381
382ssize_t _IO_least_wmarker (FILE *, wchar_t *) __THROW;
383libc_hidden_proto (_IO_least_wmarker)
384extern void _IO_switch_to_main_wget_area (FILE *) __THROW;
385libc_hidden_proto (_IO_switch_to_main_wget_area)
386extern void _IO_switch_to_wbackup_area (FILE *) __THROW;
387libc_hidden_proto (_IO_switch_to_wbackup_area)
388extern int _IO_switch_to_wget_mode (FILE *);
389libc_hidden_proto (_IO_switch_to_wget_mode)
390extern void _IO_wsetb (FILE *, wchar_t *, wchar_t *, int) __THROW;
391libc_hidden_proto (_IO_wsetb)
392extern wint_t _IO_sputbackwc (FILE *, wint_t) __THROW;
393libc_hidden_proto (_IO_sputbackwc)
394extern wint_t _IO_sungetwc (FILE *) __THROW;
395extern void _IO_wdoallocbuf (FILE *) __THROW;
396libc_hidden_proto (_IO_wdoallocbuf)
397extern void _IO_unsave_wmarkers (FILE *) __THROW;
398extern unsigned _IO_adjust_wcolumn (unsigned, const wchar_t *, int) __THROW;
399extern off64_t get_file_offset (FILE *fp);
400
401/* Marker-related function. */
402
403extern void _IO_init_marker (struct _IO_marker *, FILE *);
404extern void _IO_init_wmarker (struct _IO_marker *, FILE *);
405extern void _IO_remove_marker (struct _IO_marker *) __THROW;
406extern int _IO_marker_difference (struct _IO_marker *, struct _IO_marker *)
407 __THROW;
408extern int _IO_marker_delta (struct _IO_marker *) __THROW;
409extern int _IO_wmarker_delta (struct _IO_marker *) __THROW;
410extern int _IO_seekmark (FILE *, struct _IO_marker *, int) __THROW;
411extern int _IO_seekwmark (FILE *, struct _IO_marker *, int) __THROW;
412
413/* Functions for iterating global list and dealing with its lock */
414
415extern _IO_ITER _IO_iter_begin (void) __THROW;
416libc_hidden_proto (_IO_iter_begin)
417extern _IO_ITER _IO_iter_end (void) __THROW;
418libc_hidden_proto (_IO_iter_end)
419extern _IO_ITER _IO_iter_next (_IO_ITER) __THROW;
420libc_hidden_proto (_IO_iter_next)
421extern FILE *_IO_iter_file (_IO_ITER) __THROW;
422libc_hidden_proto (_IO_iter_file)
423extern void _IO_list_lock (void) __THROW;
424libc_hidden_proto (_IO_list_lock)
425extern void _IO_list_unlock (void) __THROW;
426libc_hidden_proto (_IO_list_unlock)
427extern void _IO_list_resetlock (void) __THROW;
428libc_hidden_proto (_IO_list_resetlock)
429extern void _IO_enable_locks (void) __THROW;
430libc_hidden_proto (_IO_enable_locks)
431
432/* Default jumptable functions. */
433
434extern int _IO_default_underflow (FILE *) __THROW;
435extern int _IO_default_uflow (FILE *);
436libc_hidden_proto (_IO_default_uflow)
437extern wint_t _IO_wdefault_uflow (FILE *);
438libc_hidden_proto (_IO_wdefault_uflow)
439extern int _IO_default_doallocate (FILE *) __THROW;
440libc_hidden_proto (_IO_default_doallocate)
441extern int _IO_wdefault_doallocate (FILE *) __THROW;
442libc_hidden_proto (_IO_wdefault_doallocate)
443extern void _IO_default_finish (FILE *, int) __THROW;
444libc_hidden_proto (_IO_default_finish)
445extern void _IO_wdefault_finish (FILE *, int) __THROW;
446libc_hidden_proto (_IO_wdefault_finish)
447extern int _IO_default_pbackfail (FILE *, int) __THROW;
448libc_hidden_proto (_IO_default_pbackfail)
449extern wint_t _IO_wdefault_pbackfail (FILE *, wint_t) __THROW;
450libc_hidden_proto (_IO_wdefault_pbackfail)
451extern FILE* _IO_default_setbuf (FILE *, char *, ssize_t);
452extern size_t _IO_default_xsputn (FILE *, const void *, size_t);
453libc_hidden_proto (_IO_default_xsputn)
454extern size_t _IO_wdefault_xsputn (FILE *, const void *, size_t);
455libc_hidden_proto (_IO_wdefault_xsputn)
456extern size_t _IO_default_xsgetn (FILE *, void *, size_t);
457libc_hidden_proto (_IO_default_xsgetn)
458extern size_t _IO_wdefault_xsgetn (FILE *, void *, size_t);
459libc_hidden_proto (_IO_wdefault_xsgetn)
460extern off64_t _IO_default_seekoff (FILE *, off64_t, int, int)
461 __THROW;
462extern off64_t _IO_default_seekpos (FILE *, off64_t, int);
463extern ssize_t _IO_default_write (FILE *, const void *, ssize_t);
464extern ssize_t _IO_default_read (FILE *, void *, ssize_t);
465extern int _IO_default_stat (FILE *, void *) __THROW;
466extern off64_t _IO_default_seek (FILE *, off64_t, int) __THROW;
467extern int _IO_default_sync (FILE *) __THROW;
468#define _IO_default_close ((_IO_close_t) _IO_default_sync)
469extern int _IO_default_showmanyc (FILE *) __THROW;
470extern void _IO_default_imbue (FILE *, void *) __THROW;
471
472extern const struct _IO_jump_t _IO_file_jumps;
473libc_hidden_proto (_IO_file_jumps)
474extern const struct _IO_jump_t _IO_file_jumps_mmap attribute_hidden;
475extern const struct _IO_jump_t _IO_file_jumps_maybe_mmap attribute_hidden;
476extern const struct _IO_jump_t _IO_wfile_jumps;
477libc_hidden_proto (_IO_wfile_jumps)
478extern const struct _IO_jump_t _IO_wfile_jumps_mmap attribute_hidden;
479extern const struct _IO_jump_t _IO_wfile_jumps_maybe_mmap attribute_hidden;
480extern const struct _IO_jump_t _IO_old_file_jumps attribute_hidden;
481extern const struct _IO_jump_t _IO_streambuf_jumps;
482extern const struct _IO_jump_t _IO_old_proc_jumps attribute_hidden;
483extern const struct _IO_jump_t _IO_str_jumps attribute_hidden;
484extern const struct _IO_jump_t _IO_wstr_jumps attribute_hidden;
485extern int _IO_do_write (FILE *, const char *, size_t);
486libc_hidden_proto (_IO_do_write)
487extern int _IO_new_do_write (FILE *, const char *, size_t);
488extern int _IO_old_do_write (FILE *, const char *, size_t);
489extern int _IO_wdo_write (FILE *, const wchar_t *, size_t);
490libc_hidden_proto (_IO_wdo_write)
491extern int _IO_flush_all_lockp (int);
492extern int _IO_flush_all (void);
493libc_hidden_proto (_IO_flush_all)
494extern int _IO_cleanup (void);
495extern void _IO_flush_all_linebuffered (void);
496libc_hidden_proto (_IO_flush_all_linebuffered)
497extern int _IO_new_fgetpos (FILE *, __fpos_t *);
498extern int _IO_old_fgetpos (FILE *, __fpos_t *);
499extern int _IO_new_fsetpos (FILE *, const __fpos_t *);
500extern int _IO_old_fsetpos (FILE *, const __fpos_t *);
501extern int _IO_new_fgetpos64 (FILE *, __fpos64_t *);
502extern int _IO_old_fgetpos64 (FILE *, __fpos64_t *);
503extern int _IO_new_fsetpos64 (FILE *, const __fpos64_t *);
504extern int _IO_old_fsetpos64 (FILE *, const __fpos64_t *);
505extern void _IO_old_init (FILE *fp, int flags) __THROW;
506
507
508#define _IO_do_flush(_f) \
509 ((_f)->_mode <= 0 \
510 ? _IO_do_write(_f, (_f)->_IO_write_base, \
511 (_f)->_IO_write_ptr-(_f)->_IO_write_base) \
512 : _IO_wdo_write(_f, (_f)->_wide_data->_IO_write_base, \
513 ((_f)->_wide_data->_IO_write_ptr \
514 - (_f)->_wide_data->_IO_write_base)))
515#define _IO_old_do_flush(_f) \
516 _IO_old_do_write(_f, (_f)->_IO_write_base, \
517 (_f)->_IO_write_ptr-(_f)->_IO_write_base)
518#define _IO_in_put_mode(_fp) ((_fp)->_flags & _IO_CURRENTLY_PUTTING)
519#define _IO_mask_flags(fp, f, mask) \
520 ((fp)->_flags = ((fp)->_flags & ~(mask)) | ((f) & (mask)))
521#define _IO_setg(fp, eb, g, eg) ((fp)->_IO_read_base = (eb),\
522 (fp)->_IO_read_ptr = (g), (fp)->_IO_read_end = (eg))
523#define _IO_wsetg(fp, eb, g, eg) ((fp)->_wide_data->_IO_read_base = (eb),\
524 (fp)->_wide_data->_IO_read_ptr = (g), \
525 (fp)->_wide_data->_IO_read_end = (eg))
526#define _IO_setp(__fp, __p, __ep) \
527 ((__fp)->_IO_write_base = (__fp)->_IO_write_ptr \
528 = __p, (__fp)->_IO_write_end = (__ep))
529#define _IO_wsetp(__fp, __p, __ep) \
530 ((__fp)->_wide_data->_IO_write_base \
531 = (__fp)->_wide_data->_IO_write_ptr = __p, \
532 (__fp)->_wide_data->_IO_write_end = (__ep))
533#define _IO_have_backup(fp) ((fp)->_IO_save_base != NULL)
534#define _IO_have_wbackup(fp) ((fp)->_wide_data->_IO_save_base != NULL)
535#define _IO_in_backup(fp) ((fp)->_flags & _IO_IN_BACKUP)
536#define _IO_have_markers(fp) ((fp)->_markers != NULL)
537#define _IO_blen(fp) ((fp)->_IO_buf_end - (fp)->_IO_buf_base)
538#define _IO_wblen(fp) ((fp)->_wide_data->_IO_buf_end \
539 - (fp)->_wide_data->_IO_buf_base)
540
541/* Jumptable functions for files. */
542
543extern int _IO_file_doallocate (FILE *) __THROW;
544libc_hidden_proto (_IO_file_doallocate)
545extern FILE* _IO_file_setbuf (FILE *, char *, ssize_t);
546libc_hidden_proto (_IO_file_setbuf)
547extern off64_t _IO_file_seekoff (FILE *, off64_t, int, int);
548libc_hidden_proto (_IO_file_seekoff)
549extern off64_t _IO_file_seekoff_mmap (FILE *, off64_t, int, int)
550 __THROW;
551extern size_t _IO_file_xsputn (FILE *, const void *, size_t);
552libc_hidden_proto (_IO_file_xsputn)
553extern size_t _IO_file_xsgetn (FILE *, void *, size_t);
554libc_hidden_proto (_IO_file_xsgetn)
555extern int _IO_file_stat (FILE *, void *) __THROW;
556libc_hidden_proto (_IO_file_stat)
557extern int _IO_file_close (FILE *) __THROW;
558libc_hidden_proto (_IO_file_close)
559extern int _IO_file_close_mmap (FILE *) __THROW;
560extern int _IO_file_underflow (FILE *);
561libc_hidden_proto (_IO_file_underflow)
562extern int _IO_file_underflow_mmap (FILE *);
563extern int _IO_file_underflow_maybe_mmap (FILE *);
564extern int _IO_file_overflow (FILE *, int);
565libc_hidden_proto (_IO_file_overflow)
566#define _IO_file_is_open(__fp) ((__fp)->_fileno != -1)
567extern FILE* _IO_file_attach (FILE *, int);
568libc_hidden_proto (_IO_file_attach)
569extern FILE* _IO_file_open (FILE *, const char *, int, int, int, int);
570libc_hidden_proto (_IO_file_open)
571extern FILE* _IO_file_fopen (FILE *, const char *, const char *, int);
572libc_hidden_proto (_IO_file_fopen)
573extern ssize_t _IO_file_write (FILE *, const void *, ssize_t);
574extern ssize_t _IO_file_read (FILE *, void *, ssize_t);
575libc_hidden_proto (_IO_file_read)
576extern int _IO_file_sync (FILE *);
577libc_hidden_proto (_IO_file_sync)
578extern int _IO_file_close_it (FILE *);
579libc_hidden_proto (_IO_file_close_it)
580extern off64_t _IO_file_seek (FILE *, off64_t, int) __THROW;
581libc_hidden_proto (_IO_file_seek)
582extern void _IO_file_finish (FILE *, int);
583libc_hidden_proto (_IO_file_finish)
584
585extern FILE* _IO_new_file_attach (FILE *, int);
586extern int _IO_new_file_close_it (FILE *);
587extern void _IO_new_file_finish (FILE *, int);
588extern FILE* _IO_new_file_fopen (FILE *, const char *, const char *,
589 int);
590extern void _IO_no_init (FILE *, int, int, struct _IO_wide_data *,
591 const struct _IO_jump_t *) __THROW;
592extern void _IO_new_file_init_internal (struct _IO_FILE_plus *)
593 __THROW attribute_hidden;
594extern FILE* _IO_new_file_setbuf (FILE *, char *, ssize_t);
595extern FILE* _IO_file_setbuf_mmap (FILE *, char *, ssize_t);
596extern int _IO_new_file_sync (FILE *);
597extern int _IO_new_file_underflow (FILE *);
598extern int _IO_new_file_overflow (FILE *, int);
599extern off64_t _IO_new_file_seekoff (FILE *, off64_t, int, int);
600extern ssize_t _IO_new_file_write (FILE *, const void *, ssize_t);
601extern size_t _IO_new_file_xsputn (FILE *, const void *, size_t);
602
603extern FILE* _IO_old_file_setbuf (FILE *, char *, ssize_t);
604extern off64_t _IO_old_file_seekoff (FILE *, off64_t, int, int);
605extern size_t _IO_old_file_xsputn (FILE *, const void *, size_t);
606extern int _IO_old_file_underflow (FILE *);
607extern int _IO_old_file_overflow (FILE *, int);
608extern void _IO_old_file_init_internal (struct _IO_FILE_plus *)
609 __THROW attribute_hidden;
610extern FILE* _IO_old_file_attach (FILE *, int);
611extern FILE* _IO_old_file_fopen (FILE *, const char *, const char *);
612extern ssize_t _IO_old_file_write (FILE *, const void *, ssize_t);
613extern int _IO_old_file_sync (FILE *);
614extern int _IO_old_file_close_it (FILE *);
615extern void _IO_old_file_finish (FILE *, int);
616
617extern int _IO_wfile_doallocate (FILE *) __THROW;
618extern size_t _IO_wfile_xsputn (FILE *, const void *, size_t);
619libc_hidden_proto (_IO_wfile_xsputn)
620extern FILE* _IO_wfile_setbuf (FILE *, wchar_t *, ssize_t);
621extern wint_t _IO_wfile_sync (FILE *);
622libc_hidden_proto (_IO_wfile_sync)
623extern wint_t _IO_wfile_underflow (FILE *);
624libc_hidden_proto (_IO_wfile_underflow)
625extern wint_t _IO_wfile_overflow (FILE *, wint_t);
626libc_hidden_proto (_IO_wfile_overflow)
627extern off64_t _IO_wfile_seekoff (FILE *, off64_t, int, int);
628libc_hidden_proto (_IO_wfile_seekoff)
629
630/* Jumptable functions for proc_files. */
631extern FILE* _IO_proc_open (FILE *, const char *, const char *)
632 __THROW;
633extern FILE* _IO_new_proc_open (FILE *, const char *, const char *)
634 __THROW;
635extern FILE* _IO_old_proc_open (FILE *, const char *, const char *);
636extern int _IO_proc_close (FILE *) __THROW;
637extern int _IO_new_proc_close (FILE *) __THROW;
638extern int _IO_old_proc_close (FILE *);
639
640/* Jumptable functions for strfiles. */
641extern int _IO_str_underflow (FILE *) __THROW;
642libc_hidden_proto (_IO_str_underflow)
643extern int _IO_str_overflow (FILE *, int) __THROW;
644libc_hidden_proto (_IO_str_overflow)
645extern int _IO_str_pbackfail (FILE *, int) __THROW;
646libc_hidden_proto (_IO_str_pbackfail)
647extern off64_t _IO_str_seekoff (FILE *, off64_t, int, int) __THROW;
648libc_hidden_proto (_IO_str_seekoff)
649extern void _IO_str_finish (FILE *, int) __THROW;
650
651/* Other strfile functions */
652struct _IO_strfile_;
653extern ssize_t _IO_str_count (FILE *) __THROW;
654
655/* And the wide character versions. */
656extern void _IO_wstr_init_static (FILE *, wchar_t *, size_t, wchar_t *)
657 __THROW;
658extern ssize_t _IO_wstr_count (FILE *) __THROW;
659extern wint_t _IO_wstr_overflow (FILE *, wint_t) __THROW;
660extern wint_t _IO_wstr_underflow (FILE *) __THROW;
661extern off64_t _IO_wstr_seekoff (FILE *, off64_t, int, int)
662 __THROW;
663extern wint_t _IO_wstr_pbackfail (FILE *, wint_t) __THROW;
664extern void _IO_wstr_finish (FILE *, int) __THROW;
665
666/* Internal versions of v*printf that take an additional flags
667 parameter. */
668extern int __vfprintf_internal (FILE *fp, const char *format, va_list ap,
669 unsigned int mode_flags)
670 attribute_hidden;
671extern int __vfwprintf_internal (FILE *fp, const wchar_t *format, va_list ap,
672 unsigned int mode_flags)
673 attribute_hidden;
674
675extern int __vasprintf_internal (char **result_ptr, const char *format,
676 va_list ap, unsigned int mode_flags)
677 attribute_hidden;
678extern int __vdprintf_internal (int d, const char *format, va_list ap,
679 unsigned int mode_flags)
680 attribute_hidden;
681extern int __obstack_vprintf_internal (struct obstack *ob, const char *fmt,
682 va_list ap, unsigned int mode_flags)
683 attribute_hidden;
684
685/* Note: __vsprintf_internal, unlike vsprintf, does take a maxlen argument,
686 because it's called by both vsprintf and vsprintf_chk. If maxlen is
687 not set to -1, overrunning the buffer will cause a prompt crash.
688 This is the behavior of ordinary (v)sprintf functions, thus they call
689 __vsprintf_internal with that argument set to -1. */
690extern int __vsprintf_internal (char *string, size_t maxlen,
691 const char *format, va_list ap,
692 unsigned int mode_flags)
693 attribute_hidden;
694
695extern int __vsnprintf_internal (char *string, size_t maxlen,
696 const char *format, va_list ap,
697 unsigned int mode_flags)
698 attribute_hidden;
699extern int __vswprintf_internal (wchar_t *string, size_t maxlen,
700 const wchar_t *format, va_list ap,
701 unsigned int mode_flags)
702 attribute_hidden;
703
704/* Flags for __v*printf_internal.
705
706 PRINTF_LDBL_IS_DBL indicates whether long double values are to be
707 handled as having the same format as double, in which case the flag
708 should be set to one, or as another format, otherwise.
709
710 PRINTF_FORTIFY, when set to one, indicates that fortification checks
711 are to be performed in input parameters. This is used by the
712 __*printf_chk functions, which are used when _FORTIFY_SOURCE is
713 defined to 1 or 2. Otherwise, such checks are ignored.
714
715 PRINTF_CHK indicates, to the internal function being called, that the
716 call is originated from one of the __*printf_chk functions.
717
718 PRINTF_LDBL_USES_FLOAT128 is used on platforms where the long double
719 format used to be different from the IEC 60559 double format *and*
720 also different from the Quadruple 128-bits IEC 60559 format (such as
721 the IBM Extended Precision format on powerpc or the 80-bits IEC 60559
722 format on x86), but was later converted to the Quadruple 128-bits IEC
723 60559 format, which is the same format that the _Float128 always has
724 (hence the `USES_FLOAT128' suffix in the name of the flag). When set
725 to one, this macro indicates that long double values are to be
726 handled as having this new format. Otherwise, they should be handled
727 as the previous format on that platform. */
728#define PRINTF_LDBL_IS_DBL 0x0001
729#define PRINTF_FORTIFY 0x0002
730#define PRINTF_CHK 0x0004
731#define PRINTF_LDBL_USES_FLOAT128 0x0008
732
733extern size_t _IO_getline (FILE *,char *, size_t, int, int);
734libc_hidden_proto (_IO_getline)
735extern size_t _IO_getline_info (FILE *,char *, size_t,
736 int, int, int *);
737libc_hidden_proto (_IO_getline_info)
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 PTR_MANGLE (flag);
915 atomic_store_relaxed (&IO_accept_foreign_vtables, flag);
916}
917
918#else /* !SHARED */
919
920/* The statically-linked version does nothing. */
921static inline void
922IO_set_accept_foreign_vtables (void (*flag) (void))
923{
924}
925
926#endif
927
928/* Check if unknown vtable pointers are permitted; otherwise,
929 terminate the process. */
930void _IO_vtable_check (void) attribute_hidden;
931
932/* Perform vtable pointer validation. If validation fails, terminate
933 the process. */
934static inline const struct _IO_jump_t *
935IO_validate_vtable (const struct _IO_jump_t *vtable)
936{
937 /* Fast path: The vtable pointer is within the __libc_IO_vtables
938 section. */
939 uintptr_t section_length = __stop___libc_IO_vtables - __start___libc_IO_vtables;
940 uintptr_t ptr = (uintptr_t) vtable;
941 uintptr_t offset = ptr - (uintptr_t) __start___libc_IO_vtables;
942 if (__glibc_unlikely (offset >= section_length))
943 /* The vtable pointer is not in the expected section. Use the
944 slow path, which will terminate the process if necessary. */
945 _IO_vtable_check ();
946 return vtable;
947}
948
949/* Character set conversion. */
950
951enum __codecvt_result
952{
953 __codecvt_ok,
954 __codecvt_partial,
955 __codecvt_error,
956 __codecvt_noconv
957};
958
959enum __codecvt_result __libio_codecvt_out (struct _IO_codecvt *,
960 __mbstate_t *,
961 const wchar_t *,
962 const wchar_t *,
963 const wchar_t **, char *,
964 char *, char **)
965 attribute_hidden;
966enum __codecvt_result __libio_codecvt_in (struct _IO_codecvt *,
967 __mbstate_t *,
968 const char *, const char *,
969 const char **, wchar_t *,
970 wchar_t *, wchar_t **)
971 attribute_hidden;
972int __libio_codecvt_encoding (struct _IO_codecvt *) attribute_hidden;
973int __libio_codecvt_length (struct _IO_codecvt *, __mbstate_t *,
974 const char *, const char *, size_t)
975 attribute_hidden;
976
977#endif /* libioP.h. */
978