binutils-gdb/gdbsupport/scoped_ignore_signal.h
Pedro Alves 336b30e58a Don't call sigtimedwait for scoped_ignore_sigttou
Because SIGTTOU is sent to the whole process instead of to a specific
thread, consuming a pending SIGTTOU in the destructor of
scoped_ignore_sigttou could consume a SIGTTOU signal raised due to
actions done by some other thread.  Simply avoid sigtimedwait in
scoped_ignore_sigttou, thus plugging the race.  This works because we
know that when the thread writes to the terminal and the signal is
blocked, the kernel does not raise the signal at all.

Tested on GNU/Linux, Solaris 11 and FreeBSD.

gdb/ChangeLog:
yyyy-mm-dd  Pedro Alves  <pedro@palves.net>

	* scoped_ignore_signal.h (scoped_ignore_signal): Add
	ConsumePending template parameter.
	(scoped_ignore_signal::~scoped_ignore_signal): Skip calling
	sigtimedwait if ConsumePending is false.
	(scoped_ignore_sigpipe): Initialize with ConsumePending=true.
	* scoped_ignore_sigttou.h (scoped_ignore_sigttou)
	<m_ignore_signal>: Initialize with ConsumePending=false.

Change-Id: I92f754dbc45c45819dce2ce68b8c067d8d5c61b1
2021-06-17 19:39:08 +01:00

105 lines
2.9 KiB
C++

/* Support for ignoring signals.
Copyright (C) 2021 Free Software Foundation, Inc.
This file is part of GDB.
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 <http://www.gnu.org/licenses/>. */
#ifndef SCOPED_IGNORE_SIGNAL_H
#define SCOPED_IGNORE_SIGNAL_H
#include <signal.h>
/* RAII class used to ignore a signal in a scope. If sigprocmask is
supported, then the signal is only ignored by the calling thread.
Otherwise, the signal disposition is set to SIG_IGN, which affects
the whole process. If ConsumePending is true, the destructor
consumes a pending Sig. SIGPIPE for example is queued on the
thread even if blocked at the time the pipe is written to. SIGTTOU
OTOH is not raised at all if the thread writing to the terminal has
it blocked. Because SIGTTOU is sent to the whole process instead
of to a specific thread, consuming a pending SIGTTOU in the
destructor could consume a signal raised due to actions done by
some other thread. */
template <int Sig, bool ConsumePending>
class scoped_ignore_signal
{
public:
scoped_ignore_signal ()
{
#ifdef HAVE_SIGPROCMASK
sigset_t set, old_state;
sigemptyset (&set);
sigaddset (&set, Sig);
sigprocmask (SIG_BLOCK, &set, &old_state);
m_was_blocked = sigismember (&old_state, Sig);
#else
m_osig = signal (Sig, SIG_IGN);
#endif
}
~scoped_ignore_signal ()
{
#ifdef HAVE_SIGPROCMASK
if (!m_was_blocked)
{
sigset_t set;
const timespec zero_timeout = {};
sigemptyset (&set);
sigaddset (&set, Sig);
/* If we got a pending Sig signal, consume it before
unblocking. */
if (ConsumePending)
sigtimedwait (&set, nullptr, &zero_timeout);
sigprocmask (SIG_UNBLOCK, &set, nullptr);
}
#else
signal (Sig, m_osig);
#endif
}
DISABLE_COPY_AND_ASSIGN (scoped_ignore_signal);
private:
#ifdef HAVE_SIGPROCMASK
bool m_was_blocked;
#else
sighandler_t m_osig;
#endif
};
struct scoped_ignore_signal_nop
{
/* Note, these can't both be "= default", because otherwise the
compiler warns that variables of this type are not used. */
scoped_ignore_signal_nop ()
{}
~scoped_ignore_signal_nop ()
{}
DISABLE_COPY_AND_ASSIGN (scoped_ignore_signal_nop);
};
#ifdef SIGPIPE
using scoped_ignore_sigpipe = scoped_ignore_signal<SIGPIPE, true>;
#else
using scoped_ignore_sigpipe = scoped_ignore_signal_nop;
#endif
#endif /* SCOPED_IGNORE_SIGNAL_H */