lib/dhcpsrv/network_state.cc

// Copyright (C) 2017-2021 Internet Systems Consortium, Inc. ("ISC")
//
// 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/.

#include <config.h>

#include <exceptions/exceptions.h>
#include <dhcpsrv/network_state.h>
#include <dhcpsrv/timer_mgr.h>
#include <util/multi_threading_mgr.h>
#include <boost/enable_shared_from_this.hpp>
#include <functional>
#include <string>

using namespace isc::util;

namespace {

/// @brief Name of the timer used by the @c NetworkState class.
const std::string NETWORK_STATE_TIMER_NAME_USER_CMD = "network-state-timer-user-cmd";
const std::string NETWORK_STATE_TIMER_NAME_HA_CMD = "network-state-timer-ha-cmd";

} // end of anonymous namespace

namespace isc {
namespace dhcp {

/// @brief Implementation of the @c NetworkState class.
class NetworkStateImpl : public boost::enable_shared_from_this<NetworkStateImpl> {
public:

    /// @brief Constructor.
    NetworkStateImpl(const NetworkState::ServerType& server_type)
        : server_type_(server_type), globally_disabled_(false),
          disabled_subnets_(), disabled_networks_(),
          timer_mgr_(TimerMgr::instance()), disabled_by_user_command_(false),
          disabled_by_ha_command_(false), disabled_by_db_connection_(0) {
    }

    /// @brief Destructor.
    ~NetworkStateImpl() {
        destroyTimer(NetworkState::Origin::USER_COMMAND);
        destroyTimer(NetworkState::Origin::HA_COMMAND);
    }

    /// @brief Sets appropriate disabled or enabled DHCP service state for the
    /// respective origin.
    ///
    /// @note If any of the user commands, HA internal commands or connection
    /// recovery processes disable the dhcp service, the service will remain
    /// disabled until all flags are cleared.
    /// In the case of the connection recovery a reference count is used
    /// internally, so that all connections must be restored before enabling
    /// the network state.
    ///
    /// @param disable The value of the flag used to perform the transition.
    /// @param origin The origin of the state transition.
    void setDisableService(const bool disable,
                           const NetworkState::Origin& origin) {
        if (disable) {
            // Disable the service for any flag.
            globally_disabled_ = true;
            switch (origin) {
            case NetworkState::Origin::USER_COMMAND:
                disabled_by_user_command_ = true;
                break;
            case NetworkState::Origin::HA_COMMAND:
                disabled_by_ha_command_ = true;
                break;
            case NetworkState::Origin::DB_CONNECTION:
                ++disabled_by_db_connection_;
                break;
            default:
                isc_throw(NotImplemented, "origin value not handled when "
                          "disabling the network state");
                break;
            }
        } else {
            switch (origin) {
            case NetworkState::Origin::USER_COMMAND:
                disabled_by_user_command_ = false;
                break;
            case NetworkState::Origin::HA_COMMAND:
                disabled_by_ha_command_ = false;
                break;
            case NetworkState::Origin::DB_CONNECTION:
                // Never go below 0 (using unsigned type).
                // This should never happen anyway.
                if (disabled_by_db_connection_) {
                    --disabled_by_db_connection_;
                }
                break;
            default:
                isc_throw(NotImplemented, "origin value not handled when "
                          "enabling the network state");
                break;
            }
            // Enable the service only if all flags have been cleared.
            if (!disabled_by_user_command_ && !disabled_by_ha_command_ &&
                disabled_by_db_connection_ == 0) {
                globally_disabled_ = false;
            }
        }
    }

    /// @brief Reset internal counters for a specific origin.
    ///
    /// @note The dhcp service will remain disabled until all flags are cleared.
    ///
    /// @param origin The origin of the state transition.
    void reset(const NetworkState::Origin& origin) {
        switch (origin) {
        case NetworkState::Origin::USER_COMMAND:
            disabled_by_user_command_ = false;
            break;
        case NetworkState::Origin::HA_COMMAND:
            disabled_by_ha_command_ = false;
            break;
        case NetworkState::Origin::DB_CONNECTION:
            disabled_by_db_connection_ = 0;
            break;
        default:
            isc_throw(NotImplemented, "origin value not handled when "
                      "resetting the network state");
            break;
        }
        // Enable the service only if all flags have been cleared.
        if (!disabled_by_user_command_ && !disabled_by_ha_command_ &&
            disabled_by_db_connection_ == 0) {
            globally_disabled_ = false;
        }
    }

    /// @brief Enables DHCP service globally and per scopes.
    ///
    /// If delayed enabling DHCP service has been scheduled, it cancels it.
    ///
    /// @param origin The origin of the state transition.
    void enableAll(const NetworkState::Origin& origin) {
        setDisableService(false, origin);

        /// @todo Enable service for all subnets and networks here.

        destroyTimer(origin);
    }

    /// @brief Creates a timer counting the time when @c enableAll should be
    /// automatically called.
    ///
    /// If the timer has been already scheduled, it is destroyed and replaced
    /// with a new timer.
    ///
    /// @param seconds Number of seconds to elapse before the @c enableAll is
    /// called.
    /// @param origin The origin of the state transition.
    void createTimer(const unsigned int seconds,
                     const NetworkState::Origin& origin) {
        destroyTimer(origin);
        std::string timer_name = NETWORK_STATE_TIMER_NAME_USER_CMD;
        switch (origin) {
        case NetworkState::Origin::USER_COMMAND:
            timer_name = NETWORK_STATE_TIMER_NAME_USER_CMD;
            break;
        case NetworkState::Origin::HA_COMMAND:
            timer_name = NETWORK_STATE_TIMER_NAME_HA_CMD;
            break;
        case NetworkState::Origin::DB_CONNECTION:
            isc_throw(BadValue, "DB connection does not support delayed enable");
            break;
        default:
            isc_throw(NotImplemented, "origin value not handled when creating "
                      "a timer for delayed enable");
            break;
        }
        timer_mgr_->registerTimer(timer_name,
                                  std::bind(&NetworkStateImpl::enableAll,
                                            shared_from_this(), origin),
                                  seconds * 1000,
                                  asiolink::IntervalTimer::ONE_SHOT);
        timer_mgr_->setup(timer_name);
    }

