1 /* Copyright (C) 1993-2023 Free Software Foundation, Inc.
2 This file is part of the GNU C Library.
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.
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.
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/>.
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. */
32 #include <sys/param.h>
33 #include <sys/types.h>
39 #include "../wcsmbs/wcsmbsload.h"
40 #include "../iconv/gconv_charset.h"
41 #include "../iconv/gconv_int.h"
42 #include <shlib-compat.h>
43 #include <not-cancel.h>
44 #include <kernel-features.h>
46 extern struct __gconv_trans_data __libio_translit attribute_hidden
;
48 /* An fstream can be in at most one of put mode, get mode, or putback mode.
49 Putback mode is a variant of get mode.
51 In a filebuf, there is only one current position, instead of two
52 separate get and put pointers. In get mode, the current position
53 is that of gptr(); in put mode that of pptr().
55 The position in the buffer that corresponds to the position
56 in external file system is normally _IO_read_end, except in putback
57 mode, when it is _IO_save_end and also when the file is in append mode,
58 since switching from read to write mode automatically sends the position in
59 the external file system to the end of file.
60 If the field _fb._offset is >= 0, it gives the offset in
61 the file as a whole corresponding to eGptr(). (?)
64 If a filebuf is in put mode, then all of _IO_read_ptr, _IO_read_end,
65 and _IO_read_base are equal to each other. These are usually equal
66 to _IO_buf_base, though not necessarily if we have switched from
67 get mode to put mode. (The reason is to maintain the invariant
68 that _IO_read_end corresponds to the external file position.)
69 _IO_write_base is non-NULL and usually equal to _IO_buf_base.
70 We also have _IO_write_end == _IO_buf_end, but only in fully buffered mode.
71 The un-flushed character are those between _IO_write_base and _IO_write_ptr.
74 If a filebuf is in get or putback mode, eback() != egptr().
75 In get mode, the unread characters are between gptr() and egptr().
76 The OS file position corresponds to that of egptr().
79 Putback mode is used to remember "excess" characters that have
80 been sputbackc'd in a separate putback buffer.
81 In putback mode, the get buffer points to the special putback buffer.
82 The unread characters are the characters between gptr() and egptr()
83 in the putback buffer, as well as the area between save_gptr()
84 and save_egptr(), which point into the original reserve buffer.
85 (The pointers save_gptr() and save_egptr() are the values
86 of gptr() and egptr() at the time putback mode was entered.)
87 The OS position corresponds to that of save_egptr().
90 During line buffered output, _IO_write_base==base() && epptr()==base().
91 However, ptr() may be anywhere between base() and ebuf().
92 This forces a call to filebuf::overflow(int C) on every put.
93 If there is more space in the buffer, and C is not a '\n',
94 then C is inserted, and pptr() incremented.
97 If a filebuf is unbuffered(), the _shortbuf[1] is used as the buffer.
100 #define CLOSED_FILEBUF_FLAGS \
101 (_IO_IS_FILEBUF+_IO_NO_READS+_IO_NO_WRITES+_IO_TIED_PUT_GET)
105 _IO_new_file_init_internal (struct _IO_FILE_plus
*fp
)
107 /* POSIX.1 allows another file handle to be used to change the position
108 of our file descriptor. Hence we actually don't know the actual
109 position before we do the first fseek (and until a following fflush). */
110 fp
->file
._offset
= _IO_pos_BAD
;
111 fp
->file
._flags
|= CLOSED_FILEBUF_FLAGS
;
114 fp
->file
._fileno
= -1;
117 /* External version of _IO_new_file_init_internal which switches off
118 vtable validation. */
120 _IO_new_file_init (struct _IO_FILE_plus
*fp
)
122 IO_set_accept_foreign_vtables (&_IO_vtable_check
);
123 _IO_new_file_init_internal (fp
);
127 _IO_new_file_close_it (FILE *fp
)
130 if (!_IO_file_is_open (fp
))
133 if ((fp
->_flags
& _IO_NO_WRITES
) == 0
134 && (fp
->_flags
& _IO_CURRENTLY_PUTTING
) != 0)
135 write_status
= _IO_do_flush (fp
);
139 _IO_unsave_markers (fp
);
141 int close_status
= ((fp
->_flags2
& _IO_FLAGS2_NOCLOSE
) == 0
142 ? _IO_SYSCLOSE (fp
) : 0);
147 if (_IO_have_wbackup (fp
))
148 _IO_free_wbackup_area (fp
);
149 _IO_wsetb (fp
, NULL
, NULL
, 0);
150 _IO_wsetg (fp
, NULL
, NULL
, NULL
);
151 _IO_wsetp (fp
, NULL
, NULL
);
153 _IO_setb (fp
, NULL
, NULL
, 0);
154 _IO_setg (fp
, NULL
, NULL
, NULL
);
155 _IO_setp (fp
, NULL
, NULL
);
157 _IO_un_link ((struct _IO_FILE_plus
*) fp
);
158 fp
->_flags
= _IO_MAGIC
|CLOSED_FILEBUF_FLAGS
;
160 fp
->_offset
= _IO_pos_BAD
;
162 return close_status
? close_status
: write_status
;
164 libc_hidden_ver (_IO_new_file_close_it
, _IO_file_close_it
)
167 _IO_new_file_finish (FILE *fp
, int dummy
)
169 if (_IO_file_is_open (fp
))
172 if (!(fp
->_flags
& _IO_DELETE_DONT_CLOSE
))
175 _IO_default_finish (fp
, 0);
177 libc_hidden_ver (_IO_new_file_finish
, _IO_file_finish
)
180 _IO_file_open (FILE *fp
, const char *filename
, int posix_mode
, int prot
,
181 int read_write
, int is32not64
)
184 if (__glibc_unlikely (fp
->_flags2
& _IO_FLAGS2_NOTCANCEL
))
185 fdesc
= __open_nocancel (filename
,
186 posix_mode
| (is32not64
? 0 : O_LARGEFILE
), prot
);
188 fdesc
= __open (filename
, posix_mode
| (is32not64
? 0 : O_LARGEFILE
), prot
);
192 _IO_mask_flags (fp
, read_write
,_IO_NO_READS
+_IO_NO_WRITES
+_IO_IS_APPENDING
);
193 /* For append mode, send the file offset to the end of the file. Don't
194 update the offset cache though, since the file handle is not active. */
195 if ((read_write
& (_IO_IS_APPENDING
| _IO_NO_READS
))
196 == (_IO_IS_APPENDING
| _IO_NO_READS
))
198 off64_t new_pos
= _IO_SYSSEEK (fp
, 0, _IO_seek_end
);
199 if (new_pos
== _IO_pos_BAD
&& errno
!= ESPIPE
)
201 __close_nocancel (fdesc
);
205 _IO_link_in ((struct _IO_FILE_plus
*) fp
);
208 libc_hidden_def (_IO_file_open
)
211 _IO_new_file_fopen (FILE *fp
, const char *filename
, const char *mode
,
214 int oflags
= 0, omode
;
220 const char *last_recognized
;
222 if (_IO_file_is_open (fp
))
228 read_write
= _IO_NO_WRITES
;
232 oflags
= O_CREAT
|O_TRUNC
;
233 read_write
= _IO_NO_READS
;
237 oflags
= O_CREAT
|O_APPEND
;
238 read_write
= _IO_NO_READS
|_IO_IS_APPENDING
;
241 __set_errno (EINVAL
);
244 last_recognized
= mode
;
245 for (i
= 1; i
< 7; ++i
)
254 read_write
&= _IO_IS_APPENDING
;
255 last_recognized
= mode
;
259 last_recognized
= mode
;
262 last_recognized
= mode
;
265 fp
->_flags2
|= _IO_FLAGS2_MMAP
;
268 fp
->_flags2
|= _IO_FLAGS2_NOTCANCEL
;
272 fp
->_flags2
|= _IO_FLAGS2_CLOEXEC
;
281 result
= _IO_file_open (fp
, filename
, omode
|oflags
, oprot
, read_write
,
286 /* Test whether the mode string specifies the conversion. */
287 cs
= strstr (last_recognized
+ 1, ",ccs=");
290 /* Yep. Load the appropriate conversions and set the orientation
292 struct gconv_fcts fcts
;
293 struct _IO_codecvt
*cc
;
294 char *endp
= __strchrnul (cs
+ 5, ',');
295 char *ccs
= malloc (endp
- (cs
+ 5) + 3);
299 int malloc_err
= errno
; /* Whatever malloc failed with. */
300 (void) _IO_file_close_it (fp
);
301 __set_errno (malloc_err
);
305 *((char *) __mempcpy (ccs
, cs
+ 5, endp
- (cs
+ 5))) = '\0';
308 if (__wcsmbs_named_conv (&fcts
, ccs
[2] == '\0'
309 ? upstr (ccs
, cs
+ 5) : ccs
) != 0)
311 /* Something went wrong, we cannot load the conversion modules.
312 This means we cannot proceed since the user explicitly asked
314 (void) _IO_file_close_it (fp
);
316 __set_errno (EINVAL
);
322 assert (fcts
.towc_nsteps
== 1);
323 assert (fcts
.tomb_nsteps
== 1);
325 fp
->_wide_data
->_IO_read_ptr
= fp
->_wide_data
->_IO_read_end
;
326 fp
->_wide_data
->_IO_write_ptr
= fp
->_wide_data
->_IO_write_base
;
328 /* Clear the state. We start all over again. */
329 memset (&fp
->_wide_data
->_IO_state
, '\0', sizeof (__mbstate_t
));
330 memset (&fp
->_wide_data
->_IO_last_state
, '\0', sizeof (__mbstate_t
));
332 cc
= fp
->_codecvt
= &fp
->_wide_data
->_codecvt
;
334 cc
->__cd_in
.step
= fcts
.towc
;
336 cc
->__cd_in
.step_data
.__invocation_counter
= 0;
337 cc
->__cd_in
.step_data
.__internal_use
= 1;
338 cc
->__cd_in
.step_data
.__flags
= __GCONV_IS_LAST
;
339 cc
->__cd_in
.step_data
.__statep
= &result
->_wide_data
->_IO_state
;
341 cc
->__cd_out
.step
= fcts
.tomb
;
343 cc
->__cd_out
.step_data
.__invocation_counter
= 0;
344 cc
->__cd_out
.step_data
.__internal_use
= 1;
345 cc
->__cd_out
.step_data
.__flags
= __GCONV_IS_LAST
| __GCONV_TRANSLIT
;
346 cc
->__cd_out
.step_data
.__statep
= &result
->_wide_data
->_IO_state
;
348 /* From now on use the wide character callback functions. */
349 _IO_JUMPS_FILE_plus (fp
) = fp
->_wide_data
->_wide_vtable
;
351 /* Set the mode now. */
358 libc_hidden_ver (_IO_new_file_fopen
, _IO_file_fopen
)
361 _IO_new_file_attach (FILE *fp
, int fd
)
363 if (_IO_file_is_open (fp
))
366 fp
->_flags
&= ~(_IO_NO_READS
+_IO_NO_WRITES
);
367 fp
->_flags
|= _IO_DELETE_DONT_CLOSE
;
368 /* Get the current position of the file. */
369 /* We have to do that since that may be junk. */
370 fp
->_offset
= _IO_pos_BAD
;
371 int save_errno
= errno
;
372 if (_IO_SEEKOFF (fp
, (off64_t
)0, _IO_seek_cur
, _IOS_INPUT
|_IOS_OUTPUT
)
373 == _IO_pos_BAD
&& errno
!= ESPIPE
)
375 __set_errno (save_errno
);
378 libc_hidden_ver (_IO_new_file_attach
, _IO_file_attach
)
381 _IO_new_file_setbuf (FILE *fp
, char *p
, ssize_t len
)
383 if (_IO_default_setbuf (fp
, p
, len
) == NULL
)
386 fp
->_IO_write_base
= fp
->_IO_write_ptr
= fp
->_IO_write_end
388 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
392 libc_hidden_ver (_IO_new_file_setbuf
, _IO_file_setbuf
)
396 _IO_file_setbuf_mmap (FILE *fp
, char *p
, ssize_t len
)
400 /* Change the function table. */
401 _IO_JUMPS_FILE_plus (fp
) = &_IO_file_jumps
;
402 fp
->_wide_data
->_wide_vtable
= &_IO_wfile_jumps
;
404 /* And perform the normal operation. */
405 result
= _IO_new_file_setbuf (fp
, p
, len
);
407 /* If the call failed, restore to using mmap. */
410 _IO_JUMPS_FILE_plus (fp
) = &_IO_file_jumps_mmap
;
411 fp
->_wide_data
->_wide_vtable
= &_IO_wfile_jumps_mmap
;
417 static size_t new_do_write (FILE *, const char *, size_t);
419 /* Write TO_DO bytes from DATA to FP.
420 Then mark FP as having empty buffers. */
423 _IO_new_do_write (FILE *fp
, const char *data
, size_t to_do
)
426 || (size_t) new_do_write (fp
, data
, to_do
) == to_do
) ? 0 : EOF
;
428 libc_hidden_ver (_IO_new_do_write
, _IO_do_write
)
431 new_do_write (FILE *fp
, const char *data
, size_t to_do
)
434 if (fp
->_flags
& _IO_IS_APPENDING
)
435 /* On a system without a proper O_APPEND implementation,
436 you would need to sys_seek(0, SEEK_END) here, but is
437 not needed nor desirable for Unix- or Posix-like systems.
438 Instead, just indicate that offset (before and after) is
440 fp
->_offset
= _IO_pos_BAD
;
441 else if (fp
->_IO_read_end
!= fp
->_IO_write_base
)
444 = _IO_SYSSEEK (fp
, fp
->_IO_write_base
- fp
->_IO_read_end
, 1);
445 if (new_pos
== _IO_pos_BAD
)
447 fp
->_offset
= new_pos
;
449 count
= _IO_SYSWRITE (fp
, data
, to_do
);
450 if (fp
->_cur_column
&& count
)
451 fp
->_cur_column
= _IO_adjust_column (fp
->_cur_column
- 1, data
, count
) + 1;
452 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
453 fp
->_IO_write_base
= fp
->_IO_write_ptr
= fp
->_IO_buf_base
;
454 fp
->_IO_write_end
= (fp
->_mode
<= 0
455 && (fp
->_flags
& (_IO_LINE_BUF
| _IO_UNBUFFERED
))
456 ? fp
->_IO_buf_base
: fp
->_IO_buf_end
);
461 _IO_new_file_underflow (FILE *fp
)
465 /* C99 requires EOF to be "sticky". */
466 if (fp
->_flags
& _IO_EOF_SEEN
)
469 if (fp
->_flags
& _IO_NO_READS
)
471 fp
->_flags
|= _IO_ERR_SEEN
;
475 if (fp
->_IO_read_ptr
< fp
->_IO_read_end
)
476 return *(unsigned char *) fp
->_IO_read_ptr
;
478 if (fp
->_IO_buf_base
== NULL
)
480 /* Maybe we already have a push back pointer. */
481 if (fp
->_IO_save_base
!= NULL
)
483 free (fp
->_IO_save_base
);
484 fp
->_flags
&= ~_IO_IN_BACKUP
;
489 /* FIXME This can/should be moved to genops ?? */
490 if (fp
->_flags
& (_IO_LINE_BUF
|_IO_UNBUFFERED
))
492 /* We used to flush all line-buffered stream. This really isn't
493 required by any standard. My recollection is that
494 traditional Unix systems did this for stdout. stderr better
495 not be line buffered. So we do just that here
496 explicitly. --drepper */
497 _IO_acquire_lock (stdout
);
499 if ((stdout
->_flags
& (_IO_LINKED
| _IO_NO_WRITES
| _IO_LINE_BUF
))
500 == (_IO_LINKED
| _IO_LINE_BUF
))
501 _IO_OVERFLOW (stdout
, EOF
);
503 _IO_release_lock (stdout
);
506 _IO_switch_to_get_mode (fp
);
508 /* This is very tricky. We have to adjust those
509 pointers before we call _IO_SYSREAD () since
510 we may longjump () out while waiting for
511 input. Those pointers may be screwed up. H.J. */
512 fp
->_IO_read_base
= fp
->_IO_read_ptr
= fp
->_IO_buf_base
;
513 fp
->_IO_read_end
= fp
->_IO_buf_base
;
514 fp
->_IO_write_base
= fp
->_IO_write_ptr
= fp
->_IO_write_end
517 count
= _IO_SYSREAD (fp
, fp
->_IO_buf_base
,
518 fp
->_IO_buf_end
- fp
->_IO_buf_base
);
522 fp
->_flags
|= _IO_EOF_SEEN
;
524 fp
->_flags
|= _IO_ERR_SEEN
, count
= 0;
526 fp
->_IO_read_end
+= count
;
529 /* If a stream is read to EOF, the calling application may switch active
530 handles. As a result, our offset cache would no longer be valid, so
532 fp
->_offset
= _IO_pos_BAD
;
535 if (fp
->_offset
!= _IO_pos_BAD
)
536 _IO_pos_adjust (fp
->_offset
, count
);
537 return *(unsigned char *) fp
->_IO_read_ptr
;
539 libc_hidden_ver (_IO_new_file_underflow
, _IO_file_underflow
)
541 /* Guts of underflow callback if we mmap the file. This stats the file and
542 updates the stream state to match. In the normal case we return zero.
543 If the file is no longer eligible for mmap, its jump tables are reset to
544 the vanilla ones and we return nonzero. */
546 mmap_remap_check (FILE *fp
)
548 struct __stat64_t64 st
;
550 if (_IO_SYSSTAT (fp
, &st
) == 0
551 && S_ISREG (st
.st_mode
) && st
.st_size
!= 0
552 /* Limit the file size to 1MB for 32-bit machines. */
553 && (sizeof (ptrdiff_t) > 4 || st
.st_size
< 1*1024*1024))
555 const size_t pagesize
= __getpagesize ();
556 # define ROUNDED(x) (((x) + pagesize - 1) & ~(pagesize - 1))
557 if (ROUNDED (st
.st_size
) < ROUNDED (fp
->_IO_buf_end
560 /* We can trim off some pages past the end of the file. */
561 (void) __munmap (fp
->_IO_buf_base
+ ROUNDED (st
.st_size
),
562 ROUNDED (fp
->_IO_buf_end
- fp
->_IO_buf_base
)
563 - ROUNDED (st
.st_size
));
564 fp
->_IO_buf_end
= fp
->_IO_buf_base
+ st
.st_size
;
566 else if (ROUNDED (st
.st_size
) > ROUNDED (fp
->_IO_buf_end
569 /* The file added some pages. We need to remap it. */
572 p
= __mremap (fp
->_IO_buf_base
, ROUNDED (fp
->_IO_buf_end
574 ROUNDED (st
.st_size
), MREMAP_MAYMOVE
);
577 (void) __munmap (fp
->_IO_buf_base
,
578 fp
->_IO_buf_end
- fp
->_IO_buf_base
);
582 (void) __munmap (fp
->_IO_buf_base
,
583 fp
->_IO_buf_end
- fp
->_IO_buf_base
);
584 p
= __mmap64 (NULL
, st
.st_size
, PROT_READ
, MAP_SHARED
,
589 fp
->_IO_buf_base
= p
;
590 fp
->_IO_buf_end
= fp
->_IO_buf_base
+ st
.st_size
;
594 /* The number of pages didn't change. */
595 fp
->_IO_buf_end
= fp
->_IO_buf_base
+ st
.st_size
;
599 fp
->_offset
-= fp
->_IO_read_end
- fp
->_IO_read_ptr
;
600 _IO_setg (fp
, fp
->_IO_buf_base
,
601 fp
->_offset
< fp
->_IO_buf_end
- fp
->_IO_buf_base
602 ? fp
->_IO_buf_base
+ fp
->_offset
: fp
->_IO_buf_end
,
605 /* If we are already positioned at or past the end of the file, don't
606 change the current offset. If not, seek past what we have mapped,
607 mimicking the position left by a normal underflow reading into its
610 if (fp
->_offset
< fp
->_IO_buf_end
- fp
->_IO_buf_base
)
612 if (__lseek64 (fp
->_fileno
, fp
->_IO_buf_end
- fp
->_IO_buf_base
,
614 != fp
->_IO_buf_end
- fp
->_IO_buf_base
)
615 fp
->_flags
|= _IO_ERR_SEEN
;
617 fp
->_offset
= fp
->_IO_buf_end
- fp
->_IO_buf_base
;
624 /* Life is no longer good for mmap. Punt it. */
625 (void) __munmap (fp
->_IO_buf_base
,
626 fp
->_IO_buf_end
- fp
->_IO_buf_base
);
628 fp
->_IO_buf_base
= fp
->_IO_buf_end
= NULL
;
629 _IO_setg (fp
, NULL
, NULL
, NULL
);
631 _IO_JUMPS_FILE_plus (fp
) = &_IO_file_jumps
;
633 _IO_JUMPS_FILE_plus (fp
) = &_IO_wfile_jumps
;
634 fp
->_wide_data
->_wide_vtable
= &_IO_wfile_jumps
;
640 /* Special callback replacing the underflow callbacks if we mmap the file. */
642 _IO_file_underflow_mmap (FILE *fp
)
644 if (fp
->_IO_read_ptr
< fp
->_IO_read_end
)
645 return *(unsigned char *) fp
->_IO_read_ptr
;
647 if (__glibc_unlikely (mmap_remap_check (fp
)))
648 /* We punted to the regular file functions. */
649 return _IO_UNDERFLOW (fp
);
651 if (fp
->_IO_read_ptr
< fp
->_IO_read_end
)
652 return *(unsigned char *) fp
->_IO_read_ptr
;
654 fp
->_flags
|= _IO_EOF_SEEN
;
659 decide_maybe_mmap (FILE *fp
)
661 /* We use the file in read-only mode. This could mean we can
662 mmap the file and use it without any copying. But not all
663 file descriptors are for mmap-able objects and on 32-bit
664 machines we don't want to map files which are too large since
665 this would require too much virtual memory. */
666 struct __stat64_t64 st
;
668 if (_IO_SYSSTAT (fp
, &st
) == 0
669 && S_ISREG (st
.st_mode
) && st
.st_size
!= 0
670 /* Limit the file size to 1MB for 32-bit machines. */
671 && (sizeof (ptrdiff_t) > 4 || st
.st_size
< 1*1024*1024)
673 && (fp
->_offset
== _IO_pos_BAD
|| fp
->_offset
<= st
.st_size
))
675 /* Try to map the file. */
678 p
= __mmap64 (NULL
, st
.st_size
, PROT_READ
, MAP_SHARED
, fp
->_fileno
, 0);
681 /* OK, we managed to map the file. Set the buffer up and use a
682 special jump table with simplified underflow functions which
683 never tries to read anything from the file. */
685 if (__lseek64 (fp
->_fileno
, st
.st_size
, SEEK_SET
) != st
.st_size
)
687 (void) __munmap (p
, st
.st_size
);
688 fp
->_offset
= _IO_pos_BAD
;
692 _IO_setb (fp
, p
, (char *) p
+ st
.st_size
, 0);
694 if (fp
->_offset
== _IO_pos_BAD
)
697 _IO_setg (fp
, p
, p
+ fp
->_offset
, p
+ st
.st_size
);
698 fp
->_offset
= st
.st_size
;
701 _IO_JUMPS_FILE_plus (fp
) = &_IO_file_jumps_mmap
;
703 _IO_JUMPS_FILE_plus (fp
) = &_IO_wfile_jumps_mmap
;
704 fp
->_wide_data
->_wide_vtable
= &_IO_wfile_jumps_mmap
;
711 /* We couldn't use mmap, so revert to the vanilla file operations. */
714 _IO_JUMPS_FILE_plus (fp
) = &_IO_file_jumps
;
716 _IO_JUMPS_FILE_plus (fp
) = &_IO_wfile_jumps
;
717 fp
->_wide_data
->_wide_vtable
= &_IO_wfile_jumps
;
721 _IO_file_underflow_maybe_mmap (FILE *fp
)
723 /* This is the first read attempt. Choose mmap or vanilla operations
724 and then punt to the chosen underflow routine. */
725 decide_maybe_mmap (fp
);
726 return _IO_UNDERFLOW (fp
);
731 _IO_new_file_overflow (FILE *f
, int ch
)
733 if (f
->_flags
& _IO_NO_WRITES
) /* SET ERROR */
735 f
->_flags
|= _IO_ERR_SEEN
;
739 /* If currently reading or no buffer allocated. */
740 if ((f
->_flags
& _IO_CURRENTLY_PUTTING
) == 0 || f
->_IO_write_base
== NULL
)
742 /* Allocate a buffer if needed. */
743 if (f
->_IO_write_base
== NULL
)
746 _IO_setg (f
, f
->_IO_buf_base
, f
->_IO_buf_base
, f
->_IO_buf_base
);
748 /* Otherwise must be currently reading.
749 If _IO_read_ptr (and hence also _IO_read_end) is at the buffer end,
750 logically slide the buffer forwards one block (by setting the
751 read pointers to all point at the beginning of the block). This
752 makes room for subsequent output.
753 Otherwise, set the read pointers to _IO_read_end (leaving that
754 alone, so it can continue to correspond to the external position). */
755 if (__glibc_unlikely (_IO_in_backup (f
)))
757 size_t nbackup
= f
->_IO_read_end
- f
->_IO_read_ptr
;
758 _IO_free_backup_area (f
);
759 f
->_IO_read_base
-= MIN (nbackup
,
760 f
->_IO_read_base
- f
->_IO_buf_base
);
761 f
->_IO_read_ptr
= f
->_IO_read_base
;
764 if (f
->_IO_read_ptr
== f
->_IO_buf_end
)
765 f
->_IO_read_end
= f
->_IO_read_ptr
= f
->_IO_buf_base
;
766 f
->_IO_write_ptr
= f
->_IO_read_ptr
;
767 f
->_IO_write_base
= f
->_IO_write_ptr
;
768 f
->_IO_write_end
= f
->_IO_buf_end
;
769 f
->_IO_read_base
= f
->_IO_read_ptr
= f
->_IO_read_end
;
771 f
->_flags
|= _IO_CURRENTLY_PUTTING
;
772 if (f
->_mode
<= 0 && f
->_flags
& (_IO_LINE_BUF
| _IO_UNBUFFERED
))
773 f
->_IO_write_end
= f
->_IO_write_ptr
;
776 return _IO_do_write (f
, f
->_IO_write_base
,
777 f
->_IO_write_ptr
- f
->_IO_write_base
);
778 if (f
->_IO_write_ptr
== f
->_IO_buf_end
) /* Buffer is really full */
779 if (_IO_do_flush (f
) == EOF
)
781 *f
->_IO_write_ptr
++ = ch
;
782 if ((f
->_flags
& _IO_UNBUFFERED
)
783 || ((f
->_flags
& _IO_LINE_BUF
) && ch
== '\n'))
784 if (_IO_do_write (f
, f
->_IO_write_base
,
785 f
->_IO_write_ptr
- f
->_IO_write_base
) == EOF
)
787 return (unsigned char) ch
;
789 libc_hidden_ver (_IO_new_file_overflow
, _IO_file_overflow
)
792 _IO_new_file_sync (FILE *fp
)
797 /* char* ptr = cur_ptr(); */
798 if (fp
->_IO_write_ptr
> fp
->_IO_write_base
)
799 if (_IO_do_flush(fp
)) return EOF
;
800 delta
= fp
->_IO_read_ptr
- fp
->_IO_read_end
;
803 off64_t new_pos
= _IO_SYSSEEK (fp
, delta
, 1);
804 if (new_pos
!= (off64_t
) EOF
)
805 fp
->_IO_read_end
= fp
->_IO_read_ptr
;
806 else if (errno
== ESPIPE
)
807 ; /* Ignore error from unseekable devices. */
812 fp
->_offset
= _IO_pos_BAD
;
813 /* FIXME: Cleanup - can this be shared? */
814 /* setg(base(), ptr, ptr); */
817 libc_hidden_ver (_IO_new_file_sync
, _IO_file_sync
)
820 _IO_file_sync_mmap (FILE *fp
)
822 if (fp
->_IO_read_ptr
!= fp
->_IO_read_end
)
824 if (__lseek64 (fp
->_fileno
, fp
->_IO_read_ptr
- fp
->_IO_buf_base
,
826 != fp
->_IO_read_ptr
- fp
->_IO_buf_base
)
828 fp
->_flags
|= _IO_ERR_SEEN
;
832 fp
->_offset
= fp
->_IO_read_ptr
- fp
->_IO_buf_base
;
833 fp
->_IO_read_end
= fp
->_IO_read_ptr
= fp
->_IO_read_base
;
837 /* ftell{,o} implementation. The only time we modify the state of the stream
838 is when we have unflushed writes. In that case we seek to the end and
839 record that offset in the stream object. */
843 off64_t result
, offset
= 0;
845 /* No point looking at unflushed data if we haven't allocated buffers
847 if (fp
->_IO_buf_base
!= NULL
)
849 bool unflushed_writes
= fp
->_IO_write_ptr
> fp
->_IO_write_base
;
851 bool append_mode
= (fp
->_flags
& _IO_IS_APPENDING
) == _IO_IS_APPENDING
;
853 /* When we have unflushed writes in append mode, seek to the end of the
854 file and record that offset. This is the only time we change the file
855 stream state and it is safe since the file handle is active. */
856 if (unflushed_writes
&& append_mode
)
858 result
= _IO_SYSSEEK (fp
, 0, _IO_seek_end
);
859 if (result
== _IO_pos_BAD
)
862 fp
->_offset
= result
;
865 /* Adjust for unflushed data. */
866 if (!unflushed_writes
)
867 offset
-= fp
->_IO_read_end
- fp
->_IO_read_ptr
;
868 /* We don't trust _IO_read_end to represent the current file offset when
869 writing in append mode because the value would have to be shifted to
870 the end of the file during a flush. Use the write base instead, along
871 with the new offset we got above when we did a seek to the end of the
873 else if (append_mode
)
874 offset
+= fp
->_IO_write_ptr
- fp
->_IO_write_base
;
875 /* For all other modes, _IO_read_end represents the file offset. */
877 offset
+= fp
->_IO_write_ptr
- fp
->_IO_read_end
;
880 if (fp
->_offset
!= _IO_pos_BAD
)
881 result
= fp
->_offset
;
883 result
= _IO_SYSSEEK (fp
, 0, _IO_seek_cur
);
892 __set_errno (EINVAL
);
900 _IO_new_file_seekoff (FILE *fp
, off64_t offset
, int dir
, int mode
)
903 off64_t delta
, new_offset
;
906 /* Short-circuit into a separate function. We don't want to mix any
907 functionality and we don't want to touch anything inside the FILE
910 return do_ftell (fp
);
912 /* POSIX.1 8.2.3.7 says that after a call the fflush() the file
913 offset of the underlying file must be exact. */
914 int must_be_exact
= (fp
->_IO_read_base
== fp
->_IO_read_end
915 && fp
->_IO_write_base
== fp
->_IO_write_ptr
);
917 bool was_writing
= (fp
->_IO_write_ptr
> fp
->_IO_write_base
918 || _IO_in_put_mode (fp
));
920 /* Flush unwritten characters.
921 (This may do an unneeded write if we seek within the buffer.
922 But to be able to switch to reading, we would need to set
923 egptr to pptr. That can't be done in the current design,
924 which assumes file_ptr() is eGptr. Anyway, since we probably
925 end up flushing when we close(), it doesn't make much difference.)
926 FIXME: simulate mem-mapped files. */
927 if (was_writing
&& _IO_switch_to_get_mode (fp
))
930 if (fp
->_IO_buf_base
== NULL
)
932 /* It could be that we already have a pushback buffer. */
933 if (fp
->_IO_read_base
!= NULL
)
935 free (fp
->_IO_read_base
);
936 fp
->_flags
&= ~_IO_IN_BACKUP
;
939 _IO_setp (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
940 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
946 /* Adjust for read-ahead (bytes is buffer). */
947 offset
-= fp
->_IO_read_end
- fp
->_IO_read_ptr
;
949 if (fp
->_offset
== _IO_pos_BAD
)
951 /* Make offset absolute, assuming current pointer is file_ptr(). */
952 offset
+= fp
->_offset
;
955 __set_errno (EINVAL
);
965 struct __stat64_t64 st
;
966 if (_IO_SYSSTAT (fp
, &st
) == 0 && S_ISREG (st
.st_mode
))
968 offset
+= st
.st_size
;
976 _IO_free_backup_area (fp
);
978 /* At this point, dir==_IO_seek_set. */
980 /* If destination is within current buffer, optimize: */
981 if (fp
->_offset
!= _IO_pos_BAD
&& fp
->_IO_read_base
!= NULL
982 && !_IO_in_backup (fp
))
984 off64_t start_offset
= (fp
->_offset
985 - (fp
->_IO_read_end
- fp
->_IO_buf_base
));
986 if (offset
>= start_offset
&& offset
< fp
->_offset
)
988 _IO_setg (fp
, fp
->_IO_buf_base
,
989 fp
->_IO_buf_base
+ (offset
- start_offset
),
991 _IO_setp (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
993 _IO_mask_flags (fp
, 0, _IO_EOF_SEEN
);
998 if (fp
->_flags
& _IO_NO_READS
)
1001 /* Try to seek to a block boundary, to improve kernel page management. */
1002 new_offset
= offset
& ~(fp
->_IO_buf_end
- fp
->_IO_buf_base
- 1);
1003 delta
= offset
- new_offset
;
1004 if (delta
> fp
->_IO_buf_end
- fp
->_IO_buf_base
)
1006 new_offset
= offset
;
1009 result
= _IO_SYSSEEK (fp
, new_offset
, 0);
1016 count
= _IO_SYSREAD (fp
, fp
->_IO_buf_base
,
1018 ? delta
: fp
->_IO_buf_end
- fp
->_IO_buf_base
));
1021 /* We weren't allowed to read, but try to seek the remainder. */
1022 offset
= count
== EOF
? delta
: delta
-count
;
1027 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
+ delta
,
1028 fp
->_IO_buf_base
+ count
);
1029 _IO_setp (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
1030 fp
->_offset
= result
+ count
;
1031 _IO_mask_flags (fp
, 0, _IO_EOF_SEEN
);
1035 _IO_unsave_markers (fp
);
1036 result
= _IO_SYSSEEK (fp
, offset
, dir
);
1039 _IO_mask_flags (fp
, 0, _IO_EOF_SEEN
);
1040 fp
->_offset
= result
;
1041 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
1042 _IO_setp (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
1047 /* We need to do it since it is possible that the file offset in
1048 the kernel may be changed behind our back. It may happen when
1049 we fopen a file and then do a fork. One process may access the
1050 file and the kernel file offset will be changed. */
1051 if (fp
->_offset
>= 0)
1052 _IO_SYSSEEK (fp
, fp
->_offset
, 0);
1056 libc_hidden_ver (_IO_new_file_seekoff
, _IO_file_seekoff
)
1059 _IO_file_seekoff_mmap (FILE *fp
, off64_t offset
, int dir
, int mode
)
1063 /* If we are only interested in the current position, calculate it and
1064 return right now. This calculation does the right thing when we are
1065 using a pushback buffer, but in the usual case has the same value as
1066 (fp->_IO_read_ptr - fp->_IO_buf_base). */
1068 return fp
->_offset
- (fp
->_IO_read_end
- fp
->_IO_read_ptr
);
1073 /* Adjust for read-ahead (bytes is buffer). */
1074 offset
+= fp
->_IO_read_ptr
- fp
->_IO_read_base
;
1079 offset
+= fp
->_IO_buf_end
- fp
->_IO_buf_base
;
1082 /* At this point, dir==_IO_seek_set. */
1086 /* No negative offsets are valid. */
1087 __set_errno (EINVAL
);
1091 result
= _IO_SYSSEEK (fp
, offset
, 0);
1095 if (offset
> fp
->_IO_buf_end
- fp
->_IO_buf_base
)
1096 /* One can fseek arbitrarily past the end of the file
1097 and it is meaningless until one attempts to read.
1098 Leave the buffer pointers in EOF state until underflow. */
1099 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_end
, fp
->_IO_buf_end
);
1101 /* Adjust the read pointers to match the file position,
1102 but so the next read attempt will call underflow. */
1103 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
+ offset
,
1104 fp
->_IO_buf_base
+ offset
);
1106 fp
->_offset
= result
;
1108 _IO_mask_flags (fp
, 0, _IO_EOF_SEEN
);
1114 _IO_file_seekoff_maybe_mmap (FILE *fp
, off64_t offset
, int dir
,
1117 /* We only get here when we haven't tried to read anything yet.
1118 So there is nothing more useful for us to do here than just
1119 the underlying lseek call. */
1121 off64_t result
= _IO_SYSSEEK (fp
, offset
, dir
);
1125 fp
->_offset
= result
;
1130 _IO_file_read (FILE *fp
, void *buf
, ssize_t size
)
1132 return (__builtin_expect (fp
->_flags2
& _IO_FLAGS2_NOTCANCEL
, 0)
1133 ? __read_nocancel (fp
->_fileno
, buf
, size
)
1134 : __read (fp
->_fileno
, buf
, size
));
1136 libc_hidden_def (_IO_file_read
)
1139 _IO_file_seek (FILE *fp
, off64_t offset
, int dir
)
1141 return __lseek64 (fp
->_fileno
, offset
, dir
);
1143 libc_hidden_def (_IO_file_seek
)
1146 _IO_file_stat (FILE *fp
, void *st
)
1148 return __fstat64_time64 (fp
->_fileno
, (struct __stat64_t64
*) st
);
1150 libc_hidden_def (_IO_file_stat
)
1153 _IO_file_close_mmap (FILE *fp
)
1155 /* In addition to closing the file descriptor we have to unmap the file. */
1156 (void) __munmap (fp
->_IO_buf_base
, fp
->_IO_buf_end
- fp
->_IO_buf_base
);
1157 fp
->_IO_buf_base
= fp
->_IO_buf_end
= NULL
;
1158 /* Cancelling close should be avoided if possible since it leaves an
1159 unrecoverable state behind. */
1160 return __close_nocancel (fp
->_fileno
);
1164 _IO_file_close (FILE *fp
)
1166 /* Cancelling close should be avoided if possible since it leaves an
1167 unrecoverable state behind. */
1168 return __close_nocancel (fp
->_fileno
);
1170 libc_hidden_def (_IO_file_close
)
1173 _IO_new_file_write (FILE *f
, const void *data
, ssize_t n
)
1178 ssize_t count
= (__builtin_expect (f
->_flags2
1179 & _IO_FLAGS2_NOTCANCEL
, 0)
1180 ? __write_nocancel (f
->_fileno
, data
, to_do
)
1181 : __write (f
->_fileno
, data
, to_do
));
1184 f
->_flags
|= _IO_ERR_SEEN
;
1188 data
= (void *) ((char *) data
+ count
);
1191 if (f
->_offset
>= 0)
1197 _IO_new_file_xsputn (FILE *f
, const void *data
, size_t n
)
1199 const char *s
= (const char *) data
;
1206 /* This is an optimized implementation.
1207 If the amount to be written straddles a block boundary
1208 (or the filebuf is unbuffered), use sys_write directly. */
1210 /* First figure out how much space is available in the buffer. */
1211 if ((f
->_flags
& _IO_LINE_BUF
) && (f
->_flags
& _IO_CURRENTLY_PUTTING
))
1213 count
= f
->_IO_buf_end
- f
->_IO_write_ptr
;
1217 for (p
= s
+ n
; p
> s
; )
1228 else if (f
->_IO_write_end
> f
->_IO_write_ptr
)
1229 count
= f
->_IO_write_end
- f
->_IO_write_ptr
; /* Space available. */
1231 /* Then fill the buffer. */
1236 f
->_IO_write_ptr
= __mempcpy (f
->_IO_write_ptr
, s
, count
);
1240 if (to_do
+ must_flush
> 0)
1242 size_t block_size
, do_write
;
1243 /* Next flush the (full) buffer. */
1244 if (_IO_OVERFLOW (f
, EOF
) == EOF
)
1245 /* If nothing else has to be written we must not signal the
1246 caller that everything has been written. */
1247 return to_do
== 0 ? EOF
: n
- to_do
;
1249 /* Try to maintain alignment: write a whole number of blocks. */
1250 block_size
= f
->_IO_buf_end
- f
->_IO_buf_base
;
1251 do_write
= to_do
- (block_size
>= 128 ? to_do
% block_size
: 0);
1255 count
= new_do_write (f
, s
, do_write
);
1257 if (count
< do_write
)
1261 /* Now write out the remainder. Normally, this will fit in the
1262 buffer, but it's somewhat messier for line-buffered files,
1263 so we let _IO_default_xsputn handle the general case. */
1265 to_do
-= _IO_default_xsputn (f
, s
+do_write
, to_do
);
1269 libc_hidden_ver (_IO_new_file_xsputn
, _IO_file_xsputn
)
1272 _IO_file_xsgetn (FILE *fp
, void *data
, size_t n
)
1280 if (fp
->_IO_buf_base
== NULL
)
1282 /* Maybe we already have a push back pointer. */
1283 if (fp
->_IO_save_base
!= NULL
)
1285 free (fp
->_IO_save_base
);
1286 fp
->_flags
&= ~_IO_IN_BACKUP
;
1288 _IO_doallocbuf (fp
);
1293 have
= fp
->_IO_read_end
- fp
->_IO_read_ptr
;
1296 memcpy (s
, fp
->_IO_read_ptr
, want
);
1297 fp
->_IO_read_ptr
+= want
;
1304 s
= __mempcpy (s
, fp
->_IO_read_ptr
, have
);
1306 fp
->_IO_read_ptr
+= have
;
1309 /* Check for backup and repeat */
1310 if (_IO_in_backup (fp
))
1312 _IO_switch_to_main_get_area (fp
);
1316 /* If we now want less than a buffer, underflow and repeat
1317 the copy. Otherwise, _IO_SYSREAD directly to
1319 if (fp
->_IO_buf_base
1320 && want
< (size_t) (fp
->_IO_buf_end
- fp
->_IO_buf_base
))
1322 if (__underflow (fp
) == EOF
)
1328 /* These must be set before the sysread as we might longjmp out
1329 waiting for input. */
1330 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
1331 _IO_setp (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
1333 /* Try to maintain alignment: read a whole number of blocks. */
1335 if (fp
->_IO_buf_base
)
1337 size_t block_size
= fp
->_IO_buf_end
- fp
->_IO_buf_base
;
1338 if (block_size
>= 128)
1339 count
-= want
% block_size
;
1342 count
= _IO_SYSREAD (fp
, s
, count
);
1346 fp
->_flags
|= _IO_EOF_SEEN
;
1348 fp
->_flags
|= _IO_ERR_SEEN
;
1355 if (fp
->_offset
!= _IO_pos_BAD
)
1356 _IO_pos_adjust (fp
->_offset
, count
);
1362 libc_hidden_def (_IO_file_xsgetn
)
1365 _IO_file_xsgetn_mmap (FILE *fp
, void *data
, size_t n
)
1368 char *read_ptr
= fp
->_IO_read_ptr
;
1369 char *s
= (char *) data
;
1371 have
= fp
->_IO_read_end
- fp
->_IO_read_ptr
;
1375 if (__glibc_unlikely (_IO_in_backup (fp
)))
1377 s
= __mempcpy (s
, read_ptr
, have
);
1379 _IO_switch_to_main_get_area (fp
);
1380 read_ptr
= fp
->_IO_read_ptr
;
1381 have
= fp
->_IO_read_end
- fp
->_IO_read_ptr
;
1386 /* Check that we are mapping all of the file, in case it grew. */
1387 if (__glibc_unlikely (mmap_remap_check (fp
)))
1388 /* We punted mmap, so complete with the vanilla code. */
1389 return s
- (char *) data
+ _IO_XSGETN (fp
, data
, n
);
1391 read_ptr
= fp
->_IO_read_ptr
;
1392 have
= fp
->_IO_read_end
- read_ptr
;
1397 fp
->_flags
|= _IO_EOF_SEEN
;
1401 have
= MIN (have
, n
);
1402 s
= __mempcpy (s
, read_ptr
, have
);
1403 fp
->_IO_read_ptr
= read_ptr
+ have
;
1406 return s
- (char *) data
;
1410 _IO_file_xsgetn_maybe_mmap (FILE *fp
, void *data
, size_t n
)
1412 /* We only get here if this is the first attempt to read something.
1413 Decide which operations to use and then punt to the chosen one. */
1415 decide_maybe_mmap (fp
);
1416 return _IO_XSGETN (fp
, data
, n
);
1419 versioned_symbol (libc
, _IO_new_do_write
, _IO_do_write
, GLIBC_2_1
);
1420 versioned_symbol (libc
, _IO_new_file_attach
, _IO_file_attach
, GLIBC_2_1
);
1421 versioned_symbol (libc
, _IO_new_file_close_it
, _IO_file_close_it
, GLIBC_2_1
);
1422 versioned_symbol (libc
, _IO_new_file_finish
, _IO_file_finish
, GLIBC_2_1
);
1423 versioned_symbol (libc
, _IO_new_file_fopen
, _IO_file_fopen
, GLIBC_2_1
);
1424 versioned_symbol (libc
, _IO_new_file_init
, _IO_file_init
, GLIBC_2_1
);
1425 versioned_symbol (libc
, _IO_new_file_setbuf
, _IO_file_setbuf
, GLIBC_2_1
);
1426 versioned_symbol (libc
, _IO_new_file_sync
, _IO_file_sync
, GLIBC_2_1
);
1427 versioned_symbol (libc
, _IO_new_file_overflow
, _IO_file_overflow
, GLIBC_2_1
);
1428 versioned_symbol (libc
, _IO_new_file_seekoff
, _IO_file_seekoff
, GLIBC_2_1
);
1429 versioned_symbol (libc
, _IO_new_file_underflow
, _IO_file_underflow
, GLIBC_2_1
);
1430 versioned_symbol (libc
, _IO_new_file_write
, _IO_file_write
, GLIBC_2_1
);
1431 versioned_symbol (libc
, _IO_new_file_xsputn
, _IO_file_xsputn
, GLIBC_2_1
);