Cutensor bindings

.github/workflows/cmake.yml

@@ -51,7 +51,8 @@ jobs:
         -G Ninja
         -DCMAKE_BUILD_TYPE=${{ matrix.build_type }}
         -DCMAKE_UNITY_BUILD=${{ matrix.build_type == 'Debug' || matrix.valgrind }}
-        -DTAPP_REFERENCE_ENABLE_TBLIS=${{ !matrix.valgrind }}
+        -DTAPP_REFERENCE_USE_TBLIS=${{ !matrix.valgrind }}
+
     steps:
     - uses: actions/checkout@v4
 
@@ -90,6 +91,7 @@ jobs:
       run: |
         sudo apt-get update
         sudo apt-get install ninja-build g++-14 liblapack-dev ccache valgrind
+
     - name: Prepare ccache timestamp
       id: ccache_cache_timestamp
       shell: cmake -P {0}
@@ -136,8 +138,8 @@ jobs:
       working-directory: ${{github.workspace}}/build
       shell: bash
       run: |
-        valgrind --error-exitcode=1 --leak-check=full ./tapp-reference-demo
-        valgrind --error-exitcode=1 --leak-check=full ./tapp-reference-driver
+        valgrind --error-exitcode=1 --leak-check=full ./test/tapp-reference-demo
+        valgrind --error-exitcode=1 --leak-check=full ./examples/tapp-reference-driver
 
     - name: Consume from build tree
       if: ${{ !matrix.valgrind && !matrix.sanitize }}

CMakeLists.txt

@@ -39,8 +39,8 @@ project(tapp
         HOMEPAGE_URL "https://github.com/TAPPOrg/")
 
 # TBLIS requires CXX; enable_language must be called at the top level
-option(TAPP_REFERENCE_ENABLE_TBLIS "Build and link TBLIS and TBLIS bindings" OFF)
-if(TAPP_REFERENCE_ENABLE_TBLIS)
+option(TAPP_REFERENCE_USE_TBLIS "TAPP-Reference will use TBLIS to implement TAPP_product" OFF)
+if(TAPP_REFERENCE_USE_TBLIS)
   include(CheckLanguage)
   check_language(CXX)
   if(CMAKE_CXX_COMPILER)
