1 /*
2 //@HEADER
3 // ************************************************************************
4 //
5 //                        Kokkos v. 3.0
6 //       Copyright (2020) National Technology & Engineering
7 //               Solutions of Sandia, LLC (NTESS).
8 //
9 // Under the terms of Contract DE-NA0003525 with NTESS,
10 // the U.S. Government retains certain rights in this software.
11 //
12 // Redistribution and use in source and binary forms, with or without
13 // modification, are permitted provided that the following conditions are
14 // met:
15 //
16 // 1. Redistributions of source code must retain the above copyright
17 // notice, this list of conditions and the following disclaimer.
18 //
19 // 2. Redistributions in binary form must reproduce the above copyright
20 // notice, this list of conditions and the following disclaimer in the
21 // documentation and/or other materials provided with the distribution.
22 //
23 // 3. Neither the name of the Corporation nor the names of the
24 // contributors may be used to endorse or promote products derived from
25 // this software without specific prior written permission.
26 //
27 // THIS SOFTWARE IS PROVIDED BY NTESS "AS IS" AND ANY
28 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL NTESS OR THE
31 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
32 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
33 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
34 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
35 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
36 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
37 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 //
39 // Questions? Contact Christian R. Trott (crtrott@sandia.gov)
40 //
41 // ************************************************************************
42 //@HEADER
43 */
44 
45 #include <Kokkos_Core.hpp>
46 #include <array>
47 #include <random>
48 #include <gtest/gtest.h>
49 
50 /// @Kokkos_Feature_Level_Required:17
51 // Incremental test for atomic views.
52 // In this test we sort N integers into num_buckets number of buckets based on
53 // their rermainder, i.e., a histogram based on remainder. Since the number of
54 // integers is greater than the number of buckets, we use atomic views for the
55 // sorted histogram.
56 
57 namespace Test {
58 
59 using value_type      = int;
60 const int N           = 1000;
61 const int num_buckets = 10;
62 
63 template <class ExecSpace>
64 struct TestAtomicView {
65   // 1D  View of int
66   using View = typename Kokkos::View<value_type *, ExecSpace>;
67 
68   // 1D atomic view
69   using atomic_view =
70       typename Kokkos::View<value_type *, ExecSpace,
71                             Kokkos::MemoryTraits<Kokkos::Atomic> >;
72 
atomicViewTest::TestAtomicView73   void atomicView() {
74     // Use default_random_engine object to introduce randomness.
75     std::default_random_engine generator;
76     // Initialize uniform_int_distribution class.
77     std::uniform_int_distribution<int> distribution(0, N);
78 
79     // Device and Host views of N number of integers
80     View d_data("deviceData_1D", N);
81     auto h_data = create_mirror_view(d_data);
82 
83     // Atomic Device and Host views of histogram
84     atomic_view d_hist("histogram", num_buckets);
85     auto h_hist = create_mirror_view(d_hist);
86 
87     // An array to store correct results for verification
88     std::array<int, num_buckets> correct_results;
89 
90     // Initialize host side histogram arrays
91     for (int i = 0; i < num_buckets; ++i) {
92       h_hist(i)          = 0;
93       correct_results[i] = 0;
94     }
95 
96     // Fill host data with integers from the distribution object.
97     for (int i = 0; i < N; ++i) h_data(i) = distribution(generator);
98 
99     // Copy data from host to device
100     Kokkos::deep_copy(d_data, h_data);
101     Kokkos::deep_copy(d_hist, h_hist);
102 
103     // Update histogram
104     Kokkos::parallel_for(
105         Kokkos::RangePolicy<ExecSpace>(0, N),
106         KOKKOS_LAMBDA(const int i) { d_hist(d_data(i) % num_buckets)++; });
107 
108     // Perform the same computation on host for correctness test.
109     for (int i = 0; i < N; ++i) correct_results[h_data(i) % num_buckets]++;
110 
111     // Copy the histogram back to host
112     Kokkos::deep_copy(h_hist, d_hist);
113 
114     // Validate results
115     for (int i = 0; i < num_buckets; ++i)
116       ASSERT_EQ(correct_results[i], h_hist(i));
117   }
118 };
119 
120 // atomic view tests
TEST(TEST_CATEGORY,incr_17_atomicView)121 TEST(TEST_CATEGORY, incr_17_atomicView) {
122   TestAtomicView<TEST_EXECSPACE> test;
123   test.atomicView();
124 }
125 
126 }  // namespace Test
127