Implementation of new API

.clang-format

@@ -53,6 +53,7 @@ IndentWrappedFunctionNames: false
 KeepEmptyLinesAtTheStartOfBlocks: false
 MaxEmptyLinesToKeep: 1
 NamespaceIndentation: None
+PenaltyBreakBeforeMemberAccess: 1000
 PenaltyReturnTypeOnItsOwnLine: 400
 PointerAlignment: Left
 ReflowComments: false

.github/workflows/cmake-cuda-multi-compiler.yml

@@ -13,11 +13,11 @@ jobs:
     runs-on: ${{ matrix.os }}
 
     strategy:
-      fail-fast: true
+      fail-fast: false
 
       matrix:
         os: [ubuntu-latest]
-        build_type: [Debug]
+        build_type: [Release]
         cpp_compiler: [g++, clang++]
 
     steps:
@@ -50,8 +50,9 @@ jobs:
           -DKMM_BUILD_TESTS:BOOL=ON
           -DKMM_BUILD_EXAMPLES:BOOL=ON
           -DKMM_BUILD_BENCHMARKS:BOOL=ON
+          -DKMM_ENABLE_WARNINGS:BOOL=OFF
           -S ${{ github.workspace }}
 
       - name: Build
         # Build your program with the given configuration. Note that --config is needed because the default Windows generator is a multi-config generator (Visual Studio generator).
-        run: cmake --build ${{ steps.strings.outputs.build-output-dir }} --config ${{ matrix.build_type }} --parallel 4
+        run: cmake --build ${{ steps.strings.outputs.build-output-dir }} --config ${{ matrix.build_type }}

.github/workflows/cmake-hip.yml

@@ -13,22 +13,27 @@ jobs:
     runs-on: ${{ matrix.os }}
 
     strategy:
-      fail-fast: true
+      fail-fast: false
 
       matrix:
         os: [ubuntu-latest]
-        build_type: [Debug]
+        build_type: [Release]
 
     steps:
-      - uses: loostrum/rocm-installer@main
-        with:
-          version: 6.2.2
-          packages: hip-dev hipcc rocm-device-libs rocblas rocm-hip-runtime-dev rocrand
-
       - uses: actions/checkout@v4
         with:
           submodules: 'recursive'
 
+      - name: Install dependencies
+        run: |
+          sudo apt update
+          sudo apt install python3-setuptools python3-wheel
+          wget https://repo.radeon.com/amdgpu-install/6.3.4/ubuntu/noble/amdgpu-install_6.3.60304-1_all.deb
+          sudo apt install ./amdgpu-install_6.3.60304-1_all.deb
+          rm ./amdgpu-install_6.3.60304-1_all.deb
+          sudo apt update
+          sudo apt install hip-dev hipcc rocm-device-libs rocblas rocm-hip-runtime-dev rocrand hipcub-dev
+
       - name: Set reusable strings
         # Turn repeated input strings (such as the build output directory) into step outputs. These step outputs can be used throughout the workflow file.
         id: strings
@@ -42,18 +47,21 @@ jobs:
         run: >
           cmake -B ${{ steps.strings.outputs.build-output-dir }}
           -DCMAKE_PREFIX_PATH=/opt/rocm
+          -DCMAKE_CXX_COMPILER:PATH=/opt/rocm/bin/amdclang++
           -DCMAKE_HIP_COMPILER_ROCM_ROOT:PATH=/opt/rocm
           -DCMAKE_HIP_ARCHITECTURES=gfx90a
           -DAMDGPU_TARGETS=gfx90a
+          -DCMAKE_HIP_COMPILER:PATH=/opt/rocm/bin/amdclang++
           -DCMAKE_BUILD_TYPE=${{ matrix.build_type }}
           -DCMAKE_VERBOSE_MAKEFILE:BOOL=ON
           -DSPDLOG_FMT_EXTERNAL:BOOL=ON
           -DKMM_USE_HIP:BOOL=ON
           -DKMM_BUILD_TESTS:BOOL=ON
           -DKMM_BUILD_EXAMPLES:BOOL=ON
           -DKMM_BUILD_BENCHMARKS:BOOL=ON
+          -DKMM_ENABLE_WARNINGS:BOOL=OFF
           -S ${{ github.workspace }}
 
       - name: Build
         # Build your program with the given configuration. Note that --config is needed because the default Windows generator is a multi-config generator (Visual Studio generator).
