Adds support for pulling cuCollections using rapids-cmake

docs/api.rst

@@ -44,6 +44,7 @@ package uses :ref:`can be found here. <cpm_versions>`
 .. toctree::
    :titlesonly:
 
+   /packages/rapids_cpm_cuco
    /packages/rapids_cpm_gtest
    /packages/rapids_cpm_libcudacxx
    /packages/rapids_cpm_nvbench

docs/packages/rapids_cpm_cuco.rst

@@ -0,0 +1 @@
+.. cmake-module:: ../../rapids-cmake/cpm/cuco.cmake

rapids-cmake/cpm/cuco.cmake

@@ -0,0 +1,86 @@
+#=============================================================================
+# Copyright (c) 2022, NVIDIA CORPORATION.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#=============================================================================
+include_guard(GLOBAL)
+
+#[=======================================================================[.rst:
+rapids_cpm_cuco
+---------------------
+
+.. versionadded:: v22.08.00
+
+Allow projects to find or build `cuCollections` via `CPM` with built-in
+tracking of these dependencies for correct export support.
+
+Uses the version of cuCollections :ref:`specified in the version file <cpm_versions>` for consistency
+across all RAPIDS projects.
+
+.. code-block:: cmake
+
+  rapids_cpm_cuco( [BUILD_EXPORT_SET <export-name>]
+                   [INSTALL_EXPORT_SET <export-name>]
+                   )
+
+``BUILD_EXPORT_SET``
+  Record that a :cmake:command:`CPMFindPackage(cuco)` call needs to occur as part of
+  our build directory export set.
+
+``INSTALL_EXPORT_SET``
+  Record a :cmake:command:`find_dependency(cuco) <cmake:module:CMakeFindDependencyMacro>` call needs to occur as part of
+  our install directory export set.
+
+Result Targets
+^^^^^^^^^^^^^^
+  cuco::cuco target will be created
+
+#]=======================================================================]
+function(rapids_cpm_cuco)
+  list(APPEND CMAKE_MESSAGE_CONTEXT "rapids.cpm.cuco")
+
+  set(options)
+  set(one_value INSTALL_EXPORT_SET)
+  set(multi_value)
+  cmake_parse_arguments(_RAPIDS "${options}" "${one_value}" "${multi_value}" ${ARGN})
+
+  # Fix up _RAPIDS_UNPARSED_ARGUMENTS to have INSTALL_EXPORT_SET as this is need for rapids_cpm_find
+  if(_RAPIDS_INSTALL_EXPORT_SET)
+    list(APPEND _RAPIDS_UNPARSED_ARGUMENTS INSTALL_EXPORT_SET ${_RAPIDS_INSTALL_EXPORT_SET})
+  endif()
+
+  include("${rapids-cmake-dir}/cpm/detail/package_details.cmake")
+  rapids_cpm_package_details(cuco version repository tag shallow exclude)
+
+  set(to_exclude OFF)
+  if(NOT _RAPIDS_INSTALL_EXPORT_SET OR exclude)
+    set(to_exclude ON)
+  endif()
+
+  include("${rapids-cmake-dir}/cpm/find.cmake")
+  rapids_cpm_find(cuco ${version} ${_RAPIDS_UNPARSED_ARGUMENTS}
+                  GLOBAL_TARGETS cuco::cuco
+                  CPM_ARGS
+                  GIT_REPOSITORY ${repository}
+                  GIT_TAG ${tag}
+                  GIT_SHALLOW ${shallow}
+                  EXCLUDE_FROM_ALL ${to_exclude}
+                  OPTIONS "BUILD_TESTS OFF" "BUILD_BENCHMARKS OFF" "BUILD_EXAMPLES OFF")
+
+  # Propagate up variables that CPMFindPackage provide
+  set(cuco_SOURCE_DIR "${cuco_SOURCE_DIR}" PARENT_SCOPE)
+  set(cuco_BINARY_DIR "${cuco_BINARY_DIR}" PARENT_SCOPE)
+  set(cuco_ADDED "${cuco_ADDED}" PARENT_SCOPE)
+  set(cuco_VERSION ${version} PARENT_SCOPE)
+
+endfunction()

rapids-cmake/cpm/versions.json

@@ -39,6 +39,12 @@
       "version" : "1.7.0",
       "git_url" : "https://github.com/NVIDIA/libcudacxx.git",
       "git_tag" : "${version}"
+    },
+    "cuco" : {
+      "version" : "0.0.1",
+      "git_shallow" : false,
+      "git_url" : "https://github.com/NVIDIA/cuCollections.git",
+      "git_tag" : "55029034c3f82bca36148c9be29941b37492394d"
     }
   }
 }

testing/cpm/CMakeLists.txt

@@ -1,5 +1,5 @@
 #=============================================================================
-# Copyright (c) 2021, NVIDIA CORPORATION.
+# Copyright (c) 2021-2022, NVIDIA CORPORATION.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -59,3 +59,6 @@ add_cmake_config_test( cpm_spdlog-simple.cmake )
 
 add_cmake_config_test( cpm_thrust-export.cmake )
 add_cmake_config_test( cpm_thrust-simple.cmake )
+
+add_cmake_config_test( cpm_cuco-simple.cmake )
+add_cmake_config_test( cpm_cuco-export.cmake )

testing/cpm/cpm_cuco-export.cmake

@@ -0,0 +1,26 @@
+#=============================================================================
+# Copyright (c) 2022, NVIDIA CORPORATION.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#=============================================================================
+include(${rapids-cmake-dir}/cpm/init.cmake)
+include(${rapids-cmake-dir}/cpm/cuco.cmake)
+
+rapids_cpm_init()
+
+rapids_cpm_cuco(BUILD_EXPORT_SET test_export_set)
+
+get_target_property(packages rapids_export_build_test_export_set PACKAGE_NAMES)
+if(NOT cuco IN_LIST packages)
+  message(FATAL_ERROR "rapids_cpm_cuco failed to record cuco needs to be exported")
+endif()

testing/cpm/cpm_cuco-simple.cmake

@@ -0,0 +1,31 @@
+#=============================================================================
+# Copyright (c) 2022, NVIDIA CORPORATION.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#=============================================================================
+include(${rapids-cmake-dir}/cpm/init.cmake)
+include(${rapids-cmake-dir}/cpm/cuco.cmake)
+
+rapids_cpm_init()
+
+if(TARGET cuco::cuco)
+  message(FATAL_ERROR "Expected cuco::cuco target not to exist")
+endif()
+
+rapids_cpm_cuco()
+if(NOT TARGET cuco::cuco)
+  message(FATAL_ERROR "Expected cuco::cuco target to exist")
+endif()
+
+# Ensure that calls are idempotent.
+rapids_cpm_cuco()