ibarrier.hpp

// This file is part of KaMPIng.
//
// Copyright 2023 The KaMPIng Authors
//
// KaMPIng is free software : you can redistribute it and/or modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later
// version. KaMPIng is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the
// implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
// for more details.
//
// You should have received a copy of the GNU Lesser General Public License along with KaMPIng.  If not, see
// <https://www.gnu.org/licenses/>.
 
#pragma once
 
#include <mpi.h>
 
#include "kamping/communicator.hpp"
#include "kamping/error_handling.hpp"
#include "kamping/named_parameter_check.hpp"
#include "kamping/named_parameter_selection.hpp"
#include "kamping/named_parameter_types.hpp"
#include "kamping/named_parameters.hpp"
#include "kamping/parameter_objects.hpp"
#include "kamping/request.hpp"
#include "kamping/result.hpp"
 
/// @addtogroup kamping_collectives
/// @{
 
/// @brief Perform a non-blocking barrier synchronization on this communicator using \c MPI_Ibarrier. The call is
/// associated with a \ref kamping::Request (either allocated by KaMPIng or provided by the user). Only when the request
/// has completed, it is guaranteed that all ranks have reached the barrier.
///
/// The following parameters are optional:
/// - \ref kamping::request() The request object to associate this operation with. Defaults to a library allocated
/// request object, which can be accessed via the returned result.
///
/// @tparam Args Automatically deduced template parameters.
/// @param args All required and any number of the optional buffers described above.
template <
    template <typename...>
    typename DefaultContainerType,
    template <typename, template <typename...> typename>
    typename... Plugins>
template <typename... Args>
auto kamping::Communicator<DefaultContainerType, Plugins...>::ibarrier(Args... args) const {
    using namespace kamping::internal;
    KAMPING_CHECK_PARAMETERS(Args, KAMPING_REQUIRED_PARAMETERS(), KAMPING_OPTIONAL_PARAMETERS(request));
 
    using default_request_param = decltype(kamping::request());
    auto&& request_param =
        internal::select_parameter_type_or_default<internal::ParameterType::request, default_request_param>(
            std::tuple{},
            args...
        );
 
    [[maybe_unused]] int err = MPI_Ibarrier(
        mpi_communicator(),                       // comm
        &request_param.underlying().mpi_request() // request
    );
    this->mpi_error_hook(err, "MPI_Ibarrier");
 
    return internal::make_nonblocking_result<std::tuple<Args...>>(std::move(request_param));
}
/// @}