Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow nested lib location for nvcomp #675

Merged
merged 3 commits into from
Aug 16, 2024
Merged

Allow nested lib location for nvcomp #675

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7240793
Allow nested lib location for nvcomp
KyleFromNVIDIA Aug 16, 2024
5e9aaba
Make sure include and lib dirs share parent directory
KyleFromNVIDIA Aug 16, 2024
25762b5
Review feedback
KyleFromNVIDIA Aug 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions rapids-cmake/cpm/nvcomp.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,11 +123,22 @@ function(rapids_cpm_nvcomp)
# nvcomp-release-targets.cmake. Guarded in an EXISTS check so we only try to do this on the
# first configuration pass
if(NOT EXISTS "${nvcomp_ROOT}/${lib_dir}/cmake/nvcomp/nvcomp-targets-release.cmake")
include(GNUInstallDirs)
cmake_path(GET lib_dir PARENT_PATH lib_dir_parent)
cmake_path(GET CMAKE_INSTALL_INCLUDEDIR PARENT_PATH include_dir_parent)
if(NOT lib_dir_parent STREQUAL include_dir_parent)
message(FATAL_ERROR "CMAKE_INSTALL_INCLUDEDIR and CMAKE_INSTALL_LIBDIR must share parent directory"
)
endif()

cmake_path(GET lib_dir FILENAME lib_dir_name)
file(READ "${nvcomp_ROOT}/lib/cmake/nvcomp/nvcomp-targets-release.cmake" FILE_CONTENTS)
string(REPLACE "\$\{_IMPORT_PREFIX\}/lib/" "\$\{_IMPORT_PREFIX\}/${lib_dir}/" FILE_CONTENTS
${FILE_CONTENTS})
string(REPLACE "\$\{_IMPORT_PREFIX\}/lib/" "\$\{_IMPORT_PREFIX\}/${lib_dir_name}/"
FILE_CONTENTS ${FILE_CONTENTS})
file(WRITE "${nvcomp_ROOT}/lib/cmake/nvcomp/nvcomp-targets-release.cmake" ${FILE_CONTENTS})
file(MAKE_DIRECTORY "${nvcomp_ROOT}/${lib_dir_parent}")
file(RENAME "${nvcomp_ROOT}/lib/" "${nvcomp_ROOT}/${lib_dir}/")
file(RENAME "${nvcomp_ROOT}/include/" "${nvcomp_ROOT}/${CMAKE_INSTALL_INCLUDEDIR}/")
endif()

# Record the nvcomp_DIR so that if USE_PROPRIETARY_BINARY is disabled we can safely clear the
Expand Down Expand Up @@ -199,7 +210,8 @@ function(rapids_cpm_nvcomp)
include(GNUInstallDirs)

install(DIRECTORY "${nvcomp_ROOT}/${lib_dir}/" DESTINATION "${lib_dir}")
install(DIRECTORY "${nvcomp_ROOT}/include/" DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}")
install(DIRECTORY "${nvcomp_ROOT}/${CMAKE_INSTALL_INCLUDEDIR}/"
DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}")
# place the license information in the location that conda uses
install(FILES "${nvcomp_ROOT}/NOTICE" DESTINATION info/ RENAME NVCOMP_NOTICE)
install(FILES "${nvcomp_ROOT}/LICENSE" DESTINATION info/ RENAME NVCOMP_LICENSE)
Expand Down
1 change: 1 addition & 0 deletions testing/cpm/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@ add_cmake_config_test( cpm_nvcomp-invalid-arch.cmake )
add_cmake_config_test( cpm_nvcomp-always-download-proprietary_binary.cmake SERIAL)
add_cmake_config_test( cpm_nvcomp-override-clears-proprietary_binary.cmake SERIAL)
add_cmake_build_test( cpm_nvcomp-proprietary_binary-lib-location.cmake SERIAL NO_CPM_CACHE)
add_cmake_build_test( cpm_nvcomp-proprietary_binary-lib-location-nested.cmake SERIAL NO_CPM_CACHE)

