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
|
/**
* Copyright (C) 2018-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.
*/
#pragma once
#include "mongo/base/string_data.h"
#include "mongo/db/client.h"
#include "mongo/platform/condition_variable.h"
#include "mongo/platform/mutex.h"
#include "mongo/util/fail_point_service.h"
#include "mongo/util/time_support.h"
namespace mongo {
/**
* DiagnosticInfo keeps track of diagnostic information such as a developer provided
* name, the time when a lock was first acquired, and a partial caller call stack.
*/
class DiagnosticInfo {
public:
/**
* A simple RAII guard to attempt to join a blocked op once it is no longer needed
*
* This type is used in tests in conjunction with maybeMakeBlockedOpForTest
*/
class BlockedOpGuard {
public:
~BlockedOpGuard();
};
static boost::optional<DiagnosticInfo> get(Client& client);
virtual ~DiagnosticInfo() = default;
// Maximum number of stack frames to appear in a backtrace.
static constexpr size_t kMaxBackTraceFrames = 100ull;
struct Backtrace {
std::vector<void*> data = std::vector<void*>(kMaxBackTraceFrames, nullptr);
};
struct StackFrame {
std::string toString() const;
friend bool operator==(const StackFrame& frame1, const StackFrame& frame2);
friend bool operator!=(const StackFrame& frame1, const StackFrame& frame2) {
return !(frame1 == frame2);
}
StringData objectPath;
uintptr_t instructionOffset = 0;
};
struct StackTrace {
std::string toString() const;
friend bool operator==(const StackTrace& trace1, const StackTrace& trace2);
friend bool operator!=(const StackTrace& trace1, const StackTrace& trace2) {
return !(trace1 == trace2);
}
std::vector<StackFrame> frames;
};
Date_t getTimestamp() const {
return _timestamp;
}
StringData getCaptureName() const {
return _captureName;
}
StackTrace makeStackTrace() const;
static Backtrace getBacktrace();
std::string toString() const;
/**
* Simple options struct to go with takeDiagnosticInfo
*/
struct Options {
Options() : shouldTakeBacktrace{false} {}
bool shouldTakeBacktrace;
};
/**
* Captures the diagnostic information based on the caller's context.
*/
static DiagnosticInfo capture(const StringData& captureName, Options options = Options{});
/**
* This function checks the FailPoint currentOpSpawnsThreadWaitingForLatch and potentially
* launches a blocked operation to populate waitingForLatch for $currentOp.
*/
static std::unique_ptr<BlockedOpGuard> maybeMakeBlockedOpForTest(Client* client);
private:
friend bool operator==(const DiagnosticInfo& info1, const DiagnosticInfo& info2);
friend bool operator!=(const DiagnosticInfo& info1, const DiagnosticInfo& info2) {
return !(info1 == info2);
}
friend std::ostream& operator<<(std::ostream& s, const DiagnosticInfo& info);
Date_t _timestamp;
StringData _captureName;
Backtrace _backtrace;
DiagnosticInfo(const Date_t& timestamp, const StringData& captureName, Backtrace backtrace)
: _timestamp(timestamp), _captureName(captureName), _backtrace(std::move(backtrace)) {}
};
inline std::ostream& operator<<(std::ostream& s, const DiagnosticInfo::StackFrame& frame) {
return s << frame.toString();
}
inline std::ostream& operator<<(std::ostream& s, const DiagnosticInfo& info) {
return s << info.toString();
}
} // namespace mongo
|
