Use scikit-build for the build process

.gitignore

@@ -50,6 +50,9 @@ pip-delete-this-directory.txt
 # Ignore dynamically generated .pxd files
 python/rmm/_cuda/gpu.pxd
 
+# Ignore _skbuild directory
+_skbuild/
+
 # Unit test / coverage reports
 htmlcov/
 .tox/

CONTRIBUTING.md

@@ -34,6 +34,12 @@ into three categories:
 8. Once reviewed and approved, a RAPIDS developer will merge your pull request. Note that for C++ code, two reviewers
 are required.
 
+To set up a development environment, follow the steps in the [README](https://github.com/rapidsai/rmm/blob/main/README.md) for cloning the repository and creating the conda environment.
+Once the environment is created, you can build and install RMM using
+```bash
+$ python setup.py develop
+```
+This command will build the RMM Python library inside the clone and automatically make it importable when running Python anywhere on your machine.
 Remember, if you are unsure about anything, don't hesitate to comment on issues
 and ask for clarifications!
 
@@ -52,7 +58,7 @@ implementation of the issue, ask them in the issue instead of the PR.
 
 ### Building and Testing on a gpuCI image locally
 
- Before submitting a pull request, you can do a local build and test on your machine that mimics our gpuCI environment using the `ci/local/build.sh` script.
+Before submitting a pull request, you can do a local build and test on your machine that mimics our gpuCI environment using the `ci/local/build.sh` script.
 For detailed information on usage of this script, see [here](ci/local/README.md).
 
 ## Attribution

build.sh

@@ -37,8 +37,8 @@ HELP="$0 [clean] [librmm] [rmm] [-v] [-g] [-n] [-s] [--ptds] [--no-cudamallocasy
    default action (no args) is to build and install 'librmm' and 'rmm' targets
 "
 LIBRMM_BUILD_DIR=${LIBRMM_BUILD_DIR:=${REPODIR}/build}
-RMM_BUILD_DIR=${REPODIR}/python/build
-BUILD_DIRS="${LIBRMM_BUILD_DIR} ${RMM_BUILD_DIR}"
+RMM_BUILD_DIR="${REPODIR}/python/build ${REPODIR}/python/_skbuild"
+BUILD_DIR="${LIBRMM_BUILD_DIR} ${RMM_BUILD_DIR}"
 
 # Set defaults for vars modified by flags to this script
 VERBOSE_FLAG=""
@@ -157,7 +157,7 @@ if hasArg clean; then
         if [ -d "${bd}" ]; then
             find "${bd}" -mindepth 1 -delete
             rmdir "${bd}" || true
-	fi
+        fi
     done
 fi
 
@@ -178,15 +178,16 @@ if (( NUMARGS == 0 )) || hasArg rmm; then
     cd "${REPODIR}/python"
     export INSTALL_PREFIX
     echo "building rmm..."
+
     if [[ ${CUDA_MALLOC_ASYNC_SUPPORT} == OFF ]]; then
-        python setup.py build_ext_no_async --inplace
+        python setup.py build_ext --inplace -- -DCUDA_MALLOC_ASYNC_SUPPORT=OFF -DCMAKE_PREFIX_PATH=${INSTALL_PREFIX}
     else
-        python setup.py build_ext --inplace
+        python setup.py build_ext --inplace -- -DCMAKE_PREFIX_PATH=${INSTALL_PREFIX}
     fi
 
     if [[ ${INSTALL_TARGET} != "" ]]; then
         echo "installing rmm..."
-        python setup.py install --single-version-externally-managed --record=record.txt
+        python setup.py install --single-version-externally-managed --record=record.txt -- -DCMAKE_PREFIX_PATH=${INSTALL_PREFIX}
     fi
 
 fi

ci/release/update-version.sh

@@ -30,6 +30,7 @@ function sed_runner() {
 }
 
 sed_runner 's/'"  VERSION .*"'/'"  VERSION ${NEXT_FULL_TAG}"'/g' CMakeLists.txt
+sed_runner 's/'"rmm_version .*)"'/'"rmm_version ${NEXT_FULL_TAG})"'/g' python/CMakeLists.txt
 sed_runner 's/'"branch-.*\/RAPIDS.cmake"'/'"branch-${NEXT_SHORT_TAG}\/RAPIDS.cmake"'/g' CMakeLists.txt
 
 sed_runner 's/'"PROJECT_NUMBER         = .*"'/'"PROJECT_NUMBER         = ${NEXT_SHORT_TAG}"'/g' doxygen/Doxyfile

cmake/config.json

@@ -28,7 +28,7 @@
     "max_pargs_hwrap": 999
   },
   "lint": {
-    "disabled_codes": ["C0301"],
+    "disabled_codes": ["C0301", "C0112"],
     "function_pattern": "[0-9A-z_]+",
     "macro_pattern": "[0-9A-z_]+",
     "global_var_pattern": "[A-z][0-9A-z_]+",

conda/environments/rmm_dev_cuda11.5.yml

@@ -16,6 +16,7 @@ dependencies:
 - cffi>=1.10.0
 - pytest
 - cudatoolkit=11.5
+- scikit-build>=0.13.1
 - spdlog>=1.8.5,<1.9
 - cython>=0.29,<0.30
 - gcovr>=5.0

conda/environments/rmm_dev_cuda11.6.yml

@@ -16,6 +16,7 @@ dependencies:
 - cffi>=1.10.0
 - pytest
 - cudatoolkit=11.6
+- scikit-build>=0.13.1
 - spdlog>=1.8.5,<1.9
 - cython>=0.29,<0.30
 - gcovr>=5.0

conda/recipes/rmm/meta.yaml

@@ -1,4 +1,4 @@
-# Copyright (c) 2019-2021, NVIDIA CORPORATION.
+# Copyright (c) 2019-2022, NVIDIA CORPORATION.
 
 {% set version = environ.get('GIT_DESCRIBE_TAG', '0.0.0.dev').lstrip('v') + environ.get('VERSION_SUFFIX', '') %}
 {% set py_version=environ.get('CONDA_PY', 35) %}
@@ -27,7 +27,9 @@ requirements:
     - python
     - librmm {{ version }}
     - setuptools
-    - cython >=0.29,<0.30
+    - cython>=0.29,<0.30
+    - cmake>=3.20.1
+    - scikit-build>=0.13.1
     - spdlog>=1.8.5,<2.0.0a0
     - cudatoolkit {{ cuda_version }}.*
     - cuda-python >=11.5,<12.0

python/CMakeLists.txt

@@ -0,0 +1,65 @@
+# =============================================================================
+# 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.
+# =============================================================================
+
+cmake_minimum_required(VERSION 3.20.1 FATAL_ERROR)
+
+# TODO: Pull this directly from the file written by rapids_cmake_write_version_file.
+set(rmm_version 22.04.00)
+
+project(
+  rmm-python
+  VERSION ${rmm_version}
+  LANGUAGES # TODO: Building Python extension modules via the python_extension_module requires the C
+            # language to be enabled here. The test project that is built in scikit-build to verify
+            # various linking options for the python library is hardcoded to build with C, so until
+            # that is fixed we need to keep C.
+            C
+            CXX
+            # TODO: The C++ RMM CMake configuration targets cuda_std_17 features, which prior to
+            # CMake 3.22 will also pull in the corresponding required languages even if this project
+            # does not actually require those languages. As a result, we need to include CUDA here.
+            # We can remove CUDA once we upgrade the minimum required CMake version to 3.22.
+            CUDA)
+
+option(FIND_RMM_CPP "Search for existing RMM C++ installations before defaulting to local files"
+       OFF)
+
+find_package(PythonExtensions REQUIRED)
+find_package(Cython REQUIRED)
+
+# Ignore unused variable warning.
+set(ignored_variable "${SKBUILD}")
+
+# If the user requested it we attempt to find RMM. TODO: Should we allow the user to specify a path
+# instead of just searching? This version assumes that the installation has been appropriately
+# configured for CMake discovery.
+if(FIND_RMM_CPP)
+  find_package(RMM ${rmm_version})
+else()
+  set(RMM_FOUND OFF)
+endif()
+
+if(DEFINED CUDA_MALLOC_ASYNC_SUPPORT AND NOT CUDA_MALLOC_ASYNC_SUPPORT)
+  add_compile_definitions("RMM_DISABLE_CUDA_MALLOC_ASYNC")
+endif()
+
+if(NOT RMM_FOUND)
+  set(BUILD_TESTS OFF)
+  set(BUILD_BENCHMARKS OFF)
+  add_subdirectory(../ rmm-cpp)
+endif()
+
+add_subdirectory(cmake)
+add_subdirectory(rmm/_cuda)
+add_subdirectory(rmm/_lib)

python/cmake/CMakeLists.txt

@@ -0,0 +1,16 @@
+# =============================================================================
+# 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(rmm_python_helpers.cmake)
+include(skbuild_patches.cmake)

python/cmake/rmm_python_helpers.cmake

@@ -0,0 +1,48 @@
+# =============================================================================
+# 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.
+# =============================================================================
+
+#[=======================================================================[.rst:
+add_cython_modules
+------------------
+
+Generate C(++) from Cython and create Python modules.
+
+.. code-block:: cmake
+
+  add_cython_modules(<ModuleName...>)
+
+Creates a Cython target for a module, then adds a corresponding Python
+extension module.
+
+``ModuleName``
+  The list of modules to build.
+
+#]=======================================================================]
+function(add_cython_modules cython_modules)
+  foreach(cython_module ${cython_modules})
+    add_cython_target(${cython_module} CXX PY3)
+    add_library(${cython_module} MODULE ${cython_module})
+    python_extension_module(${cython_module})
+
+    # To avoid libraries being prefixed with "lib".
+    set_target_properties(${cython_module} PROPERTIES PREFIX "")
+    target_link_libraries(${cython_module} rmm::rmm)
+
+    # Compute the install directory relative to the source and rely on installs being relative to
+    # the CMAKE_PREFIX_PATH for e.g. editable installs.
+    cmake_path(RELATIVE_PATH CMAKE_CURRENT_SOURCE_DIR BASE_DIRECTORY ${rmm-python_SOURCE_DIR}
+               OUTPUT_VARIABLE install_dst)
+    install(TARGETS ${cython_module} DESTINATION ${install_dst})
+  endforeach(cython_module ${cython_sources})
+endfunction()

python/cmake/skbuild_patches.cmake

@@ -0,0 +1,48 @@
+# =============================================================================
+# 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.
+# =============================================================================
+
+#[=======================================================================[.rst:
+_set_python_extension_symbol_visibility
+---------------------------------------
+
+The original version of this function in scikit-build runs a linker script to
+modify the visibility of symbols. This version is a patch to avoid overwriting
+the visibility of symbols because RMM specifically overrides some symbol
+visibility in order to share certain functional-local static variables.
+
+#]=======================================================================]
+# TODO: Should we guard this based on a scikit-build version? Override this function to avoid
+# scikit-build clobbering symbol visibility.
+function(_set_python_extension_symbol_visibility _target)
+  if(PYTHON_VERSION_MAJOR VERSION_GREATER 2)
+    set(_modinit_prefix "PyInit_")
+  else()
+    set(_modinit_prefix "init")
+  endif()
+  message("_modinit_prefix:${_modinit_prefix}")
+  if("${CMAKE_C_COMPILER_ID}" STREQUAL "MSVC")
+    set_target_properties(${_target} PROPERTIES LINK_FLAGS "/EXPORT:${_modinit_prefix}${_target}")
+  elseif("${CMAKE_C_COMPILER_ID}" STREQUAL "GNU" AND NOT ${CMAKE_SYSTEM_NAME} MATCHES "Darwin")
+    set(_script_path ${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/${_target}-version-script.map)
+    file(
+      WRITE ${_script_path}
+      # Note: The change is to this script, which does not indiscriminately mark all non PyInit
+      # symbols as local.
+      "{global: ${_modinit_prefix}${_target}; };")
+    set_property(
+      TARGET ${_target}
+      APPEND_STRING
+      PROPERTY LINK_FLAGS " -Wl,--version-script=\"${_script_path}\"")
+  endif()
+endfunction()

python/dev_requirements.txt

@@ -1,4 +1,4 @@
-# Copyright (c) 2021, NVIDIA CORPORATION.
+# Copyright (c) 2021-2022, NVIDIA CORPORATION.
 
 clang==8.0.1
 flake8==3.8.3
@@ -12,3 +12,4 @@ pytest-xdist
 cython>=0.29,<0.30
 wheel
 setuptools
+scikit-build>=0.13.1

python/pyproject.toml

@@ -1,11 +1,26 @@
-# 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.
+# 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.
 
 [build-system]
 
 requires = [
     "wheel",
     "setuptools",
-    "Cython>=0.29,<0.30",
+    "cython>=0.29,<0.30",
+    "scikit-build>=0.13.1",
+    "cmake>=3.20.1",
+    "ninja",
 ]
 
 [tool.black]

python/rmm/_cuda/CMakeLists.txt

@@ -0,0 +1,19 @@
+# =============================================================================
+# 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.
+# =============================================================================
+
+# Set the list of Cython files to build
+set(cython_modules stream)
+
+# Build all of the Cython targets
+add_cython_modules("${cython_modules}")

python/rmm/_lib/CMakeLists.txt

@@ -0,0 +1,19 @@
+# =============================================================================
+# 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.
+# =============================================================================
+
+# Set the list of Cython files to build
+set(cython_modules device_buffer lib memory_resource cuda_stream)
+
+# Build all of the Cython targets
+add_cython_modules("${cython_modules}")