[FEA] Add option to build faiss shared libs

build.sh

@@ -43,6 +43,7 @@ PYTHON_DEPS_CLONE=${REPODIR}/python/external_repositories
 BUILD_DIRS="${CPP_RAFT_BUILD_DIR} ${PY_RAFT_BUILD_DIR} ${PYTHON_DEPS_CLONE}"
 
 # Set defaults for vars modified by flags to this script
+CMAKE_LOG_LEVEL=""
 VERBOSE_FLAG=""
 BUILD_ALL_GPU_ARCH=0
 BUILD_GTEST=OFF
@@ -84,6 +85,7 @@ fi
 # Process flags
 if hasArg -v; then
     VERBOSE_FLAG=-v
+    CMAKE_LOG_LEVEL="--log-level=VERBOSE"
     set -x
 fi
 if hasArg -g; then
@@ -147,13 +149,13 @@ if (( ${NUMARGS} == 0 )) || hasArg cppraft; then
         echo "Building for *ALL* supported GPU architectures..."
     fi
 
-    cmake -S ${REPODIR}/cpp -B ${CPP_RAFT_BUILD_DIR} \
+    cmake -S ${REPODIR}/cpp -B ${CPP_RAFT_BUILD_DIR} ${CMAKE_LOG_LEVEL} \
           -DCMAKE_INSTALL_PREFIX=${INSTALL_PREFIX} \
           -DCMAKE_CUDA_ARCHITECTURES=${RAFT_CMAKE_CUDA_ARCHITECTURES} \
           -DNVTX=${NVTX} \
           -DDISABLE_DEPRECATION_WARNING=${BUILD_DISABLE_DEPRECATION_WARNING} \
           -DBUILD_GTEST=${BUILD_GTEST} \
-          -DBUILD_STATIC_FAISS=${BUILD_STATIC_FAISS}
+          -DRAFT_USE_FAISS_STATIC=${BUILD_STATIC_FAISS}
 
 
     # Run all c++ targets at once

cpp/CMakeLists.txt

@@ -49,6 +49,8 @@ option(DISABLE_DEPRECATION_WARNINGS "Disable depreaction warnings " ON)
 option(DISABLE_OPENMP "Disable OpenMP" OFF)
 option(NVTX "Enable nvtx markers" OFF)
 
+option(RAFT_USE_FAISS_STATIC "Build and statically link the FAISS library for nearest neighbors search on GPU" ON)
+
 message(VERBOSE "RAFT: Build RAFT unit-tests: ${BUILD_TESTS}")
 message(VERBOSE "RAFT: Enable detection of conda environment for dependencies: ${DETECT_CONDA_ENV}")
 message(VERBOSE "RAFT: Disable depreaction warnings " ${DISABLE_DEPRECATION_WARNINGS})
@@ -100,15 +102,15 @@ endif()
 # add third party dependencies using CPM
 rapids_cpm_init()
 
-# thrust and libcudacxx need to be before cuco!
-include(cmake/thirdparty/get_thrust.cmake)
 include(cmake/thirdparty/get_rmm.cmake)
 include(cmake/thirdparty/get_libcudacxx.cmake)
 include(cmake/thirdparty/get_cuco.cmake)
+# CPMFindPackage(faiss) so it's available for raft consumers to use
+include(cmake/thirdparty/get_faiss.cmake)
+# CPMFindPackage(GTest) so it's available for raft consumers to use
+include(cmake/thirdparty/get_gtest.cmake)
 
 if(BUILD_TESTS)
-  include(cmake/thirdparty/get_faiss.cmake)
-  include(cmake/thirdparty/get_gtest.cmake)
   include(cmake/thirdparty/get_nccl.cmake)
   include(cmake/thirdparty/get_ucx.cmake)
 endif()
