-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
157 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# Enable debug timings `@trixi_timeit timer() "name" stuff...`. | ||
# This allows us to disable timings completely by executing | ||
# `TimerOutputs.disable_debug_timings(TrixiBase)` | ||
# and to enable them again by executing | ||
# `TimerOutputs.enable_debug_timings(TrixiBase)` | ||
timeit_debug_enabled() = true | ||
disable_debug_timings() = TimerOutputs.disable_debug_timings(@__MODULE__) | ||
enable_debug_timings() = TimerOutputs.enable_debug_timings(@__MODULE__) | ||
|
||
# Store main timer for global timing of functions | ||
const main_timer = TimerOutput() | ||
|
||
# Always call timer() to hide implementation details | ||
timer() = main_timer | ||
|
||
# @trixi_timeit timer() "some label" expression | ||
# | ||
# Basically the same as a special case of `@timeit_debug` from | ||
# [TimerOutputs.jl](https://github.com/KristofferC/TimerOutputs.jl), | ||
# but without `try ... finally ... end` block. Thus, it's not exception-safe, | ||
# but it also avoids some related performance problems. Since we do not use | ||
# exception handling in Trixi, that's not really an issue. | ||
# | ||
# Copied from [Trixi.jl](https://github.com/trixi-framework/Trixi.jl). | ||
macro trixi_timeit(timer_output, label, expr) | ||
timeit_block = quote | ||
if timeit_debug_enabled() | ||
local to = $(esc(timer_output)) | ||
local enabled = to.enabled | ||
if enabled | ||
local accumulated_data = $(TimerOutputs.push!)(to, $(esc(label))) | ||
end | ||
local b0 = $(TimerOutputs.gc_bytes)() | ||
local t0 = $(TimerOutputs.time_ns)() | ||
end | ||
local val = $(esc(expr)) | ||
if timeit_debug_enabled() && enabled | ||
$(TimerOutputs.do_accumulate!)(accumulated_data, t0, b0) | ||
$(TimerOutputs.pop!)(to) | ||
end | ||
val | ||
end | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,102 @@ | ||
@testset verbose=true "Timers" begin | ||
@testset verbose=true "`timer()`" begin | ||
@test timer() isa TrixiBase.TimerOutput | ||
|
||
# Test empty timer output | ||
TrixiBase.TimerOutputs.reset_timer!(timer()) | ||
|
||
timer_output = """ | ||
──────────────────────────────────────────────────────────────────── | ||
Time Allocations | ||
─────────────────────── ──────────────────────── | ||
Tot / % measured: 91.5s / 0.0% 5.43MiB / 0.0% | ||
Section ncalls time %tot avg alloc %tot avg | ||
──────────────────────────────────────────────────────────────────── | ||
──────────────────────────────────────────────────────────────────── | ||
""" | ||
# Remove "Tot / % measured" line and trailing white spaces | ||
expected = replace(timer_output, r"Tot / % measured: .*" => "", | ||
r"\s+\n" => "\n") | ||
actual = replace(repr(timer()) * "\n", r"Tot / % measured: .*" => "", | ||
r"\s+\n" => "\n") | ||
|
||
# Compare against empty timer output | ||
@test actual == expected | ||
end | ||
|
||
@testset verbose=true "`@trixi_timeit`" begin | ||
# Start with empty timer output | ||
TrixiBase.TimerOutputs.reset_timer!(timer()) | ||
|
||
# Add timer entry with 2 calls | ||
@trixi_timeit timer() "test timer" sin(0.0) | ||
@trixi_timeit timer() "test timer" sin(0.0) | ||
|
||
timer_output = """ | ||
─────────────────────────────────────────────────────────────────────── | ||
Time Allocations | ||
─────────────────────── ──────────────────────── | ||
Tot / % measured: 61.4ms / 99.2% 5.60MiB / 99.6% | ||
Section ncalls time %tot avg alloc %tot avg | ||
─────────────────────────────────────────────────────────────────────── | ||
test timer 2 60.9ms 100.0% 60.9ms 5.57MiB 100.0% 5.57MiB | ||
─────────────────────────────────────────────────────────────────────── | ||
""" | ||
# Remove "Tot / % measured" line and trailing white spaces and replace | ||
# the "test timer" line (but don't remove it, we want to check that it's there). | ||
expected = replace(timer_output, r"Tot / % measured: .*" => "", | ||
r"\s+\n" => "\n", | ||
r"test timer 2 .*B\n" => "test timer 2") | ||
actual = replace(repr(timer()) * "\n", r"Tot / % measured: .*" => "", | ||
r"\s+\n" => "\n", | ||
r"test timer 2 .*B\n" => "test timer 2") | ||
|
||
# Compare against empty timer output | ||
@test actual == expected | ||
end | ||
|
||
@testset verbose=true "disable and enable timings" begin | ||
# Start with empty timer output | ||
TrixiBase.TimerOutputs.reset_timer!(timer()) | ||
|
||
# Disable timings | ||
disable_debug_timings() | ||
|
||
# These two timings should be disabled | ||
@trixi_timeit timer() "test timer" sin(0.0) | ||
@trixi_timeit timer() "test timer" sin(0.0) | ||
|
||
# Disable timings | ||
enable_debug_timings() | ||
|
||
# This timing should be counted | ||
@trixi_timeit timer() "test timer 2" sin(0.0) | ||
|
||
println(timer()) | ||
|
||
timer_output = """ | ||
───────────────────────────────────────────────────────────────────────── | ||
Time Allocations | ||
─────────────────────── ──────────────────────── | ||
Tot / % measured: 23.7ms / 0.0% 1.00MiB / 0.0% | ||
Section ncalls time %tot avg alloc %tot avg | ||
───────────────────────────────────────────────────────────────────────── | ||
test timer 2 1 875ns 100.0% 875ns 48.0B 100.0% 48.0B | ||
───────────────────────────────────────────────────────────────────────── | ||
""" | ||
# Remove "Tot / % measured" line and trailing white spaces and replace | ||
# the "test timer" line (but don't remove it, we want to check that it's there). | ||
expected = replace(timer_output, r"Tot / % measured: .*" => "", | ||
r"\s+\n" => "\n", | ||
r"test timer 2 1 .*B\n" => "test timer 2 1") | ||
actual = replace(repr(timer()) * "\n", r"Tot / % measured: .*" => "", | ||
r"\s+\n" => "\n", | ||
r"test timer 2 1 .*B\n" => "test timer 2 1") | ||
|
||
# Compare against empty timer output | ||
@test actual == expected | ||
end | ||
end; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters