ctrl_dhcp6_srv.cc 16.3 KB
Newer Older
1
// Copyright (C) 2014-2016 Internet Systems Consortium, Inc. ("ISC")
Tomek Mrugalski's avatar
Tomek Mrugalski committed
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/.
Tomek Mrugalski's avatar
Tomek Mrugalski committed
6 7 8

#include <config.h>
#include <cc/data.h>
9
#include <config/command_mgr.h>
10
#include <dhcp/libdhcp++.h>
11
#include <dhcpsrv/cfgmgr.h>
12
#include <dhcpsrv/cfg_db_access.h>
Tomek Mrugalski's avatar
Tomek Mrugalski committed
13
#include <dhcp6/ctrl_dhcp6_srv.h>
14
#include <dhcp6/dhcp6to4_ipc.h>
Tomek Mrugalski's avatar
Tomek Mrugalski committed
15 16
#include <dhcp6/dhcp6_log.h>
#include <dhcp6/json_config_parser.h>
17 18
#include <hooks/hooks_manager.h>
#include <stats/stats_mgr.h>
Tomek Mrugalski's avatar
Tomek Mrugalski committed
19

20
using namespace isc::config;
Tomek Mrugalski's avatar
Tomek Mrugalski committed
21 22
using namespace isc::data;
using namespace isc::hooks;
23
using namespace isc::stats;
Tomek Mrugalski's avatar
Tomek Mrugalski committed
24 25
using namespace std;

