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

Speed up GPU tests by avoiding device reset #467

Merged
merged 4 commits into from
Mar 6, 2020
Merged

Conversation

upsj
Copy link
Member

@upsj upsj commented Feb 27, 2020

At the moment, all of our GPU tests store a device executor that gets destroyed after each test, which in turn executes cuda/hipDeviceReset. This causes each of our tests to take at least 800ms on NVIDIA GPUs (less on AMD GPUs), independent of the actual kernel runtime. I think this is not necessary and can be fixed by instantiating a second device executor in a global variable (other, cleaner solutions welcome!)

Somewhat related to #461

Before:

151: [==========] Running 24 tests from 1 test case.
151: [----------] Global test environment set-up.
151: [----------] 24 tests from Dense
151: [ RUN      ] Dense.SingleVectorHipScaleIsEquivalentToRef
151: [       OK ] Dense.SingleVectorHipScaleIsEquivalentToRef (1012 ms)
...
151: [ RUN      ] Dense.CalculateTotalColsIsEquivalentToRef
151: [       OK ] Dense.CalculateTotalColsIsEquivalentToRef (864 ms)
151: [----------] 24 tests from Dense (22293 ms total)

After:

151: [==========] Running 24 tests from 1 test case.
151: [----------] Global test environment set-up.
151: [----------] 24 tests from Dense
151: [ RUN      ] Dense.SingleVectorHipScaleIsEquivalentToRef
151: [       OK ] Dense.SingleVectorHipScaleIsEquivalentToRef (95 ms)
...
151: [ RUN      ] Dense.CalculateTotalColsIsEquivalentToRef
151: [       OK ] Dense.CalculateTotalColsIsEquivalentToRef (20 ms)
151: [----------] 24 tests from Dense (1783 ms total)

@upsj upsj added reg:testing This is related to testing. 1:ST:ready-for-review This PR is ready for review labels Feb 27, 2020
@upsj upsj self-assigned this Feb 27, 2020
@thoasm
Copy link
Member

thoasm commented Feb 27, 2020

What about creating a cuda/test/utils.hpp header (which includes core/test/utils.hpp), and do the creation of the executor there? That would at least hide the not so pleasant code inside a header and would allow us to improve / remove that in one line instead of in every test-file.
This would obviously require us changing all includes of core/test/utils.hpp to cuda/test/utils.hpp, but that is easy to automate (only needs to be done once).

@upsj
Copy link
Member Author

upsj commented Mar 2, 2020

@thoasm Good idea, I followed your suggestion and only had to patch a small compilation issue with assert and the comma operator in constexpr contexts for HIP.

@upsj upsj force-pushed the no_test_device_reset branch 2 times, most recently from 62e630f to 612ed9c Compare March 2, 2020 14:15
@yhmtsai
Copy link
Member

yhmtsai commented Mar 3, 2020

Does return GKO_ASSERT(...), value; -> GKO_ASSERT(...); return value; not work?
Or it can not be constexpr?

@upsj
Copy link
Member Author

upsj commented Mar 3, 2020

In C++11, constexpr functions are only allowed to consist of a single return statement, so that unfortunately doesn't work. The expected behavior for NDEBUG would be that assert is replaced by something like void(0), but this weird combination of includes seems to let some asserts vanish. I did not investigate this further yet, since the workaround works.

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.

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.

LGMT!

Copy link
Member

@tcojean tcojean left a comment

Choose a reason for hiding this comment

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

LGTM.

cuda/test/utils.hpp Show resolved Hide resolved
@tcojean tcojean 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 Mar 5, 2020
upsj and others added 3 commits March 5, 2020 15:32
We sometimes use assertions in a constexpr context.
For this, we use the comma operator like

  return GKO_ASSERT(...), value;

For some constellation of include files

  #include <ginkgo/core/base/math.hpp>
  #include <gtest/gtest.h>
  #include <hip/hip_runtime.h>
  #include "hip/test/utils.hip.hpp"

the assertions in gko::dim disappear completely for reasons
I did not want to chase down too much

  include/ginkgo/core/base/dim.hpp(109): error: expected an expression

This is a simple workaround for that issue
Co-authored-by: Terry Cojean <[email protected]>
Copy link
Member

@pratikvn pratikvn left a comment

Choose a reason for hiding this comment

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

LGTM!

cuda/test/utils.hpp Outdated Show resolved Hide resolved
cuda/test/utils.hpp Outdated Show resolved Hide resolved
hip/test/utils.hip.hpp Outdated Show resolved Hide resolved
hip/test/utils.hip.hpp Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Mar 6, 2020

Codecov Report

Merging #467 into develop will increase coverage by 1.49%.
The diff coverage is 91.35%.

Impacted file tree graph

@@             Coverage Diff             @@
##           develop     #467      +/-   ##
===========================================
+ Coverage    89.98%   91.47%   +1.49%     
===========================================
  Files          136      294     +158     
  Lines         6078    19551   +13473     
