lib/fflush.c

   1 /* fflush.c -- allow flushing input streams
   2    Copyright (C) 2007-2008 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 static inline void
  35 clear_ungetc_buffer (FILE *fp)
  36 {
  37 #if defined __sferror || defined __DragonFly__ /* FreeBSD, NetBSD, OpenBSD, DragonFly, MacOS X, Cygwin */
  38   if (HASUB (fp))
  39     {
  40       fp_->_p += fp_->_r;
  41       fp_->_r = 0;
  42     }
  43 #endif
  44 }
  45
  46 #if (defined __sferror || defined __DragonFly__) && defined __SNPT /* FreeBSD, NetBSD, OpenBSD, DragonFly, MacOS X, Cygwin */
  47
  48 static inline int
  49 disable_seek_optimization (FILE *fp)
  50 {
  51   int saved_flags = fp_->_flags & (__SOPT | __SNPT);
  52   fp_->_flags = (fp_->_flags & ~__SOPT) | __SNPT;
  53   return saved_flags;
  54 }
  55
  56 static inline void
  57 restore_seek_optimization (FILE *fp, int saved_flags)
  58 {
  59   fp_->_flags = (fp_->_flags & ~(__SOPT | __SNPT)) | saved_flags;
  60 }
  61
  62 #endif
  63
  64 static inline void
  65 update_fpos_cache (FILE *fp)
  66 {
  67 #if defined __sferror || defined __DragonFly__ /* FreeBSD, NetBSD, OpenBSD, DragonFly, MacOS X, Cygwin */
  68   fp_->_offset = pos;
  69   fp_->_flags |= __SOFF;
  70 #endif
  71 }
  72
  73 /* Flush all pending data on STREAM according to POSIX rules.  Both
  74    output and seekable input streams are supported.  */
  75 int
  76 rpl_fflush (FILE *stream)
  77 {
  78   int result;
  79   off_t pos;
  80
  81   /* When stream is NULL, POSIX and C99 only require flushing of "output
  82      streams and update streams in which the most recent operation was not
  83      input", and all implementations do this.
  84
  85      When stream is "an output stream or an update stream in which the most
  86      recent operation was not input", POSIX and C99 requires that fflush
  87      writes out any buffered data, and all implementations do this.
  88
  89      When stream is, however, an input stream or an update stream in
  90      which the most recent operation was input, C99 specifies nothing,
  91      and POSIX only specifies behavior if the stream is seekable.
  92      mingw, in particular, drops the input buffer, leaving the file
  93      descriptor positioned at the end of the input buffer. I.e. ftell
  94      (stream) is lost.  We don't want to call the implementation's
  95      fflush in this case.
  96
  97      We test ! freading (stream) here, rather than fwriting (stream), because
  98      what we need to know is whether the stream holds a "read buffer", and on
  99      mingw this is indicated by _IOREAD, regardless of _IOWRT.  */
 100   if (stream == NULL || ! freading (stream))
 101     return fflush (stream);
 102
 103   /* Clear the ungetc buffer.
 104
 105      This is needed before fetching the file-position indicator, because
 106      1) The file position indicator is incremented by fgetc() and decremented
 107         by ungetc():
 108         <http://www.opengroup.org/susv3/functions/fgetc.html>
 109           "... the fgetc() function shall ... advance the associated file
 110            position indicator for the stream ..."
 111         <http://www.opengroup.org/susv3/functions/ungetc.html>
 112           "The file-position indicator is decremented by each successful
 113            call to ungetc()..."
 114      2) <http://www.opengroup.org/susv3/functions/ungetc.html> says:
 115           "The value of the file-position indicator for the stream after
 116            reading or discarding all pushed-back bytes shall be the same
 117            as it was before the bytes were pushed back."
 118      3) Here we are discarding all pushed-back bytes.
 119
 120      Unfortunately it is impossible to implement this on platforms with
 121      _IOERR, because an ungetc() on this platform prepends the pushed-back
 122      bytes to the buffer without an indication of the limit between the
 123      pushed-back bytes and the read-ahead bytes.  */
 124   clear_ungetc_buffer (stream);
 125
 126   /* POSIX does not specify fflush behavior for non-seekable input
 127      streams.  Some implementations purge unread data, some return
 128      EBADF, some do nothing.  */
 129   pos = ftello (stream);
 130   if (pos == -1)
 131     {
 132       errno = EBADF;
 133       return EOF;
 134     }
 135
 136   /* To get here, we must be flushing a seekable input stream, so the
 137      semantics of fpurge are now appropriate to clear the buffer.  To
 138      avoid losing data, the lseek is also necessary.  */
 139   result = fpurge (stream);
 140   if (result != 0)
 141     return result;
 142
 143 #if (defined __sferror || defined __DragonFly__) && defined __SNPT /* FreeBSD, NetBSD, OpenBSD, DragonFly, MacOS X, Cygwin */
 144
 145   {
 146     /* Disable seek optimization for the next fseeko call.  This tells the
 147        following fseeko call to seek to the desired position directly, rather
 148        than to seek to a block-aligned boundary.  */
 149     int saved_flags = disable_seek_optimization (stream);
 150
 151     result = fseeko (stream, pos, SEEK_SET);
 152
 153     restore_seek_optimization (stream, saved_flags);
 154   }
 155   return result;
 156
 157 #else
 158
 159   pos = lseek (fileno (stream), pos, SEEK_SET);
 160   if (pos == -1)
 161     return EOF;
 162   /* After a successful lseek, update the file descriptor's position cache
 163      in the stream.  */
 164   update_fpos_cache (stream);
 165
 166   return 0;
 167
 168 #endif
 169 }