add_cmake_build_test( cpm_nvtx-build-config-works.cmake )
add_cmake_build_test( cpm_nvtx-install-config-works.cmake )
Expand Down
80 changes: 80 additions & 0 deletions testing/cpm/cpm_nvcomp-proprietary_binary-lib-location-common.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
#=============================================================================
# Copyright (c) 2024, 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/nvcomp.cmake)
include(${rapids-cmake-dir}/cpm/package_override.cmake)


rapids_cpm_init()

if(TARGET nvcomp::nvcomp)
message(FATAL_ERROR "Expected nvcomp::nvcomp not to exist")
endif()

rapids_cpm_nvcomp(USE_PROPRIETARY_BINARY ON BUILD_EXPORT_SET nvcomp-targets INSTALL_EXPORT_SET nvcomp-targets)

if(NOT nvcomp_proprietary_binary)
message(FATAL_ERROR "Ignored nvcomp override file failed to get proprietary binary version")
endif()

# Check the contents of the nvcomp-targets-release.cmake file to ensure that
# every line containing "_IMPORT_PREFIX" also contains "${CMAKE_INSTALL_LIBDIR}"
file(STRINGS "${CMAKE_CURRENT_BINARY_DIR}/_deps/nvcomp_proprietary_binary-src/${CMAKE_INSTALL_LIBDIR}/cmake/nvcomp/nvcomp-targets-release.cmake" nvcomp_targets_release_contents)
foreach(line IN LISTS nvcomp_targets_release_contents)
string(FIND "${line}" "_IMPORT_PREFIX" _IMPORT_PREFIX_INDEX)
if(_IMPORT_PREFIX_INDEX EQUAL -1)
continue()
endif()
cmake_path(GET CMAKE_INSTALL_LIBDIR FILENAME lib_dir_name)
string(FIND "${line}" "${lib_dir_name}" _LIBDIR_INDEX)
if(_LIBDIR_INDEX EQUAL -1)
message(FATAL_ERROR "nvcomp-targets-release.cmake file does not contain ${lib_dir_name}")
endif()
endforeach()

# Install and check the install directory.
add_custom_target(install_project ALL
COMMAND ${CMAKE_COMMAND} --install "${CMAKE_BINARY_DIR}" --prefix check_nvcomp_lib_dir/install/
)

# Need to capture the install directory based on the binary dir of this project, not the subproject used for testing.
set(expected_install_dir "${CMAKE_BINARY_DIR}/check_nvcomp_lib_dir/install/")

