d_controller.cc 23.1 KB
Newer Older
1
// Copyright (C) 2013-2017 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
#include <log/logger_support.h>
15
#include <process/d_log.h>
16
#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

Francis Dupont's avatar
Francis Dupont committed
32 33 34
using namespace isc::data;
using namespace isc::config;

35
namespace isc {
36
namespace process {
37 38 39 40

DControllerBasePtr DControllerBase::controller_;

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

48
void
49
DControllerBase::setController(const DControllerBasePtr& controller) {
50 51 52 53 54 55 56
    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.");
    }

57
    controller_ = controller;
58 59
}

Francis Dupont's avatar
Francis Dupont committed
60
ConstElementPtr
61
DControllerBase::parseFile(const std::string&) {
Francis Dupont's avatar
Francis Dupont committed
62
    ConstElementPtr elements;
63 64 65
    return (elements);
}

66
void
67
DControllerBase::launch(int argc, char* argv[], const bool test_mode) {
68

69 70 71 72 73
    // Step 1 is to parse the command line arguments.
    try {
        parseArgs(argc, argv);
    } catch (const InvalidUsage& ex) {
        usage(ex.what());
74 75
        // rethrow it with an empty message
        isc_throw(InvalidUsage, "");
76 77
    }

78
    setProcName(bin_name_);
79

80 81
    if (isCheckOnly()) {
        checkConfigOnly();
82
        return;
83
    }
84

85 86 87 88 89 90 91 92 93 94
    // 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_);

95 96 97 98
    // 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.
99
        Daemon::loggerInit(bin_name_.c_str(), verbose_);
100
    }
101

102 103 104
    try {
        createPIDFile();
    } catch (const dhcp::DaemonPIDExists& ex) {
105
        LOG_FATAL(dctl_logger, DCTL_ALREADY_RUNNING)
106 107 108
                  .arg(bin_name_).arg(ex.what());
        isc_throw (LaunchError, "Launch Failed: " << ex.what());
    } catch (const std::exception& ex) {
109
        LOG_FATAL(dctl_logger, DCTL_PID_FILE_ERROR)
110 111 112 113
                  .arg(app_name_).arg(ex.what());
        isc_throw (LaunchError, "Launch failed: " << ex.what());
    }

114 115 116
    // Log the starting of the service.
    LOG_INFO(dctl_logger, DCTL_STARTING)
        .arg(app_name_).arg(getpid()).arg(VERSION);
117
    try {
118
        // Step 2 is to create and initialize the application process object.
119
        initProcess();
120
    } catch (const std::exception& ex) {
121 122 123
        LOG_FATAL(dctl_logger, DCTL_INIT_PROCESS_FAIL)
                  .arg(app_name_).arg(ex.what());
        isc_throw (ProcessInitError,
124
                   "Application Process initialization failed: " << ex.what());
125
    }
126

127 128 129 130
    LOG_DEBUG(dctl_logger, DBGLVL_START_SHUT, DCTL_STANDALONE).arg(app_name_);

    // Step 3 is to load configuration from file.
    int rcode;
Francis Dupont's avatar
Francis Dupont committed
131
    ConstElementPtr comment = parseAnswer(rcode, configFromFile());
132 133 134
    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
135
        isc_throw (ProcessInitError, "Could Not load configuration file: "
136
                   << comment->stringValue());
137
    }
138

139 140 141
    // Everything is clear for launch, so start the application's
    // event loop.
    try {
142 143
        // Now that we have a proces, we can set up signal handling.
        initSignalHandling();
144 145
        runProcess();
    } catch (const std::exception& ex) {
146 147 148
        LOG_FATAL(dctl_logger, DCTL_PROCESS_FAILED)
                  .arg(app_name_).arg(ex.what());
        isc_throw (ProcessRunError,
149
                   "Application process event loop failed: " << ex.what());
150 151
    }

152 153 154
    // All done, so bail out.
    LOG_INFO(dctl_logger, DCTL_SHUTDOWN)
        .arg(app_name_).arg(getpid()).arg(VERSION);
155 156
}

