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. */
30 #include <sys/types.h>
41 # define open(Name, Flags, Prot) __open (Name, Flags, Prot)
42 # define close(FD) __close (FD)
43 # define fstat(FD, Statbuf) __fstat (FD, Statbuf)
44 # define lseek(FD, Offset, Whence) __lseek (FD, Offset, Whence)
45 # define read(FD, Buf, NBytes) __read (FD, Buf, NBytes)
46 # define write(FD, Buf, NBytes) __write (FD, Buf, NBytes)
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.
59 If the field _fb._offset is >= 0, it gives the offset in
60 the file as a whole corresponding to eGptr(). (?)
63 If a filebuf is in put mode, then all of _IO_read_ptr, _IO_read_end,
64 and _IO_read_base are equal to each other. These are usually equal
65 to _IO_buf_base, though not necessarily if we have switched from
66 get mode to put mode. (The reason is to maintain the invariant
67 that _IO_read_end corresponds to the external file position.)
68 _IO_write_base is non-NULL and usually equal to _IO_base_base.
69 We also have _IO_write_end == _IO_buf_end, but only in fully buffered mode.
70 The un-flushed character are those between _IO_write_base and _IO_write_ptr.
73 If a filebuf is in get or putback mode, eback() != egptr().
74 In get mode, the unread characters are between gptr() and egptr().
75 The OS file position corresponds to that of egptr().
78 Putback mode is used to remember "excess" characters that have
79 been sputbackc'd in a separate putback buffer.
80 In putback mode, the get buffer points to the special putback buffer.
81 The unread characters are the characters between gptr() and egptr()
82 in the putback buffer, as well as the area between save_gptr()
83 and save_egptr(), which point into the original reserve buffer.
84 (The pointers save_gptr() and save_egptr() are the values
85 of gptr() and egptr() at the time putback mode was entered.)
86 The OS position corresponds to that of save_egptr().
89 During line buffered output, _IO_write_base==base() && epptr()==base().
90 However, ptr() may be anywhere between base() and ebuf().
91 This forces a call to filebuf::overflow(int C) on every put.
92 If there is more space in the buffer, and C is not a '\n',
93 then C is inserted, and pptr() incremented.
96 If a filebuf is unbuffered(), the _shortbuf[1] is used as the buffer.
99 #define CLOSED_FILEBUF_FLAGS \
100 (_IO_IS_FILEBUF+_IO_NO_READS+_IO_NO_WRITES+_IO_TIED_PUT_GET)
107 /* POSIX.1 allows another file handle to be used to change the position
108 of our file descriptor. Hence we actually don't know the actual
109 position before we do the first fseek (and until a following fflush). */
110 fp
->_offset
= _IO_pos_BAD
;
111 fp
->_IO_file_flags
|= CLOSED_FILEBUF_FLAGS
;
118 _IO_file_close_it (fp
)
121 int write_status
, close_status
;
122 if (!_IO_file_is_open (fp
))
125 write_status
= _IO_do_flush (fp
);
127 _IO_unsave_markers(fp
);
129 close_status
= _IO_SYSCLOSE (fp
);
132 _IO_setb (fp
, NULL
, NULL
, 0);
133 _IO_setg (fp
, NULL
, NULL
, NULL
);
134 _IO_setp (fp
, NULL
, NULL
);
137 fp
->_flags
= _IO_MAGIC
|CLOSED_FILEBUF_FLAGS
;
139 fp
->_offset
= _IO_pos_BAD
;
141 return close_status
? close_status
: write_status
;
145 _IO_file_finish (fp
, dummy
)
149 if (_IO_file_is_open (fp
))
152 if (!(fp
->_flags
& _IO_DELETE_DONT_CLOSE
))
155 _IO_default_finish (fp
, 0);
159 _IO_file_fopen (fp
, filename
, mode
)
161 const char *filename
;
164 int oflags
= 0, omode
;
165 int read_write
, fdesc
;
167 if (_IO_file_is_open (fp
))
173 read_write
= _IO_NO_WRITES
;
177 oflags
= O_CREAT
|O_TRUNC
;
178 read_write
= _IO_NO_READS
;
182 oflags
= O_CREAT
|O_APPEND
;
183 read_write
= _IO_NO_READS
|_IO_IS_APPENDING
;
186 __set_errno (EINVAL
);
189 if (mode
[0] == '+' || (mode
[0] == 'b' && mode
[1] == '+'))
192 read_write
&= _IO_IS_APPENDING
;
194 fdesc
= open (filename
, omode
|oflags
, oprot
);
198 _IO_mask_flags (fp
, read_write
,_IO_NO_READS
+_IO_NO_WRITES
+_IO_IS_APPENDING
);
199 if (read_write
& _IO_IS_APPENDING
)
200 if (_IO_SEEKOFF (fp
, (_IO_off_t
)0, _IO_seek_end
, _IOS_INPUT
|_IOS_OUTPUT
)
201 == _IO_pos_BAD
&& errno
!= ESPIPE
)
208 _IO_file_attach (fp
, fd
)
212 if (_IO_file_is_open (fp
))
215 fp
->_flags
&= ~(_IO_NO_READS
+_IO_NO_WRITES
);
216 fp
->_flags
|= _IO_DELETE_DONT_CLOSE
;
217 /* Get the current position of the file. */
218 /* We have to do that since that may be junk. */
219 fp
->_offset
= _IO_pos_BAD
;
220 if (_IO_SEEKOFF (fp
, (_IO_off_t
)0, _IO_seek_cur
, _IOS_INPUT
|_IOS_OUTPUT
)
221 == _IO_pos_BAD
&& errno
!= ESPIPE
)
227 _IO_file_setbuf (fp
, p
, len
)
232 if (_IO_default_setbuf (fp
, p
, len
) == NULL
)
235 fp
->_IO_write_base
= fp
->_IO_write_ptr
= fp
->_IO_write_end
237 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
242 /* Write TO_DO bytes from DATA to FP.
243 Then mark FP as having empty buffers. */
246 _IO_do_write (fp
, data
, to_do
)
254 if (fp
->_flags
& _IO_IS_APPENDING
)
255 /* On a system without a proper O_APPEND implementation,
256 you would need to sys_seek(0, SEEK_END) here, but it
257 is not needed nor desirable for Unix- or Posix-like systems.
258 Instead, just indicate that offset (before and after) is
260 fp
->_offset
= _IO_pos_BAD
;
261 else if (fp
->_IO_read_end
!= fp
->_IO_write_base
)
264 = _IO_SYSSEEK (fp
, fp
->_IO_write_base
- fp
->_IO_read_end
, 1);
265 if (new_pos
== _IO_pos_BAD
)
267 fp
->_offset
= new_pos
;
269 count
= _IO_SYSWRITE (fp
, data
, to_do
);
271 fp
->_cur_column
= _IO_adjust_column (fp
->_cur_column
- 1, data
, to_do
) + 1;
272 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
273 fp
->_IO_write_base
= fp
->_IO_write_ptr
= fp
->_IO_buf_base
;
274 fp
->_IO_write_end
= ((fp
->_flags
& (_IO_LINE_BUF
+_IO_UNBUFFERED
))
275 ? fp
->_IO_buf_base
: fp
->_IO_buf_end
);
276 return count
!= to_do
? EOF
: 0;
280 _IO_file_underflow (fp
)
285 /* SysV does not make this test; take it out for compatibility */
286 if (fp
->_flags
& _IO_EOF_SEEN
)
290 if (fp
->_flags
& _IO_NO_READS
)
295 if (fp
->_IO_read_ptr
< fp
->_IO_read_end
)
296 return *(unsigned char *) fp
->_IO_read_ptr
;
298 if (fp
->_IO_buf_base
== NULL
)
301 /* Flush all line buffered files before reading. */
302 /* FIXME This can/should be moved to genops ?? */
303 if (fp
->_flags
& (_IO_LINE_BUF
|_IO_UNBUFFERED
))
304 _IO_flush_all_linebuffered ();
306 _IO_switch_to_get_mode (fp
);
308 /* This is very tricky. We have to adjust those
309 pointers before we call _IO_SYSREAD () since
310 we may longjump () out while waiting for
311 input. Those pointers may be screwed up. H.J. */
312 fp
->_IO_read_base
= fp
->_IO_read_ptr
= fp
->_IO_buf_base
;
313 fp
->_IO_read_end
= fp
->_IO_buf_base
;
314 fp
->_IO_write_base
= fp
->_IO_write_ptr
= fp
->_IO_write_end
317 count
= _IO_SYSREAD (fp
, fp
->_IO_buf_base
,
318 fp
->_IO_buf_end
- fp
->_IO_buf_base
);
322 fp
->_flags
|= _IO_EOF_SEEN
;
324 fp
->_flags
|= _IO_ERR_SEEN
, count
= 0;
326 fp
->_IO_read_end
+= count
;
329 if (fp
->_offset
!= _IO_pos_BAD
)
330 _IO_pos_adjust (fp
->_offset
, count
);
331 return *(unsigned char *) fp
->_IO_read_ptr
;
335 _IO_file_overflow (f
, ch
)
339 if (f
->_flags
& _IO_NO_WRITES
) /* SET ERROR */
341 f
->_flags
|= _IO_ERR_SEEN
;
345 /* If currently reading or no buffer allocated. */
346 if ((f
->_flags
& _IO_CURRENTLY_PUTTING
) == 0)
348 /* Allocate a buffer if needed. */
349 if (f
->_IO_write_base
== 0)
352 _IO_setg (f
, f
->_IO_buf_base
, f
->_IO_buf_base
, f
->_IO_buf_base
);
354 /* Otherwise must be currently reading.
355 If _IO_read_ptr (and hence also _IO_read_end) is at the buffer end,
356 logically slide the buffer forwards one block (by setting the
357 read pointers to all point at the beginning of the block). This
358 makes room for subsequent output.
359 Otherwise, set the read pointers to _IO_read_end (leaving that
360 alone, so it can continue to correspond to the external position). */
361 if (f
->_IO_read_ptr
== f
->_IO_buf_end
)
362 f
->_IO_read_end
= f
->_IO_read_ptr
= f
->_IO_buf_base
;
363 f
->_IO_write_ptr
= f
->_IO_read_ptr
;
364 f
->_IO_write_base
= f
->_IO_write_ptr
;
365 f
->_IO_write_end
= f
->_IO_buf_end
;
366 f
->_IO_read_base
= f
->_IO_read_ptr
= f
->_IO_read_end
;
368 if (f
->_flags
& (_IO_LINE_BUF
+_IO_UNBUFFERED
))
369 f
->_IO_write_end
= f
->_IO_write_ptr
;
370 f
->_flags
|= _IO_CURRENTLY_PUTTING
;
373 return _IO_do_flush (f
);
374 if (f
->_IO_write_ptr
== f
->_IO_buf_end
) /* Buffer is really full */
375 if (_IO_do_flush (f
) == EOF
)
377 *f
->_IO_write_ptr
++ = ch
;
378 if ((f
->_flags
& _IO_UNBUFFERED
)
379 || ((f
->_flags
& _IO_LINE_BUF
) && ch
== '\n'))
380 if (_IO_do_flush (f
) == EOF
)
382 return (unsigned char) ch
;
392 _IO_cleanup_region_start ((void (*) __P ((void *))) _IO_funlockfile
, fp
);
394 /* char* ptr = cur_ptr(); */
395 if (fp
->_IO_write_ptr
> fp
->_IO_write_base
)
396 if (_IO_do_flush(fp
)) return EOF
;
397 delta
= fp
->_IO_read_ptr
- fp
->_IO_read_end
;
401 if (_IO_in_backup (fp
))
402 delta
-= eGptr () - Gbase ();
404 _IO_off_t new_pos
= _IO_SYSSEEK (fp
, delta
, 1);
405 if (new_pos
!= (_IO_off_t
) EOF
)
406 fp
->_IO_read_end
= fp
->_IO_read_ptr
;
408 else if (errno
== ESPIPE
)
409 ; /* Ignore error from unseekable devices. */
415 fp
->_offset
= _IO_pos_BAD
;
416 /* FIXME: Cleanup - can this be shared? */
417 /* setg(base(), ptr, ptr); */
418 _IO_cleanup_region_end (1);
423 _IO_file_seekoff (fp
, offset
, dir
, mode
)
430 _IO_off_t delta
, new_offset
;
432 /* POSIX.1 8.2.3.7 says that after a call the fflush() the file
433 offset of the underlying file must be exact. */
434 int must_be_exact
= (fp
->_IO_read_base
== fp
->_IO_read_end
435 && fp
->_IO_write_base
== fp
->_IO_write_ptr
);
438 dir
= _IO_seek_cur
, offset
= 0; /* Don't move any pointers. */
440 /* Flush unwritten characters.
441 (This may do an unneeded write if we seek within the buffer.
442 But to be able to switch to reading, we would need to set
443 egptr to ptr. That can't be done in the current design,
444 which assumes file_ptr() is eGptr. Anyway, since we probably
445 end up flushing when we close(), it doesn't make much difference.)
446 FIXME: simulate mem-papped files. */
448 if (fp
->_IO_write_ptr
> fp
->_IO_write_base
|| _IO_in_put_mode (fp
))
449 if (_IO_switch_to_get_mode (fp
))
452 if (fp
->_IO_buf_base
== NULL
)
455 _IO_setp (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
456 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
462 /* Adjust for read-ahead (bytes is buffer). */
463 offset
-= fp
->_IO_read_end
- fp
->_IO_read_ptr
;
464 if (fp
->_offset
== _IO_pos_BAD
)
466 /* Make offset absolute, assuming current pointer is file_ptr(). */
467 offset
+= _IO_pos_as_off (fp
->_offset
);
476 if (_IO_SYSSTAT (fp
, &st
) == 0 && S_ISREG (st
.st_mode
))
478 offset
+= st
.st_size
;
485 /* At this point, dir==_IO_seek_set. */
487 /* If destination is within current buffer, optimize: */
488 if (fp
->_offset
!= _IO_pos_BAD
&& fp
->_IO_read_base
!= NULL
489 && !_IO_in_backup (fp
))
491 /* Offset relative to start of main get area. */
492 _IO_pos_t rel_offset
= (offset
- fp
->_offset
493 + (fp
->_IO_read_end
- fp
->_IO_read_base
));
497 if (_IO_in_backup (fp
))
498 _IO_switch_to_main_get_area (fp
);
500 if (rel_offset
<= fp
->_IO_read_end
- fp
->_IO_read_base
)
502 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
+ rel_offset
,
504 _IO_setp (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
508 /* If we have streammarkers, seek forward by reading ahead. */
509 if (_IO_have_markers (fp
))
511 int to_skip
= rel_offset
512 - (fp
->_IO_read_ptr
- fp
->_IO_read_base
);
513 if (ignore (to_skip
) != to_skip
)
520 if (rel_offset
< 0 && rel_offset
>= Bbase () - Bptr ())
522 if (!_IO_in_backup (fp
))
523 _IO_switch_to_backup_area (fp
);
524 gbump (fp
->_IO_read_end
+ rel_offset
- fp
->_IO_read_ptr
);
531 _IO_unsave_markers (fp
);
534 if (fp
->_flags
& _IO_NO_READS
)
537 /* Try to seek to a block boundary, to improve kernel page management. */
538 new_offset
= offset
& ~(fp
->_IO_buf_end
- fp
->_IO_buf_base
- 1);
539 delta
= offset
- new_offset
;
540 if (delta
> fp
->_IO_buf_end
- fp
->_IO_buf_base
)
545 result
= _IO_SYSSEEK (fp
, new_offset
, 0);
552 count
= _IO_SYSREAD (fp
, fp
->_IO_buf_base
,
554 ? delta
: fp
->_IO_buf_end
- fp
->_IO_buf_base
));
557 /* We weren't allowed to read, but try to seek the remainder. */
558 offset
= count
== EOF
? delta
: delta
-count
;
563 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
+ delta
,
564 fp
->_IO_buf_base
+ count
);
565 _IO_setp (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
566 fp
->_offset
= result
+ count
;
567 _IO_mask_flags (fp
, 0, _IO_EOF_SEEN
);
571 _IO_unsave_markers (fp
);
572 result
= _IO_SYSSEEK (fp
, offset
, dir
);
574 _IO_mask_flags (fp
, 0, _IO_EOF_SEEN
);
575 fp
->_offset
= result
;
576 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
577 _IO_setp (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
582 _IO_file_read (fp
, buf
, size
)
587 return read (fp
->_fileno
, buf
, size
);
591 _IO_file_seek (fp
, offset
, dir
)
596 return lseek (fp
->_fileno
, offset
, dir
);
600 _IO_file_stat (fp
, st
)
604 return fstat (fp
->_fileno
, (struct stat
*) st
);
611 return close (fp
->_fileno
);
615 _IO_file_write (f
, data
, n
)
620 _IO_ssize_t to_do
= n
;
623 _IO_ssize_t count
= write (f
->_fileno
, data
, to_do
);
626 f
->_flags
|= _IO_ERR_SEEN
;
630 data
= (void *) ((char *) data
+ count
);
639 _IO_file_xsputn (f
, data
, n
)
644 register const char *s
= (char *) data
;
645 _IO_size_t to_do
= n
;
651 /* This is an optimized implementation.
652 If the amount to be written straddles a block boundary
653 (or the filebuf is unbuffered), use sys_write directly. */
655 /* First figure out how much space is available in the buffer. */
656 count
= f
->_IO_write_end
- f
->_IO_write_ptr
; /* Space available. */
657 if ((f
->_flags
& _IO_LINE_BUF
) && (f
->_flags
& _IO_CURRENTLY_PUTTING
))
659 count
= f
->_IO_buf_end
- f
->_IO_write_ptr
;
662 register const char *p
;
663 for (p
= s
+ n
; p
> s
; )
674 /* Then fill the buffer. */
681 memcpy (f
->_IO_write_ptr
, s
, count
);
686 register char *p
= f
->_IO_write_ptr
;
687 register int i
= (int) count
;
691 f
->_IO_write_ptr
+= count
;
694 if (to_do
+ must_flush
> 0)
696 _IO_size_t block_size
, dont_write
;
697 /* Next flush the (full) buffer. */
698 if (__overflow (f
, EOF
) == EOF
)
701 /* Try to maintain alignment: write a whole number of blocks.
702 dont_write is what gets left over. */
703 block_size
= f
->_IO_buf_end
- f
->_IO_buf_base
;
704 dont_write
= block_size
>= 128 ? to_do
% block_size
: 0;
706 count
= to_do
- dont_write
;
707 if (_IO_do_write (f
, s
, count
) == EOF
)
711 /* Now write out the remainder. Normally, this will fit in the
712 buffer, but it's somewhat messier for line-buffered files,
713 so we let _IO_default_xsputn handle the general case. */
715 to_do
-= _IO_default_xsputn (f
, s
+count
, dont_write
);
721 /* Work in progress */
723 _IO_file_xsgetn (fp
, data
, n
)
728 register _IO_size_t more
= n
;
729 register char *s
= data
;
732 /* Data available. */
733 _IO_ssize_t count
= fp
->_IO_read_end
- fp
->_IO_read_ptr
;
740 memcpy (s
, fp
->_IO_read_ptr
, count
);
742 fp
->_IO_read_ptr
+= count
;
748 register char *p
= fp
->_IO_read_ptr
;
749 register int i
= (int) count
;
752 fp
->_IO_read_ptr
= p
;
757 if (! _IO_in
put_mode (fp
)
758 && ! _IO_have_markers (fp
) && ! IO_have_backup (fp
))
760 /* This is an optimization of _IO_file_underflow */
761 if (fp
->_flags
& _IO_NO_READS
)
763 /* If we're reading a lot of data, don't bother allocating
764 a buffer. But if we're only reading a bit, perhaps we should ??*/
765 if (count
<= 512 && fp
->_IO_buf_base
== NULL
)
767 if (fp
->_flags
& (_IO_LINE_BUF
|_IO_UNBUFFERED
))
768 _IO_flush_all_linebuffered ();
770 _IO_switch_to_get_mode (fp
); ???;
771 count
= _IO_SYSREAD (fp
, s
, more
);
775 fp
->_flags
|= _IO_EOF_SEEN
;
777 fp
->_flags
|= _IO_ERR_SEEN
, count
= 0;
784 if (more
== 0 || __underflow (fp
) == EOF
)
791 struct _IO_jump_t _IO_file_jumps
=
794 JUMP_INIT(finish
, _IO_file_finish
),
795 JUMP_INIT(overflow
, _IO_file_overflow
),
796 JUMP_INIT(underflow
, _IO_file_underflow
),
797 JUMP_INIT(uflow
, _IO_default_uflow
),
798 JUMP_INIT(pbackfail
, _IO_default_pbackfail
),
799 JUMP_INIT(xsputn
, _IO_file_xsputn
),
800 JUMP_INIT(xsgetn
, _IO_default_xsgetn
),
801 JUMP_INIT(seekoff
, _IO_file_seekoff
),
802 JUMP_INIT(seekpos
, _IO_default_seekpos
),
803 JUMP_INIT(setbuf
, _IO_file_setbuf
),
804 JUMP_INIT(sync
, _IO_file_sync
),
805 JUMP_INIT(doallocate
, _IO_file_doallocate
),
806 JUMP_INIT(read
, _IO_file_read
),
807 JUMP_INIT(write
, _IO_file_write
),
808 JUMP_INIT(seek
, _IO_file_seek
),
809 JUMP_INIT(close
, _IO_file_close
),
810 JUMP_INIT(stat
, _IO_file_stat
)