Add dpcpp device timing #1110

yhmtsai · 2022-09-01T22:05:00Z

This PR adds the ability to enable the profiling of the queue and allow use the device timer in benchmark.

We only use forward declaration in executor.hpp, so I can not use the property as default input directly, which leads the incomplete type error. I use the enum and convert it into the property type when create the queue. Any idea on this is welcome.

Another is to add the device timing to benchmark. I add two dummy kernels as the marker. the timing is the interval between end time of start event and start time of end event.

upsj

LGTM! Minor nits

benchmark/utils/dpcpp_timer.dp.cpp

upsj · 2022-09-13T17:59:30Z

benchmark/utils/dpcpp_timer.dp.cpp

+     */
+    DpcppTimer(std::shared_ptr<const gko::DpcppExecutor> exec) : Timer()
+    {
+        assert(exec != nullptr);


Suggested change

assert(exec != nullptr);

upsj · 2022-09-13T18:00:49Z

benchmark/utils/general.hpp

@@ -290,30 +290,35 @@ void backup_results(rapidjson::Document& results)


 // executor mapping
-const std::map<std::string, std::function<std::shared_ptr<gko::Executor>()>>
+const std::map<std::string, std::function<std::shared_ptr<gko::Executor>(bool)>>


This parameter should already be available as a global variable, maybe use the global instead?

I think it will require the timer.hpp include the general.hpp or include general.hpp earlier than timer.hpp.
it only uses one input so I prefer not introducing another headers hierarchy.

dpcpp/base/executor.dp.cpp

thoasm

I have one concern about the use of enum class, other than that, it looks good.

include/ginkgo/core/base/executor.hpp

dpcpp/base/executor.dp.cpp

Co-authored-by: Tobias Ribizel <ribizel@kit.edu>

thoasm

LGTM, sorry for the confusion I caused with the enum class (I learned something new during this review).

include/ginkgo/core/base/executor.hpp

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

sonarcloud · 2022-10-12T12:17:50Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
3 Code Smells

12.5% Coverage
0.0% Duplication

codecov · 2022-10-12T12:23:56Z

Codecov Report

Base: 90.87% // Head: 90.89% // Increases project coverage by +0.01% 🎉

Coverage data is based on head (13432f7) compared to base (8e7c3fa).
Patch coverage: 66.66% of modified lines in pull request are covered.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #1110      +/-   ##
===========================================
+ Coverage    90.87%   90.89%   +0.01%     
===========================================
  Files          508      508              
  Lines        44256    44258       +2     
===========================================
+ Hits         40218    40228      +10     
+ Misses        4038     4030       -8

Impacted Files	Coverage Δ
include/ginkgo/core/base/executor.hpp	`71.98% <50.00%> (-0.71%)`	⬇️
core/device_hooks/dpcpp_hooks.cpp	`27.27% <100.00%> (ø)`
reference/base/index_set_kernels.cpp	`94.20% <0.00%> (+0.08%)`	⬆️
omp/reorder/rcm_kernels.cpp	`98.13% <0.00%> (+3.69%)`	⬆️
devices/machine_topology.cpp	`82.71% <0.00%> (+4.93%)`	⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

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))

yhmtsai added 1:ST:ready-for-review This PR is ready for review 1:ST:need-feedback The PR is somewhat ready but feedback on a blocking topic is required before a proper review. labels Sep 1, 2022

yhmtsai requested a review from a team September 1, 2022 22:05

yhmtsai self-assigned this Sep 1, 2022

upsj approved these changes Sep 13, 2022

View reviewed changes

yhmtsai force-pushed the add_dpcpp_timing branch 2 times, most recently from 70f3079 to a7036e6 Compare September 27, 2022 08:40

thoasm reviewed Oct 6, 2022

View reviewed changes

include/ginkgo/core/base/executor.hpp Outdated Show resolved Hide resolved

dpcpp/base/executor.dp.cpp Outdated Show resolved Hide resolved

yhmtsai and others added 5 commits October 11, 2022 14:52

add the property selection on dpcpp executor

3a43510

add the dpcpp device timer

d46536c

remove unnecessary code

007e454

Co-authored-by: Tobias Ribizel <ribizel@kit.edu>

fix missing arg in dummy impl

2577d68

separate timer flag and vendors' format flag

7941947

yhmtsai force-pushed the add_dpcpp_timing branch from e7658c2 to 5d94276 Compare October 11, 2022 06:52

thoasm approved these changes Oct 11, 2022

View reviewed changes

include/ginkgo/core/base/executor.hpp Outdated Show resolved Hide resolved

include/ginkgo/core/base/executor.hpp Outdated Show resolved Hide resolved

yhmtsai force-pushed the add_dpcpp_timing branch from 5d94276 to f84243f Compare October 11, 2022 16:55

yhmtsai 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:need-feedback The PR is somewhat ready but feedback on a blocking topic is required before a proper review. labels Oct 12, 2022

update the documentation and reorder the condition

13432f7

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

yhmtsai force-pushed the add_dpcpp_timing branch from f84243f to 13432f7 Compare October 12, 2022 05:55

yhmtsai merged commit c47af5f into develop Oct 12, 2022

yhmtsai deleted the add_dpcpp_timing branch October 12, 2022 12:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add dpcpp device timing #1110

Add dpcpp device timing #1110

yhmtsai commented Sep 1, 2022

upsj left a comment

upsj Sep 13, 2022

upsj Sep 13, 2022

yhmtsai Sep 27, 2022

thoasm left a comment

thoasm left a comment

sonarcloud bot commented Oct 12, 2022

codecov bot commented Oct 12, 2022

Add dpcpp device timing #1110

Add dpcpp device timing #1110

Conversation

yhmtsai commented Sep 1, 2022

upsj left a comment

Choose a reason for hiding this comment

upsj Sep 13, 2022

Choose a reason for hiding this comment

upsj Sep 13, 2022

Choose a reason for hiding this comment

yhmtsai Sep 27, 2022

Choose a reason for hiding this comment

thoasm left a comment

Choose a reason for hiding this comment

thoasm left a comment

Choose a reason for hiding this comment

sonarcloud bot commented Oct 12, 2022

codecov bot commented Oct 12, 2022

Codecov Report