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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
|
//===-- ScriptedThread.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 "ScriptedThread.h"
#include "Plugins/Process/Utility/RegisterContextThreadMemory.h"
#include "Plugins/Process/Utility/StopInfoMachException.h"
#include "lldb/Target/OperatingSystem.h"
#include "lldb/Target/Process.h"
#include "lldb/Target/RegisterContext.h"
#include "lldb/Target/StopInfo.h"
#include "lldb/Target/Unwind.h"
#include "lldb/Utility/DataBufferHeap.h"
#include "lldb/Utility/LLDBLog.h"
#include <memory>
#include <optional>
using namespace lldb;
using namespace lldb_private;
void ScriptedThread::CheckInterpreterAndScriptObject() const {
lldbassert(m_script_object_sp && "Invalid Script Object.");
lldbassert(GetInterface() && "Invalid Scripted Thread Interface.");
}
llvm::Expected<std::shared_ptr<ScriptedThread>>
ScriptedThread::Create(ScriptedProcess &process,
StructuredData::Generic *script_object) {
if (!process.IsValid())
return llvm::createStringError(llvm::inconvertibleErrorCode(),
"Invalid scripted process.");
process.CheckScriptedInterface();
auto scripted_thread_interface =
process.GetInterface().CreateScriptedThreadInterface();
if (!scripted_thread_interface)
return llvm::createStringError(
llvm::inconvertibleErrorCode(),
"Failed to create scripted thread interface.");
llvm::StringRef thread_class_name;
if (!script_object) {
std::optional<std::string> class_name =
process.GetInterface().GetScriptedThreadPluginName();
if (!class_name || class_name->empty())
return llvm::createStringError(
llvm::inconvertibleErrorCode(),
"Failed to get scripted thread class name.");
thread_class_name = *class_name;
}
ExecutionContext exe_ctx(process);
auto obj_or_err = scripted_thread_interface->CreatePluginObject(
thread_class_name, exe_ctx, process.m_scripted_metadata.GetArgsSP(),
script_object);
if (!obj_or_err) {
llvm::consumeError(obj_or_err.takeError());
return llvm::createStringError(llvm::inconvertibleErrorCode(),
"Failed to create script object.");
}
StructuredData::GenericSP owned_script_object_sp = *obj_or_err;
if (!owned_script_object_sp->IsValid())
return llvm::createStringError(llvm::inconvertibleErrorCode(),
"Created script object is invalid.");
lldb::tid_t tid = scripted_thread_interface->GetThreadID();
return std::make_shared<ScriptedThread>(process, scripted_thread_interface,
tid, owned_script_object_sp);
}
ScriptedThread::ScriptedThread(ScriptedProcess &process,
ScriptedThreadInterfaceSP interface_sp,
lldb::tid_t tid,
StructuredData::GenericSP script_object_sp)
: Thread(process, tid), m_scripted_process(process),
m_scripted_thread_interface_sp(interface_sp),
m_script_object_sp(script_object_sp) {}
ScriptedThread::~ScriptedThread() { DestroyThread(); }
const char *ScriptedThread::GetName() {
CheckInterpreterAndScriptObject();
std::optional<std::string> thread_name = GetInterface()->GetName();
if (!thread_name)
return nullptr;
return ConstString(thread_name->c_str()).AsCString();
}
const char *ScriptedThread::GetQueueName() {
CheckInterpreterAndScriptObject();
std::optional<std::string> queue_name = GetInterface()->GetQueue();
if (!queue_name)
return nullptr;
return ConstString(queue_name->c_str()).AsCString();
}
void ScriptedThread::WillResume(StateType resume_state) {}
void ScriptedThread::ClearStackFrames() { Thread::ClearStackFrames(); }
RegisterContextSP ScriptedThread::GetRegisterContext() {
if (!m_reg_context_sp)
m_reg_context_sp = CreateRegisterContextForFrame(nullptr);
return m_reg_context_sp;
}
RegisterContextSP
ScriptedThread::CreateRegisterContextForFrame(StackFrame *frame) {
const uint32_t concrete_frame_idx =
frame ? frame->GetConcreteFrameIndex() : 0;
if (concrete_frame_idx)
return GetUnwinder().CreateRegisterContextForFrame(frame);
lldb::RegisterContextSP reg_ctx_sp;
Status error;
std::optional<std::string> reg_data = GetInterface()->GetRegisterContext();
if (!reg_data)
return ScriptedInterface::ErrorWithMessage<lldb::RegisterContextSP>(
LLVM_PRETTY_FUNCTION, "Failed to get scripted thread registers data.",
error, LLDBLog::Thread);
DataBufferSP data_sp(
std::make_shared<DataBufferHeap>(reg_data->c_str(), reg_data->size()));
if (!data_sp->GetByteSize())
return ScriptedInterface::ErrorWithMessage<lldb::RegisterContextSP>(
LLVM_PRETTY_FUNCTION, "Failed to copy raw registers data.", error,
LLDBLog::Thread);
std::shared_ptr<RegisterContextMemory> reg_ctx_memory =
std::make_shared<RegisterContextMemory>(
*this, 0, *GetDynamicRegisterInfo(), LLDB_INVALID_ADDRESS);
if (!reg_ctx_memory)
return ScriptedInterface::ErrorWithMessage<lldb::RegisterContextSP>(
LLVM_PRETTY_FUNCTION, "Failed to create a register context.", error,
LLDBLog::Thread);
reg_ctx_memory->SetAllRegisterData(data_sp);
m_reg_context_sp = reg_ctx_memory;
return m_reg_context_sp;
}
bool ScriptedThread::LoadArtificialStackFrames() {
StructuredData::ArraySP arr_sp = GetInterface()->GetStackFrames();
Status error;
if (!arr_sp)
return ScriptedInterface::ErrorWithMessage<bool>(
LLVM_PRETTY_FUNCTION, "Failed to get scripted thread stackframes.",
error, LLDBLog::Thread);
size_t arr_size = arr_sp->GetSize();
if (arr_size > std::numeric_limits<uint32_t>::max())
return ScriptedInterface::ErrorWithMessage<bool>(
LLVM_PRETTY_FUNCTION,
llvm::Twine(
"StackFrame array size (" + llvm::Twine(arr_size) +
llvm::Twine(
") is greater than maximum authorized for a StackFrameList."))
.str(),
error, LLDBLog::Thread);
StackFrameListSP frames = GetStackFrameList();
for (size_t idx = 0; idx < arr_size; idx++) {
std::optional<StructuredData::Dictionary *> maybe_dict =
arr_sp->GetItemAtIndexAsDictionary(idx);
if (!maybe_dict)
return ScriptedInterface::ErrorWithMessage<bool>(
LLVM_PRETTY_FUNCTION,
llvm::Twine(
"Couldn't get artificial stackframe dictionary at index (" +
llvm::Twine(idx) + llvm::Twine(") from stackframe array."))
.str(),
error, LLDBLog::Thread);
StructuredData::Dictionary *dict = *maybe_dict;
lldb::addr_t pc;
if (!dict->GetValueForKeyAsInteger("pc", pc))
return ScriptedInterface::ErrorWithMessage<bool>(
LLVM_PRETTY_FUNCTION,
"Couldn't find value for key 'pc' in stackframe dictionary.", error,
LLDBLog::Thread);
Address symbol_addr;
symbol_addr.SetLoadAddress(pc, &this->GetProcess()->GetTarget());
lldb::addr_t cfa = LLDB_INVALID_ADDRESS;
bool cfa_is_valid = false;
const bool behaves_like_zeroth_frame = false;
SymbolContext sc;
symbol_addr.CalculateSymbolContext(&sc);
StackFrameSP synth_frame_sp = std::make_shared<StackFrame>(
this->shared_from_this(), idx, idx, cfa, cfa_is_valid, pc,
StackFrame::Kind::Artificial, behaves_like_zeroth_frame, &sc);
if (!frames->SetFrameAtIndex(static_cast<uint32_t>(idx), synth_frame_sp))
return ScriptedInterface::ErrorWithMessage<bool>(
LLVM_PRETTY_FUNCTION,
llvm::Twine("Couldn't add frame (" + llvm::Twine(idx) +
llvm::Twine(") to ScriptedThread StackFrameList."))
.str(),
error, LLDBLog::Thread);
}
return true;
}
bool ScriptedThread::CalculateStopInfo() {
StructuredData::DictionarySP dict_sp = GetInterface()->GetStopReason();
Status error;
if (!dict_sp)
return ScriptedInterface::ErrorWithMessage<bool>(
LLVM_PRETTY_FUNCTION, "Failed to get scripted thread stop info.", error,
LLDBLog::Thread);
// If we're at a BreakpointSite, mark that we stopped there and
// need to hit the breakpoint when we resume. This will be cleared
// if we CreateStopReasonWithBreakpointSiteID.
if (RegisterContextSP reg_ctx_sp = GetRegisterContext()) {
addr_t pc = reg_ctx_sp->GetPC();
if (BreakpointSiteSP bp_site_sp =
GetProcess()->GetBreakpointSiteList().FindByAddress(pc))
if (bp_site_sp->IsEnabled())
SetThreadStoppedAtUnexecutedBP(pc);
}
lldb::StopInfoSP stop_info_sp;
lldb::StopReason stop_reason_type;
if (!dict_sp->GetValueForKeyAsInteger("type", stop_reason_type))
return ScriptedInterface::ErrorWithMessage<bool>(
LLVM_PRETTY_FUNCTION,
"Couldn't find value for key 'type' in stop reason dictionary.", error,
LLDBLog::Thread);
StructuredData::Dictionary *data_dict;
if (!dict_sp->GetValueForKeyAsDictionary("data", data_dict))
return ScriptedInterface::ErrorWithMessage<bool>(
LLVM_PRETTY_FUNCTION,
"Couldn't find value for key 'data' in stop reason dictionary.", error,
LLDBLog::Thread);
switch (stop_reason_type) {
case lldb::eStopReasonNone:
return true;
case lldb::eStopReasonBreakpoint: {
lldb::break_id_t break_id;
data_dict->GetValueForKeyAsInteger("break_id", break_id,
LLDB_INVALID_BREAK_ID);
stop_info_sp =
StopInfo::CreateStopReasonWithBreakpointSiteID(*this, break_id);
} break;
case lldb::eStopReasonSignal: {
uint32_t signal;
llvm::StringRef description;
if (!data_dict->GetValueForKeyAsInteger("signal", signal)) {
signal = LLDB_INVALID_SIGNAL_NUMBER;
return false;
}
data_dict->GetValueForKeyAsString("desc", description);
stop_info_sp =
StopInfo::CreateStopReasonWithSignal(*this, signal, description.data());
} break;
case lldb::eStopReasonTrace: {
stop_info_sp = StopInfo::CreateStopReasonToTrace(*this);
} break;
case lldb::eStopReasonException: {
#if defined(__APPLE__)
StructuredData::Dictionary *mach_exception;
if (data_dict->GetValueForKeyAsDictionary("mach_exception",
mach_exception)) {
llvm::StringRef value;
mach_exception->GetValueForKeyAsString("type", value);
auto exc_type =
StopInfoMachException::MachException::ExceptionCode(value.data());
if (!exc_type)
return false;
uint32_t exc_data_size = 0;
llvm::SmallVector<uint64_t, 3> raw_codes;
StructuredData::Array *exc_rawcodes;
mach_exception->GetValueForKeyAsArray("rawCodes", exc_rawcodes);
if (exc_rawcodes) {
auto fetch_data = [&raw_codes](StructuredData::Object *obj) {
if (!obj)
return false;
raw_codes.push_back(obj->GetUnsignedIntegerValue());
return true;
};
exc_rawcodes->ForEach(fetch_data);
exc_data_size = raw_codes.size();
}
stop_info_sp = StopInfoMachException::CreateStopReasonWithMachException(
*this, *exc_type, exc_data_size,
exc_data_size >= 1 ? raw_codes[0] : 0,
exc_data_size >= 2 ? raw_codes[1] : 0,
exc_data_size >= 3 ? raw_codes[2] : 0);
break;
}
#endif
stop_info_sp =
StopInfo::CreateStopReasonWithException(*this, "EXC_BAD_ACCESS");
} break;
default:
return ScriptedInterface::ErrorWithMessage<bool>(
LLVM_PRETTY_FUNCTION,
llvm::Twine("Unsupported stop reason type (" +
llvm::Twine(stop_reason_type) + llvm::Twine(")."))
.str(),
error, LLDBLog::Thread);
}
if (!stop_info_sp)
return false;
SetStopInfo(stop_info_sp);
return true;
}
void ScriptedThread::RefreshStateAfterStop() {
GetRegisterContext()->InvalidateIfNeeded(/*force=*/false);
LoadArtificialStackFrames();
}
lldb::ScriptedThreadInterfaceSP ScriptedThread::GetInterface() const {
return m_scripted_thread_interface_sp;
}
std::shared_ptr<DynamicRegisterInfo> ScriptedThread::GetDynamicRegisterInfo() {
CheckInterpreterAndScriptObject();
if (!m_register_info_sp) {
StructuredData::DictionarySP reg_info = GetInterface()->GetRegisterInfo();
Status error;
if (!reg_info)
return ScriptedInterface::ErrorWithMessage<
std::shared_ptr<DynamicRegisterInfo>>(
LLVM_PRETTY_FUNCTION, "Failed to get scripted thread registers info.",
error, LLDBLog::Thread);
m_register_info_sp = DynamicRegisterInfo::Create(
*reg_info, m_scripted_process.GetTarget().GetArchitecture());
}
return m_register_info_sp;
}
StructuredData::ObjectSP ScriptedThread::FetchThreadExtendedInfo() {
CheckInterpreterAndScriptObject();
Status error;
StructuredData::ArraySP extended_info_sp = GetInterface()->GetExtendedInfo();
if (!extended_info_sp || !extended_info_sp->GetSize())
return ScriptedInterface::ErrorWithMessage<StructuredData::ObjectSP>(
LLVM_PRETTY_FUNCTION, "No extended information found", error);
return extended_info_sp;
}
|