lib/fwriteerror.c

   1 /* Detect write error on a stream.
   2    Copyright (C) 2003-2006 Free Software Foundation, Inc.
   3    Written by Bruno Haible <bruno@clisp.org>, 2003.
   4
   5    This program is free software; you can redistribute it and/or modify
   6    it under the terms of the GNU General Public License as published by
   7    the Free Software Foundation; either version 2, or (at your option)
   8    any later version.
   9
  10    This program is distributed in the hope that it will be useful,
  11    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13    GNU General Public License for more details.
  14
  15    You should have received a copy of the GNU General Public License
  16    along with this program; if not, write to the Free Software Foundation,
  17    Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
  18
  19 #ifdef HAVE_CONFIG_H
  20 # include <config.h>
  21 #endif
  22
  23 /* Specification.  */
  24 #include "fwriteerror.h"
  25
  26 #include <errno.h>
  27 #include <stdbool.h>
  28
  29 int
  30 fwriteerror (FILE *fp)
  31 {
  32   /* State to allow multiple calls to fwriteerror (stdout).  */
  33   static bool stdout_closed = false;
  34
  35   if (fp == stdout && stdout_closed)
  36     return 0;
  37
  38   /* Need to
  39      1. test the error indicator of the stream,
  40      2. flush the buffers both in userland and in the kernel, through fclose,
  41         testing for error again.  */
  42
  43   /* Clear errno, so that on non-POSIX systems the caller doesn't see a
  44      wrong value of errno when we return -1.  */
  45   errno = 0;
  46
  47   if (ferror (fp))
  48     {
  49       if (fflush (fp))
  50         goto close_preserving_errno; /* errno is set here */
  51       /* The stream had an error earlier, but its errno was lost.  If the
  52          error was not temporary, we can get the same errno by writing and
  53          flushing one more byte.  We can do so because at this point the
  54          stream's contents is garbage anyway.  */
  55       if (fputc ('\0', fp) == EOF)
  56         goto close_preserving_errno; /* errno is set here */
  57       if (fflush (fp))
  58         goto close_preserving_errno; /* errno is set here */
  59       /* Give up on errno.  */
  60       errno = 0;
  61      close_preserving_errno:
  62       /* There's an error.  Nevertheless call fclose(fp), for consistency
  63          with the other cases.  */
  64       {
  65         int saved_errno = errno;
  66         fclose (fp);
  67         errno = saved_errno;
  68         return -1;
  69       }
  70     }
  71
  72   /* If we are closing stdout, don't attempt to do it later again.  */
  73   if (fp == stdout)
  74     stdout_closed = true;
  75
  76   if (fclose (fp))
  77     return -1; /* errno is set here */
  78
  79   return 0;
  80 }
  81
  82
  83 #if TEST
  84
  85 /* Name of a file on which writing fails.  On systems without /dev/full,
  86    you can choose a filename on a full filesystem.  */
  87 #define UNWRITABLE_FILE "/dev/full"
  88
  89 int
  90 main ()
  91 {
  92   static int sizes[] =
  93     {
  94        511,  512,  513,
  95       1023, 1024, 1025,
  96       2047, 2048, 2049,
  97       4095, 4096, 4097,
  98       8191, 8192, 8193
  99     };
 100   static char dummy[8193];
 101   unsigned int i, j;
 102
 103   for (i = 0; i < sizeof (sizes) / sizeof (sizes[0]); i++)
 104     {
 105       size_t size = sizes[i];
 106
 107       for (j = 0; j < 2; j++)
 108         {
 109           /* Run a test depending on i and j:
 110              Write size bytes and then calls fflush if j==1.  */
 111           FILE *stream = fopen (UNWRITABLE_FILE, "w");
 112
 113           if (stream == NULL)
 114             {
 115               fprintf (stderr, "Test %u:%u: could not open file\n", i, j);
 116               continue;
 117             }
 118
 119           fwrite (dummy, 347, 1, stream);
 120           fwrite (dummy, size - 347, 1, stream);
 121           if (j)
 122             fflush (stream);
 123
 124           if (fwriteerror (stream) == -1)
 125             {
 126               if (errno != ENOSPC)
 127                 fprintf (stderr, "Test %u:%u: fwriteerror ok, errno = %d\n",
 128                          i, j, errno);
 129             }
 130           else
 131             fprintf (stderr, "Test %u:%u: fwriteerror found no error!\n",
 132                      i, j);
 133         }
 134     }
 135
 136   return 0;
 137 }
 138
 139 #endif