d_controller.cc 16.7 KB
Newer Older
1
// Copyright (C) 2013-2016 Internet Systems Consortium, Inc. ("ISC")
2
//
3 4 5
// 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/.
6

7
#include <config.h>
8
#include <cc/command_interpreter.h>
9
#include <cfgrpt/config_report.h>
10
#include <cryptolink/cryptolink.h>
11 12
#include <dhcpsrv/cfgmgr.h>
#include <exceptions/exceptions.h>
13
#include <log/logger.h>
14 15 16
#include <log/logger_support.h>
#include <process/d2_log.h>
#include <process/d_controller.h>
17

18 19 20 21 22 23
#ifdef HAVE_MYSQL
#include <dhcpsrv/mysql_lease_mgr.h>
#endif
#ifdef HAVE_PGSQL
#include <dhcpsrv/pgsql_lease_mgr.h>
#endif
Tomek Mrugalski's avatar
Tomek Mrugalski committed
24 25
#ifdef HAVE_CQL
#include <dhcpsrv/cql_lease_mgr.h>
26
#endif
27 28
#include <dhcpsrv/memfile_lease_mgr.h>

29
#include <sstream>
30
#include <unistd.h>
31 32 33 34 35 36 37

namespace isc {
namespace d2 {

DControllerBasePtr DControllerBase::controller_;

// Note that the constructor instantiates the controller's primary IOService.
38
DControllerBase::DControllerBase(const char* app_name, const char* bin_name)
39
    : app_name_(app_name), bin_name_(bin_name),
40
      verbose_(false), spec_file_name_(""),
41
      io_service_(new isc::asiolink::IOService()),
42
      io_signal_queue_() {
43 44
}

45
void
46
DControllerBase::setController(const DControllerBasePtr& controller) {
47 48 49 50 51 52 53
    if (controller_) {
        // This shouldn't happen, but let's make sure it can't be done.
        // It represents a programmatic error.
        isc_throw (DControllerBaseError,
                "Multiple controller instances attempted.");
    }

54
    controller_ = controller;
55 56
}

57
void
58
DControllerBase::launch(int argc, char* argv[], const bool test_mode) {
59

60 61 62 63 64
    // Step 1 is to parse the command line arguments.
    try {
        parseArgs(argc, argv);
    } catch (const InvalidUsage& ex) {
        usage(ex.what());
65
        throw; // rethrow it
66 67
    }

68
    setProcName(bin_name_);
69

70 71 72 73 74 75 76 77 78 79
    // It is important that we set a default logger name because this name
    // will be used when the user doesn't provide the logging configuration
    // in the Kea configuration file.
    isc::dhcp::CfgMgr::instance().setDefaultLoggerName(bin_name_);

    // Logger's default configuration depends on whether we are in the
    // verbose mode or not. CfgMgr manages the logger configuration so
    // the verbose mode is set for CfgMgr.
    isc::dhcp::CfgMgr::instance().setVerbose(verbose_);

80 81 82 83
    // Do not initialize logger here if we are running unit tests. It would
    // replace an instance of unit test specific logger.
    if (!test_mode) {
        // Now that we know what the mode flags are, we can init logging.
84
        Daemon::loggerInit(bin_name_.c_str(), verbose_);
85
    }
86

87 88 89
    try {
        createPIDFile();
    } catch (const dhcp::DaemonPIDExists& ex) {
90
        LOG_FATAL(dctl_logger, DCTL_ALREADY_RUNNING)
91 92 93
                  .arg(bin_name_).arg(ex.what());
        isc_throw (LaunchError, "Launch Failed: " << ex.what());
    } catch (const std::exception& ex) {
94
        LOG_FATAL(dctl_logger, DCTL_PID_FILE_ERROR)
95 96 97 98
                  .arg(app_name_).arg(ex.what());
        isc_throw (LaunchError, "Launch failed: " << ex.what());
    }

99 100 101
    // Log the starting of the service.
    LOG_INFO(dctl_logger, DCTL_STARTING)
        .arg(app_name_).arg(getpid()).arg(VERSION);
102
    try {
103
        // Step 2 is to create and initialize the application process object.
104
        initProcess();
105
    } catch (const std::exception& ex) {
106 107 108
        LOG_FATAL(dctl_logger, DCTL_INIT_PROCESS_FAIL)
                  .arg(app_name_).arg(ex.what());
        isc_throw (ProcessInitError,
109
                   "Application Process initialization failed: " << ex.what());
110
    }
111

112 113 114 115 116 117 118 119 120
    LOG_DEBUG(dctl_logger, DBGLVL_START_SHUT, DCTL_STANDALONE).arg(app_name_);

    // Step 3 is to load configuration from file.
    int rcode;
    isc::data::ConstElementPtr comment
        = isc::config::parseAnswer(rcode, configFromFile());
    if (rcode != 0) {
        LOG_FATAL(dctl_logger, DCTL_CONFIG_FILE_LOAD_FAIL)
                  .arg(app_name_).arg(comment->stringValue());
Vincent Legout's avatar
Vincent Legout committed
121
        isc_throw (ProcessInitError, "Could Not load configuration file: "
122
                   << comment->stringValue());
123
    }
124

125 126 127
    // Everything is clear for launch, so start the application's
    // event loop.
    try {
128 129
        // Now that we have a proces, we can set up signal handling.
        initSignalHandling();
130 131
        runProcess();
    } catch (const std::exception& ex) {
132 133 134
        LOG_FATAL(dctl_logger, DCTL_PROCESS_FAILED)
                  .arg(app_name_).arg(ex.what());
        isc_throw (ProcessRunError,
135
                   "Application process event loop failed: " << ex.what());
136 137
    }

138 139 140
    // All done, so bail out.
    LOG_INFO(dctl_logger, DCTL_SHUTDOWN)
        .arg(app_name_).arg(getpid()).arg(VERSION);
141 142 143 144 145
}

void
DControllerBase::parseArgs(int argc, char* argv[])
{
146
    // Iterate over the given command line options. If its a stock option
147 148 149
    // ("s" or "v") handle it here.  If its a valid custom option, then
    // invoke customOption.
    int ch;
150
    opterr = 0;
151
    optind = 1;
152
    std::string opts("dvVWc:" + getCustomOpts());
153 154
    while ((ch = getopt(argc, argv, opts.c_str())) != -1) {
        switch (ch) {
155
        case 'd':
156 157 158 159
            // Enables verbose logging.
            verbose_ = true;
            break;

160
        case 'v':
161 162 163 164
            // gather Kea version and throw so main() can catch and return
            // rather than calling exit() here which disrupts gtest.
            isc_throw(VersionMessage, getVersion(false));
            break;
165 166

        case 'V':
167 168 169 170
            // gather Kea version and throw so main() can catch and return
            // rather than calling exit() here which disrupts gtest.
            isc_throw(VersionMessage, getVersion(true));
            break;
171
            
172 173 174 175 176 177
        case 'W':
            // gather Kea config report and throw so main() can catch and
            // return rather than calling exit() here which disrupts gtest.
            isc_throw(VersionMessage, isc::detail::getConfigReport());
            break;

178 179 180 181 182 183
        case 'c':
            // config file name
            if (optarg == NULL) {
                isc_throw(InvalidUsage, "configuration file name missing");
            }

184
            setConfigFile(optarg);
185 186 187 188
            break;

        case '?': {
            // We hit an invalid option.
189
            isc_throw(InvalidUsage, "unsupported option: ["
190 191
                      << static_cast<char>(optopt) << "] "
                      << (!optarg ? "" : optarg));
192 193 194

            break;
            }
195

196 197 198
        default:
            // We hit a valid custom option
            if (!customOption(ch, optarg)) {
199
                // This would be a programmatic error.
200
                isc_throw(InvalidUsage, " Option listed but implemented?: ["
201 202
                          << static_cast<char>(ch) << "] "
                          << (!optarg ? "" : optarg));
203 204 205 206 207 208 209
            }
            break;
        }
    }

    // There was too much information on the command line.
    if (argc > optind) {
210
        isc_throw(InvalidUsage, "extraneous command line information");
211 212 213
    }
}

214
bool
215 216 217 218 219 220 221 222
DControllerBase::customOption(int /* option */, char* /*optarg*/)
{
    // Default implementation returns false.
    return (false);
}

void
DControllerBase::initProcess() {
223
    LOG_DEBUG(dctl_logger, DBGLVL_START_SHUT, DCTL_INIT_PROCESS).arg(app_name_);
224 225

    // Invoke virtual method to instantiate the application process.
226
    try {
227
        process_.reset(createProcess());
228
    } catch (const std::exception& ex) {
229
        isc_throw(DControllerBaseError, std::string("createProcess failed: ")
230
                  + ex.what());
231 232 233 234
    }

    // This is pretty unlikely, but will test for it just to be safe..
    if (!process_) {
235
        isc_throw(DControllerBaseError, "createProcess returned NULL");
236
    }
237

238 239
    // Invoke application's init method (Note this call should throw
    // DProcessBaseError if it fails).
240 241 242
    process_->init();
}

243 244
isc::data::ConstElementPtr
DControllerBase::configFromFile() {
245 246 247 248
    // Rollback any previous staging configuration. For D2, only a
    // logger configuration is used here.
    isc::dhcp::CfgMgr::instance().rollback();
    // Will hold configuration.
249
    isc::data::ConstElementPtr module_config;
250 251
    // Will receive configuration result.
    isc::data::ConstElementPtr answer;
252
    try {
253
        std::string config_file = getConfigFile();
254 255 256 257 258 259 260 261 262 263
        if (config_file.empty()) {
            // Basic sanity check: file name must not be empty.
            isc_throw(BadValue, "JSON configuration file not specified. Please "
                                "use -c command line option.");
        }

        // Read contents of the file and parse it as JSON
        isc::data::ConstElementPtr whole_config =
            isc::data::Element::fromJSONFile(config_file, true);

264 265 266 267
        // Let's configure logging before applying the configuration,
        // so we can log things during configuration process.

        // Temporary storage for logging configuration
268
        isc::dhcp::SrvConfigPtr storage =
269
            isc::dhcp::CfgMgr::instance().getStagingCfg();
270

Tomek Mrugalski's avatar
Tomek Mrugalski committed
271 272
        // Get 'Logging' element from the config and use it to set up
        // logging. If there's no such element, we'll just pass NULL.
273
        Daemon::configureLogger(whole_config->get("Logging"), storage);
274

275 276 277 278 279 280 281
        // Extract derivation-specific portion of the configuration.
        module_config = whole_config->get(getAppName());
        if (!module_config) {
            isc_throw(BadValue, "Config file " << config_file <<
                                " does not include '" <<
                                 getAppName() << "' entry.");
        }
282 283 284 285 286 287 288 289 290 291 292

        answer = updateConfig(module_config);
        int rcode = 0;
        isc::config::parseAnswer(rcode, answer);
        if (!rcode) {
            // Configuration successful, so apply the logging configuration
            // to log4cplus.
            isc::dhcp::CfgMgr::instance().getStagingCfg()->applyLoggingCfg();
            isc::dhcp::CfgMgr::instance().commit();
        }

293
    } catch (const std::exception& ex) {
294 295
        // Rollback logging configuration.
        isc::dhcp::CfgMgr::instance().rollback();
296 297 298 299 300
        // build an error result
        isc::data::ConstElementPtr error =
            isc::config::createAnswer(1,
                std::string("Configuration parsing failed: ") + ex.what());
        return (error);
301 302
    }

303
    return (answer);
304 305
}

306

307 308
void
DControllerBase::runProcess() {
309
    LOG_DEBUG(dctl_logger, DBGLVL_START_SHUT, DCTL_RUN_PROCESS).arg(app_name_);
310 311 312 313 314
    if (!process_) {
        // This should not be possible.
        isc_throw(DControllerBaseError, "Process not initialized");
    }

315 316
    // Invoke the application process's run method. This may throw
    // DProcessBaseError
317 318 319
    process_->run();
}

320
// Instance method for handling new config
321 322
isc::data::ConstElementPtr
DControllerBase::updateConfig(isc::data::ConstElementPtr new_config) {
323
    return (process_->configure(new_config));
324 325 326
}


327
// Instance method for executing commands
328
isc::data::ConstElementPtr
329
DControllerBase::executeCommand(const std::string& command,
330
                            isc::data::ConstElementPtr args) {
331
    // Shutdown is universal.  If its not that, then try it as
332
    // a custom command supported by the derivation.  If that
333 334 335 336
    // doesn't pan out either, than send to it the application
    // as it may be supported there.
    isc::data::ConstElementPtr answer;
    if (command.compare(SHUT_DOWN_COMMAND) == 0) {
337
        answer = shutdownProcess(args);
338
    } else {
339
        // It wasn't shutdown, so it may be a custom controller command.
340 341
        int rcode = 0;
        answer = customControllerCommand(command, args);
342
        isc::config::parseAnswer(rcode, answer);
343 344
        if (rcode == COMMAND_INVALID)
        {
345
            // It wasn't a controller command, so it may be an application command.
346
            answer = process_->command(command, args);
347 348 349 350 351 352 353
        }
    }

    return (answer);
}

isc::data::ConstElementPtr
354
DControllerBase::customControllerCommand(const std::string& command,
355 356 357 358
                                     isc::data::ConstElementPtr /* args */) {

    // Default implementation always returns invalid command.
    return (isc::config::createAnswer(COMMAND_INVALID,
359
                                      "Unrecognized command: " + command));
360 361
}

362
isc::data::ConstElementPtr
363
DControllerBase::shutdownProcess(isc::data::ConstElementPtr args) {
364
    if (process_) {
365
        return (process_->shutdown(args));
366
    }
367

368 369 370
    // Not really a failure, but this condition is worth noting. In reality
    // it should be pretty hard to cause this.
    LOG_WARN(dctl_logger, DCTL_NOT_RUNNING).arg(app_name_);
Vincent Legout's avatar
Vincent Legout committed
371
    return (isc::config::createAnswer(0, "Process has not been initialized."));
372 373
}

374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
void
DControllerBase::initSignalHandling() {
    /// @todo block everything we don't handle

    // Create our signal queue.
    io_signal_queue_.reset(new IOSignalQueue(io_service_));

    // Install the on-receipt handler
    util::SignalSet::setOnReceiptHandler(boost::bind(&DControllerBase::
                                                     osSignalHandler,
                                                     this, _1));
    // Register for the signals we wish to handle.
    signal_set_.reset(new util::SignalSet(SIGHUP,SIGINT,SIGTERM));
}

bool
DControllerBase::osSignalHandler(int signum) {
    // Create a IOSignal to propagate the signal to IOService.
    io_signal_queue_->pushSignal(signum, boost::bind(&DControllerBase::
                                                     ioSignalHandler,
                                                     this, _1));
    return (true);
}

void
DControllerBase::ioSignalHandler(IOSignalId sequence_id) {
    // Pop the signal instance off the queue.  This should make us
    // the only one holding it, so when we leave it should be freed.
    // (note that popSignal will throw if signal is not found, which
    // in turn will caught, logged, and swallowed by IOSignal callback
    // invocation code.)
    IOSignalPtr io_signal = io_signal_queue_->popSignal(sequence_id);

    // Now call virtual signal processing method.
    processSignal(io_signal->getSignum());
}

void
DControllerBase::processSignal(int signum) {
    switch (signum) {
        case SIGHUP:
        {
416
            LOG_INFO(dctl_logger, DCTL_CFG_FILE_RELOAD_SIGNAL_RECVD)
417 418 419 420 421 422
                     .arg(signum).arg(getConfigFile());
            int rcode;
            isc::data::ConstElementPtr comment = isc::config::
                                                 parseAnswer(rcode,
                                                             configFromFile());
            if (rcode != 0) {
423
                LOG_ERROR(dctl_logger, DCTL_CFG_FILE_RELOAD_ERROR)
424 425 426 427 428 429 430 431 432
                          .arg(comment->stringValue());
            }

            break;
        }

        case SIGINT:
        case SIGTERM:
        {
433
            LOG_DEBUG(dctl_logger, DBGLVL_START_SHUT,
434
                      DCTL_SHUTDOWN_SIGNAL_RECVD).arg(signum);
435 436 437 438 439 440
            isc::data::ElementPtr arg_set;
            executeCommand(SHUT_DOWN_COMMAND, arg_set);
            break;
        }

        default:
441
            LOG_WARN(dctl_logger, DCTL_UNSUPPORTED_SIGNAL).arg(signum);
442 443 444 445
            break;
    }
}

446 447 448 449
void
DControllerBase::usage(const std::string & text)
{
    if (text != "") {
450
        std::cerr << "Usage error: " << text << std::endl;
451 452
    }

453
    std::cerr << "Usage: " << bin_name_ <<  std::endl
454 455
              << "  -v: print version number and exit" << std::endl
              << "  -V: print extended version information and exit"
456 457
              << std::endl
              << "  -W: display the configuration report and exit"
458 459 460 461
              << std::endl
              << "  -d: optional, verbose output " << std::endl
              << "  -c <config file name> : mandatory,"
              <<   " specifies name of configuration file " << std::endl;
462

463
    // add any derivation specific usage
464
    std::cerr << getUsageText() << std::endl;
465 466 467 468 469
}

DControllerBase::~DControllerBase() {
}

470 471 472
// Refer to config_report so it will be embedded in the binary
const char* const* d2_config_report = isc::detail::config_report;

Tomek Mrugalski's avatar
Tomek Mrugalski committed
473
std::string
474
DControllerBase::getVersion(bool extended) {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
475 476 477 478
    std::stringstream tmp;

    tmp << VERSION;
    if (extended) {
479
        tmp << std::endl << EXTENDED_VERSION << std::endl;
480 481 482
        tmp << "linked with:" << std::endl;
        tmp << isc::log::Logger::getVersion() << std::endl;
        tmp << isc::cryptolink::CryptoLink::getVersion() << std::endl;
483
        tmp << "database:" << std::endl; 
484
#ifdef HAVE_MYSQL
485
        tmp << isc::dhcp::MySqlLeaseMgr::getDBVersion() << std::endl;
486
#endif
487
#ifdef HAVE_PGSQL
488
        tmp << isc::dhcp::PgSqlLeaseMgr::getDBVersion() << std::endl;
489
#endif
Tomek Mrugalski's avatar
Tomek Mrugalski committed
490 491
#ifdef HAVE_CQL
        tmp << isc::dhcp::CqlLeaseMgr::getDBVersion() << std::endl;
492
#endif
493
        tmp << isc::dhcp::Memfile_LeaseMgr::getDBVersion();
494

495
        // @todo: more details about database runtime
Tomek Mrugalski's avatar
Tomek Mrugalski committed
496 497 498 499
    }

    return (tmp.str());
}
500 501 502 503

}; // namespace isc::d2

}; // namespace isc