Add support for generic device tests & CMake cleanup #1044

upsj · 2022-05-23T22:15:50Z

Make sure CMake variables are stable across multiple calls
Make sure CMake variables are defined at the highest possible scope so they are available everywhere
Add support for generic tests using common kernels (needed for Add kernels for Csr sparsity pattern lookup #994)
Work around HIP issues

yhmtsai · 2022-06-20T10:20:56Z

Are some of them from the lookuptable pr?

upsj · 2022-06-20T10:23:05Z

some of the tests were left out from the csr lookup PR, yes.

yhmtsai · 2022-06-23T12:40:39Z

cmake/cuda.cmake

+    endif()
+endif()
+
+include(cmake/Modules/CudaArchitectureSelector.cmake)


should we remove the third_party?

since this is now being called from the root CMakeLists.txt instead of the cuda CMakeLists.txt, I would prefer removing the third_party link to CAS, yes. Do you see any benefit from keeping it (also allowing external CAS, as discussed elsewhere)?

no from both sides. I am not sure whether we move back to a dependency way at some point.

As our minimum CMake version grows, we will probably move to CMake's CUDA_ARCHITECTURES target property at some point, anyways? I think CAS will be slimmed down significantly then.

cmake/hip_path.cmake

examples/custom-stopping-criterion/CMakeLists.txt

third_party/CMakeLists.txt

third_party/CudaArchitectureSelector/CMakeLists.txt

test/base/kernel_launch_generic.cpp

yhmtsai · 2022-06-24T12:17:11Z

cmake/create_test.cmake

+
+## Adds a test to the list executed by ctest and sets its output binary name
+function(ginkgo_add_test test_name test_target_name)
+    cmake_parse_arguments(PARSE_ARGV 2 add_test "" "MPI_SIZE" "DISABLE_EXECUTORS;ADDITIONAL_LIBRARIES;ADDITIONAL_INCLUDES")


no use for the DISABLE_EXECUTORS;ADDITIONAL_LIBRARIES;ADDITIONAL_INCLUDES

they still need to be handled, since they may be passed on from surrounding ginkgo_add_*_test calls.

cmake/create_test.cmake

tcojean

LGTM. Nice refactoring of the CMake code

examples/custom-stopping-criterion/CMakeLists.txt

cmake/hip.cmake

CMakeLists.txt

cmake/create_test.cmake

yhmtsai

Could you also revert this commit 6514704?
It does not show conflict when rebasing, so I forgot I did it in that pr.

yhmtsai · 2022-07-11T15:07:52Z

dpcpp/CMakeLists.txt

-target_compile_features(ginkgo_dpcpp PRIVATE cxx_std_17)
+target_compile_features(ginkgo_dpcpp PUBLIC cxx_std_17)


is it required to be public?
If it is, need to change the ReadME.md description in dpcpp module

I think it is safer to make sure all pieces of Ginkgo use the same compiler and standard version, otherwise we may get subtle binary incompatibilities.

cmake/create_test.cmake

yhmtsai · 2022-07-12T09:07:42Z

cmake/create_test.cmake

+endfunction(ginkgo_create_cuda_test)
+
+## Internal function allowing separate test name, filename and target name
+function(ginkgo_create_cuda_test_internal test_name filename test_target_name)


Interesting. cmake does not require the function declaration before usage.

yhmtsai · 2022-07-12T09:12:38Z

cmake/create_test.cmake

+    ginkgo_build_test_name(${test_name} test_target_name)
+    if(GINKGO_BUILD_DPCPP)
+        ginkgo_create_common_test_internal(${test_name} DpcppExecutor dpcpp ${ARGN})
+        target_compile_features(${test_target_name}_dpcpp PRIVATE cxx_std_17)


the c++17 concern from Terry's comment is handled here. without public, it should also work

This reverts commit 6514704.

* pass the same variadic arguments around everywhere * make MPI a parameter instead of a separate test category * remove separate test categories for device headers and Threads * add support for common device tests * add a test using that support

Running CMake multiple times could produce inconsistent results. This can be fixed my making sure all variables are set before use

They are already handled in hip.cmake

FindHIP.cmake incorrectly handles shared libraries due to scoping

- fix dpcpp execution on GPUs - make cxx_17 property public - formatting - add comments to add_test functions

sonarqubecloud · 2022-07-12T15:44:44Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
36 Code Smells

93.9% Coverage
11.5% Duplication

codecov · 2022-07-12T16:20:07Z

Codecov Report

Merging #1044 (650838d) into develop (4726fed) will decrease coverage by 3.31%.
The diff coverage is 93.66%.

@@             Coverage Diff             @@
##           develop    #1044      +/-   ##
===========================================
- Coverage    93.82%   90.50%   -3.32%     
===========================================
  Files          504      505       +1     
  Lines        43253    43861     +608     
===========================================
- Hits         40580    39698     -882     
- Misses        2673     4163    +1490

Impacted Files	Coverage Δ
core/matrix/csr_lookup.hpp	`97.02% <ø> (ø)`
test/matrix/csr_kernels.cpp	`94.82% <88.00%> (-5.18%)`	⬇️
test/base/kernel_launch_generic.cpp	`95.32% <95.32%> (ø)`
test/matrix/matrix.cpp	`0.00% <0.00%> (-97.59%)`	⬇️
common/unified/matrix/sellp_kernels.cpp	`8.82% <0.00%> (-87.73%)`	⬇️
common/unified/matrix/ell_kernels.cpp	`22.64% <0.00%> (-77.36%)`	⬇️
common/unified/matrix/hybrid_kernels.cpp	`34.88% <0.00%> (-65.12%)`	⬇️
core/test/mpi/base/communicator.cpp	`35.13% <0.00%> (-64.87%)`	⬇️
common/unified/matrix/csr_kernels.cpp	`52.30% <0.00%> (-47.70%)`	⬇️
include/ginkgo/core/base/mpi.hpp	`54.38% <0.00%> (-41.54%)`	⬇️
... and 29 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4726fed...650838d. Read the comment docs.

Advertise release 1.5.0 and last changes + Add changelog, + Update third party libraries + A small fix to a CMake file See PR: #1195 The Ginkgo team is proud to announce the new Ginkgo minor release 1.5.0. This release brings many important new features such as: - MPI-based multi-node support for all matrix formats and most solvers; - full DPC++/SYCL support, - functionality and interface for GPU-resident sparse direct solvers, - an interface for wrapping solvers with scaling and reordering applied, - a new algebraic Multigrid solver/preconditioner, - improved mixed-precision support, - support for device matrix assembly, and much more. If you face an issue, please first check our [known issues page](https://github.com/ginkgo-project/ginkgo/wiki/Known-Issues) and the [open issues list](https://github.com/ginkgo-project/ginkgo/issues) and if you do not find a solution, feel free to [open a new issue](https://github.com/ginkgo-project/ginkgo/issues/new/choose) or ask a question using the [github discussions](https://github.com/ginkgo-project/ginkgo/discussions). Supported systems and requirements: + For all platforms, CMake 3.13+ + C++14 compliant compiler + Linux and macOS + GCC: 5.5+ + clang: 3.9+ + Intel compiler: 2018+ + Apple LLVM: 8.0+ + NVHPC: 22.7+ + Cray Compiler: 14.0.1+ + CUDA module: CUDA 9.2+ or NVHPC 22.7+ + HIP module: ROCm 4.0+ + DPC++ module: Intel OneAPI 2021.3 with oneMKL and oneDPL. Set the CXX compiler to `dpcpp`. + Windows + MinGW and Cygwin: GCC 5.5+ + Microsoft Visual Studio: VS 2019 + CUDA module: CUDA 9.2+, Microsoft Visual Studio + OpenMP module: MinGW or Cygwin. Algorithm and important feature additions: + Add MPI-based multi-node for all matrix formats and solvers (except GMRES and IDR). ([#676](#676), [#908](#908), [#909](#909), [#932](#932), [#951](#951), [#961](#961), [#971](#971), [#976](#976), [#985](#985), [#1007](#1007), [#1030](#1030), [#1054](#1054), [#1100](#1100), [#1148](#1148)) + Porting the remaining algorithms (preconditioners like ISAI, Jacobi, Multigrid, ParILU(T) and ParIC(T)) to DPC++/SYCL, update to SYCL 2020, and improve support and performance ([#896](#896), [#924](#924), [#928](#928), [#929](#929), [#933](#933), [#943](#943), [#960](#960), [#1057](#1057), [#1110](#1110), [#1142](#1142)) + Add a Sparse Direct interface supporting GPU-resident numerical LU factorization, symbolic Cholesky factorization, improved triangular solvers, and more ([#957](#957), [#1058](#1058), [#1072](#1072), [#1082](#1082)) + Add a ScaleReordered interface that can wrap solvers and automatically apply reorderings and scalings ([#1059](#1059)) + Add a Multigrid solver and improve the aggregation based PGM coarsening scheme ([#542](#542), [#913](#913), [#980](#980), [#982](#982), [#986](#986)) + Add infrastructure for unified, lambda-based, backend agnostic, kernels and utilize it for some simple kernels ([#833](#833), [#910](#910), [#926](#926)) + Merge different CUDA, HIP, DPC++ and OpenMP tests under a common interface ([#904](#904), [#973](#973), [#1044](#1044), [#1117](#1117)) + Add a device_matrix_data type for device-side matrix assembly ([#886](#886), [#963](#963), [#965](#965)) + Add support for mixed real/complex BLAS operations ([#864](#864)) + Add a FFT LinOp for all but DPC++/SYCL ([#701](#701)) + Add FBCSR support for NVIDIA and AMD GPUs and CPUs with OpenMP ([#775](#775)) + Add CSR scaling ([#848](#848)) + Add array::const_view and equivalent to create constant matrices from non-const data ([#890](#890)) + Add a RowGatherer LinOp supporting mixed precision to gather dense matrix rows ([#901](#901)) + Add mixed precision SparsityCsr SpMV support ([#970](#970)) + Allow creating CSR submatrix including from (possibly discontinuous) index sets ([#885](#885), [#964](#964)) + Add a scaled identity addition (M <- aI + bM) feature interface and impls for Csr and Dense ([#942](#942)) Deprecations and important changes: + Deprecate AmgxPgm in favor of the new Pgm name. ([#1149](#1149)). + Deprecate specialized residual norm classes in favor of a common `ResidualNorm` class ([#1101](#1101)) + Deprecate CamelCase non-polymorphic types in favor of snake_case versions (like array, machine_topology, uninitialized_array, index_set) ([#1031](#1031), [#1052](#1052)) + Bug fix: restrict gko::share to rvalue references (*possible interface break*) ([#1020](#1020)) + Bug fix: when using cuSPARSE's triangular solvers, specifying the factory parameter `num_rhs` is now required when solving for more than one right-hand side, otherwise an exception is thrown ([#1184](#1184)). + Drop official support for old CUDA < 9.2 ([#887](#887)) Improved performance additions: + Reuse tmp storage in reductions in solvers and add a mutable workspace to all solvers ([#1013](#1013), [#1028](#1028)) + Add HIP unsafe atomic option for AMD ([#1091](#1091)) + Prefer vendor implementations for Dense dot, conj_dot and norm2 when available ([#967](#967)). + Tuned OpenMP SellP, COO, and ELL SpMV kernels for a small number of RHS ([#809](#809)) Fixes: + Fix various compilation warnings ([#1076](#1076), [#1183](#1183), [#1189](#1189)) + Fix issues with hwloc-related tests ([#1074](#1074)) + Fix include headers for GCC 12 ([#1071](#1071)) + Fix for simple-solver-logging example ([#1066](#1066)) + Fix for potential memory leak in Logger ([#1056](#1056)) + Fix logging of mixin classes ([#1037](#1037)) + Improve value semantics for LinOp types, like moved-from state in cross-executor copy/clones ([#753](#753)) + Fix some matrix SpMV and conversion corner cases ([#905](#905), [#978](#978)) + Fix uninitialized data ([#958](#958)) + Fix CUDA version requirement for cusparseSpSM ([#953](#953)) + Fix several issues within bash-script ([#1016](#1016)) + Fixes for `NVHPC` compiler support ([#1194](#1194)) Other additions: + Simplify and properly name GMRES kernels ([#861](#861)) + Improve pkg-config support for non-CMake libraries ([#923](#923), [#1109](#1109)) + Improve gdb pretty printer ([#987](#987), [#1114](#1114)) + Add a logger highlighting inefficient allocation and copy patterns ([#1035](#1035)) + Improved and optimized test random matrix generation ([#954](#954), [#1032](#1032)) + Better CSR strategy defaults ([#969](#969)) + Add `move_from` to `PolymorphicObject` ([#997](#997)) + Remove unnecessary device_guard usage ([#956](#956)) + Improvements to the generic accessor for mixed-precision ([#727](#727)) + Add a naive lower triangular solver implementation for CUDA ([#764](#764)) + Add support for int64 indices from CUDA 11 onward with SpMV and SpGEMM ([#897](#897)) + Add a L1 norm implementation ([#900](#900)) + Add reduce_add for arrays ([#831](#831)) + Add utility to simplify Dense View creation from an existing Dense vector ([#1136](#1136)). + Add a custom transpose implementation for Fbcsr and Csr transpose for unsupported vendor types ([#1123](#1123)) + Make IDR random initilization deterministic ([#1116](#1116)) + Move the algorithm choice for triangular solvers from Csr::strategy_type to a factory parameter ([#1088](#1088)) + Update CUDA archCoresPerSM ([#1175](#1116)) + Add kernels for Csr sparsity pattern lookup ([#994](#994)) + Differentiate between structural and numerical zeros in Ell/Sellp ([#1027](#1027)) + Add a binary IO format for matrix data ([#984](#984)) + Add a tuple zip_iterator implementation ([#966](#966)) + Simplify kernel stubs and declarations ([#888](#888)) + Simplify GKO_REGISTER_OPERATION with lambdas ([#859](#859)) + Simplify copy to device in tests and examples ([#863](#863)) + More verbose output to array assertions ([#858](#858)) + Allow parallel compilation for Jacobi kernels ([#871](#871)) + Change clang-format pointer alignment to left ([#872](#872)) + Various improvements and fixes to the benchmarking framework ([#750](#750), [#759](#759), [#870](#870), [#911](#911), [#1033](#1033), [#1137](#1137)) + Various documentation improvements ([#892](#892), [#921](#921), [#950](#950), [#977](#977), [#1021](#1021), [#1068](#1068), [#1069](#1069), [#1080](#1080), [#1081](#1081), [#1108](#1108), [#1153](#1153), [#1154](#1154)) + Various CI improvements ([#868](#868), [#874](#874), [#884](#884), [#889](#889), [#899](#899), [#903](#903), [#922](#922), [#925](#925), [#930](#930), [#936](#936), [#937](#937), [#958](#958), [#882](#882), [#1011](#1011), [#1015](#1015), [#989](#989), [#1039](#1039), [#1042](#1042), [#1067](#1067), [#1073](#1073), [#1075](#1075), [#1083](#1083), [#1084](#1084), [#1085](#1085), [#1139](#1139), [#1178](#1178), [#1187](#1187))

upsj added the 1:ST:ready-for-review This PR is ready for review label May 23, 2022

upsj added this to the Ginkgo 1.5.0 milestone May 23, 2022

upsj requested review from yhmtsai and tcojean May 23, 2022 22:15

upsj self-assigned this May 23, 2022

upsj requested a review from a team May 23, 2022 22:20

upsj force-pushed the cmake_generic_tests branch 3 times, most recently from 3180100 to 0a25be5 Compare May 23, 2022 22:45

upsj force-pushed the csr_lookup branch from 1a50064 to a851a72 Compare May 24, 2022 10:39

Base automatically changed from csr_lookup to develop May 24, 2022 17:31

upsj force-pushed the cmake_generic_tests branch from 0a25be5 to d00f38d Compare June 20, 2022 10:22

upsj mentioned this pull request Jun 20, 2022

add oneMKL csr and optimized csr to benchmark #1057

Merged

yhmtsai reviewed Jun 24, 2022

View reviewed changes

tcojean approved these changes Jun 24, 2022

View reviewed changes

upsj force-pushed the cmake_generic_tests branch 2 times, most recently from de39f67 to bfd82a9 Compare July 1, 2022 10:43

upsj force-pushed the cmake_generic_tests branch 2 times, most recently from 3350a14 to 26dd6e7 Compare July 6, 2022 17:06

upsj added the 1:ST:run-full-test label Jul 6, 2022

upsj requested a review from yhmtsai July 7, 2022 07:26

yhmtsai approved these changes Jul 12, 2022

View reviewed changes

upsj added 11 commits July 12, 2022 12:26

Revert "relax time limit for test/matrix/matrix_exec"

e8e870e

This reverts commit 6514704.

find CUDA, Threads & OpenMP from root CMakeLists.txt

8e0f93d

refactor create_test.cmake

e853b69

* pass the same variadic arguments around everywhere * make MPI a parameter instead of a separate test category * remove separate test categories for device headers and Threads * add support for common device tests * add a test using that support

test csr lookup on the device

285c965

fix unstable cmake configuration

3dd8e51

Running CMake multiple times could produce inconsistent results. This can be fixed my making sure all variables are set before use

clean up unnecessary find_package calls

fe3011e

They are already handled in hip.cmake

fix HIP compilation

766198f

FindHIP.cmake incorrectly handles shared libraries due to scoping

review updates

295c555

- fix dpcpp execution on GPUs - make cxx_17 property public - formatting - add comments to add_test functions

fix multi-parameter cmake_parse_arguments

ef7b8b9

fix DPC++ generic tests

74d41c4

fix HIP compilation

0bccf12

upsj force-pushed the cmake_generic_tests branch from 26dd6e7 to 0bccf12 Compare July 12, 2022 11:11

use C++17 consistently for DPC++ in README

650838d

upsj added 1:ST:ready-to-merge This PR is ready to merge. and removed 1:ST:ready-for-review This PR is ready for review 1:ST:run-full-test labels Jul 12, 2022

upsj merged commit 25e3f6d into develop Jul 12, 2022

upsj deleted the cmake_generic_tests branch July 12, 2022 16:45

upsj mentioned this pull request Nov 1, 2022

Benchmarking sparse functionality #1155

Closed

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for generic device tests & CMake cleanup #1044

Add support for generic device tests & CMake cleanup #1044

upsj commented May 23, 2022

yhmtsai commented Jun 20, 2022

upsj commented Jun 20, 2022

yhmtsai Jun 23, 2022

upsj Jun 24, 2022

yhmtsai Jul 12, 2022

upsj Jul 12, 2022

yhmtsai Jun 24, 2022

upsj Jun 24, 2022

tcojean left a comment

yhmtsai left a comment

yhmtsai Jul 11, 2022

upsj Jul 12, 2022

yhmtsai Jul 12, 2022

yhmtsai Jul 12, 2022

sonarqubecloud bot commented Jul 12, 2022

codecov bot commented Jul 12, 2022 •

edited

Loading

		target_compile_features(ginkgo_dpcpp PRIVATE cxx_std_17)
		target_compile_features(ginkgo_dpcpp PUBLIC cxx_std_17)

Add support for generic device tests & CMake cleanup #1044

Add support for generic device tests & CMake cleanup #1044

Conversation

upsj commented May 23, 2022

yhmtsai commented Jun 20, 2022

upsj commented Jun 20, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tcojean left a comment

Choose a reason for hiding this comment

yhmtsai left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Jul 12, 2022

codecov bot commented Jul 12, 2022 • edited Loading

Codecov Report

codecov bot commented Jul 12, 2022 •

edited

Loading