Install test

.github/workflows/build_test.yaml

@@ -154,24 +154,19 @@ jobs:
           path: tests_${{ matrix.backend.name }}.tar
         if: ${{ matrix.target.name == 'native' }}
 
-      - name: Install
+      - name: Use KokkosFFT as a subdirectory in a CMake project
         run: |
           docker run -v ${{ github.workspace }}:/work ghcr.io/cexa-project/kokkos-fft/base_${{ matrix.backend.image }}_${{ needs.check_docker_files.outputs.image_suffix }}:${{ needs.check_docker_files.outputs.image_tag }} \
-            cmake --install build
+            ./install_test/as_subdirectory/as_subdirectory.sh /tmp ${{env.BUILD_TYPE}} ${{ matrix.backend.c_compiler }} ${{ matrix.backend.cxx_compiler }} \
+            ${{ matrix.backend.cmake_flags }} ${{ matrix.target.cmake_flags }}
+        if: ${{ matrix.target.name == 'native' }}
 
-      - name: Configure and build test code
-        # Use the built and installed Kokkos FFT library to build a test code
+      - name: Use KokkosFFT as a library in a CMake project
         run: |
           docker run -v ${{ github.workspace }}:/work ghcr.io/cexa-project/kokkos-fft/base_${{ matrix.backend.image }}_${{ needs.check_docker_files.outputs.image_suffix }}:${{ needs.check_docker_files.outputs.image_tag }} \
-            cmake -B build_test \
-            -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} \
-            -DCMAKE_C_COMPILER=${{ matrix.backend.c_compiler }} \
-            -DCMAKE_CXX_COMPILER=${{ matrix.backend.cxx_compiler }} \
-            -DCMAKE_CXX_STANDARD=17 \
-            -DCMAKE_PREFIX_PATH=/work/install \
-            install_test
-          docker run -v ${{ github.workspace }}:/work ghcr.io/cexa-project/kokkos-fft/base_${{ matrix.backend.image }}_${{ needs.check_docker_files.outputs.image_suffix }}:${{ needs.check_docker_files.outputs.image_tag }} \
-            cmake --build build_test -j $(( $(nproc) * 2 + 1 ))
+            ./install_test/as_library/as_library.sh /tmp ${{env.BUILD_TYPE}} ${{ matrix.backend.c_compiler }} ${{ matrix.backend.cxx_compiler }} \
+            ${{ matrix.backend.cmake_flags }} ${{ matrix.target.cmake_flags }}
+        if: ${{ matrix.target.name == 'native' }}
 
   test:
     runs-on: ${{ matrix.backend.runner }}

CMakeLists.txt

@@ -25,17 +25,13 @@ set(KOKKOSFFT_VERSION_MAJOR ${PROJECT_VERSION_MAJOR})
 set(KOKKOSFFT_VERSION_MINOR ${PROJECT_VERSION_MINOR})
 set(KOKKOSFFT_VERSION_PATCH ${PROJECT_VERSION_PATCH})
 
-set(KOKKOS_REQUIRED_VERSION "4.2.00")
+set(KOKKOS_REQUIRED_VERSION 4.2.0)
 
 if (NOT KokkosFFT_ENABLE_INTERNAL_KOKKOS)
     # First check, Kokkos is added as subdirectory or not
     if(NOT TARGET Kokkos::kokkos)
-        find_package(Kokkos REQUIRED)
+        find_package(Kokkos ${KOKKOS_REQUIRED_VERSION} REQUIRED)
     endif()
-
-    # Kokkos version check
-    include(Kokkos_Version_Check)
-    check_minimum_required_kokkos(${KOKKOS_REQUIRED_VERSION})
 else ()
     add_subdirectory(tpls/kokkos)
 endif ()

install_test/as_library/CMakeLists.txt

@@ -0,0 +1,8 @@
+cmake_minimum_required(VERSION 3.23)
+project(kokkos-fft-as-library LANGUAGES CXX)
+
+find_package(Kokkos CONFIG REQUIRED)
+find_package(KokkosFFT CONFIG REQUIRED)
+
+add_executable(hello-kokkos-fft hello.cpp)
+target_link_libraries(hello-kokkos-fft PUBLIC Kokkos::kokkos KokkosFFT::fft)

install_test/as_library/as_library.sh

