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>
44 # define open(Name, Flags, Prot) __open (Name, Flags, Prot)
45 # define close(FD) __close (FD)
46 # define fstat(FD, Statbuf) __fstat (FD, Statbuf)
47 # define lseek(FD, Offset, Whence) __lseek (FD, Offset, Whence)
48 # define read(FD, Buf, NBytes) __read (FD, Buf, NBytes)
49 # define write(FD, Buf, NBytes) __write (FD, Buf, NBytes)
52 /* An fstream can be in at most one of put mode, get mode, or putback mode.
53 Putback mode is a variant of get mode.
55 In a filebuf, there is only one current position, instead of two
56 separate get and put pointers. In get mode, the current position
57 is that of gptr(); in put mode that of pptr().
59 The position in the buffer that corresponds to the position
60 in external file system is normally _IO_read_end, except in putback
61 mode, when it is _IO_save_end.
62 If the field _fb._offset is >= 0, it gives the offset in
63 the file as a whole corresponding to eGptr(). (?)
66 If a filebuf is in put mode, then all of _IO_read_ptr, _IO_read_end,
67 and _IO_read_base are equal to each other. These are usually equal
68 to _IO_buf_base, though not necessarily if we have switched from
69 get mode to put mode. (The reason is to maintain the invariant
70 that _IO_read_end corresponds to the external file position.)
71 _IO_write_base is non-NULL and usually equal to _IO_base_base.
72 We also have _IO_write_end == _IO_buf_end, but only in fully buffered mode.
73 The un-flushed character are those between _IO_write_base and _IO_write_ptr.
76 If a filebuf is in get or putback mode, eback() != egptr().
77 In get mode, the unread characters are between gptr() and egptr().
78 The OS file position corresponds to that of egptr().
81 Putback mode is used to remember "excess" characters that have
82 been sputbackc'd in a separate putback buffer.
83 In putback mode, the get buffer points to the special putback buffer.
84 The unread characters are the characters between gptr() and egptr()
85 in the putback buffer, as well as the area between save_gptr()
86 and save_egptr(), which point into the original reserve buffer.
87 (The pointers save_gptr() and save_egptr() are the values
88 of gptr() and egptr() at the time putback mode was entered.)
89 The OS position corresponds to that of save_egptr().
92 During line buffered output, _IO_write_base==base() && epptr()==base().
93 However, ptr() may be anywhere between base() and ebuf().
94 This forces a call to filebuf::overflow(int C) on every put.
95 If there is more space in the buffer, and C is not a '\n',
96 then C is inserted, and pptr() incremented.
99 If a filebuf is unbuffered(), the _shortbuf[1] is used as the buffer.
102 #define CLOSED_FILEBUF_FLAGS \
103 (_IO_IS_FILEBUF+_IO_NO_READS+_IO_NO_WRITES+_IO_TIED_PUT_GET)
110 /* POSIX.1 allows another file handle to be used to change the position
111 of our file descriptor. Hence we actually don't know the actual
112 position before we do the first fseek (and until a following fflush). */
113 fp
->_offset
= _IO_pos_BAD
;
114 fp
->_IO_file_flags
|= CLOSED_FILEBUF_FLAGS
;
121 _IO_file_close_it (fp
)
124 int write_status
, close_status
;
125 if (!_IO_file_is_open (fp
))
128 write_status
= _IO_do_flush (fp
);
130 _IO_unsave_markers(fp
);
132 close_status
= _IO_SYSCLOSE (fp
);
135 _IO_setb (fp
, NULL
, NULL
, 0);
136 _IO_setg (fp
, NULL
, NULL
, NULL
);
137 _IO_setp (fp
, NULL
, NULL
);
140 fp
->_flags
= _IO_MAGIC
|CLOSED_FILEBUF_FLAGS
;
142 fp
->_offset
= _IO_pos_BAD
;
144 return close_status
? close_status
: write_status
;
148 _IO_file_finish (fp
, dummy
)
152 if (_IO_file_is_open (fp
))
155 if (!(fp
->_flags
& _IO_DELETE_DONT_CLOSE
))
158 _IO_default_finish (fp
, 0);
162 _IO_file_fopen (fp
, filename
, mode
)
164 const char *filename
;
167 int oflags
= 0, omode
;
168 int read_write
, fdesc
;
170 if (_IO_file_is_open (fp
))
176 read_write
= _IO_NO_WRITES
;
180 oflags
= O_CREAT
|O_TRUNC
;
181 read_write
= _IO_NO_READS
;
185 oflags
= O_CREAT
|O_APPEND
;
186 read_write
= _IO_NO_READS
|_IO_IS_APPENDING
;
189 __set_errno (EINVAL
);
192 if (mode
[0] == '+' || (mode
[0] == 'b' && mode
[1] == '+'))
195 read_write
&= _IO_IS_APPENDING
;
197 fdesc
= open (filename
, omode
|oflags
, oprot
);
201 _IO_mask_flags (fp
, read_write
,_IO_NO_READS
+_IO_NO_WRITES
+_IO_IS_APPENDING
);
202 if (read_write
& _IO_IS_APPENDING
)
203 if (_IO_SEEKOFF (fp
, (_IO_off_t
)0, _IO_seek_end
, _IOS_INPUT
|_IOS_OUTPUT
)
204 == _IO_pos_BAD
&& errno
!= ESPIPE
)
211 _IO_file_attach (fp
, fd
)
215 if (_IO_file_is_open (fp
))
218 fp
->_flags
&= ~(_IO_NO_READS
+_IO_NO_WRITES
);
219 fp
->_flags
|= _IO_DELETE_DONT_CLOSE
;
220 /* Get the current position of the file. */
221 /* We have to do that since that may be junk. */
222 fp
->_offset
= _IO_pos_BAD
;
223 if (_IO_SEEKOFF (fp
, (_IO_off_t
)0, _IO_seek_cur
, _IOS_INPUT
|_IOS_OUTPUT
)
224 == _IO_pos_BAD
&& errno
!= ESPIPE
)
230 _IO_file_setbuf (fp
, p
, len
)
235 if (_IO_default_setbuf (fp
, p
, len
) == NULL
)
238 fp
->_IO_write_base
= fp
->_IO_write_ptr
= fp
->_IO_write_end
240 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
245 /* Write TO_DO bytes from DATA to FP.
246 Then mark FP as having empty buffers. */
249 _IO_do_write (fp
, data
, to_do
)
257 if (fp
->_flags
& _IO_IS_APPENDING
)
258 /* On a system without a proper O_APPEND implementation,
259 you would need to sys_seek(0, SEEK_END) here, but it
260 is not needed nor desirable for Unix- or Posix-like systems.
261 Instead, just indicate that offset (before and after) is
263 fp
->_offset
= _IO_pos_BAD
;
264 else if (fp
->_IO_read_end
!= fp
->_IO_write_base
)
267 = _IO_SYSSEEK (fp
, fp
->_IO_write_base
- fp
->_IO_read_end
, 1);
268 if (new_pos
== _IO_pos_BAD
)
270 fp
->_offset
= new_pos
;
272 count
= _IO_SYSWRITE (fp
, data
, to_do
);
274 fp
->_cur_column
= _IO_adjust_column (fp
->_cur_column
- 1, data
, to_do
) + 1;
275 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
276 fp
->_IO_write_base
= fp
->_IO_write_ptr
= fp
->_IO_buf_base
;
277 fp
->_IO_write_end
= ((fp
->_flags
& (_IO_LINE_BUF
+_IO_UNBUFFERED
))
278 ? fp
->_IO_buf_base
: fp
->_IO_buf_end
);
279 return count
!= to_do
? EOF
: 0;
283 _IO_file_underflow (fp
)
288 /* SysV does not make this test; take it out for compatibility */
289 if (fp
->_flags
& _IO_EOF_SEEN
)
293 if (fp
->_flags
& _IO_NO_READS
)
298 if (fp
->_IO_read_ptr
< fp
->_IO_read_end
)
299 return *(unsigned char *) fp
->_IO_read_ptr
;
301 if (fp
->_IO_buf_base
== NULL
)
304 /* Flush all line buffered files before reading. */
305 /* FIXME This can/should be moved to genops ?? */
306 if (fp
->_flags
& (_IO_LINE_BUF
|_IO_UNBUFFERED
))
307 _IO_flush_all_linebuffered ();
309 _IO_switch_to_get_mode (fp
);
311 /* This is very tricky. We have to adjust those
312 pointers before we call _IO_SYSREAD () since
313 we may longjump () out while waiting for
314 input. Those pointers may be screwed up. H.J. */
315 fp
->_IO_read_base
= fp
->_IO_read_ptr
= fp
->_IO_buf_base
;
316 fp
->_IO_read_end
= fp
->_IO_buf_base
;
317 fp
->_IO_write_base
= fp
->_IO_write_ptr
= fp
->_IO_write_end
320 count
= _IO_SYSREAD (fp
, fp
->_IO_buf_base
,
321 fp
->_IO_buf_end
- fp
->_IO_buf_base
);
325 fp
->_flags
|= _IO_EOF_SEEN
;
327 fp
->_flags
|= _IO_ERR_SEEN
, count
= 0;
329 fp
->_IO_read_end
+= count
;
332 if (fp
->_offset
!= _IO_pos_BAD
)
333 _IO_pos_adjust (fp
->_offset
, count
);
334 return *(unsigned char *) fp
->_IO_read_ptr
;
338 _IO_file_overflow (f
, ch
)
342 if (f
->_flags
& _IO_NO_WRITES
) /* SET ERROR */
344 f
->_flags
|= _IO_ERR_SEEN
;
348 /* If currently reading or no buffer allocated. */
349 if ((f
->_flags
& _IO_CURRENTLY_PUTTING
) == 0)
351 /* Allocate a buffer if needed. */
352 if (f
->_IO_write_base
== 0)
355 _IO_setg (f
, f
->_IO_buf_base
, f
->_IO_buf_base
, f
->_IO_buf_base
);
357 /* Otherwise must be currently reading.
358 If _IO_read_ptr (and hence also _IO_read_end) is at the buffer end,
359 logically slide the buffer forwards one block (by setting the
360 read pointers to all point at the beginning of the block). This
361 makes room for subsequent output.
362 Otherwise, set the read pointers to _IO_read_end (leaving that
363 alone, so it can continue to correspond to the external position). */
364 if (f
->_IO_read_ptr
== f
->_IO_buf_end
)
365 f
->_IO_read_end
= f
->_IO_read_ptr
= f
->_IO_buf_base
;
366 f
->_IO_write_ptr
= f
->_IO_read_ptr
;
367 f
->_IO_write_base
= f
->_IO_write_ptr
;
368 f
->_IO_write_end
= f
->_IO_buf_end
;
369 f
->_IO_read_base
= f
->_IO_read_ptr
= f
->_IO_read_end
;
371 if (f
->_flags
& (_IO_LINE_BUF
+_IO_UNBUFFERED
))
372 f
->_IO_write_end
= f
->_IO_write_ptr
;
373 f
->_flags
|= _IO_CURRENTLY_PUTTING
;
376 return _IO_do_flush (f
);
377 if (f
->_IO_write_ptr
== f
->_IO_buf_end
) /* Buffer is really full */
378 if (_IO_do_flush (f
) == EOF
)
380 *f
->_IO_write_ptr
++ = ch
;
381 if ((f
->_flags
& _IO_UNBUFFERED
)
382 || ((f
->_flags
& _IO_LINE_BUF
) && ch
== '\n'))
383 if (_IO_do_flush (f
) == EOF
)
385 return (unsigned char) ch
;
395 _IO_cleanup_region_start ((void (*) __P ((void *))) _IO_funlockfile
, fp
);
397 /* char* ptr = cur_ptr(); */
398 if (fp
->_IO_write_ptr
> fp
->_IO_write_base
)
399 if (_IO_do_flush(fp
)) return EOF
;
400 delta
= fp
->_IO_read_ptr
- fp
->_IO_read_end
;
404 if (_IO_in_backup (fp
))
405 delta
-= eGptr () - Gbase ();
407 _IO_off_t new_pos
= _IO_SYSSEEK (fp
, delta
, 1);
408 if (new_pos
!= (_IO_off_t
) EOF
)
409 fp
->_IO_read_end
= fp
->_IO_read_ptr
;
411 else if (errno
== ESPIPE
)
412 ; /* Ignore error from unseekable devices. */
418 fp
->_offset
= _IO_pos_BAD
;
419 /* FIXME: Cleanup - can this be shared? */
420 /* setg(base(), ptr, ptr); */
421 _IO_cleanup_region_end (1);
426 _IO_file_seekoff (fp
, offset
, dir
, mode
)
433 _IO_off_t delta
, new_offset
;
435 /* POSIX.1 8.2.3.7 says that after a call the fflush() the file
436 offset of the underlying file must be exact. */
437 int must_be_exact
= (fp
->_IO_read_base
== fp
->_IO_read_end
438 && fp
->_IO_write_base
== fp
->_IO_write_ptr
);
441 dir
= _IO_seek_cur
, offset
= 0; /* Don't move any pointers. */
443 /* Flush unwritten characters.
444 (This may do an unneeded write if we seek within the buffer.
445 But to be able to switch to reading, we would need to set
446 egptr to ptr. That can't be done in the current design,
447 which assumes file_ptr() is eGptr. Anyway, since we probably
448 end up flushing when we close(), it doesn't make much difference.)
449 FIXME: simulate mem-papped files. */
451 if (fp
->_IO_write_ptr
> fp
->_IO_write_base
|| _IO_in_put_mode (fp
))
452 if (_IO_switch_to_get_mode (fp
))
455 if (fp
->_IO_buf_base
== NULL
)
458 _IO_setp (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
459 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
465 /* Adjust for read-ahead (bytes is buffer). */
466 offset
-= fp
->_IO_read_end
- fp
->_IO_read_ptr
;
467 if (fp
->_offset
== _IO_pos_BAD
)
469 /* Make offset absolute, assuming current pointer is file_ptr(). */
470 offset
+= _IO_pos_as_off (fp
->_offset
);
479 if (_IO_SYSSTAT (fp
, &st
) == 0 && S_ISREG (st
.st_mode
))
481 offset
+= st
.st_size
;
488 /* At this point, dir==_IO_seek_set. */
490 /* If destination is within current buffer, optimize: */
491 if (fp
->_offset
!= _IO_pos_BAD
&& fp
->_IO_read_base
!= NULL
492 && !_IO_in_backup (fp
))
494 /* Offset relative to start of main get area. */
495 _IO_pos_t rel_offset
= (offset
- fp
->_offset
496 + (fp
->_IO_read_end
- fp
->_IO_read_base
));
500 if (_IO_in_backup (fp
))
501 _IO_switch_to_main_get_area (fp
);
503 if (rel_offset
<= fp
->_IO_read_end
- fp
->_IO_read_base
)
505 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
+ rel_offset
,
507 _IO_setp (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
511 /* If we have streammarkers, seek forward by reading ahead. */
512 if (_IO_have_markers (fp
))
514 int to_skip
= rel_offset
515 - (fp
->_IO_read_ptr
- fp
->_IO_read_base
);
516 if (ignore (to_skip
) != to_skip
)
523 if (rel_offset
< 0 && rel_offset
>= Bbase () - Bptr ())
525 if (!_IO_in_backup (fp
))
526 _IO_switch_to_backup_area (fp
);
527 gbump (fp
->_IO_read_end
+ rel_offset
- fp
->_IO_read_ptr
);
534 _IO_unsave_markers (fp
);
537 if (fp
->_flags
& _IO_NO_READS
)
540 /* Try to seek to a block boundary, to improve kernel page management. */
541 new_offset
= offset
& ~(fp
->_IO_buf_end
- fp
->_IO_buf_base
- 1);
542 delta
= offset
- new_offset
;
543 if (delta
> fp
->_IO_buf_end
- fp
->_IO_buf_base
)
548 result
= _IO_SYSSEEK (fp
, new_offset
, 0);
555 count
= _IO_SYSREAD (fp
, fp
->_IO_buf_base
,
557 ? delta
: fp
->_IO_buf_end
- fp
->_IO_buf_base
));
560 /* We weren't allowed to read, but try to seek the remainder. */
561 offset
= count
== EOF
? delta
: delta
-count
;
566 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
+ delta
,
567 fp
->_IO_buf_base
+ count
);
568 _IO_setp (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
569 fp
->_offset
= result
+ count
;
570 _IO_mask_flags (fp
, 0, _IO_EOF_SEEN
);
574 _IO_unsave_markers (fp
);
575 result
= _IO_SYSSEEK (fp
, offset
, dir
);
577 _IO_mask_flags (fp
, 0, _IO_EOF_SEEN
);
578 fp
->_offset
= result
;
579 _IO_setg (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
580 _IO_setp (fp
, fp
->_IO_buf_base
, fp
->_IO_buf_base
);
585 _IO_file_read (fp
, buf
, size
)
590 return read (fp
->_fileno
, buf
, size
);
594 _IO_file_seek (fp
, offset
, dir
)
599 return lseek (fp
->_fileno
, offset
, dir
);
603 _IO_file_stat (fp
, st
)
607 return fstat (fp
->_fileno
, (struct stat
*) st
);
614 return close (fp
->_fileno
);
618 _IO_file_write (f
, data
, n
)
623 _IO_ssize_t to_do
= n
;
626 _IO_ssize_t count
= write (f
->_fileno
, data
, to_do
);
629 f
->_flags
|= _IO_ERR_SEEN
;
633 data
= (void *) ((char *) data
+ count
);
642 _IO_file_xsputn (f
, data
, n
)
647 register const char *s
= (char *) data
;
648 _IO_size_t to_do
= n
;
654 /* This is an optimized implementation.
655 If the amount to be written straddles a block boundary
656 (or the filebuf is unbuffered), use sys_write directly. */
658 /* First figure out how much space is available in the buffer. */
659 count
= f
->_IO_write_end
- f
->_IO_write_ptr
; /* Space available. */
660 if ((f
->_flags
& _IO_LINE_BUF
) && (f
->_flags
& _IO_CURRENTLY_PUTTING
))
662 count
= f
->_IO_buf_end
- f
->_IO_write_ptr
;
665 register const char *p
;
666 for (p
= s
+ n
; p
> s
; )
677 /* Then fill the buffer. */
684 memcpy (f
->_IO_write_ptr
, s
, count
);
689 register char *p
= f
->_IO_write_ptr
;
690 register int i
= (int) count
;
694 f
->_IO_write_ptr
+= count
;
697 if (to_do
+ must_flush
> 0)
699 _IO_size_t block_size
, dont_write
;
700 /* Next flush the (full) buffer. */
701 if (__overflow (f
, EOF
) == EOF
)
704 /* Try to maintain alignment: write a whole number of blocks.
705 dont_write is what gets left over. */
706 block_size
= f
->_IO_buf_end
- f
->_IO_buf_base
;
707 dont_write
= block_size
>= 128 ? to_do
% block_size
: 0;
709 count
= to_do
- dont_write
;
710 if (_IO_do_write (f
, s
, count
) == EOF
)
714 /* Now write out the remainder. Normally, this will fit in the
715 buffer, but it's somewhat messier for line-buffered files,
716 so we let _IO_default_xsputn handle the general case. */
718 to_do
-= _IO_default_xsputn (f
, s
+count
, dont_write
);
724 /* Work in progress */
726 _IO_file_xsgetn (fp
, data
, n
)
731 register _IO_size_t more
= n
;
732 register char *s
= data
;
735 /* Data available. */
736 _IO_ssize_t count
= fp
->_IO_read_end
- fp
->_IO_read_ptr
;
743 memcpy (s
, fp
->_IO_read_ptr
, count
);
745 fp
->_IO_read_ptr
+= count
;
751 register char *p
= fp
->_IO_read_ptr
;
752 register int i
= (int) count
;
755 fp
->_IO_read_ptr
= p
;
760 if (! _IO_in
put_mode (fp
)
761 && ! _IO_have_markers (fp
) && ! IO_have_backup (fp
))
763 /* This is an optimization of _IO_file_underflow */
764 if (fp
->_flags
& _IO_NO_READS
)
766 /* If we're reading a lot of data, don't bother allocating
767 a buffer. But if we're only reading a bit, perhaps we should ??*/
768 if (count
<= 512 && fp
->_IO_buf_base
== NULL
)
770 if (fp
->_flags
& (_IO_LINE_BUF
|_IO_UNBUFFERED
))
771 _IO_flush_all_linebuffered ();
773 _IO_switch_to_get_mode (fp
); ???;
774 count
= _IO_SYSREAD (fp
, s
, more
);
778 fp
->_flags
|= _IO_EOF_SEEN
;
780 fp
->_flags
|= _IO_ERR_SEEN
, count
= 0;
787 if (more
== 0 || __underflow (fp
) == EOF
)
794 struct _IO_jump_t _IO_file_jumps
=
797 JUMP_INIT(finish
, _IO_file_finish
),
798 JUMP_INIT(overflow
, _IO_file_overflow
),
799 JUMP_INIT(underflow
, _IO_file_underflow
),
800 JUMP_INIT(uflow
, _IO_default_uflow
),
801 JUMP_INIT(pbackfail
, _IO_default_pbackfail
),
802 JUMP_INIT(xsputn
, _IO_file_xsputn
),
803 JUMP_INIT(xsgetn
, _IO_default_xsgetn
),
804 JUMP_INIT(seekoff
, _IO_file_seekoff
),
805 JUMP_INIT(seekpos
, _IO_default_seekpos
),
806 JUMP_INIT(setbuf
, _IO_file_setbuf
),
807 JUMP_INIT(sync
, _IO_file_sync
),
808 JUMP_INIT(doallocate
, _IO_file_doallocate
),
809 JUMP_INIT(read
, _IO_file_read
),
810 JUMP_INIT(write
, _IO_file_write
),
811 JUMP_INIT(seek
, _IO_file_seek
),
812 JUMP_INIT(close
, _IO_file_close
),
813 JUMP_INIT(stat
, _IO_file_stat
)