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.

Sign up for GitHub

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

Jump to bottom

Improve value semantics for LinOp types #753

Merged
merged 21 commits into from
May 2, 2022
Merged

Improve value semantics for LinOp types #753

merged 21 commits into from
May 2, 2022

Conversation

upsj
Copy link
Member

@upsj upsj commented Apr 27, 2021 •
edited
Loading

This PR improves the value semantics of Ginkgo polymorphic objects by making sure that their contents are always stored on the correct executor. This fixes the issues caused by gko::clone not copying data that is stored in a shared_ptr. Additionally, I added a few helpers to reduce code duplication in solvers.

The PR is still work in progress, I only added the basic implementation and an example for Bicg, but I wanted to open the floor to discussions already

TODO:

  • moving Preconditionable to solver_base.hpp is interface-breaking, I guess we can do without the move?
  • Add tests
  • Bicgstab
  • Cg
  • Cgs
  • Fcg
  • Gmres
  • CbGmres
  • Idr
  • Ir
  • Lower/UpperTrs
  • Ilu/Ic factorizations
  • Ilu/Ic preconditioners
  • Isai preconditioner
  • Jacobi (size members)
  • Sellp (size members)
  • Dense (stride-preserving copy)
  • Hybrid (Coo, Ell, strategy)
  • Fbcsr (size members)
  • Ell (size members)
  • Csr (strategy)
  • Composition
  • Combination
  • Pertubation
  • Multigrid
  • UseComposition is still broken, but there is no interface break-less approach to fix this. EnableMultigridLevel needs access to the object's executor, thus needs to become a mix-in.
  • MultigridLevel cloning is currently very hacky, we probably need a better approach here.

Fixes #747

@upsj upsj added the 1:ST:WIP This PR is a work in progress. Not ready for review. label Apr 27, 2021
@upsj upsj self-assigned this Apr 27, 2021
@ginkgo-bot ginkgo-bot added mod:core This is related to the core module. reg:build This is related to the build system. type:solver This is related to the solvers labels Apr 27, 2021
@nbeams nbeams mentioned this pull request May 3, 2021
Merged
4 tasks
@upsj upsj added this to the Ginkgo 1.4.0 milestone May 5, 2021
This was referenced May 6, 2021
Merged
Closed
@upsj
Copy link
Member Author

upsj commented May 8, 2021 •
edited
Loading

It would also make sense for simplification to have a general utility class that provides correct value semantics to a std::unique_ptr<LinOp> or std::shared_ptr<LinOp> member. unfortunately, that is not so easy, as in its empty state, such an object does not know which executor to copy the data to, unless we store it within that wrapper object as well, which would give a certain overhead. I prefer the mixin solution I went for in the other types.

@upsj upsj added this to Short-term tasks in Ginkgo development May 12, 2021
@upsj upsj modified the milestones: Ginkgo 1.4.0, Ginkgo 1.5.0 May 31, 2021
@upsj upsj force-pushed the value-semantics branch 5 times, most recently from 8691b6b to a9fbc37 Compare June 15, 2021 23:37
@upsj upsj added 1:ST:ready-for-review This PR is ready for review and removed 1:ST:WIP This PR is a work in progress. Not ready for review. labels Jun 15, 2021
@upsj upsj modified the milestones: Ginkgo 1.5.0, Ginkgo 1.4.0 Jun 15, 2021
@upsj upsj removed this from the Ginkgo 1.4.0 milestone Jun 28, 2021
upsj and others added 19 commits April 29, 2022 14:02
@upsj
add tests for composite operators
383f444
@upsj
keep input stride in dense convert_to
023e99d
@upsj
make Array moved-from state consistently empty
d0d9927
@upsj
add tests for matrix format move-/copy-assignment
a172c4b
@upsj
fix moved-from state for matrix types
f2ecfbc
@upsj
prevent segfault in empty solver apply
ae77cdf
@upsj @pratikvn
review updates
ae392f4 
Co-authored-by: Pratik Nayak <[email protected]>
@upsj
move matrix_utils to utils namespace
9e34431
@upsj @pratikvn @MarcelKoch
review updates
09c7a48 
* deduplicate members for GMRES/IDR
* add documentation
* simplify solver test parameters

Co-authored-by: Pratik Nayak <[email protected]>
Co-authored-by: Marcel Koch <[email protected]>
Co-authored-by: Thomas Grützmacher <[email protected]>
@upsj
test result of assignment operators
e43fe19
@upsj
fix solver and matrix tests
680c9c6 
* Don't preserve stride in Dense
* Preserve strategy in Csr and Hybrid
* Regenerate solver_struct on cross-executor assignment
* Copy wrapped matrices on copy in Hybrid
@upsj
test move operations in generic matrix test
e22031d
@upsj
add Ell copy kernel that ignores padding
3e7dfd4
@upsj
pass assignment operations to Ell/Coo in Hybrid
8e98368
@upsj
improve Dense documentation
18ffeb0
@upsj
add assignment and constructor documentation
bd80758
@upsj
fix HIP SolveStruct
cd4864d
@upsj
fix MoveToDense generic matrix test
18350ec 
The stride requirements are incorrect
@upsj
fix icc/cuda compilation issues
e5d4ac0
@ginkgo-bot
Copy link
Member

Note: This PR changes the Ginkgo ABI:

Functions changes summary: 918 Removed, 1593 Changed (16448 filtered out), 1630 Added functions
Variables changes summary: 0 Removed, 0 Changed, 0 Added variable

For details check the full ABI diff under Artifacts here

@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 2, 2022
@sonarcloud
Copy link

sonarcloud bot commented May 2, 2022

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 179 Code Smells

61.8% 61.8% Coverage
3.0% 3.0% Duplication

@upsj upsj merged commit 2109f6a into develop May 2, 2022
@upsj upsj deleted the value-semantics branch May 2, 2022 13:06
greole pushed a commit that referenced this pull request Jun 15, 2022
@MarcelKoch @greole
make dense::move_to adhere to move semantics
7381b38 
will be superseeded by #753
@upsj upsj mentioned this pull request Oct 3, 2022
Closed
tcojean added a commit that referenced this pull request Nov 12, 2022
@tcojean
Merge Release 1.5.0 to develop
7c9f530 
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 upsj mentioned this pull request May 10, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MarcelKoch MarcelKoch MarcelKoch approved these changes

@thoasm thoasm thoasm approved these changes

@pratikvn pratikvn pratikvn approved these changes

@yhmtsai yhmtsai yhmtsai approved these changes

@greole greole Awaiting requested review from greole

@Slaedr Slaedr Awaiting requested review from Slaedr

@tcojean tcojean Awaiting requested review from tcojean

@fritzgoebel fritzgoebel Awaiting requested review from fritzgoebel

Assignees

@upsj upsj

Labels
1:ST:ready-to-merge This PR is ready to merge. 1:ST:run-full-test mod:core This is related to the core module. reg:build This is related to the build system. type:solver This is related to the solvers
Projects
Ginkgo development
Awaiting Merge
Milestone
Ginkgo 1.5.0
Development

Successfully merging this pull request may close these issues.

Consistent empty state for clear and move_to
6 participants
@upsj @ginkgo-bot @pratikvn @MarcelKoch @thoasm @yhmtsai