File: TestDynRankView_ViewCustomization.hpp

package info (click to toggle)
kokkos 5.0.1-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 15,140 kB
  • sloc: cpp: 225,293; sh: 1,250; python: 78; makefile: 16; fortran: 4; ansic: 2
file content (270 lines) | stat: -rw-r--r-- 9,438 bytes parent folder | download
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
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
// SPDX-FileCopyrightText: Copyright Contributors to the Kokkos project

#include <Kokkos_Macros.hpp>
#ifdef KOKKOS_ENABLE_EXPERIMENTAL_CXX20_MODULES
import kokkos.core;
#else
#include <Kokkos_Core.hpp>
#endif
#include <Kokkos_DynRankView.hpp>

// Duplicate from
// core/unit_test/view/TestViewCustomizationAccessorFromMapping.hpp
namespace Foo {

// ElementType which is actually just a tag type
struct BarStrided {};

// Reference type for Bar
struct BarRefStrided {
  double* ptr{nullptr};
  size_t size{0ul};
  size_t stride{0ul};
  KOKKOS_FUNCTION
  double& operator[](size_t idx) const { return ptr[idx * stride]; }
};

// A TestAccessor mimicking some of what Sacado does
// Specifically:
//   * returns a proxy reference
//   * the underlying storage is of some basic scalar type
//   * the size of the allocation does not actually come from
//   sizeof(ElementType)
template <class ElementType, class MemorySpace>
struct TestAccessorStrided {
  static_assert(std::is_same_v<std::remove_cv_t<ElementType>, BarStrided>);
  using element_type     = ElementType;
  using reference        = BarRefStrided;
  using data_handle_type = Kokkos::Impl::ReferenceCountedDataHandle<
      std::conditional_t<std::is_const_v<ElementType>, const double, double>,
      MemorySpace>;
  using offset_policy = TestAccessorStrided;

  // View expects this from accessors right now
  using memory_space = MemorySpace;

  KOKKOS_DEFAULTED_FUNCTION
  constexpr TestAccessorStrided() = default;

  template <class OtherElementType, class OtherMemorySpace,
            std::enable_if_t<std::is_constructible_v<
                                 Kokkos::default_accessor<element_type>,
                                 Kokkos::default_accessor<OtherElementType>>,
                             int> = 0>
  KOKKOS_FUNCTION constexpr TestAccessorStrided(
      const TestAccessorStrided<OtherElementType, OtherMemorySpace>&
          other) noexcept
      : size(other.size), stride(other.stride) {}

  KOKKOS_FUNCTION
  TestAccessorStrided(const size_t val, const size_t s_val)
      : size(val), stride(s_val) {}

  KOKKOS_FUNCTION
  constexpr reference access(
#ifndef KOKKOS_ENABLE_OPENACC
      const data_handle_type& p,
#else
      // FIXME OPENACC: illegal address when passing by reference
      data_handle_type p,
#endif
      size_t i) const noexcept {
    return BarRefStrided{(p.get() + i), size, stride};
  }

  KOKKOS_FUNCTION
  constexpr typename offset_policy::data_handle_type offset(
#ifndef KOKKOS_ENABLE_OPENACC
      const data_handle_type& p,
#else
      // FIXME OPENACC: illegal address when passing by reference
      data_handle_type p,
#endif
      size_t i) const noexcept {
    return p + i;
  }

  size_t size{0lu};
  size_t stride{0lu};
};

// Use the customization point to inject the custom accessor
template <class LayoutType, class DeviceType, class MemoryTraits>
constexpr auto customize_view_arguments(
    Kokkos::Impl::ViewArguments<BarStrided, LayoutType, DeviceType,
                                MemoryTraits>) {
  return Kokkos::Impl::ViewCustomArguments<
      size_t,
      TestAccessorStrided<BarStrided, typename DeviceType::memory_space>>{};
}

template <class LayoutType, class DeviceType, class MemoryTraits>
constexpr auto customize_view_arguments(
    Kokkos::Impl::ViewArguments<const BarStrided, LayoutType, DeviceType,
                                MemoryTraits>) {
  return Kokkos::Impl::ViewCustomArguments<
      size_t, TestAccessorStrided<const BarStrided,
                                  typename DeviceType::memory_space>>{};
}

// Customization point to compute allocation sizes
template <class MappingType, class ElementType, class MemorySpace>
KOKKOS_INLINE_FUNCTION size_t allocation_size_from_mapping_and_accessor(
    const MappingType& map,
    const TestAccessorStrided<ElementType, MemorySpace>& acc) {
  return map.required_span_size() * acc.size;
}

// Customization point to create accessor from AccessorArg and Mapping
template <class ElementType, class MemorySpace, class MappingType>
KOKKOS_INLINE_FUNCTION constexpr auto accessor_from_mapping_and_accessor_arg(
    Kokkos::Impl::AccessorTypeTag<
        TestAccessorStrided<ElementType, MemorySpace>>,
    const MappingType& map, const Kokkos::Impl::AccessorArg_t& acc_arg) {
  return TestAccessorStrided<ElementType, MemorySpace>{
      acc_arg.value, map.required_span_size()};
}
}  // namespace Foo

