ha_callouts.cc

Go to the documentation of this file.

// Copyright (C) 2017-2026 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/.
 
// Functions accessed by the hooks framework use C linkage to avoid the name
// mangling that accompanies use of the C++ compiler as well as to avoid
// issues related to namespaces.
 
#include <config.h>
 
#include <asiolink/io_service.h>
#include <asiolink/io_service_mgr.h>
#include <cc/command_interpreter.h>
#include <dhcpsrv/cfgmgr.h>
#include <dhcpsrv/network_state.h>
#include <exceptions/exceptions.h>
#include <high_availability/ha_impl.h>
#include <hooks/hooks.h>
#include <process/daemon.h>
 
#include <sstream>
#include <string>
 
#include <ha_log.h>
 
namespace isc {
namespace ha {
 
HAImplPtr impl;
 
} // end of namespace isc::ha
} // end of namespace isc
 
using namespace isc::asiolink;
using namespace isc::config;
using namespace isc::data;
using namespace isc::dhcp;
using namespace isc::ha;
using namespace isc::hooks;
using namespace isc::process;
using namespace std;
 
extern "C" {

int dhcp4_srv_configured(CalloutHandle& handle) {
    try {
        isc::dhcp::NetworkStatePtr network_state;
        handle.getArgument("network_state", network_state);
        impl->startServices(network_state, HAServerType::DHCPv4);
        IOServiceMgr::instance().registerIOService(impl->getIOService());
 
    } catch (const std::exception& ex) {
        LOG_ERROR(ha_logger, HA_DHCP4_START_SERVICE_FAILED)
            .arg(ex.what());
        handle.setStatus(isc::hooks::CalloutHandle::NEXT_STEP_DROP);
        ostringstream os;
        os << "Error: " << ex.what();
        string error(os.str());
        handle.setArgument("error", error);
        return (1);
    }
    return (0);
}

int buffer4_receive(CalloutHandle& handle) {
    CalloutHandle::CalloutNextStep status = handle.getStatus();
    if (status == CalloutHandle::NEXT_STEP_DROP) {
        return (0);
    }
 
    try {
        impl->buffer4Receive(handle);
 
    } catch (const std::exception& ex) {
        LOG_ERROR(ha_logger, HA_BUFFER4_RECEIVE_FAILED)
            .arg(ex.what());
        return (1);
    }
 
    return (0);
}

int subnet4_select(CalloutHandle& handle) {
    CalloutHandle::CalloutNextStep status = handle.getStatus();
    if (status == CalloutHandle::NEXT_STEP_DROP) {
        return (0);
    }
 
    try {
        impl->subnet4Select(handle);
 
    } catch (const std::exception& ex) {
        LOG_ERROR(ha_logger, HA_SUBNET4_SELECT_FAILED)
            .arg(ex.what());
        return (1);
    }
 
    return (0);
}
 

int leases4_committed(CalloutHandle& handle) {
    CalloutHandle::CalloutNextStep status = handle.getStatus();
    if (status == CalloutHandle::NEXT_STEP_DROP ||
        status == CalloutHandle::NEXT_STEP_SKIP) {
        return (0);
    }
 
    try {
        impl->leases4Committed(handle);
 
    } catch (const std::exception& ex) {
        LOG_ERROR(ha_logger, HA_LEASES4_COMMITTED_FAILED)
            .arg(ex.what());
        return (1);
    }
 
    return (0);
}

int lease4_server_decline(CalloutHandle& handle) {
    CalloutHandle::CalloutNextStep status = handle.getStatus();
    if (status == CalloutHandle::NEXT_STEP_DROP ||
        status == CalloutHandle::NEXT_STEP_SKIP) {
        return (0);
    }
 
    try {
        impl->lease4ServerDecline(handle);
    } catch (const std::exception& ex) {
        LOG_ERROR(ha_logger, HA_LEASE4_SERVER_DECLINE_FAILED)
            .arg(ex.what());
        return (1);
    }
 
    return (0);
}

int lease4_expire(CalloutHandle& handle) {
    CalloutHandle::CalloutNextStep status = handle.getStatus();
    if (status == CalloutHandle::NEXT_STEP_SKIP) {
        return (0);
    }
 
    try {
        impl->lease4Expire(handle);
    } catch (const std::exception& ex) {
        LOG_ERROR(ha_logger, HA_LEASE4_EXPIRE_FAILED)
            .arg(ex.what());
        return (1);
    }
 
    return (0);
}

int dhcp6_srv_configured(CalloutHandle& handle) {
    try {
        isc::dhcp::NetworkStatePtr network_state;
        handle.getArgument("network_state", network_state);
        impl->startServices(network_state, HAServerType::DHCPv6);
        IOServiceMgr::instance().registerIOService(impl->getIOService());
 
    } catch (const std::exception& ex) {
        LOG_ERROR(ha_logger, HA_DHCP6_START_SERVICE_FAILED)
            .arg(ex.what());
        handle.setStatus(isc::hooks::CalloutHandle::NEXT_STEP_DROP);
        ostringstream os;
        os << "Error: " << ex.what();
        string error(os.str());
        handle.setArgument("error", error);
        return (1);
    }
    return (0);
}

int buffer6_receive(CalloutHandle& handle) {
    CalloutHandle::CalloutNextStep status = handle.getStatus();
    if (status == CalloutHandle::NEXT_STEP_DROP ||
        status == CalloutHandle::NEXT_STEP_SKIP) {
        return (0);
    }
 
    try {
        impl->buffer6Receive(handle);
 
    } catch (const std::exception& ex) {
        LOG_ERROR(ha_logger, HA_BUFFER6_RECEIVE_FAILED)
            .arg(ex.what());
        return (1);
    }
 
    return (0);
}

int subnet6_select(CalloutHandle& handle) {
    CalloutHandle::CalloutNextStep status = handle.getStatus();
    if (status == CalloutHandle::NEXT_STEP_DROP) {
        return (0);
    }
 
    try {
        impl->subnet6Select(handle);
 
    } catch (const std::exception& ex) {
        LOG_ERROR(ha_logger, HA_SUBNET6_SELECT_FAILED)
            .arg(ex.what());
        return (1);
    }
 
    return (0);
}

int leases6_committed(CalloutHandle& handle) {
    CalloutHandle::CalloutNextStep status = handle.getStatus();
    if (status == CalloutHandle::NEXT_STEP_DROP ||
        status == CalloutHandle::NEXT_STEP_SKIP) {
        return (0);
    }
 
    try {
        impl->leases6Committed(handle);
 
    } catch (const std::exception& ex) {
        LOG_ERROR(ha_logger, HA_LEASES6_COMMITTED_FAILED)
            .arg(ex.what());
        return (1);
    }
 
    return (0);
}

int lease6_expire(CalloutHandle& handle) {
    CalloutHandle::CalloutNextStep status = handle.getStatus();
    if (status == CalloutHandle::NEXT_STEP_SKIP) {
        return (0);
    }
 
    try {
        impl->lease6Expire(handle);
    } catch (const std::exception& ex) {
        LOG_ERROR(ha_logger, HA_LEASE6_EXPIRE_FAILED)
            .arg(ex.what());
        return (1);
    }
 
    return (0);
}

int command_processed(CalloutHandle& handle) {
    try {
        impl->commandProcessed(handle);
 
    } catch (const std::exception& ex) {
        LOG_ERROR(ha_logger, HA_COMMAND_PROCESSED_FAILED)
            .arg(ex.what());
        return (1);
    }
 
    return (0);
}

int heartbeat_command(CalloutHandle& handle) {
    try {
        impl->heartbeatHandler(handle);
 
    } catch (const std::exception& ex) {
        LOG_ERROR(ha_logger, HA_HEARTBEAT_HANDLER_FAILED)
            .arg(ex.what());
        return (1);
    }
 
    return (0);
}

int sync_command(CalloutHandle& handle) {
    try {
        impl->synchronizeHandler(handle);
 
    } catch (const std::exception& ex) {
        LOG_ERROR(ha_logger, HA_SYNC_HANDLER_FAILED)
            .arg(ex.what());
    }
 
    return (0);
}

int scopes_command(CalloutHandle& handle) {
    try {
        impl->scopesHandler(handle);
 
    } catch (const std::exception& ex) {
        LOG_ERROR(ha_logger, HA_SCOPES_HANDLER_FAILED)
            .arg(ex.what());
    }
 
    return (0);
}

int continue_command(CalloutHandle& handle) {
    try {
        impl->continueHandler(handle);
 
    } catch (const std::exception& ex) {
        LOG_ERROR(ha_logger, HA_CONTINUE_HANDLER_FAILED)
            .arg(ex.what());
    }
 
    return (0);
}

int maintenance_notify_command(CalloutHandle& handle) {
    try {
        impl->maintenanceNotifyHandler(handle);
 
    } catch (const std::exception& ex) {
        LOG_ERROR(ha_logger, HA_MAINTENANCE_NOTIFY_HANDLER_FAILED)
            .arg(ex.what());
    }
 
    return (0);
}

int maintenance_start_command(CalloutHandle& handle) {
    try {
        impl->maintenanceStartHandler(handle);
 
    } catch (const std::exception& ex) {
        LOG_ERROR(ha_logger, HA_MAINTENANCE_START_HANDLER_FAILED)
            .arg(ex.what());
    }
 
    return (0);
}

int maintenance_cancel_command(CalloutHandle& handle) {
    try {
        impl->maintenanceCancelHandler(handle);
 
    } catch (const std::exception& ex) {
        LOG_ERROR(ha_logger, HA_MAINTENANCE_CANCEL_HANDLER_FAILED)
            .arg(ex.what());
    }
 
    return (0);
}

int ha_reset_command(CalloutHandle& handle) {
    try {
        impl->haResetHandler(handle);
 
    } catch (const std::exception& ex) {
        LOG_ERROR(ha_logger, HA_RESET_HANDLER_FAILED)
            .arg(ex.what());
    }
 
    return (0);
}

int sync_complete_notify_command(CalloutHandle& handle) {
    try {
        impl->syncCompleteNotifyHandler(handle);
    } catch (const std::exception& ex) {
        LOG_ERROR(ha_logger, HA_SYNC_COMPLETE_NOTIFY_HANDLER_FAILED)
            .arg(ex.what());
    }
 
    return (0);
}

int load(LibraryHandle& handle) {
    ConstElementPtr config = handle.getParameter("high-availability");
    if (!config) {
        LOG_ERROR(ha_logger, HA_MISSING_CONFIGURATION);
        return (1);
    }
 
    try {
        // Make the hook library not loadable by d2.
        uint16_t family = CfgMgr::instance().getFamily();
        const std::string& proc_name = Daemon::getProcName();
        if (family == AF_INET) {
            if (proc_name != "kea-dhcp4") {
                isc_throw(isc::Unexpected, "Bad process name: " << proc_name
                          << ", expected kea-dhcp4");
            }
        } else {
            if (proc_name != "kea-dhcp6") {
                isc_throw(isc::Unexpected, "Bad process name: " << proc_name
                          << ", expected kea-dhcp6");
            }
        }
 
        impl = boost::make_shared<HAImpl>();
        impl->configure(config);
 
        handle.registerCommandCallout("ha-heartbeat", heartbeat_command);
        handle.registerCommandCallout("ha-sync", sync_command);
        handle.registerCommandCallout("ha-scopes", scopes_command);
        handle.registerCommandCallout("ha-continue", continue_command);
        handle.registerCommandCallout("ha-maintenance-notify", maintenance_notify_command);
        handle.registerCommandCallout("ha-maintenance-start", maintenance_start_command);
        handle.registerCommandCallout("ha-maintenance-cancel", maintenance_cancel_command);
        handle.registerCommandCallout("ha-reset", ha_reset_command);
        handle.registerCommandCallout("ha-sync-complete-notify", sync_complete_notify_command);
 
    } catch (const std::exception& ex) {
        LOG_ERROR(ha_logger, HA_CONFIGURATION_FAILED)
            .arg(ex.what());
        return (CONTROL_RESULT_ERROR);
    }
 
    LOG_INFO(ha_logger, HA_INIT_OK);
    return (0);
}

int unload() {
    if (impl) {
        IOServiceMgr::instance().unregisterIOService(impl->getIOService());
        impl->stop();
        impl.reset();
    }
    LOG_INFO(ha_logger, HA_DEINIT_OK);
    return (0);
}

int multi_threading_compatible() {
    return (1);
}
 
} // end extern "C"