Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add kernels for Csr sparsity pattern lookup #994

Merged
merged 8 commits into from
May 24, 2022
Merged

Add kernels for Csr sparsity pattern lookup #994

merged 8 commits into from
May 24, 2022

Conversation

upsj
Copy link
Member

@upsj upsj commented Mar 23, 2022

This PR adds build_lookup kernels together with a device-independent type of lookup structure that builds a mapping column index -> local nonzero index. It requires sorted column indices and uses, in decreasing order of priority:

  • full storage (contiguous range of column indices)
  • dense storage (use a bitmap containing a 1 for each nonzero that is present)
  • sparse storage (using a hashmap for the mapping)

Together with #938 and #965 it would enable their own device-independent assembly kernels with acceptable performance.

I still need to work a bit on the interface and the Volta-specific optimizations, but I would like to put this out there already

TODO:

  • add interface will do that in a later PR
  • add to sparse_blas benchmark same

Closes #947

@upsj upsj added this to the Ginkgo 1.5.0 milestone Mar 23, 2022
@upsj upsj self-assigned this Mar 23, 2022
@ginkgo-bot ginkgo-bot added mod:all This touches all Ginkgo modules. reg:testing This is related to testing. type:matrix-format This is related to the Matrix formats labels Mar 23, 2022
@upsj upsj force-pushed the csr_lookup branch 2 times, most recently from 57c2999 to 143d565 Compare March 24, 2022 09:51
@upsj upsj added the 1:ST:ready-for-review This PR is ready for review label Apr 11, 2022
@upsj upsj requested a review from a team April 11, 2022 15:36
Copy link
Member

@yhmtsai yhmtsai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cuda hip code should be able transferred to dpcpp

Copy link
Member

@MarcelKoch MarcelKoch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the start of my review. I have mostly comments on the public interface, with some minor other issues. I will dig deeper into the algorithms at a later time.

Personally, I would prefer moving the public interface into core. I'm not sure if it's in a stable enough state at the moment. Especially, building the lookup seems a bit unclear right now. I don't think there is a way to build the lookup from user code at the moment, right? If that is present, I think it can stay in the public interface. See my newer review.
Also, at least for me, it would be nice to see how the interface can be used (probably referring to another PR or something else).

Copy link
Member

@MarcelKoch MarcelKoch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From the algorithmic side, this looks very good. I don't have much to say there. I guess at some point one could add a similar parallelization using subgroups.

I would like to see some way of constructing the lookup added to the public interface. Currently there is no way for a user to construct it, so I think that is absolutly necessary. Alternatively, the public interface would need to be removed, which I find a bit too harsh.

Copy link
Member

@yhmtsai yhmtsai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. some question and minor nit

Copy link
Member

@MarcelKoch MarcelKoch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. I would only comment that I would have preferred breaking the test up into several shorter ones, because I find shorter test easier to digest. But that seems to be just personal preference.

@upsj upsj force-pushed the csr_lookup branch 2 times, most recently from 5361dcf to 4908ade Compare May 13, 2022 17:21
@upsj
Copy link
Member Author

upsj commented May 13, 2022

format-rebase!

@ginkgo-bot
Copy link
Member

Formatting rebase introduced changes, see Artifacts here to review them

@upsj upsj force-pushed the csr_lookup branch 3 times, most recently from 2352e97 to 1c25951 Compare May 16, 2022 15:41
Copy link
Member

@thoasm thoasm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please move the sparsity_type into a csr namespace.

@upsj upsj requested a review from thoasm May 23, 2022 06:26
@upsj upsj force-pushed the csr_lookup branch 3 times, most recently from f69953f to 4139058 Compare May 23, 2022 12:04
@upsj upsj requested a review from yhmtsai May 23, 2022 12:09
@upsj 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 labels May 23, 2022
Copy link
Member

@thoasm thoasm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

upsj and others added 8 commits May 24, 2022 12:38
* allow lookups of non-existent column indices
* store separate offsets for lookup data to reduce memory footprint
* simplify tests
* fix DPC++ execution on float-only devices
* clarify comments on cheap modulo replacement

Co-authored-by: Yuhsiang M. Tsai <yhmtsai@gmail.com>
Co-authored-by: Marcel Koch <marcel.koch@kit.edu>
Somehow, the static constexpr member variable trips up the linker.
Move it to a global constant instead
* move sparsity lookup to csr namespace
* improve conversions for sparsity_type

Co-authored-by: Thomas Grützmacher <thomas.gruetzmacher@kit.edu>
Co-authored-by: Yuhsiang M. Tsai <yhmtsai@gmail.com>
* consistently cast to int64 for row_desc
* fix compilation issues on Volta with HIP

Co-authored-by: Thomas Grützmacher <thomas.gruetzmacher@kit.edu>
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 38 Code Smells

99.1% 99.1% Coverage
17.8% 17.8% Duplication

@codecov
Copy link

codecov bot commented May 24, 2022

Codecov Report

Merging #994 (a851a72) into develop (198957c) will increase coverage by 0.07%.
The diff coverage is 99.23%.

@@             Coverage Diff             @@
##           develop     #994      +/-   ##
===========================================
+ Coverage    91.72%   91.79%   +0.07%     
===========================================
  Files          497      499       +2     
  Lines        42580    42968     +388     
===========================================
+ Hits         39056    39442     +386     
- Misses        3524     3526       +2     
Impacted Files Coverage Δ
omp/test/matrix/csr_kernels.cpp 100.00% <ø> (ø)
core/matrix/csr_lookup.hpp 97.02% <97.02%> (ø)
common/unified/matrix/csr_kernels.cpp 52.30% <100.00%> (+21.19%) ⬆️
include/ginkgo/core/base/intrinsics.hpp 100.00% <100.00%> (ø)
omp/matrix/csr_kernels.cpp 86.20% <100.00%> (+1.77%) ⬆️
reference/matrix/csr_kernels.cpp 92.40% <100.00%> (+1.06%) ⬆️
reference/test/matrix/csr_kernels.cpp 99.84% <100.00%> (+0.02%) ⬆️
test/matrix/csr_kernels.cpp 100.00% <100.00%> (ø)
reference/base/index_set_kernels.cpp 94.11% <0.00%> (-0.09%) ⬇️
omp/reorder/rcm_kernels.cpp 98.13% <0.00%> (+0.60%) ⬆️

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 47fddae...a851a72. Read the comment docs.

@upsj upsj merged commit b3b3b04 into develop May 24, 2022
@upsj upsj deleted the csr_lookup branch May 24, 2022 17:31
tcojean added a commit that referenced this pull request Nov 12, 2022
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))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1:ST:ready-to-merge This PR is ready to merge. 1:ST:run-full-test mod:all This touches all Ginkgo modules. reg:testing This is related to testing. type:matrix-format This is related to the Matrix formats
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Device matrix assembly: Useful lookup structures
5 participants