-        run: cmake --build ${{ steps.strings.outputs.build-output-dir }} --config ${{ matrix.build_type }} --parallel 4
+        run: cmake --build ${{ steps.strings.outputs.build-output-dir }} --config ${{ matrix.build_type }}

.github/workflows/cmake-multi-compiler.yml

@@ -13,11 +13,11 @@ jobs:
     runs-on: ${{ matrix.os }}
 
     strategy:
-      fail-fast: true
+      fail-fast: false
 
       matrix:
         os: [ubuntu-latest, macos-latest]
-        build_type: [Debug]
+        build_type: [Release]
         cpp_compiler: [g++, clang++]
 
     steps:
@@ -42,11 +42,12 @@ jobs:
         -DCMAKE_VERBOSE_MAKEFILE:BOOL=ON
         -DSPDLOG_FMT_EXTERNAL:BOOL=ON
         -DKMM_BUILD_TESTS:BOOL=ON
+        -DKMM_ENABLE_WARNINGS:BOOL=OFF
         -S ${{ github.workspace }}
 
     - name: Build
       # Build your program with the given configuration. Note that --config is needed because the default Windows generator is a multi-config generator (Visual Studio generator).
-      run: cmake --build ${{ steps.strings.outputs.build-output-dir }} --config ${{ matrix.build_type }} --parallel 4
+      run: cmake --build ${{ steps.strings.outputs.build-output-dir }} --config ${{ matrix.build_type }}
 
     - name: Test
       working-directory: ${{ steps.strings.outputs.build-output-dir }}

.gitignore

@@ -5,3 +5,6 @@ cmake-build*
 # Editors
 .idea/
 .vscode/
+
+# Generated docs
+docs/html/

.gitmodules

@@ -7,3 +7,6 @@
 [submodule "external/Catch2"]
 	path = external/Catch2
 	url = https://github.com/catchorg/Catch2.git
+[submodule "external/unordered_dense"]
+	path = external/unordered_dense
+	url = https://github.com/martinus/unordered_dense

CMakeLists.txt

@@ -2,7 +2,7 @@ cmake_minimum_required(VERSION 3.10)
 
 # Project setup
 set(PROJECT_NAME "kmm")
-project(${PROJECT_NAME} LANGUAGES CXX VERSION 0.3)
+project(${PROJECT_NAME} LANGUAGES CXX VERSION 0.4.0)
 
 # User options (features)
 option(KMM_STATIC   "Build a static library" OFF)
@@ -14,6 +14,7 @@ option(KMM_ENABLE_LINTER  "Enable clang-tidy linter" OFF)
 option(KMM_BUILD_TESTS    "Build tests" OFF)
 option(KMM_BUILD_EXAMPLES "Build examples" OFF)
 option(KMM_BUILD_BENCHMARKS "Build benchmarks" OFF)
+option(KMM_ENABLE_WARNINGS "Enable -Wall -Wextra -Wconversion" ON)
 
 # Check options
 if(KMM_USE_CUDA AND KMM_USE_HIP)
@@ -29,8 +30,11 @@ file(GLOB_RECURSE sources
   "${PROJECT_SOURCE_DIR}/src/*.cu"
 )
 
-# Exclude backend implementation files from compilation, as they are included in `src/core/backends.cpp`
-list(FILTER sources EXCLUDE REGEX "src/backends/(cuda|hip|cpu)\\.cpp$")
+list(FILTER sources EXCLUDE REGEX "src/utils/backends/cpu.cpp")
+
+if(NOT KMM_USE_CUDA AND NOT KMM_USE_HIP)
+  list(APPEND sources "${PROJECT_SOURCE_DIR}/src/utils/backends/cpu.cpp")
+endif()
 
 # Create library
 if(KMM_STATIC)
@@ -53,7 +57,8 @@ endif()
 target_compile_options(${PROJECT_NAME}
         PUBLIC
         $<$<COMPILE_LANGUAGE:CUDA>:-forward-unknown-to-host-compiler>
-        -Wall -Wextra -Wconversion -Wno-unused-parameter
+        "$<$<BOOL:${KMM_ENABLE_WARNINGS}>:-Wall;-Wextra;-Wconversion;-Wno-unused-parameter>"
+        $<$<NOT:$<BOOL:${KMM_ENABLE_WARNINGS}>>:-w>
         #$<$<COMPILE_LANGUAGE:CUDA>:-Xcompiler=-Werror>
 )
 target_compile_options(${PROJECT_NAME} PUBLIC ${CXXFLAGS})
