Blender V5.3
timeit.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include "BLI_string_ref.hh"
10#include "BLI_timeit.hh"
11
12#include <algorithm>
13#include <iostream>
14
15#include <fmt/format.h>
16
17namespace blender::timeit {
18
19static void format_duration(Nanoseconds duration, fmt::memory_buffer &buf)
20{
21 using namespace std::chrono;
22 if (duration < microseconds(100)) {
23 fmt::format_to(fmt::appender(buf), FMT_STRING("{} ns"), duration.count());
24 }
25 else if (duration < seconds(5)) {
26 fmt::format_to(fmt::appender(buf), FMT_STRING("{:.2f} ms"), duration.count() / 1.0e6);
27 }
28 else if (duration > seconds(90)) {
29 /* Long durations: print seconds, and also H:m:s */
30 const auto dur_hours = duration_cast<hours>(duration);
31 const auto dur_mins = duration_cast<minutes>(duration - dur_hours);
32 const auto dur_sec = duration_cast<seconds>(duration - dur_hours - dur_mins);
33 fmt::format_to(fmt::appender(buf),
34 FMT_STRING("{:.1f} s ({}H:{}m:{}s)"),
35 duration.count() / 1.0e9,
36 dur_hours.count(),
37 dur_mins.count(),
38 dur_sec.count());
39 }
40 else {
41 fmt::format_to(fmt::appender(buf), FMT_STRING("{:.1f} s"), duration.count() / 1.0e9);
42 }
43}
44
46{
47 fmt::memory_buffer buf;
48 format_duration(duration, buf);
49 std::cout << StringRef(buf.data(), buf.size());
50}
51
53{
54 const TimePoint end = Clock::now();
55 const Nanoseconds duration = end - start_;
56
57 fmt::memory_buffer buf;
58 fmt::format_to(fmt::appender(buf), FMT_STRING("Timer '{}' took "), name_);
59 format_duration(duration, buf);
60 buf.append(StringRef("\n"));
61 std::cout << StringRef(buf.data(), buf.size());
62}
63
65 int64_t &total_count,
66 Nanoseconds &total_time,
67 Nanoseconds &min_time,
68 const std::optional<int64_t> window_size,
69 const std::optional<int64_t> nth_samples_report)
70 : name_(std::move(name)),
71 total_count_(total_count),
72 total_time_(total_time),
73 min_time_(min_time),
74 window_size_(window_size),
75 nth_samples_report_(nth_samples_report)
76{
77 BLI_assert_msg(!window_size_ || window_size_.value() >= 2,
78 "`window_size` value must be at least 2");
79 BLI_assert_msg(!nth_samples_report_ || nth_samples_report_.value() >= 1,
80 "`nth_samples_report` value must be at least 1");
81 start_ = Clock::now();
82}
83
85{
86 const TimePoint end = Clock::now();
87 const Nanoseconds duration = end - start_;
88
89 total_count_++;
90 total_time_ += duration;
91
92 if (!window_size_ || total_count_ < window_size_.value()) {
93 rolling_average_ = total_time_ / total_count_;
94 }
95 else {
96 rolling_average_ = (rolling_average_ * (window_size_.value() - 1) / window_size_.value()) +
97 (duration / window_size_.value());
98 }
99
100 min_time_ = std::min(duration, min_time_);
101
102 if (nth_samples_report_ && (total_count_ % nth_samples_report_.value()) != 0) {
103 return;
104 }
105
106 fmt::memory_buffer buf;
107 fmt::format_to(fmt::appender(buf), FMT_STRING("Timer '{}': (Average: "), name_);
108 format_duration(rolling_average_, buf);
109 if (window_size_) {
110 fmt::format_to(
111 fmt::appender(buf), " of last {} events", std::min(window_size_.value(), total_count_));
112 }
113 buf.append(StringRef(", Min: "));
114 format_duration(min_time_, buf);
115 buf.append(StringRef(", Last: "));
116 format_duration(duration, buf);
117 fmt::format_to(fmt::appender(buf), ", Samples: {}, Total: ", total_count_);
118 format_duration(total_time_, buf);
119 buf.append(StringRef(")\n"));
120 std::cout << StringRef(buf.data(), buf.size());
121}
122
123} // namespace blender::timeit
#define BLI_assert_msg(a, msg)
constexpr StringRef()
ScopedTimerAveraged(std::string name, int64_t &total_count, Nanoseconds &total_time, Nanoseconds &min_time, const std::optional< int64_t > window_size, const std::optional< int64_t > nth_samples_report)
Definition timeit.cc:64
std::chrono::nanoseconds Nanoseconds
Definition BLI_timeit.hh:21
Clock::time_point TimePoint
Definition BLI_timeit.hh:20
void print_duration(Nanoseconds duration)
Definition timeit.cc:45
static void format_duration(Nanoseconds duration, fmt::memory_buffer &buf)
Definition timeit.cc:19
__int64 int64_t
Definition BKE_text.h:90