@@ -0,0 +1,94 @@
+#!/bin/bash
+
+args=$#
+WK_DIR=$(pwd)
+ROOT_DIR=$1
+BUILD_TYPE=$2
+C_COMPILER=$3
+CXX_COMPILER=$4
+
+if [ $args -eq 5 ]; then
+    # CPU build
+    # e.g
+    # /tmp Release gcc g++ -DKokkos_ENABLE_THREADS=ON
+    BACKEND_FLAG=$5
+    TARGET_FLAG=$6
+elif [ $args -eq 6 ]; then
+    # GPU build without target flag
+    # e.g.
+    # /tmp Release gcc g++ \
+    # -DKokkos_ENABLE_CUDA=ON -DKokkos_ARCH_AMPERE80=ON 
+    BACKEND_FLAG0=$5
+    BACKEND_FLAG1=$6
+    BACKEND_FLAG="${BACKEND_FLAG0} ${BACKEND_FLAG1}"
+    TARGET_FLAG=$7
+elif [ $args -eq 7 ]; then
+    # GPU build with target flag
+    # e.g.
+    # /tmp Release gcc g++ \
+    # -DKokkos_ENABLE_CUDA=ON -DKokkos_ARCH_AMPERE80=ON -DKokkosFFT_ENABLE_HOST_AND_DEVICE=ON
+    BACKEND_FLAG0=$5
+    BACKEND_FLAG1=$6
+    BACKEND_FLAG="${BACKEND_FLAG0} ${BACKEND_FLAG1}"
+    TARGET_FLAG=$7
+else
+    echo "*** Error: Number of arguments must be 5, 6 or 7 ***"
+    exit 1;
+fi
+
+# Install Kokkos
+export KOKKOS_INSTALL_PREFIX=${ROOT_DIR}/usr/local/kokkos
+export KOKKOS_BUILD_DIR=build_Kokkos
+
+export KOKKOSFFT_INSTALL_PREFIX=${ROOT_DIR}/usr/local/kokkosFFT
+export KOKKOSFFT_BUILD_DIR=build_KokkosFFT
+
+export EXAMPLE_BUILD_DIR=build_example
+
+# Install Kokkos
+# Get Kokkos from tpls/kokkos and build
+cd ${WK_DIR}
+mkdir ${KOKKOS_BUILD_DIR} && cd ${KOKKOS_BUILD_DIR}
+cp -r ../tpls/kokkos .
+cmake -DCMAKE_INSTALL_PREFIX=${KOKKOS_INSTALL_PREFIX} \
+      -DCMAKE_BUILD_TYPE=${BUILD_TYPE} \
+      -DCMAKE_C_COMPILER=${C_COMPILER} \
+      -DCMAKE_CXX_COMPILER=${CXX_COMPILER} \
+      -DCMAKE_CXX_STANDARD=17 \
+      ${BACKEND_FLAG} kokkos
+
+cmake --build . -j 8
+cmake --install .
+
+# Install KokkosFFT on pre-installbed Kokkos
+cd ${WK_DIR}
+mkdir ${KOKKOSFFT_BUILD_DIR} && cd ${KOKKOSFFT_BUILD_DIR}
+cmake -DCMAKE_PREFIX_PATH=${KOKKOS_INSTALL_PREFIX} \
+      -DCMAKE_INSTALL_PREFIX=${KOKKOSFFT_INSTALL_PREFIX} \
+      -DCMAKE_BUILD_TYPE=${BUILD_TYPE} \
+      -DCMAKE_C_COMPILER=${C_COMPILER} \
+      -DCMAKE_CXX_COMPILER=${CXX_COMPILER} \
+      -DCMAKE_CXX_STANDARD=17 \
+      ${TARGET_FLAG} ..
+
+cmake --build . -j 8
+cmake --install .
+
+# Try to build an example
+# Build KokkosFFT code using installed KokkosFFT
+cd ${WK_DIR}
+mkdir ${EXAMPLE_BUILD_DIR} && cd ${EXAMPLE_BUILD_DIR}
+cmake -DCMAKE_PREFIX_PATH="${KOKKOS_INSTALL_PREFIX};${KOKKOSFFT_INSTALL_PREFIX}" \
+      -DCMAKE_BUILD_TYPE=${BUILD_TYPE} \
+      -DCMAKE_C_COMPILER=${C_COMPILER} \
+      -DCMAKE_CXX_COMPILER=${CXX_COMPILER} \
+      -DCMAKE_CXX_STANDARD=17 \
+      ../install_test/as_library
+cmake --build . -j 8
+
+if [ $? -eq 0 ]; then
+    echo "*** KokkosFFT as library test: build SUCCESSFUL ***"
+else
+    echo "*** KokkosFFT as library test: build FAILED ***"
+    exit 1;
+fi

install_test/as_subdirectory/CMakeLists.txt

@@ -0,0 +1,8 @@
+cmake_minimum_required(VERSION 3.23)
+project(kokkos-fft-as-subdirectory LANGUAGES CXX)
+
+add_subdirectory(tpls/kokkos)
+add_subdirectory(tpls/kokkos-fft)
+
+add_executable(hello-kokkos-fft hello_again.cpp)
+target_link_libraries(hello-kokkos-fft PUBLIC Kokkos::kokkos KokkosFFT::fft)

install_test/as_subdirectory/as_subdirectory.sh

@@ -0,0 +1,75 @@
+#!/bin/bash
+
+args=$#
+WK_DIR=/tmp/kokkos_fft_as_subdirectory
+SRC_DIR=/work
+ROOT_DIR=$1
+BUILD_TYPE=$2
+C_COMPILER=$3
+CXX_COMPILER=$4
+
+if [ $args -eq 5 ]; then
+    # CPU build
+    # e.g
+    # /tmp Release gcc g++ -DKokkos_ENABLE_THREADS=ON
+    # TARGET_FLAG is empty
+    BACKEND_FLAG=$5
+    TARGET_FLAG=$6
+elif [ $args -eq 6 ]; then
+    # GPU build without target flag
+    # e.g.
+    # /tmp Release gcc g++ \
+    # -DKokkos_ENABLE_CUDA=ON -DKokkos_ARCH_AMPERE80=ON 
+    # TARGET_FLAG is empty
+    BACKEND_FLAG0=$5
+    BACKEND_FLAG1=$6
+    BACKEND_FLAG="${BACKEND_FLAG0} ${BACKEND_FLAG1}"
+    TARGET_FLAG=$7
+elif [ $args -eq 7 ]; then
+    # GPU build with target flag
+    # e.g.
+    # /tmp Release gcc g++ \
+    # -DKokkos_ENABLE_CUDA=ON -DKokkos_ARCH_AMPERE80=ON -DKokkosFFT_ENABLE_HOST_AND_DEVICE=ON
+    BACKEND_FLAG0=$5
+    BACKEND_FLAG1=$6
+    BACKEND_FLAG="${BACKEND_FLAG0} ${BACKEND_FLAG1}"
+    TARGET_FLAG=$7
+else
+    echo "*** Error: Number of arguments must be 5, 6 or 7 ***"
+    exit 1;
+fi
+
+# Make work directory (Project directory)
+mkdir -p ${WK_DIR} && cd ${WK_DIR}
+
+# Copy CMakeLists.txt and hello.cpp
+cp ${SRC_DIR}/install_test/as_subdirectory/* .
+
+# Prepare Kokkos and KokkosFFT under tpls
+mkdir tpls && cd tpls
+
+# Prepare tpls/kokkos 
+git clone https://github.com/kokkos/kokkos.git
+
+# Copy KokkosFFT under tpls/kokkos-fft
+cp -r ${SRC_DIR} kokkos-fft
+
+# Try to build an example
+# Build KokkosFFT code using Kokkos and KokkosFFT as submodules
+
+export EXAMPLE_BUILD_DIR=build_example
+cd ${WK_DIR}
+mkdir ${EXAMPLE_BUILD_DIR} && cd ${EXAMPLE_BUILD_DIR}
+cmake -DCMAKE_CXX_COMPILER=${CXX_COMPILER} \
+      -DCMAKE_BUILD_TYPE=${BUILD_TYPE} \
+      ${BACKEND_FLAG} \
+      ${TARGET_FLAG} ..
+
+cmake --build . -j 8
+
+if [ $? -eq 0 ]; then
+    echo "*** KokkosFFT as subdirectory test: build SUCCESSFUL ***"
+else
+    echo "*** KokkosFFT as subdirectory test: build FAILED ***"
+    exit 1;
+fi

install_test/as_subdirectory/hello_again.cpp

@@ -0,0 +1,44 @@
+#include <Kokkos_Core.hpp>
+#include <Kokkos_Complex.hpp>
+#include <Kokkos_Random.hpp>
+#include <KokkosFFT.hpp>
+
+using execution_space = Kokkos::DefaultExecutionSpace;
+template <typename T>
+using View2D = Kokkos::View<T**, execution_space>;
+
+int main(int argc, char* argv[]) {
+  Kokkos::initialize(argc, argv);
+  {
+    constexpr int n0 = 128, n1 = 128;
+    const Kokkos::complex<double> I(1.0, 1.0);
+
+    // 2D C2C FFT (Forward and Backward)
+    View2D<Kokkos::complex<double> > xc2c("xc2c", n0, n1);
+    View2D<Kokkos::complex<double> > xc2c_hat("xc2c_hat", n0, n1);
+    View2D<Kokkos::complex<double> > xc2c_inv("xc2c_inv", n0, n1);
+
+    Kokkos::Random_XorShift64_Pool<> random_pool(12345);
+    Kokkos::fill_random(xc2c, random_pool, I);
+
+    KokkosFFT::fft2(execution_space(), xc2c, xc2c_hat);
+    KokkosFFT::ifft2(execution_space(), xc2c_hat, xc2c_inv);
+
+    // 2D R2C FFT
+    View2D<double> xr2c("xr2c", n0, n1);
+    View2D<Kokkos::complex<double> > xr2c_hat("xr2c_hat", n0, n1 / 2 + 1);
+    Kokkos::fill_random(xr2c, random_pool, 1);
+
+    KokkosFFT::rfft2(execution_space(), xr2c, xr2c_hat);
+
+    // 2D C2R FFT
+    View2D<Kokkos::complex<double> > xc2r("xr2c_hat", n0, n1 / 2 + 1);
+    View2D<double> xc2r_hat("xc2r", n0, n1);
+    Kokkos::fill_random(xc2r, random_pool, I);
+
+    KokkosFFT::irfft2(execution_space(), xc2r, xc2r_hat);
+  }
+  Kokkos::finalize();
+
+  return 0;
+}