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 #include <config.h>
  20
  21 /* Specification.  */
  22 #include "fwriteerror.h"
  23
  24 #include <errno.h>
  25 #include <stdbool.h>
  26
  27 static int
  28 do_fwriteerror (FILE *fp, bool ignore_ebadf)
  29 {
  30   /* State to allow multiple calls to fwriteerror (stdout).  */
  31   static bool stdout_closed = false;
  32
  33   if (fp == stdout)
  34     {
  35       if (stdout_closed)
  36         return 0;
  37
  38       /* If we are closing stdout, don't attempt to do it later again.  */
  39       stdout_closed = true;
  40     }
  41
  42   /* Need to
  43      1. test the error indicator of the stream,
  44      2. flush the buffers both in userland and in the kernel, through fclose,
  45         testing for error again.  */
  46
  47   /* Clear errno, so that on non-POSIX systems the caller doesn't see a
  48      wrong value of errno when we return -1.  */
  49   errno = 0;
  50
  51   if (ferror (fp))
  52     {
  53       if (fflush (fp))
  54         goto close_preserving_errno; /* errno is set here */
  55       /* The stream had an error earlier, but its errno was lost.  If the
  56          error was not temporary, we can get the same errno by writing and
  57          flushing one more byte.  We can do so because at this point the
  58          stream's contents is garbage anyway.  */
  59       if (fputc ('\0', fp) == EOF)
  60         goto close_preserving_errno; /* errno is set here */
  61       if (fflush (fp))
  62         goto close_preserving_errno; /* errno is set here */
  63       /* Give up on errno.  */
  64       errno = 0;
  65       goto close_preserving_errno;
  66     }
  67
  68   if (ignore_ebadf)
  69     {
  70       /* We need an explicit fflush to tell whether some output was already
  71          done on FP.  */
  72       if (fflush (fp))
  73         goto close_preserving_errno; /* errno is set here */
  74       if (fclose (fp) && errno != EBADF)
  75         return -1; /* errno is set here */
  76     }
  77   else
  78     {
  79       if (fclose (fp))
  80         return -1; /* errno is set here */
  81     }
  82
  83   return 0;
  84
  85  close_preserving_errno:
  86   /* There's an error.  Nevertheless call fclose(fp), for consistency
  87      with the other cases.  */
  88   {
  89     int saved_errno = errno;
  90     fclose (fp);
  91     errno = saved_errno;
  92     return -1;
  93   }
  94 }
  95
  96 int
  97 fwriteerror (FILE *fp)
  98 {
  99   return do_fwriteerror (fp, false);
 100 }
 101
 102 int
 103 fwriteerror_no_ebadf (FILE *fp)
 104 {
 105   return do_fwriteerror (fp, true);
 106 }
 107
 108
 109 #if TEST
 110
 111 /* Name of a file on which writing fails.  On systems without /dev/full,
 112    you can choose a filename on a full filesystem.  */
 113 #define UNWRITABLE_FILE "/dev/full"
 114
 115 int
 116 main ()
 117 {
 118   static int sizes[] =
 119     {
 120        511,  512,  513,
 121       1023, 1024, 1025,
 122       2047, 2048, 2049,
 123       4095, 4096, 4097,
 124       8191, 8192, 8193
 125     };
 126   static char dummy[8193];
 127   unsigned int i, j;
 128
 129   for (i = 0; i < sizeof (sizes) / sizeof (sizes[0]); i++)
 130     {
 131       size_t size = sizes[i];
 132
 133       for (j = 0; j < 2; j++)
 134         {
 135           /* Run a test depending on i and j:
 136              Write size bytes and then calls fflush if j==1.  */
 137           FILE *stream = fopen (UNWRITABLE_FILE, "w");
 138
 139           if (stream == NULL)
 140             {
 141               fprintf (stderr, "Test %u:%u: could not open file\n", i, j);
 142               continue;
 143             }
 144
 145           fwrite (dummy, 347, 1, stream);
 146           fwrite (dummy, size - 347, 1, stream);
 147           if (j)
 148             fflush (stream);
 149
 150           if (fwriteerror (stream) == -1)
 151             {
 152               if (errno != ENOSPC)
 153                 fprintf (stderr, "Test %u:%u: fwriteerror ok, errno = %d\n",
 154                          i, j, errno);
 155             }
 156           else
 157             fprintf (stderr, "Test %u:%u: fwriteerror found no error!\n",
 158                      i, j);
 159         }
 160     }
 161
 162   return 0;
 163 }
 164
 165 #endif