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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
//===-- Telemetry.cpp -----------------------------------------------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
#include "lldb/Core/Telemetry.h"
#include "lldb/Core/Debugger.h"
#include "lldb/Utility/LLDBLog.h"
#include "lldb/Utility/Log.h"
#include "lldb/Utility/UUID.h"
#include "lldb/lldb-enumerations.h"
#include "lldb/lldb-forward.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/Error.h"
#include "llvm/Support/Format.h"
#include "llvm/Support/RandomNumberGenerator.h"
#include "llvm/Telemetry/Telemetry.h"
#include <chrono>
#include <cstdlib>
#include <ctime>
#include <memory>
#include <string>
#include <utility>
namespace lldb_private {
namespace telemetry {
using namespace llvm::telemetry;
static uint64_t ToNanosec(const SteadyTimePoint Point) {
return std::chrono::nanoseconds(Point.time_since_epoch()).count();
}
// Generate a unique string. This should be unique across different runs.
// We build such string by combining three parts:
// <16 random bytes>_<timestamp>
// This reduces the chances of getting the same UUID, even when the same
// user runs the two copies of binary at the same time.
static std::string MakeUUID() {
auto timestmap = std::chrono::steady_clock::now().time_since_epoch().count();
UUID uuid = UUID::Generate();
return llvm::formatv("{0}_{1}", uuid.GetAsString(), timestmap);
}
void LLDBBaseTelemetryInfo::serialize(Serializer &serializer) const {
serializer.write("entry_kind", getKind());
serializer.write("session_id", SessionId);
serializer.write("start_time", ToNanosec(start_time));
if (end_time.has_value())
serializer.write("end_time", ToNanosec(end_time.value()));
}
void ClientInfo::serialize(Serializer &serializer) const {
LLDBBaseTelemetryInfo::serialize(serializer);
serializer.write("client_data", client_data);
serializer.write("client_name", client_name);
if (error_msg.has_value())
serializer.write("error_msg", error_msg.value());
}
void CommandInfo::serialize(Serializer &serializer) const {
LLDBBaseTelemetryInfo::serialize(serializer);
serializer.write("target_uuid", target_uuid.GetAsString());
serializer.write("command_id", command_id);
serializer.write("command_name", command_name);
if (original_command.has_value())
serializer.write("original_command", original_command.value());
if (args.has_value())
serializer.write("args", args.value());
if (ret_status.has_value())
serializer.write("ret_status", ret_status.value());
if (error_data.has_value())
serializer.write("error_data", error_data.value());
}
std::atomic<uint64_t> CommandInfo::g_command_id_seed = 1;
uint64_t CommandInfo::GetNextID() { return g_command_id_seed.fetch_add(1); }
void DebuggerInfo::serialize(Serializer &serializer) const {
LLDBBaseTelemetryInfo::serialize(serializer);
serializer.write("lldb_version", lldb_version);
serializer.write("is_exit_entry", is_exit_entry);
}
void ExecutableModuleInfo::serialize(Serializer &serializer) const {
LLDBBaseTelemetryInfo::serialize(serializer);
serializer.write("uuid", uuid.GetAsString());
serializer.write("pid", pid);
serializer.write("triple", triple);
serializer.write("is_start_entry", is_start_entry);
}
void ProcessExitInfo::serialize(Serializer &serializer) const {
LLDBBaseTelemetryInfo::serialize(serializer);
serializer.write("module_uuid", module_uuid.GetAsString());
serializer.write("pid", pid);
serializer.write("is_start_entry", is_start_entry);
if (exit_desc.has_value()) {
serializer.write("exit_code", exit_desc->exit_code);
serializer.write("exit_desc", exit_desc->description);
}
}
TelemetryManager::TelemetryManager(std::unique_ptr<LLDBConfig> config)
: m_config(std::move(config)), m_id(MakeUUID()) {}
llvm::Error TelemetryManager::preDispatch(TelemetryInfo *entry) {
// Assign the manager_id, and debugger_id, if available, to this entry.
LLDBBaseTelemetryInfo *lldb_entry = llvm::cast<LLDBBaseTelemetryInfo>(entry);
lldb_entry->SessionId = m_id;
if (Debugger *debugger = lldb_entry->debugger)
lldb_entry->debugger_id = debugger->GetID();
return llvm::Error::success();
}
// Helper for extracting time field from a Dictionary.
static std::optional<std::chrono::nanoseconds>
GetAsNanosec(StructuredData::Dictionary *dict, llvm::StringRef key) {
auto value = dict->GetValueForKey(key);
if (!value->IsValid()) {
LLDB_LOG(GetLog(LLDBLog::Object),
"Cannot determine {0} from client-telemetry entry", key);
return std::nullopt;
}
return std::chrono::nanoseconds(value->GetUnsignedIntegerValue(0));
}
void TelemetryManager::DispatchClientTelemetry(
const lldb_private::StructuredDataImpl &entry, Debugger *debugger) {
if (!m_config->enable_client_telemetry)
return;
ClientInfo client_info;
client_info.debugger = debugger;
if (entry.GetObjectSP()->GetType() != lldb::eStructuredDataTypeDictionary) {
LLDB_LOG(GetLog(LLDBLog::Object), "Expected Dictionary type but got {0}.",
entry.GetObjectSP()->GetType());
return;
}
auto *dict = entry.GetObjectSP()->GetAsDictionary();
llvm::StringRef client_name;
if (dict->GetValueForKeyAsString("client_name", client_name))
client_info.client_name = client_name.str();
else
LLDB_LOG(GetLog(LLDBLog::Object),
"Cannot determine client_name from client-telemetry entry");
llvm::StringRef client_data;
if (dict->GetValueForKeyAsString("client_data", client_data))
client_info.client_data = client_data.str();
else
LLDB_LOG(GetLog(LLDBLog::Object),
"Cannot determine client_data from client-telemetry entry");
if (auto maybe_start_time = GetAsNanosec(dict, "start_time"))
client_info.start_time += *maybe_start_time;
if (auto maybe_end_time = GetAsNanosec(dict, "end_time")) {
SteadyTimePoint epoch;
client_info.end_time = epoch + *maybe_end_time;
}
llvm::StringRef error_msg;
if (dict->GetValueForKeyAsString("error", error_msg))
client_info.error_msg = error_msg.str();
if (llvm::Error er = dispatch(&client_info))
LLDB_LOG_ERROR(GetLog(LLDBLog::Object), std::move(er),
"Failed to dispatch client telemetry");
}
class NoOpTelemetryManager : public TelemetryManager {
public:
llvm::Error preDispatch(llvm::telemetry::TelemetryInfo *entry) override {
// Does nothing.
return llvm::Error::success();
}
explicit NoOpTelemetryManager()
: TelemetryManager(std::make_unique<LLDBConfig>(
/*EnableTelemetry=*/false, /*DetailedCommand=*/false,
/*ClientTelemery=*/false)) {}
virtual llvm::StringRef GetInstanceName() const override {
return "NoOpTelemetryManager";
}
void DispatchClientTelemetry(const lldb_private::StructuredDataImpl &entry,
Debugger *debugger) override {
// Does nothing.
}
llvm::Error dispatch(llvm::telemetry::TelemetryInfo *entry) override {
// Does nothing.
return llvm::Error::success();
}
static NoOpTelemetryManager *GetInstance() {
static std::unique_ptr<NoOpTelemetryManager> g_ins =
std::make_unique<NoOpTelemetryManager>();
return g_ins.get();
}
};
std::unique_ptr<TelemetryManager> TelemetryManager::g_instance = nullptr;
TelemetryManager *TelemetryManager::GetInstance() {
// If Telemetry is disabled or if there is no default instance, then use the
// NoOp manager. We use a dummy instance to avoid having to do nullchecks in
// various places.
if (!Config::BuildTimeEnableTelemetry || !g_instance)
return NoOpTelemetryManager::GetInstance();
return g_instance.get();
}
void TelemetryManager::SetInstance(std::unique_ptr<TelemetryManager> manager) {
if (Config::BuildTimeEnableTelemetry)
g_instance = std::move(manager);
}
} // namespace telemetry
} // namespace lldb_private
|