    /// @brief Destroys a timer if present.
    ///
    /// @param origin The origin of the state transition.
    void destroyTimer(const NetworkState::Origin& origin) {
        std::string timer_name = NETWORK_STATE_TIMER_NAME_USER_CMD;
        switch (origin) {
        case NetworkState::Origin::USER_COMMAND:
            timer_name = NETWORK_STATE_TIMER_NAME_USER_CMD;
            break;
        case NetworkState::Origin::HA_COMMAND:
            timer_name = NETWORK_STATE_TIMER_NAME_HA_CMD;
            break;
        case NetworkState::Origin::DB_CONNECTION:
            return;
        default:
            isc_throw(NotImplemented, "origin value not handled when creating "
                      "a timer for delayed enable");
            break;
        }
        if (timer_mgr_->isTimerRegistered(timer_name)) {
            timer_mgr_->unregisterTimer(timer_name);
        }
    }

    /// @brief Server type.
    NetworkState::ServerType server_type_;

    /// @brief A flag indicating if DHCP service is globally disabled.
    bool globally_disabled_;

    /// @brief A list of subnets for which the DHCP service has been disabled.
    NetworkState::Subnets disabled_subnets_;

    /// @brief A list of networks for which the DHCP service has been disabled.
    NetworkState::Networks disabled_networks_;

    /// @brief A pointer to the common timer manager.
    ///
    /// This pointer is held here to make sure that the timer manager is not
    /// destroyed before an instance of this class is destroyed.
    TimerMgrPtr timer_mgr_;

    /// @brief Flag which indicates the state has been disabled by an user
    /// command.
    bool disabled_by_user_command_;

    /// @brief Flag which indicates the state has been disabled by the HA
    /// command.
    bool disabled_by_ha_command_;

    /// @brief Flag which indicates the state has been disabled by a DB
    /// connection loss.
    uint32_t disabled_by_db_connection_;
};

NetworkState::NetworkState(const NetworkState::ServerType& server_type)
    : impl_(new NetworkStateImpl(server_type)), mutex_(new std::mutex()) {
}

void
NetworkState::disableService(const Origin& origin) {
    if (MultiThreadingMgr::instance().getMode()) {
        std::lock_guard<std::mutex> lk(*mutex_);
        impl_->setDisableService(true, origin);
    } else {
        impl_->setDisableService(true, origin);
    }
}

void
NetworkState::enableService(const Origin& origin) {
    if (MultiThreadingMgr::instance().getMode()) {
        std::lock_guard<std::mutex> lk(*mutex_);
        impl_->setDisableService(false, origin);
    } else {
        impl_->setDisableService(false, origin);
    }
}

void
NetworkState::reset(const NetworkState::Origin& origin) {
    if (MultiThreadingMgr::instance().getMode()) {
        std::lock_guard<std::mutex> lk(*mutex_);
        impl_->reset(origin);
    } else {
        impl_->reset(origin);
    }
}

void
NetworkState::enableAll(const NetworkState::Origin& origin) {
    if (MultiThreadingMgr::instance().getMode()) {
        std::lock_guard<std::mutex> lk(*mutex_);
        impl_->enableAll(origin);
    } else {
        impl_->enableAll(origin);
    }
}

void
NetworkState::delayedEnableAll(const unsigned int seconds,
                               const NetworkState::Origin& origin) {
    if (MultiThreadingMgr::instance().getMode()) {
        std::lock_guard<std::mutex> lk(*mutex_);
        impl_->createTimer(seconds, origin);
    } else {
        impl_->createTimer(seconds, origin);
    }
}

bool
NetworkState::isServiceEnabled() const {
    if (MultiThreadingMgr::instance().getMode()) {
        std::lock_guard<std::mutex> lk(*mutex_);
        return (!impl_->globally_disabled_);
    } else {
        return (!impl_->globally_disabled_);
    }
}

bool
NetworkState::isDelayedEnableAll() const {
    return (TimerMgr::instance()->isTimerRegistered(NETWORK_STATE_TIMER_NAME_USER_CMD) ||
            TimerMgr::instance()->isTimerRegistered(NETWORK_STATE_TIMER_NAME_HA_CMD));
}

void
NetworkState::selectiveDisable(const NetworkState::Subnets&) {
    isc_throw(NotImplemented, "selectiveDisableService is not implemented");
}

void
NetworkState::selectiveDisable(const NetworkState::Networks&) {
    isc_throw(NotImplemented, "selectiveDisableService is not implemented");
}

void
NetworkState::selectiveEnable(const NetworkState::Subnets&) {
    isc_throw(NotImplemented, "selectiveEnableService is not implemented");
}

void
NetworkState::selectiveEnable(const NetworkState::Networks&) {
    isc_throw(NotImplemented, "selectiveEnableService is not implemented");
}

} // end of namespace isc::dhcp
} // end of namespace isc