@@ -65,207 +65,39 @@ set(TAPP_INSTALL_DATADIR "share/tapp/${TAPP_EXT_VERSION}/data"
 set(TAPP_INSTALL_DOCDIR "share/tapp/${TAPP_EXT_VERSION}/doc"
         CACHE PATH "TAPP doc install directory")
 
-# this provides tapp-api target
+# this provides tapp::api target
 add_subdirectory(api)
 
-# this provides tapp-reference target
+# this provides tapp::reference target
 add_subdirectory(reference_implementation)
 
 # ----------------------------------------------------------------------------
-# testing
-
-include(CTest)
-
-if(BUILD_TESTING)
-
-  # ----------------------------------------------------------------------------
-  # TBLIS test
-
-  if(TAPP_REFERENCE_ENABLE_TBLIS)
-    add_executable(tapp-reference-test++)
-
-    target_sources(
-      tapp-reference-test++
-      PRIVATE
-        test/test.cpp
-        test/test.h
-      )
-
-    target_link_libraries(
-      tapp-reference-test++
-      PRIVATE
-        tapp-reference
-        tblis-static
-      )
-
-    set_property(
-      TARGET tapp-reference-test++
-      PROPERTY
-        CXX_STANDARD 20
-        CXX_STANDARD_REQUIRED YES
-        CXX_EXTENSIONS NO
-    )
-
-    add_test(
-      NAME tapp-reference-test++
-      COMMAND $<TARGET_FILE:tapp-reference-test++>
-      )
-  endif()
-
-  # ----------------------------------------------------------------------------
-  # demo
-
-  add_executable(tapp-reference-demo)
-
-  target_sources(
-    tapp-reference-demo
-    PRIVATE
-      test/demo.c
-      test/helpers.c
-      test/helpers.h
-    )
-
-  target_link_libraries(
-    tapp-reference-demo
-    PRIVATE
-      tapp-reference
-    )
-
-  add_test(
-    NAME tapp-reference-demo
-    COMMAND $<TARGET_FILE:tapp-reference-demo>
-    )
-
-  # ----------------------------------------------------------------------------
-  # driver
-
-  add_executable(tapp-reference-driver)
-
-  target_sources(
-    tapp-reference-driver
-    PRIVATE
-      examples/driver/driver.c
-      test/helpers.c
-      test/helpers.h
-    )
-
-  target_include_directories(
-    tapp-reference-driver
-    PRIVATE
-      ${CMAKE_CURRENT_SOURCE_DIR}/test
-    )
-
-  target_link_libraries(
-    tapp-reference-driver
-    PRIVATE
-      tapp-reference
-    )
-
-  add_test(
-    NAME tapp-reference-driver
-    COMMAND $<TARGET_FILE:tapp-reference-driver>
-    )
-
-  # ----------------------------------------------------------------------------
-  # exercise: contraction
-
-  if(TAPP_BUILD_EXERCISE)
-    add_executable(tapp-reference-exercise_contraction)
-
-    target_sources(
-      tapp-reference-exercise_contraction
-      PRIVATE
-        examples/exercise_contraction/exercise_contraction.c
-        test/helpers.c
-        test/helpers.h
-      )
-
-    target_include_directories(
-      tapp-reference-exercise_contraction
-      PRIVATE
-        ${CMAKE_CURRENT_SOURCE_DIR}/test
-      )
-
-    target_link_libraries(
-      tapp-reference-exercise_contraction
-      PRIVATE
-        tapp-reference
-      )
-
-    add_test(
-      NAME tapp-reference-exercise_contraction
-      COMMAND $<TARGET_FILE:tapp-reference-exercise_contraction>
-      )
+# cutensor bindings
+option(TAPP_CUTENSOR "Build cuTensor bindings" OFF)
+if (TAPP_CUTENSOR)
+  # enable_language must be called at the top level
+  include(CheckLanguage)
+  check_language(CXX)
+  if(CMAKE_CXX_COMPILER)
+    enable_language(CXX)
+  else()
+    message(FATAL_ERROR "Cannot build cuTENSOR bindings due to missing CXX language support")
   endif()
+  # since CUDAToolkit will be needed in tests/ also, load it here
+  cmake_minimum_required(VERSION 3.17) # CUDAToolkit
+  find_package(CUDAToolkit REQUIRED)
 
-  # ----------------------------------------------------------------------------
-  # exercise: contraction answers
-
-  add_executable(tapp-reference-exercise_contraction_answers)
-
-  target_sources(
-    tapp-reference-exercise_contraction_answers
-    PRIVATE
-      examples/exercise_contraction/answers/exercise_contraction_answers.c
-      test/helpers.c
-      test/helpers.h
-    )
-
-  target_include_directories(
-    tapp-reference-exercise_contraction_answers
-    PRIVATE
-      ${CMAKE_CURRENT_SOURCE_DIR}/test
-    )
-
-  target_link_libraries(
-    tapp-reference-exercise_contraction_answers
-    PRIVATE
-      tapp-reference
-    )
-
-  add_test(
-    NAME tapp-reference-exercise_contraction_answers
-    COMMAND $<TARGET_FILE:tapp-reference-exercise_contraction_answers>
-    )
-
-  # ----------------------------------------------------------------------------
-  # exercise: tucker
-
-  add_library(tapp-reference-exercise_tucker SHARED)
-
-  target_sources(
-    tapp-reference-exercise_tucker
-    PUBLIC
-      examples/exercise_tucker/tapp_tucker/exercise_tucker.h
-    PRIVATE
-      examples/exercise_tucker/tapp_tucker/exercise_tucker.c
-    )
-
-  target_link_libraries(
-    tapp-reference-exercise_tucker
-    PRIVATE
-      tapp-reference
-    )
-
-  # ----------------------------------------------------------------------------
-  # exercise: tucker answers
-
-  add_library(tapp-reference-exercise_tucker_answers SHARED)
+  add_subdirectory(cutensor_bindings)
+endif()
 
-  target_sources(
-    tapp-reference-exercise_tucker_answers
-    PUBLIC
-      examples/exercise_tucker/tapp_tucker/answers/exercise_tucker_answers.h
-    PRIVATE
-      examples/exercise_tucker/tapp_tucker/answers/exercise_tucker_answers.c
-    )
+# ----------------------------------------------------------------------------
+# testing
 
-  target_link_libraries(
-    tapp-reference-exercise_tucker_answers
-    PRIVATE
-      tapp-reference
-    )
+include(CTest)
 
+if(BUILD_TESTING)
+  add_subdirectory(test)
+  add_subdirectory(examples)
 endif()
 
 # ============================================================================

api/include/tapp/tensor.h

@@ -3,6 +3,7 @@
 
 #include <stdint.h>
 
+#include "handle.h"
 #include "util.h"
 #include "error.h"
 #include "datatype.h"
@@ -20,6 +21,7 @@ typedef intptr_t TAPP_tensor_info;
  */ 
 
 TAPP_EXPORT TAPP_error TAPP_create_tensor_info(TAPP_tensor_info* info,
+                                               TAPP_handle handle,
                                                TAPP_datatype type,
                                                int nmode,
                                                const int64_t* extents,

cutensor_bindings/CMakeLists.txt

@@ -0,0 +1,73 @@
+# cuTENSOR is not part of the CUDA toolkit; look for it separately
+if(NOT TARGET cutensor::cutensor)
+  find_path(CUTENSOR_INCLUDE_DIR
+    NAMES cutensor.h
+    HINTS ${CUTENSOR_ROOT} ENV CUTENSOR_ROOT
+          ${CUDAToolkit_LIBRARY_ROOT}
+    PATH_SUFFIXES include
+  )
+  find_library(CUTENSOR_LIBRARY
+    NAMES cutensor
+    HINTS ${CUTENSOR_ROOT} ENV CUTENSOR_ROOT
+          ${CUDAToolkit_LIBRARY_ROOT}
+    PATH_SUFFIXES lib lib64 lib/${CMAKE_LIBRARY_ARCHITECTURE}
+  )
+
+  if(NOT CUTENSOR_INCLUDE_DIR OR NOT CUTENSOR_LIBRARY)
+    message(FATAL_ERROR "cuTENSOR not found; set CUTENSOR_ROOT to the cuTENSOR installation prefix")
+  endif()
+  message(STATUS "Found cuTENSOR: ${CUTENSOR_LIBRARY}")
+  message(STATUS "cuTENSOR include: ${CUTENSOR_INCLUDE_DIR}")
+
+  add_library(cutensor::cutensor UNKNOWN IMPORTED GLOBAL)
+  set_target_properties(cutensor::cutensor PROPERTIES
+    IMPORTED_LOCATION "${CUTENSOR_LIBRARY}"
+    INTERFACE_INCLUDE_DIRECTORIES "${CUTENSOR_INCLUDE_DIR}"
+  )
+endif()
+
+add_library(tapp-cutensor SHARED)
+set_property(TARGET tapp-cutensor PROPERTY EXPORT_NAME cutensor)
+add_library(tapp::cutensor ALIAS tapp-cutensor)
+target_link_libraries(
+        cutensor::cutensor
+        INTERFACE
+        CUDA::cudart
+)
+
+target_sources(tapp-cutensor
+  PRIVATE
+    src/attributes.cpp
+    src/datatype.cpp
+    src/error.cpp
+    src/executor.cpp
+    src/handle.cpp
+    src/product.cpp
+    src/tensor.cpp
+)
+
+set_target_properties(tapp-cutensor PROPERTIES
+  POSITION_INDEPENDENT_CODE ON
+  CXX_STANDARD 20
+  CXX_STANDARD_REQUIRED YES
+)
+
+target_include_directories(tapp-cutensor
+  PRIVATE
+    ${CMAKE_CURRENT_SOURCE_DIR}/include
+)
+
+target_link_libraries(tapp-cutensor
+  PUBLIC
+    tapp::api
+  PRIVATE
+    cutensor::cutensor
+    CUDA::cudart
+)
+
+install(TARGETS tapp-cutensor EXPORT tapp
+  COMPONENT cutensor)
+
+if(APPLE AND CMAKE_C_COMPILER_ID MATCHES "^(Clang|AppleClang)$")
+  target_link_options(tapp-cutensor PRIVATE "-undefined;dynamic_lookup")
+endif()

cutensor_bindings/include/attributes.h

@@ -0,0 +1,12 @@
+#ifndef TAPP_REF_IMPL_CUTENSOR_BINDINGS_ATTRIBUTES_H_
+#define TAPP_REF_IMPL_CUTENSOR_BINDINGS_ATTRIBUTES_H_
+
+#include <tapp/attributes.h>
+
+#include <cstring>
+
+#include "handle.h"
+
+#define ATTR_KEY_USE_DEVICE_MEMORY 0
+
+#endif /* TAPP_REF_IMPL_CUTENSOR_BINDINGS_ATTRIBUTES_H_ */

cutensor_bindings/include/datatype.h

@@ -0,0 +1,16 @@
+#ifndef TAPP_REF_IMPL_CUTENSOR_BINDINGS_DATATYPE_H_
+#define TAPP_REF_IMPL_CUTENSOR_BINDINGS_DATATYPE_H_
+
+#include <tapp/datatype.h>
+
+#include <cutensor.h>
+
+#include <complex>
+
+cutensorDataType_t translate_datatype(TAPP_datatype type);
+
+cutensorComputeDescriptor_t translate_prectype(TAPP_prectype prec, TAPP_datatype datatype);
+
+size_t sizeof_datatype(TAPP_datatype type);
+
+#endif /* TAPP_REF_IMPL_CUTENSOR_BINDINGS_DATATYPE_H_ */