157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
void
DControllerBase::checkConfigOnly() {
    try {
        // We need to initialize logging, in case any error
        // messages are to be printed.
        // This is just a test, so we don't care about lockfile.
        setenv("KEA_LOCKFILE_DIR", "none", 0);
        isc::dhcp::CfgMgr::instance().setDefaultLoggerName(bin_name_);
        isc::dhcp::CfgMgr::instance().setVerbose(verbose_);
        Daemon::loggerInit(bin_name_.c_str(), verbose_);

        // Check the syntax first.
        std::string config_file = getConfigFile();
        if (config_file.empty()) {
            // Basic sanity check: file name must not be empty.
            isc_throw(InvalidUsage, "JSON configuration file not specified");
        }
Francis Dupont's avatar
Francis Dupont committed
174
        ConstElementPtr whole_config = parseFile(config_file);
175 176 177 178 179 180 181 182 183
        if (!whole_config) {
            // No fallback to fromJSONFile
            isc_throw(InvalidUsage, "No configuration found");
        }
        if (verbose_) {
            std::cerr << "Syntax check OK" << std::endl;
        }

        // Check the logic next.
Francis Dupont's avatar
Francis Dupont committed
184
        ConstElementPtr module_config;
185 186 187 188 189 190 191 192 193
        module_config = whole_config->get(getAppName());
        if (!module_config) {
            isc_throw(InvalidUsage, "Config file " << config_file <<
                      " does not include '" << getAppName() << "' entry");
        }

        // Get an application process object.
        initProcess();

Francis Dupont's avatar
Francis Dupont committed
194
        ConstElementPtr answer = checkConfig(module_config);
195
        int rcode = 0;
Francis Dupont's avatar
Francis Dupont committed
196
        answer = parseAnswer(rcode, answer);
197 198 199 200 201 202 203 204 205 206 207 208 209 210
        if (rcode != 0) {
            isc_throw(InvalidUsage, "Error encountered: "
                      << answer->stringValue());
        }
    } catch (const VersionMessage&) {
        throw;
    } catch (const InvalidUsage&) {
        throw;
    } catch (const std::exception& ex) {
        isc_throw(InvalidUsage, "Syntax check failed with: " << ex.what());
    }
    return;
}

211 212 213
void
DControllerBase::parseArgs(int argc, char* argv[])
{
214
    // Iterate over the given command line options. If its a stock option
215
    // ("c" or "d") handle it here.  If its a valid custom option, then
216 217
    // invoke customOption.
    int ch;
218
    opterr = 0;
219
    optind = 1;
220
    std::string opts("dvVWc:t:" + getCustomOpts());
221 222
    while ((ch = getopt(argc, argv, opts.c_str())) != -1) {
        switch (ch) {
223
        case 'd':
224 225 226 227
            // Enables verbose logging.
            verbose_ = true;
            break;

228
        case 'v':
229 230 231 232
            // 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;
233 234

        case 'V':
235 236 237 238
            // 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;
239

240 241 242 243 244 245
        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;

246
        case 'c':
247
        case 't':
248 249 250 251 252
            // config file name
            if (optarg == NULL) {
                isc_throw(InvalidUsage, "configuration file name missing");
            }

253
            setConfigFile(optarg);
254 255 256 257

            if (ch == 't') {
                check_only_ = true;
            }
258 259 260 261
            break;

        case '?': {
            // We hit an invalid option.
262
            isc_throw(InvalidUsage, "unsupported option: ["
263 264
                      << static_cast<char>(optopt) << "] "
                      << (!optarg ? "" : optarg));
265 266 267

            break;
            }
268

269 270 271
        default:
            // We hit a valid custom option
            if (!customOption(ch, optarg)) {
272
                // This would be a programmatic error.
273
                isc_throw(InvalidUsage, " Option listed but implemented?: ["
274 275
                          << static_cast<char>(ch) << "] "
                          << (!optarg ? "" : optarg));
276 277 278 279 280 281 282
            }
            break;
        }
    }

    // There was too much information on the command line.
    if (argc > optind) {
283
        isc_throw(InvalidUsage, "extraneous command line information");
284 285 286
    }
}

287
bool
288 289 290 291 292 293 294 295
DControllerBase::customOption(int /* option */, char* /*optarg*/)
{
    // Default implementation returns false.
    return (false);
}

void
DControllerBase::initProcess() {
296
    LOG_DEBUG(dctl_logger, DBGLVL_START_SHUT, DCTL_INIT_PROCESS).arg(app_name_);
297 298

    // Invoke virtual method to instantiate the application process.
299
    try {
300
        process_.reset(createProcess());
301
    } catch (const std::exception& ex) {
302
        isc_throw(DControllerBaseError, std::string("createProcess failed: ")
303
                  + ex.what());
304 305 306 307
    }

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

311 312
    // Invoke application's init method (Note this call should throw
    // DProcessBaseError if it fails).
313 314 315
    process_->init();
}

