1 /* Copyright (C) 1993-2025 Free Software Foundation, Inc.
2 Copyright The GNU Toolchain Authors.
3 This file is part of the GNU C Library.
5 The GNU C Library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Lesser General Public
7 License as published by the Free Software Foundation; either
8 version 2.1 of the License, or (at your option) any later version.
10 The GNU C Library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public
16 License along with the GNU C Library; if not, see
17 <https://www.gnu.org/licenses/>.
19 As a special exception, if you link the code in this file with
20 files compiled with a GNU compiler to produce an executable,
21 that does not cause the resulting executable to be covered by
22 the GNU Lesser General Public License. This exception does not
23 however invalidate any other reasons why the executable file
24 might be covered by the GNU Lesser General Public License.
25 This exception applies to code released by its copyright holders
26 in files containing the exception. */
33 #include <sys/param.h>
34 #include <sys/types.h>
40 #include "../wcsmbs/wcsmbsload.h"
41 #include "../iconv/gconv_charset.h"
42 #include "../iconv/gconv_int.h"
43 #include <shlib-compat.h>
44 #include <not-cancel.h>
45 #include <kernel-features.h>
47 extern struct __gconv_trans_data __libio_translit attribute_hidden
;
49 /* An fstream can be in at most one of put mode, get mode, or putback mode.
50 Putback mode is a variant of get mode.
52 In a filebuf, there is only one current position, instead of two
53 separate get and put pointers. In get mode, the current position
54 is that of gptr(); in put mode that of pptr().
56 The position in the buffer that corresponds to the position
57 in external file system is normally _IO_read_end, except in putback
58 mode, when it is _IO_save_end and also when the file is in append mode,
59 since switching from read to write mode automatically sends the position in
60 the external file system to the end of file.
61 If the field _fb._offset is >= 0, it gives the offset in
62 the file as a whole corresponding to eGptr(). (?)
65 If a filebuf is in put mode, then all of _IO_read_ptr, _IO_read_end,
66 and _IO_read_base are equal to each other. These are usually equal
67 to _IO_buf_base, though not necessarily if we have switched from
68 get mode to put mode. (The reason is to maintain the invariant
69 that _IO_read_end corresponds to the external file position.)
70 _IO_write_base is non-NULL and usually equal to _IO_buf_base.
71 We also have _IO_write_end == _IO_buf_end, but only in fully buffered mode.
72 The un-flushed character are those between _IO_write_base and _IO_write_ptr.
75 If a filebuf is in get or putback mode, eback() != egptr().
76 In get mode, the unread characters are between gptr() and egptr().
77 The OS file position corresponds to that of egptr().
80 Putback mode is used to remember "excess" characters that have
81 been sputbackc'd in a separate putback buffer.
82 In putback mode, the get buffer points to the special putback buffer.
83 The unread characters are the characters between gptr() and egptr()
84 in the putback buffer, as well as the area between save_gptr()
85 and save_egptr(), which point into the original reserve buffer.
86 (The pointers save_gptr() and save_egptr() are the values
87 of gptr() and egptr() at the time putback mode was entered.)
88 The OS position corresponds to that of save_egptr().
91 During line buffered output, _IO_write_base==base() && epptr()==base().
92 However, ptr() may be anywhere between base() and ebuf().
93 This forces a call to filebuf::overflow(int C) on every put.
94 If there is more space in the buffer, and C is not a '\n',
95 then C is inserted, and pptr() incremented.
98 If a filebuf is unbuffered(), the _shortbuf[1] is used as the buffer.
101 #define CLOSED_FILEBUF_FLAGS \
102 (_IO_IS_FILEBUF+_IO_NO_READS+_IO_NO_WRITES+_IO_TIED_PUT_GET)
106 _IO_new_file_init_internal (struct _IO_FILE_plus
*fp
)
108 /* POSIX.1 allows another file handle to be used to change the position
109 of our file descriptor. Hence we actually don't know the actual
110 position before we do the first fseek (and until a following fflush). */
111 fp
->file
._offset
= _IO_pos_BAD
;
112 fp
->file
._flags
|= CLOSED_FILEBUF_FLAGS
;
115 fp
->file
._fileno
= -1;
118 /* External version of _IO_new_file_init_internal which switches off
119 vtable validation. */
121 _IO_new_file_init (struct _IO_FILE_plus
*fp
)
123 IO_set_accept_foreign_vtables (&_IO_vtable_check
);
124 _IO_new_file_init_internal (fp
);
128 _IO_new_file_close_it (FILE *fp
)
131 if (!_IO_file_is_open (fp
))
134 if ((fp
->_flags
& _IO_NO_WRITES
) == 0
135 && (fp
->_flags
& _IO_CURRENTLY_PUTTING
) != 0)
136 write_status
= _IO_do_flush (fp
);
140 _IO_unsave_markers (fp
);
142 int close_status
= ((fp
->_flags2
& _IO_FLAGS2_NOCLOSE
) == 0
143 ? _IO_SYSCLOSE (fp
) : 0);
148 if (_IO_have_wbackup (fp
))
149 _IO_free_wbackup_area (fp
);
150 _IO_wsetb (fp
, NULL
, NULL
, 0);
151 _IO_wsetg (fp
, NULL
, NULL
, NULL
);
152 _IO_wsetp (fp
, NULL
, NULL
);
154 _IO_setb (fp
, NULL
, NULL
, 0);
155 _IO_setg (fp
, NULL
, NULL
, NULL
);
156 _IO_setp (fp
, NULL
, NULL
);
158 _IO_un_link ((struct _IO_FILE_plus
*) fp
);
159 fp
->_flags
= _IO_MAGIC
|CLOSED_FILEBUF_FLAGS
;
161 fp
->_offset
= _IO_pos_BAD
;
163 return close_status
? close_status
: write_status
;
165 libc_hidden_ver (_IO_new_file_close_it
, _IO_file_close_it
)
168 _IO_new_file_finish (FILE *fp
, int dummy
)
170 if (_IO_file_is_open (fp
))
173 if (!(fp
->_flags
& _IO_DELETE_DONT_CLOSE
))
176 _IO_default_finish (fp
, 0);
178 libc_hidden_ver (_IO_new_file_finish
, _IO_file_finish
)
181 _IO_file_open (FILE *fp
, const char *filename
, int posix_mode
, int prot
,
182 int read_write
, int is32not64
)
185 if (__glibc_unlikely (fp
->_flags2
& _IO_FLAGS2_NOTCANCEL
))
186 fdesc
= __open_nocancel (filename
,
187 posix_mode
| (is32not64
? 0 : O_LARGEFILE
), prot
);
189 fdesc
= __open (filename
, posix_mode
| (is32not64
? 0 : O_LARGEFILE
), prot
);
193 _IO_mask_flags (fp
, read_write
,_IO_NO_READS
+_IO_NO_WRITES
+_IO_IS_APPENDING
);
194 /* For append mode, send the file offset to the end of the file. Don't
195 update the offset cache though, since the file handle is not active. */
196 if ((read_write
& (_IO_IS_APPENDING
| _IO_NO_READS
))
197 == (_IO_IS_APPENDING
| _IO_NO_READS
))
199 off64_t new_pos
= _IO_SYSSEEK (fp
, 0, _IO_seek_end
);
200 if (new_pos
== _IO_pos_BAD
&& errno
!= ESPIPE
)
202 __close_nocancel (fdesc
);
206 _IO_link_in ((struct _IO_FILE_plus
*) fp
);
209 libc_hidden_def (_IO_file_open
)
212 _IO_new_file_fopen (FILE *fp
, const char *filename
, const char *mode
,
215 int oflags
= 0, omode
;
221 const char *last_recognized
;
223 if (_IO_file_is_open (fp
))
229 read_write
= _IO_NO_WRITES
;
233 oflags
= O_CREAT
|O_TRUNC
;
234 read_write
= _IO_NO_READS
;
238 oflags
= O_CREAT
|O_APPEND
;
239 read_write
= _IO_NO_READS
|_IO_IS_APPENDING
;
242 __set_errno (EINVAL
);
245 last_recognized
= mode
;
246 for (i
= 1; i
< 7; ++i
)
255 read_write
&= _IO_IS_APPENDING
;
256 last_recognized
= mode
;
260 last_recognized
= mode
;
263 last_recognized
= mode
;
266 fp
->_flags2
|= _IO_FLAGS2_MMAP
;
269 fp
->_flags2
|= _IO_FLAGS2_NOTCANCEL
;
273 fp
->_flags2
|= _IO_FLAGS2_CLOEXEC
;
282 result
= _IO_file_open (fp
, filename
, omode
|oflags
, oprot
, read_write
,
287 /* Test whether the mode string specifies the conversion. */
288 cs
= strstr (last_recognized
+ 1, ",ccs=");
291 /* Yep. Load the appropriate conversions and set the orientation
293 struct gconv_fcts fcts
;
294 struct _IO_codecvt
*cc
;
295 char *endp
= __strchrnul (cs
+ 5, ',');
296 char *ccs
= malloc (endp
- (cs
+ 5) + 3);
300 int malloc_err
= errno
; /* Whatever malloc failed with. */
301 (void) _IO_file_close_it (fp
);
302 __set_errno (malloc_err
);
306 *((char *) __mempcpy (ccs
, cs
+ 5, endp
- (cs
+ 5))) = '\0';
309 if (__wcsmbs_named_conv (&fcts
, ccs
[2] == '\0'
310 ? upstr (ccs
, cs
+ 5) : ccs
) != 0)
312 /* Something went wrong, we cannot load the conversion modules.
313 This means we cannot proceed since the user explicitly asked
315 (void) _IO_file_close_it (fp
);
317 __set_errno (EINVAL
);
323 assert (fcts
.towc_nsteps
== 1);
324 assert (fcts
.tomb_nsteps
== 1);
326 fp
->_wide_data
->_IO_read_ptr
= fp
->_wide_data
->_IO_read_end
;
327 fp
->_wide_data
->_IO_write_ptr
= fp
->_wide_data
->_IO_write_base
;
329 /* Clear the state. We start all over again. */
330 memset (&fp
->_wide_data
->_IO_state
, '\0', sizeof (__mbstate_t
));
331 memset (&fp
->_wide_data
->_IO_last_state
, '\0', sizeof (__mbstate_t
));
333 cc
= fp
->_codecvt
= &fp
->_wide_data
->_codecvt
;
335 cc
->__cd_in
.step
= fcts
.towc
;
337 cc
->__cd_in
.step_data
.__invocation_counter
= 0;
338 cc
->__cd_in
.step_data
.__internal_use
= 1;
339 cc
->__cd_in
.step_data
.__flags
= __GCONV_IS_LAST
;
340 cc
->__cd_in
.step_data
.__statep
= &result
->_wide_data
->_IO_state
;
342 cc
->__cd_out
.step
= fcts
.tomb
;
344 cc
->__cd_out
.step_data
.__invocation_counter
= 0;
345 cc
->__cd_out
.step_data
.__internal_use
= 1;
346 cc
->__cd_out
.step_data
.__flags
= __GCONV_IS_LAST
| __GCONV_TRANSLIT
;
347 cc
->__cd_out
.step_data
.__statep
= &result
->_wide_data
->_IO_state
;
349 /* From now on use the wide character callback functions. */
350 _IO_JUMPS_FILE_plus (fp
) = fp
->_wide_data
->_wide_vtable
;
352 /* Set the mode now. */
359 libc_hidden_ver (_IO_new_file_fopen
, _IO_file_fopen
)
362 _IO_new_file_attach (FILE *fp
, int fd
)
364 if (_IO_file_is_open (fp
))
367 fp
->_flags
&= ~(_IO_NO_READS
+_IO_NO_WRITES
);
368 fp
->_flags
|= _IO_DELETE_DONT_CLOSE
;
369 /* Get the current position of the file. */
370 /* We have to do that since that may be junk. */
371 fp
->_offset
= _IO_pos_BAD
;
372 int save_errno
= errno
;
373 if (_IO_SEEKOFF (fp
, (off64_t
)0, _IO_seek_cur
, _IOS_INPUT
|_IOS_OUTPUT
)
374 == _IO_pos_BAD
&& errno
!= ESPIPE
)
376 __set_errno (save_errno
);
379 libc_hidden_ver (_IO_new_file_attach
, _IO_file_attach
)
382 _IO_new_file_setbuf (FILE *fp
, char *p
, ssize_t len
)
384 if (_IO_default_setbuf (fp
, p
, len
) == NULL
)
387 fp
->_IO_write_base
= fp
->_IO_write_ptr
= fp
->_IO_write_end
389 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
393 libc_hidden_ver (_IO_new_file_setbuf
, _IO_file_setbuf
)
397 _IO_file_setbuf_mmap (FILE *fp
, char *p
, ssize_t len
)
401 /* Change the function table. */
402 _IO_JUMPS_FILE_plus (fp
) = &_IO_file_jumps
;
403 fp
->_wide_data
->_wide_vtable
= &_IO_wfile_jumps
;
405 /* And perform the normal operation. */
406 result
= _IO_new_file_setbuf (fp
, p
, len
);
408 /* If the call failed, restore to using mmap. */
411 _IO_JUMPS_FILE_plus (fp
) = &_IO_file_jumps_mmap
;
412 fp
->_wide_data
->_wide_vtable
= &_IO_wfile_jumps_mmap
;
418 static size_t new_do_write (FILE *, const char *, size_t);
420 /* Write TO_DO bytes from DATA to FP.
421 Then mark FP as having empty buffers. */
424 _IO_new_do_write (FILE *fp
, const char *data
, size_t to_do
)
427 || (size_t) new_do_write (fp
, data
, to_do
) == to_do
) ? 0 : EOF
;
429 libc_hidden_ver (_IO_new_do_write
, _IO_do_write
)
432 new_do_write (FILE *fp
, const char *data
, size_t to_do
)
435 if (fp
->_flags
& _IO_IS_APPENDING
)
436 /* On a system without a proper O_APPEND implementation,
437 you would need to sys_seek(0, SEEK_END) here, but is
438 not needed nor desirable for Unix- or Posix-like systems.
439 Instead, just indicate that offset (before and after) is
441 fp
->_offset
= _IO_pos_BAD
;
442 else if (fp
->_IO_read_end
!= fp
->_IO_write_base
)
445 = _IO_SYSSEEK (fp
, fp
->_IO_write_base
- fp
->_IO_read_end
, 1);
446 if (new_pos
== _IO_pos_BAD
)
448 fp
->_offset
= new_pos
;
450 count
= _IO_SYSWRITE (fp
, data
, to_do
);
451 if (fp
->_cur_column
&& count
)
452 fp
->_cur_column
= _IO_adjust_column (fp
->_cur_column
- 1, data
, count
) + 1;
453 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
454 fp
->_IO_write_base
= fp
->_IO_write_ptr
= fp
->_IO_buf_base
;
455 fp
->_IO_write_end
= (fp
->_mode
<= 0
456 && (fp
->_flags
& (_IO_LINE_BUF
| _IO_UNBUFFERED
))
457 ? fp
->_IO_buf_base
: fp
->_IO_buf_end
);
462 _IO_new_file_underflow (FILE *fp
)
466 /* C99 requires EOF to be "sticky". */
467 if (fp
->_flags
& _IO_EOF_SEEN
)
470 if (fp
->_flags
& _IO_NO_READS
)
472 fp
->_flags
|= _IO_ERR_SEEN
;
476 if (fp
->_IO_read_ptr
< fp
->_IO_read_end
)
477 return *(unsigned char *) fp
->_IO_read_ptr
;
479 if (fp
->_IO_buf_base
== NULL
)
481 /* Maybe we already have a push back pointer. */
482 if (fp
->_IO_save_base
!= NULL
)
484 _IO_free_backup_buf (fp
, fp
->_IO_save_base
);
485 fp
->_flags
&= ~_IO_IN_BACKUP
;
490 /* FIXME This can/should be moved to genops ?? */
491 if (fp
->_flags
& (_IO_LINE_BUF
|_IO_UNBUFFERED
))
493 /* We used to flush all line-buffered stream. This really isn't
494 required by any standard. My recollection is that
495 traditional Unix systems did this for stdout. stderr better
496 not be line buffered. So we do just that here
497 explicitly. --drepper */
498 _IO_acquire_lock (stdout
);
500 if ((stdout
->_flags
& (_IO_LINKED
| _IO_NO_WRITES
| _IO_LINE_BUF
))
501 == (_IO_LINKED
| _IO_LINE_BUF
))
502 _IO_OVERFLOW (stdout
, EOF
);
504 _IO_release_lock (stdout
);
507 _IO_switch_to_get_mode (fp
);
509 /* This is very tricky. We have to adjust those
510 pointers before we call _IO_SYSREAD () since
511 we may longjump () out while waiting for
512 input. Those pointers may be screwed up. H.J. */
513 fp
->_IO_read_base
= fp
->_IO_read_ptr
= fp
->_IO_buf_base
;
514 fp
->_IO_read_end
= fp
->_IO_buf_base
;
515 fp
->_IO_write_base
= fp
->_IO_write_ptr
= fp
->_IO_write_end
518 count
= _IO_SYSREAD (fp
, fp
->_IO_buf_base
,
519 fp
->_IO_buf_end
- fp
->_IO_buf_base
);
523 fp
->_flags
|= _IO_EOF_SEEN
;
525 fp
->_flags
|= _IO_ERR_SEEN
, count
= 0;
527 fp
->_IO_read_end
+= count
;
530 /* If a stream is read to EOF, the calling application may switch active
531 handles. As a result, our offset cache would no longer be valid, so
533 fp
->_offset
= _IO_pos_BAD
;
536 if (fp
->_offset
!= _IO_pos_BAD
)
537 _IO_pos_adjust (fp
->_offset
, count
);
538 return *(unsigned char *) fp
->_IO_read_ptr
;
540 libc_hidden_ver (_IO_new_file_underflow
, _IO_file_underflow
)
542 /* Guts of underflow callback if we mmap the file. This stats the file and
543 updates the stream state to match. In the normal case we return zero.
544 If the file is no longer eligible for mmap, its jump tables are reset to
545 the vanilla ones and we return nonzero. */
547 mmap_remap_check (FILE *fp
)
549 struct __stat64_t64 st
;
551 if (_IO_SYSSTAT (fp
, &st
) == 0
552 && S_ISREG (st
.st_mode
) && st
.st_size
!= 0
553 /* Limit the file size to 1MB for 32-bit machines. */
554 && (sizeof (ptrdiff_t) > 4 || st
.st_size
< 1*1024*1024))
556 const size_t pagesize
= __getpagesize ();
557 # define ROUNDED(x) (((x) + pagesize - 1) & ~(pagesize - 1))
558 if (ROUNDED (st
.st_size
) < ROUNDED (fp
->_IO_buf_end
561 /* We can trim off some pages past the end of the file. */
562 (void) __munmap (fp
->_IO_buf_base
+ ROUNDED (st
.st_size
),
563 ROUNDED (fp
->_IO_buf_end
- fp
->_IO_buf_base
)
564 - ROUNDED (st
.st_size
));
565 fp
->_IO_buf_end
= fp
->_IO_buf_base
+ st
.st_size
;
567 else if (ROUNDED (st
.st_size
) > ROUNDED (fp
->_IO_buf_end
570 /* The file added some pages. We need to remap it. */
573 p
= __mremap (fp
->_IO_buf_base
, ROUNDED (fp
->_IO_buf_end
575 ROUNDED (st
.st_size
), MREMAP_MAYMOVE
);
578 (void) __munmap (fp
->_IO_buf_base
,
579 fp
->_IO_buf_end
- fp
->_IO_buf_base
);
583 (void) __munmap (fp
->_IO_buf_base
,
584 fp
->_IO_buf_end
- fp
->_IO_buf_base
);
585 p
= __mmap64 (NULL
, st
.st_size
, PROT_READ
, MAP_SHARED
,
590 fp
->_IO_buf_base
= p
;
591 fp
->_IO_buf_end
= fp
->_IO_buf_base
+ st
.st_size
;
595 /* The number of pages didn't change. */
596 fp
->_IO_buf_end
= fp
->_IO_buf_base
+ st
.st_size
;
600 fp
->_offset
-= fp
->_IO_read_end
- fp
->_IO_read_ptr
;
601 _IO_setg (fp
, fp
->_IO_buf_base
,
602 fp
->_offset
< fp
->_IO_buf_end
- fp
->_IO_buf_base
603 ? fp
->_IO_buf_base
+ fp
->_offset
: fp
->_IO_buf_end
,
606 /* If we are already positioned at or past the end of the file, don't
607 change the current offset. If not, seek past what we have mapped,
608 mimicking the position left by a normal underflow reading into its
611 if (fp
->_offset
< fp
->_IO_buf_end
- fp
->_IO_buf_base
)
613 if (__lseek64 (fp
->_fileno
, fp
->_IO_buf_end
- fp
->_IO_buf_base
,
615 != fp
->_IO_buf_end
- fp
->_IO_buf_base
)
616 fp
->_flags
|= _IO_ERR_SEEN
;
618 fp
->_offset
= fp
->_IO_buf_end
- fp
->_IO_buf_base
;
625 /* Life is no longer good for mmap. Punt it. */
626 (void) __munmap (fp
->_IO_buf_base
,
627 fp
->_IO_buf_end
- fp
->_IO_buf_base
);
629 fp
->_IO_buf_base
= fp
->_IO_buf_end
= NULL
;
630 _IO_setg (fp
, NULL
, NULL
, NULL
);
632 _IO_JUMPS_FILE_plus (fp
) = &_IO_file_jumps
;
634 _IO_JUMPS_FILE_plus (fp
) = &_IO_wfile_jumps
;
635 fp
->_wide_data
->_wide_vtable
= &_IO_wfile_jumps
;
641 /* Special callback replacing the underflow callbacks if we mmap the file. */
643 _IO_file_underflow_mmap (FILE *fp
)
645 if (fp
->_IO_read_ptr
< fp
->_IO_read_end
)
646 return *(unsigned char *) fp
->_IO_read_ptr
;
648 if (__glibc_unlikely (mmap_remap_check (fp
)))
649 /* We punted to the regular file functions. */
650 return _IO_UNDERFLOW (fp
);
652 if (fp
->_IO_read_ptr
< fp
->_IO_read_end
)
653 return *(unsigned char *) fp
->_IO_read_ptr
;
655 fp
->_flags
|= _IO_EOF_SEEN
;
660 decide_maybe_mmap (FILE *fp
)
662 /* We use the file in read-only mode. This could mean we can
663 mmap the file and use it without any copying. But not all
664 file descriptors are for mmap-able objects and on 32-bit
665 machines we don't want to map files which are too large since
666 this would require too much virtual memory. */
667 struct __stat64_t64 st
;
669 if (_IO_SYSSTAT (fp
, &st
) == 0
670 && S_ISREG (st
.st_mode
) && st
.st_size
!= 0
671 /* Limit the file size to 1MB for 32-bit machines. */
672 && (sizeof (ptrdiff_t) > 4 || st
.st_size
< 1*1024*1024)
674 && (fp
->_offset
== _IO_pos_BAD
|| fp
->_offset
<= st
.st_size
))
676 /* Try to map the file. */
679 p
= __mmap64 (NULL
, st
.st_size
, PROT_READ
, MAP_SHARED
, fp
->_fileno
, 0);
682 /* OK, we managed to map the file. Set the buffer up and use a
683 special jump table with simplified underflow functions which
684 never tries to read anything from the file. */
686 if (__lseek64 (fp
->_fileno
, st
.st_size
, SEEK_SET
) != st
.st_size
)
688 (void) __munmap (p
, st
.st_size
);
689 fp
->_offset
= _IO_pos_BAD
;
693 _IO_setb (fp
, p
, (char *) p
+ st
.st_size
, 0);
695 if (fp
->_offset
== _IO_pos_BAD
)
698 _IO_setg (fp
, p
, p
+ fp
->_offset
, p
+ st
.st_size
);
699 fp
->_offset
= st
.st_size
;
702 _IO_JUMPS_FILE_plus (fp
) = &_IO_file_jumps_mmap
;
704 _IO_JUMPS_FILE_plus (fp
) = &_IO_wfile_jumps_mmap
;
705 fp
->_wide_data
->_wide_vtable
= &_IO_wfile_jumps_mmap
;
712 /* We couldn't use mmap, so revert to the vanilla file operations. */
715 _IO_JUMPS_FILE_plus (fp
) = &_IO_file_jumps
;
717 _IO_JUMPS_FILE_plus (fp
) = &_IO_wfile_jumps
;
718 fp
->_wide_data
->_wide_vtable
= &_IO_wfile_jumps
;
722 _IO_file_underflow_maybe_mmap (FILE *fp
)
724 /* This is the first read attempt. Choose mmap or vanilla operations
725 and then punt to the chosen underflow routine. */
726 decide_maybe_mmap (fp
);
727 return _IO_UNDERFLOW (fp
);
732 _IO_new_file_overflow (FILE *f
, int ch
)
734 if (f
->_flags
& _IO_NO_WRITES
) /* SET ERROR */
736 f
->_flags
|= _IO_ERR_SEEN
;
740 /* If currently reading or no buffer allocated. */
741 if ((f
->_flags
& _IO_CURRENTLY_PUTTING
) == 0 || f
->_IO_write_base
== NULL
)
743 /* Allocate a buffer if needed. */
744 if (f
->_IO_write_base
== NULL
)
747 _IO_setg (f
, f
->_IO_buf_base
, f
->_IO_buf_base
, f
->_IO_buf_base
);
749 /* Otherwise must be currently reading.
750 If _IO_read_ptr (and hence also _IO_read_end) is at the buffer end,
751 logically slide the buffer forwards one block (by setting the
752 read pointers to all point at the beginning of the block). This
753 makes room for subsequent output.
754 Otherwise, set the read pointers to _IO_read_end (leaving that
755 alone, so it can continue to correspond to the external position). */
756 if (__glibc_unlikely (_IO_in_backup (f
)))
758 size_t nbackup
= f
->_IO_read_end
- f
->_IO_read_ptr
;
759 _IO_free_backup_area (f
);
760 f
->_IO_read_base
-= MIN (nbackup
,
761 f
->_IO_read_base
- f
->_IO_buf_base
);
762 f
->_IO_read_ptr
= f
->_IO_read_base
;
765 if (f
->_IO_read_ptr
== f
->_IO_buf_end
)
766 f
->_IO_read_end
= f
->_IO_read_ptr
= f
->_IO_buf_base
;
767 f
->_IO_write_ptr
= f
->_IO_read_ptr
;
768 f
->_IO_write_base
= f
->_IO_write_ptr
;
769 f
->_IO_write_end
= f
->_IO_buf_end
;
770 f
->_IO_read_base
= f
->_IO_read_ptr
= f
->_IO_read_end
;
772 f
->_flags
|= _IO_CURRENTLY_PUTTING
;
773 if (f
->_mode
<= 0 && f
->_flags
& (_IO_LINE_BUF
| _IO_UNBUFFERED
))
774 f
->_IO_write_end
= f
->_IO_write_ptr
;
777 return _IO_do_write (f
, f
->_IO_write_base
,
778 f
->_IO_write_ptr
- f
->_IO_write_base
);
779 if (f
->_IO_write_ptr
== f
->_IO_buf_end
) /* Buffer is really full */
780 if (_IO_do_flush (f
) == EOF
)
782 *f
->_IO_write_ptr
++ = ch
;
783 if ((f
->_flags
& _IO_UNBUFFERED
)
784 || ((f
->_flags
& _IO_LINE_BUF
) && ch
== '\n'))
785 if (_IO_do_write (f
, f
->_IO_write_base
,
786 f
->_IO_write_ptr
- f
->_IO_write_base
) == EOF
)
788 return (unsigned char) ch
;
790 libc_hidden_ver (_IO_new_file_overflow
, _IO_file_overflow
)
793 _IO_new_file_sync (FILE *fp
)
798 /* char* ptr = cur_ptr(); */
799 if (fp
->_IO_write_ptr
> fp
->_IO_write_base
)
800 if (_IO_do_flush(fp
)) return EOF
;
801 delta
= fp
->_IO_read_ptr
- fp
->_IO_read_end
;
804 off64_t new_pos
= _IO_SYSSEEK (fp
, delta
, 1);
805 if (new_pos
!= (off64_t
) EOF
)
806 fp
->_IO_read_end
= fp
->_IO_read_ptr
;
807 else if (errno
== ESPIPE
)
808 ; /* Ignore error from unseekable devices. */
813 fp
->_offset
= _IO_pos_BAD
;
814 /* FIXME: Cleanup - can this be shared? */
815 /* setg(base(), ptr, ptr); */
818 libc_hidden_ver (_IO_new_file_sync
, _IO_file_sync
)
821 _IO_file_sync_mmap (FILE *fp
)
823 if (fp
->_IO_read_ptr
!= fp
->_IO_read_end
)
825 if (__lseek64 (fp
->_fileno
, fp
->_IO_read_ptr
- fp
->_IO_buf_base
,
827 != fp
->_IO_read_ptr
- fp
->_IO_buf_base
)
829 fp
->_flags
|= _IO_ERR_SEEN
;
833 fp
->_offset
= fp
->_IO_read_ptr
- fp
->_IO_buf_base
;
834 fp
->_IO_read_end
= fp
->_IO_read_ptr
= fp
->_IO_read_base
;
838 /* ftell{,o} implementation. The only time we modify the state of the stream
839 is when we have unflushed writes. In that case we seek to the end and
840 record that offset in the stream object. */
844 off64_t result
, offset
= 0;
846 /* No point looking at unflushed data if we haven't allocated buffers
848 if (fp
->_IO_buf_base
!= NULL
)
850 bool unflushed_writes
= fp
->_IO_write_ptr
> fp
->_IO_write_base
;
852 bool append_mode
= (fp
->_flags
& _IO_IS_APPENDING
) == _IO_IS_APPENDING
;
854 /* When we have unflushed writes in append mode, seek to the end of the
855 file and record that offset. This is the only time we change the file
856 stream state and it is safe since the file handle is active. */
857 if (unflushed_writes
&& append_mode
)
859 result
= _IO_SYSSEEK (fp
, 0, _IO_seek_end
);
860 if (result
== _IO_pos_BAD
)
863 fp
->_offset
= result
;
866 /* Adjust for unflushed data. */
867 if (!unflushed_writes
)
868 offset
-= fp
->_IO_read_end
- fp
->_IO_read_ptr
;
869 /* We don't trust _IO_read_end to represent the current file offset when
870 writing in append mode because the value would have to be shifted to
871 the end of the file during a flush. Use the write base instead, along
872 with the new offset we got above when we did a seek to the end of the
874 else if (append_mode
)
875 offset
+= fp
->_IO_write_ptr
- fp
->_IO_write_base
;
876 /* For all other modes, _IO_read_end represents the file offset. */
878 offset
+= fp
->_IO_write_ptr
- fp
->_IO_read_end
;
881 if (fp
->_offset
!= _IO_pos_BAD
)
882 result
= fp
->_offset
;
884 result
= _IO_SYSSEEK (fp
, 0, _IO_seek_cur
);
893 __set_errno (EINVAL
);
901 _IO_new_file_seekoff (FILE *fp
, off64_t offset
, int dir
, int mode
)
904 off64_t delta
, new_offset
;
907 /* Short-circuit into a separate function. We don't want to mix any
908 functionality and we don't want to touch anything inside the FILE
911 return do_ftell (fp
);
913 /* POSIX.1 8.2.3.7 says that after a call the fflush() the file
914 offset of the underlying file must be exact. */
915 int must_be_exact
= (fp
->_IO_read_base
== fp
->_IO_read_end
916 && fp
->_IO_write_base
== fp
->_IO_write_ptr
);
918 bool was_writing
= (fp
->_IO_write_ptr
> fp
->_IO_write_base
919 || _IO_in_put_mode (fp
));
921 /* Flush unwritten characters.
922 (This may do an unneeded write if we seek within the buffer.
923 But to be able to switch to reading, we would need to set
924 egptr to pptr. That can't be done in the current design,
925 which assumes file_ptr() is eGptr. Anyway, since we probably
926 end up flushing when we close(), it doesn't make much difference.)
927 FIXME: simulate mem-mapped files. */
928 if (was_writing
&& _IO_switch_to_get_mode (fp
))
931 if (fp
->_IO_buf_base
== NULL
)
933 /* It could be that we already have a pushback buffer. */
934 if (fp
->_IO_read_base
!= NULL
)
936 _IO_free_backup_buf (fp
, fp
->_IO_read_base
);
937 fp
->_flags
&= ~_IO_IN_BACKUP
;
940 _IO_setp (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
941 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
947 /* Adjust for read-ahead (bytes is buffer). */
948 offset
-= fp
->_IO_read_end
- fp
->_IO_read_ptr
;
950 if (fp
->_offset
== _IO_pos_BAD
)
952 /* Make offset absolute, assuming current pointer is file_ptr(). */
953 offset
+= fp
->_offset
;
956 __set_errno (EINVAL
);
966 struct __stat64_t64 st
;
967 if (_IO_SYSSTAT (fp
, &st
) == 0 && S_ISREG (st
.st_mode
))
969 offset
+= st
.st_size
;
977 _IO_free_backup_area (fp
);
979 /* At this point, dir==_IO_seek_set. */
981 /* If destination is within current buffer, optimize: */
982 if (fp
->_offset
!= _IO_pos_BAD
&& fp
->_IO_read_base
!= NULL
983 && !_IO_in_backup (fp
))
985 off64_t start_offset
= (fp
->_offset
986 - (fp
->_IO_read_end
- fp
->_IO_buf_base
));
987 if (offset
>= start_offset
&& offset
< fp
->_offset
)
989 _IO_setg (fp
, fp
->_IO_buf_base
,
990 fp
->_IO_buf_base
+ (offset
- start_offset
),
992 _IO_setp (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
994 _IO_mask_flags (fp
, 0, _IO_EOF_SEEN
);
999 if (fp
->_flags
& _IO_NO_READS
)
1002 /* Try to seek to a block boundary, to improve kernel page management. */
1003 new_offset
= offset
& ~(fp
->_IO_buf_end
- fp
->_IO_buf_base
- 1);
1004 delta
= offset
- new_offset
;
1005 if (delta
> fp
->_IO_buf_end
- fp
->_IO_buf_base
)
1007 new_offset
= offset
;
1010 result
= _IO_SYSSEEK (fp
, new_offset
, 0);
1017 count
= _IO_SYSREAD (fp
, fp
->_IO_buf_base
,
1019 ? delta
: fp
->_IO_buf_end
- fp
->_IO_buf_base
));
1022 /* We weren't allowed to read, but try to seek the remainder. */
1023 offset
= count
== EOF
? delta
: delta
-count
;
1028 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
+ delta
,
1029 fp
->_IO_buf_base
+ count
);
1030 _IO_setp (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
1031 fp
->_offset
= result
+ count
;
1032 _IO_mask_flags (fp
, 0, _IO_EOF_SEEN
);
1036 _IO_unsave_markers (fp
);
1037 result
= _IO_SYSSEEK (fp
, offset
, dir
);
1040 _IO_mask_flags (fp
, 0, _IO_EOF_SEEN
);
1041 fp
->_offset
= result
;
1042 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
1043 _IO_setp (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
1048 /* We need to do it since it is possible that the file offset in
1049 the kernel may be changed behind our back. It may happen when
1050 we fopen a file and then do a fork. One process may access the
1051 file and the kernel file offset will be changed. */
1052 if (fp
->_offset
>= 0)
1053 _IO_SYSSEEK (fp
, fp
->_offset
, 0);
1057 libc_hidden_ver (_IO_new_file_seekoff
, _IO_file_seekoff
)
1060 _IO_file_seekoff_mmap (FILE *fp
, off64_t offset
, int dir
, int mode
)
1064 /* If we are only interested in the current position, calculate it and
1065 return right now. This calculation does the right thing when we are
1066 using a pushback buffer, but in the usual case has the same value as
1067 (fp->_IO_read_ptr - fp->_IO_buf_base). */
1069 return fp
->_offset
- (fp
->_IO_read_end
- fp
->_IO_read_ptr
);
1074 /* Adjust for read-ahead (bytes is buffer). */
1075 offset
+= fp
->_IO_read_ptr
- fp
->_IO_read_base
;
1080 offset
+= fp
->_IO_buf_end
- fp
->_IO_buf_base
;
1083 /* At this point, dir==_IO_seek_set. */
1087 /* No negative offsets are valid. */
1088 __set_errno (EINVAL
);
1092 result
= _IO_SYSSEEK (fp
, offset
, 0);
1096 if (offset
> fp
->_IO_buf_end
- fp
->_IO_buf_base
)
1097 /* One can fseek arbitrarily past the end of the file
1098 and it is meaningless until one attempts to read.
1099 Leave the buffer pointers in EOF state until underflow. */
1100 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_end
, fp
->_IO_buf_end
);
1102 /* Adjust the read pointers to match the file position,
1103 but so the next read attempt will call underflow. */
1104 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
+ offset
,
1105 fp
->_IO_buf_base
+ offset
);
1107 fp
->_offset
= result
;
1109 _IO_mask_flags (fp
, 0, _IO_EOF_SEEN
);
1115 _IO_file_seekoff_maybe_mmap (FILE *fp
, off64_t offset
, int dir
,
1118 /* We only get here when we haven't tried to read anything yet.
1119 So there is nothing more useful for us to do here than just
1120 the underlying lseek call. */
1122 off64_t result
= _IO_SYSSEEK (fp
, offset
, dir
);
1126 fp
->_offset
= result
;
1131 _IO_file_read (FILE *fp
, void *buf
, ssize_t size
)
1133 return (__builtin_expect (fp
->_flags2
& _IO_FLAGS2_NOTCANCEL
, 0)
1134 ? __read_nocancel (fp
->_fileno
, buf
, size
)
1135 : __read (fp
->_fileno
, buf
, size
));
1137 libc_hidden_def (_IO_file_read
)
1140 _IO_file_seek (FILE *fp
, off64_t offset
, int dir
)
1142 return __lseek64 (fp
->_fileno
, offset
, dir
);
1144 libc_hidden_def (_IO_file_seek
)
1147 _IO_file_stat (FILE *fp
, void *st
)
1149 return __fstat64_time64 (fp
->_fileno
, (struct __stat64_t64
*) st
);
1151 libc_hidden_def (_IO_file_stat
)
1154 _IO_file_close_mmap (FILE *fp
)
1156 /* In addition to closing the file descriptor we have to unmap the file. */
1157 (void) __munmap (fp
->_IO_buf_base
, fp
->_IO_buf_end
- fp
->_IO_buf_base
);
1158 fp
->_IO_buf_base
= fp
->_IO_buf_end
= NULL
;
1159 /* Cancelling close should be avoided if possible since it leaves an
1160 unrecoverable state behind. */
1161 return __close_nocancel (fp
->_fileno
);
1165 _IO_file_close (FILE *fp
)
1167 /* Cancelling close should be avoided if possible since it leaves an
1168 unrecoverable state behind. */
1169 return __close_nocancel (fp
->_fileno
);
1171 libc_hidden_def (_IO_file_close
)
1174 _IO_new_file_write (FILE *f
, const void *data
, ssize_t n
)
1179 ssize_t count
= (__builtin_expect (f
->_flags2
1180 & _IO_FLAGS2_NOTCANCEL
, 0)
1181 ? __write_nocancel (f
->_fileno
, data
, to_do
)
1182 : __write (f
->_fileno
, data
, to_do
));
1185 f
->_flags
|= _IO_ERR_SEEN
;
1189 data
= (void *) ((char *) data
+ count
);
1192 if (f
->_offset
>= 0)
1198 _IO_new_file_xsputn (FILE *f
, const void *data
, size_t n
)
1200 const char *s
= (const char *) data
;
1207 /* This is an optimized implementation.
1208 If the amount to be written straddles a block boundary
1209 (or the filebuf is unbuffered), use sys_write directly. */
1211 /* First figure out how much space is available in the buffer. */
1212 if ((f
->_flags
& _IO_LINE_BUF
) && (f
->_flags
& _IO_CURRENTLY_PUTTING
))
1214 count
= f
->_IO_buf_end
- f
->_IO_write_ptr
;
1218 for (p
= s
+ n
; p
> s
; )
1229 else if (f
->_IO_write_end
> f
->_IO_write_ptr
)
1230 count
= f
->_IO_write_end
- f
->_IO_write_ptr
; /* Space available. */
1232 /* Then fill the buffer. */
1237 f
->_IO_write_ptr
= __mempcpy (f
->_IO_write_ptr
, s
, count
);
1241 if (to_do
+ must_flush
> 0)
1243 size_t block_size
, do_write
;
1244 /* Next flush the (full) buffer. */
1245 if (_IO_OVERFLOW (f
, EOF
) == EOF
)
1246 /* If nothing else has to be written we must not signal the
1247 caller that everything has been written. */
1248 return to_do
== 0 ? EOF
: n
- to_do
;
1250 /* Try to maintain alignment: write a whole number of blocks. */
1251 block_size
= f
->_IO_buf_end
- f
->_IO_buf_base
;
1252 do_write
= to_do
- (block_size
>= 128 ? to_do
% block_size
: 0);
1256 count
= new_do_write (f
, s
, do_write
);
1258 if (count
< do_write
)
1262 /* Now write out the remainder. Normally, this will fit in the
1263 buffer, but it's somewhat messier for line-buffered files,
1264 so we let _IO_default_xsputn handle the general case. */
1266 to_do
-= _IO_default_xsputn (f
, s
+do_write
, to_do
);
1270 libc_hidden_ver (_IO_new_file_xsputn
, _IO_file_xsputn
)
1273 _IO_file_xsgetn (FILE *fp
, void *data
, size_t n
)
1281 if (fp
->_IO_buf_base
== NULL
)
1283 /* Maybe we already have a push back pointer. */
1284 if (fp
->_IO_save_base
!= NULL
)
1286 _IO_free_backup_buf (fp
, fp
->_IO_save_base
);
1287 fp
->_flags
&= ~_IO_IN_BACKUP
;
1289 _IO_doallocbuf (fp
);
1294 have
= fp
->_IO_read_end
- fp
->_IO_read_ptr
;
1297 memcpy (s
, fp
->_IO_read_ptr
, want
);
1298 fp
->_IO_read_ptr
+= want
;
1305 s
= __mempcpy (s
, fp
->_IO_read_ptr
, have
);
1307 fp
->_IO_read_ptr
+= have
;
1310 /* Check for backup and repeat */
1311 if (_IO_in_backup (fp
))
1313 _IO_switch_to_main_get_area (fp
);
1317 /* If we now want less than a buffer, underflow and repeat
1318 the copy. Otherwise, _IO_SYSREAD directly to
1320 if (fp
->_IO_buf_base
1321 && want
< (size_t) (fp
->_IO_buf_end
- fp
->_IO_buf_base
))
1323 if (__underflow (fp
) == EOF
)
1329 /* These must be set before the sysread as we might longjmp out
1330 waiting for input. */
1331 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
1332 _IO_setp (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
1334 /* Try to maintain alignment: read a whole number of blocks. */
1336 if (fp
->_IO_buf_base
)
1338 size_t block_size
= fp
->_IO_buf_end
- fp
->_IO_buf_base
;
1339 if (block_size
>= 128)
1340 count
-= want
% block_size
;
1343 count
= _IO_SYSREAD (fp
, s
, count
);
1347 fp
->_flags
|= _IO_EOF_SEEN
;
1349 fp
->_flags
|= _IO_ERR_SEEN
;
1356 if (fp
->_offset
!= _IO_pos_BAD
)
1357 _IO_pos_adjust (fp
->_offset
, count
);
1363 libc_hidden_def (_IO_file_xsgetn
)
1366 _IO_file_xsgetn_mmap (FILE *fp
, void *data
, size_t n
)
1369 char *read_ptr
= fp
->_IO_read_ptr
;
1370 char *s
= (char *) data
;
1372 have
= fp
->_IO_read_end
- fp
->_IO_read_ptr
;
1376 if (__glibc_unlikely (_IO_in_backup (fp
)))
1378 s
= __mempcpy (s
, read_ptr
, have
);
1380 _IO_switch_to_main_get_area (fp
);
1381 read_ptr
= fp
->_IO_read_ptr
;
1382 have
= fp
->_IO_read_end
- fp
->_IO_read_ptr
;
1387 /* Check that we are mapping all of the file, in case it grew. */
1388 if (__glibc_unlikely (mmap_remap_check (fp
)))
1389 /* We punted mmap, so complete with the vanilla code. */
1390 return s
- (char *) data
+ _IO_XSGETN (fp
, data
, n
);
1392 read_ptr
= fp
->_IO_read_ptr
;
1393 have
= fp
->_IO_read_end
- read_ptr
;
1398 fp
->_flags
|= _IO_EOF_SEEN
;
1402 have
= MIN (have
, n
);
1403 s
= __mempcpy (s
, read_ptr
, have
);
1404 fp
->_IO_read_ptr
= read_ptr
+ have
;
1407 return s
- (char *) data
;
1411 _IO_file_xsgetn_maybe_mmap (FILE *fp
, void *data
, size_t n
)
1413 /* We only get here if this is the first attempt to read something.
1414 Decide which operations to use and then punt to the chosen one. */
1416 decide_maybe_mmap (fp
);
1417 return _IO_XSGETN (fp
, data
, n
);
1420 versioned_symbol (libc
, _IO_new_do_write
, _IO_do_write
, GLIBC_2_1
);
1421 versioned_symbol (libc
, _IO_new_file_attach
, _IO_file_attach
, GLIBC_2_1
);
1422 versioned_symbol (libc
, _IO_new_file_close_it
, _IO_file_close_it
, GLIBC_2_1
);
1423 versioned_symbol (libc
, _IO_new_file_finish
, _IO_file_finish
, GLIBC_2_1
);
1424 versioned_symbol (libc
, _IO_new_file_fopen
, _IO_file_fopen
, GLIBC_2_1
);
1425 versioned_symbol (libc
, _IO_new_file_init
, _IO_file_init
, GLIBC_2_1
);
1426 versioned_symbol (libc
, _IO_new_file_setbuf
, _IO_file_setbuf
, GLIBC_2_1
);
1427 versioned_symbol (libc
, _IO_new_file_sync
, _IO_file_sync
, GLIBC_2_1
);
1428 versioned_symbol (libc
, _IO_new_file_overflow
, _IO_file_overflow
, GLIBC_2_1
);
1429 versioned_symbol (libc
, _IO_new_file_seekoff
, _IO_file_seekoff
, GLIBC_2_1
);
1430 versioned_symbol (libc
, _IO_new_file_underflow
, _IO_file_underflow
, GLIBC_2_1
);
1431 versioned_symbol (libc
, _IO_new_file_write
, _IO_file_write
, GLIBC_2_1
);
1432 versioned_symbol (libc
, _IO_new_file_xsputn
, _IO_file_xsputn
, GLIBC_2_1
);