icinga2/lib/base/application.hpp

204 lines
6.3 KiB
C++

/******************************************************************************
* Icinga 2 *
* Copyright (C) 2012-2016 Icinga Development Team (https://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. *
******************************************************************************/
#ifndef APPLICATION_H
#define APPLICATION_H
#include "base/i2-base.hpp"
#include "base/application.thpp"
#include "base/threadpool.hpp"
#include "base/utility.hpp"
#include "base/logger.hpp"
#include <ostream>
namespace icinga
{
/**
* Abstract base class for applications.
*
* @ingroup base
*/
class I2_BASE_API Application : public ObjectImpl<Application> {
public:
DECLARE_OBJECT(Application);
static boost::signals2::signal<void (void)> OnReopenLogs;
~Application(void);
static void InitializeBase(void);
static void UninitializeBase(void);
static Application::Ptr GetInstance(void);
static void Exit(int rc);
int Run(void);
/**
* Starts the application.
*
* @returns The exit code of the application.
*/
virtual int Main(void) = 0;
static void SetResourceLimits(void);
static int GetArgC(void);
static void SetArgC(int argc);
static char **GetArgV(void);
static void SetArgV(char **argv);
static void InstallExceptionHandlers(void);
static void RequestShutdown(void);
static void RequestRestart(void);
static void RequestReopenLogs(void);
static bool IsShuttingDown(void);
static void SetDebuggingSeverity(LogSeverity severity);
static LogSeverity GetDebuggingSeverity(void);
void UpdatePidFile(const String& filename, pid_t pid = Utility::GetPid());
void ClosePidFile(bool unlink);
static pid_t ReadPidFile(const String& filename);
static String GetExePath(const String& argv0);
static String GetPrefixDir(void);
static void DeclarePrefixDir(const String& path);
static String GetSysconfDir(void);
static void DeclareSysconfDir(const String& path);
static String GetZonesDir(void);
static void DeclareZonesDir(const String& path);
static String GetRunDir(void);
static void DeclareRunDir(const String& path);
static String GetLocalStateDir(void);
static void DeclareLocalStateDir(const String& path);
static String GetPkgDataDir(void);
static void DeclarePkgDataDir(const String& path);
static String GetIncludeConfDir(void);
static void DeclareIncludeConfDir(const String& path);
static String GetStatePath(void);
static void DeclareStatePath(const String& path);
static String GetModAttrPath(void);
static void DeclareModAttrPath(const String& path);
static String GetObjectsPath(void);
static void DeclareObjectsPath(const String& path);
static String GetVarsPath(void);
static void DeclareVarsPath(const String& path);
static String GetPidPath(void);
static void DeclarePidPath(const String& path);
static String GetRunAsUser(void);
static void DeclareRunAsUser(const String& user);
static String GetRunAsGroup(void);
static void DeclareRunAsGroup(const String& group);
static int GetConcurrency(void);
static void DeclareConcurrency(int ncpus);
static ThreadPool& GetTP(void);
static String GetAppVersion(void);
static String GetAppSpecVersion(void);
static double GetStartTime(void);
static void SetStartTime(double ts);
static double GetMainTime(void);
static void SetMainTime(double ts);
static bool GetScriptDebuggerEnabled(void);
static void SetScriptDebuggerEnabled(bool enabled);
static double GetLastReloadFailed(void);
static void SetLastReloadFailed(double ts);
static void DisplayInfoMessage(std::ostream& os, bool skipVersion = false);
protected:
virtual void OnConfigLoaded(void) override;
virtual void Stop(bool runtimeRemoved) override;
void RunEventLoop(void);
pid_t StartReloadProcess(void);
virtual void OnShutdown(void);
virtual void ValidateName(const String& value, const ValidationUtils& utils) override;
private:
static Application::Ptr m_Instance; /**< The application instance. */
static bool m_ShuttingDown; /**< Whether the application is in the process of
shutting down. */
static bool m_RequestRestart; /**< A restart was requested through SIGHUP */
static pid_t m_ReloadProcess; /**< The PID of a subprocess doing a reload,
only valid when l_Restarting==true */
static bool m_RequestReopenLogs; /**< Whether we should re-open log files. */
static int m_ArgC; /**< The number of command-line arguments. */
static char **m_ArgV; /**< Command-line arguments. */
FILE *m_PidFile; /**< The PID file */
static bool m_Debugging; /**< Whether debugging is enabled. */
static LogSeverity m_DebuggingSeverity; /**< Whether debugging severity is set. */
static double m_StartTime;
static double m_MainTime;
static bool m_ScriptDebuggerEnabled;
static double m_LastReloadFailed;
#ifndef _WIN32
static void SigIntTermHandler(int signum);
#else /* _WIN32 */
static BOOL WINAPI CtrlHandler(DWORD type);
static LONG WINAPI SEHUnhandledExceptionFilter(PEXCEPTION_POINTERS exi);
#endif /* _WIN32 */
static void DisplayBugMessage(std::ostream& os);
static void SigAbrtHandler(int signum);
static void SigUsr1Handler(int signum);
static void ExceptionHandler(void);
static String GetCrashReportFilename(void);
static void AttachDebugger(const String& filename, bool interactive);
};
}
#endif /* APPLICATION_H */