icinga2/lib/base/application.cpp

921 lines
21 KiB
C++

/******************************************************************************
* Icinga 2 *
* Copyright (C) 2012-2014 Icinga Development Team (http://www.icinga.org) *
* *
* 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 2 *
* 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, write to the Free Software Foundation *
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. *
******************************************************************************/
#include "base/application.h"
#include "base/stacktrace.h"
#include "base/timer.h"
#include "base/logger_fwd.h"
#include "base/exception.h"
#include "base/objectlock.h"
#include "base/utility.h"
#include "base/debug.h"
#include "base/type.h"
#include "base/convert.h"
#include "base/scriptvariable.h"
#include "icinga-version.h"
#include <sstream>
#include <boost/algorithm/string/classification.hpp>
#include <boost/thread/thread.hpp>
#include <boost/bind.hpp>
#include <boost/make_shared.hpp>
#include <boost/foreach.hpp>
#include <boost/algorithm/string/split.hpp>
#include <boost/exception/errinfo_api_function.hpp>
#include <boost/exception/errinfo_errno.hpp>
#include <boost/exception/errinfo_file_name.hpp>
#include <iostream>
using namespace icinga;
REGISTER_TYPE(Application);
Application *Application::m_Instance = NULL;
bool Application::m_ShuttingDown = false;
bool Application::m_RequestRestart = false;
bool Application::m_Restarting = false;
bool Application::m_Debugging = false;
int Application::m_ArgC;
char **Application::m_ArgV;
double Application::m_StartTime;
/**
* Constructor for the Application class.
*/
void Application::OnConfigLoaded(void)
{
m_PidFile = NULL;
#ifdef _WIN32
/* disable GUI-based error messages for LoadLibrary() */
SetErrorMode(SEM_FAILCRITICALERRORS);
WSADATA wsaData;
if (WSAStartup(MAKEWORD(1, 1), &wsaData) != 0) {
BOOST_THROW_EXCEPTION(win32_error()
<< boost::errinfo_api_function("WSAStartup")
<< errinfo_win32_error(WSAGetLastError()));
}
#endif /* _WIN32 */
#ifdef _WIN32
if (IsDebuggerPresent())
m_Debugging = true;
#endif /* _WIN32 */
ASSERT(m_Instance == NULL);
m_Instance = this;
}
/**
* Destructor for the application class.
*/
void Application::Stop(void)
{
m_ShuttingDown = true;
#ifdef _WIN32
WSACleanup();
#endif /* _WIN32 */
ClosePidFile();
DynamicObject::Stop();
}
Application::~Application(void)
{
m_Instance = NULL;
}
void Application::InitializeBase(void)
{
Utility::ExecuteDeferredInitializers();
}
/**
* Retrieves a pointer to the application singleton object.
*
* @returns The application object.
*/
Application::Ptr Application::GetInstance(void)
{
if (!m_Instance)
return Application::Ptr();
return m_Instance->GetSelf();
}
void Application::SetResourceLimits(void)
{
#ifndef _WIN32
rlimit rl;
# ifdef RLIMIT_NOFILE
rl.rlim_cur = 16 * 1024;
rl.rlim_max = rl.rlim_cur;
if (setrlimit(RLIMIT_NOFILE, &rl) < 0)
Log(LogDebug, "base", "Could not adjust resource limit for open file handles (RLIMIT_NOFILE)");
# else /* RLIMIT_NOFILE */
Log(LogDebug, "base", "System does not support adjusting the resource limit for open file handles (RLIMIT_NOFILE)");
# endif /* RLIMIT_NOFILE */
# ifdef RLIMIT_NPROC
rl.rlim_cur = 16 * 1024;
rl.rlim_max = rl.rlim_cur;
if (setrlimit(RLIMIT_NPROC, &rl) < 0)
Log(LogDebug, "base", "Could not adjust resource limit for number of processes (RLIMIT_NPROC)");
# else /* RLIMIT_NPROC */
Log(LogDebug, "base", "System does not support adjusting the resource limit for number of processes (RLIMIT_NPROC)");
# endif /* RLIMIT_NPROC */
# ifdef RLIMIT_STACK
int argc = Application::GetArgC();
char **argv = Application::GetArgV();
bool set_stack_rlimit = true;
for (int i = 0; i < argc; i++) {
if (strcmp(argv[i], "--no-stack-rlimit") == 0) {
set_stack_rlimit = false;
break;
}
}
if (set_stack_rlimit) {
rl.rlim_cur = 256 * 1024;
rl.rlim_max = rl.rlim_cur;
if (setrlimit(RLIMIT_STACK, &rl) < 0)
Log(LogDebug, "base", "Could not adjust resource limit for stack size (RLIMIT_STACK)");
else {
char **new_argv = static_cast<char **>(malloc(sizeof(char *) * (argc + 2)));
if (!new_argv) {
perror("malloc");
exit(1);
}
for (int i = 0; i < argc; i++)
new_argv[i] = argv[i];
new_argv[argc] = strdup("--no-stack-rlimit");
if (!new_argv[argc]) {
perror("strdup");
exit(1);
}
new_argv[argc + 1] = NULL;
if (execvp(new_argv[0], new_argv) < 0)
perror("execvp");
exit(1);
}
}
# else /* RLIMIT_STACK */
Log(LogDebug, "base", "System does not support adjusting the resource limit for stack size (RLIMIT_STACK)");
# endif /* RLIMIT_STACK */
#endif /* _WIN32 */
}
int Application::GetArgC(void)
{
return m_ArgC;
}
void Application::SetArgC(int argc)
{
m_ArgC = argc;
}
char **Application::GetArgV(void)
{
return m_ArgV;
}
void Application::SetArgV(char **argv)
{
m_ArgV = argv;
}
/**
* Processes events for registered sockets and timers and calls whatever
* handlers have been set up for these events.
*/
void Application::RunEventLoop(void) const
{
Timer::Initialize();
double lastLoop = Utility::GetTime();
mainloop:
while (!m_ShuttingDown && !m_RequestRestart) {
/* Watches for changes to the system time. Adjusts timers if necessary. */
Utility::Sleep(2.5);
double now = Utility::GetTime();
double timeDiff = lastLoop - now;
if (abs(timeDiff) > 15) {
/* We made a significant jump in time. */
std::ostringstream msgbuf;
msgbuf << "We jumped "
<< (timeDiff < 0 ? "forward" : "backward")
<< " in time: " << abs(timeDiff) << " seconds";
Log(LogInformation, "base", msgbuf.str());
Timer::AdjustTimers(-timeDiff);
}
lastLoop = now;
}
if (m_RequestRestart) {
m_RequestRestart = false; // we are now handling the request, once is enough
// are we already restarting? ignore request if we already are
if (m_Restarting)
goto mainloop;
m_Restarting = true;
StartReloadProcess();
goto mainloop;
}
Log(LogInformation, "base", "Shutting down Icinga...");
DynamicObject::StopObjects();
Application::GetInstance()->OnShutdown();
#ifdef _DEBUG
GetTP().Stop();
m_ShuttingDown = false;
GetTP().Join(true);
Timer::Uninitialize();
#endif /* _DEBUG */
}
void Application::OnShutdown(void)
{
/* Nothing to do here. */
}
void Application::StartReloadProcess(void) const
{
Log(LogInformation, "base", "Got reload command: Starting new instance.");
// prepare arguments
Array::Ptr args = make_shared<Array>();
args->Add(GetExePath(m_ArgV[0]));
for (int i=1; i < Application::GetArgC(); i++) {
if (std::string(Application::GetArgV()[i]) != "--reload-internal")
args->Add(Application::GetArgV()[i]);
else
i++; // the next parameter after --reload-internal is the pid, remove that too
}
args->Add("--reload-internal");
args->Add(Convert::ToString(Utility::GetPid()));
Process::Ptr process = make_shared<Process>(Process::PrepareCommand(args));
process->SetTimeout(300);
process->Run(boost::bind(&Application::ReloadProcessCallback, _1));
}
void Application::ReloadProcessCallback(const ProcessResult& pr)
{
if (pr.ExitStatus != 0)
Log(LogCritical, "base", "Found error in config: reloading aborted");
m_Restarting=false;
}
/**
* Signals the application to shut down during the next
* execution of the event loop.
*/
void Application::RequestShutdown(void)
{
m_ShuttingDown = true;
}
/**
* Signals the application to restart during the next
* execution of the event loop.
*/
void Application::RequestRestart(void)
{
m_RequestRestart = true;
}
/**
* Retrieves the full path of the executable.
*
* @param argv0 The first command-line argument.
* @returns The path.
*/
String Application::GetExePath(const String& argv0)
{
String executablePath;
#ifndef _WIN32
char buffer[MAXPATHLEN];
if (getcwd(buffer, sizeof(buffer)) == NULL) {
BOOST_THROW_EXCEPTION(posix_error()
<< boost::errinfo_api_function("getcwd")
<< boost::errinfo_errno(errno));
}
String workingDirectory = buffer;
if (argv0[0] != '/')
executablePath = workingDirectory + "/" + argv0;
else
executablePath = argv0;
bool foundSlash = false;
for (size_t i = 0; i < argv0.GetLength(); i++) {
if (argv0[i] == '/') {
foundSlash = true;
break;
}
}
if (!foundSlash) {
const char *pathEnv = getenv("PATH");
if (pathEnv != NULL) {
std::vector<String> paths;
boost::algorithm::split(paths, pathEnv, boost::is_any_of(":"));
bool foundPath = false;
BOOST_FOREACH(String& path, paths) {
String pathTest = path + "/" + argv0;
if (access(pathTest.CStr(), X_OK) == 0) {
executablePath = pathTest;
foundPath = true;
break;
}
}
if (!foundPath) {
executablePath.Clear();
BOOST_THROW_EXCEPTION(std::runtime_error("Could not determine executable path."));
}
}
}
if (realpath(executablePath.CStr(), buffer) == NULL) {
BOOST_THROW_EXCEPTION(posix_error()
<< boost::errinfo_api_function("realpath")
<< boost::errinfo_errno(errno)
<< boost::errinfo_file_name(executablePath));
}
return buffer;
#else /* _WIN32 */
char FullExePath[MAXPATHLEN];
if (!GetModuleFileName(NULL, FullExePath, sizeof(FullExePath)))
BOOST_THROW_EXCEPTION(win32_error()
<< boost::errinfo_api_function("GetModuleFileName")
<< errinfo_win32_error(GetLastError()));
return FullExePath;
#endif /* _WIN32 */
}
/**
* Sets whether debugging is enabled.
*
* @param debug Whether to enable debugging.
*/
void Application::SetDebugging(bool debug)
{
m_Debugging = debug;
}
/**
* Retrieves the debugging mode of the application.
*
* @returns true if the application is being debugged, false otherwise
*/
bool Application::IsDebugging(void)
{
return m_Debugging;
}
/**
* Display version information.
*/
void Application::DisplayVersionMessage(void)
{
std::cerr << "***" << std::endl
<< "* Application version: " << GetVersion() << std::endl
<< "* Installation root: " << GetPrefixDir() << std::endl
<< "* Sysconf directory: " << GetSysconfDir() << std::endl
<< "* Local state directory: " << GetLocalStateDir() << std::endl
<< "* Package data directory: " << GetPkgDataDir() << std::endl
<< "* State path: " << GetStatePath() << std::endl
<< "* PID path: " << GetPidPath() << std::endl
<< "* Application type: " << GetApplicationType() << std::endl
<< "***" << std::endl;
}
/**
* Displays a message that tells users what to do when they encounter a bug.
*/
void Application::DisplayBugMessage(void)
{
std::cerr << "***" << std::endl
<< "* This would indicate a runtime problem or configuration error. If you believe this is a bug in Icinga 2" << std::endl
<< "* please submit a bug report at https://dev.icinga.org/ and include this stack trace as well as any other" << std::endl
<< "* information that might be useful in order to reproduce this problem." << std::endl
<< "***" << std::endl;
}
#ifndef _WIN32
/**
* Signal handler for SIGINT and SIGTERM. Prepares the application for cleanly
* shutting down during the next execution of the event loop.
*
* @param - The signal number.
*/
void Application::SigIntTermHandler(int signum)
{
struct sigaction sa;
memset(&sa, 0, sizeof(sa));
sa.sa_handler = SIG_DFL;
sigaction(signum, &sa, NULL);
Application::Ptr instance = Application::GetInstance();
if (!instance)
return;
instance->RequestShutdown();
}
/**
* Signal handler for SIGABRT. Helps with debugging ASSERT()s.
*
* @param - The signal number.
*/
void Application::SigAbrtHandler(int)
{
#ifndef _WIN32
struct sigaction sa;
memset(&sa, 0, sizeof(sa));
sa.sa_handler = SIG_DFL;
sigaction(SIGABRT, &sa, NULL);
#endif /* _WIN32 */
std::cerr << "Caught SIGABRT." << std::endl
<< "Current time: " << Utility::FormatDateTime("%Y-%m-%d %H:%M:%S %z", Utility::GetTime()) << std::endl
<< std::endl;
DisplayVersionMessage();
StackTrace trace;
std::cerr << "Stacktrace:" << std::endl;
trace.Print(std::cerr, 1);
DisplayBugMessage();
}
#else /* _WIN32 */
/**
* Console control handler. Prepares the application for cleanly
* shutting down during the next execution of the event loop.
*/
BOOL WINAPI Application::CtrlHandler(DWORD type)
{
Application::Ptr instance = Application::GetInstance();
if (!instance)
return TRUE;
instance->RequestShutdown();
SetConsoleCtrlHandler(NULL, FALSE);
return TRUE;
}
#endif /* _WIN32 */
/**
* Handler for unhandled exceptions.
*/
void Application::ExceptionHandler(void)
{
#ifndef _WIN32
struct sigaction sa;
memset(&sa, 0, sizeof(sa));
sa.sa_handler = SIG_DFL;
sigaction(SIGABRT, &sa, NULL);
#endif /* _WIN32 */
std::cerr << "Caught unhandled exception." << std::endl
<< "Current time: " << Utility::FormatDateTime("%Y-%m-%d %H:%M:%S %z", Utility::GetTime()) << std::endl
<< std::endl;
DisplayVersionMessage();
try {
RethrowUncaughtException();
} catch (const std::exception& ex) {
std::cerr << std::endl
<< DiagnosticInformation(ex)
<< std::endl;
}
DisplayBugMessage();
abort();
}
#ifdef _WIN32
LONG CALLBACK Application::SEHUnhandledExceptionFilter(PEXCEPTION_POINTERS exi)
{
DisplayVersionMessage();
std::cerr << "Caught unhandled SEH exception." << std::endl
<< "Current time: " << Utility::FormatDateTime("%Y-%m-%d %H:%M:%S %z", Utility::GetTime()) << std::endl
<< std::endl;
StackTrace trace(exi);
std::cerr << "Stacktrace:" << std::endl;
trace.Print(std::cerr, 1);
DisplayBugMessage();
return EXCEPTION_CONTINUE_SEARCH;
}
#endif /* _WIN32 */
/**
* Installs the exception handlers.
*/
void Application::InstallExceptionHandlers(void)
{
std::set_terminate(&Application::ExceptionHandler);
#ifndef _WIN32
struct sigaction sa;
memset(&sa, 0, sizeof(sa));
sa.sa_handler = &Application::SigAbrtHandler;
sigaction(SIGABRT, &sa, NULL);
#else /* _WIN32 */
SetUnhandledExceptionFilter(&Application::SEHUnhandledExceptionFilter);
#endif /* _WIN32 */
}
/**
* Runs the application.
*
* @returns The application's exit code.
*/
int Application::Run(void)
{
int result;
#ifndef _WIN32
struct sigaction sa;
memset(&sa, 0, sizeof(sa));
sa.sa_handler = &Application::SigIntTermHandler;
sigaction(SIGINT, &sa, NULL);
sigaction(SIGTERM, &sa, NULL);
sa.sa_handler = SIG_IGN;
sigaction(SIGPIPE, &sa, NULL);
#else /* _WIN32 */
SetConsoleCtrlHandler(&Application::CtrlHandler, TRUE);
#endif /* _WIN32 */
UpdatePidFile(GetPidPath());
result = Main();
return result;
}
/**
* Grabs the PID file lock and updates the PID. Terminates the application
* if the PID file is already locked by another instance of the application.
*
* @param filename The name of the PID file.
*/
void Application::UpdatePidFile(const String& filename)
{
ASSERT(!OwnsLock());
ObjectLock olock(this);
if (m_PidFile != NULL)
fclose(m_PidFile);
/* There's just no sane way of getting a file descriptor for a
* C++ ofstream which is why we're using FILEs here. */
m_PidFile = fopen(filename.CStr(), "r+");
if (m_PidFile == NULL)
m_PidFile = fopen(filename.CStr(), "w");
if (m_PidFile == NULL)
BOOST_THROW_EXCEPTION(std::runtime_error("Could not open PID file '" + filename + "'"));
#ifndef _WIN32
int fd = fileno(m_PidFile);
Utility::SetCloExec(fd);
struct flock lock;
lock.l_start = 0;
lock.l_len = 0;
lock.l_type = F_WRLCK;
lock.l_whence = SEEK_SET;
if (fcntl(fd, F_SETLK, &lock) < 0) {
Log(LogCritical, "base", "Could not lock PID file. Make sure that only one instance of the application is running.");
_exit(EXIT_FAILURE);
}
if (ftruncate(fd, 0) < 0) {
BOOST_THROW_EXCEPTION(posix_error()
<< boost::errinfo_api_function("ftruncate")
<< boost::errinfo_errno(errno));
}
#endif /* _WIN32 */
fprintf(m_PidFile, "%d\n", Utility::GetPid());
fflush(m_PidFile);
}
/**
* Closes the PID file. Does nothing if the PID file is not currently open.
*/
void Application::ClosePidFile(void)
{
ASSERT(!OwnsLock());
ObjectLock olock(this);
if (m_PidFile != NULL)
fclose(m_PidFile);
m_PidFile = NULL;
}
/**
* Checks if another process currently owns the pidfile and read it
*
* @param filename The name of the PID file.
* @returns 0: no process owning the pidfile, pid of the process otherwise
*/
pid_t Application::ReadPidFile(const String& filename)
{
FILE *pidfile = fopen(filename.CStr(), "r");
if (pidfile == NULL)
return 0;
#ifndef _WIN32
int fd = fileno(pidfile);
struct flock lock;
lock.l_start = 0;
lock.l_len = 0;
lock.l_type = F_WRLCK;
lock.l_whence = SEEK_SET;
if (fcntl(fd, F_GETLK, &lock) < 0) {
int error = errno;
fclose(pidfile);
BOOST_THROW_EXCEPTION(posix_error()
<< boost::errinfo_api_function("fcntl")
<< boost::errinfo_errno(error));
}
if (lock.l_type == F_UNLCK) {
// nobody has locked the file: no icinga running
fclose(pidfile);
return -1;
}
#endif /* _WIN32 */
pid_t runningpid;
int res = fscanf(pidfile, "%d", &runningpid);
fclose(pidfile);
// bogus result?
if (res != 1)
return 0;
#ifdef _WIN32
HANDLE hProcess = OpenProcess(0, FALSE, runningpid);
if (!hProcess)
return 0;
CloseHandle(hProcess);
#endif /* _WIN32 */
return runningpid;
}
/**
* Retrieves the path of the installation prefix.
*
* @returns The path.
*/
String Application::GetPrefixDir(void)
{
return ScriptVariable::Get("PrefixDir");
}
/**
* Sets the path for the installation prefix.
*
* @param path The new path.
*/
void Application::DeclarePrefixDir(const String& path)
{
ScriptVariable::Set("PrefixDir", path, false);
}
/**
* Retrives the path of the sysconf dir.
*
* @returns The path.
*/
String Application::GetSysconfDir(void)
{
return ScriptVariable::Get("SysconfDir");
}
/**
* Sets the path of the sysconf dir.
*
* @param path The new path.
*/
void Application::DeclareSysconfDir(const String& path)
{
ScriptVariable::Set("SysconfDir", path, false);
}
/**
* Retrieves the path for the local state dir.
*
* @returns The path.
*/
String Application::GetLocalStateDir(void)
{
return ScriptVariable::Get("LocalStateDir");
}
/**
* Sets the path for the local state dir.
*
* @param path The new path.
*/
void Application::DeclareLocalStateDir(const String& path)
{
ScriptVariable::Set("LocalStateDir", path, false);
}
/**
* Retrieves the path for the package data dir.
*
* @returns The path.
*/
String Application::GetPkgDataDir(void)
{
return ScriptVariable::Get("PkgDataDir");
}
/**
* Sets the path for the package data dir.
*
* @param path The new path.
*/
void Application::DeclarePkgDataDir(const String& path)
{
ScriptVariable::Set("PkgDataDir", path, false);
}
/**
* Retrieves the path for the state file.
*
* @returns The path.
*/
String Application::GetStatePath(void)
{
return ScriptVariable::Get("StatePath");
}
/**
* Sets the path for the state file.
*
* @param path The new path.
*/
void Application::DeclareStatePath(const String& path)
{
ScriptVariable::Set("StatePath", path, false);
}
/**
* Retrieves the path for the PID file.
*
* @returns The path.
*/
String Application::GetPidPath(void)
{
return ScriptVariable::Get("PidPath");
}
/**
* Sets the path for the PID file.
*
* @param path The new path.
*/
void Application::DeclarePidPath(const String& path)
{
ScriptVariable::Set("PidPath", path, false);
}
/**
* Retrieves the name of the Application type.
*
* @returns The name.
*/
String Application::GetApplicationType(void)
{
return ScriptVariable::Get("ApplicationType");
}
/**
* Sets the name of the Application type.
*
* @param path The new type name.
*/
void Application::DeclareApplicationType(const String& type)
{
ScriptVariable::Set("ApplicationType", type, false);
}
void Application::MakeVariablesConstant(void)
{
ScriptVariable::GetByName("PrefixDir")->SetConstant(true);
ScriptVariable::GetByName("SysconfDir")->SetConstant(true);
ScriptVariable::GetByName("LocalStateDir")->SetConstant(true);
ScriptVariable::GetByName("PkgDataDir")->SetConstant(true);
ScriptVariable::GetByName("StatePath")->SetConstant(false);
ScriptVariable::GetByName("PidPath")->SetConstant(false);
ScriptVariable::GetByName("ApplicationType")->SetConstant(true);
}
/**
* Returns the global thread pool.
*
* @returns The global thread pool.
*/
ThreadPool& Application::GetTP(void)
{
static ThreadPool tp;
return tp;
}
String Application::GetVersion(void)
{
return VERSION;
}
double Application::GetStartTime(void)
{
return m_StartTime;
}
void Application::SetStartTime(double ts)
{
m_StartTime = ts;
}