libreoffice-online/common/SigUtil.hpp
Ashod Nakashian 88d5491108 wsd: allow shutting down during startup
During startup we wait for extended time until
a child process is up and running. In case this
takes a long time, or indeed if forking permanently
fails, we simply don't respond to shutdown requests.

This patch makes it possible to wait for about 20
seconds at a time for a child. This way on average
we will exit the process within about 10 seconds,
assuming we are blocked waiting for a child that
will never spawn.

Change-Id: I4409cbc60aa3c7bd30970d4638c820bc581b65ba
Signed-off-by: Ashod Nakashian <ashod.nakashian@collabora.co.uk>
(cherry picked from commit 6ed8b4bb1a6532d947a6bb00f936183767b54a80)
2021-10-06 12:28:06 -04:00

104 lines
2.9 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.
void setTerminationFlag();
#if MOBILEAPP
/// Reset the flag to stop pump loops forcefully.
/// Only necessary in Mobile.
void resetTerminationFlag();
#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: */