Francis Dupont's avatar
Francis Dupont committed
316
ConstElementPtr
317
DControllerBase::configFromFile() {
318 319 320 321
    // Rollback any previous staging configuration. For D2, only a
    // logger configuration is used here.
    isc::dhcp::CfgMgr::instance().rollback();
    // Will hold configuration.
Francis Dupont's avatar
Francis Dupont committed
322
    ConstElementPtr module_config;
323
    // Will receive configuration result.
Francis Dupont's avatar
Francis Dupont committed
324
    ConstElementPtr answer;
325
    try {
326
        std::string config_file = getConfigFile();
327 328 329 330 331 332
        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.");
        }

333 334
        // If parseFile returns an empty pointer, then pass the file onto the
        // original JSON parser.
Francis Dupont's avatar
Francis Dupont committed
335
        ConstElementPtr whole_config = parseFile(config_file);
336 337
        if (!whole_config) {
            // Read contents of the file and parse it as JSON
Francis Dupont's avatar
Francis Dupont committed
338
            whole_config = Element::fromJSONFile(config_file, true);
339
        }
340

341 342 343 344
        // Let's configure logging before applying the configuration,
        // so we can log things during configuration process.

        // Temporary storage for logging configuration
345
        isc::dhcp::SrvConfigPtr storage =
346
            isc::dhcp::CfgMgr::instance().getStagingCfg();
347

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

352 353 354 355 356 357 358
        // 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.");
        }
359

360
        answer = updateConfig(module_config);
361
        int rcode = 0;
Francis Dupont's avatar
Francis Dupont committed
362
        parseAnswer(rcode, answer);
363 364 365 366 367 368 369
        if (!rcode) {
            // Configuration successful, so apply the logging configuration
            // to log4cplus.
            isc::dhcp::CfgMgr::instance().getStagingCfg()->applyLoggingCfg();
            isc::dhcp::CfgMgr::instance().commit();
        }

370
    } catch (const std::exception& ex) {
371 372
        // Rollback logging configuration.
        isc::dhcp::CfgMgr::instance().rollback();
373
        // build an error result
Francis Dupont's avatar
Francis Dupont committed
374 375
        ConstElementPtr error = createAnswer(COMMAND_ERROR,
                 std::string("Configuration parsing failed: ") + ex.what());
376
        return (error);
377 378
    }

379
    return (answer);
380 381
}

382

383 384
void
DControllerBase::runProcess() {
385
    LOG_DEBUG(dctl_logger, DBGLVL_START_SHUT, DCTL_RUN_PROCESS).arg(app_name_);
386 387 388 389 390
    if (!process_) {
        // This should not be possible.
        isc_throw(DControllerBaseError, "Process not initialized");
    }

391 392
    // Invoke the application process's run method. This may throw
    // DProcessBaseError
393 394 395
    process_->run();
}

396
// Instance method for handling new config
Francis Dupont's avatar
Francis Dupont committed
397 398
ConstElementPtr
DControllerBase::updateConfig(ConstElementPtr new_config) {
399 400 401 402
    return (process_->configure(new_config, false));
}

// Instance method for checking new config
Francis Dupont's avatar
Francis Dupont committed
403 404
ConstElementPtr
DControllerBase::checkConfig(ConstElementPtr new_config) {
405
    return (process_->configure(new_config, true));
406 407
}

Francis Dupont's avatar
Francis Dupont committed
408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
ConstElementPtr
DControllerBase::configGetHandler(const std::string&,
                                  ConstElementPtr /*args*/) {
    ConstElementPtr config = process_->getCfgMgr()->getContext()->toElement();

    return (createAnswer(COMMAND_SUCCESS, config));
}