===========================================
+ Hits          5469    17884   +12415     
- Misses         609     1667    +1058     
Impacted Files Coverage Δ
omp/solver/cgs_kernels.cpp 0.00% <0.00%> (-100.00%) ⬇️
omp/matrix/hybrid_kernels.cpp 0.00% <0.00%> (-98.83%) ⬇️
omp/solver/fcg_kernels.cpp 0.00% <0.00%> (-97.06%) ⬇️
omp/solver/cg_kernels.cpp 0.00% <0.00%> (-96.78%) ⬇️
omp/solver/gmres_kernels.cpp 0.00% <0.00%> (-95.63%) ⬇️
omp/matrix/coo_kernels.cpp 5.55% <0.00%> (-94.45%) ⬇️
omp/matrix/sellp_kernels.cpp 0.00% <0.00%> (-93.34%) ⬇️
omp/matrix/sparsity_csr_kernels.cpp 7.24% <0.00%> (-92.76%) ⬇️
omp/matrix/ell_kernels.cpp 0.00% <0.00%> (-91.67%) ⬇️
omp/solver/bicgstab_kernels.cpp 0.00% <0.00%> (-91.18%) ⬇️
... and 260 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 3523945...0c1340a. Read the comment docs.

Co-Authored-By: Pratik Nayak <[email protected]>
@sonarcloud
Copy link

sonarcloud bot commented Mar 6, 2020

Kudos, SonarCloud Quality Gate passed!

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities (and Security Hotspot 0 Security Hotspots to review)
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@upsj upsj merged commit c0ab864 into develop Mar 6, 2020
@upsj upsj deleted the no_test_device_reset branch March 6, 2020 12:38
@tcojean tcojean mentioned this pull request Jun 23, 2020
tcojean added a commit that referenced this pull request Jul 7, 2020
The Ginkgo team is proud to announce the new minor release of Ginkgo version
1.2.0. This release brings full HIP support to Ginkgo, new preconditioners
(ParILUT, ISAI), conversion between double and float for all LinOps, and many
more features and fixes.

Supported systems and requirements:
+ For all platforms, cmake 3.9+
+ Linux and MacOS
  + gcc: 5.3+, 6.3+, 7.3+, all versions after 8.1+
  + clang: 3.9+
  + Intel compiler: 2017+
  + Apple LLVM: 8.0+
  + CUDA module: CUDA 9.0+
  + HIP module: ROCm 2.8+
+ Windows
  + MinGW and CygWin: gcc 5.3+, 6.3+, 7.3+, all versions after 8.1+
  + Microsoft Visual Studio: VS 2017 15.7+
  + CUDA module: CUDA 9.0+, Microsoft Visual Studio
  + OpenMP module: MinGW or CygWin.


