1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
// SPDX-FileCopyrightText: Copyright Contributors to the Kokkos project
#include <gtest/gtest.h>
#include <Kokkos_Macros.hpp>
#ifdef KOKKOS_ENABLE_EXPERIMENTAL_CXX20_MODULES
import kokkos.core;
import kokkos.core_impl;
#else
#include <Kokkos_Core.hpp>
#endif
#include <regex>
#include <limits>
#include <type_traits>
namespace {
TEST(TEST_CATEGORY, range_policy_runtime_parameters) {
using Policy = Kokkos::RangePolicy<>;
using Index = Policy::index_type;
Index work_begin = 5;
Index work_end = 15;
Index chunk_size = 10;
{
Policy p(work_begin, work_end);
ASSERT_EQ(p.begin(), work_begin);
ASSERT_EQ(p.end(), work_end);
}
{
Policy p(Kokkos::DefaultExecutionSpace(), work_begin, work_end);
ASSERT_EQ(p.begin(), work_begin);
ASSERT_EQ(p.end(), work_end);
}
{
Policy p(work_begin, work_end, Kokkos::ChunkSize(chunk_size));
ASSERT_EQ(p.begin(), work_begin);
ASSERT_EQ(p.end(), work_end);
ASSERT_EQ(p.chunk_size(), chunk_size);
}
{
Policy p(Kokkos::DefaultExecutionSpace(), work_begin, work_end,
Kokkos::ChunkSize(chunk_size));
ASSERT_EQ(p.begin(), work_begin);
ASSERT_EQ(p.end(), work_end);
ASSERT_EQ(p.chunk_size(), chunk_size);
}
{
Policy p; // default-constructed
ASSERT_EQ(p.begin(), Index(0));
ASSERT_EQ(p.end(), Index(0));
ASSERT_EQ(p.chunk_size(), Index(0));
// copy-assigned
p = Policy(work_begin, work_end, Kokkos::ChunkSize(chunk_size));
ASSERT_EQ(p.begin(), work_begin);
ASSERT_EQ(p.end(), work_end);
ASSERT_EQ(p.chunk_size(), chunk_size);
}
{
Policy p1(work_begin, work_end, Kokkos::ChunkSize(chunk_size));
Policy p2(p1); // copy-constructed
ASSERT_EQ(p1.begin(), p2.begin());
ASSERT_EQ(p1.end(), p2.end());
ASSERT_EQ(p1.chunk_size(), p2.chunk_size());
}
}
TEST(TEST_CATEGORY_DEATH, range_policy_invalid_bounds) {
::testing::FLAGS_gtest_death_test_style = "threadsafe";
using Policy = Kokkos::RangePolicy<TEST_EXECSPACE>;
using ChunkSize = Kokkos::ChunkSize;
std::string msg =
"Kokkos::RangePolicy bounds error: The lower bound (100) is greater than "
"the upper bound (90).\n";
#ifndef KOKKOS_ENABLE_DEPRECATED_CODE_4
// escape the parentheses in the regex to match the error message
msg = std::regex_replace(msg, std::regex("\\(|\\)"), "\\$&");
ASSERT_DEATH({ (void)Policy(100, 90); }, msg);
ASSERT_DEATH({ (void)Policy(TEST_EXECSPACE(), 100, 90, ChunkSize(10)); },
msg);
#else
if (!Kokkos::show_warnings()) {
GTEST_SKIP() << "Kokkos warning messages are disabled";
}
{
::testing::internal::CaptureStderr();
Policy policy(100, 90);
ASSERT_EQ((int)policy.begin(), 0);
ASSERT_EQ((int)policy.end(), 0);
#ifdef KOKKOS_ENABLE_DEPRECATION_WARNINGS
ASSERT_EQ(::testing::internal::GetCapturedStderr(), msg);
#else
ASSERT_TRUE(::testing::internal::GetCapturedStderr().empty());
(void)msg;
#endif
}
{
::testing::internal::CaptureStderr();
Policy policy(TEST_EXECSPACE(), 100, 90, ChunkSize(10));
ASSERT_EQ((int)policy.begin(), 0);
ASSERT_EQ((int)policy.end(), 0);
#ifdef KOKKOS_ENABLE_DEPRECATION_WARNINGS
ASSERT_EQ(::testing::internal::GetCapturedStderr(), msg);
#else
ASSERT_TRUE(::testing::internal::GetCapturedStderr().empty());
(void)msg;
#endif
}
#endif
}
struct W { // round-trip conversion check for narrowing should "fire"
W(int const* ptr) : val_(*ptr) {}
W(int) : val_(0) {}
operator int() const { return val_; }
int val_;
};
TEST(TEST_CATEGORY_DEATH, range_policy_round_trip_conversion_fires) {
::testing::FLAGS_gtest_death_test_style = "threadsafe";
using Policy = Kokkos::RangePolicy<>;
static_assert(std::is_convertible_v<W, Policy::index_type>);
static_assert(std::is_convertible_v<Policy::index_type, W>);
int const n = 1;
[[maybe_unused]] std::string msg =
"Kokkos::RangePolicy bound type error: an unsafe implicit conversion is "
"performed";
#ifndef KOKKOS_ENABLE_DEPRECATED_CODE_4
ASSERT_DEATH((void)Policy(0, W(&n)), msg);
#else
::testing::internal::CaptureStderr();
(void)Policy(0, W(&n));
auto s = std::string(::testing::internal::GetCapturedStderr());
#ifdef KOKKOS_ENABLE_DEPRECATION_WARNINGS
if (Kokkos::show_warnings()) {
ASSERT_NE(s.find(msg), std::string::npos) << msg;
} else
#endif
ASSERT_TRUE(s.empty());
#endif
}
struct B { // round-trip conversion would not compile
B(int const* ptr) : val_(*ptr) {}
operator int() const { return val_; }
int val_;
};
TEST(TEST_CATEGORY, range_policy_one_way_convertible_bounds) {
using Policy = Kokkos::RangePolicy<>;
using IndexType = Policy::index_type;
static_assert(std::is_convertible_v<B, IndexType>);
static_assert(!std::is_convertible_v<IndexType, B>);
int const n = 1;
Policy policy(0, B(&n));
EXPECT_EQ(policy.begin(), static_cast<IndexType>(0));
EXPECT_EQ(policy.end(), static_cast<IndexType>(1));
}
TEST(TEST_CATEGORY_DEATH, range_policy_check_sign_changes) {
::testing::FLAGS_gtest_death_test_style = "threadsafe";
using UInt32Policy =
Kokkos::RangePolicy<TEST_EXECSPACE, Kokkos::IndexType<std::uint32_t>>;
[[maybe_unused]] std::string msg =
"Kokkos::RangePolicy bound type error: an unsafe implicit conversion is "
"performed";
#ifndef KOKKOS_ENABLE_DEPRECATED_CODE_4
{
std::int64_t n = std::numeric_limits<std::int64_t>::max();
ASSERT_DEATH((void)UInt32Policy(0, n), msg);
}
{
std::int64_t n = std::numeric_limits<std::int64_t>::min();
ASSERT_DEATH((void)UInt32Policy(n, 0), msg);
}
#else
{
::testing::internal::CaptureStderr();
std::int64_t n = std::numeric_limits<std::int64_t>::max();
(void)UInt32Policy(0, n);
auto s = std::string(::testing::internal::GetCapturedStderr());
#ifdef KOKKOS_ENABLE_DEPRECATION_WARNINGS
if (Kokkos::show_warnings()) {
ASSERT_NE(s.find(msg), std::string::npos) << msg;
}
#endif
}
{
::testing::internal::CaptureStderr();
std::int64_t n = std::numeric_limits<std::int64_t>::min();
(void)UInt32Policy(n, 0);
auto s = std::string(::testing::internal::GetCapturedStderr());
#ifdef KOKKOS_ENABLE_DEPRECATION_WARNINGS
if (Kokkos::show_warnings()) {
ASSERT_NE(s.find(msg), std::string::npos) << msg;
}
#endif
}
#endif
}
TEST(TEST_CATEGORY_DEATH, range_policy_implicitly_converted_bounds) {
using UIntIndexType = Kokkos::IndexType<unsigned>;
using IntIndexType = Kokkos::IndexType<int>;
using UIntPolicy = Kokkos::RangePolicy<TEST_EXECSPACE, UIntIndexType>;
using IntPolicy = Kokkos::RangePolicy<TEST_EXECSPACE, IntIndexType>;
std::string msg =
"Kokkos::RangePolicy bound type error: an unsafe implicit conversion is "
"performed on a bound (), which may not preserve its original value.\n";
[[maybe_unused]] auto get_error_msg = [](auto str, auto val) {
return str.insert(str.find("(") + 1, std::to_string(val).c_str());
};
#ifndef KOKKOS_ENABLE_DEPRECATED_CODE_4
::testing::FLAGS_gtest_death_test_style = "threadsafe";
std::string expected = std::regex_replace(msg, std::regex("\\(|\\)"), "\\$&");
{
int test_val = -1;
ASSERT_DEATH({ (void)UIntPolicy(test_val, 10); },
get_error_msg(expected, test_val));
}
{
unsigned test_val = std::numeric_limits<unsigned>::max();
ASSERT_DEATH({ (void)IntPolicy(0u, test_val); },
get_error_msg(expected, test_val));
}
{
long long test_val = std::numeric_limits<long long>::max();
ASSERT_DEATH({ (void)IntPolicy(0LL, test_val); },
get_error_msg(expected, test_val));
}
{
int test_val = -1;
ASSERT_DEATH({ (void)UIntPolicy(test_val, 10, Kokkos::ChunkSize(2)); },
get_error_msg(expected, test_val));
}
#else
{
::testing::internal::CaptureStderr();
int test_val = -1;
UIntPolicy policy(test_val, 10);
ASSERT_EQ(policy.begin(), 0u);
ASSERT_EQ(policy.end(), 0u);
#ifdef KOKKOS_ENABLE_DEPRECATION_WARNINGS
if (Kokkos::show_warnings()) {
auto s = std::string(::testing::internal::GetCapturedStderr());
ASSERT_EQ(s.substr(0, s.find("\n") + 1), get_error_msg(msg, test_val));
}
#else
ASSERT_TRUE(::testing::internal::GetCapturedStderr().empty());
(void)msg;
(void)get_error_msg;
#endif
}
{
::testing::internal::CaptureStderr();
unsigned test_val = std::numeric_limits<unsigned>::max();
IntPolicy policy(0u, test_val);
ASSERT_EQ(policy.begin(), 0);
ASSERT_EQ(policy.end(), 0);
#ifdef KOKKOS_ENABLE_DEPRECATION_WARNINGS
if (Kokkos::show_warnings()) {
auto s = std::string(::testing::internal::GetCapturedStderr());
ASSERT_EQ(s.substr(0, s.find("\n") + 1), get_error_msg(msg, test_val));
}
#else
ASSERT_TRUE(::testing::internal::GetCapturedStderr().empty());
(void)msg;
(void)get_error_msg;
#endif
}
#endif
}
constexpr bool test_chunk_size_explicit() {
using ExecutionSpace = TEST_EXECSPACE;
using Kokkos::ChunkSize;
#ifdef KOKKOS_ENABLE_DEPRECATED_CODE_4
static_assert(std::is_convertible_v<int, ChunkSize>);
static_assert(std::is_constructible_v<ChunkSize, int>);
// Some execution spaces were implicitly constructible from int
// which made the constructor call ambiguous.
static_assert(
std::is_constructible_v<Kokkos::DefaultExecutionSpace, int> ||
std::is_constructible_v<
Kokkos::RangePolicy<Kokkos::DefaultExecutionSpace>, int, int, int>);
static_assert(std::is_constructible_v<
Kokkos::RangePolicy<Kokkos::DefaultExecutionSpace>, int, int,
ChunkSize>);
static_assert(std::is_constructible_v<Kokkos::RangePolicy<ExecutionSpace>,
ExecutionSpace, int, int, int>);
static_assert(std::is_constructible_v<Kokkos::RangePolicy<ExecutionSpace>,
ExecutionSpace, int, int, ChunkSize>);
#else
static_assert(!std::is_convertible_v<int, ChunkSize>);
static_assert(std::is_constructible_v<ChunkSize, int>);
static_assert(
!std::is_constructible_v<
Kokkos::RangePolicy<Kokkos::DefaultExecutionSpace>, int, int, int>);
static_assert(std::is_constructible_v<
Kokkos::RangePolicy<Kokkos::DefaultExecutionSpace>, int, int,
ChunkSize>);
static_assert(!std::is_constructible_v<Kokkos::RangePolicy<ExecutionSpace>,
ExecutionSpace, int, int, int>);
static_assert(std::is_constructible_v<Kokkos::RangePolicy<ExecutionSpace>,
ExecutionSpace, int, int, ChunkSize>);
#endif
return true;
}
static_assert(test_chunk_size_explicit());
// The execution space is defaulted if not given to the constructor.
TEST(TEST_CATEGORY, range_policy_default_space) {
using policy_t = Kokkos::RangePolicy<TEST_EXECSPACE>;
policy_t defaulted(42, 666);
ASSERT_EQ(defaulted.space(), TEST_EXECSPACE{});
}
// The execution space instance can be updated.
TEST(TEST_CATEGORY, range_policy_impl_set_space) {
using policy_t = Kokkos::RangePolicy<TEST_EXECSPACE>;
const auto [exec_old, exec_new] =
Kokkos::Experimental::partition_space(TEST_EXECSPACE{}, 1, 1);
const policy_t policy_old(exec_old, 42, 666);
ASSERT_EQ(policy_old.space(), exec_old);
const policy_t policy_new(Kokkos::Impl::PolicyUpdate{}, policy_old, exec_new);
ASSERT_EQ(policy_new.space(), exec_new);
ASSERT_EQ(policy_new.begin(), 42);
ASSERT_EQ(policy_new.end(), 666);
}
} // namespace
|