ConstElementPtr
DControllerBase::configWriteHandler(const std::string&,
                                    ConstElementPtr args) {
    std::string filename;

    if (args) {
        if (args->getType() != Element::map) {
            return (createAnswer(COMMAND_ERROR, "Argument must be a map"));
        }
        ConstElementPtr filename_param = args->get("filename");
        if (filename_param) {
            if (filename_param->getType() != Element::string) {
                return (createAnswer(COMMAND_ERROR,
                                     "passed parameter 'filename' "
                                     "is not a string"));
            }
            filename = filename_param->stringValue();
        }
    }

    if (filename.empty()) {
        // filename parameter was not specified, so let's use
        // whatever we remember
        filename = getConfigFile();
        if (filename.empty()) {
            return (createAnswer(COMMAND_ERROR,
                                 "Unable to determine filename."
                                 "Please specify filename explicitly."));
        }
    }

    // Now do the sanity checks on the filename
    if (filename.find("..") != std::string::npos) {
        // Trying to escape the directory.. nope.
        return (createAnswer(COMMAND_ERROR,
                             "Using '..' in filename is not allowed."));
    }

    if (filename.find("\\") != std::string::npos) {
        // Trying to inject escapes (possibly to inject quotes and something
        // nasty afterward)
        return (createAnswer(COMMAND_ERROR,
                             "Using \\ in filename is not allowed."));
    }

    if (filename[0] == '/') {
        // Absolute paths are not allowed.
        return (createAnswer(COMMAND_ERROR,
                             "Absolute path in filename is not allowed."));
    }

    // Ok, it's time to write the file.
    size_t size = 0;
    try {
        size = writeConfigFile(filename);
    } catch (const isc::Exception& ex) {
        return (createAnswer(COMMAND_ERROR,
                             std::string("Error during write-config:")
                             + ex.what()));
    }
    if (size == 0) {
        return (createAnswer(COMMAND_ERROR,
                             "Error writing configuration to " + filename));
    }

    // Ok, it's time to return the successful response.
    ElementPtr params = Element::createMap();
    params->set("size", Element::create(static_cast<long long>(size)));
    params->set("filename", Element::create(filename));

    return (createAnswer(CONTROL_RESULT_SUCCESS, "Configuration written to "
                         + filename + " successful", params));
}

ConstElementPtr
DControllerBase::configTestHandler(const std::string&, ConstElementPtr args) {
492 493 494
    const int status_code = COMMAND_ERROR; // 1 indicates an error
    ConstElementPtr module_config;
    std::string module = getAppName();
Francis Dupont's avatar
Francis Dupont committed
495 496 497
    std::string message;

    // Command arguments are expected to be:
498 499
    // { "Module": { ... }, "Logging": { ... } }
    // The Logging component is technically optional. If it's not supplied
Francis Dupont's avatar
Francis Dupont committed
500 501 502 503
    // logging will revert to default logging.
    if (!args) {
        message = "Missing mandatory 'arguments' parameter.";
    } else {
504 505 506 507 508
      module_config = args->get(module);
        if (!module_config) {
            message = "Missing mandatory '" + module + "' parameter.";
        } else if (module_config->getType() != Element::map) {
            message = "'" + module + "' parameter expected to be a map.";
Francis Dupont's avatar
Francis Dupont committed
509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524
        }
    }

    if (!message.empty()) {
        // Something is amiss with arguments, return a failure response.
        ConstElementPtr result = isc::config::createAnswer(status_code,
                                                           message);
        return (result);
    }

    // We are starting the configuration process so we should remove any
    // staging configuration that has been created during previous
    // configuration attempts.
    isc::dhcp::CfgMgr::instance().rollback();

    // Now we check the server proper.
525
    return (checkConfig(module_config));
Francis Dupont's avatar
Francis Dupont committed
526 527
}

Francis Dupont's avatar
Francis Dupont committed
528 529 530
ConstElementPtr
DControllerBase::versionGetHandler(const std::string&, ConstElementPtr args) {
    ConstElementPtr answer;
531

Francis Dupont's avatar
Francis Dupont committed
532 533 534 535 536
    // For version-get put the extended version in arguments
    ElementPtr extended = Element::create(getVersion(true));
    ElementPtr arguments = Element::createMap();
    arguments->set("extended", extended);
    answer = createAnswer(COMMAND_SUCCESS, getVersion(false), arguments);
537 538 539
    return (answer);
}

Francis Dupont's avatar
Francis Dupont committed
540 541 542 543
ConstElementPtr
DControllerBase::buildReportHandler(const std::string&, ConstElementPtr args) {
    return (createAnswer(COMMAND_SUCCESS, isc::detail::getConfigReport()));
}
544