The current known issues can be found in the [known issues page](https://github.com/ginkgo-project/ginkgo/wiki/Known-Issues).


# Additions
Here are the main additions to the Ginkgo library. Other thematic additions are listed below.
+ Add full HIP support to Ginkgo [#344](#344), [#357](#357), [#384](#384), [#373](#373), [#391](#391), [#396](#396), [#395](#395), [#393](#393), [#404](#404), [#439](#439), [#443](#443), [#567](#567)
+ Add a new ISAI preconditioner [#489](#489), [#502](#502), [#512](#512), [#508](#508), [#520](#520)
+ Add support for ParILUT and ParICT factorization with ILU preconditioners [#400](#400)
+ Add a new BiCG solver [#438](#438)
+ Add a new permutation matrix format [#352](#352), [#469](#469)
+ Add CSR SpGEMM support [#386](#386), [#398](#398), [#418](#418), [#457](#457)
+ Add CSR SpGEAM support [#556](#556)
+ Make all solvers and preconditioners transposable [#535](#535)
+ Add CsrBuilder and CooBuilder for intrusive access to matrix arrays [#437](#437)
+ Add a standard-compliant allocator based on the Executors [#504](#504)
+ Support conversions for all LinOp between double and float [#521](#521)
+ Add a new boolean to the CUDA and HIP executors to control DeviceReset (default off) [#557](#557)
+ Add a relaxation factor to IR to represent Richardson Relaxation [#574](#574)
+ Add two new stopping criteria, for relative (to `norm(b)`) and absolute residual norm [#577](#577)

### Example additions
+ Templatize all examples to simplify changing the precision [#513](#513)
+ Add a new adaptive precision block-Jacobi example [#507](#507)
+ Add a new IR example [#522](#522)
+ Add a new Mixed Precision Iterative Refinement example [#525](#525)
+ Add a new example on iterative trisolves in ILU preconditioning [#526](#526), [#536](#536), [#550](#550)

### Compilation and library changes
+ Auto-detect compilation settings based on environment [#435](#435), [#537](#537)
+ Add SONAME to shared libraries [#524](#524)
+ Add clang-cuda support [#543](#543)

### Other additions
+ Add sorting, searching and merging kernels for GPUs [#403](#403), [#428](#428), [#417](#417), [#455](#455)
+ Add `gko::as` support for smart pointers [#493](#493)
+ Add setters and getters for criterion factories [#527](#527)
+ Add a new method to check whether a solver uses `x` as an initial guess [#531](#531)
+ Add contribution guidelines [#549](#549)

# Fixes
### Algorithms
+ Improve the classical CSR strategy's performance [#401](#401)
+ Improve the CSR automatical strategy [#407](#407), [#559](#559)
+ Memory, speed improvements to the ELL kernel [#411](#411)
+ Multiple improvements and fixes to ParILU [#419](#419), [#427](#427), [#429](#429), [#456](#456), [#544](#544)
+ Fix multiple issues with GMRES [#481](#481), [#523](#523), [#575](#575)
+ Optimize OpenMP matrix conversions [#505](#505)
+ Ensure the linearity of the ILU preconditioner [#506](#506)
+ Fix IR's use of the advanced apply [#522](#522)
+ Fix empty matrices conversions and add tests [#560](#560)

### Other core functionalities
+ Fix complex number support in our math header [#410](#410)
+ Fix CUDA compatibility of the main ginkgo header [#450](#450)
+ Fix isfinite issues [#465](#465)
+ Fix the Array::view memory leak and the array/view copy/move [#485](#485)
+ Fix typos preventing use of some interface functions [#496](#496)
+ Fix the `gko::dim` to abide to the C++ standard [#498](#498)
+ Simplify the executor copy interface [#516](#516)
+ Optimize intermediate storage for Composition [#540](#540)
+ Provide an initial guess for relevant Compositions [#561](#561)
+ Better management of nullptr as criterion [#562](#562)
+ Fix the norm calculations for complex support [#564](#564)

### CUDA and HIP specific
+ Use the return value of the atomic operations in our wrappers [#405](#405)
+ Improve the portability of warp lane masks [#422](#422)
+ Extract thread ID computation into a separate function [#464](#464)
+ Reorder kernel parameters for consistency [#474](#474)
+ Fix the use of `pragma unroll` in HIP [#492](#492)

### Other
+ Fix the Ginkgo CMake installation files [#414](#414), [#553](#553)
+ Fix the Windows compilation [#415](#415)
+ Always use demangled types in error messages [#434](#434), [#486](#486)
+ Add CUDA header dependency to appropriate tests [#452](#452)
+ Fix several sonarqube or compilation warnings [#453](#453), [#463](#463), [#532](#532), [#569](#569)
+ Add shuffle tests [#460](#460)
+ Fix MSVC C2398 error [#490](#490)
+ Fix missing interface tests in test install [#558](#558)

# Tools and ecosystem
### Benchmarks
+ Add better norm support in the benchmarks [#377](#377)
+ Add CUDA 10.1 generic SpMV support in benchmarks [#468](#468), [#473](#473)
+ Add sparse library ILU in benchmarks [#487](#487)
+ Add overhead benchmarking capacities [#501](#501)
+ Allow benchmarking from a matrix list file [#503](#503)
+ Fix benchmarking issue with JSON and non-finite numbers [#514](#514)
+ Fix benchmark logger crashers with OpenMP [#565](#565)

### CI related
+ Improvements to the CI setup with HIP compilation [#421](#421), [#466](#466)
+ Add MacOSX CI support [#470](#470), [#488](#488)
+ Add Windows CI support [#471](#471), [#488](#488), [#510](#510), [#566](#566)
+ Use sanitizers instead of valgrind [#476](#476)
+ Add automatic container generation and update facilities [#499](#499)
+ Fix the CI parallelism settings [#517](#517), [#538](#538), [#539](#539)
+ Make the codecov patch check informational [#519](#519)
+ Add support for LLVM sanitizers with improved thread sanitizer support [#578](#578)

### Test suite
+ Add an assertion for sparsity pattern equality [#416](#416)
+ Add core and reference multiprecision tests support [#448](#448)
+ Speed up GPU tests by avoiding device reset [#467](#467)
+ Change test matrix location string [#494](#494)

### Other
+ Add Ginkgo badges from our tools [#413](#413)
+ Update the `create_new_algorithm.sh` script [#420](#420)
+ Bump copyright and improve license management [#436](#436), [#433](#433)
+ Set clang-format minimum requirement [#441](#441), [#484](#484)
+ Update git-cmake-format [#446](#446), [#484](#484)
+ Disable the development tools by default [#442](#442)
+ Add a script for automatic header formatting [#447](#447)
+ Add GDB pretty printer for `gko::Array` [#509](#509)
+ Improve compilation speed [#533](#533)
+ Add editorconfig support [#546](#546)
+ Add a compile-time check for header self-sufficiency [#552](#552)


# Related PR: #583
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. reg:testing This is related to testing.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants