lib/fflush.c

   1 /* fflush.c -- allow flushing input streams
   2    Copyright (C) 2007-2009 Free Software Foundation, Inc.
   3
   4    This program is free software: you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation; either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  16
  17 /* Written by Eric Blake. */
  18
  19 #include <config.h>
  20
  21 /* Specification.  */
  22 #include <stdio.h>
  23
  24 #include <errno.h>
  25 #include <unistd.h>
  26
  27 #include "freading.h"
  28 #include "fpurge.h"
  29
  30 #include "stdio-impl.h"
  31
  32 #undef fflush
  33
  34
  35 #if defined _IO_ftrylockfile || __GNU_LIBRARY__ == 1 /* GNU libc, BeOS, Haiku, Linux libc5 */
  36
  37 /* Clear the stream's ungetc buffer, preserving the value of ftello (fp).  */
  38 static inline void
  39 clear_ungetc_buffer_preserving_position (FILE *fp)
  40 {
  41   if (fp->_flags & _IO_IN_BACKUP)
  42     /* _IO_free_backup_area is a bit complicated.  Simply call fseek.  */
  43     fseek (fp, 0, SEEK_CUR);
  44 }
  45
  46 #else
  47
  48 /* Clear the stream's ungetc buffer.  May modify the value of ftello (fp).  */
  49 static inline void
  50 clear_ungetc_buffer (FILE *fp)
  51 {
  52 # if defined __sferror || defined __DragonFly__ /* FreeBSD, NetBSD, OpenBSD, DragonFly, MacOS X, Cygwin */
  53   if (HASUB (fp))
  54     {
  55       fp_->_p += fp_->_r;
  56       fp_->_r = 0;
  57     }
  58 # elif defined __EMX__              /* emx+gcc */
  59   if (fp->_ungetc_count > 0)
  60     {
  61       fp->_ungetc_count = 0;
  62       fp->_rcount = - fp->_rcount;
  63     }
  64 # elif defined _IOERR               /* AIX, HP-UX, IRIX, OSF/1, Solaris, OpenServer, mingw */
  65   /* Nothing to do.  */
  66 # else                              /* other implementations */
  67   fseek (fp, 0, SEEK_CUR);
  68 # endif
  69 }
  70
  71 #endif
  72
  73 #if (defined __sferror || defined __DragonFly__) && defined __SNPT /* FreeBSD, NetBSD, OpenBSD, DragonFly, MacOS X, Cygwin */
  74
  75 static inline int
  76 disable_seek_optimization (FILE *fp)
  77 {
  78   int saved_flags = fp_->_flags & (__SOPT | __SNPT);
  79   fp_->_flags = (fp_->_flags & ~__SOPT) | __SNPT;
  80   return saved_flags;
  81 }
  82
  83 static inline void
  84 restore_seek_optimization (FILE *fp, int saved_flags)
  85 {
  86   fp_->_flags = (fp_->_flags & ~(__SOPT | __SNPT)) | saved_flags;
  87 }
  88
  89 #endif
  90
  91 static inline void
  92 update_fpos_cache (FILE *fp, off_t pos)
  93 {
  94 #if defined __sferror || defined __DragonFly__ /* FreeBSD, NetBSD, OpenBSD, DragonFly, MacOS X, Cygwin */
  95   fp_->_offset = pos;
  96   fp_->_flags |= __SOFF;
  97 #endif
  98 }
  99
 100 /* Flush all pending data on STREAM according to POSIX rules.  Both
 101    output and seekable input streams are supported.  */
 102 int
 103 rpl_fflush (FILE *stream)
 104 {
 105   int result;
 106   off_t pos;
 107
 108   /* When stream is NULL, POSIX and C99 only require flushing of "output
 109      streams and update streams in which the most recent operation was not
 110      input", and all implementations do this.
 111
 112      When stream is "an output stream or an update stream in which the most
 113      recent operation was not input", POSIX and C99 requires that fflush
 114      writes out any buffered data, and all implementations do this.
 115
 116      When stream is, however, an input stream or an update stream in
 117      which the most recent operation was input, C99 specifies nothing,
 118      and POSIX only specifies behavior if the stream is seekable.
 119      mingw, in particular, drops the input buffer, leaving the file
 120      descriptor positioned at the end of the input buffer. I.e. ftell
 121      (stream) is lost.  We don't want to call the implementation's
 122      fflush in this case.
 123
 124      We test ! freading (stream) here, rather than fwriting (stream), because
 125      what we need to know is whether the stream holds a "read buffer", and on
 126      mingw this is indicated by _IOREAD, regardless of _IOWRT.  */
 127   if (stream == NULL || ! freading (stream))
 128     return fflush (stream);
 129
 130 #if defined _IO_ftrylockfile || __GNU_LIBRARY__ == 1 /* GNU libc, BeOS, Haiku, Linux libc5 */
 131
 132   clear_ungetc_buffer_preserving_position (stream);
 133
 134   return fflush (stream);
 135
 136 #else
 137
 138   /* Notes about the file-position indicator:
 139      1) The file position indicator is incremented by fgetc() and decremented
 140         by ungetc():
 141         <http://www.opengroup.org/susv3/functions/fgetc.html>
 142           "... the fgetc() function shall ... advance the associated file
 143            position indicator for the stream ..."
 144         <http://www.opengroup.org/susv3/functions/ungetc.html>
 145           "The file-position indicator is decremented by each successful
 146            call to ungetc()..."
 147      2) <http://www.opengroup.org/susv3/functions/ungetc.html> says:
 148           "The value of the file-position indicator for the stream after
 149            reading or discarding all pushed-back bytes shall be the same
 150            as it was before the bytes were pushed back."
 151         Here we are discarding all pushed-back bytes.  But more specifically,
 152      3) <http://www.opengroup.org/austin/aardvark/latest/xshbug3.txt> says:
 153           "[After fflush(),] the file offset of the underlying open file
 154            description shall be set to the file position of the stream, and
 155            any characters pushed back onto the stream by ungetc() ... shall
 156            be discarded."  */
 157
 158   /* POSIX does not specify fflush behavior for non-seekable input
 159      streams.  Some implementations purge unread data, some return
 160      EBADF, some do nothing.  */
 161   pos = ftello (stream);
 162   if (pos == -1)
 163     {
 164       errno = EBADF;
 165       return EOF;
 166     }
 167
 168   /* Clear the ungetc buffer.  */
 169   clear_ungetc_buffer (stream);
 170
 171   /* To get here, we must be flushing a seekable input stream, so the
 172      semantics of fpurge are now appropriate to clear the buffer.  To
 173      avoid losing data, the lseek is also necessary.  */
 174   result = fpurge (stream);
 175   if (result != 0)
 176     return result;
 177
 178 # if (defined __sferror || defined __DragonFly__) && defined __SNPT /* FreeBSD, NetBSD, OpenBSD, DragonFly, MacOS X, Cygwin */
 179
 180   {
 181     /* Disable seek optimization for the next fseeko call.  This tells the
 182        following fseeko call to seek to the desired position directly, rather
 183        than to seek to a block-aligned boundary.  */
 184     int saved_flags = disable_seek_optimization (stream);
 185
 186     result = fseeko (stream, pos, SEEK_SET);
 187
 188     restore_seek_optimization (stream, saved_flags);
 189   }
 190   return result;
 191
 192 # else
 193
 194   pos = lseek (fileno (stream), pos, SEEK_SET);
 195   if (pos == -1)
 196     return EOF;
 197   /* After a successful lseek, update the file descriptor's position cache
 198      in the stream.  */
 199   update_fpos_cache (stream, pos);
 200
 201   return 0;
 202
 203 # endif
 204 #endif
 205 }