Add oneDPL external and add its tests

Author: beomki-yeo

CMakeLists.txt

@@ -138,6 +138,22 @@ if( TRACCC_SETUP_TBB )
    endif()
 endif()
 
+# Set up DPL if SYCL is built.
+if( TRACCC_BUILD_SYCL )
+   option( TRACCC_SETUP_DPL
+      "Set up the DPL target(s) explicitly" TRUE )
+   option( TRACCC_USE_SYSTEM_DPL
+      "Pick up an existing installation of DPL from the build environment"
+      ${TRACCC_USE_SYSTEM_LIBS} )
+   if( TRACCC_SETUP_DPL )
+      if( TRACCC_USE_SYSTEM_DPL )
+         find_package( DPL REQUIRED )
+      else()
+      add_subdirectory( extern/dpl )
+      endif()
+   endif()
+endif()
+
 # Set up Kokkos.
 option( TRACCC_SETUP_KOKKOS
    "Set up the Kokkos library" ${TRACCC_BUILD_KOKKOS} )

extern/dpl/CMakeLists.txt

@@ -0,0 +1,30 @@
+# TRACCC library, part of the ACTS project (R&D line)
+#
+# (c) 2023 CERN for the benefit of the ACTS project
+#
+# Mozilla Public License Version 2.0
+
+# CMake include(s).
+cmake_minimum_required( VERSION 3.14 )
+include( FetchContent )
+
+# Silence FetchContent warnings with CMake >=3.24.
+if( POLICY CMP0135 )
+   cmake_policy( SET CMP0135 NEW )
+endif()
+
+# Tell the user what's happening.
+message( STATUS "Building oneDPL as part of the TRACCC project" )
+
+# Declare where to get DPL from.
+set( TRACCC_DPL_SOURCE
+   "URL;https://github.com/oneapi-src/oneDPL/archive/refs/tags/oneDPL-2022.0.0-release.tar.gz;URL_MD5;46b60bd87325042df716d1df4686eb3b"
+   CACHE STRING "Source for DPL, when built as part of this project" )
+mark_as_advanced( TRACCC_DPL_SOURCE )
+FetchContent_Declare( DPL ${TRACCC_DPL_SOURCE} )
+
+# Exclude TBB
+set( ONEDPL_BACKEND dpcpp_only )
+
+# Get it into the current directory.
+FetchContent_MakeAvailable( DPL )

extern/dpl/README.md

@@ -0,0 +1,4 @@
+# Build Recipe for oneDPL
+
+This directory holds a build recipe for building
+[DPL](https://github.com/oneapi-src/oneDPL) for this project.

tests/sycl/CMakeLists.txt

@@ -12,6 +12,7 @@ traccc_add_test(
     sycl
 
     # Define the sources for the test.
+    test_dpl.sycl
     test_kalman_filter.sycl
 
     LINK_LIBRARIES
@@ -25,4 +26,5 @@ traccc_add_test(
     traccc::performance
     traccc::io
     traccc_tests_common
+    oneDPL
 )

tests/sycl/test_dpl.sycl

@@ -0,0 +1,114 @@
+/** TRACCC library, part of the ACTS project (R&D line)
+ *
+ * (c) 2023 CERN for the benefit of the ACTS project
+ *
+ * Mozilla Public License Version 2.0
+ */
+
+// SYCL include(s).
+#include <CL/sycl.hpp>
+
+// VecMem include(s).
+#include <vecmem/containers/data/vector_buffer.hpp>
+#include <vecmem/containers/device_vector.hpp>
+#include <vecmem/memory/host_memory_resource.hpp>
+#include <vecmem/memory/sycl/device_memory_resource.hpp>
+#include <vecmem/utils/sycl/copy.hpp>
+
+// DPL include(s).
+#include <oneapi/dpl/algorithm>
+#include <oneapi/dpl/execution>
+
+// GTest include(s).
+#include <gtest/gtest.h>
+
+namespace {
+
+// Simple asynchronous handler function
+auto handle_async_error = [](::sycl::exception_list elist) {
+    for (auto& e : elist) {
+        try {
+            std::rethrow_exception(e);
+        } catch (::sycl::exception& e) {
+            std::cout << "ASYNC EXCEPTION!!\n";
+            std::cout << e.what() << "\n";
+        }
+    }
+};
+
+::sycl::queue q(handle_async_error);
+vecmem::sycl::copy copy{&q};
+vecmem::host_memory_resource host_resource;
+vecmem::sycl::device_memory_resource device_resource;
+
+}  // namespace
+
+TEST(dpl, sort) {
+
+    vecmem::vector<unsigned int> host_vector{{3, 2, 1, 8, 4}, &host_resource};
+
+    auto host_buffer = vecmem::get_data(host_vector);
+    auto device_buffer = copy.to(vecmem::get_data(host_vector), device_resource,
+                                 vecmem::copy::type::host_to_device);
+
+    vecmem::device_vector<unsigned int> device_vector(device_buffer);
+
+    oneapi::dpl::sort(oneapi::dpl::execution::dpcpp_default,
+                      device_vector.begin(), device_vector.end());
+
+    copy(device_buffer, host_buffer, vecmem::copy::type::device_to_host);
+
+    ASSERT_EQ(host_vector[0], 1);
+    ASSERT_EQ(host_vector[1], 2);
+    ASSERT_EQ(host_vector[2], 3);
+    ASSERT_EQ(host_vector[3], 4);
+    ASSERT_EQ(host_vector[4], 8);
+}
+
+TEST(dpl, scan) {
+
+    vecmem::vector<unsigned int> host_vector{{3, 2, 1, 8, 4}, &host_resource};
+
+    auto host_buffer = vecmem::get_data(host_vector);
+    auto device_buffer = copy.to(vecmem::get_data(host_vector), device_resource,
+                                 vecmem::copy::type::host_to_device);
+
+    vecmem::device_vector<unsigned int> device_vector(device_buffer);
+
+    oneapi::dpl::inclusive_scan(oneapi::dpl::execution::dpcpp_default,
+                                device_vector.begin(), device_vector.end(),
+                                device_vector.begin());
+
+    copy(device_buffer, host_buffer, vecmem::copy::type::device_to_host);
+
+    ASSERT_EQ(host_vector[0], 3);
+    ASSERT_EQ(host_vector[1], 5);
+    ASSERT_EQ(host_vector[2], 6);
+    ASSERT_EQ(host_vector[3], 14);
+    ASSERT_EQ(host_vector[4], 18);
+}
+
+TEST(dpl, fill) {
+
+    vecmem::vector<unsigned int> host_vector{{1, 1, 1, 1, 1, 1, 1},
+                                             &host_resource};
+
+    auto host_buffer = vecmem::get_data(host_vector);
+    auto device_buffer = copy.to(vecmem::get_data(host_vector), device_resource,
+                                 vecmem::copy::type::host_to_device);
+
+    vecmem::device_vector<unsigned int> device_vector(device_buffer);
+
+    oneapi::dpl::fill(oneapi::dpl::execution::dpcpp_default,
+                      device_vector.begin(), device_vector.end(), 112);
+
+    copy(device_buffer, host_buffer, vecmem::copy::type::device_to_host);
+
+    ASSERT_EQ(host_vector[0], 112);
+    ASSERT_EQ(host_vector[1], 112);
+    ASSERT_EQ(host_vector[2], 112);
+    ASSERT_EQ(host_vector[3], 112);
+    ASSERT_EQ(host_vector[4], 112);
+    ASSERT_EQ(host_vector[5], 112);
+    ASSERT_EQ(host_vector[6], 112);
+}