# Add a custom command that verifies that the expect files have
# been installed for each component
file(WRITE "${CMAKE_BINARY_DIR}/check_nvcomp_lib_dir/CMakeLists.txt" "
cmake_minimum_required(VERSION 3.26.4)
project(verify_install_targets LANGUAGES CXX)

message(\"Checking for ${CMAKE_INSTALL_LIBDIR} directory in ${expected_install_dir}\")
if (NOT EXISTS ${expected_install_dir}/${CMAKE_INSTALL_LIBDIR})
message(FATAL_ERROR \"The ${CMAKE_INSTALL_LIBDIR} directory didn't exist!\")
endif()

set(nvcomp_ROOT \"${expected_install_dir}/${CMAKE_INSTALL_LIBDIR}/cmake/nvcomp\")
find_package(nvcomp REQUIRED)

file(WRITE \"\${CMAKE_CURRENT_BINARY_DIR}/stub.cpp\" \" \")
add_library(uses_nvcomp SHARED stub.cpp)
target_link_libraries(uses_nvcomp PRIVATE nvcomp::nvcomp)

")

add_custom_target(verify_nvcomp_lib_dir ALL
COMMAND ${CMAKE_COMMAND} -E rm -rf "${CMAKE_BINARY_DIR}/check_nvcomp_lib_dir/build"
COMMAND ${CMAKE_COMMAND} -S="${CMAKE_BINARY_DIR}/check_nvcomp_lib_dir" -B="${CMAKE_BINARY_DIR}/install/build"
)
add_dependencies(verify_nvcomp_lib_dir install_project)
19 changes: 19 additions & 0 deletions testing/cpm/cpm_nvcomp-proprietary_binary-lib-location-nested.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
#=============================================================================
# Copyright (c) 2024, 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(CMAKE_INSTALL_LIBDIR "nested/lib64")
set(CMAKE_INSTALL_INCLUDEDIR "nested/include")
include("${CMAKE_CURRENT_LIST_DIR}/cpm_nvcomp-proprietary_binary-lib-location-common.cmake")
robertmaynard marked this conversation as resolved.
Show resolved Hide resolved
64 changes: 1 addition & 63 deletions testing/cpm/cpm_nvcomp-proprietary_binary-lib-location.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,68 +13,6 @@
# 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/nvcomp.cmake)
include(${rapids-cmake-dir}/cpm/package_override.cmake)


rapids_cpm_init()

if(TARGET nvcomp::nvcomp)
message(FATAL_ERROR "Expected nvcomp::nvcomp not to exist")
endif()

set(CMAKE_INSTALL_LIBDIR "lib64")
rapids_cpm_nvcomp(USE_PROPRIETARY_BINARY ON BUILD_EXPORT_SET nvcomp-targets INSTALL_EXPORT_SET nvcomp-targets)

if(NOT nvcomp_proprietary_binary)
message(FATAL_ERROR "Ignored nvcomp override file failed to get proprietary binary version")
endif()

# Check the contents of the nvcomp-targets-release.cmake file to ensure that
# every line containing "_IMPORT_PREFIX" also contains "lib64"
file(STRINGS "${CMAKE_CURRENT_BINARY_DIR}/_deps/nvcomp_proprietary_binary-src/lib64/cmake/nvcomp/nvcomp-targets-release.cmake" nvcomp_targets_release_contents)
foreach(line IN LISTS nvcomp_targets_release_contents)
string(FIND "${line}" "_IMPORT_PREFIX" _IMPORT_PREFIX_INDEX)
if(_IMPORT_PREFIX_INDEX EQUAL -1)
continue()
endif()
string(FIND "${line}" "lib64" _LIB64_INDEX)
if(_LIB64_INDEX EQUAL -1)
message(FATAL_ERROR "nvcomp-targets-release.cmake file does not contain lib64")
endif()
endforeach()

# Install and check the install directory.
add_custom_target(install_project ALL
COMMAND ${CMAKE_COMMAND} --install "${CMAKE_BINARY_DIR}" --prefix check_nvcomp_lib_dir/install/
)

# Need to capture the install directory based on the binary dir of this project, not the subproject used for testing.
set(expected_install_dir "${CMAKE_BINARY_DIR}/check_nvcomp_lib_dir/install/")

# Add a custom command that verifies that the expect files have
# been installed for each component
file(WRITE "${CMAKE_BINARY_DIR}/check_nvcomp_lib_dir/CMakeLists.txt" "
cmake_minimum_required(VERSION 3.26.4)
project(verify_install_targets LANGUAGES CXX)

message(\"Checking for lib64 directory in ${expected_install_dir}\")
if (NOT EXISTS ${expected_install_dir}/lib64)
message(FATAL_ERROR \"The lib64 directory didn't exist!\")
endif()

set(nvcomp_ROOT \"${expected_install_dir}/lib64/cmake/nvcomp\")
find_package(nvcomp REQUIRED)

file(WRITE \"\${CMAKE_CURRENT_BINARY_DIR}/stub.cpp\" \" \")
add_library(uses_nvcomp SHARED stub.cpp)
target_link_libraries(uses_nvcomp PRIVATE nvcomp::nvcomp)

")

add_custom_target(verify_nvcomp_lib_dir ALL
COMMAND ${CMAKE_COMMAND} -E rm -rf "${CMAKE_BINARY_DIR}/check_nvcomp_lib_dir/build"
COMMAND ${CMAKE_COMMAND} -S="${CMAKE_BINARY_DIR}/check_nvcomp_lib_dir" -B="${CMAKE_BINARY_DIR}/install/build"
)
add_dependencies(verify_nvcomp_lib_dir install_project)
include("${CMAKE_CURRENT_LIST_DIR}/cpm_nvcomp-proprietary_binary-lib-location-common.cmake")
Loading