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>
43 # define open(Name, Flags, Prot) __open ((Name), (Flags), (Prot))
46 /* An fstream can be in at most one of put mode, get mode, or putback mode.
47 Putback mode is a variant of get mode.
49 In a filebuf, there is only one current position, instead of two
50 separate get and put pointers. In get mode, the current position
51 is that of gptr(); in put mode that of pptr().
53 The position in the buffer that corresponds to the position
54 in external file system is normally _IO_read_end, except in putback
55 mode, when it is _IO_save_end.
56 If the field _fb._offset is >= 0, it gives the offset in
57 the file as a whole corresponding to eGptr(). (?)
60 If a filebuf is in put mode, then all of _IO_read_ptr, _IO_read_end,
61 and _IO_read_base are equal to each other. These are usually equal
62 to _IO_buf_base, though not necessarily if we have switched from
63 get mode to put mode. (The reason is to maintain the invariant
64 that _IO_read_end corresponds to the external file position.)
65 _IO_write_base is non-NULL and usually equal to _IO_base_base.
66 We also have _IO_write_end == _IO_buf_end, but only in fully buffered mode.
67 The un-flushed character are those between _IO_write_base and _IO_write_ptr.
70 If a filebuf is in get or putback mode, eback() != egptr().
71 In get mode, the unread characters are between gptr() and egptr().
72 The OS file position corresponds to that of egptr().
75 Putback mode is used to remember "excess" characters that have
76 been sputbackc'd in a separate putback buffer.
77 In putback mode, the get buffer points to the special putback buffer.
78 The unread characters are the characters between gptr() and egptr()
79 in the putback buffer, as well as the area between save_gptr()
80 and save_egptr(), which point into the original reserve buffer.
81 (The pointers save_gptr() and save_egptr() are the values
82 of gptr() and egptr() at the time putback mode was entered.)
83 The OS position corresponds to that of save_egptr().
86 During line buffered output, _IO_write_base==base() && epptr()==base().
87 However, ptr() may be anywhere between base() and ebuf().
88 This forces a call to filebuf::overflow(int C) on every put.
89 If there is more space in the buffer, and C is not a '\n',
90 then C is inserted, and pptr() incremented.
93 If a filebuf is unbuffered(), the _shortbuf[1] is used as the buffer.
96 #define CLOSED_FILEBUF_FLAGS \
97 (_IO_IS_FILEBUF+_IO_NO_READS+_IO_NO_WRITES+_IO_TIED_PUT_GET)
104 /* POSIX.1 allows another file handle to be used to change the position
105 of our file descriptor. Hence we actually don't know the actual
106 position before we do the first fseek (and until a following fflush). */
107 fp
->_offset
= _IO_pos_BAD
;
108 fp
->_IO_file_flags
|= CLOSED_FILEBUF_FLAGS
;
115 _IO_file_close_it (fp
)
118 int write_status
, close_status
;
119 if (!_IO_file_is_open (fp
))
122 write_status
= _IO_do_flush (fp
);
124 _IO_unsave_markers(fp
);
126 close_status
= _IO_SYSCLOSE (fp
);
129 _IO_setb (fp
, NULL
, NULL
, 0);
130 _IO_setg (fp
, NULL
, NULL
, NULL
);
131 _IO_setp (fp
, NULL
, NULL
);
134 fp
->_flags
= _IO_MAGIC
|CLOSED_FILEBUF_FLAGS
;
136 fp
->_offset
= _IO_pos_BAD
;
138 return close_status
? close_status
: write_status
;
142 _IO_file_finish (fp
, dummy
)
146 if (_IO_file_is_open (fp
))
149 if (!(fp
->_flags
& _IO_DELETE_DONT_CLOSE
))
152 _IO_default_finish (fp
, 0);
156 _IO_file_fopen (fp
, filename
, mode
)
158 const char *filename
;
161 int oflags
= 0, omode
;
162 int read_write
, fdesc
;
164 if (_IO_file_is_open (fp
))
170 read_write
= _IO_NO_WRITES
;
174 oflags
= O_CREAT
|O_TRUNC
;
175 read_write
= _IO_NO_READS
;
179 oflags
= O_CREAT
|O_APPEND
;
180 read_write
= _IO_NO_READS
|_IO_IS_APPENDING
;
183 __set_errno (EINVAL
);
186 if (mode
[0] == '+' || (mode
[0] == 'b' && mode
[1] == '+'))
189 read_write
&= _IO_IS_APPENDING
;
191 fdesc
= open (filename
, omode
|oflags
, oprot
);
195 _IO_mask_flags (fp
, read_write
,_IO_NO_READS
+_IO_NO_WRITES
+_IO_IS_APPENDING
);
196 if (read_write
& _IO_IS_APPENDING
)
197 if (_IO_SEEKOFF (fp
, (_IO_off_t
)0, _IO_seek_end
, _IOS_INPUT
|_IOS_OUTPUT
)
198 == _IO_pos_BAD
&& errno
!= ESPIPE
)
205 _IO_file_attach (fp
, fd
)
209 if (_IO_file_is_open (fp
))
212 fp
->_flags
&= ~(_IO_NO_READS
+_IO_NO_WRITES
);
213 fp
->_flags
|= _IO_DELETE_DONT_CLOSE
;
214 /* Get the current position of the file. */
215 /* We have to do that since that may be junk. */
216 fp
->_offset
= _IO_pos_BAD
;
217 if (_IO_SEEKOFF (fp
, (_IO_off_t
)0, _IO_seek_cur
, _IOS_INPUT
|_IOS_OUTPUT
)
218 == _IO_pos_BAD
&& errno
!= ESPIPE
)
224 _IO_file_setbuf (fp
, p
, len
)
229 if (_IO_default_setbuf (fp
, p
, len
) == NULL
)
232 fp
->_IO_write_base
= fp
->_IO_write_ptr
= fp
->_IO_write_end
234 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
239 /* Write TO_DO bytes from DATA to FP.
240 Then mark FP as having empty buffers. */
243 _IO_do_write (fp
, data
, to_do
)
251 if (fp
->_flags
& _IO_IS_APPENDING
)
252 /* On a system without a proper O_APPEND implementation,
253 you would need to sys_seek(0, SEEK_END) here, but is
254 is not needed nor desirable for Unix- or Posix-like systems.
255 Instead, just indicate that offset (before and after) is
257 fp
->_offset
= _IO_pos_BAD
;
258 else if (fp
->_IO_read_end
!= fp
->_IO_write_base
)
261 = _IO_SYSSEEK (fp
, fp
->_IO_write_base
- fp
->_IO_read_end
, 1);
262 if (new_pos
== _IO_pos_BAD
)
264 fp
->_offset
= new_pos
;
266 count
= _IO_SYSWRITE (fp
, data
, to_do
);
268 fp
->_cur_column
= _IO_adjust_column (fp
->_cur_column
- 1, data
, to_do
) + 1;
269 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
270 fp
->_IO_write_base
= fp
->_IO_write_ptr
= fp
->_IO_buf_base
;
271 fp
->_IO_write_end
= ((fp
->_flags
& (_IO_LINE_BUF
+_IO_UNBUFFERED
))
272 ? fp
->_IO_buf_base
: fp
->_IO_buf_end
);
273 return count
!= to_do
? EOF
: 0;
277 _IO_file_underflow (fp
)
282 /* SysV does not make this test; take it out for compatibility */
283 if (fp
->_flags
& _IO_EOF_SEEN
)
287 if (fp
->_flags
& _IO_NO_READS
)
292 if (fp
->_IO_read_ptr
< fp
->_IO_read_end
)
293 return *(unsigned char *) fp
->_IO_read_ptr
;
295 if (fp
->_IO_buf_base
== NULL
)
298 /* Flush all line buffered files before reading. */
299 /* FIXME This can/should be moved to genops ?? */
300 if (fp
->_flags
& (_IO_LINE_BUF
|_IO_UNBUFFERED
))
301 _IO_flush_all_linebuffered ();
303 _IO_switch_to_get_mode (fp
);
305 /* This is very tricky. We have to adjust those
306 pointers before we call _IO_SYSREAD () since
307 we may longjump () out while waiting for
308 input. Those pointers may be screwed up. H.J. */
309 fp
->_IO_read_base
= fp
->_IO_read_ptr
= fp
->_IO_buf_base
;
310 fp
->_IO_read_end
= fp
->_IO_buf_base
;
311 fp
->_IO_write_base
= fp
->_IO_write_ptr
= fp
->_IO_write_end
314 count
= _IO_SYSREAD (fp
, fp
->_IO_buf_base
,
315 fp
->_IO_buf_end
- fp
->_IO_buf_base
);
319 fp
->_flags
|= _IO_EOF_SEEN
;
321 fp
->_flags
|= _IO_ERR_SEEN
, count
= 0;
323 fp
->_IO_read_end
+= count
;
326 if (fp
->_offset
!= _IO_pos_BAD
)
327 _IO_pos_adjust (fp
->_offset
, count
);
328 return *(unsigned char *) fp
->_IO_read_ptr
;
332 _IO_file_overflow (f
, ch
)
336 if (f
->_flags
& _IO_NO_WRITES
) /* SET ERROR */
338 f
->_flags
|= _IO_ERR_SEEN
;
342 /* If currently reading or no buffer allocated. */
343 if ((f
->_flags
& _IO_CURRENTLY_PUTTING
) == 0)
345 /* Allocate a buffer if needed. */
346 if (f
->_IO_write_base
== 0)
349 _IO_setg (f
, f
->_IO_buf_base
, f
->_IO_buf_base
, f
->_IO_buf_base
);
351 /* Otherwise must be currently reading.
352 If _IO_read_ptr (and hence also _IO_read_end) is at the buffer end,
353 logically slide the buffer forwards one block (by setting the
354 read pointers to all point at the beginning of the block). This
355 makes room for subsequent output.
356 Otherwise, set the read pointers to _IO_read_end (leaving that
357 alone, so it can continue to correspond to the external position). */
358 if (f
->_IO_read_ptr
== f
->_IO_buf_end
)
359 f
->_IO_read_end
= f
->_IO_read_ptr
= f
->_IO_buf_base
;
360 f
->_IO_write_ptr
= f
->_IO_read_ptr
;
361 f
->_IO_write_base
= f
->_IO_write_ptr
;
362 f
->_IO_write_end
= f
->_IO_buf_end
;
363 f
->_IO_read_base
= f
->_IO_read_ptr
= f
->_IO_read_end
;
365 if (f
->_flags
& (_IO_LINE_BUF
+_IO_UNBUFFERED
))
366 f
->_IO_write_end
= f
->_IO_write_ptr
;
367 f
->_flags
|= _IO_CURRENTLY_PUTTING
;
370 return _IO_do_flush (f
);
371 if (f
->_IO_write_ptr
== f
->_IO_buf_end
) /* Buffer is really full */
372 if (_IO_do_flush (f
) == EOF
)
374 *f
->_IO_write_ptr
++ = ch
;
375 if ((f
->_flags
& _IO_UNBUFFERED
)
376 || ((f
->_flags
& _IO_LINE_BUF
) && ch
== '\n'))
377 if (_IO_do_flush (f
) == EOF
)
379 return (unsigned char) ch
;
387 /* char* ptr = cur_ptr(); */
388 if (fp
->_IO_write_ptr
> fp
->_IO_write_base
)
389 if (_IO_do_flush(fp
)) return EOF
;
390 delta
= fp
->_IO_read_ptr
- fp
->_IO_read_end
;
394 if (_IO_in_backup (fp
))
395 delta
-= eGptr () - Gbase ();
397 _IO_off_t new_pos
= _IO_SYSSEEK (fp
, delta
, 1);
398 if (new_pos
!= (_IO_off_t
) EOF
)
399 fp
->_IO_read_end
= fp
->_IO_read_ptr
;
401 else if (errno
== ESPIPE
)
402 ; /* Ignore error from unseekable devices. */
407 fp
->_offset
= _IO_pos_BAD
;
408 /* FIXME: Cleanup - can this be shared? */
409 /* setg(base(), ptr, ptr); */
414 _IO_file_seekoff (fp
, offset
, dir
, mode
)
421 _IO_off_t delta
, new_offset
;
423 /* POSIX.1 8.2.3.7 says that after a call the fflush() the file
424 offset of the underlying file must be exact. */
425 int must_be_exact
= (fp
->_IO_read_base
== fp
->_IO_read_end
426 && fp
->_IO_write_base
== fp
->_IO_write_ptr
);
429 dir
= _IO_seek_cur
, offset
= 0; /* Don't move any pointers. */
431 /* Flush unwritten characters.
432 (This may do an unneeded write if we seek within the buffer.
433 But to be able to switch to reading, we would need to set
434 egptr to ptr. That can't be done in the current design,
435 which assumes file_ptr() is eGptr. Anyway, since we probably
436 end up flushing when we close(), it doesn't make much difference.)
437 FIXME: simulate mem-papped files. */
439 if (fp
->_IO_write_ptr
> fp
->_IO_write_base
|| _IO_in_put_mode (fp
))
440 if (_IO_switch_to_get_mode (fp
))
443 if (fp
->_IO_buf_base
== NULL
)
446 _IO_setp (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
447 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
453 /* Adjust for read-ahead (bytes is buffer). */
454 offset
-= fp
->_IO_read_end
- fp
->_IO_read_ptr
;
455 if (fp
->_offset
== _IO_pos_BAD
)
457 /* Make offset absolute, assuming current pointer is file_ptr(). */
458 offset
+= _IO_pos_as_off (fp
->_offset
);
467 if (_IO_SYSSTAT (fp
, &st
) == 0 && S_ISREG (st
.st_mode
))
469 offset
+= st
.st_size
;
476 /* At this point, dir==_IO_seek_set. */
478 /* If destination is within current buffer, optimize: */
479 if (fp
->_offset
!= _IO_pos_BAD
&& fp
->_IO_read_base
!= NULL
480 && !_IO_in_backup (fp
))
482 /* Offset relative to start of main get area. */
483 _IO_pos_t rel_offset
= (offset
- fp
->_offset
484 + (fp
->_IO_read_end
- fp
->_IO_read_base
));
488 if (_IO_in_backup (fp
))
489 _IO_switch_to_main_get_area (fp
);
491 if (rel_offset
<= fp
->_IO_read_end
- fp
->_IO_read_base
)
493 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
+ rel_offset
,
495 _IO_setp (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
499 /* If we have streammarkers, seek forward by reading ahead. */
500 if (_IO_have_markers (fp
))
502 int to_skip
= rel_offset
503 - (fp
->_IO_read_ptr
- fp
->_IO_read_base
);
504 if (ignore (to_skip
) != to_skip
)
511 if (rel_offset
< 0 && rel_offset
>= Bbase () - Bptr ())
513 if (!_IO_in_backup (fp
))
514 _IO_switch_to_backup_area (fp
);
515 gbump (fp
->_IO_read_end
+ rel_offset
- fp
->_IO_read_ptr
);
522 _IO_unsave_markers (fp
);
525 if (fp
->_flags
& _IO_NO_READS
)
528 /* Try to seek to a block boundary, to improve kernel page management. */
529 new_offset
= offset
& ~(fp
->_IO_buf_end
- fp
->_IO_buf_base
- 1);
530 delta
= offset
- new_offset
;
531 if (delta
> fp
->_IO_buf_end
- fp
->_IO_buf_base
)
536 result
= _IO_SYSSEEK (fp
, new_offset
, 0);
543 count
= _IO_SYSREAD (fp
, fp
->_IO_buf_base
,
545 ? delta
: fp
->_IO_buf_end
- fp
->_IO_buf_base
));
548 /* We weren't allowed to read, but try to seek the remainder. */
549 offset
= count
== EOF
? delta
: delta
-count
;
554 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
+ delta
,
555 fp
->_IO_buf_base
+ count
);
556 _IO_setp (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
557 fp
->_offset
= result
+ count
;
558 _IO_mask_flags (fp
, 0, _IO_EOF_SEEN
);
562 _IO_unsave_markers (fp
);
563 result
= _IO_SYSSEEK (fp
, offset
, dir
);
565 _IO_mask_flags (fp
, 0, _IO_EOF_SEEN
);
566 fp
->_offset
= result
;
567 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
568 _IO_setp (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
573 _IO_file_read (fp
, buf
, size
)
580 _IO_ssize_t count
= _IO_read (fp
->_fileno
, buf
, size
);
581 #if 0 && defined EINTR
582 /* We must not do this optimization since POSIX.1 explicitly
583 requests that the stream operations must return with the
584 error EINTR if this happens. There must be the possibility
585 that stream operations time out. --drepper */
586 if (count
== -1 && errno
== EINTR
)
594 _IO_file_seek (fp
, offset
, dir
)
599 return _IO_lseek (fp
->_fileno
, offset
, dir
);
603 _IO_file_stat (fp
, st
)
607 return _IO_fstat (fp
->_fileno
, (struct stat
*) st
);
614 return _IO_close (fp
->_fileno
);
618 _IO_file_write (f
, data
, n
)
623 _IO_ssize_t to_do
= n
;
626 _IO_ssize_t count
= _IO_write (f
->_fileno
, data
, to_do
);
629 #if 0 && defined EINTR
630 /* We must not do this optimization since POSIX.1 explicitly
631 requests that the stream operations must return with the
632 error EINTR if this happens. There must be the
633 possibility that stream operations time out. --drepper */
639 f
->_flags
|= _IO_ERR_SEEN
;
644 data
= (void *) ((char *) data
+ count
);
653 _IO_file_xsputn (f
, data
, n
)
658 register const char *s
= (char *) data
;
659 _IO_size_t to_do
= n
;
665 /* This is an optimized implementation.
666 If the amount to be written straddles a block boundary
667 (or the filebuf is unbuffered), use sys_write directly. */
669 /* First figure out how much space is available in the buffer. */
670 count
= f
->_IO_write_end
- f
->_IO_write_ptr
; /* Space available. */
671 if ((f
->_flags
& _IO_LINE_BUF
) && (f
->_flags
& _IO_CURRENTLY_PUTTING
))
673 count
= f
->_IO_buf_end
- f
->_IO_write_ptr
;
676 register const char *p
;
677 for (p
= s
+ n
; p
> s
; )
688 /* Then fill the buffer. */
695 memcpy (f
->_IO_write_ptr
, s
, count
);
700 register char *p
= f
->_IO_write_ptr
;
701 register int i
= (int) count
;
705 f
->_IO_write_ptr
+= count
;
708 if (to_do
+ must_flush
> 0)
710 _IO_size_t block_size
, dont_write
;
711 /* Next flush the (full) buffer. */
712 if (__overflow (f
, EOF
) == EOF
)
715 /* Try to maintain alignment: write a whole number of blocks.
716 dont_write is what gets left over. */
717 block_size
= f
->_IO_buf_end
- f
->_IO_buf_base
;
718 dont_write
= block_size
>= 128 ? to_do
% block_size
: 0;
720 count
= to_do
- dont_write
;
721 if (_IO_do_write (f
, s
, count
) == EOF
)
725 /* Now write out the remainder. Normally, this will fit in the
726 buffer, but it's somewhat messier for line-buffered files,
727 so we let _IO_default_xsputn handle the general case. */
729 to_do
-= _IO_default_xsputn (f
, s
+count
, dont_write
);
735 /* Work in progress */
737 _IO_file_xsgetn (fp
, data
, n
)
742 register _IO_size_t more
= n
;
743 register char *s
= data
;
746 /* Data available. */
747 _IO_ssize_t count
= fp
->_IO_read_end
- fp
->_IO_read_ptr
;
754 memcpy (s
, fp
->_IO_read_ptr
, count
);
756 fp
->_IO_read_ptr
+= count
;
762 register char *p
= fp
->_IO_read_ptr
;
763 register int i
= (int) count
;
766 fp
->_IO_read_ptr
= p
;
771 if (! _IO_in
put_mode (fp
)
772 && ! _IO_have_markers (fp
) && ! IO_have_backup (fp
))
774 /* This is an optimization of _IO_file_underflow */
775 if (fp
->_flags
& _IO_NO_READS
)
777 /* If we're reading a lot of data, don't bother allocating
778 a buffer. But if we're only reading a bit, perhaps we should ??*/
779 if (count
<= 512 && fp
->_IO_buf_base
== NULL
)
781 if (fp
->_flags
& (_IO_LINE_BUF
|_IO_UNBUFFERED
))
782 _IO_flush_all_linebuffered ();
784 _IO_switch_to_get_mode (fp
); ???;
785 count
= _IO_SYSREAD (fp
, s
, more
);
789 fp
->_flags
|= _IO_EOF_SEEN
;
791 fp
->_flags
|= _IO_ERR_SEEN
, count
= 0;
798 if (more
== 0 || __underflow (fp
) == EOF
)
805 struct _IO_jump_t _IO_file_jumps
=
808 JUMP_INIT(finish
, _IO_file_finish
),
809 JUMP_INIT(overflow
, _IO_file_overflow
),
810 JUMP_INIT(underflow
, _IO_file_underflow
),
811 JUMP_INIT(uflow
, _IO_default_uflow
),
812 JUMP_INIT(pbackfail
, _IO_default_pbackfail
),
813 JUMP_INIT(xsputn
, _IO_file_xsputn
),
814 JUMP_INIT(xsgetn
, _IO_default_xsgetn
),
815 JUMP_INIT(seekoff
, _IO_file_seekoff
),
816 JUMP_INIT(seekpos
, _IO_default_seekpos
),
817 JUMP_INIT(setbuf
, _IO_file_setbuf
),
818 JUMP_INIT(sync
, _IO_file_sync
),
819 JUMP_INIT(doallocate
, _IO_file_doallocate
),
820 JUMP_INIT(read
, _IO_file_read
),
821 JUMP_INIT(write
, _IO_file_write
),
822 JUMP_INIT(seek
, _IO_file_seek
),
823 JUMP_INIT(close
, _IO_file_close
),
824 JUMP_INIT(stat
, _IO_file_stat
)