Develop stream 2024-09-12

CHANGELOG.md

@@ -9,6 +9,10 @@ Documentation for rocThrust available at
 
 * Merged changes from upstream CCCL/thrust 2.4.0
 
+### Changes
+
+* Split the contents of HIPSTDPAR's forwarding header into several implementation headers.
+
 ## (Unreleased) rocThrust 3.2.0 for ROCm 6.3
 
 ### Additions
@@ -33,6 +37,7 @@ Documentation for rocThrust available at
 
 * Merged changes from upstream CCCL/thrust 2.2.0
   * Updated the contents of `system/hip` and `test` with the upstream changes to `system/cuda` and `testing`
+* Added HIPSTDPAR library as part of rocThrust.
 
 ### Changes
 

README.md

@@ -9,7 +9,7 @@ works on HIP and ROCm software. Currently there is no CUDA backend in place.
 
 Software requirements include:
 
-* CMake (3.5.1 or later)
+* CMake (3.10.2 or later)
 * AMD [ROCm](https://rocm.docs.amd.com) Software (1.8.0 or later)
   * Including the [HipCC](https://github.com/ROCm/HIP) compiler, which must be set
     as your C++ compiler for ROCm
@@ -266,6 +266,39 @@ make -j4
 ./benchmarks/benchmark_thrust_bench
 ```
 
+## HIPSTDPAR
+rocThrust also hosts the header files for [HIPSTDPAR](https://rocm.blogs.amd.com/software-tools-optimization/hipstdpar/README.html#c-17-parallel-algorithms-and-hipstdpar).
+Within these headers, a great part of the C++ Standard Library parallel algorithms are overloaded so that rocThrust's and rocPRIM's implementations of those algorithms are used when they are invoked with the `parallel_unsequenced_policy` policy.
+When compiling with the proper flags (see [LLVM (AMD's fork) docs](https://github.com/ROCm/llvm-project/blob/rocm-6.2.x/clang/docs/HIPSupport.rst#implementation-driver) for the complete list), the HIPSTDPAR headers are implicitly included by the compiler, and therefore the execution of these parallel algorithms will be offloaded to AMD devices.
+
+### Install
+HIPSTDPAR is currently packaged along rocThrust. The `hipstdpar` package is set up as a virtual package provided by `rocthrust`, so the latter needs to be installed entirely for getting HIPSTDPAR's headers. Conversely, installing the `rocthrust` package will also include HIPSTDPAR's headers in the system.
+
+### Tests
+rocThrust also includes some tests for checking the correct building of HIPSTDPAR implementations. These are located under the [tests/hipstdpar](/test/hipstdpar/) folder. When configuring the project with the `BUILD_TEST` option on, these tests will also be enabled. Additionally, one can configure **only** HIPSTDPAR's tests by disabling `BUILD_TEST` and enabling `BUILD_HIPSTDPAR_TEST`. In general, the following steps can be followed for building and running the tests:
+
+```sh
+git clone https://github.com/ROCm/rocThrust
+
+# Go to rocThrust directory, create and go to the build directory.
+cd rocThrust; mkdir build; cd build
+
+# Configure rocThrust.
+[CXX=hipcc] cmake ../. -D BUILD_TEST=ON # Configure rocThrust's and HIPSTDPAR's tests.
+[CXX=hipcc] cmake ../. -D BUILD_TEST=OFF -D BUILD_HIPSTDPAR_TEST=ON # Only configure HIPSTDPAR's tests.
+
+# Build
+make -j4
+
+# Run tests.
+ctest --output-on-failure
+```
+
+#### Requirements
+* [rocPRIM](https://github.com/ROCm/rocPRIM) and [rocThrust](https://github.com/ROCm/rocThrust) libraries
+* [TBB](https://www.intel.com/content/www/us/en/developer/tools/oneapi/onetbb.html) library
+* CMake (3.10.2 or later)
+
 ## Support
 
 You can report bugs and feature requests through the GitHub