blob: d2b8f746a38c854876bc6c943f8056a27c34bdcf (
plain) (
blame)
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
|
//===-- Statistics.h --------------------------------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#ifndef LLDB_TARGET_STATISTICS_H
#define LLDB_TARGET_STATISTICS_H
#include "lldb/Utility/ConstString.h"
#include "lldb/Utility/Stream.h"
#include "lldb/lldb-forward.h"
#include "llvm/Support/JSON.h"
#include <atomic>
#include <chrono>
#include <ratio>
#include <string>
#include <vector>
namespace lldb_private {
using StatsClock = std::chrono::high_resolution_clock;
using StatsTimepoint = std::chrono::time_point<StatsClock>;
class StatsDuration {
public:
using Duration = std::chrono::duration<double>;
Duration get() const {
return Duration(InternalDuration(value.load(std::memory_order_relaxed)));
}
operator Duration() const { return get(); }
StatsDuration &operator+=(Duration dur) {
value.fetch_add(std::chrono::duration_cast<InternalDuration>(dur).count(),
std::memory_order_relaxed);
return *this;
}
private:
using InternalDuration = std::chrono::duration<uint64_t, std::micro>;
std::atomic<uint64_t> value{0};
};
/// A class that measures elapsed time in an exception safe way.
///
/// This is a RAII class is designed to help gather timing statistics within
/// LLDB where objects have optional Duration variables that get updated with
/// elapsed times. This helps LLDB measure statistics for many things that are
/// then reported in LLDB commands.
///
/// Objects that need to measure elapsed times should have a variable of type
/// "StatsDuration m_time_xxx;" which can then be used in the constructor of
/// this class inside a scope that wants to measure something:
///
/// ElapsedTime elapsed(m_time_xxx);
/// // Do some work
///
/// This class will increment the m_time_xxx variable with the elapsed time
/// when the object goes out of scope. The "m_time_xxx" variable will be
/// incremented when the class goes out of scope. This allows a variable to
/// measure something that might happen in stages at different times, like
/// resolving a breakpoint each time a new shared library is loaded.
class ElapsedTime {
public:
/// Set to the start time when the object is created.
StatsTimepoint m_start_time;
/// Elapsed time in seconds to increment when this object goes out of scope.
StatsDuration &m_elapsed_time;
public:
ElapsedTime(StatsDuration &opt_time) : m_elapsed_time(opt_time) {
m_start_time = StatsClock::now();
}
~ElapsedTime() {
StatsClock::duration elapsed = StatsClock::now() - m_start_time;
m_elapsed_time += elapsed;
}
};
/// A class to count success/fail statistics.
struct StatsSuccessFail {
StatsSuccessFail(llvm::StringRef n) : name(n.str()) {}
void NotifySuccess() { ++successes; }
void NotifyFailure() { ++failures; }
llvm::json::Value ToJSON() const;
std::string name;
uint32_t successes = 0;
uint32_t failures = 0;
};
/// A class that represents statistics for a since lldb_private::Module.
struct ModuleStats {
llvm::json::Value ToJSON() const;
intptr_t identifier;
std::string path;
std::string uuid;
std::string triple;
double symtab_parse_time = 0.0;
double symtab_index_time = 0.0;
double debug_parse_time = 0.0;
double debug_index_time = 0.0;
uint64_t debug_info_size = 0;
bool symtab_loaded_from_cache = false;
bool symtab_saved_to_cache = false;
bool debug_info_index_loaded_from_cache = false;
bool debug_info_index_saved_to_cache = false;
};
struct ConstStringStats {
llvm::json::Value ToJSON() const;
ConstString::MemoryStats stats = ConstString::GetMemoryStats();
};
/// A class that represents statistics for a since lldb_private::Target.
class TargetStats {
public:
llvm::json::Value ToJSON(Target &target);
void SetLaunchOrAttachTime();
void SetFirstPrivateStopTime();
void SetFirstPublicStopTime();
StatsDuration &GetCreateTime() { return m_create_time; }
StatsSuccessFail &GetExpressionStats() { return m_expr_eval; }
StatsSuccessFail &GetFrameVariableStats() { return m_frame_var; }
protected:
StatsDuration m_create_time;
llvm::Optional<StatsTimepoint> m_launch_or_attach_time;
llvm::Optional<StatsTimepoint> m_first_private_stop_time;
llvm::Optional<StatsTimepoint> m_first_public_stop_time;
StatsSuccessFail m_expr_eval{"expressionEvaluation"};
StatsSuccessFail m_frame_var{"frameVariable"};
std::vector<intptr_t> m_module_identifiers;
void CollectStats(Target &target);
};
class DebuggerStats {
public:
static void SetCollectingStats(bool enable) { g_collecting_stats = enable; }
static bool GetCollectingStats() { return g_collecting_stats; }
/// Get metrics associated with one or all targets in a debugger in JSON
/// format.
///
/// \param debugger
/// The debugger to get the target list from if \a target is NULL.
///
/// \param target
/// The single target to emit statistics for if non NULL, otherwise dump
/// statistics only for the specified target.
///
/// \return
/// Returns a JSON value that contains all target metrics.
static llvm::json::Value ReportStatistics(Debugger &debugger, Target *target);
protected:
// Collecting stats can be set to true to collect stats that are expensive
// to collect. By default all stats that are cheap to collect are enabled.
// This settings is here to maintain compatibility with "statistics enable"
// and "statistics disable".
static bool g_collecting_stats;
};
} // namespace lldb_private
#endif // LLDB_TARGET_STATISTICS_H
|
