1
/* closeout.c - close standard output
3
Copyright (C) 1998, 1999, 2000, 2001, 2002, 2004 Free Software
6
This program is free software; you can redistribute it and/or modify
7
it under the terms of the GNU General Public License as published by
8
the Free Software Foundation; either version 2, or (at your option)
11
This program is distributed in the hope that it will be useful,
12
but WITHOUT ANY WARRANTY; without even the implied warranty of
13
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14
GNU General Public License for more details.
16
You should have received a copy of the GNU General Public License
17
along with this program; if not, write to the Free Software Foundation,
18
Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */
31
#define _(msgid) gettext (msgid)
36
#include "__fpending.h"
39
# include "unlocked-io.h"
42
static const char *file_name;
44
/* Set the file name to be reported in the event an error is detected
47
close_stdout_set_file_name (const char *file)
52
/* Close standard output, exiting with status 'exit_failure' on failure.
53
If a program writes *anything* to stdout, that program should close
54
stdout and make sure that it succeeds before exiting. Otherwise,
55
suppose that you go to the extreme of checking the return status
56
of every function that does an explicit write to stdout. The last
57
printf can succeed in writing to the internal stream buffer, and yet
58
the fclose(stdout) could still fail (due e.g., to a disk full error)
59
when it tries to write out that buffered data. Thus, you would be
60
left with an incomplete output file and the offending program would
61
exit successfully. Even calling fflush is not always sufficient,
62
since some file systems (NFS and CODA) buffer written/flushed data
63
until an actual close call.
65
Besides, it's wasteful to check the return value from every call
66
that writes to stdout -- just let the internal stream state record
67
the failure. That's what the ferror test is checking below.
69
It's important to detect such failures and exit nonzero because many
70
tools (most notably `make' and other build-management systems) depend
71
on being able to detect failure in other tools via their exit status. */
76
bool prev_fail = ferror (stdout);
77
bool none_pending = (0 == __fpending (stdout));
78
bool fclose_fail = fclose (stdout);
80
if (prev_fail || fclose_fail)
82
int e = fclose_fail ? errno : 0;
83
char const *write_error;
85
/* If ferror returned zero, no data remains to be flushed, and we'd
86
otherwise fail with EBADF due to a failed fclose, then assume that
87
it's ok to ignore the fclose failure. That can happen when a
88
program like cp is invoked like this `cp a b >&-' (i.e., with
89
stdout closed) and doesn't generate any output (hence no previous
90
error and nothing to be flushed). */
91
if (e == EBADF && !prev_fail && none_pending)
94
write_error = _("write error");
96
error (exit_failure, e, "%s: %s", quotearg_colon (file_name),
99
error (exit_failure, e, "%s", write_error);