2016-11-14 07:58:04 -06:00
|
|
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
|
|
|
|
/*
|
|
|
|
* This file is part of the LibreOffice project.
|
|
|
|
*
|
|
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef INCLUDED_SIGNALUTIL_HPP
|
|
|
|
#define INCLUDED_SIGNALUTIL_HPP
|
|
|
|
|
|
|
|
#include <atomic>
|
|
|
|
#include <mutex>
|
|
|
|
|
2019-11-03 19:52:19 -06:00
|
|
|
#if MOBILEAPP
|
2018-10-15 08:01:15 -05:00
|
|
|
static constexpr bool ShutdownRequestFlag(false);
|
2019-11-03 19:52:19 -06:00
|
|
|
extern std::atomic<bool> MobileTerminationFlag;
|
2018-10-15 08:01:15 -05:00
|
|
|
#endif
|
2017-03-04 11:33:46 -06:00
|
|
|
|
2019-08-08 02:10:59 -05:00
|
|
|
namespace SigUtil
|
|
|
|
{
|
2019-11-03 19:52:19 -06:00
|
|
|
/// Get the flag used to commence clean shutdown.
|
|
|
|
/// requestShutdown() is used to set the flag.
|
|
|
|
bool getShutdownRequestFlag();
|
2017-03-03 15:18:55 -06:00
|
|
|
|
2019-11-03 19:52:19 -06:00
|
|
|
/// Get the flag to stop pump loops forcefully.
|
|
|
|
bool getTerminationFlag();
|
|
|
|
/// Set the flag to stop pump loops forcefully.
|
|
|
|
void setTerminationFlag();
|
2019-05-14 14:37:11 -05:00
|
|
|
#if MOBILEAPP
|
2019-11-03 19:52:19 -06:00
|
|
|
/// Reset the flag to stop pump loops forcefully.
|
|
|
|
/// Only necessary in Mobile.
|
|
|
|
void resetTerminationFlag();
|
2019-05-14 14:37:11 -05:00
|
|
|
#endif
|
|
|
|
|
2019-11-03 19:52:19 -06:00
|
|
|
/// Get the flag to dump internal state.
|
|
|
|
bool getDumpGlobalState();
|
|
|
|
/// Reset the flag to dump internal state.
|
|
|
|
void resetDumpGlobalState();
|
2018-10-15 08:01:15 -05:00
|
|
|
|
2019-11-03 19:52:19 -06:00
|
|
|
#if !MOBILEAPP
|
2019-11-18 08:12:30 -06:00
|
|
|
|
|
|
|
/// Wait for the signal handler, if any,
|
2019-08-13 02:08:16 -05:00
|
|
|
/// and prevent _Exit while collecting backtrace.
|
2019-11-18 08:12:30 -06:00
|
|
|
void waitSigHandlerTrap();
|
2019-08-13 02:08:16 -05:00
|
|
|
|
2016-11-14 07:58:04 -06:00
|
|
|
/// Returns the name of the signal.
|
|
|
|
const char* signalName(int signo);
|
|
|
|
|
2017-03-02 12:12:52 -06:00
|
|
|
/// Register a wakeup function when changing
|
|
|
|
|
2016-11-14 07:58:04 -06:00
|
|
|
/// Trap signals to cleanup and exit the process gracefully.
|
|
|
|
void setTerminationSignals();
|
|
|
|
|
|
|
|
/// Trap all fatal signals to assist debugging.
|
|
|
|
void setFatalSignals();
|
|
|
|
|
2017-03-03 15:18:55 -06:00
|
|
|
/// Trap generally useful signals
|
|
|
|
void setUserSignals();
|
|
|
|
|
2019-12-18 14:28:14 -06:00
|
|
|
/// Trap to unpause the process
|
|
|
|
void setDebuggerSignal();
|
|
|
|
|
2016-11-19 09:22:53 -06:00
|
|
|
/// Requests the server to initiate graceful shutdown.
|
|
|
|
/// Shutting down is a multi-stage process, because
|
|
|
|
/// it can be requested via signals.
|
|
|
|
/// Since we need to notify clients, we can't
|
|
|
|
/// invoke the sockets while in a signal handler.
|
|
|
|
/// This flags the server to notify clients first
|
|
|
|
/// then flags for shutdown.
|
|
|
|
void requestShutdown();
|
|
|
|
|
2016-11-14 07:58:04 -06:00
|
|
|
/// Kills a child process and returns true when
|
|
|
|
/// child pid is removed from the process table
|
|
|
|
/// after a certain (short) timeout.
|
|
|
|
bool killChild(const int pid);
|
|
|
|
|
2017-04-28 12:08:57 -05:00
|
|
|
/// Dump a signal-safe back-trace
|
|
|
|
void dumpBacktrace();
|
|
|
|
|
2018-10-15 08:01:15 -05:00
|
|
|
#endif // !MOBILEAPP
|
|
|
|
|
2019-11-18 08:12:30 -06:00
|
|
|
} // end namespace SigUtil
|
|
|
|
|
2016-11-14 07:58:04 -06:00
|
|
|
#endif
|
|
|
|
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|