test_bulk.cpp

Go to the documentation of this file.

#include "kokkos-utils/callbacks/RecorderListener.hpp"
#include "kokkos-utils/tests/scoped/callbacks/Manager.hpp"
 
#include "kokkos-execution/execution_space.hpp"
 
#include "tests/utils/callback_matchers.hpp"
#include "tests/utils/check_rcvr_env_queryable_with.hpp"
#include "tests/utils/execution_space_context.hpp"
#include "tests/utils/functors/counter.hpp"
#include "tests/utils/functors/labeled.hpp"
#include "tests/utils/functors/no_op.hpp"
#include "tests/utils/functors/sum_indices.hpp"
#include "tests/utils/just_stopped.hpp"
#include "tests/utils/sink_receiver.hpp"
#include "tests/utils/stdexec.hpp"
#include "tests/utils/sync_wait.hpp"
#include "tests/utils/tracking_allocator.hpp"

 
namespace Tests::ExecutionSpaceImpl {
 
using namespace Kokkos::utils::callbacks;
 
class BulkTest
    : public Tests::Utils::ExecutionSpaceContextTest<TEST_EXECUTION_SPACE>
    , public Kokkos::utils::tests::scoped::callbacks::Manager {
   public:
    using recorder_listener_t = RecorderListener<
        EventDiscardMatcher<TEST_EXECUTION_SPACE>,
        BeginFenceEvent,
        BeginParallelForEvent,
        Kokkos::Execution::Impl::RecordEvent,
        Kokkos::Execution::Impl::WaitEvent
    >;
};

consteval bool test_sndr_traits() {
    using schd_sndr_t = typename BulkTest::schedule_sender_t;

    using functor_t = Tests::Utils::Functors::SumIndices<BulkTest::view_s_t>;
    using bulk_sndr_t = stdexec::transform_sender_result_t<
        decltype(stdexec::bulk(std::declval<schd_sndr_t>(), stdexec::par, 1, std::declval<functor_t>())),
        stdexec::env<>
    >;
 
    static_assert(std::same_as<
                  bulk_sndr_t,
                  Kokkos::Execution::ExecutionSpaceImpl::ParallelForSender<
                      stdexec::bulk_t,
                      schd_sndr_t,
                      TEST_EXECUTION_SPACE,
                      Kokkos::Execution::Impl::ParallelForData<
                          functor_t,
                          Kokkos::RangePolicy<TEST_EXECUTION_SPACE, Kokkos::IndexType<int>>,
                          Kokkos::Execution::Impl::Label<std::string_view>
                      >
                  >
    >);

    static_assert(Kokkos::Execution::ExecutionSpaceImpl::execution_space_completing_sender<bulk_sndr_t>);
    static_assert(std::same_as<Kokkos::Execution::Impl::exec_of_t<bulk_sndr_t>, TEST_EXECUTION_SPACE>);

    static_assert(!Kokkos::Execution::Impl::dispatching_sender<bulk_sndr_t>);
 
    return true;
}
 
static_assert(test_sndr_traits());

consteval bool test_sndr_nothrow_transformable() {
    using sndr_bulk_t =
        decltype(stdexec::schedule(std::declval<typename BulkTest::scheduler_t>()) | stdexec::bulk(stdexec::par, 1, Tests::Utils::Functors::NoOp<false, false, false>{}));
 
    static_assert(stdexec::__detail::__has_nothrow_transform_sender<
                  Kokkos::Execution::ExecutionSpaceImpl::Domain,
                  stdexec::set_value_t,
                  sndr_bulk_t&&,
                  stdexec::env<>
    >);
 
    using sndr_bulk_maythrow_on_move_t =
        decltype(stdexec::schedule(std::declval<typename BulkTest::scheduler_t>()) | stdexec::bulk(stdexec::par, 1, Tests::Utils::Functors::NoOp<false, false, true>{}));
 
    static_assert(!stdexec::__detail::__has_nothrow_transform_sender<
                  Kokkos::Execution::ExecutionSpaceImpl::Domain,
                  stdexec::set_value_t,
                  sndr_bulk_maythrow_on_move_t&&,
                  stdexec::env<>
    >);
 
    using sndr_bulk_maythrow_on_copy_t =
        decltype(stdexec::schedule(std::declval<typename BulkTest::scheduler_t>()) | stdexec::bulk(stdexec::par, 1, Tests::Utils::Functors::NoOp<false, true, false>{}));
 
    static_assert(!stdexec::__detail::__has_nothrow_transform_sender<
                  Kokkos::Execution::ExecutionSpaceImpl::Domain,
                  stdexec::set_value_t,
                  const sndr_bulk_maythrow_on_copy_t&,
                  stdexec::env<>
    >);
 
    static_assert(
        !noexcept(stdexec::transform_sender(std::declval<const sndr_bulk_maythrow_on_copy_t&>(), stdexec::env<>{})));
 
    return true;
}
 
static_assert(test_sndr_nothrow_transformable());

static_assert(Tests::Utils::check_continues_on_after_just_stopped<
              typename BulkTest::scheduler_t,
              stdexec::bulk_t,
              stdexec::parallel_policy,
              int,
              Tests::Utils::Functors::NoOp<false, false, false>
>());

constexpr bool test_op_state_passed_by_const_ref() {
    using sndr_t = decltype(stdexec::bulk(
        stdexec::schedule(std::declval<typename BulkTest::context_t>().get_scheduler()),
        stdexec::par,
        1,
        Tests::Utils::Functors::Labeled<'a'>{}));
 
    static_assert(!std::is_const_v<sndr_t>);

    using op_state_from_sndr_const_ref_t = stdexec::connect_result_t<const sndr_t&, Tests::Utils::SinkReceiver>;
 
    static_assert(std::same_as<
                  op_state_from_sndr_const_ref_t,
                  Kokkos::Execution::ExecutionSpaceImpl::OpState<
                      const typename BulkTest::schedule_sender_t&,
                      Tests::Utils::SinkReceiver,
                      Kokkos::Execution::ExecutionSpaceImpl::ParallelForClosure<
                          TEST_EXECUTION_SPACE,
                          Kokkos::Execution::Impl::ParallelForData<
                              Tests::Utils::Functors::Labeled<'a'>,
                              Kokkos::RangePolicy<TEST_EXECUTION_SPACE, Kokkos::IndexType<int>>,
                              Kokkos::Execution::Impl::Label<std::string_view>
                          >
                      >
                  >
    >);
 
    return true;
}
 
static_assert(test_op_state_passed_by_const_ref());

TEST_F(BulkTest, bulk) {
    constexpr size_t size = 10;
 
    const view_s_t data(Kokkos::view_alloc(exec, "data - shared space"));
 
    const context_t esc{exec};
 
    auto chain = stdexec::schedule(esc.get_scheduler()) | BULK_SUM_INDICES(size, data);
 
    using chain_t = decltype(chain);

    static_assert(std::same_as<stdexec::__domain_of_t<stdexec::env_of_t<chain_t>>, stdexec::default_domain>);
    static_assert(std::same_as<
                  stdexec::__detail::__completing_domain_t<stdexec::set_value_t, chain_t>,
                  Kokkos::Execution::ExecutionSpaceImpl::Domain
    >);

    static_assert(std::same_as<
                  decltype(stdexec::get_completion_scheduler<stdexec::set_value_t>(stdexec::get_env(chain))),
                  scheduler_t
    >);
 
    ASSERT_EQ(data(), 0) << "Eager execution is not allowed.";
 
    ASSERT_THAT(
        Tests::Utils::record_sync_wait<recorder_listener_t>(std::move(chain)),
        testing::ElementsAre(
            MATCHER_FOR_BEGIN_PFOR(exec, dispatch_label(exec, "bulk")),
            MATCHER_FOR_BEGIN_FENCE(exec, dispatch_label(exec, "sync_wait"))));
 
    ASSERT_EQ(data(), size / 2 * (size - 1));
}

TEST_F(BulkTest, no_spurious_copy_on_connect) {
    const context_t esc{exec};
 
    Tests::Utils::Functors::Counter::reset();
 
    {
        auto lvalue = stdexec::schedule(esc.get_scheduler())
                    | stdexec::bulk(stdexec::par, 42, Tests::Utils::Functors::Counter{});
 
        [[maybe_unused]]
        const auto lop_state = stdexec::connect(lvalue, Tests::Utils::SinkReceiver{});
 
        ASSERT_EQ(Tests::Utils::Functors::Counter::copy_assignments, 0);
        ASSERT_EQ(Tests::Utils::Functors::Counter::copy_constructions, 1);
        ASSERT_EQ(Tests::Utils::Functors::Counter::move_assignments, 0);
    }
 
    Tests::Utils::Functors::Counter::reset();
 
    {
        auto rvalue = stdexec::schedule(esc.get_scheduler())
                    | stdexec::bulk(stdexec::par, 42, Tests::Utils::Functors::Counter{});
 
        [[maybe_unused]]
        const auto rop_state = stdexec::connect(std::move(rvalue), Tests::Utils::SinkReceiver{});
 
        ASSERT_EQ(Tests::Utils::Functors::Counter::copy_assignments, 0);
        ASSERT_EQ(Tests::Utils::Functors::Counter::copy_constructions, 0);
        ASSERT_EQ(Tests::Utils::Functors::Counter::move_assignments, 0);
    }
}

TEST_F(BulkTest, forwarding_env) {
    constexpr size_t size = 10;
 
    const view_s_t data(Kokkos::view_alloc(exec, "data - shared space"));
 
    std::atomic<size_t> count = 0;
 
    int value;
 
    const context_t esc{exec};
 
    stdexec::sender auto sndr =
        stdexec::read_env(stdexec::get_allocator)
        | stdexec::then([&value](auto allocator) { value = Tests::Utils::round_trip_allocate(allocator, 42); })
        | stdexec::continues_on(esc.get_scheduler())
        | Tests::Utils::check_rcvr_env_queryable_with<stdexec::get_allocator_t>() | BULK_SUM_INDICES(size, data)
        | stdexec::write_env(stdexec::prop{stdexec::get_allocator, Tests::Utils::TrackingAllocator<int>{&count}});
 
    ASSERT_EQ(data(), 0) << "Eager execution is not allowed.";
 
    const auto recorded_events = Tests::Utils::record_sync_wait<recorder_listener_t>(std::move(sndr));
 
    ASSERT_THAT(recorded_events, [&]() {
        if constexpr (Kokkos::Execution::Impl::has_non_blocking_dispatch<TEST_EXECUTION_SPACE>) {
            return testing::ElementsAre(
                MATCHER_FOR_BEGIN_PFOR(exec, dispatch_label(exec, "bulk")),
                MATCHER_FOR_RECORD_EVENT(exec),
                MATCHER_FOR_WAIT_EVENT(recorded_events.at(1)));
        } else {
            return testing::ElementsAre(
                MATCHER_FOR_BEGIN_PFOR(exec, dispatch_label(exec, "bulk")),
                MATCHER_FOR_BEGIN_FENCE(exec, dispatch_label(exec, "after dispatch")));
        }
    }());
 
    ASSERT_EQ(data(), size / 2 * (size - 1));
 
    ASSERT_EQ(value, 42);
    ASSERT_EQ(count, 1);
}
 
} // namespace Tests::ExecutionSpaceImpl