Francis Dupont's avatar
Francis Dupont committed
545 546 547 548 549 550 551
ConstElementPtr
DControllerBase::shutdownHandler(const std::string&, ConstElementPtr args) {
    // Shutdown is universal.  If its not that, then try it as
    // a custom command supported by the derivation.  If that
    // doesn't pan out either, than send to it the application
    // as it may be supported there.
    return (shutdownProcess(args));
552 553
}

Francis Dupont's avatar
Francis Dupont committed
554 555
ConstElementPtr
DControllerBase::shutdownProcess(ConstElementPtr args) {
556
    if (process_) {
557
        return (process_->shutdown(args));
558
    }
559

560 561 562
    // 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_);
Francis Dupont's avatar
Francis Dupont committed
563
    return (createAnswer(COMMAND_SUCCESS, "Process has not been initialized"));
564 565
}

566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607
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:
        {
608
            LOG_INFO(dctl_logger, DCTL_CFG_FILE_RELOAD_SIGNAL_RECVD)
609 610
                     .arg(signum).arg(getConfigFile());
            int rcode;
Francis Dupont's avatar
Francis Dupont committed
611
            ConstElementPtr comment = parseAnswer(rcode, configFromFile());
612
            if (rcode != 0) {
613
                LOG_ERROR(dctl_logger, DCTL_CFG_FILE_RELOAD_ERROR)
614 615 616 617 618 619 620 621 622
                          .arg(comment->stringValue());
            }

            break;
        }

        case SIGINT:
        case SIGTERM:
        {
623
            LOG_DEBUG(dctl_logger, DBGLVL_START_SHUT,
624
                      DCTL_SHUTDOWN_SIGNAL_RECVD).arg(signum);
Francis Dupont's avatar
Francis Dupont committed
625 626
            ElementPtr arg_set;
            shutdownHandler(SHUT_DOWN_COMMAND, arg_set);
627 628 629 630
            break;
        }

        default:
631
            LOG_WARN(dctl_logger, DCTL_UNSUPPORTED_SIGNAL).arg(signum);
632 633 634 635
            break;
    }
}

636 637 638 639
void
DControllerBase::usage(const std::string & text)
{
    if (text != "") {
640
        std::cerr << "Usage error: " << text << std::endl;
641 642
    }

643
    std::cerr << "Usage: " << bin_name_ <<  std::endl
644 645
              << "  -v: print version number and exit" << std::endl
              << "  -V: print extended version information and exit"
646 647
              << std::endl
              << "  -W: display the configuration report and exit"
648 649 650
              << std::endl
              << "  -d: optional, verbose output " << std::endl
              << "  -c <config file name> : mandatory,"
651 652 653
              << " specify name of configuration file" << std::endl
              << "  -t <config file name> : check the"
              << " configuration file and exit" << std::endl;
654

655
    // add any derivation specific usage
656
    std::cerr << getUsageText() << std::endl;
657 658 659 660 661
}

DControllerBase::~DControllerBase() {
}

662 663 664
// 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
665
std::string
666
DControllerBase::getVersion(bool extended) {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
667 668 669 670
    std::stringstream tmp;

    tmp << VERSION;
    if (extended) {
671
        tmp << std::endl << EXTENDED_VERSION << std::endl;
672 673 674
        tmp << "linked with:" << std::endl;
        tmp << isc::log::Logger::getVersion() << std::endl;
        tmp << isc::cryptolink::CryptoLink::getVersion() << std::endl;
675
        tmp << "database:" << std::endl;
676
#ifdef HAVE_MYSQL
677
        tmp << isc::dhcp::MySqlLeaseMgr::getDBVersion() << std::endl;
678
#endif
679
#ifdef HAVE_PGSQL
680
        tmp << isc::dhcp::PgSqlLeaseMgr::getDBVersion() << std::endl;
681
#endif
Tomek Mrugalski's avatar
Tomek Mrugalski committed
682 683
#ifdef HAVE_CQL
        tmp << isc::dhcp::CqlLeaseMgr::getDBVersion() << std::endl;
684
#endif
685
        tmp << isc::dhcp::Memfile_LeaseMgr::getDBVersion();
686

687
        // @todo: more details about database runtime
Tomek Mrugalski's avatar
Tomek Mrugalski committed
688 689 690 691
    }

    return (tmp.str());
}
692

693
}; // namespace isc::process
694 695

}; // namespace isc