@@ -73,6 +78,10 @@ set(SPDLOG_BUILD_PIC ON)
 add_subdirectory(external/spdlog)
 target_link_libraries(${PROJECT_NAME} PUBLIC spdlog)
 
+# Dependencies: unordered_dense
+add_subdirectory(external/unordered_dense)
+target_link_libraries(${PROJECT_NAME} PUBLIC unordered_dense::unordered_dense)
+
 # Install
 include(GNUInstallDirs)
 set_target_properties(
@@ -143,13 +152,31 @@ elseif(KMM_USE_HIP)
   set(CMAKE_MODULE_PATH "${HIP_PATH}/cmake" ${CMAKE_MODULE_PATH})
   find_package(HIP REQUIRED)
   find_package(ROCBLAS REQUIRED)
-  set_source_files_properties(${sources} PROPERTIES LANGUAGE HIP)
+  find_package(hipcub REQUIRED)
+  # CMake only recognizes .cu as CUDA by default, so the actual GPU kernel files (which need to be
+  # compiled by amdclang++'s HIP frontend) must be reassigned explicitly. Plain .cpp files must
+  # stay as CXX -- forcing them to HIP too makes amdclang++ run a device-code compilation pass on
+  # files with no device code, which fails since they never include <hip/hip_runtime.h>.
+  set(hip_kernel_sources ${sources})
+  list(FILTER hip_kernel_sources INCLUDE REGEX "\\.cu$")
+  set_source_files_properties(${hip_kernel_sources} PROPERTIES LANGUAGE HIP)
+
+  # `enable_language(HIP)` above means CMake's native HIP-language support already knows how to
+  # compile the HIP-language kernel sources (invoking amdclang++ with the right -x hip flag and
+  # architecture), the same way CUDA_ARCHITECTURES drives .cu compilation in the CUDA branch. We
+  # deliberately do NOT link hip::device here: it exists for the legacy pattern of writing device
+  # code directly in .cpp files, and does so by force-injecting -x hip onto every CXX-language
+  # source in the target -- which breaks plain host .cpp files that never include hip headers.
+  set_target_properties(
+          ${PROJECT_NAME}
+          PROPERTIES
+          HIP_ARCHITECTURES "gfx90a"
+  )
   target_link_libraries(${PROJECT_NAME}
           PUBLIC
           hip::host
           roc::rocblas
-          PRIVATE
-          hip::device
+          hip::hipcub
   )
 
   # Define `KMM_USE_HIP` macro so that headers can detect HIP usage
@@ -171,4 +198,4 @@ endif()
 # Compile benchmarks
 if(KMM_BUILD_BENCHMARKS)
   add_subdirectory(benchmarks)
-endif()
+endif()

LICENSE

@@ -199,3 +199,4 @@
    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.
+

Makefile

@@ -1,12 +1,13 @@
 CLANG_FORMAT=clang-format --verbose
 
 pretty:
-	${CLANG_FORMAT} -i include/kmm/*.hpp include/kmm/*/*.hpp
-	$(CLANG_FORMAT) -i src/*/*.cpp src/*/*.cu src/*/*.cuh
-	${CLANG_FORMAT} -i test/*/*.cpp
-	${CLANG_FORMAT} -i examples/*.cu
-	${CLANG_FORMAT} -i benchmarks/*.cu
+	find include src test examples \
+		\( -name '*.hpp' -o -name '*.cpp' -o -name '*.cu' -o -name '*.cuh' \) -type f -print0 \
+		| xargs -0 -r ${CLANG_FORMAT} -i
+
+docs:
+	cd docs && doxygen Doxyfile
 
 all: pretty
 
-.PHONY : pretty
+.PHONY : pretty docs

README.md

@@ -84,4 +84,5 @@ int main() {
 
 ## License
 
-KMM is made available under the terms of the Apache License version 2.0, see the file LICENSE for details.
+KMM is made available under the terms of the Apache License version 2.0, see the LICENSE file for details.
+