587d160146
Certain parts of the code assume ShutdownRequested is set when relying on the Termination flag. This is because they serve as degrees not as independent flags. The Termination flag is basically a more impatient ShutdownRequested flag. It is used to forcefully and immediately terminate. It is not designed to be used independently from ShutdownRequested. This pair is a good candidate for unifying as a single enum. Change-Id: I8e3913a1959868197d8c5a059e89cbdbc6cef070 Signed-off-by: Ashod Nakashian <ashod.nakashian@collabora.co.uk>
104 lines
3 KiB
C++
104 lines
3 KiB
C++
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
|
|
/*
|
|
* 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/.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <atomic>
|
|
#include <mutex>
|
|
#include <signal.h>
|
|
|
|
namespace SigUtil
|
|
{
|
|
#ifndef IOS
|
|
/// Get the flag used to commence clean shutdown.
|
|
/// requestShutdown() is used to set the flag.
|
|
bool getShutdownRequestFlag();
|
|
|
|
/// Get the flag to stop pump loops forcefully.
|
|
/// If this returns true, getShutdownRequestFlag() must also return true.
|
|
bool getTerminationFlag();
|
|
/// Set the flag to stop pump loops forcefully and request shutting down.
|
|
void setTerminationFlag();
|
|
#if MOBILEAPP
|
|
/// Reset the flags to stop pump loops forcefully.
|
|
/// Only necessary in Mobile.
|
|
void resetTerminationFlags();
|
|
#endif
|
|
#else
|
|
// In the mobile apps we have no need to shut down the app.
|
|
inline constexpr bool getShutdownRequestFlag()
|
|
{
|
|
return false;
|
|
}
|
|
|
|
inline constexpr bool getTerminationFlag()
|
|
{
|
|
return false;
|
|
}
|
|
|
|
inline void setTerminationFlag()
|
|
{
|
|
}
|
|
#endif
|
|
|
|
extern "C" { typedef void (*GlobalDumpStateFn)(void); }
|
|
|
|
void checkDumpGlobalState(GlobalDumpStateFn dumpState);
|
|
|
|
typedef void (*UnoCommandsDumperFn)(void);
|
|
|
|
extern UnoCommandsDumperFn dumpUnoCommandsInfoFn;
|
|
|
|
void registerUnoCommandInfoHandler(UnoCommandsDumperFn dumpUnoCommandsInfo);
|
|
|
|
#if !MOBILEAPP
|
|
/// Wait for the signal handler, if any,
|
|
/// and prevent _Exit while collecting backtrace.
|
|
void waitSigHandlerTrap();
|
|
|
|
/// Returns the name of the signal.
|
|
const char* signalName(int signo);
|
|
|
|
/// Register a wakeup function when changing
|
|
|
|
/// Trap signals to cleanup and exit the process gracefully.
|
|
void setTerminationSignals();
|
|
|
|
/// Trap all fatal signals to assist debugging.
|
|
void setFatalSignals(const std::string &versionInfo);
|
|
|
|
/// Update version info
|
|
void setVersionInfo(const std::string &versionInfo);
|
|
|
|
/// Trap generally useful signals
|
|
void setUserSignals();
|
|
|
|
/// Trap to unpause the process
|
|
void setDebuggerSignal();
|
|
|
|
/// 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();
|
|
|
|
/// 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, const int signal = SIGKILL);
|
|
|
|
/// Dump a signal-safe back-trace
|
|
void dumpBacktrace();
|
|
|
|
#endif // !MOBILEAPP
|
|
|
|
} // end namespace SigUtil
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|