@@ -152,7 +154,7 @@ set(RAFT_LINK_LIBRARIES
 
 target_link_libraries(raft INTERFACE ${RAFT_LINK_LIBRARIES})
 target_link_libraries(raft_distance PUBLIC ${RAFT_LINK_LIBRARIES})
-target_link_libraries(raft_nn PUBLIC ${RAFT_LINK_LIBRARIES} FAISS::FAISS)
+target_link_libraries(raft_nn PUBLIC ${RAFT_LINK_LIBRARIES} faiss::faiss)
 
 set(RAFT_COMPILE_DEFINITIONS
         $<$<BOOL:${NVTX}>:NVTX_ENABLED>
@@ -198,6 +200,12 @@ install(DIRECTORY include/raft/
 install(FILES include/raft.hpp
 	DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/raft)
 
+include("${rapids-cmake-dir}/export/write_dependencies.cmake")
+rapids_export_write_dependencies(
+  INSTALL raft-faiss-exports
+  "${PROJECT_BINARY_DIR}/rapids-cmake/raft/export/raft-faiss-dependencies.cmake"
+)
+
 ##############################################################################
 # - install export -----------------------------------------------------------
 set(doc_string
@@ -209,11 +217,31 @@ mathematical computational primitives, and utilities that accelerate
 building analytics and data science algorithms in the RAPIDS ecosystem.
 ]=])
 
- rapids_export(INSTALL raft
+set(code_string
+[=[
+if(faiss IN_LIST raft_FIND_COMPONENTS)
+  enable_language(CUDA)
+  if(EXISTS "${CMAKE_CURRENT_LIST_DIR}/raft-faiss-dependencies.cmake")
+    include("${CMAKE_CURRENT_LIST_DIR}/raft-faiss-dependencies.cmake")
+  endif()
+  if(TARGET faiss AND (NOT TARGET faiss::faiss))
+      add_library(faiss::faiss ALIAS faiss)
+  elseif(TARGET faiss::faiss AND (NOT TARGET faiss))
+      add_library(faiss ALIAS faiss::faiss)
+  endif()
+  if(TARGET raft::raft)
+    target_link_libraries(raft::raft INTERFACE faiss::faiss)
+  endif()
+endif()
+]=]
+)
+
+rapids_export(INSTALL raft
     EXPORT_SET raft-exports
     GLOBAL_TARGETS raft raft_distance# since we can't hook into EXPORT SETS
     NAMESPACE raft::
     DOCUMENTATION doc_string
+    FINAL_CODE_BLOCK code_string
     )
 
 ##############################################################################
@@ -222,11 +250,15 @@ building analytics and data science algorithms in the RAPIDS ecosystem.
 rapids_export(BUILD raft
     EXPORT_SET raft-exports
     GLOBAL_TARGETS raft raft_distance raft_nn# since we can't hook into EXPORT SETS
-    LANGUAGES CUDA
     DOCUMENTATION doc_string
     NAMESPACE raft::
+    FINAL_CODE_BLOCK code_string
     )
 
+rapids_export_write_dependencies(
+  BUILD raft-faiss-exports "${PROJECT_BINARY_DIR}/raft-faiss-dependencies.cmake"
+)
+
 ##############################################################################
 # - build test executable ----------------------------------------------------
 

cpp/cmake/thirdparty/get_cuco.cmake

@@ -30,4 +30,5 @@ function(find_and_configure_cuco VERSION)
 
 endfunction()
 
-find_and_configure_cuco(0.0.1)
+# cuCollections doesn't have a version yet
+find_and_configure_cuco(0.0)

cpp/cmake/thirdparty/get_faiss.cmake

@@ -15,39 +15,55 @@
 #=============================================================================
 
 function(find_and_configure_faiss)
-    set(oneValueArgs VERSION PINNED_TAG)
+    set(oneValueArgs VERSION PINNED_TAG BUILD_STATIC_LIBS)
     cmake_parse_arguments(PKG "${options}" "${oneValueArgs}"
                           "${multiValueArgs}" ${ARGN} )
 
-    rapids_find_generate_module(FAISS
+    rapids_find_generate_module(faiss
         HEADER_NAMES  faiss/IndexFlat.h
         LIBRARY_NAMES faiss
     )
 
-    rapids_cpm_find(FAISS ${PKG_VERSION}
-        GLOBAL_TARGETS  faiss
+    set(BUILD_SHARED_LIBS OFF)
+    if (NOT BUILD_STATIC_LIBS)
+        set(BUILD_SHARED_LIBS ON)
+    endif()
+
+    rapids_cpm_find(faiss ${PKG_VERSION}
+        GLOBAL_TARGETS     faiss::faiss
+        INSTALL_EXPORT_SET raft-faiss-exports
         CPM_ARGS
-          GIT_REPOSITORY  https://github.com/facebookresearch/faiss.git
-          GIT_TAG         ${PKG_PINNED_TAG}
+          GIT_REPOSITORY   https://github.com/facebookresearch/faiss.git
+          GIT_TAG          ${PKG_PINNED_TAG}
+          EXCLUDE_FROM_ALL TRUE
           OPTIONS
             "FAISS_ENABLE_PYTHON OFF"
-            "BUILD_SHARED_LIBS OFF"
             "CUDAToolkit_ROOT ${CUDAToolkit_LIBRARY_DIR}"
             "FAISS_ENABLE_GPU ON"
             "BUILD_TESTING OFF"
             "CMAKE_MESSAGE_LOG_LEVEL VERBOSE"
     )
 
-    if(FAISS_ADDED)
-      set(FAISS_GPU_HEADERS ${FAISS_SOURCE_DIR} PARENT_SCOPE)
+    if(TARGET faiss AND NOT TARGET faiss::faiss)
+        add_library(faiss::faiss ALIAS faiss)
     endif()
 
-    if(TARGET faiss AND NOT TARGET FAISS::FAISS)
-        add_library(FAISS::FAISS ALIAS faiss)
+    if(faiss_ADDED)
+        rapids_export(BUILD faiss
+            EXPORT_SET faiss-targets
+            GLOBAL_TARGETS faiss
+            NAMESPACE faiss::)
     endif()
 
+    # We generate the faiss-config files when we built faiss locally, so always do `find_dependency`
+    rapids_export_package(BUILD faiss raft-faiss-exports)
+
+    # Tell cmake where it can find the generated faiss-config.cmake we wrote.
+    include("${rapids-cmake-dir}/export/find_package_root.cmake")
+    rapids_export_find_package_root(BUILD faiss [=[${CMAKE_CURRENT_LIST_DIR}]=] raft-faiss-exports)
 endfunction()
 
 find_and_configure_faiss(VERSION    1.7.0
                          PINNED_TAG  bde7c0027191f29c9dadafe4f6e68ca0ee31fb30
+                         BUILD_STATIC_LIBS ${RAFT_USE_FAISS_STATIC}
                         )

cpp/cmake/thirdparty/get_gtest.cmake

@@ -17,7 +17,19 @@
 function(find_and_configure_gtest )
 
     include(${rapids-cmake-dir}/cpm/gtest.cmake)
-    rapids_cpm_gtest()
+    rapids_cpm_gtest(BUILD_EXPORT_SET raft-exports
+                     INSTALL_EXPORT_SET raft-exports)
+
+    if(GTest_ADDED)
+        rapids_export(BUILD GTest
+          VERSION ${GTest_VERSION}
+          EXPORT_SET GTestTargets
+          GLOBAL_TARGETS gtest gmock gtest_main gmock_main
+          NAMESPACE GTest::)
+
+        include("${rapids-cmake-dir}/export/find_package_root.cmake")
+        rapids_export_find_package_root(BUILD GTest [=[${CMAKE_CURRENT_LIST_DIR}]=] raft-exports)
+    endif()
 
 endfunction()
 

cpp/test/CMakeLists.txt

@@ -120,15 +120,16 @@ target_compile_options(test_raft
 
 target_include_directories(test_raft
     PUBLIC  "$<BUILD_INTERFACE:${RAFT_SOURCE_DIR}/test>"
-            "${FAISS_GPU_HEADERS}"
 )
 
 
 target_link_libraries(test_raft
 PRIVATE
-  raft # transitively links all CUDA libs, etc
-  raft_distance
-  raft_nn
+  raft::raft # transitively links all CUDA libs, etc
+  raft::raft_distance
+  raft::raft_nn
+  NCCL::NCCL
+  faiss::faiss
   GTest::gtest
   GTest::gtest_main
   Threads::Threads