summaryrefslogtreecommitdiff
path: root/src/mongo/db/operation_cpu_timer.cpp
blob: 7627c8af11c241cecd4a0a8ec13936c245cdecf8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
/**
 *    Copyright (C) 2020-present MongoDB, Inc.
 *
 *    This program is free software: you can redistribute it and/or modify
 *    it under the terms of the Server Side Public License, version 1,
 *    as published by MongoDB, Inc.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    Server Side Public License for more details.
 *
 *    You should have received a copy of the Server Side Public License
 *    along with this program. If not, see
 *    <http://www.mongodb.com/licensing/server-side-public-license>.
 *
 *    As a special exception, the copyright holders give permission to link the
 *    code of portions of this program with the OpenSSL library under certain
 *    conditions as described in each individual source file and distribute
 *    linked combinations including the program with the OpenSSL library. You
 *    must comply with the Server Side Public License in all respects for
 *    all of the code used other than as permitted herein. If you modify file(s)
 *    with this exception, you may extend this exception to your version of the
 *    file(s), but you are not obligated to do so. If you do not wish to do so,
 *    delete this exception statement from your version. If you delete this
 *    exception statement from all source files in the program, then also delete
 *    it in the license file.
 */

#include <boost/optional.hpp>
#include <fmt/format.h>

#if defined(__linux__)
#include <time.h>
#endif  // defined(__linux__)

#include "mongo/db/operation_cpu_timer.h"

#include "mongo/base/error_codes.h"
#include "mongo/db/client.h"
#include "mongo/db/operation_context.h"
#include "mongo/stdx/thread.h"
#include "mongo/util/assert_util.h"
#include "mongo/util/errno_util.h"
#include "mongo/util/fail_point.h"

namespace mongo {

#if defined(__linux__)

namespace {

using namespace fmt::literals;

MONGO_FAIL_POINT_DEFINE(hangCPUTimerAfterOnThreadAttach);
MONGO_FAIL_POINT_DEFINE(hangCPUTimerAfterOnThreadDetach);

class PosixTimer final : public OperationCPUTimer {
public:
    Nanoseconds getElapsed() const override;

    void start() override;
    void stop() override;

    void onThreadAttach() override;
    void onThreadDetach() override;

private:
    bool _timerIsRunning() const;
    bool _isAttachedToCurrentThread() const;

    // Returns the elapsed time since the creation of the current thread.
    Nanoseconds _getThreadTime() const;

    // Holds the value returned by `_getThreadTime()` at the time of starting/resuming the timer.
    boost::optional<Nanoseconds> _startedOn;
    boost::optional<stdx::thread::id> _threadId;
    Nanoseconds _elapsedBeforeInterrupted = Nanoseconds(0);
};

Nanoseconds PosixTimer::getElapsed() const {
    invariant(_isAttachedToCurrentThread(), "Not attached to current thread");
    auto elapsed = _elapsedBeforeInterrupted;
    if (_timerIsRunning())
        elapsed += _getThreadTime() - _startedOn.get();
    return elapsed;
}

bool PosixTimer::_timerIsRunning() const {
    return _startedOn.has_value();
}

bool PosixTimer::_isAttachedToCurrentThread() const {
    return _threadId.has_value() && _threadId.get() == stdx::this_thread::get_id();
}

void PosixTimer::start() {
    invariant(!_timerIsRunning(), "Timer has already started");

    _startedOn = _getThreadTime();
    _threadId = stdx::this_thread::get_id();
    _elapsedBeforeInterrupted = Nanoseconds(0);
}

void PosixTimer::stop() {
    invariant(_timerIsRunning(), "Timer is not running");
    invariant(_isAttachedToCurrentThread());

    _elapsedBeforeInterrupted = getElapsed();
    _startedOn.reset();
}

void PosixTimer::onThreadAttach() {
    if (!_timerIsRunning())
        return;

    invariant(!_threadId.has_value(), "Timer has already been attached");
    _threadId = stdx::this_thread::get_id();
    _startedOn = _getThreadTime();

    hangCPUTimerAfterOnThreadAttach.pauseWhileSet();
}

void PosixTimer::onThreadDetach() {
    if (!_timerIsRunning())
        return;

    invariant(_threadId.has_value(), "Timer is not attached");
    _threadId.reset();
    _elapsedBeforeInterrupted = _getThreadTime() - _startedOn.get();

    hangCPUTimerAfterOnThreadDetach.pauseWhileSet();
}

Nanoseconds PosixTimer::_getThreadTime() const {
    struct timespec t;
    if (auto ret = clock_gettime(CLOCK_THREAD_CPUTIME_ID, &t); ret != 0) {
        int ec = errno;
        internalAssert(Status(ErrorCodes::InternalError,
                              "Unable to get time: {}"_format(errnoWithDescription(ec))));
    }
    return Seconds(t.tv_sec) + Nanoseconds(t.tv_nsec);
}

static auto getCPUTimer = OperationContext::declareDecoration<PosixTimer>();

}  // namespace

OperationCPUTimer* OperationCPUTimer::get(OperationContext* opCtx) {
    invariant(Client::getCurrent() && Client::getCurrent()->getOperationContext() == opCtx,
              "Operation not attached to the current thread");

    // Checks for time support on POSIX platforms. In particular, it checks for support in presence
    // of SMP systems.
    static bool isTimeSupported = [] {
        clockid_t cid;
        return clock_getcpuclockid(0, &cid) == 0;
    }();

    if (!isTimeSupported)
        return nullptr;
    return &getCPUTimer(opCtx);
}

#else  // not defined(__linux__)

OperationCPUTimer* OperationCPUTimer::get(OperationContext*) {
    return nullptr;
}

#endif  // defined(__linux__)

}  // namespace mongo