closeout.c

Absolute File Name:

/home/opencoverage/opencoverage/guest-scripts/coreutils/src/gnulib/lib/closeout.c

Line

Source

Count

/* Close standard output and standard error, exiting with a diagnostic on error.

Inc.

This program is free software: you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation; either version 3 of the License, or

(at your option) any later version.

This program is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

GNU General Public License for more details.

You should have received a copy of the GNU General Public License

along with this program. If not, see <https://www.gnu.org/licenses/>. */

#include <config.h>

#include "closeout.h"

#include <errno.h>

#include <stdbool.h>

#include <stdio.h>

#include <unistd.h>

#include "gettext.h"

#define _(msgid) gettext (msgid)

#include "close-stream.h"

#include "error.h"

#include "exitfail.h"

#include "quotearg.h"

#ifndef __has_feature

# define __has_feature(a) false

#endif

#if defined __SANITIZE_ADDRESS__ || __has_feature (address_sanitizer)

enum { SANITIZE_ADDRESS = true };

#else

enum { SANITIZE_ADDRESS = false };

#endif

static const char *file_name;

/* Set the file name to be reported in the event an error is detected

by close_stdout. */

void

close_stdout_set_file_name (const char *file)

{

file_name = file;

}

never executed: end of block

static bool ignore_EPIPE /* = false */;

/* Specify the reaction to an EPIPE error during the closing of stdout:

- If ignore = true, it shall be ignored.

- If ignore = false, it shall evoke a diagnostic, along with a nonzero

exit status.

The default is ignore = false.

This setting matters only if the SIGPIPE signal is ignored (i.e. its

handler set to SIG_IGN) or blocked. Only particular programs need to

temporarily ignore SIGPIPE. If SIGPIPE is ignored or blocked because

it was ignored or blocked in the parent process when it created the

child process, it usually is a bug in the parent process: It is bad

practice to have SIGPIPE ignored or blocked while creating a child

process.

EPIPE occurs when writing to a pipe or socket that has no readers now,

when SIGPIPE is ignored or blocked.

The ignore = false setting is suitable for a scenario where it is normally

guaranteed that the pipe writer terminates before the pipe reader. In

this case, an EPIPE is an indication of a premature termination of the

pipe reader and should lead to a diagnostic and a nonzero exit status.

The ignore = true setting is suitable for a scenario where you don't know

ahead of time whether the pipe writer or the pipe reader will terminate

first. In this case, an EPIPE is an indication that the pipe writer can

stop doing useless write() calls; this is what close_stdout does anyway.

EPIPE is part of the normal pipe/socket shutdown protocol in this case,

and should not lead to a diagnostic message. */

void

close_stdout_set_ignore_EPIPE (bool ignore)

{

ignore_EPIPE = ignore;

}

never executed: end of block

/* Close standard output. On error, issue a diagnostic and _exit

with status 'exit_failure'.

Also close standard error. On error, _exit with status 'exit_failure'.

Since close_stdout is commonly registered via 'atexit', POSIX

and the C standard both say that it should not call 'exit',

100

because the behavior is undefined if 'exit' is called more than

101

once. So it calls '_exit' instead of 'exit'. If close_stdout

102

is registered via atexit before other functions are registered,

103

the other functions can act before this _exit is invoked.

104

105

Applications that use close_stdout should flush any streams

106

other than stdout and stderr before exiting, since the call to

107

_exit will bypass other buffer flushing. Applications should

108

be flushing and closing other streams anyway, to check for I/O

109

errors. Also, applications should not use tmpfile, since _exit

110

can bypass the removal of these files.

111

112

It's important to detect such failures and exit nonzero because many

113

tools (most notably 'make' and other build-management systems) depend

114

on being able to detect failure in other tools via their exit status. */

void

close_stdout (void)

{

if (close_stream (stdout) != 0

close_stream ( stdout ) != 0	Description
TRUE	never evaluated
FALSE	evaluated 37190 times by 106 tests Evaluated by: [ b2sum base32 base64 basename cat chcon chgrp chmod chown chroot cksum comm cp csplit cut date dd df dir dircolors dirname du echo env ...

0-37190

120

&& !(ignore_EPIPE && errno == EPIPE))

ignore_EPIPE	Description
TRUE	never evaluated
FALSE	never evaluated

(*__errno_location ()) == 32	Description
TRUE	never evaluated
FALSE	never evaluated

121

{

122

char const *write_error = _("write error");

123

if (file_name)

file_name	Description
TRUE	never evaluated
FALSE	never evaluated

124

error (0, errno, "%s: %s", quotearg_colon (file_name),

never executed: error (0, (*__errno_location ()) , "%s: %s", quotearg_colon (file_name), write_error);

125

write_error);

never executed: error (0, (*__errno_location ()) , "%s: %s", quotearg_colon (file_name), write_error);

126

else

127

error (0, errno, "%s", write_error);

never executed: error (0, (*__errno_location ()) , "%s", write_error);

128

129

_exit (exit_failure);

130

}

never executed: end of block

131

132

/* Close stderr only if not sanitizing, as sanitizers may report to

133

stderr after this function returns. */

134

if (!SANITIZE_ADDRESS && close_stream (stderr) != 0)

!SANITIZE_ADDRESS	Description
TRUE	evaluated 37190 times by 106 tests Evaluated by: [ b2sum base32 base64 basename cat chcon chgrp chmod chown chroot cksum comm cp csplit cut date dd df dir dircolors dirname du echo env ...
FALSE	never evaluated

close_stream ( stderr ) != 0	Description
TRUE	never evaluated
FALSE	evaluated 37190 times by 106 tests Evaluated by: [ b2sum base32 base64 basename cat chcon chgrp chmod chown chroot cksum comm cp csplit cut date dd df dir dircolors dirname du echo env ...

0-37190

135

_exit (exit_failure);

never executed: _exit (exit_failure);

136

}

executed 37190 times by 106 tests: end of block

Executed by:

[
b2sum
base32
base64
basename
cat
chcon
chgrp
chmod
chown
chroot
cksum
comm
cp
csplit
cut
date
dd
df
dir
dircolors
dirname
du
echo
env
...

37190

Generated by Squish Coco 4.1.2