1 /* Copyright (C) 1993, 1995, 1997 Free Software Foundation, Inc.
2 This file is part of the GNU IO Library.
3 Written by Per Bothner <bothner@cygnus.com>.
5 This library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU General Public License as
7 published by the Free Software Foundation; either version 2, or (at
8 your option) any later version.
10 This library is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this library; see the file COPYING. If not, write to
17 the Free Software Foundation, 59 Temple Place - Suite 330, Boston,
20 As a special exception, if you link this library with files
21 compiled with a GNU compiler to produce an executable, this does
22 not cause the resulting executable to be covered by the GNU General
23 Public License. This exception does not however invalidate any
24 other reasons why the executable file might be covered by the GNU
25 General Public License. */
29 # define _POSIX_SOURCE
33 #include <sys/types.h>
41 # define __set_errno(Val) errno = (Val)
46 # define open(Name, Flags, Prot) __open (Name, Flags, Prot)
47 # define close(FD) __close (FD)
48 # define fstat(FD, Statbuf) __fstat (FD, Statbuf)
49 # define lseek(FD, Offset, Whence) __lseek (FD, Offset, Whence)
50 # define read(FD, Buf, NBytes) __read (FD, Buf, NBytes)
51 # define write(FD, Buf, NBytes) __write (FD, Buf, NBytes)
54 /* An fstream can be in at most one of put mode, get mode, or putback mode.
55 Putback mode is a variant of get mode.
57 In a filebuf, there is only one current position, instead of two
58 separate get and put pointers. In get mode, the current position
59 is that of gptr(); in put mode that of pptr().
61 The position in the buffer that corresponds to the position
62 in external file system is normally _IO_read_end, except in putback
63 mode, when it is _IO_save_end.
64 If the field _fb._offset is >= 0, it gives the offset in
65 the file as a whole corresponding to eGptr(). (?)
68 If a filebuf is in put mode, then all of _IO_read_ptr, _IO_read_end,
69 and _IO_read_base are equal to each other. These are usually equal
70 to _IO_buf_base, though not necessarily if we have switched from
71 get mode to put mode. (The reason is to maintain the invariant
72 that _IO_read_end corresponds to the external file position.)
73 _IO_write_base is non-NULL and usually equal to _IO_base_base.
74 We also have _IO_write_end == _IO_buf_end, but only in fully buffered mode.
75 The un-flushed character are those between _IO_write_base and _IO_write_ptr.
78 If a filebuf is in get or putback mode, eback() != egptr().
79 In get mode, the unread characters are between gptr() and egptr().
80 The OS file position corresponds to that of egptr().
83 Putback mode is used to remember "excess" characters that have
84 been sputbackc'd in a separate putback buffer.
85 In putback mode, the get buffer points to the special putback buffer.
86 The unread characters are the characters between gptr() and egptr()
87 in the putback buffer, as well as the area between save_gptr()
88 and save_egptr(), which point into the original reserve buffer.
89 (The pointers save_gptr() and save_egptr() are the values
90 of gptr() and egptr() at the time putback mode was entered.)
91 The OS position corresponds to that of save_egptr().
94 During line buffered output, _IO_write_base==base() && epptr()==base().
95 However, ptr() may be anywhere between base() and ebuf().
96 This forces a call to filebuf::overflow(int C) on every put.
97 If there is more space in the buffer, and C is not a '\n',
98 then C is inserted, and pptr() incremented.
101 If a filebuf is unbuffered(), the _shortbuf[1] is used as the buffer.
104 #define CLOSED_FILEBUF_FLAGS \
105 (_IO_IS_FILEBUF+_IO_NO_READS+_IO_NO_WRITES+_IO_TIED_PUT_GET)
112 /* POSIX.1 allows another file handle to be used to change the position
113 of our file descriptor. Hence we actually don't know the actual
114 position before we do the first fseek (and until a following fflush). */
115 fp
->_offset
= _IO_pos_BAD
;
116 fp
->_IO_file_flags
|= CLOSED_FILEBUF_FLAGS
;
123 _IO_file_close_it (fp
)
126 int write_status
, close_status
;
127 if (!_IO_file_is_open (fp
))
130 write_status
= _IO_do_flush (fp
);
132 _IO_unsave_markers(fp
);
134 close_status
= _IO_SYSCLOSE (fp
);
137 _IO_setb (fp
, NULL
, NULL
, 0);
138 _IO_setg (fp
, NULL
, NULL
, NULL
);
139 _IO_setp (fp
, NULL
, NULL
);
142 fp
->_flags
= _IO_MAGIC
|CLOSED_FILEBUF_FLAGS
;
144 fp
->_offset
= _IO_pos_BAD
;
146 return close_status
? close_status
: write_status
;
150 _IO_file_finish (fp
, dummy
)
154 if (_IO_file_is_open (fp
))
157 if (!(fp
->_flags
& _IO_DELETE_DONT_CLOSE
))
160 _IO_default_finish (fp
, 0);
164 _IO_file_fopen (fp
, filename
, mode
, is32not64
)
166 const char *filename
;
170 int oflags
= 0, omode
;
171 int read_write
, fdesc
;
173 if (_IO_file_is_open (fp
))
179 read_write
= _IO_NO_WRITES
;
183 oflags
= O_CREAT
|O_TRUNC
;
184 read_write
= _IO_NO_READS
;
188 oflags
= O_CREAT
|O_APPEND
;
189 read_write
= _IO_NO_READS
|_IO_IS_APPENDING
;
192 __set_errno (EINVAL
);
195 if (mode
[0] == '+' || (mode
[0] == 'b' && mode
[1] == '+'))
198 read_write
&= _IO_IS_APPENDING
;
202 ? open (filename
, omode
|oflags
, oprot
)
203 : _G_OPEN64 (filename
, omode
|oflags
, oprot
));
205 fdesc
= open (filename
, omode
|oflags
, oprot
);
210 _IO_mask_flags (fp
, read_write
,_IO_NO_READS
+_IO_NO_WRITES
+_IO_IS_APPENDING
);
211 if (read_write
& _IO_IS_APPENDING
)
212 if (_IO_SEEKOFF (fp
, (_IO_off64_t
)0, _IO_seek_end
, _IOS_INPUT
|_IOS_OUTPUT
)
213 == _IO_pos_BAD
&& errno
!= ESPIPE
)
220 _IO_file_attach (fp
, fd
)
224 if (_IO_file_is_open (fp
))
227 fp
->_flags
&= ~(_IO_NO_READS
+_IO_NO_WRITES
);
228 fp
->_flags
|= _IO_DELETE_DONT_CLOSE
;
229 /* Get the current position of the file. */
230 /* We have to do that since that may be junk. */
231 fp
->_offset
= _IO_pos_BAD
;
232 if (_IO_SEEKOFF (fp
, (_IO_off64_t
)0, _IO_seek_cur
, _IOS_INPUT
|_IOS_OUTPUT
)
233 == _IO_pos_BAD
&& errno
!= ESPIPE
)
239 _IO_file_setbuf (fp
, p
, len
)
244 if (_IO_default_setbuf (fp
, p
, len
) == NULL
)
247 fp
->_IO_write_base
= fp
->_IO_write_ptr
= fp
->_IO_write_end
249 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
254 /* Write TO_DO bytes from DATA to FP.
255 Then mark FP as having empty buffers. */
258 _IO_do_write (fp
, data
, to_do
)
266 if (fp
->_flags
& _IO_IS_APPENDING
)
267 /* On a system without a proper O_APPEND implementation,
268 you would need to sys_seek(0, SEEK_END) here, but is
269 is not needed nor desirable for Unix- or Posix-like systems.
270 Instead, just indicate that offset (before and after) is
272 fp
->_offset
= _IO_pos_BAD
;
273 else if (fp
->_IO_read_end
!= fp
->_IO_write_base
)
276 = _IO_SYSSEEK (fp
, fp
->_IO_write_base
- fp
->_IO_read_end
, 1);
277 if (new_pos
== _IO_pos_BAD
)
279 fp
->_offset
= new_pos
;
281 count
= _IO_SYSWRITE (fp
, data
, to_do
);
283 fp
->_cur_column
= _IO_adjust_column (fp
->_cur_column
- 1, data
, to_do
) + 1;
284 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
285 fp
->_IO_write_base
= fp
->_IO_write_ptr
= fp
->_IO_buf_base
;
286 fp
->_IO_write_end
= ((fp
->_flags
& (_IO_LINE_BUF
+_IO_UNBUFFERED
))
287 ? fp
->_IO_buf_base
: fp
->_IO_buf_end
);
288 return count
!= to_do
? EOF
: 0;
292 _IO_file_underflow (fp
)
297 /* SysV does not make this test; take it out for compatibility */
298 if (fp
->_flags
& _IO_EOF_SEEN
)
302 if (fp
->_flags
& _IO_NO_READS
)
307 if (fp
->_IO_read_ptr
< fp
->_IO_read_end
)
308 return *(unsigned char *) fp
->_IO_read_ptr
;
310 if (fp
->_IO_buf_base
== NULL
)
313 /* Flush all line buffered files before reading. */
314 /* FIXME This can/should be moved to genops ?? */
315 if (fp
->_flags
& (_IO_LINE_BUF
|_IO_UNBUFFERED
))
316 _IO_flush_all_linebuffered ();
318 _IO_switch_to_get_mode (fp
);
320 /* This is very tricky. We have to adjust those
321 pointers before we call _IO_SYSREAD () since
322 we may longjump () out while waiting for
323 input. Those pointers may be screwed up. H.J. */
324 fp
->_IO_read_base
= fp
->_IO_read_ptr
= fp
->_IO_buf_base
;
325 fp
->_IO_read_end
= fp
->_IO_buf_base
;
326 fp
->_IO_write_base
= fp
->_IO_write_ptr
= fp
->_IO_write_end
329 count
= _IO_SYSREAD (fp
, fp
->_IO_buf_base
,
330 fp
->_IO_buf_end
- fp
->_IO_buf_base
);
334 fp
->_flags
|= _IO_EOF_SEEN
;
336 fp
->_flags
|= _IO_ERR_SEEN
, count
= 0;
338 fp
->_IO_read_end
+= count
;
341 if (fp
->_offset
!= _IO_pos_BAD
)
342 _IO_pos_adjust (fp
->_offset
, count
);
343 return *(unsigned char *) fp
->_IO_read_ptr
;
347 _IO_file_overflow (f
, ch
)
351 if (f
->_flags
& _IO_NO_WRITES
) /* SET ERROR */
353 f
->_flags
|= _IO_ERR_SEEN
;
357 /* If currently reading or no buffer allocated. */
358 if ((f
->_flags
& _IO_CURRENTLY_PUTTING
) == 0)
360 /* Allocate a buffer if needed. */
361 if (f
->_IO_write_base
== 0)
364 _IO_setg (f
, f
->_IO_buf_base
, f
->_IO_buf_base
, f
->_IO_buf_base
);
366 /* Otherwise must be currently reading.
367 If _IO_read_ptr (and hence also _IO_read_end) is at the buffer end,
368 logically slide the buffer forwards one block (by setting the
369 read pointers to all point at the beginning of the block). This
370 makes room for subsequent output.
371 Otherwise, set the read pointers to _IO_read_end (leaving that
372 alone, so it can continue to correspond to the external position). */
373 if (f
->_IO_read_ptr
== f
->_IO_buf_end
)
374 f
->_IO_read_end
= f
->_IO_read_ptr
= f
->_IO_buf_base
;
375 f
->_IO_write_ptr
= f
->_IO_read_ptr
;
376 f
->_IO_write_base
= f
->_IO_write_ptr
;
377 f
->_IO_write_end
= f
->_IO_buf_end
;
378 f
->_IO_read_base
= f
->_IO_read_ptr
= f
->_IO_read_end
;
380 if (f
->_flags
& (_IO_LINE_BUF
+_IO_UNBUFFERED
))
381 f
->_IO_write_end
= f
->_IO_write_ptr
;
382 f
->_flags
|= _IO_CURRENTLY_PUTTING
;
385 return _IO_do_flush (f
);
386 if (f
->_IO_write_ptr
== f
->_IO_buf_end
) /* Buffer is really full */
387 if (_IO_do_flush (f
) == EOF
)
389 *f
->_IO_write_ptr
++ = ch
;
390 if ((f
->_flags
& _IO_UNBUFFERED
)
391 || ((f
->_flags
& _IO_LINE_BUF
) && ch
== '\n'))
392 if (_IO_do_flush (f
) == EOF
)
394 return (unsigned char) ch
;
404 _IO_cleanup_region_start ((void (*) __P ((void *))) _IO_funlockfile
, fp
);
406 /* char* ptr = cur_ptr(); */
407 if (fp
->_IO_write_ptr
> fp
->_IO_write_base
)
408 if (_IO_do_flush(fp
)) return EOF
;
409 delta
= fp
->_IO_read_ptr
- fp
->_IO_read_end
;
413 if (_IO_in_backup (fp
))
414 delta
-= eGptr () - Gbase ();
416 _IO_off64_t new_pos
= _IO_SYSSEEK (fp
, delta
, 1);
417 if (new_pos
!= (_IO_off64_t
) EOF
)
418 fp
->_IO_read_end
= fp
->_IO_read_ptr
;
420 else if (errno
== ESPIPE
)
421 ; /* Ignore error from unseekable devices. */
427 fp
->_offset
= _IO_pos_BAD
;
428 /* FIXME: Cleanup - can this be shared? */
429 /* setg(base(), ptr, ptr); */
430 _IO_cleanup_region_end (1);
435 _IO_file_seekoff (fp
, offset
, dir
, mode
)
442 _IO_off64_t delta
, new_offset
;
444 /* POSIX.1 8.2.3.7 says that after a call the fflush() the file
445 offset of the underlying file must be exact. */
446 int must_be_exact
= (fp
->_IO_read_base
== fp
->_IO_read_end
447 && fp
->_IO_write_base
== fp
->_IO_write_ptr
);
450 dir
= _IO_seek_cur
, offset
= 0; /* Don't move any pointers. */
452 /* Flush unwritten characters.
453 (This may do an unneeded write if we seek within the buffer.
454 But to be able to switch to reading, we would need to set
455 egptr to ptr. That can't be done in the current design,
456 which assumes file_ptr() is eGptr. Anyway, since we probably
457 end up flushing when we close(), it doesn't make much difference.)
458 FIXME: simulate mem-papped files. */
460 if (fp
->_IO_write_ptr
> fp
->_IO_write_base
|| _IO_in_put_mode (fp
))
461 if (_IO_switch_to_get_mode (fp
))
464 if (fp
->_IO_buf_base
== NULL
)
467 _IO_setp (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
468 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
474 /* Adjust for read-ahead (bytes is buffer). */
475 offset
-= fp
->_IO_read_end
- fp
->_IO_read_ptr
;
476 if (fp
->_offset
== _IO_pos_BAD
)
478 /* Make offset absolute, assuming current pointer is file_ptr(). */
479 offset
+= _IO_pos_as_off (fp
->_offset
);
488 if (_IO_SYSSTAT (fp
, &st
) == 0 && S_ISREG (st
.st_mode
))
490 offset
+= st
.st_size
;
497 /* At this point, dir==_IO_seek_set. */
499 /* If destination is within current buffer, optimize: */
500 if (fp
->_offset
!= _IO_pos_BAD
&& fp
->_IO_read_base
!= NULL
501 && !_IO_in_backup (fp
))
503 /* Offset relative to start of main get area. */
504 _IO_fpos64_t rel_offset
= (offset
- fp
->_offset
505 + (fp
->_IO_read_end
- fp
->_IO_read_base
));
509 if (_IO_in_backup (fp
))
510 _IO_switch_to_main_get_area (fp
);
512 if (rel_offset
<= fp
->_IO_read_end
- fp
->_IO_read_base
)
514 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
+ rel_offset
,
516 _IO_setp (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
520 /* If we have streammarkers, seek forward by reading ahead. */
521 if (_IO_have_markers (fp
))
523 int to_skip
= rel_offset
524 - (fp
->_IO_read_ptr
- fp
->_IO_read_base
);
525 if (ignore (to_skip
) != to_skip
)
532 if (rel_offset
< 0 && rel_offset
>= Bbase () - Bptr ())
534 if (!_IO_in_backup (fp
))
535 _IO_switch_to_backup_area (fp
);
536 gbump (fp
->_IO_read_end
+ rel_offset
- fp
->_IO_read_ptr
);
543 _IO_unsave_markers (fp
);
546 if (fp
->_flags
& _IO_NO_READS
)
549 /* Try to seek to a block boundary, to improve kernel page management. */
550 new_offset
= offset
& ~(fp
->_IO_buf_end
- fp
->_IO_buf_base
- 1);
551 delta
= offset
- new_offset
;
552 if (delta
> fp
->_IO_buf_end
- fp
->_IO_buf_base
)
557 result
= _IO_SYSSEEK (fp
, new_offset
, 0);
564 count
= _IO_SYSREAD (fp
, fp
->_IO_buf_base
,
566 ? delta
: fp
->_IO_buf_end
- fp
->_IO_buf_base
));
569 /* We weren't allowed to read, but try to seek the remainder. */
570 offset
= count
== EOF
? delta
: delta
-count
;
575 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
+ delta
,
576 fp
->_IO_buf_base
+ count
);
577 _IO_setp (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
578 fp
->_offset
= result
+ count
;
579 _IO_mask_flags (fp
, 0, _IO_EOF_SEEN
);
583 _IO_unsave_markers (fp
);
584 result
= _IO_SYSSEEK (fp
, offset
, dir
);
586 _IO_mask_flags (fp
, 0, _IO_EOF_SEEN
);
587 fp
->_offset
= result
;
588 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
589 _IO_setp (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
594 _IO_file_read (fp
, buf
, size
)
599 return read (fp
->_fileno
, buf
, size
);
603 _IO_file_seek (fp
, offset
, dir
)
609 return _G_LSEEK64 (fp
->_fileno
, offset
, dir
);
611 return lseek (fp
->_fileno
, offset
, dir
);
616 _IO_file_stat (fp
, st
)
621 return _G_FSTAT64 (fp
->_fileno
, (struct _G_stat64
*) st
);
623 return fstat (fp
->_fileno
, (struct _G_stat64
*) st
);
631 return close (fp
->_fileno
);
635 _IO_file_write (f
, data
, n
)
640 _IO_ssize_t to_do
= n
;
643 _IO_ssize_t count
= write (f
->_fileno
, data
, to_do
);
646 f
->_flags
|= _IO_ERR_SEEN
;
650 data
= (void *) ((char *) data
+ count
);
659 _IO_file_xsputn (f
, data
, n
)
664 register const char *s
= (char *) data
;
665 _IO_size_t to_do
= n
;
671 /* This is an optimized implementation.
672 If the amount to be written straddles a block boundary
673 (or the filebuf is unbuffered), use sys_write directly. */
675 /* First figure out how much space is available in the buffer. */
676 count
= f
->_IO_write_end
- f
->_IO_write_ptr
; /* Space available. */
677 if ((f
->_flags
& _IO_LINE_BUF
) && (f
->_flags
& _IO_CURRENTLY_PUTTING
))
679 count
= f
->_IO_buf_end
- f
->_IO_write_ptr
;
682 register const char *p
;
683 for (p
= s
+ n
; p
> s
; )
694 /* Then fill the buffer. */
701 memcpy (f
->_IO_write_ptr
, s
, count
);
706 register char *p
= f
->_IO_write_ptr
;
707 register int i
= (int) count
;
711 f
->_IO_write_ptr
+= count
;
714 if (to_do
+ must_flush
> 0)
716 _IO_size_t block_size
, dont_write
;
717 /* Next flush the (full) buffer. */
718 if (__overflow (f
, EOF
) == EOF
)
721 /* Try to maintain alignment: write a whole number of blocks.
722 dont_write is what gets left over. */
723 block_size
= f
->_IO_buf_end
- f
->_IO_buf_base
;
724 dont_write
= block_size
>= 128 ? to_do
% block_size
: 0;
726 count
= to_do
- dont_write
;
727 if (_IO_do_write (f
, s
, count
) == EOF
)
731 /* Now write out the remainder. Normally, this will fit in the
732 buffer, but it's somewhat messier for line-buffered files,
733 so we let _IO_default_xsputn handle the general case. */
735 to_do
-= _IO_default_xsputn (f
, s
+count
, dont_write
);
741 /* Work in progress */
743 _IO_file_xsgetn (fp
, data
, n
)
748 register _IO_size_t more
= n
;
749 register char *s
= data
;
752 /* Data available. */
753 _IO_ssize_t count
= fp
->_IO_read_end
- fp
->_IO_read_ptr
;
760 memcpy (s
, fp
->_IO_read_ptr
, count
);
762 fp
->_IO_read_ptr
+= count
;
768 register char *p
= fp
->_IO_read_ptr
;
769 register int i
= (int) count
;
772 fp
->_IO_read_ptr
= p
;
777 if (! _IO_in
put_mode (fp
)
778 && ! _IO_have_markers (fp
) && ! IO_have_backup (fp
))
780 /* This is an optimization of _IO_file_underflow */
781 if (fp
->_flags
& _IO_NO_READS
)
783 /* If we're reading a lot of data, don't bother allocating
784 a buffer. But if we're only reading a bit, perhaps we should ??*/
785 if (count
<= 512 && fp
->_IO_buf_base
== NULL
)
787 if (fp
->_flags
& (_IO_LINE_BUF
|_IO_UNBUFFERED
))
788 _IO_flush_all_linebuffered ();
790 _IO_switch_to_get_mode (fp
); ???;
791 count
= _IO_SYSREAD (fp
, s
, more
);
795 fp
->_flags
|= _IO_EOF_SEEN
;
797 fp
->_flags
|= _IO_ERR_SEEN
, count
= 0;
804 if (more
== 0 || __underflow (fp
) == EOF
)
811 struct _IO_jump_t _IO_file_jumps
=
814 JUMP_INIT(finish
, _IO_file_finish
),
815 JUMP_INIT(overflow
, _IO_file_overflow
),
816 JUMP_INIT(underflow
, _IO_file_underflow
),
817 JUMP_INIT(uflow
, _IO_default_uflow
),
818 JUMP_INIT(pbackfail
, _IO_default_pbackfail
),
819 JUMP_INIT(xsputn
, _IO_file_xsputn
),
820 JUMP_INIT(xsgetn
, _IO_default_xsgetn
),
821 JUMP_INIT(seekoff
, _IO_file_seekoff
),
822 JUMP_INIT(seekpos
, _IO_default_seekpos
),
823 JUMP_INIT(setbuf
, _IO_file_setbuf
),
824 JUMP_INIT(sync
, _IO_file_sync
),
825 JUMP_INIT(doallocate
, _IO_file_doallocate
),
826 JUMP_INIT(read
, _IO_file_read
),
827 JUMP_INIT(write
, _IO_file_write
),
828 JUMP_INIT(seek
, _IO_file_seek
),
829 JUMP_INIT(close
, _IO_file_close
),
830 JUMP_INIT(stat
, _IO_file_stat
),
831 JUMP_INIT(showmanyc
, _IO_default_showmanyc
),
832 JUMP_INIT(imbue
, _IO_default_imbue
)