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)
44 # define close(FD) __close (FD)
45 # define fstat(FD, Statbuf) __fstat (FD, Statbuf)
46 # define lseek(FD, Offset, Whence) __lseek (FD, Offset, Whence)
47 # define read(FD, Buf, NBytes) __read (FD, Buf, NBytes)
48 # define write(FD, Buf, NBytes) __write (FD, Buf, NBytes)
51 /* An fstream can be in at most one of put mode, get mode, or putback mode.
52 Putback mode is a variant of get mode.
54 In a filebuf, there is only one current position, instead of two
55 separate get and put pointers. In get mode, the current position
56 is that of gptr(); in put mode that of pptr().
58 The position in the buffer that corresponds to the position
59 in external file system is normally _IO_read_end, except in putback
60 mode, when it is _IO_save_end.
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_base_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)
109 /* POSIX.1 allows another file handle to be used to change the position
110 of our file descriptor. Hence we actually don't know the actual
111 position before we do the first fseek (and until a following fflush). */
112 fp
->_offset
= _IO_pos_BAD
;
113 fp
->_IO_file_flags
|= CLOSED_FILEBUF_FLAGS
;
120 _IO_file_close_it (fp
)
123 int write_status
, close_status
;
124 if (!_IO_file_is_open (fp
))
127 write_status
= _IO_do_flush (fp
);
129 _IO_unsave_markers(fp
);
131 close_status
= _IO_SYSCLOSE (fp
);
134 _IO_setb (fp
, NULL
, NULL
, 0);
135 _IO_setg (fp
, NULL
, NULL
, NULL
);
136 _IO_setp (fp
, NULL
, NULL
);
139 fp
->_flags
= _IO_MAGIC
|CLOSED_FILEBUF_FLAGS
;
141 fp
->_offset
= _IO_pos_BAD
;
143 return close_status
? close_status
: write_status
;
147 _IO_file_finish (fp
, dummy
)
151 if (_IO_file_is_open (fp
))
154 if (!(fp
->_flags
& _IO_DELETE_DONT_CLOSE
))
157 _IO_default_finish (fp
, 0);
161 _IO_file_fopen (fp
, filename
, mode
)
163 const char *filename
;
166 int oflags
= 0, omode
;
167 int read_write
, fdesc
;
169 if (_IO_file_is_open (fp
))
175 read_write
= _IO_NO_WRITES
;
179 oflags
= O_CREAT
|O_TRUNC
;
180 read_write
= _IO_NO_READS
;
184 oflags
= O_CREAT
|O_APPEND
;
185 read_write
= _IO_NO_READS
|_IO_IS_APPENDING
;
188 __set_errno (EINVAL
);
191 if (mode
[0] == '+' || (mode
[0] == 'b' && mode
[1] == '+'))
194 read_write
&= _IO_IS_APPENDING
;
196 fdesc
= open (filename
, omode
|oflags
, oprot
);
200 _IO_mask_flags (fp
, read_write
,_IO_NO_READS
+_IO_NO_WRITES
+_IO_IS_APPENDING
);
201 if (read_write
& _IO_IS_APPENDING
)
202 if (_IO_SEEKOFF (fp
, (_IO_off_t
)0, _IO_seek_end
, _IOS_INPUT
|_IOS_OUTPUT
)
203 == _IO_pos_BAD
&& errno
!= ESPIPE
)
210 _IO_file_attach (fp
, fd
)
214 if (_IO_file_is_open (fp
))
217 fp
->_flags
&= ~(_IO_NO_READS
+_IO_NO_WRITES
);
218 fp
->_flags
|= _IO_DELETE_DONT_CLOSE
;
219 /* Get the current position of the file. */
220 /* We have to do that since that may be junk. */
221 fp
->_offset
= _IO_pos_BAD
;
222 if (_IO_SEEKOFF (fp
, (_IO_off_t
)0, _IO_seek_cur
, _IOS_INPUT
|_IOS_OUTPUT
)
223 == _IO_pos_BAD
&& errno
!= ESPIPE
)
229 _IO_file_setbuf (fp
, p
, len
)
234 if (_IO_default_setbuf (fp
, p
, len
) == NULL
)
237 fp
->_IO_write_base
= fp
->_IO_write_ptr
= fp
->_IO_write_end
239 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
244 /* Write TO_DO bytes from DATA to FP.
245 Then mark FP as having empty buffers. */
248 _IO_do_write (fp
, data
, to_do
)
256 if (fp
->_flags
& _IO_IS_APPENDING
)
257 /* On a system without a proper O_APPEND implementation,
258 you would need to sys_seek(0, SEEK_END) here, but is
259 is not needed nor desirable for Unix- or Posix-like systems.
260 Instead, just indicate that offset (before and after) is
262 fp
->_offset
= _IO_pos_BAD
;
263 else if (fp
->_IO_read_end
!= fp
->_IO_write_base
)
266 = _IO_SYSSEEK (fp
, fp
->_IO_write_base
- fp
->_IO_read_end
, 1);
267 if (new_pos
== _IO_pos_BAD
)
269 fp
->_offset
= new_pos
;
271 count
= _IO_SYSWRITE (fp
, data
, to_do
);
273 fp
->_cur_column
= _IO_adjust_column (fp
->_cur_column
- 1, data
, to_do
) + 1;
274 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
275 fp
->_IO_write_base
= fp
->_IO_write_ptr
= fp
->_IO_buf_base
;
276 fp
->_IO_write_end
= ((fp
->_flags
& (_IO_LINE_BUF
+_IO_UNBUFFERED
))
277 ? fp
->_IO_buf_base
: fp
->_IO_buf_end
);
278 return count
!= to_do
? EOF
: 0;
282 _IO_file_underflow (fp
)
287 /* SysV does not make this test; take it out for compatibility */
288 if (fp
->_flags
& _IO_EOF_SEEN
)
292 if (fp
->_flags
& _IO_NO_READS
)
297 if (fp
->_IO_read_ptr
< fp
->_IO_read_end
)
298 return *(unsigned char *) fp
->_IO_read_ptr
;
300 if (fp
->_IO_buf_base
== NULL
)
303 /* Flush all line buffered files before reading. */
304 /* FIXME This can/should be moved to genops ?? */
305 if (fp
->_flags
& (_IO_LINE_BUF
|_IO_UNBUFFERED
))
306 _IO_flush_all_linebuffered ();
308 _IO_switch_to_get_mode (fp
);
310 /* This is very tricky. We have to adjust those
311 pointers before we call _IO_SYSREAD () since
312 we may longjump () out while waiting for
313 input. Those pointers may be screwed up. H.J. */
314 fp
->_IO_read_base
= fp
->_IO_read_ptr
= fp
->_IO_buf_base
;
315 fp
->_IO_read_end
= fp
->_IO_buf_base
;
316 fp
->_IO_write_base
= fp
->_IO_write_ptr
= fp
->_IO_write_end
319 count
= _IO_SYSREAD (fp
, fp
->_IO_buf_base
,
320 fp
->_IO_buf_end
- fp
->_IO_buf_base
);
324 fp
->_flags
|= _IO_EOF_SEEN
;
326 fp
->_flags
|= _IO_ERR_SEEN
, count
= 0;
328 fp
->_IO_read_end
+= count
;
331 if (fp
->_offset
!= _IO_pos_BAD
)
332 _IO_pos_adjust (fp
->_offset
, count
);
333 return *(unsigned char *) fp
->_IO_read_ptr
;
337 _IO_file_overflow (f
, ch
)
341 if (f
->_flags
& _IO_NO_WRITES
) /* SET ERROR */
343 f
->_flags
|= _IO_ERR_SEEN
;
347 /* If currently reading or no buffer allocated. */
348 if ((f
->_flags
& _IO_CURRENTLY_PUTTING
) == 0)
350 /* Allocate a buffer if needed. */
351 if (f
->_IO_write_base
== 0)
354 _IO_setg (f
, f
->_IO_buf_base
, f
->_IO_buf_base
, f
->_IO_buf_base
);
356 /* Otherwise must be currently reading.
357 If _IO_read_ptr (and hence also _IO_read_end) is at the buffer end,
358 logically slide the buffer forwards one block (by setting the
359 read pointers to all point at the beginning of the block). This
360 makes room for subsequent output.
361 Otherwise, set the read pointers to _IO_read_end (leaving that
362 alone, so it can continue to correspond to the external position). */
363 if (f
->_IO_read_ptr
== f
->_IO_buf_end
)
364 f
->_IO_read_end
= f
->_IO_read_ptr
= f
->_IO_buf_base
;
365 f
->_IO_write_ptr
= f
->_IO_read_ptr
;
366 f
->_IO_write_base
= f
->_IO_write_ptr
;
367 f
->_IO_write_end
= f
->_IO_buf_end
;
368 f
->_IO_read_base
= f
->_IO_read_ptr
= f
->_IO_read_end
;
370 if (f
->_flags
& (_IO_LINE_BUF
+_IO_UNBUFFERED
))
371 f
->_IO_write_end
= f
->_IO_write_ptr
;
372 f
->_flags
|= _IO_CURRENTLY_PUTTING
;
375 return _IO_do_flush (f
);
376 if (f
->_IO_write_ptr
== f
->_IO_buf_end
) /* Buffer is really full */
377 if (_IO_do_flush (f
) == EOF
)
379 *f
->_IO_write_ptr
++ = ch
;
380 if ((f
->_flags
& _IO_UNBUFFERED
)
381 || ((f
->_flags
& _IO_LINE_BUF
) && ch
== '\n'))
382 if (_IO_do_flush (f
) == EOF
)
384 return (unsigned char) ch
;
394 _IO_cleanup_region_start ((void (*) __P ((void *))) _IO_funlockfile
, fp
);
396 /* char* ptr = cur_ptr(); */
397 if (fp
->_IO_write_ptr
> fp
->_IO_write_base
)
398 if (_IO_do_flush(fp
)) return EOF
;
399 delta
= fp
->_IO_read_ptr
- fp
->_IO_read_end
;
403 if (_IO_in_backup (fp
))
404 delta
-= eGptr () - Gbase ();
406 _IO_off_t new_pos
= _IO_SYSSEEK (fp
, delta
, 1);
407 if (new_pos
!= (_IO_off_t
) EOF
)
408 fp
->_IO_read_end
= fp
->_IO_read_ptr
;
410 else if (errno
== ESPIPE
)
411 ; /* Ignore error from unseekable devices. */
417 fp
->_offset
= _IO_pos_BAD
;
418 /* FIXME: Cleanup - can this be shared? */
419 /* setg(base(), ptr, ptr); */
420 _IO_cleanup_region_end (1);
425 _IO_file_seekoff (fp
, offset
, dir
, mode
)
432 _IO_off_t delta
, new_offset
;
434 /* POSIX.1 8.2.3.7 says that after a call the fflush() the file
435 offset of the underlying file must be exact. */
436 int must_be_exact
= (fp
->_IO_read_base
== fp
->_IO_read_end
437 && fp
->_IO_write_base
== fp
->_IO_write_ptr
);
440 dir
= _IO_seek_cur
, offset
= 0; /* Don't move any pointers. */
442 /* Flush unwritten characters.
443 (This may do an unneeded write if we seek within the buffer.
444 But to be able to switch to reading, we would need to set
445 egptr to ptr. That can't be done in the current design,
446 which assumes file_ptr() is eGptr. Anyway, since we probably
447 end up flushing when we close(), it doesn't make much difference.)
448 FIXME: simulate mem-papped files. */
450 if (fp
->_IO_write_ptr
> fp
->_IO_write_base
|| _IO_in_put_mode (fp
))
451 if (_IO_switch_to_get_mode (fp
))
454 if (fp
->_IO_buf_base
== NULL
)
457 _IO_setp (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
458 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
464 /* Adjust for read-ahead (bytes is buffer). */
465 offset
-= fp
->_IO_read_end
- fp
->_IO_read_ptr
;
466 if (fp
->_offset
== _IO_pos_BAD
)
468 /* Make offset absolute, assuming current pointer is file_ptr(). */
469 offset
+= _IO_pos_as_off (fp
->_offset
);
478 if (_IO_SYSSTAT (fp
, &st
) == 0 && S_ISREG (st
.st_mode
))
480 offset
+= st
.st_size
;
487 /* At this point, dir==_IO_seek_set. */
489 /* If destination is within current buffer, optimize: */
490 if (fp
->_offset
!= _IO_pos_BAD
&& fp
->_IO_read_base
!= NULL
491 && !_IO_in_backup (fp
))
493 /* Offset relative to start of main get area. */
494 _IO_pos_t rel_offset
= (offset
- fp
->_offset
495 + (fp
->_IO_read_end
- fp
->_IO_read_base
));
499 if (_IO_in_backup (fp
))
500 _IO_switch_to_main_get_area (fp
);
502 if (rel_offset
<= fp
->_IO_read_end
- fp
->_IO_read_base
)
504 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
+ rel_offset
,
506 _IO_setp (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
510 /* If we have streammarkers, seek forward by reading ahead. */
511 if (_IO_have_markers (fp
))
513 int to_skip
= rel_offset
514 - (fp
->_IO_read_ptr
- fp
->_IO_read_base
);
515 if (ignore (to_skip
) != to_skip
)
522 if (rel_offset
< 0 && rel_offset
>= Bbase () - Bptr ())
524 if (!_IO_in_backup (fp
))
525 _IO_switch_to_backup_area (fp
);
526 gbump (fp
->_IO_read_end
+ rel_offset
- fp
->_IO_read_ptr
);
533 _IO_unsave_markers (fp
);
536 if (fp
->_flags
& _IO_NO_READS
)
539 /* Try to seek to a block boundary, to improve kernel page management. */
540 new_offset
= offset
& ~(fp
->_IO_buf_end
- fp
->_IO_buf_base
- 1);
541 delta
= offset
- new_offset
;
542 if (delta
> fp
->_IO_buf_end
- fp
->_IO_buf_base
)
547 result
= _IO_SYSSEEK (fp
, new_offset
, 0);
554 count
= _IO_SYSREAD (fp
, fp
->_IO_buf_base
,
556 ? delta
: fp
->_IO_buf_end
- fp
->_IO_buf_base
));
559 /* We weren't allowed to read, but try to seek the remainder. */
560 offset
= count
== EOF
? delta
: delta
-count
;
565 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
+ delta
,
566 fp
->_IO_buf_base
+ count
);
567 _IO_setp (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
568 fp
->_offset
= result
+ count
;
569 _IO_mask_flags (fp
, 0, _IO_EOF_SEEN
);
573 _IO_unsave_markers (fp
);
574 result
= _IO_SYSSEEK (fp
, offset
, dir
);
576 _IO_mask_flags (fp
, 0, _IO_EOF_SEEN
);
577 fp
->_offset
= result
;
578 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
579 _IO_setp (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
584 _IO_file_read (fp
, buf
, size
)
589 return read (fp
->_fileno
, buf
, size
);
593 _IO_file_seek (fp
, offset
, dir
)
598 return lseek (fp
->_fileno
, offset
, dir
);
602 _IO_file_stat (fp
, st
)
606 return fstat (fp
->_fileno
, (struct stat
*) st
);
613 return close (fp
->_fileno
);
617 _IO_file_write (f
, data
, n
)
622 _IO_ssize_t to_do
= n
;
625 _IO_ssize_t count
= write (f
->_fileno
, data
, to_do
);
628 f
->_flags
|= _IO_ERR_SEEN
;
632 data
= (void *) ((char *) data
+ count
);
641 _IO_file_xsputn (f
, data
, n
)
646 register const char *s
= (char *) data
;
647 _IO_size_t to_do
= n
;
653 /* This is an optimized implementation.
654 If the amount to be written straddles a block boundary
655 (or the filebuf is unbuffered), use sys_write directly. */
657 /* First figure out how much space is available in the buffer. */
658 count
= f
->_IO_write_end
- f
->_IO_write_ptr
; /* Space available. */
659 if ((f
->_flags
& _IO_LINE_BUF
) && (f
->_flags
& _IO_CURRENTLY_PUTTING
))
661 count
= f
->_IO_buf_end
- f
->_IO_write_ptr
;
664 register const char *p
;
665 for (p
= s
+ n
; p
> s
; )
676 /* Then fill the buffer. */
683 memcpy (f
->_IO_write_ptr
, s
, count
);
688 register char *p
= f
->_IO_write_ptr
;
689 register int i
= (int) count
;
693 f
->_IO_write_ptr
+= count
;
696 if (to_do
+ must_flush
> 0)
698 _IO_size_t block_size
, dont_write
;
699 /* Next flush the (full) buffer. */
700 if (__overflow (f
, EOF
) == EOF
)
703 /* Try to maintain alignment: write a whole number of blocks.
704 dont_write is what gets left over. */
705 block_size
= f
->_IO_buf_end
- f
->_IO_buf_base
;
706 dont_write
= block_size
>= 128 ? to_do
% block_size
: 0;
708 count
= to_do
- dont_write
;
709 if (_IO_do_write (f
, s
, count
) == EOF
)
713 /* Now write out the remainder. Normally, this will fit in the
714 buffer, but it's somewhat messier for line-buffered files,
715 so we let _IO_default_xsputn handle the general case. */
717 to_do
-= _IO_default_xsputn (f
, s
+count
, dont_write
);
723 /* Work in progress */
725 _IO_file_xsgetn (fp
, data
, n
)
730 register _IO_size_t more
= n
;
731 register char *s
= data
;
734 /* Data available. */
735 _IO_ssize_t count
= fp
->_IO_read_end
- fp
->_IO_read_ptr
;
742 memcpy (s
, fp
->_IO_read_ptr
, count
);
744 fp
->_IO_read_ptr
+= count
;
750 register char *p
= fp
->_IO_read_ptr
;
751 register int i
= (int) count
;
754 fp
->_IO_read_ptr
= p
;
759 if (! _IO_in
put_mode (fp
)
760 && ! _IO_have_markers (fp
) && ! IO_have_backup (fp
))
762 /* This is an optimization of _IO_file_underflow */
763 if (fp
->_flags
& _IO_NO_READS
)
765 /* If we're reading a lot of data, don't bother allocating
766 a buffer. But if we're only reading a bit, perhaps we should ??*/
767 if (count
<= 512 && fp
->_IO_buf_base
== NULL
)
769 if (fp
->_flags
& (_IO_LINE_BUF
|_IO_UNBUFFERED
))
770 _IO_flush_all_linebuffered ();
772 _IO_switch_to_get_mode (fp
); ???;
773 count
= _IO_SYSREAD (fp
, s
, more
);
777 fp
->_flags
|= _IO_EOF_SEEN
;
779 fp
->_flags
|= _IO_ERR_SEEN
, count
= 0;
786 if (more
== 0 || __underflow (fp
) == EOF
)
793 struct _IO_jump_t _IO_file_jumps
=
796 JUMP_INIT(finish
, _IO_file_finish
),
797 JUMP_INIT(overflow
, _IO_file_overflow
),
798 JUMP_INIT(underflow
, _IO_file_underflow
),
799 JUMP_INIT(uflow
, _IO_default_uflow
),
800 JUMP_INIT(pbackfail
, _IO_default_pbackfail
),
801 JUMP_INIT(xsputn
, _IO_file_xsputn
),
802 JUMP_INIT(xsgetn
, _IO_default_xsgetn
),
803 JUMP_INIT(seekoff
, _IO_file_seekoff
),
804 JUMP_INIT(seekpos
, _IO_default_seekpos
),
805 JUMP_INIT(setbuf
, _IO_file_setbuf
),
806 JUMP_INIT(sync
, _IO_file_sync
),
807 JUMP_INIT(doallocate
, _IO_file_doallocate
),
808 JUMP_INIT(read
, _IO_file_read
),
809 JUMP_INIT(write
, _IO_file_write
),
810 JUMP_INIT(seek
, _IO_file_seek
),
811 JUMP_INIT(close
, _IO_file_close
),
812 JUMP_INIT(stat
, _IO_file_stat
)