Files
lammps/lib/kokkos/algorithms/unit_tests/TestStdAlgorithmsTeamExclusiveScan.cpp
2023-11-21 15:02:12 -07:00

254 lines
9.0 KiB
C++

//@HEADER
// ************************************************************************
//
// Kokkos v. 4.0
// Copyright (2022) National Technology & Engineering
// Solutions of Sandia, LLC (NTESS).
//
// Under the terms of Contract DE-NA0003525 with NTESS,
// the U.S. Government retains certain rights in this software.
//
// Part of Kokkos, under the Apache License v2.0 with LLVM Exceptions.
// See https://kokkos.org/LICENSE for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//@HEADER
#include <TestStdAlgorithmsCommon.hpp>
namespace Test {
namespace stdalgos {
namespace TeamExclusiveScan {
namespace KE = Kokkos::Experimental;
template <class ValueType>
struct PlusFunctor {
KOKKOS_INLINE_FUNCTION constexpr ValueType operator()(
const ValueType& lhs, const ValueType& rhs) const {
return lhs + rhs;
}
};
template <class SourceViewType, class DestViewType, class DistancesViewType,
class IntraTeamSentinelView, class InitValuesViewType,
class BinaryOpType>
struct TestFunctorA {
SourceViewType m_sourceView;
DestViewType m_destView;
DistancesViewType m_distancesView;
IntraTeamSentinelView m_intraTeamSentinelView;
InitValuesViewType m_initValuesView;
BinaryOpType m_binaryOp;
int m_apiPick;
TestFunctorA(const SourceViewType sourceView, const DestViewType destView,
const DistancesViewType distancesView,
const IntraTeamSentinelView intraTeamSentinelView,
const InitValuesViewType initValuesView, BinaryOpType binaryOp,
int apiPick)
: m_sourceView(sourceView),
m_destView(destView),
m_distancesView(distancesView),
m_intraTeamSentinelView(intraTeamSentinelView),
m_initValuesView(initValuesView),
m_binaryOp(binaryOp),
m_apiPick(apiPick) {}
template <class MemberType>
KOKKOS_INLINE_FUNCTION void operator()(const MemberType& member) const {
const auto rowIndex = member.league_rank();
auto rowViewSrc = Kokkos::subview(m_sourceView, rowIndex, Kokkos::ALL());
auto rowViewDest = Kokkos::subview(m_destView, rowIndex, Kokkos::ALL());
const auto initVal = m_initValuesView(rowIndex);
ptrdiff_t resultDist = 0;
switch (m_apiPick) {
case 0: {
auto it = KE::exclusive_scan(member, KE::cbegin(rowViewSrc),
KE::cend(rowViewSrc),
KE::begin(rowViewDest), initVal);
resultDist = KE::distance(KE::begin(rowViewDest), it);
Kokkos::single(Kokkos::PerTeam(member),
[=, *this] { m_distancesView(rowIndex) = resultDist; });
break;
}
case 1: {
auto it = KE::exclusive_scan(member, rowViewSrc, rowViewDest, initVal);
resultDist = KE::distance(KE::begin(rowViewDest), it);
Kokkos::single(Kokkos::PerTeam(member),
[=, *this] { m_distancesView(rowIndex) = resultDist; });
break;
}
#if not defined KOKKOS_ENABLE_OPENMPTARGET
case 2: {
auto it = KE::exclusive_scan(
member, KE::cbegin(rowViewSrc), KE::cend(rowViewSrc),
KE::begin(rowViewDest), initVal, m_binaryOp);
resultDist = KE::distance(KE::begin(rowViewDest), it);
Kokkos::single(Kokkos::PerTeam(member),
[=, *this] { m_distancesView(rowIndex) = resultDist; });
break;
}
case 3: {
auto it = KE::exclusive_scan(member, rowViewSrc, rowViewDest, initVal,
m_binaryOp);
resultDist = KE::distance(KE::begin(rowViewDest), it);
Kokkos::single(Kokkos::PerTeam(member),
[=, *this] { m_distancesView(rowIndex) = resultDist; });
break;
}
#endif
}
// store result of checking if all members have their local
// values matching the one stored in m_distancesView
member.team_barrier();
const bool intraTeamCheck = team_members_have_matching_result(
member, resultDist, m_distancesView(rowIndex));
Kokkos::single(Kokkos::PerTeam(member), [=, *this]() {
m_intraTeamSentinelView(rowIndex) = intraTeamCheck;
});
}
};
template <class LayoutTag, class ValueType>
void test_A(std::size_t numTeams, std::size_t numCols, int apiId) {
/* description:
use a rank-2 view randomly filled with values,
and run a team-level exclusive_scan
*/
// -----------------------------------------------
// prepare data
// -----------------------------------------------
// create a view in the memory space associated with default exespace
// with as many rows as the number of teams and fill it with random
// values from an arbitrary range.
constexpr ValueType lowerBound = 5;
constexpr ValueType upperBound = 523;
const auto bounds = make_bounds(lowerBound, upperBound);
auto [sourceView, sourceViewBeforeOp_h] = create_random_view_and_host_clone(
LayoutTag{}, numTeams, numCols, bounds, "sourceView");
// -----------------------------------------------
// launch kokkos kernel
// -----------------------------------------------
using space_t = Kokkos::DefaultExecutionSpace;
Kokkos::TeamPolicy<space_t> policy(numTeams, Kokkos::AUTO());
// create the destination view
Kokkos::View<ValueType**> destView("destView", numTeams, numCols);
// exclusive_scan returns an iterator so to verify that it is correct
// each team stores the distance of the returned iterator from the beginning
// of the interval that team operates on and then we check that these
// distances match the std result
Kokkos::View<std::size_t*> distancesView("distancesView", numTeams);
// sentinel to check if all members of the team compute the same result
Kokkos::View<bool*> intraTeamSentinelView("intraTeamSameResult", numTeams);
PlusFunctor<ValueType> binaryOp;
// Create view of reduce init values to be used by test cases
Kokkos::View<ValueType*, Kokkos::DefaultHostExecutionSpace> initValuesView_h(
"initValuesView_h", numTeams);
using rand_pool =
Kokkos::Random_XorShift64_Pool<Kokkos::DefaultHostExecutionSpace>;
rand_pool pool(lowerBound * upperBound);
Kokkos::fill_random(initValuesView_h, pool, lowerBound, upperBound);
// use CTAD for functor
auto initValuesView =
Kokkos::create_mirror_view_and_copy(space_t(), initValuesView_h);
TestFunctorA fnc(sourceView, destView, distancesView, intraTeamSentinelView,
initValuesView, binaryOp, apiId);
Kokkos::parallel_for(policy, fnc);
// -----------------------------------------------
// run cpp-std kernel and check
// -----------------------------------------------
auto distancesView_h = create_host_space_copy(distancesView);
auto intraTeamSentinelView_h = create_host_space_copy(intraTeamSentinelView);
Kokkos::View<ValueType**, Kokkos::HostSpace> stdDestView("stdDestView",
numTeams, numCols);
for (std::size_t i = 0; i < sourceView.extent(0); ++i) {
auto rowFrom = Kokkos::subview(sourceViewBeforeOp_h, i, Kokkos::ALL());
auto rowDest = Kokkos::subview(stdDestView, i, Kokkos::ALL());
auto initValue = initValuesView_h(i);
ASSERT_TRUE(intraTeamSentinelView_h(i));
// libstdc++ as provided by GCC 8 does not have exclusive_scan and
// for GCC 9.1, 9.2 fails to compile for missing overload not accepting policy
#if defined(_GLIBCXX_RELEASE) && (_GLIBCXX_RELEASE <= 9)
#define exclusive_scan testing_exclusive_scan
#else
#define exclusive_scan std::exclusive_scan
#endif
switch (apiId) {
case 0:
case 1: {
auto it = exclusive_scan(KE::cbegin(rowFrom), KE::cend(rowFrom),
KE::begin(rowDest), initValue);
const std::size_t stdDistance = KE::distance(KE::begin(rowDest), it);
ASSERT_EQ(stdDistance, distancesView_h(i));
break;
}
#if not defined KOKKOS_ENABLE_OPENMPTARGET
case 2:
case 3: {
auto it = exclusive_scan(KE::cbegin(rowFrom), KE::cend(rowFrom),
KE::begin(rowDest), initValue, binaryOp);
const std::size_t stdDistance = KE::distance(KE::begin(rowDest), it);
ASSERT_EQ(stdDistance, distancesView_h(i));
break;
}
#endif
}
#undef exclusive_scan
}
auto dataViewAfterOp_h = create_host_space_copy(destView);
expect_equal_host_views(stdDestView, dataViewAfterOp_h);
}
template <class LayoutTag, class ValueType>
void run_all_scenarios() {
for (int numTeams : teamSizesToTest) {
for (const auto& numCols : {0, 1, 2, 13, 101, 1444, 8153}) {
#if not defined KOKKOS_ENABLE_OPENMPTARGET
for (int apiId : {0, 1, 2, 3}) {
#else
for (int apiId : {0, 1}) {
#endif
test_A<LayoutTag, ValueType>(numTeams, numCols, apiId);
}
}
}
}
TEST(std_algorithms_exclusive_scan_team_test, test) {
run_all_scenarios<DynamicTag, double>();
run_all_scenarios<StridedTwoRowsTag, int>();
run_all_scenarios<StridedThreeRowsTag, unsigned>();
}
} // namespace TeamExclusiveScan
} // namespace stdalgos
} // namespace Test