Coverage Report

Created: 2026-04-29 19:21

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/tmp/bitcoin/src/logging/timer.h
Line
Count
Source
1
// Copyright (c) 2009-2010 Satoshi Nakamoto
2
// Copyright (c) 2009-present The Bitcoin Core developers
3
// Distributed under the MIT software license, see the accompanying
4
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
5
6
#ifndef BITCOIN_LOGGING_TIMER_H
7
#define BITCOIN_LOGGING_TIMER_H
8
9
#include <util/log.h>
10
#include <util/macros.h>
11
#include <util/time.h>
12
#include <util/types.h>
13
14
#include <chrono>
15
#include <optional>
16
#include <string>
17
18
19
namespace BCLog {
20
21
//! RAII-style object that outputs timing information to logs.
22
template <typename TimeType>
23
class Timer
24
{
25
public:
26
    //! If log_category is left as the default, end_msg will log unconditionally
27
    //! (instead of being filtered by category).
28
    Timer(
29
        std::string prefix,
30
        std::string end_msg,
31
        BCLog::LogFlags log_category = BCLog::LogFlags::ALL,
32
        bool msg_on_completion = true)
33
677k
        : m_prefix(std::move(prefix)),
34
677k
          m_title(std::move(end_msg)),
35
677k
          m_log_category(log_category),
36
677k
          m_message_on_completion(msg_on_completion)
37
677k
    {
38
677k
        this->Log(strprintf("%s started", m_title));
39
677k
        m_start_t = std::chrono::steady_clock::now();
40
677k
    }
BCLog::Timer<std::chrono::duration<long, std::ratio<1l, 1000000l>>>::Timer(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char>>, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char>>, BCLog::LogFlags, bool)
Line
Count
Source
33
665k
        : m_prefix(std::move(prefix)),
34
665k
          m_title(std::move(end_msg)),
35
665k
          m_log_category(log_category),
36
665k
          m_message_on_completion(msg_on_completion)
37
665k
    {
38
665k
        this->Log(strprintf("%s started", m_title));
39
665k
        m_start_t = std::chrono::steady_clock::now();
40
665k
    }
BCLog::Timer<std::chrono::duration<long, std::ratio<1l, 1l>>>::Timer(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char>>, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char>>, BCLog::LogFlags, bool)
Line
Count
Source
33
75
        : m_prefix(std::move(prefix)),
34
75
          m_title(std::move(end_msg)),
35
75
          m_log_category(log_category),
36
75
          m_message_on_completion(msg_on_completion)
37
75
    {
38
75
        this->Log(strprintf("%s started", m_title));
39
75
        m_start_t = std::chrono::steady_clock::now();
40
75
    }
BCLog::Timer<std::chrono::duration<long, std::ratio<1l, 1000l>>>::Timer(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char>>, std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char>>, BCLog::LogFlags, bool)
Line
Count
Source
33
11.4k
        : m_prefix(std::move(prefix)),
34
11.4k
          m_title(std::move(end_msg)),
35
11.4k
          m_log_category(log_category),
36
11.4k
          m_message_on_completion(msg_on_completion)
37
11.4k
    {
38
11.4k
        this->Log(strprintf("%s started", m_title));
39
11.4k
        m_start_t = std::chrono::steady_clock::now();
40
11.4k
    }
41
42
    ~Timer()
43
677k
    {
44
677k
        if (m_message_on_completion) {
45
676k
            this->Log(strprintf("%s completed", m_title));
46
676k
        } else {
47
936
            this->Log("completed");
48
936
        }
49
677k
    }
BCLog::Timer<std::chrono::duration<long, std::ratio<1l, 1000000l>>>::~Timer()
Line
Count
Source
43
666k
    {
44
666k
        if (m_message_on_completion) {
45
666k
            this->Log(strprintf("%s completed", m_title));
46
666k
        } else {
47
0
            this->Log("completed");
48
0
        }
49
666k
    }
BCLog::Timer<std::chrono::duration<long, std::ratio<1l, 1l>>>::~Timer()
Line
Count
Source
43
75
    {
44
75
        if (m_message_on_completion) {
45
75
            this->Log(strprintf("%s completed", m_title));
46
75
        } else {
47
0
            this->Log("completed");
48
0
        }
49
75
    }
BCLog::Timer<std::chrono::duration<long, std::ratio<1l, 1000l>>>::~Timer()
Line
Count
Source
43
11.4k
    {
44
11.4k
        if (m_message_on_completion) {
45
10.5k
            this->Log(strprintf("%s completed", m_title));
46
10.5k
        } else {
47
936
            this->Log("completed");
48
936
        }
49
11.4k
    }
50
51
    void Log(const std::string& msg)
52
1.35M
    {
53
1.35M
        const std::string full_msg = this->LogMsg(msg);
54
55
1.35M
        if (m_log_category == BCLog::LogFlags::ALL) {
56
196
            LogInfo("%s\n", full_msg);
57
1.35M
        } else {
58
1.35M
            LogDebug(m_log_category, "%s\n", full_msg);
59
1.35M
        }
60
1.35M
    }
BCLog::Timer<std::chrono::duration<long, std::ratio<1l, 1000000l>>>::Log(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char>> const&)
Line
Count
Source
52
1.33M
    {
53
1.33M
        const std::string full_msg = this->LogMsg(msg);
54
55
1.33M
        if (m_log_category == BCLog::LogFlags::ALL) {
56
2
            LogInfo("%s\n", full_msg);
57
1.33M
        } else {
58
1.33M
            LogDebug(m_log_category, "%s\n", full_msg);
59
1.33M
        }
60
1.33M
    }
BCLog::Timer<std::chrono::duration<long, std::ratio<1l, 1l>>>::Log(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char>> const&)
Line
Count
Source
52
150
    {
53
150
        const std::string full_msg = this->LogMsg(msg);
54
55
150
        if (m_log_category == BCLog::LogFlags::ALL) {
56
150
            LogInfo("%s\n", full_msg);
57
150
        } else {
58
0
            LogDebug(m_log_category, "%s\n", full_msg);
59
0
        }
60
150
    }
BCLog::Timer<std::chrono::duration<long, std::ratio<1l, 1000l>>>::Log(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char>> const&)
Line
Count
Source
52
22.9k
    {
53
22.9k
        const std::string full_msg = this->LogMsg(msg);
54
55
22.9k
        if (m_log_category == BCLog::LogFlags::ALL) {
56
44
            LogInfo("%s\n", full_msg);
57
22.9k
        } else {
58
22.9k
            LogDebug(m_log_category, "%s\n", full_msg);
59
22.9k
        }
60
22.9k
    }
61
62
    std::string LogMsg(const std::string& msg)
63
1.35M
    {
64
1.35M
        const auto end_time{std::chrono::steady_clock::now()};
65
1.35M
        if (!m_start_t) {
66
677k
            return strprintf("%s: %s", m_prefix, msg);
67
677k
        }
68
677k
        const auto duration{end_time - *m_start_t};
69
70
677k
        if constexpr (std::is_same_v<TimeType, std::chrono::microseconds>) {
71
665k
            return strprintf("%s: %s (%iμs)", m_prefix, msg, Ticks<std::chrono::microseconds>(duration));
72
665k
        } else if constexpr (std::is_same_v<TimeType, std::chrono::milliseconds>) {
73
11.4k
            return strprintf("%s: %s (%.2fms)", m_prefix, msg, Ticks<MillisecondsDouble>(duration));
74
11.4k
        } else if constexpr (std::is_same_v<TimeType, std::chrono::seconds>) {
75
75
            return strprintf("%s: %s (%.2fs)", m_prefix, msg, Ticks<SecondsDouble>(duration));
76
        } else {
77
            static_assert(ALWAYS_FALSE<TimeType>, "Error: unexpected time type");
78
        }
79
677k
    }
BCLog::Timer<std::chrono::duration<long, std::ratio<1l, 1000000l>>>::LogMsg(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char>> const&)
Line
Count
Source
63
1.33M
    {
64
1.33M
        const auto end_time{std::chrono::steady_clock::now()};
65
1.33M
        if (!m_start_t) {
66
666k
            return strprintf("%s: %s", m_prefix, msg);
67
666k
        }
68
665k
        const auto duration{end_time - *m_start_t};
69
70
665k
        if constexpr (std::is_same_v<TimeType, std::chrono::microseconds>) {
71
665k
            return strprintf("%s: %s (%iμs)", m_prefix, msg, Ticks<std::chrono::microseconds>(duration));
72
        } else if constexpr (std::is_same_v<TimeType, std::chrono::milliseconds>) {
73
            return strprintf("%s: %s (%.2fms)", m_prefix, msg, Ticks<MillisecondsDouble>(duration));
74
        } else if constexpr (std::is_same_v<TimeType, std::chrono::seconds>) {
75
            return strprintf("%s: %s (%.2fs)", m_prefix, msg, Ticks<SecondsDouble>(duration));
76
        } else {
77
            static_assert(ALWAYS_FALSE<TimeType>, "Error: unexpected time type");
78
        }
79
665k
    }
BCLog::Timer<std::chrono::duration<long, std::ratio<1l, 1l>>>::LogMsg(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char>> const&)
Line
Count
Source
63
150
    {
64
150
        const auto end_time{std::chrono::steady_clock::now()};
65
150
        if (!m_start_t) {
66
75
            return strprintf("%s: %s", m_prefix, msg);
67
75
        }
68
75
        const auto duration{end_time - *m_start_t};
69
70
        if constexpr (std::is_same_v<TimeType, std::chrono::microseconds>) {
71
            return strprintf("%s: %s (%iμs)", m_prefix, msg, Ticks<std::chrono::microseconds>(duration));
72
        } else if constexpr (std::is_same_v<TimeType, std::chrono::milliseconds>) {
73
            return strprintf("%s: %s (%.2fms)", m_prefix, msg, Ticks<MillisecondsDouble>(duration));
74
75
        } else if constexpr (std::is_same_v<TimeType, std::chrono::seconds>) {
75
75
            return strprintf("%s: %s (%.2fs)", m_prefix, msg, Ticks<SecondsDouble>(duration));
76
        } else {
77
            static_assert(ALWAYS_FALSE<TimeType>, "Error: unexpected time type");
78
        }
79
75
    }
BCLog::Timer<std::chrono::duration<long, std::ratio<1l, 1000l>>>::LogMsg(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char>> const&)
Line
Count
Source
63
22.9k
    {
64
22.9k
        const auto end_time{std::chrono::steady_clock::now()};
65
22.9k
        if (!m_start_t) {
66
11.4k
            return strprintf("%s: %s", m_prefix, msg);
67
11.4k
        }
68
11.4k
        const auto duration{end_time - *m_start_t};
69
70
        if constexpr (std::is_same_v<TimeType, std::chrono::microseconds>) {
71
            return strprintf("%s: %s (%iμs)", m_prefix, msg, Ticks<std::chrono::microseconds>(duration));
72
11.4k
        } else if constexpr (std::is_same_v<TimeType, std::chrono::milliseconds>) {
73
11.4k
            return strprintf("%s: %s (%.2fms)", m_prefix, msg, Ticks<MillisecondsDouble>(duration));
74
        } else if constexpr (std::is_same_v<TimeType, std::chrono::seconds>) {
75
            return strprintf("%s: %s (%.2fs)", m_prefix, msg, Ticks<SecondsDouble>(duration));
76
        } else {
77
            static_assert(ALWAYS_FALSE<TimeType>, "Error: unexpected time type");
78
        }
79
11.4k
    }
80
81
private:
82
    std::optional<std::chrono::steady_clock::time_point> m_start_t{};
83
84
    //! Log prefix; usually the name of the function this was created in.
85
    const std::string m_prefix;
86
87
    //! A descriptive message of what is being timed.
88
    const std::string m_title;
89
90
    //! Forwarded on to LogDebug if specified - has the effect of only
91
    //! outputting the timing log when a particular debug= category is specified.
92
    const BCLog::LogFlags m_log_category;
93
94
    //! Whether to output the message again on completion.
95
    const bool m_message_on_completion;
96
};
97
98
} // namespace BCLog
99
100
101
#define LOG_TIME_MICROS_WITH_CATEGORY(end_msg, log_category) \
102
665k
    BCLog::Timer<std::chrono::microseconds> UNIQUE_NAME(logging_timer)(__func__, end_msg, log_category)
103
#define LOG_TIME_MILLIS_WITH_CATEGORY(end_msg, log_category) \
104
10.5k
    BCLog::Timer<std::chrono::milliseconds> UNIQUE_NAME(logging_timer)(__func__, end_msg, log_category)
105
#define LOG_TIME_MILLIS_WITH_CATEGORY_MSG_ONCE(end_msg, log_category) \
106
936
    BCLog::Timer<std::chrono::milliseconds> UNIQUE_NAME(logging_timer)(__func__, end_msg, log_category, /* msg_on_completion=*/false)
107
#define LOG_TIME_SECONDS(end_msg) \
108
75
    BCLog::Timer<std::chrono::seconds> UNIQUE_NAME(logging_timer)(__func__, end_msg)
109
110
111
#endif // BITCOIN_LOGGING_TIMER_H