fclose: avoid double close race when possible
[gnulib.git] / lib / fclose.c
1 /* fclose replacement.
2    Copyright (C) 2008-2011 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 #include <config.h>
18
19 /* Specification.  */
20 #include <stdio.h>
21
22 #include <errno.h>
23 #include <unistd.h>
24
25 #include "freading.h"
26
27 /* Override fclose() to call the overridden fflush() or close().  */
28
29 int
30 rpl_fclose (FILE *fp)
31 #undef fclose
32 {
33   int saved_errno = 0;
34   int fd;
35   int result = 0;
36
37   /* Don't change behavior on memstreams.  */
38   fd = fileno (fp);
39   if (fd < 0)
40     return fclose (fp);
41
42   /* We only need to flush the file if it is not reading or if it is
43      seekable.  This only guarantees the file position of input files
44      if the fflush module is also in use.  */
45   if ((!freading (fp) || lseek (fileno (fp), 0, SEEK_CUR) != -1)
46       && fflush (fp))
47     saved_errno = errno;
48
49 #if WINDOWS_SOCKETS
50   /* There is a minor race where some other thread could open fd
51      between our close and fopen, but it is no worse than the race in
52      close_fd_maybe_socket.  */
53   if (close (fd) < 0 && saved_errno == 0)
54     saved_errno = errno;
55
56   fclose (fp); /* will fail with errno = EBADF, if we did not lose a race */
57
58   if (saved_errno != 0)
59     {
60       errno = saved_errno;
61       result = EOF;
62     }
63
64 #else /* !WINDOWS_SOCKETS */
65   /* No race here.  */
66   result = fclose (fp);
67
68 # if REPLACE_FCHDIR
69   if (result == 0)
70     unregister_shadow_fd (fd);
71 # endif
72 #endif /* !WINDOWS_SOCKETS */
73
74   return result;
75 }