18 #include <kea_version.h>
28 namespace ph = std::placeholders;
36 DControllerBase::DControllerBase(
const char* app_name,
const char* bin_name)
37 : app_name_(app_name), bin_name_(bin_name),
38 verbose_(false), check_only_(false),
49 "Multiple controller instances attempted.");
52 controller_ = controller;
77 return (EXIT_SUCCESS);
99 }
catch (
const std::exception& ex) {
101 .arg(app_name_).arg(ex.
what());
109 .arg(bin_name_).arg(ex.
what());
111 }
catch (
const std::exception& ex) {
113 .arg(app_name_).arg(ex.
what());
122 .arg(PACKAGE_VERSION_TYPE);
124 if (std::string(PACKAGE_VERSION_TYPE) ==
"development") {
130 }
catch (
const std::exception& ex) {
132 .arg(app_name_).arg(ex.
what());
134 "Application Process initialization failed: " << ex.
what());
145 .arg(app_name_).arg(comment->stringValue());
147 << comment->stringValue());
151 start_ = boost::posix_time::second_clock::universal_time();
159 }
catch (
const std::exception& ex) {
161 .arg(app_name_).arg(ex.
what());
163 "Application process event loop failed: " << ex.
what());
168 .arg(app_name_).arg(getpid()).arg(VERSION);
179 setenv(
"KEA_LOCKFILE_DIR",
"none", 0);
186 if (config_file.empty()) {
196 std::cerr <<
"Syntax check OK" << std::endl;
201 module_config = whole_config->get(
getAppName());
202 if (!module_config) {
204 " does not include '" <<
getAppName() <<
"' entry");
206 if (module_config->getType() != Element::map) {
208 " includes not map '" <<
getAppName() <<
"' entry");
213 if (!errmsg.empty()) {
225 << answer->stringValue());
231 }
catch (
const std::exception& ex) {
251 while ((ch = getopt(argc, argv, opts.c_str())) != -1) {
279 if (optarg == NULL) {
293 <<
static_cast<char>(optopt) <<
"] "
294 << (!optarg ?
"" : optarg));
304 <<
static_cast<char>(ch) <<
"] "
305 << (!optarg ?
"" : optarg));
331 }
catch (
const std::exception& ex) {
359 if (config_file.empty()) {
362 "use -c command line option.");
370 whole_config = Element::fromJSONFile(config_file,
true);
374 module_config = whole_config->get(
getAppName());
375 if (!module_config) {
377 " does not include '" <<
380 if (module_config->getType() != Element::map) {
382 " includes not map '" <<
getAppName() <<
"' entry");
387 if (!errmsg.empty()) {
403 storage->applyLoggingCfg();
407 process_->getCfgMgr()->getContext()->applyLoggingCfg();
408 }
catch (
const std::exception& ex) {
410 process_->getCfgMgr()->getContext()->applyLoggingCfg();
414 std::string(
"Configuration parsing failed: ") + ex.what());
438 return (process_->configure(new_config,
false));
444 return (process_->configure(new_config,
true));
450 ConstElementPtr config = process_->getCfgMgr()->getContext()->toElement();
458 std::string filename;
461 if (args->getType() != Element::map) {
462 return (
createAnswer(COMMAND_ERROR,
"Argument must be a map"));
465 if (filename_param) {
466 if (filename_param->getType() != Element::string) {
468 "passed parameter 'filename' "
471 filename = filename_param->stringValue();
475 if (filename.empty()) {
479 if (filename.empty()) {
481 "Unable to determine filename."
482 "Please specify filename explicitly."));
489 ElementPtr cfg = process_->getCfgMgr()->getContext()->toElement();
495 std::string(
"Error during write-config:")
500 "Error writing configuration to " + filename));
505 params->set(
"size", Element::create(
static_cast<long long>(size)));
506 params->set(
"filename", Element::create(filename));
509 + filename +
" successful", params));
517 for (
auto obj : args->mapValue()) {
518 const std::string& obj_name = obj.first;
519 if (obj_name == app_name) {
523 .arg(
"'" + obj_name +
"', defining anything in global level besides '"
524 + app_name +
"' is no longer supported.");
525 if (errmsg.empty()) {
526 errmsg =
" contains unsupported '" + obj_name +
"' parameter";
528 errmsg +=
" (and '" + obj_name +
"')";
536 const int status_code = COMMAND_ERROR;
544 message =
"Missing mandatory 'arguments' parameter.";
546 module_config = args->get(app_name);
547 if (!module_config) {
548 message =
"Missing mandatory '" + app_name +
"' parameter.";
549 }
else if (module_config->getType() != Element::map) {
550 message =
"'" + app_name +
"' parameter expected to be a map.";
554 if (message.empty()) {
557 if (!errmsg.empty()) {
558 message =
"'arguments' parameter" + errmsg;
562 if (!message.empty()) {
588 const int status_code = COMMAND_ERROR;
596 message =
"Missing mandatory 'arguments' parameter.";
598 module_config = args->get(app_name);
599 if (!module_config) {
600 message =
"Missing mandatory '" + app_name +
"' parameter.";
601 }
else if (module_config->getType() != Element::map) {
602 message =
"'" + app_name +
"' parameter expected to be a map.";
606 if (!message.empty()) {
633 storage->applyLoggingCfg();
639 process_->getCfgMgr()->getContext()->applyLoggingCfg();
641 }
catch (
const std::exception& ex) {
643 process_->getCfgMgr()->getContext()->applyLoggingCfg();
647 std::string(
"Configuration parsing failed: ") + ex.what());
654 const std::string& tag = process_->getCfgMgr()->getContext()->getServerTag();
656 response->set(
"server-tag", Element::create(tag));
664 status->set(
"pid", Element::create(
static_cast<int>(getpid())));
666 auto now = boost::posix_time::second_clock::universal_time();
667 if (!
start_.is_not_a_date_time()) {
668 auto uptime = now -
start_;
669 status->set(
"uptime", Element::create(uptime.total_seconds()));
672 auto last_commit = process_->getCfgMgr()->getContext()->getLastCommitTime();
673 if (!last_commit.is_not_a_date_time()) {
674 auto reload = now - last_commit;
675 status->set(
"reload", Element::create(reload.total_seconds()));
688 arguments->set(
"extended", extended);
705 int exit_value = EXIT_SUCCESS;
708 if (args->getType() != Element::map) {
714 if (param->getType() != Element::integer) {
716 "parameter 'exit-value' is not an integer"));
719 exit_value = param->intValue();
730 return (process_->shutdown(args));
736 return (
createAnswer(COMMAND_SUCCESS,
"Process has not been initialized"));
749 io_signal_set_->add(SIGHUP);
750 io_signal_set_->add(SIGINT);
751 io_signal_set_->add(SIGTERM);
765 .arg(comment->stringValue());
790 std::cerr <<
"Usage error: " << text << std::endl;
793 std::cerr <<
"Usage: " << bin_name_ << std::endl
794 <<
" -v: print version number and exit" << std::endl
795 <<
" -V: print extended version information and exit"
797 <<
" -W: display the configuration report and exit"
799 <<
" -d: optional, verbose output " << std::endl
800 <<
" -c <config file name> : mandatory,"
801 <<
" specify name of configuration file" << std::endl
802 <<
" -t <config file name> : check the"
803 <<
" configuration file and exit" << std::endl;
811 HooksManager::prepareUnloadLibraries();
812 if (!HooksManager::unloadLibraries()) {
813 auto names = HooksManager::getLibraryNames();
815 if (!names.empty()) {
817 for (
size_t i = 1; i < names.size(); ++i) {
818 msg += std::string(
", ") + names[i];
824 io_signal_set_.reset();
830 std::stringstream tmp;
834 tmp << std::endl << EXTENDED_VERSION << std::endl;
835 tmp <<
"linked with:" << std::endl;
A generic exception that is thrown if a parameter given to a method is considered invalid in that con...
This is a base class for exceptions thrown from the DNS library module.
virtual const char * what() const
Returns a C-style character string of the cause of the exception.
The IOService class is a wrapper for the ASIO io_service class.
Implements an asynchronous "signal" for IOService driven processing.
static std::string getVersion()
Version.
Base class for all configurations.
Exception thrown when the controller encounters an operational error.
asiolink::IOServicePtr & getIOService()
Getter for fetching the controller's IOService.
isc::data::ConstElementPtr configReloadHandler(const std::string &command, isc::data::ConstElementPtr args)
handler for config-reload command
isc::data::ConstElementPtr buildReportHandler(const std::string &command, isc::data::ConstElementPtr args)
handler for 'build-report' command
void runProcess()
Invokes the application process's event loop,(DBaseProcess::run).
void initProcess()
Instantiates the application process and then initializes it.
virtual std::string getVersionAddendum()
Fetches text containing additional version specifics.
isc::data::ConstElementPtr statusGetHandler(const std::string &command, isc::data::ConstElementPtr args)
handler for status-get command
void usage(const std::string &text)
Prints the program usage text to std error.
isc::data::ConstElementPtr shutdownProcess(isc::data::ConstElementPtr args)
Initiates shutdown procedure.
virtual const std::string getCustomOpts() const
Virtual method which returns a string containing the option letters for any custom command line optio...
virtual void processSignal(int signum)
Application-level signal processing method.
virtual ~DControllerBase()
Destructor.
isc::data::ConstElementPtr configWriteHandler(const std::string &command, isc::data::ConstElementPtr args)
handler for config-write command
static void setController(const DControllerBasePtr &controller)
Static setter which sets the singleton instance.
std::string handleOtherObjects(isc::data::ConstElementPtr args)
Deals with other (i.e.
isc::data::ConstElementPtr versionGetHandler(const std::string &command, isc::data::ConstElementPtr args)
handler for version-get command
isc::data::ConstElementPtr configSetHandler(const std::string &command, isc::data::ConstElementPtr args)
handler for config-set command
void initSignalHandling()
Initializes signal handling.
virtual const std::string getUsageText() const
Virtual method which can be used to contribute derivation specific usage text.
virtual isc::data::ConstElementPtr checkConfig(isc::data::ConstElementPtr new_config)
Instance method invoked by the configuration event handler and which processes the actual configurati...
bool isCheckOnly() const
Supplies whether or not check only mode is enabled.
isc::data::ConstElementPtr configGetHandler(const std::string &command, isc::data::ConstElementPtr args)
handler for config-get command
virtual int launch(int argc, char *argv[], const bool test_mode)
Acts as the primary entry point into the controller execution and provides the outermost application ...
void parseArgs(int argc, char *argv[])
Processes the command line arguments.
virtual bool customOption(int option, char *optarg)
Virtual method that provides derivations the opportunity to support additional command line options.
virtual DProcessBase * createProcess()=0
Abstract method that is responsible for instantiating the application process object.
isc::data::ConstElementPtr configTestHandler(const std::string &command, isc::data::ConstElementPtr args)
handler for config-test command
isc::data::ConstElementPtr serverTagGetHandler(const std::string &command, isc::data::ConstElementPtr args)
handler for server-tag-get command
std::string getAppName() const
Fetches the name of the application under control.
virtual isc::data::ConstElementPtr parseFile(const std::string &file_name)
Parse a given file into Elements.
virtual isc::data::ConstElementPtr configFromFile()
Reconfigures the process from a configuration file.
std::string getVersion(bool extended)
returns Kea version on stdout and exit.
virtual isc::data::ConstElementPtr updateConfig(isc::data::ConstElementPtr new_config)
Instance method invoked by the configuration event handler and which processes the actual configurati...
void checkConfigOnly()
Check the configuration.
isc::data::ConstElementPtr shutdownHandler(const std::string &command, isc::data::ConstElementPtr args)
handler for 'shutdown' command
Exception thrown when the PID file points to a live PID.
std::string getConfigFile() const
Returns config file name.
virtual size_t writeConfigFile(const std::string &config_file, isc::data::ConstElementPtr cfg=isc::data::ConstElementPtr()) const
Writes current configuration to specified file.
static void setVerbose(const bool verbose)
Sets or clears verbose mode.
static void configureLogger(const isc::data::ConstElementPtr &log_config, const isc::process::ConfigPtr &storage)
Configures logger.
boost::posix_time::ptime start_
Timestamp of the start of the daemon.
static void loggerInit(const char *log_name, bool verbose)
Initializes logger.
void setExitValue(int value)
Sets the exit value.
void checkConfigFile() const
Checks the configuration file name.
static void setDefaultLoggerName(const std::string &logger)
Sets the default logger name.
static void setProcName(const std::string &proc_name)
Sets the process name.
int getExitValue()
Fetches the exit value.
void createPIDFile(int pid=0)
Creates the PID file.
void setConfigFile(const std::string &config_file)
Sets the configuration file name.
Exception thrown when the command line is invalid.
Exception thrown when the controller launch fails.
Exception thrown when the application process fails.
Exception thrown when the application process encounters an operation in its event loop (i....
Exception used to convey version info upwards.
This file contains several functions and constants that are used for handling commands and responses ...
#define isc_throw(type, stream)
A shortcut macro to insert known values into exception arguments.
Logging initialization functions.
#define LOG_ERROR(LOGGER, MESSAGE)
Macro to conveniently test error output and log it.
#define LOG_INFO(LOGGER, MESSAGE)
Macro to conveniently test info output and log it.
#define LOG_WARN(LOGGER, MESSAGE)
Macro to conveniently test warn output and log it.
#define LOG_FATAL(LOGGER, MESSAGE)
Macro to conveniently test fatal output and log it.
#define LOG_DEBUG(LOGGER, LEVEL, MESSAGE)
Macro to conveniently test debug output and log it.
A wrapper interface for the ASIO library.
const int CONTROL_RESULT_ERROR
Status code indicating a general failure.
ConstElementPtr createAnswer(const int status_code, const std::string &text, const ConstElementPtr &arg)
ConstElementPtr parseAnswer(int &rcode, const ConstElementPtr &msg)
const int CONTROL_RESULT_SUCCESS
Status code indicating a successful operation.
boost::shared_ptr< const Element > ConstElementPtr
boost::shared_ptr< Element > ElementPtr
std::string getConfigReport()
const int DBGLVL_START_SHUT
This is given a value of 0 as that is the level selected if debugging is enabled without giving a lev...
isc::log::Logger dctl_logger("dctl")
Defines the logger used within libkea-process library.
const isc::log::MessageID DCTL_DEVELOPMENT_VERSION
const isc::log::MessageID DCTL_SHUTDOWN
const isc::log::MessageID DCTL_CFG_FILE_RELOAD_ERROR
const isc::log::MessageID DCTL_CFG_FILE_RELOAD_SIGNAL_RECVD
const isc::log::MessageID DCTL_RUN_PROCESS
const isc::log::MessageID DCTL_STANDALONE
const isc::log::MessageID DCTL_PID_FILE_ERROR
boost::shared_ptr< ConfigBase > ConfigPtr
Non-const pointer to the ConfigBase.
boost::shared_ptr< DControllerBase > DControllerBasePtr
const isc::log::MessageID DCTL_UNLOAD_LIBRARIES_ERROR
const isc::log::MessageID DCTL_STARTING
const isc::log::MessageID DCTL_PROCESS_FAILED
const isc::log::MessageID DCTL_SHUTDOWN_SIGNAL_RECVD
const isc::log::MessageID DCTL_INIT_PROCESS_FAIL
const isc::log::MessageID DCTL_ALREADY_RUNNING
const isc::log::MessageID DCTL_NOT_RUNNING
const isc::log::MessageID DCTL_CONFIG_FILE_LOAD_FAIL
const isc::log::MessageID DCTL_CONFIG_DEPRECATED
const isc::log::MessageID DCTL_UNSUPPORTED_SIGNAL
const isc::log::MessageID DCTL_INIT_PROCESS
Defines the logger used by the top-level component of kea-lfc.