// This tests the ability to pass in the accessor arg
// as an additional integral argument to constructor and shmem_size
TEST(TEST_CATEGORY, view_customization_extra_int_arg) {
  using view_t = Kokkos::DynRankView<Foo::BarStrided, TEST_EXECSPACE>;
  // Rank 0
  {
    view_t a("A", 5);
    ASSERT_EQ(a.rank(), 0lu);
    ASSERT_EQ(a.accessor().size, size_t(5));
    ASSERT_EQ(a.accessor().stride, size_t(1));

    view_t b(a.data(), 5);
    ASSERT_EQ(b.rank(), 0lu);
    ASSERT_EQ(b.accessor().size, 5lu);
    ASSERT_EQ(b.accessor().stride, 1lu);
    size_t shmem               = view_t::shmem_size(5);
    size_t expected_shmem_size = 5lu * sizeof(double) + sizeof(double);
    ASSERT_EQ(shmem, expected_shmem_size);
  }
  // Rank 3
  {
    view_t a("A", 3, 7, 11, 5);
    ASSERT_EQ(a.rank(), 3lu);
    ASSERT_EQ(a.extent(0), 3lu);
    ASSERT_EQ(a.extent(1), 7lu);
    ASSERT_EQ(a.extent(2), 11lu);
    ASSERT_EQ(a.accessor().size, 5lu);
    ASSERT_EQ(a.accessor().stride, size_t(3 * 7 * 11));

    view_t b(a.data(), 3, 7, 11, 5);
    ASSERT_EQ(b.rank(), 3lu);
    ASSERT_EQ(b.extent(0), 3lu);
    ASSERT_EQ(b.extent(1), 7lu);
    ASSERT_EQ(b.extent(2), 11lu);
    ASSERT_EQ(b.accessor().size, 5lu);
    ASSERT_EQ(b.accessor().stride, size_t(3 * 7 * 11));
    size_t shmem = view_t::shmem_size(3, 7, 11, 5);
    size_t expected_shmem_size =
        3lu * 7lu * 11lu * 5lu * sizeof(double) + sizeof(double);
    ASSERT_EQ(shmem, expected_shmem_size);
  }
  // Rank 6
  {
    view_t a("A", 2, 3, 2, 7, 2, 11, 5);
    ASSERT_EQ(a.rank(), 6lu);
    ASSERT_EQ(a.extent(0), 2lu);
    ASSERT_EQ(a.extent(1), 3lu);
    ASSERT_EQ(a.extent(2), 2lu);
    ASSERT_EQ(a.extent(3), 7lu);
    ASSERT_EQ(a.extent(4), 2lu);
    ASSERT_EQ(a.extent(5), 11lu);
    ASSERT_EQ(a.accessor().size, 5lu);
    ASSERT_EQ(a.accessor().stride, size_t(8 * 3 * 7 * 11));
    view_t b(a.data(), 2, 3, 2, 7, 2, 11, 5);
    ASSERT_EQ(b.rank(), 6lu);
    ASSERT_EQ(b.extent(0), 2lu);
    ASSERT_EQ(b.extent(1), 3lu);
    ASSERT_EQ(b.extent(2), 2lu);
    ASSERT_EQ(b.extent(3), 7lu);
    ASSERT_EQ(b.extent(4), 2lu);
    ASSERT_EQ(b.extent(5), 11lu);
    ASSERT_EQ(b.accessor().size, 5lu);
    ASSERT_EQ(b.accessor().stride, size_t(8 * 3 * 7 * 11));
    size_t shmem = view_t::shmem_size(2, 3, 2, 7, 2, 11, 5);
    size_t expected_shmem_size =
        2lu * 3lu * 2lu * 7lu * 2lu * 11lu * 5lu * sizeof(double) +
        sizeof(double);
    ASSERT_EQ(shmem, expected_shmem_size);
  }
  // Rank 7
  {
    view_t a("A", 2, 3, 2, 7, 2, 11, 2, 5);
    ASSERT_EQ(a.rank(), 7lu);
    ASSERT_EQ(a.extent(0), 2lu);
    ASSERT_EQ(a.extent(1), 3lu);
    ASSERT_EQ(a.extent(2), 2lu);
    ASSERT_EQ(a.extent(3), 7lu);
    ASSERT_EQ(a.extent(4), 2lu);
    ASSERT_EQ(a.extent(5), 11lu);
    ASSERT_EQ(a.extent(2), 2lu);
    ASSERT_EQ(a.accessor().size, 5lu);
    ASSERT_EQ(a.accessor().stride, size_t(16 * 3 * 7 * 11));
    view_t b(a.data(), 2, 3, 2, 7, 2, 11, 2, 5);
    ASSERT_EQ(b.rank(), 7lu);
    ASSERT_EQ(b.extent(0), 2lu);
    ASSERT_EQ(b.extent(1), 3lu);
    ASSERT_EQ(b.extent(2), 2lu);
    ASSERT_EQ(b.extent(3), 7lu);
    ASSERT_EQ(b.extent(4), 2lu);
    ASSERT_EQ(b.extent(5), 11lu);
    ASSERT_EQ(b.extent(6), 2lu);
    ASSERT_EQ(b.accessor().size, 5lu);
    ASSERT_EQ(b.accessor().stride, size_t(16 * 3 * 7 * 11));
    size_t shmem = view_t::shmem_size(2, 3, 2, 7, 2, 11, 2, 5);
    size_t expected_shmem_size =
        2lu * 3lu * 2lu * 7lu * 2lu * 11lu * 2lu * 5lu * sizeof(double) +
        sizeof(double);
    ASSERT_EQ(shmem, expected_shmem_size);
  }
  // With accessor arg and no label
  {
    // This should not interpret the last argument (11) as an accessor arg since
    // we are providing AccessorArg_t explicitly
    // Note that with and without
    // labels are two separate cases
    view_t a(Kokkos::view_alloc(Kokkos::Impl::AccessorArg_t{5ul}), 3, 7, 11);
    ASSERT_EQ(a.rank(), 3lu);
    ASSERT_EQ(a.extent(0), 3lu);
    ASSERT_EQ(a.extent(1), 7lu);
    ASSERT_EQ(a.extent(2), 11lu);
    ASSERT_EQ(a.accessor().size, 5lu);
    ASSERT_EQ(a.accessor().stride, size_t(3 * 7 * 11));
  }
  // With accessor arg and label
  {
    // This should not interpret the last argument (11) as an accessor arg since
    // we are providing AccessorArg_t explicitly
    // Note that with and without
    // labels are two separate cases
    view_t a(Kokkos::view_alloc("A", Kokkos::Impl::AccessorArg_t{5ul}), 3, 7,
             11);
    ASSERT_EQ(a.rank(), 3lu);
    ASSERT_EQ(a.extent(0), 3lu);
    ASSERT_EQ(a.extent(1), 7lu);
    ASSERT_EQ(a.extent(2), 11lu);
    ASSERT_EQ(a.accessor().size, 5lu);
    ASSERT_EQ(a.accessor().stride, size_t(3 * 7 * 11));
  }
  // Create mirror
  {
    view_t a("A", 3, 7, 11, 5);

    auto b = Kokkos::create_mirror(a);
    ASSERT_EQ(b.rank(), 3lu);
    ASSERT_EQ(b.extent(0), 3lu);
    ASSERT_EQ(b.extent(1), 7lu);
    ASSERT_EQ(b.extent(2), 11lu);
    ASSERT_EQ(b.accessor().size, 5lu);
    ASSERT_EQ(b.accessor().stride, size_t(3 * 7 * 11));
  }
}