26 27 28 29 30 31 32
namespace {

// Name of the file holding server identifier.
static const char* SERVER_DUID_FILE = "kea-dhcp6-serverid";

}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
namespace isc {
namespace dhcp {

ControlledDhcpv6Srv* ControlledDhcpv6Srv::server_ = NULL;

ConstElementPtr
ControlledDhcpv6Srv::commandShutdownHandler(const string&, ConstElementPtr) {
    if (ControlledDhcpv6Srv::server_) {
        ControlledDhcpv6Srv::server_->shutdown();
    } else {
        LOG_WARN(dhcp6_logger, DHCP6_NOT_RUNNING);
        ConstElementPtr answer = isc::config::createAnswer(1, "Shutdown failure.");
        return (answer);
    }
    ConstElementPtr answer = isc::config::createAnswer(0, "Shutting down.");
    return (answer);
}

ConstElementPtr
ControlledDhcpv6Srv::commandLibReloadHandler(const string&, ConstElementPtr) {
53 54
    /// @todo delete any stored CalloutHandles referring to the old libraries
    /// Get list of currently loaded libraries and reload them.
55
    HookLibsCollection loaded = HooksManager::getLibraryInfo();
Tomek Mrugalski's avatar
Tomek Mrugalski committed
56 57 58 59 60 61 62 63 64 65 66 67 68 69
    bool status = HooksManager::loadLibraries(loaded);
    if (!status) {
        LOG_ERROR(dhcp6_logger, DHCP6_HOOKS_LIBS_RELOAD_FAIL);
        ConstElementPtr answer = isc::config::createAnswer(1,
                                 "Failed to reload hooks libraries.");
        return (answer);
    }
    ConstElementPtr answer = isc::config::createAnswer(0,
                             "Hooks libraries successfully reloaded.");
    return (answer);
}

ConstElementPtr
ControlledDhcpv6Srv::commandConfigReloadHandler(const string&, ConstElementPtr args) {
70 71
    // Use set-config as it handles logging and server config
    return (commandSetConfigHandler("", args));
Tomek Mrugalski's avatar
Tomek Mrugalski committed
72 73
}

74 75 76 77 78 79 80 81 82
ConstElementPtr
ControlledDhcpv6Srv::commandSetConfigHandler(const string&,
                                             ConstElementPtr args) {
    const int status_code = 1; // 1 indicates an error
    ConstElementPtr dhcp6;
    string message;

    // Command arguments are expected to be:
    // { "Dhcp6": { ... }, "Logging": { ... } }
83 84
    // The Logging component is technically optional. If it's not supplied
    // logging will revert to default logging.
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
    if (!args) {
        message = "Missing mandatory 'arguments' parameter.";
    } else {
        dhcp6 = args->get("Dhcp6");
        if (!dhcp6) {
            message = "Missing mandatory 'Dhcp6' parameter.";
        } else if (dhcp6->getType() != Element::map) {
            message = "'Dhcp6' parameter expected to be a map.";
        }
    }

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

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

108 109
    // Logging is a sibling element and must be be parsed explicitly.
    // The call to configureLogger parses the given Logging element if
110
    // not null, into the staging config.  Note this does not alter the
111
    // current loggers, they remain in effect until we apply the
112 113
    // logging config below.  If no logging is supplied logging will
    // revert to default logging.
114 115 116
    Daemon::configureLogger(args->get("Logging"),
                            CfgMgr::instance().getStagingCfg());

117
    // Now we configure the server proper.
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
    ConstElementPtr result = processConfig(dhcp6);

    // If the configuration parsed successfully, apply the new logger
    // configuration and the commit the new configuration.  We apply
    // the logging first in case there's a configuration failure.
    int rcode = 0;
    isc::config::parseAnswer(rcode, result);
    if (rcode == 0) {
        CfgMgr::instance().getStagingCfg()->applyLoggingCfg();

        // Use new configuration.
        CfgMgr::instance().commit();
    }

    return (result);
133 134 135
}


136
ConstElementPtr
137
ControlledDhcpv6Srv::commandLeasesReclaimHandler(const string&,
Francis Dupont's avatar
Francis Dupont committed
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
                                                 ConstElementPtr args) {
    int status_code = 1;
    string message;

    // args must be { "remove": <bool> }
    if (!args) {
        message = "Missing mandatory 'remove' parameter.";
    } else {
        ConstElementPtr remove_name = args->get("remove");
        if (!remove_name) {
            message = "Missing mandatory 'remove' parameter.";
        } else if (remove_name->getType() != Element::boolean) {
            message = "'remove' parameter expected to be a boolean.";
        } else {
            bool remove_lease = remove_name->boolValue();
            server_->alloc_engine_->reclaimExpiredLeases6(0, 0, remove_lease);
            status_code = 0;
            message = "Reclamation of expired leases is complete.";
        }
    }
    ConstElementPtr answer = isc::config::createAnswer(status_code, message);
159 160 161
    return (answer);
}

Tomek Mrugalski's avatar
Tomek Mrugalski committed
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
isc::data::ConstElementPtr
ControlledDhcpv6Srv::processCommand(const std::string& command,
                                    isc::data::ConstElementPtr args) {
    LOG_DEBUG(dhcp6_logger, DBG_DHCP6_COMMAND, DHCP6_COMMAND_RECEIVED)
              .arg(command).arg(args->str());

    ControlledDhcpv6Srv* srv = ControlledDhcpv6Srv::getInstance();

    if (!srv) {
        ConstElementPtr no_srv = isc::config::createAnswer(1,
          "Server object not initialized, can't process command '" +
          command + "'.");
        return (no_srv);
    }

    try {
        if (command == "shutdown") {
            return (srv->commandShutdownHandler(command, args));

        } else if (command == "libreload") {
            return (srv->commandLibReloadHandler(command, args));

        } else if (command == "config-reload") {
            return (srv->commandConfigReloadHandler(command, args));
Francis Dupont's avatar
Francis Dupont committed
186

187 188 189
        } else if (command == "set-config") {
            return (srv->commandSetConfigHandler(command, args));

Francis Dupont's avatar
Francis Dupont committed
190 191
        } else if (command == "leases-reclaim") {
            return (srv->commandLeasesReclaimHandler(command, args));
Tomek Mrugalski's avatar
Tomek Mrugalski committed
192 193 194 195 196 197 198 199 200 201 202 203 204
        }

        return (isc::config::createAnswer(1, "Unrecognized command:"
                                          + command));

    } catch (const Exception& ex) {
        return (isc::config::createAnswer(1, "Error while processing command '"
                                          + command + "':" + ex.what()));
    }
}

isc::data::ConstElementPtr
ControlledDhcpv6Srv::processConfig(isc::data::ConstElementPtr config) {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
205 206 207 208

    LOG_DEBUG(dhcp6_logger, DBG_DHCP6_COMMAND, DHCP6_CONFIG_RECEIVED)
              .arg(config->str());

Tomek Mrugalski's avatar
Tomek Mrugalski committed
209 210 211 212 213 214 215 216
    ControlledDhcpv6Srv* srv = ControlledDhcpv6Srv::getInstance();

    if (!srv) {
        ConstElementPtr no_srv = isc::config::createAnswer(1,
          "Server object not initialized, can't process config.");
        return (no_srv);
    }

217 218 219 220 221 222 223 224 225 226 227
    // We're going to modify the timers configuration. This is not allowed
    // when the thread is running.
    try {
        TimerMgr::instance()->stopThread();
    } catch (const std::exception& ex) {
        std::ostringstream err;
        err << "Unable to stop worker thread running timers: "
            << ex.what() << ".";
        return (isc::config::createAnswer(1, err.str()));
    }

Tomek Mrugalski's avatar
Tomek Mrugalski committed
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
    ConstElementPtr answer = configureDhcp6Server(*srv, config);

    // Check that configuration was successful. If not, do not reopen sockets
    // and don't bother with DDNS stuff.
    try {
        int rcode = 0;
        isc::config::parseAnswer(rcode, answer);
        if (rcode != 0) {
            return (answer);
        }
    } catch (const std::exception& ex) {
        return (isc::config::createAnswer(1, "Failed to process configuration:"
                                          + string(ex.what())));
    }

243 244 245 246 247 248 249 250 251 252 253
    // Re-open lease and host database with new parameters.
    try {
        CfgDbAccessPtr cfg_db = CfgMgr::instance().getStagingCfg()->getCfgDbAccess();
        cfg_db->setAppendedParameters("universe=6");
        cfg_db->createManagers();

    } catch (const std::exception& ex) {
        return (isc::config::createAnswer(1, "Unable to open database: "
                                          + std::string(ex.what())));
    }

254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
    // Regenerate server identifier if needed.
    try {
        const std::string duid_file = CfgMgr::instance().getDataDir() + "/" +
            std::string(SERVER_DUID_FILE);
        DuidPtr duid = CfgMgr::instance().getStagingCfg()->getCfgDUID()->create(duid_file);
        server_->serverid_.reset(new Option(Option::V6, D6O_SERVERID, duid->getDuid()));
        if (duid) {
            LOG_INFO(dhcp6_logger, DHCP6_USING_SERVERID)
                .arg(duid->toText())
                .arg(duid_file);
        }

    } catch (const std::exception& ex) {
        std::ostringstream err;
        err << "unable to configure server identifier: " << ex.what();
        return (isc::config::createAnswer(1, err.str()));
    }

Tomek Mrugalski's avatar
Tomek Mrugalski committed
272 273 274 275 276 277 278
    // Server will start DDNS communications if its enabled.
    try {
        srv->startD2();
    } catch (const std::exception& ex) {
        std::ostringstream err;
        err << "error starting DHCP_DDNS client "
                " after server reconfiguration: " << ex.what();
279 280 281 282 283
        return (isc::config::createAnswer(1, err.str()));
    }

    // Setup DHCPv4-over-DHCPv6 IPC
    try {
284
        Dhcp6to4Ipc::instance().open();
285 286 287 288
    } catch (const std::exception& ex) {
        std::ostringstream err;
        err << "error starting DHCPv4-over-DHCPv6 IPC "
               " after server reconfiguration: " << ex.what();
Tomek Mrugalski's avatar
Tomek Mrugalski committed
289 290 291 292
        return (isc::config::createAnswer(1, err.str()));
    }

    // Configuration may change active interfaces. Therefore, we have to reopen
293 294 295 296 297 298
    // sockets according to new configuration. It is possible that this
    // operation will fail for some interfaces but the openSockets function
    // guards against exceptions and invokes a callback function to
    // log warnings. Since we allow that this fails for some interfaces there
    // is no need to rollback configuration if socket fails to open on any
    // of the interfaces.
299
    CfgMgr::instance().getStagingCfg()->getCfgIface()->openSockets(AF_INET6, srv->getPort());
Tomek Mrugalski's avatar
Tomek Mrugalski committed
300

301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
    // Install the timers for handling leases reclamation.
    try {
        CfgMgr::instance().getStagingCfg()->getCfgExpiration()->
            setupTimers(&ControlledDhcpv6Srv::reclaimExpiredLeases,
                        &ControlledDhcpv6Srv::deleteExpiredReclaimedLeases,
                        server_);

    } catch (const std::exception& ex) {
        std::ostringstream err;
        err << "unable to setup timers for periodically running the"
            " reclamation of the expired leases: "
            << ex.what() << ".";
        return (isc::config::createAnswer(1, err.str()));
    }

    // Start worker thread if there are any timers installed.
    if (TimerMgr::instance()->timersCount() > 0) {
        try {
            TimerMgr::instance()->startThread();
        } catch (const std::exception& ex) {
            std::ostringstream err;
            err << "Unable to start worker thread running timers: "
                << ex.what() << ".";
            return (isc::config::createAnswer(1, err.str()));
        }
    }

328 329 330 331
    // Finally, we can commit runtime option definitions in libdhcp++. This is
    // exception free.
    LibDHCP::commitRuntimeOptionDefs();

Tomek Mrugalski's avatar
Tomek Mrugalski committed
332 333 334 335
    return (answer);
}

ControlledDhcpv6Srv::ControlledDhcpv6Srv(uint16_t port)
336
    : Dhcpv6Srv(port), io_service_(), timer_mgr_(TimerMgr::instance()) {
Tomek Mrugalski's avatar
Tomek Mrugalski committed
337 338 339 340 341
    if (server_) {
        isc_throw(InvalidOperation,
                  "There is another Dhcpv6Srv instance already.");
    }
    server_ = this; // remember this instance for use in callback
342 343 344 345 346 347

    // Register supported commands in CommandMgr
    CommandMgr::instance().registerCommand("shutdown",
        boost::bind(&ControlledDhcpv6Srv::commandShutdownHandler, this, _1, _2));

    /// @todo: register config-reload (see CtrlDhcpv4Srv::commandConfigReloadHandler)
348 349 350 351

    CommandMgr::instance().registerCommand("set-config",
        boost::bind(&ControlledDhcpv6Srv::commandSetConfigHandler, this, _1, _2));

352 353
    /// @todo: register libreload (see CtrlDhcpv4Srv::commandLibReloadHandler)

354 355 356
    CommandMgr::instance().registerCommand("leases-reclaim",
        boost::bind(&ControlledDhcpv6Srv::commandLeasesReclaimHandler, this, _1, _2));

357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
    // Register statistic related commands
    CommandMgr::instance().registerCommand("statistic-get",
        boost::bind(&StatsMgr::statisticGetHandler, _1, _2));

    CommandMgr::instance().registerCommand("statistic-reset",
        boost::bind(&StatsMgr::statisticResetHandler, _1, _2));

    CommandMgr::instance().registerCommand("statistic-remove",
        boost::bind(&StatsMgr::statisticRemoveHandler, _1, _2));

    CommandMgr::instance().registerCommand("statistic-get-all",
        boost::bind(&StatsMgr::statisticGetAllHandler, _1, _2));

    CommandMgr::instance().registerCommand("statistic-reset-all",
        boost::bind(&StatsMgr::statisticResetAllHandler, _1, _2));

    CommandMgr::instance().registerCommand("statistic-remove-all",
        boost::bind(&StatsMgr::statisticRemoveAllHandler, _1, _2));
Tomek Mrugalski's avatar
Tomek Mrugalski committed
375 376 377 378 379 380 381 382
}

void ControlledDhcpv6Srv::shutdown() {
    io_service_.stop(); // Stop ASIO transmissions
    Dhcpv6Srv::shutdown(); // Initiate DHCPv6 shutdown procedure.
}

ControlledDhcpv6Srv::~ControlledDhcpv6Srv() {
383 384 385
    try {
        cleanup();

386 387
        // Stop worker thread running timers, if it is running. Then
        // unregister any timers.
388
        timer_mgr_->stopThread();
389
        timer_mgr_->unregisterTimers();
390 391 392 393 394 395

        // Close the command socket (if it exists).
        CommandMgr::instance().closeCommandSocket();

        // Deregister any registered commands
        CommandMgr::instance().deregisterCommand("shutdown");
396
        CommandMgr::instance().deregisterCommand("set-config");
397
        CommandMgr::instance().deregisterCommand("leases-reclaim");
398 399 400 401 402 403 404 405 406 407 408 409
        CommandMgr::instance().deregisterCommand("statistic-get");
        CommandMgr::instance().deregisterCommand("statistic-reset");
        CommandMgr::instance().deregisterCommand("statistic-remove");
        CommandMgr::instance().deregisterCommand("statistic-get-all");
        CommandMgr::instance().deregisterCommand("statistic-reset-all");
        CommandMgr::instance().deregisterCommand("statistic-remove-all");

    } catch (...) {
        // Don't want to throw exceptions from the destructor. The server
        // is shutting down anyway.
        ;
    }
410

Tomek Mrugalski's avatar
Tomek Mrugalski committed
411 412 413 414 415 416 417 418 419 420 421 422
    server_ = NULL; // forget this instance. There should be no callback anymore
                    // at this stage anyway.
}

void ControlledDhcpv6Srv::sessionReader(void) {
    // Process one asio event. If there are more events, iface_mgr will call
    // this callback more than once.
    if (server_) {
        server_->io_service_.run_one();
    }
}

423 424 425
void
ControlledDhcpv6Srv::reclaimExpiredLeases(const size_t max_leases,
                                          const uint16_t timeout,
426 427
                                          const bool remove_lease,
                                          const uint16_t max_unwarned_cycles) {
428
    server_->alloc_engine_->reclaimExpiredLeases6(max_leases, timeout,
429 430
                                                  remove_lease,
                                                  max_unwarned_cycles);
431 432 433 434 435 436 437 438 439 440 441 442
    // We're using the ONE_SHOT timer so there is a need to re-schedule it.
    TimerMgr::instance()->setup(CfgExpiration::RECLAIM_EXPIRED_TIMER_NAME);
}

void
ControlledDhcpv6Srv::deleteExpiredReclaimedLeases(const uint32_t secs) {
    server_->alloc_engine_->deleteExpiredReclaimedLeases6(secs);
    // We're using the ONE_SHOT timer so there is a need to re-schedule it.
    TimerMgr::instance()->setup(CfgExpiration::FLUSH_RECLAIMED_TIMER_NAME);
}


Tomek Mrugalski's avatar
Tomek Mrugalski committed
443 444
}; // end of isc::dhcp namespace
}; // end of isc namespace