Coverage Report

Created: 2025-03-13 18:46

/root/doris/be/src/util/stopwatch.hpp
Line
Count
Source (jump to first uncovered line)
1
// Licensed to the Apache Software Foundation (ASF) under one
2
// or more contributor license agreements.  See the NOTICE file
3
// distributed with this work for additional information
4
// regarding copyright ownership.  The ASF licenses this file
5
// to you under the Apache License, Version 2.0 (the
6
// "License"); you may not use this file except in compliance
7
// with the License.  You may obtain a copy of the License at
8
//
9
//   http://www.apache.org/licenses/LICENSE-2.0
10
//
11
// Unless required by applicable law or agreed to in writing,
12
// software distributed under the License is distributed on an
13
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14
// KIND, either express or implied.  See the License for the
15
// specific language governing permissions and limitations
16
// under the License.
17
// This file is copied from
18
// https://github.com/apache/impala/blob/branch-2.9.0/be/src/util/stopwatch.hpp
19
// and modified by Doris
20
21
#pragma once
22
23
#include <time.h>
24
25
namespace doris {
26
27
// Stop watch for reporting elapsed time in nanosec based on CLOCK_MONOTONIC.
28
// It is as fast as Rdtsc.
29
// It is also accurate because it not affected by cpu frequency changes and
30
// it is not affected by user setting the system clock.
31
// CLOCK_MONOTONIC represents monotonic time since some unspecified starting point.
32
// It is good for computing elapsed time.
33
template <clockid_t Clock>
34
class CustomStopWatch {
35
public:
36
396k
    CustomStopWatch(bool auto_start = false) {
37
396k
        _total_time = 0;
38
396k
        _running = false;
39
396k
        if (auto_start) {
40
0
            start();
41
0
        }
42
396k
    }
_ZN5doris15CustomStopWatchILi1EEC2Eb
Line
Count
Source
36
396k
    CustomStopWatch(bool auto_start = false) {
37
396k
        _total_time = 0;
38
396k
        _running = false;
39
396k
        if (auto_start) {
40
0
            start();
41
0
        }
42
396k
    }
_ZN5doris15CustomStopWatchILi3EEC2Eb
Line
Count
Source
36
42
    CustomStopWatch(bool auto_start = false) {
37
42
        _total_time = 0;
38
42
        _running = false;
39
42
        if (auto_start) {
40
0
            start();
41
0
        }
42
42
    }
43
44
    timespec start_time() const { return _start; }
45
46
396k
    void start() {
47
396k
        if (!_running) {
48
395k
            clock_gettime(Clock, &_start);
49
395k
            _running = true;
50
395k
        }
51
396k
    }
_ZN5doris15CustomStopWatchILi1EE5startEv
Line
Count
Source
46
396k
    void start() {
47
396k
        if (!_running) {
48
395k
            clock_gettime(Clock, &_start);
49
395k
            _running = true;
50
395k
        }
51
396k
    }
_ZN5doris15CustomStopWatchILi3EE5startEv
Line
Count
Source
46
27
    void start() {
47
27
        if (!_running) {
48
27
            clock_gettime(Clock, &_start);
49
27
            _running = true;
50
27
        }
51
27
    }
52
53
3.43k
    void stop() {
54
3.43k
        if (_running) {
55
2.39k
            _total_time += elapsed_time();
56
2.39k
            _running = false;
57
2.39k
        }
58
3.43k
    }
_ZN5doris15CustomStopWatchILi1EE4stopEv
Line
Count
Source
53
3.42k
    void stop() {
54
3.42k
        if (_running) {
55
2.38k
            _total_time += elapsed_time();
56
2.38k
            _running = false;
57
2.38k
        }
58
3.42k
    }
_ZN5doris15CustomStopWatchILi3EE4stopEv
Line
Count
Source
53
10
    void stop() {
54
10
        if (_running) {
55
10
            _total_time += elapsed_time();
56
10
            _running = false;
57
10
        }
58
10
    }
59
60
    // Restarts the timer. Returns the elapsed time until this point.
61
3.00k
    uint64_t reset() {
62
3.00k
        uint64_t ret = elapsed_time();
63
64
3.00k
        if (_running) {
65
3.00k
            clock_gettime(Clock, &_start);
66
3.00k
        }
67
68
3.00k
        return ret;
69
3.00k
    }
_ZN5doris15CustomStopWatchILi1EE5resetEv
Line
Count
Source
61
3.00k
    uint64_t reset() {
62
3.00k
        uint64_t ret = elapsed_time();
63
64
3.00k
        if (_running) {
65
3.00k
            clock_gettime(Clock, &_start);
66
3.00k
        }
67
68
3.00k
        return ret;
69
3.00k
    }
Unexecuted instantiation: _ZN5doris15CustomStopWatchILi3EE5resetEv
70
71
    // Returns time in nanosecond.
72
381k
    uint64_t elapsed_time() const {
73
381k
        if (!_running) {
74
2.56k
            return _total_time;
75
2.56k
        }
76
77
378k
        timespec end;
78
378k
        clock_gettime(Clock, &end);
79
378k
        return (end.tv_sec - _start.tv_sec) * 1000L * 1000L * 1000L +
80
378k
               (end.tv_nsec - _start.tv_nsec);
81
381k
    }
_ZNK5doris15CustomStopWatchILi1EE12elapsed_timeEv
Line
Count
Source
72
381k
    uint64_t elapsed_time() const {
73
381k
        if (!_running) {
74
2.55k
            return _total_time;
75
2.55k
        }
76
77
378k
        timespec end;
78
378k
        clock_gettime(Clock, &end);
79
378k
        return (end.tv_sec - _start.tv_sec) * 1000L * 1000L * 1000L +
80
378k
               (end.tv_nsec - _start.tv_nsec);
81
381k
    }
_ZNK5doris15CustomStopWatchILi3EE12elapsed_timeEv
Line
Count
Source
72
37
    uint64_t elapsed_time() const {
73
37
        if (!_running) {
74
10
            return _total_time;
75
10
        }
76
77
27
        timespec end;
78
27
        clock_gettime(Clock, &end);
79
27
        return (end.tv_sec - _start.tv_sec) * 1000L * 1000L * 1000L +
80
27
               (end.tv_nsec - _start.tv_nsec);
81
37
    }
82
83
    // Return time in microseconds
84
0
    uint64_t elapsed_time_microseconds() const { return elapsed_time() / 1000; }
85
86
    // Return time in milliseconds
87
167
    uint64_t elapsed_time_milliseconds() const { return elapsed_time() / 1000 / 1000; }
88
89
    // Returns time in nanosecond.
90
0
    int64_t elapsed_time_seconds(timespec end) const {
91
0
        if (!_running) {
92
0
            return _total_time / 1000L / 1000L / 1000L;
93
0
        }
94
0
        return end.tv_sec - _start.tv_sec;
95
0
    }
96
97
private:
98
    timespec _start;
99
    uint64_t _total_time; // in nanosec
100
    bool _running;
101
};
102
103
// Stop watch for reporting elapsed time in nanosec based on CLOCK_MONOTONIC.
104
// It is as fast as Rdtsc.
105
// It is also accurate because it not affected by cpu frequency changes and
106
// it is not affected by user setting the system clock.
107
// CLOCK_MONOTONIC represents monotonic time since some unspecified starting point.
108
// It is good for computing elapsed time.
109
using MonotonicStopWatch = CustomStopWatch<CLOCK_MONOTONIC>;
110
111
// Stop watch for reporting elapsed nanosec based on CLOCK_THREAD_CPUTIME_ID.
112
using ThreadCpuStopWatch = CustomStopWatch<CLOCK_THREAD_CPUTIME_ID>;
113
114
} // namespace doris