1 //===-- ProcessGDBRemote.cpp ----------------------------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8
9 #include "lldb/Host/Config.h"
10
11 #include <cerrno>
12 #include <cstdlib>
13 #if LLDB_ENABLE_POSIX
14 #include <netinet/in.h>
15 #include <sys/mman.h>
16 #include <sys/socket.h>
17 #include <unistd.h>
18 #endif
19 #include <sys/stat.h>
20 #if defined(__APPLE__)
21 #include <sys/sysctl.h>
22 #endif
23 #include <ctime>
24 #include <sys/types.h>
25
26 #include <algorithm>
27 #include <csignal>
28 #include <map>
29 #include <memory>
30 #include <mutex>
31 #include <sstream>
32
33 #include "lldb/Breakpoint/Watchpoint.h"
34 #include "lldb/Core/Debugger.h"
35 #include "lldb/Core/Module.h"
36 #include "lldb/Core/ModuleSpec.h"
37 #include "lldb/Core/PluginManager.h"
38 #include "lldb/Core/StreamFile.h"
39 #include "lldb/Core/Value.h"
40 #include "lldb/DataFormatters/FormatManager.h"
41 #include "lldb/Host/ConnectionFileDescriptor.h"
42 #include "lldb/Host/FileSystem.h"
43 #include "lldb/Host/HostThread.h"
44 #include "lldb/Host/PosixApi.h"
45 #include "lldb/Host/PseudoTerminal.h"
46 #include "lldb/Host/StringConvert.h"
47 #include "lldb/Host/ThreadLauncher.h"
48 #include "lldb/Host/XML.h"
49 #include "lldb/Interpreter/CommandInterpreter.h"
50 #include "lldb/Interpreter/CommandObject.h"
51 #include "lldb/Interpreter/CommandObjectMultiword.h"
52 #include "lldb/Interpreter/CommandReturnObject.h"
53 #include "lldb/Interpreter/OptionArgParser.h"
54 #include "lldb/Interpreter/OptionGroupBoolean.h"
55 #include "lldb/Interpreter/OptionGroupUInt64.h"
56 #include "lldb/Interpreter/OptionValueProperties.h"
57 #include "lldb/Interpreter/Options.h"
58 #include "lldb/Interpreter/Property.h"
59 #include "lldb/Symbol/LocateSymbolFile.h"
60 #include "lldb/Symbol/ObjectFile.h"
61 #include "lldb/Target/ABI.h"
62 #include "lldb/Target/DynamicLoader.h"
63 #include "lldb/Target/MemoryRegionInfo.h"
64 #include "lldb/Target/SystemRuntime.h"
65 #include "lldb/Target/Target.h"
66 #include "lldb/Target/TargetList.h"
67 #include "lldb/Target/ThreadPlanCallFunction.h"
68 #include "lldb/Utility/Args.h"
69 #include "lldb/Utility/FileSpec.h"
70 #include "lldb/Utility/Reproducer.h"
71 #include "lldb/Utility/State.h"
72 #include "lldb/Utility/StreamString.h"
73 #include "lldb/Utility/Timer.h"
74
75 #include "GDBRemoteRegisterContext.h"
76 #include "Plugins/Platform/MacOSX/PlatformRemoteiOS.h"
77 #include "Plugins/Process/Utility/GDBRemoteSignals.h"
78 #include "Plugins/Process/Utility/InferiorCallPOSIX.h"
79 #include "Plugins/Process/Utility/StopInfoMachException.h"
80 #include "ProcessGDBRemote.h"
81 #include "ProcessGDBRemoteLog.h"
82 #include "ThreadGDBRemote.h"
83 #include "lldb/Host/Host.h"
84 #include "lldb/Utility/StringExtractorGDBRemote.h"
85
86 #include "llvm/ADT/ScopeExit.h"
87 #include "llvm/ADT/StringSwitch.h"
88 #include "llvm/Support/Threading.h"
89 #include "llvm/Support/raw_ostream.h"
90
91 #define DEBUGSERVER_BASENAME "debugserver"
92 using namespace lldb;
93 using namespace lldb_private;
94 using namespace lldb_private::process_gdb_remote;
95
96 LLDB_PLUGIN_DEFINE(ProcessGDBRemote)
97
98 namespace lldb {
99 // Provide a function that can easily dump the packet history if we know a
100 // ProcessGDBRemote * value (which we can get from logs or from debugging). We
101 // need the function in the lldb namespace so it makes it into the final
102 // executable since the LLDB shared library only exports stuff in the lldb
103 // namespace. This allows you to attach with a debugger and call this function
104 // and get the packet history dumped to a file.
DumpProcessGDBRemotePacketHistory(void * p,const char * path)105 void DumpProcessGDBRemotePacketHistory(void *p, const char *path) {
106 auto file = FileSystem::Instance().Open(
107 FileSpec(path), File::eOpenOptionWrite | File::eOpenOptionCanCreate);
108 if (!file) {
109 llvm::consumeError(file.takeError());
110 return;
111 }
112 StreamFile stream(std::move(file.get()));
113 ((ProcessGDBRemote *)p)->GetGDBRemote().DumpHistory(stream);
114 }
115 } // namespace lldb
116
117 namespace {
118
119 #define LLDB_PROPERTIES_processgdbremote
120 #include "ProcessGDBRemoteProperties.inc"
121
122 enum {
123 #define LLDB_PROPERTIES_processgdbremote
124 #include "ProcessGDBRemotePropertiesEnum.inc"
125 };
126
127 class PluginProperties : public Properties {
128 public:
GetSettingName()129 static ConstString GetSettingName() {
130 return ProcessGDBRemote::GetPluginNameStatic();
131 }
132
PluginProperties()133 PluginProperties() : Properties() {
134 m_collection_sp = std::make_shared<OptionValueProperties>(GetSettingName());
135 m_collection_sp->Initialize(g_processgdbremote_properties);
136 }
137
138 ~PluginProperties() override = default;
139
GetPacketTimeout()140 uint64_t GetPacketTimeout() {
141 const uint32_t idx = ePropertyPacketTimeout;
142 return m_collection_sp->GetPropertyAtIndexAsUInt64(
143 nullptr, idx, g_processgdbremote_properties[idx].default_uint_value);
144 }
145
SetPacketTimeout(uint64_t timeout)146 bool SetPacketTimeout(uint64_t timeout) {
147 const uint32_t idx = ePropertyPacketTimeout;
148 return m_collection_sp->SetPropertyAtIndexAsUInt64(nullptr, idx, timeout);
149 }
150
GetTargetDefinitionFile() const151 FileSpec GetTargetDefinitionFile() const {
152 const uint32_t idx = ePropertyTargetDefinitionFile;
153 return m_collection_sp->GetPropertyAtIndexAsFileSpec(nullptr, idx);
154 }
155
GetUseSVR4() const156 bool GetUseSVR4() const {
157 const uint32_t idx = ePropertyUseSVR4;
158 return m_collection_sp->GetPropertyAtIndexAsBoolean(
159 nullptr, idx,
160 g_processgdbremote_properties[idx].default_uint_value != 0);
161 }
162
GetUseGPacketForReading() const163 bool GetUseGPacketForReading() const {
164 const uint32_t idx = ePropertyUseGPacketForReading;
165 return m_collection_sp->GetPropertyAtIndexAsBoolean(nullptr, idx, true);
166 }
167 };
168
169 typedef std::shared_ptr<PluginProperties> ProcessKDPPropertiesSP;
170
GetGlobalPluginProperties()171 static const ProcessKDPPropertiesSP &GetGlobalPluginProperties() {
172 static ProcessKDPPropertiesSP g_settings_sp;
173 if (!g_settings_sp)
174 g_settings_sp = std::make_shared<PluginProperties>();
175 return g_settings_sp;
176 }
177
178 } // namespace
179
180 // TODO Randomly assigning a port is unsafe. We should get an unused
181 // ephemeral port from the kernel and make sure we reserve it before passing it
182 // to debugserver.
183
184 #if defined(__APPLE__)
185 #define LOW_PORT (IPPORT_RESERVED)
186 #define HIGH_PORT (IPPORT_HIFIRSTAUTO)
187 #else
188 #define LOW_PORT (1024u)
189 #define HIGH_PORT (49151u)
190 #endif
191
GetPluginNameStatic()192 ConstString ProcessGDBRemote::GetPluginNameStatic() {
193 static ConstString g_name("gdb-remote");
194 return g_name;
195 }
196
GetPluginDescriptionStatic()197 const char *ProcessGDBRemote::GetPluginDescriptionStatic() {
198 return "GDB Remote protocol based debugging plug-in.";
199 }
200
Terminate()201 void ProcessGDBRemote::Terminate() {
202 PluginManager::UnregisterPlugin(ProcessGDBRemote::CreateInstance);
203 }
204
205 lldb::ProcessSP
CreateInstance(lldb::TargetSP target_sp,ListenerSP listener_sp,const FileSpec * crash_file_path,bool can_connect)206 ProcessGDBRemote::CreateInstance(lldb::TargetSP target_sp,
207 ListenerSP listener_sp,
208 const FileSpec *crash_file_path,
209 bool can_connect) {
210 lldb::ProcessSP process_sp;
211 if (crash_file_path == nullptr)
212 process_sp = std::make_shared<ProcessGDBRemote>(target_sp, listener_sp);
213 return process_sp;
214 }
215
GetPacketTimeout()216 std::chrono::seconds ProcessGDBRemote::GetPacketTimeout() {
217 return std::chrono::seconds(GetGlobalPluginProperties()->GetPacketTimeout());
218 }
219
CanDebug(lldb::TargetSP target_sp,bool plugin_specified_by_name)220 bool ProcessGDBRemote::CanDebug(lldb::TargetSP target_sp,
221 bool plugin_specified_by_name) {
222 if (plugin_specified_by_name)
223 return true;
224
225 // For now we are just making sure the file exists for a given module
226 Module *exe_module = target_sp->GetExecutableModulePointer();
227 if (exe_module) {
228 ObjectFile *exe_objfile = exe_module->GetObjectFile();
229 // We can't debug core files...
230 switch (exe_objfile->GetType()) {
231 case ObjectFile::eTypeInvalid:
232 case ObjectFile::eTypeCoreFile:
233 case ObjectFile::eTypeDebugInfo:
234 case ObjectFile::eTypeObjectFile:
235 case ObjectFile::eTypeSharedLibrary:
236 case ObjectFile::eTypeStubLibrary:
237 case ObjectFile::eTypeJIT:
238 return false;
239 case ObjectFile::eTypeExecutable:
240 case ObjectFile::eTypeDynamicLinker:
241 case ObjectFile::eTypeUnknown:
242 break;
243 }
244 return FileSystem::Instance().Exists(exe_module->GetFileSpec());
245 }
246 // However, if there is no executable module, we return true since we might
247 // be preparing to attach.
248 return true;
249 }
250
251 // ProcessGDBRemote constructor
ProcessGDBRemote(lldb::TargetSP target_sp,ListenerSP listener_sp)252 ProcessGDBRemote::ProcessGDBRemote(lldb::TargetSP target_sp,
253 ListenerSP listener_sp)
254 : Process(target_sp, listener_sp),
255 m_debugserver_pid(LLDB_INVALID_PROCESS_ID), m_last_stop_packet_mutex(),
256 m_register_info_sp(nullptr),
257 m_async_broadcaster(nullptr, "lldb.process.gdb-remote.async-broadcaster"),
258 m_async_listener_sp(
259 Listener::MakeListener("lldb.process.gdb-remote.async-listener")),
260 m_async_thread_state_mutex(), m_thread_ids(), m_thread_pcs(),
261 m_jstopinfo_sp(), m_jthreadsinfo_sp(), m_continue_c_tids(),
262 m_continue_C_tids(), m_continue_s_tids(), m_continue_S_tids(),
263 m_max_memory_size(0), m_remote_stub_max_memory_size(0),
264 m_addr_to_mmap_size(), m_thread_create_bp_sp(),
265 m_waiting_for_attach(false), m_destroy_tried_resuming(false),
266 m_command_sp(), m_breakpoint_pc_offset(0),
267 m_initial_tid(LLDB_INVALID_THREAD_ID), m_replay_mode(false),
268 m_allow_flash_writes(false), m_erased_flash_ranges() {
269 m_async_broadcaster.SetEventName(eBroadcastBitAsyncThreadShouldExit,
270 "async thread should exit");
271 m_async_broadcaster.SetEventName(eBroadcastBitAsyncContinue,
272 "async thread continue");
273 m_async_broadcaster.SetEventName(eBroadcastBitAsyncThreadDidExit,
274 "async thread did exit");
275
276 if (repro::Generator *g = repro::Reproducer::Instance().GetGenerator()) {
277 repro::GDBRemoteProvider &provider =
278 g->GetOrCreate<repro::GDBRemoteProvider>();
279 m_gdb_comm.SetPacketRecorder(provider.GetNewPacketRecorder());
280 }
281
282 Log *log(ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_ASYNC));
283
284 const uint32_t async_event_mask =
285 eBroadcastBitAsyncContinue | eBroadcastBitAsyncThreadShouldExit;
286
287 if (m_async_listener_sp->StartListeningForEvents(
288 &m_async_broadcaster, async_event_mask) != async_event_mask) {
289 LLDB_LOGF(log,
290 "ProcessGDBRemote::%s failed to listen for "
291 "m_async_broadcaster events",
292 __FUNCTION__);
293 }
294
295 const uint32_t gdb_event_mask =
296 Communication::eBroadcastBitReadThreadDidExit |
297 GDBRemoteCommunication::eBroadcastBitGdbReadThreadGotNotify;
298 if (m_async_listener_sp->StartListeningForEvents(
299 &m_gdb_comm, gdb_event_mask) != gdb_event_mask) {
300 LLDB_LOGF(log,
301 "ProcessGDBRemote::%s failed to listen for m_gdb_comm events",
302 __FUNCTION__);
303 }
304
305 const uint64_t timeout_seconds =
306 GetGlobalPluginProperties()->GetPacketTimeout();
307 if (timeout_seconds > 0)
308 m_gdb_comm.SetPacketTimeout(std::chrono::seconds(timeout_seconds));
309
310 m_use_g_packet_for_reading =
311 GetGlobalPluginProperties()->GetUseGPacketForReading();
312 }
313
314 // Destructor
~ProcessGDBRemote()315 ProcessGDBRemote::~ProcessGDBRemote() {
316 // m_mach_process.UnregisterNotificationCallbacks (this);
317 Clear();
318 // We need to call finalize on the process before destroying ourselves to
319 // make sure all of the broadcaster cleanup goes as planned. If we destruct
320 // this class, then Process::~Process() might have problems trying to fully
321 // destroy the broadcaster.
322 Finalize();
323
324 // The general Finalize is going to try to destroy the process and that
325 // SHOULD shut down the async thread. However, if we don't kill it it will
326 // get stranded and its connection will go away so when it wakes up it will
327 // crash. So kill it for sure here.
328 StopAsyncThread();
329 KillDebugserverProcess();
330 }
331
332 // PluginInterface
GetPluginName()333 ConstString ProcessGDBRemote::GetPluginName() { return GetPluginNameStatic(); }
334
GetPluginVersion()335 uint32_t ProcessGDBRemote::GetPluginVersion() { return 1; }
336
ParsePythonTargetDefinition(const FileSpec & target_definition_fspec)337 bool ProcessGDBRemote::ParsePythonTargetDefinition(
338 const FileSpec &target_definition_fspec) {
339 ScriptInterpreter *interpreter =
340 GetTarget().GetDebugger().GetScriptInterpreter();
341 Status error;
342 StructuredData::ObjectSP module_object_sp(
343 interpreter->LoadPluginModule(target_definition_fspec, error));
344 if (module_object_sp) {
345 StructuredData::DictionarySP target_definition_sp(
346 interpreter->GetDynamicSettings(module_object_sp, &GetTarget(),
347 "gdb-server-target-definition", error));
348
349 if (target_definition_sp) {
350 StructuredData::ObjectSP target_object(
351 target_definition_sp->GetValueForKey("host-info"));
352 if (target_object) {
353 if (auto host_info_dict = target_object->GetAsDictionary()) {
354 StructuredData::ObjectSP triple_value =
355 host_info_dict->GetValueForKey("triple");
356 if (auto triple_string_value = triple_value->GetAsString()) {
357 std::string triple_string =
358 std::string(triple_string_value->GetValue());
359 ArchSpec host_arch(triple_string.c_str());
360 if (!host_arch.IsCompatibleMatch(GetTarget().GetArchitecture())) {
361 GetTarget().SetArchitecture(host_arch);
362 }
363 }
364 }
365 }
366 m_breakpoint_pc_offset = 0;
367 StructuredData::ObjectSP breakpoint_pc_offset_value =
368 target_definition_sp->GetValueForKey("breakpoint-pc-offset");
369 if (breakpoint_pc_offset_value) {
370 if (auto breakpoint_pc_int_value =
371 breakpoint_pc_offset_value->GetAsInteger())
372 m_breakpoint_pc_offset = breakpoint_pc_int_value->GetValue();
373 }
374
375 if (m_register_info_sp->SetRegisterInfo(
376 *target_definition_sp, GetTarget().GetArchitecture()) > 0) {
377 return true;
378 }
379 }
380 }
381 return false;
382 }
383
SplitCommaSeparatedRegisterNumberString(const llvm::StringRef & comma_separated_regiter_numbers,std::vector<uint32_t> & regnums,int base)384 static size_t SplitCommaSeparatedRegisterNumberString(
385 const llvm::StringRef &comma_separated_regiter_numbers,
386 std::vector<uint32_t> ®nums, int base) {
387 regnums.clear();
388 std::pair<llvm::StringRef, llvm::StringRef> value_pair;
389 value_pair.second = comma_separated_regiter_numbers;
390 do {
391 value_pair = value_pair.second.split(',');
392 if (!value_pair.first.empty()) {
393 uint32_t reg = StringConvert::ToUInt32(value_pair.first.str().c_str(),
394 LLDB_INVALID_REGNUM, base);
395 if (reg != LLDB_INVALID_REGNUM)
396 regnums.push_back(reg);
397 }
398 } while (!value_pair.second.empty());
399 return regnums.size();
400 }
401
BuildDynamicRegisterInfo(bool force)402 void ProcessGDBRemote::BuildDynamicRegisterInfo(bool force) {
403 if (!force && m_register_info_sp)
404 return;
405
406 m_register_info_sp = std::make_shared<GDBRemoteDynamicRegisterInfo>();
407
408 // Check if qHostInfo specified a specific packet timeout for this
409 // connection. If so then lets update our setting so the user knows what the
410 // timeout is and can see it.
411 const auto host_packet_timeout = m_gdb_comm.GetHostDefaultPacketTimeout();
412 if (host_packet_timeout > std::chrono::seconds(0)) {
413 GetGlobalPluginProperties()->SetPacketTimeout(host_packet_timeout.count());
414 }
415
416 // Register info search order:
417 // 1 - Use the target definition python file if one is specified.
418 // 2 - If the target definition doesn't have any of the info from the
419 // target.xml (registers) then proceed to read the target.xml.
420 // 3 - Fall back on the qRegisterInfo packets.
421
422 FileSpec target_definition_fspec =
423 GetGlobalPluginProperties()->GetTargetDefinitionFile();
424 if (!FileSystem::Instance().Exists(target_definition_fspec)) {
425 // If the filename doesn't exist, it may be a ~ not having been expanded -
426 // try to resolve it.
427 FileSystem::Instance().Resolve(target_definition_fspec);
428 }
429 if (target_definition_fspec) {
430 // See if we can get register definitions from a python file
431 if (ParsePythonTargetDefinition(target_definition_fspec)) {
432 return;
433 } else {
434 StreamSP stream_sp = GetTarget().GetDebugger().GetAsyncOutputStream();
435 stream_sp->Printf("ERROR: target description file %s failed to parse.\n",
436 target_definition_fspec.GetPath().c_str());
437 }
438 }
439
440 const ArchSpec &target_arch = GetTarget().GetArchitecture();
441 const ArchSpec &remote_host_arch = m_gdb_comm.GetHostArchitecture();
442 const ArchSpec &remote_process_arch = m_gdb_comm.GetProcessArchitecture();
443
444 // Use the process' architecture instead of the host arch, if available
445 ArchSpec arch_to_use;
446 if (remote_process_arch.IsValid())
447 arch_to_use = remote_process_arch;
448 else
449 arch_to_use = remote_host_arch;
450
451 if (!arch_to_use.IsValid())
452 arch_to_use = target_arch;
453
454 if (GetGDBServerRegisterInfo(arch_to_use))
455 return;
456
457 char packet[128];
458 uint32_t reg_offset = LLDB_INVALID_INDEX32;
459 uint32_t reg_num = 0;
460 for (StringExtractorGDBRemote::ResponseType response_type =
461 StringExtractorGDBRemote::eResponse;
462 response_type == StringExtractorGDBRemote::eResponse; ++reg_num) {
463 const int packet_len =
464 ::snprintf(packet, sizeof(packet), "qRegisterInfo%x", reg_num);
465 assert(packet_len < (int)sizeof(packet));
466 UNUSED_IF_ASSERT_DISABLED(packet_len);
467 StringExtractorGDBRemote response;
468 if (m_gdb_comm.SendPacketAndWaitForResponse(packet, response) ==
469 GDBRemoteCommunication::PacketResult::Success) {
470 response_type = response.GetResponseType();
471 if (response_type == StringExtractorGDBRemote::eResponse) {
472 llvm::StringRef name;
473 llvm::StringRef value;
474 ConstString reg_name;
475 ConstString alt_name;
476 ConstString set_name;
477 std::vector<uint32_t> value_regs;
478 std::vector<uint32_t> invalidate_regs;
479 std::vector<uint8_t> dwarf_opcode_bytes;
480 RegisterInfo reg_info = {
481 nullptr, // Name
482 nullptr, // Alt name
483 0, // byte size
484 reg_offset, // offset
485 eEncodingUint, // encoding
486 eFormatHex, // format
487 {
488 LLDB_INVALID_REGNUM, // eh_frame reg num
489 LLDB_INVALID_REGNUM, // DWARF reg num
490 LLDB_INVALID_REGNUM, // generic reg num
491 reg_num, // process plugin reg num
492 reg_num // native register number
493 },
494 nullptr,
495 nullptr,
496 nullptr, // Dwarf expression opcode bytes pointer
497 0 // Dwarf expression opcode bytes length
498 };
499
500 while (response.GetNameColonValue(name, value)) {
501 if (name.equals("name")) {
502 reg_name.SetString(value);
503 } else if (name.equals("alt-name")) {
504 alt_name.SetString(value);
505 } else if (name.equals("bitsize")) {
506 value.getAsInteger(0, reg_info.byte_size);
507 reg_info.byte_size /= CHAR_BIT;
508 } else if (name.equals("offset")) {
509 if (value.getAsInteger(0, reg_offset))
510 reg_offset = UINT32_MAX;
511 } else if (name.equals("encoding")) {
512 const Encoding encoding = Args::StringToEncoding(value);
513 if (encoding != eEncodingInvalid)
514 reg_info.encoding = encoding;
515 } else if (name.equals("format")) {
516 Format format = eFormatInvalid;
517 if (OptionArgParser::ToFormat(value.str().c_str(), format, nullptr)
518 .Success())
519 reg_info.format = format;
520 else {
521 reg_info.format =
522 llvm::StringSwitch<Format>(value)
523 .Case("binary", eFormatBinary)
524 .Case("decimal", eFormatDecimal)
525 .Case("hex", eFormatHex)
526 .Case("float", eFormatFloat)
527 .Case("vector-sint8", eFormatVectorOfSInt8)
528 .Case("vector-uint8", eFormatVectorOfUInt8)
529 .Case("vector-sint16", eFormatVectorOfSInt16)
530 .Case("vector-uint16", eFormatVectorOfUInt16)
531 .Case("vector-sint32", eFormatVectorOfSInt32)
532 .Case("vector-uint32", eFormatVectorOfUInt32)
533 .Case("vector-float32", eFormatVectorOfFloat32)
534 .Case("vector-uint64", eFormatVectorOfUInt64)
535 .Case("vector-uint128", eFormatVectorOfUInt128)
536 .Default(eFormatInvalid);
537 }
538 } else if (name.equals("set")) {
539 set_name.SetString(value);
540 } else if (name.equals("gcc") || name.equals("ehframe")) {
541 if (value.getAsInteger(0, reg_info.kinds[eRegisterKindEHFrame]))
542 reg_info.kinds[eRegisterKindEHFrame] = LLDB_INVALID_REGNUM;
543 } else if (name.equals("dwarf")) {
544 if (value.getAsInteger(0, reg_info.kinds[eRegisterKindDWARF]))
545 reg_info.kinds[eRegisterKindDWARF] = LLDB_INVALID_REGNUM;
546 } else if (name.equals("generic")) {
547 reg_info.kinds[eRegisterKindGeneric] =
548 Args::StringToGenericRegister(value);
549 } else if (name.equals("container-regs")) {
550 SplitCommaSeparatedRegisterNumberString(value, value_regs, 16);
551 } else if (name.equals("invalidate-regs")) {
552 SplitCommaSeparatedRegisterNumberString(value, invalidate_regs, 16);
553 } else if (name.equals("dynamic_size_dwarf_expr_bytes")) {
554 size_t dwarf_opcode_len = value.size() / 2;
555 assert(dwarf_opcode_len > 0);
556
557 dwarf_opcode_bytes.resize(dwarf_opcode_len);
558 reg_info.dynamic_size_dwarf_len = dwarf_opcode_len;
559
560 StringExtractor opcode_extractor(value);
561 uint32_t ret_val =
562 opcode_extractor.GetHexBytesAvail(dwarf_opcode_bytes);
563 assert(dwarf_opcode_len == ret_val);
564 UNUSED_IF_ASSERT_DISABLED(ret_val);
565 reg_info.dynamic_size_dwarf_expr_bytes = dwarf_opcode_bytes.data();
566 }
567 }
568
569 reg_info.byte_offset = reg_offset;
570 assert(reg_info.byte_size != 0);
571 reg_offset = LLDB_INVALID_INDEX32;
572 if (!value_regs.empty()) {
573 value_regs.push_back(LLDB_INVALID_REGNUM);
574 reg_info.value_regs = value_regs.data();
575 }
576 if (!invalidate_regs.empty()) {
577 invalidate_regs.push_back(LLDB_INVALID_REGNUM);
578 reg_info.invalidate_regs = invalidate_regs.data();
579 }
580
581 reg_info.name = reg_name.AsCString();
582 // We have to make a temporary ABI here, and not use the GetABI because
583 // this code gets called in DidAttach, when the target architecture
584 // (and consequently the ABI we'll get from the process) may be wrong.
585 if (ABISP abi_sp = ABI::FindPlugin(shared_from_this(), arch_to_use))
586 abi_sp->AugmentRegisterInfo(reg_info);
587
588 m_register_info_sp->AddRegister(reg_info, reg_name, alt_name, set_name);
589 } else {
590 break; // ensure exit before reg_num is incremented
591 }
592 } else {
593 break;
594 }
595 }
596
597 if (m_register_info_sp->GetNumRegisters() > 0) {
598 m_register_info_sp->Finalize(GetTarget().GetArchitecture());
599 return;
600 }
601
602 // We didn't get anything if the accumulated reg_num is zero. See if we are
603 // debugging ARM and fill with a hard coded register set until we can get an
604 // updated debugserver down on the devices. On the other hand, if the
605 // accumulated reg_num is positive, see if we can add composite registers to
606 // the existing primordial ones.
607 bool from_scratch = (m_register_info_sp->GetNumRegisters() == 0);
608
609 if (!target_arch.IsValid()) {
610 if (arch_to_use.IsValid() &&
611 (arch_to_use.GetMachine() == llvm::Triple::arm ||
612 arch_to_use.GetMachine() == llvm::Triple::thumb) &&
613 arch_to_use.GetTriple().getVendor() == llvm::Triple::Apple)
614 m_register_info_sp->HardcodeARMRegisters(from_scratch);
615 } else if (target_arch.GetMachine() == llvm::Triple::arm ||
616 target_arch.GetMachine() == llvm::Triple::thumb) {
617 m_register_info_sp->HardcodeARMRegisters(from_scratch);
618 }
619
620 // At this point, we can finalize our register info.
621 m_register_info_sp->Finalize(GetTarget().GetArchitecture());
622 }
623
WillLaunch(lldb_private::Module * module)624 Status ProcessGDBRemote::WillLaunch(lldb_private::Module *module) {
625 return WillLaunchOrAttach();
626 }
627
WillAttachToProcessWithID(lldb::pid_t pid)628 Status ProcessGDBRemote::WillAttachToProcessWithID(lldb::pid_t pid) {
629 return WillLaunchOrAttach();
630 }
631
WillAttachToProcessWithName(const char * process_name,bool wait_for_launch)632 Status ProcessGDBRemote::WillAttachToProcessWithName(const char *process_name,
633 bool wait_for_launch) {
634 return WillLaunchOrAttach();
635 }
636
DoConnectRemote(llvm::StringRef remote_url)637 Status ProcessGDBRemote::DoConnectRemote(llvm::StringRef remote_url) {
638 Log *log(ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
639 Status error(WillLaunchOrAttach());
640
641 if (error.Fail())
642 return error;
643
644 if (repro::Reproducer::Instance().IsReplaying())
645 error = ConnectToReplayServer();
646 else
647 error = ConnectToDebugserver(remote_url);
648
649 if (error.Fail())
650 return error;
651 StartAsyncThread();
652
653 lldb::pid_t pid = m_gdb_comm.GetCurrentProcessID();
654 if (pid == LLDB_INVALID_PROCESS_ID) {
655 // We don't have a valid process ID, so note that we are connected and
656 // could now request to launch or attach, or get remote process listings...
657 SetPrivateState(eStateConnected);
658 } else {
659 // We have a valid process
660 SetID(pid);
661 GetThreadList();
662 StringExtractorGDBRemote response;
663 if (m_gdb_comm.GetStopReply(response)) {
664 SetLastStopPacket(response);
665
666 // '?' Packets must be handled differently in non-stop mode
667 if (GetTarget().GetNonStopModeEnabled())
668 HandleStopReplySequence();
669
670 Target &target = GetTarget();
671 if (!target.GetArchitecture().IsValid()) {
672 if (m_gdb_comm.GetProcessArchitecture().IsValid()) {
673 target.SetArchitecture(m_gdb_comm.GetProcessArchitecture());
674 } else {
675 if (m_gdb_comm.GetHostArchitecture().IsValid()) {
676 target.SetArchitecture(m_gdb_comm.GetHostArchitecture());
677 }
678 }
679 }
680
681 const StateType state = SetThreadStopInfo(response);
682 if (state != eStateInvalid) {
683 SetPrivateState(state);
684 } else
685 error.SetErrorStringWithFormat(
686 "Process %" PRIu64 " was reported after connecting to "
687 "'%s', but state was not stopped: %s",
688 pid, remote_url.str().c_str(), StateAsCString(state));
689 } else
690 error.SetErrorStringWithFormat("Process %" PRIu64
691 " was reported after connecting to '%s', "
692 "but no stop reply packet was received",
693 pid, remote_url.str().c_str());
694 }
695
696 LLDB_LOGF(log,
697 "ProcessGDBRemote::%s pid %" PRIu64
698 ": normalizing target architecture initial triple: %s "
699 "(GetTarget().GetArchitecture().IsValid() %s, "
700 "m_gdb_comm.GetHostArchitecture().IsValid(): %s)",
701 __FUNCTION__, GetID(),
702 GetTarget().GetArchitecture().GetTriple().getTriple().c_str(),
703 GetTarget().GetArchitecture().IsValid() ? "true" : "false",
704 m_gdb_comm.GetHostArchitecture().IsValid() ? "true" : "false");
705
706 if (error.Success() && !GetTarget().GetArchitecture().IsValid() &&
707 m_gdb_comm.GetHostArchitecture().IsValid()) {
708 // Prefer the *process'* architecture over that of the *host*, if
709 // available.
710 if (m_gdb_comm.GetProcessArchitecture().IsValid())
711 GetTarget().SetArchitecture(m_gdb_comm.GetProcessArchitecture());
712 else
713 GetTarget().SetArchitecture(m_gdb_comm.GetHostArchitecture());
714 }
715
716 LLDB_LOGF(log,
717 "ProcessGDBRemote::%s pid %" PRIu64
718 ": normalized target architecture triple: %s",
719 __FUNCTION__, GetID(),
720 GetTarget().GetArchitecture().GetTriple().getTriple().c_str());
721
722 if (error.Success()) {
723 PlatformSP platform_sp = GetTarget().GetPlatform();
724 if (platform_sp && platform_sp->IsConnected())
725 SetUnixSignals(platform_sp->GetUnixSignals());
726 else
727 SetUnixSignals(UnixSignals::Create(GetTarget().GetArchitecture()));
728 }
729
730 return error;
731 }
732
WillLaunchOrAttach()733 Status ProcessGDBRemote::WillLaunchOrAttach() {
734 Status error;
735 m_stdio_communication.Clear();
736 return error;
737 }
738
739 // Process Control
DoLaunch(lldb_private::Module * exe_module,ProcessLaunchInfo & launch_info)740 Status ProcessGDBRemote::DoLaunch(lldb_private::Module *exe_module,
741 ProcessLaunchInfo &launch_info) {
742 Log *log(ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
743 Status error;
744
745 LLDB_LOGF(log, "ProcessGDBRemote::%s() entered", __FUNCTION__);
746
747 uint32_t launch_flags = launch_info.GetFlags().Get();
748 FileSpec stdin_file_spec{};
749 FileSpec stdout_file_spec{};
750 FileSpec stderr_file_spec{};
751 FileSpec working_dir = launch_info.GetWorkingDirectory();
752
753 const FileAction *file_action;
754 file_action = launch_info.GetFileActionForFD(STDIN_FILENO);
755 if (file_action) {
756 if (file_action->GetAction() == FileAction::eFileActionOpen)
757 stdin_file_spec = file_action->GetFileSpec();
758 }
759 file_action = launch_info.GetFileActionForFD(STDOUT_FILENO);
760 if (file_action) {
761 if (file_action->GetAction() == FileAction::eFileActionOpen)
762 stdout_file_spec = file_action->GetFileSpec();
763 }
764 file_action = launch_info.GetFileActionForFD(STDERR_FILENO);
765 if (file_action) {
766 if (file_action->GetAction() == FileAction::eFileActionOpen)
767 stderr_file_spec = file_action->GetFileSpec();
768 }
769
770 if (log) {
771 if (stdin_file_spec || stdout_file_spec || stderr_file_spec)
772 LLDB_LOGF(log,
773 "ProcessGDBRemote::%s provided with STDIO paths via "
774 "launch_info: stdin=%s, stdout=%s, stderr=%s",
775 __FUNCTION__,
776 stdin_file_spec ? stdin_file_spec.GetCString() : "<null>",
777 stdout_file_spec ? stdout_file_spec.GetCString() : "<null>",
778 stderr_file_spec ? stderr_file_spec.GetCString() : "<null>");
779 else
780 LLDB_LOGF(log,
781 "ProcessGDBRemote::%s no STDIO paths given via launch_info",
782 __FUNCTION__);
783 }
784
785 const bool disable_stdio = (launch_flags & eLaunchFlagDisableSTDIO) != 0;
786 if (stdin_file_spec || disable_stdio) {
787 // the inferior will be reading stdin from the specified file or stdio is
788 // completely disabled
789 m_stdin_forward = false;
790 } else {
791 m_stdin_forward = true;
792 }
793
794 // ::LogSetBitMask (GDBR_LOG_DEFAULT);
795 // ::LogSetOptions (LLDB_LOG_OPTION_THREADSAFE |
796 // LLDB_LOG_OPTION_PREPEND_TIMESTAMP |
797 // LLDB_LOG_OPTION_PREPEND_PROC_AND_THREAD);
798 // ::LogSetLogFile ("/dev/stdout");
799
800 ObjectFile *object_file = exe_module->GetObjectFile();
801 if (object_file) {
802 error = EstablishConnectionIfNeeded(launch_info);
803 if (error.Success()) {
804 PseudoTerminal pty;
805 const bool disable_stdio = (launch_flags & eLaunchFlagDisableSTDIO) != 0;
806
807 PlatformSP platform_sp(GetTarget().GetPlatform());
808 if (disable_stdio) {
809 // set to /dev/null unless redirected to a file above
810 if (!stdin_file_spec)
811 stdin_file_spec.SetFile(FileSystem::DEV_NULL,
812 FileSpec::Style::native);
813 if (!stdout_file_spec)
814 stdout_file_spec.SetFile(FileSystem::DEV_NULL,
815 FileSpec::Style::native);
816 if (!stderr_file_spec)
817 stderr_file_spec.SetFile(FileSystem::DEV_NULL,
818 FileSpec::Style::native);
819 } else if (platform_sp && platform_sp->IsHost()) {
820 // If the debugserver is local and we aren't disabling STDIO, lets use
821 // a pseudo terminal to instead of relying on the 'O' packets for stdio
822 // since 'O' packets can really slow down debugging if the inferior
823 // does a lot of output.
824 if ((!stdin_file_spec || !stdout_file_spec || !stderr_file_spec) &&
825 !errorToBool(pty.OpenFirstAvailablePrimary(O_RDWR | O_NOCTTY))) {
826 FileSpec secondary_name(pty.GetSecondaryName());
827
828 if (!stdin_file_spec)
829 stdin_file_spec = secondary_name;
830
831 if (!stdout_file_spec)
832 stdout_file_spec = secondary_name;
833
834 if (!stderr_file_spec)
835 stderr_file_spec = secondary_name;
836 }
837 LLDB_LOGF(
838 log,
839 "ProcessGDBRemote::%s adjusted STDIO paths for local platform "
840 "(IsHost() is true) using secondary: stdin=%s, stdout=%s, "
841 "stderr=%s",
842 __FUNCTION__,
843 stdin_file_spec ? stdin_file_spec.GetCString() : "<null>",
844 stdout_file_spec ? stdout_file_spec.GetCString() : "<null>",
845 stderr_file_spec ? stderr_file_spec.GetCString() : "<null>");
846 }
847
848 LLDB_LOGF(log,
849 "ProcessGDBRemote::%s final STDIO paths after all "
850 "adjustments: stdin=%s, stdout=%s, stderr=%s",
851 __FUNCTION__,
852 stdin_file_spec ? stdin_file_spec.GetCString() : "<null>",
853 stdout_file_spec ? stdout_file_spec.GetCString() : "<null>",
854 stderr_file_spec ? stderr_file_spec.GetCString() : "<null>");
855
856 if (stdin_file_spec)
857 m_gdb_comm.SetSTDIN(stdin_file_spec);
858 if (stdout_file_spec)
859 m_gdb_comm.SetSTDOUT(stdout_file_spec);
860 if (stderr_file_spec)
861 m_gdb_comm.SetSTDERR(stderr_file_spec);
862
863 m_gdb_comm.SetDisableASLR(launch_flags & eLaunchFlagDisableASLR);
864 m_gdb_comm.SetDetachOnError(launch_flags & eLaunchFlagDetachOnError);
865
866 m_gdb_comm.SendLaunchArchPacket(
867 GetTarget().GetArchitecture().GetArchitectureName());
868
869 const char *launch_event_data = launch_info.GetLaunchEventData();
870 if (launch_event_data != nullptr && *launch_event_data != '\0')
871 m_gdb_comm.SendLaunchEventDataPacket(launch_event_data);
872
873 if (working_dir) {
874 m_gdb_comm.SetWorkingDir(working_dir);
875 }
876
877 // Send the environment and the program + arguments after we connect
878 m_gdb_comm.SendEnvironment(launch_info.GetEnvironment());
879
880 {
881 // Scope for the scoped timeout object
882 GDBRemoteCommunication::ScopedTimeout timeout(m_gdb_comm,
883 std::chrono::seconds(10));
884
885 int arg_packet_err = m_gdb_comm.SendArgumentsPacket(launch_info);
886 if (arg_packet_err == 0) {
887 std::string error_str;
888 if (m_gdb_comm.GetLaunchSuccess(error_str)) {
889 SetID(m_gdb_comm.GetCurrentProcessID());
890 } else {
891 error.SetErrorString(error_str.c_str());
892 }
893 } else {
894 error.SetErrorStringWithFormat("'A' packet returned an error: %i",
895 arg_packet_err);
896 }
897 }
898
899 if (GetID() == LLDB_INVALID_PROCESS_ID) {
900 LLDB_LOGF(log, "failed to connect to debugserver: %s",
901 error.AsCString());
902 KillDebugserverProcess();
903 return error;
904 }
905
906 StringExtractorGDBRemote response;
907 if (m_gdb_comm.GetStopReply(response)) {
908 SetLastStopPacket(response);
909 // '?' Packets must be handled differently in non-stop mode
910 if (GetTarget().GetNonStopModeEnabled())
911 HandleStopReplySequence();
912
913 const ArchSpec &process_arch = m_gdb_comm.GetProcessArchitecture();
914
915 if (process_arch.IsValid()) {
916 GetTarget().MergeArchitecture(process_arch);
917 } else {
918 const ArchSpec &host_arch = m_gdb_comm.GetHostArchitecture();
919 if (host_arch.IsValid())
920 GetTarget().MergeArchitecture(host_arch);
921 }
922
923 SetPrivateState(SetThreadStopInfo(response));
924
925 if (!disable_stdio) {
926 if (pty.GetPrimaryFileDescriptor() != PseudoTerminal::invalid_fd)
927 SetSTDIOFileDescriptor(pty.ReleasePrimaryFileDescriptor());
928 }
929 }
930 } else {
931 LLDB_LOGF(log, "failed to connect to debugserver: %s", error.AsCString());
932 }
933 } else {
934 // Set our user ID to an invalid process ID.
935 SetID(LLDB_INVALID_PROCESS_ID);
936 error.SetErrorStringWithFormat(
937 "failed to get object file from '%s' for arch %s",
938 exe_module->GetFileSpec().GetFilename().AsCString(),
939 exe_module->GetArchitecture().GetArchitectureName());
940 }
941 return error;
942 }
943
ConnectToDebugserver(llvm::StringRef connect_url)944 Status ProcessGDBRemote::ConnectToDebugserver(llvm::StringRef connect_url) {
945 Status error;
946 // Only connect if we have a valid connect URL
947 Log *log(ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
948
949 if (!connect_url.empty()) {
950 LLDB_LOGF(log, "ProcessGDBRemote::%s Connecting to %s", __FUNCTION__,
951 connect_url.str().c_str());
952 std::unique_ptr<ConnectionFileDescriptor> conn_up(
953 new ConnectionFileDescriptor());
954 if (conn_up) {
955 const uint32_t max_retry_count = 50;
956 uint32_t retry_count = 0;
957 while (!m_gdb_comm.IsConnected()) {
958 if (conn_up->Connect(connect_url, &error) == eConnectionStatusSuccess) {
959 m_gdb_comm.SetConnection(std::move(conn_up));
960 break;
961 } else if (error.WasInterrupted()) {
962 // If we were interrupted, don't keep retrying.
963 break;
964 }
965
966 retry_count++;
967
968 if (retry_count >= max_retry_count)
969 break;
970
971 std::this_thread::sleep_for(std::chrono::milliseconds(100));
972 }
973 }
974 }
975
976 if (!m_gdb_comm.IsConnected()) {
977 if (error.Success())
978 error.SetErrorString("not connected to remote gdb server");
979 return error;
980 }
981
982 // Start the communications read thread so all incoming data can be parsed
983 // into packets and queued as they arrive.
984 if (GetTarget().GetNonStopModeEnabled())
985 m_gdb_comm.StartReadThread();
986
987 // We always seem to be able to open a connection to a local port so we need
988 // to make sure we can then send data to it. If we can't then we aren't
989 // actually connected to anything, so try and do the handshake with the
990 // remote GDB server and make sure that goes alright.
991 if (!m_gdb_comm.HandshakeWithServer(&error)) {
992 m_gdb_comm.Disconnect();
993 if (error.Success())
994 error.SetErrorString("not connected to remote gdb server");
995 return error;
996 }
997
998 // Send $QNonStop:1 packet on startup if required
999 if (GetTarget().GetNonStopModeEnabled())
1000 GetTarget().SetNonStopModeEnabled(m_gdb_comm.SetNonStopMode(true));
1001
1002 m_gdb_comm.GetEchoSupported();
1003 m_gdb_comm.GetThreadSuffixSupported();
1004 m_gdb_comm.GetListThreadsInStopReplySupported();
1005 m_gdb_comm.GetHostInfo();
1006 m_gdb_comm.GetVContSupported('c');
1007 m_gdb_comm.GetVAttachOrWaitSupported();
1008 m_gdb_comm.EnableErrorStringInPacket();
1009
1010 // Ask the remote server for the default thread id
1011 if (GetTarget().GetNonStopModeEnabled())
1012 m_gdb_comm.GetDefaultThreadId(m_initial_tid);
1013
1014 size_t num_cmds = GetExtraStartupCommands().GetArgumentCount();
1015 for (size_t idx = 0; idx < num_cmds; idx++) {
1016 StringExtractorGDBRemote response;
1017 m_gdb_comm.SendPacketAndWaitForResponse(
1018 GetExtraStartupCommands().GetArgumentAtIndex(idx), response);
1019 }
1020 return error;
1021 }
1022
DidLaunchOrAttach(ArchSpec & process_arch)1023 void ProcessGDBRemote::DidLaunchOrAttach(ArchSpec &process_arch) {
1024 Log *log(ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
1025 BuildDynamicRegisterInfo(false);
1026
1027 // See if the GDB server supports qHostInfo or qProcessInfo packets. Prefer
1028 // qProcessInfo as it will be more specific to our process.
1029
1030 const ArchSpec &remote_process_arch = m_gdb_comm.GetProcessArchitecture();
1031 if (remote_process_arch.IsValid()) {
1032 process_arch = remote_process_arch;
1033 LLDB_LOG(log, "gdb-remote had process architecture, using {0} {1}",
1034 process_arch.GetArchitectureName(),
1035 process_arch.GetTriple().getTriple());
1036 } else {
1037 process_arch = m_gdb_comm.GetHostArchitecture();
1038 LLDB_LOG(log,
1039 "gdb-remote did not have process architecture, using gdb-remote "
1040 "host architecture {0} {1}",
1041 process_arch.GetArchitectureName(),
1042 process_arch.GetTriple().getTriple());
1043 }
1044
1045 if (int addresssable_bits = m_gdb_comm.GetAddressingBits()) {
1046 lldb::addr_t address_mask = ~((1ULL << addresssable_bits) - 1);
1047 SetCodeAddressMask(address_mask);
1048 SetDataAddressMask(address_mask);
1049 }
1050
1051 if (process_arch.IsValid()) {
1052 const ArchSpec &target_arch = GetTarget().GetArchitecture();
1053 if (target_arch.IsValid()) {
1054 LLDB_LOG(log, "analyzing target arch, currently {0} {1}",
1055 target_arch.GetArchitectureName(),
1056 target_arch.GetTriple().getTriple());
1057
1058 // If the remote host is ARM and we have apple as the vendor, then
1059 // ARM executables and shared libraries can have mixed ARM
1060 // architectures.
1061 // You can have an armv6 executable, and if the host is armv7, then the
1062 // system will load the best possible architecture for all shared
1063 // libraries it has, so we really need to take the remote host
1064 // architecture as our defacto architecture in this case.
1065
1066 if ((process_arch.GetMachine() == llvm::Triple::arm ||
1067 process_arch.GetMachine() == llvm::Triple::thumb) &&
1068 process_arch.GetTriple().getVendor() == llvm::Triple::Apple) {
1069 GetTarget().SetArchitecture(process_arch);
1070 LLDB_LOG(log,
1071 "remote process is ARM/Apple, "
1072 "setting target arch to {0} {1}",
1073 process_arch.GetArchitectureName(),
1074 process_arch.GetTriple().getTriple());
1075 } else {
1076 // Fill in what is missing in the triple
1077 const llvm::Triple &remote_triple = process_arch.GetTriple();
1078 llvm::Triple new_target_triple = target_arch.GetTriple();
1079 if (new_target_triple.getVendorName().size() == 0) {
1080 new_target_triple.setVendor(remote_triple.getVendor());
1081
1082 if (new_target_triple.getOSName().size() == 0) {
1083 new_target_triple.setOS(remote_triple.getOS());
1084
1085 if (new_target_triple.getEnvironmentName().size() == 0)
1086 new_target_triple.setEnvironment(remote_triple.getEnvironment());
1087 }
1088
1089 ArchSpec new_target_arch = target_arch;
1090 new_target_arch.SetTriple(new_target_triple);
1091 GetTarget().SetArchitecture(new_target_arch);
1092 }
1093 }
1094
1095 LLDB_LOG(log,
1096 "final target arch after adjustments for remote architecture: "
1097 "{0} {1}",
1098 target_arch.GetArchitectureName(),
1099 target_arch.GetTriple().getTriple());
1100 } else {
1101 // The target doesn't have a valid architecture yet, set it from the
1102 // architecture we got from the remote GDB server
1103 GetTarget().SetArchitecture(process_arch);
1104 }
1105 }
1106
1107 MaybeLoadExecutableModule();
1108
1109 // Find out which StructuredDataPlugins are supported by the debug monitor.
1110 // These plugins transmit data over async $J packets.
1111 if (StructuredData::Array *supported_packets =
1112 m_gdb_comm.GetSupportedStructuredDataPlugins())
1113 MapSupportedStructuredDataPlugins(*supported_packets);
1114 }
1115
MaybeLoadExecutableModule()1116 void ProcessGDBRemote::MaybeLoadExecutableModule() {
1117 ModuleSP module_sp = GetTarget().GetExecutableModule();
1118 if (!module_sp)
1119 return;
1120
1121 llvm::Optional<QOffsets> offsets = m_gdb_comm.GetQOffsets();
1122 if (!offsets)
1123 return;
1124
1125 bool is_uniform =
1126 size_t(llvm::count(offsets->offsets, offsets->offsets[0])) ==
1127 offsets->offsets.size();
1128 if (!is_uniform)
1129 return; // TODO: Handle non-uniform responses.
1130
1131 bool changed = false;
1132 module_sp->SetLoadAddress(GetTarget(), offsets->offsets[0],
1133 /*value_is_offset=*/true, changed);
1134 if (changed) {
1135 ModuleList list;
1136 list.Append(module_sp);
1137 m_process->GetTarget().ModulesDidLoad(list);
1138 }
1139 }
1140
DidLaunch()1141 void ProcessGDBRemote::DidLaunch() {
1142 ArchSpec process_arch;
1143 DidLaunchOrAttach(process_arch);
1144 }
1145
DoAttachToProcessWithID(lldb::pid_t attach_pid,const ProcessAttachInfo & attach_info)1146 Status ProcessGDBRemote::DoAttachToProcessWithID(
1147 lldb::pid_t attach_pid, const ProcessAttachInfo &attach_info) {
1148 Log *log(ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
1149 Status error;
1150
1151 LLDB_LOGF(log, "ProcessGDBRemote::%s()", __FUNCTION__);
1152
1153 // Clear out and clean up from any current state
1154 Clear();
1155 if (attach_pid != LLDB_INVALID_PROCESS_ID) {
1156 error = EstablishConnectionIfNeeded(attach_info);
1157 if (error.Success()) {
1158 m_gdb_comm.SetDetachOnError(attach_info.GetDetachOnError());
1159
1160 char packet[64];
1161 const int packet_len =
1162 ::snprintf(packet, sizeof(packet), "vAttach;%" PRIx64, attach_pid);
1163 SetID(attach_pid);
1164 m_async_broadcaster.BroadcastEvent(
1165 eBroadcastBitAsyncContinue, new EventDataBytes(packet, packet_len));
1166 } else
1167 SetExitStatus(-1, error.AsCString());
1168 }
1169
1170 return error;
1171 }
1172
DoAttachToProcessWithName(const char * process_name,const ProcessAttachInfo & attach_info)1173 Status ProcessGDBRemote::DoAttachToProcessWithName(
1174 const char *process_name, const ProcessAttachInfo &attach_info) {
1175 Status error;
1176 // Clear out and clean up from any current state
1177 Clear();
1178
1179 if (process_name && process_name[0]) {
1180 error = EstablishConnectionIfNeeded(attach_info);
1181 if (error.Success()) {
1182 StreamString packet;
1183
1184 m_gdb_comm.SetDetachOnError(attach_info.GetDetachOnError());
1185
1186 if (attach_info.GetWaitForLaunch()) {
1187 if (!m_gdb_comm.GetVAttachOrWaitSupported()) {
1188 packet.PutCString("vAttachWait");
1189 } else {
1190 if (attach_info.GetIgnoreExisting())
1191 packet.PutCString("vAttachWait");
1192 else
1193 packet.PutCString("vAttachOrWait");
1194 }
1195 } else
1196 packet.PutCString("vAttachName");
1197 packet.PutChar(';');
1198 packet.PutBytesAsRawHex8(process_name, strlen(process_name),
1199 endian::InlHostByteOrder(),
1200 endian::InlHostByteOrder());
1201
1202 m_async_broadcaster.BroadcastEvent(
1203 eBroadcastBitAsyncContinue,
1204 new EventDataBytes(packet.GetString().data(), packet.GetSize()));
1205
1206 } else
1207 SetExitStatus(-1, error.AsCString());
1208 }
1209 return error;
1210 }
1211
TraceSupported()1212 llvm::Expected<TraceSupportedResponse> ProcessGDBRemote::TraceSupported() {
1213 return m_gdb_comm.SendTraceSupported(GetInterruptTimeout());
1214 }
1215
TraceStop(const TraceStopRequest & request)1216 llvm::Error ProcessGDBRemote::TraceStop(const TraceStopRequest &request) {
1217 return m_gdb_comm.SendTraceStop(request, GetInterruptTimeout());
1218 }
1219
TraceStart(const llvm::json::Value & request)1220 llvm::Error ProcessGDBRemote::TraceStart(const llvm::json::Value &request) {
1221 return m_gdb_comm.SendTraceStart(request, GetInterruptTimeout());
1222 }
1223
1224 llvm::Expected<std::string>
TraceGetState(llvm::StringRef type)1225 ProcessGDBRemote::TraceGetState(llvm::StringRef type) {
1226 return m_gdb_comm.SendTraceGetState(type, GetInterruptTimeout());
1227 }
1228
1229 llvm::Expected<std::vector<uint8_t>>
TraceGetBinaryData(const TraceGetBinaryDataRequest & request)1230 ProcessGDBRemote::TraceGetBinaryData(const TraceGetBinaryDataRequest &request) {
1231 return m_gdb_comm.SendTraceGetBinaryData(request, GetInterruptTimeout());
1232 }
1233
DidExit()1234 void ProcessGDBRemote::DidExit() {
1235 // When we exit, disconnect from the GDB server communications
1236 m_gdb_comm.Disconnect();
1237 }
1238
DidAttach(ArchSpec & process_arch)1239 void ProcessGDBRemote::DidAttach(ArchSpec &process_arch) {
1240 // If you can figure out what the architecture is, fill it in here.
1241 process_arch.Clear();
1242 DidLaunchOrAttach(process_arch);
1243 }
1244
WillResume()1245 Status ProcessGDBRemote::WillResume() {
1246 m_continue_c_tids.clear();
1247 m_continue_C_tids.clear();
1248 m_continue_s_tids.clear();
1249 m_continue_S_tids.clear();
1250 m_jstopinfo_sp.reset();
1251 m_jthreadsinfo_sp.reset();
1252 return Status();
1253 }
1254
DoResume()1255 Status ProcessGDBRemote::DoResume() {
1256 Status error;
1257 Log *log(ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
1258 LLDB_LOGF(log, "ProcessGDBRemote::Resume()");
1259
1260 ListenerSP listener_sp(
1261 Listener::MakeListener("gdb-remote.resume-packet-sent"));
1262 if (listener_sp->StartListeningForEvents(
1263 &m_gdb_comm, GDBRemoteCommunication::eBroadcastBitRunPacketSent)) {
1264 listener_sp->StartListeningForEvents(
1265 &m_async_broadcaster,
1266 ProcessGDBRemote::eBroadcastBitAsyncThreadDidExit);
1267
1268 const size_t num_threads = GetThreadList().GetSize();
1269
1270 StreamString continue_packet;
1271 bool continue_packet_error = false;
1272 if (m_gdb_comm.HasAnyVContSupport()) {
1273 if (!GetTarget().GetNonStopModeEnabled() &&
1274 (m_continue_c_tids.size() == num_threads ||
1275 (m_continue_c_tids.empty() && m_continue_C_tids.empty() &&
1276 m_continue_s_tids.empty() && m_continue_S_tids.empty()))) {
1277 // All threads are continuing, just send a "c" packet
1278 continue_packet.PutCString("c");
1279 } else {
1280 continue_packet.PutCString("vCont");
1281
1282 if (!m_continue_c_tids.empty()) {
1283 if (m_gdb_comm.GetVContSupported('c')) {
1284 for (tid_collection::const_iterator
1285 t_pos = m_continue_c_tids.begin(),
1286 t_end = m_continue_c_tids.end();
1287 t_pos != t_end; ++t_pos)
1288 continue_packet.Printf(";c:%4.4" PRIx64, *t_pos);
1289 } else
1290 continue_packet_error = true;
1291 }
1292
1293 if (!continue_packet_error && !m_continue_C_tids.empty()) {
1294 if (m_gdb_comm.GetVContSupported('C')) {
1295 for (tid_sig_collection::const_iterator
1296 s_pos = m_continue_C_tids.begin(),
1297 s_end = m_continue_C_tids.end();
1298 s_pos != s_end; ++s_pos)
1299 continue_packet.Printf(";C%2.2x:%4.4" PRIx64, s_pos->second,
1300 s_pos->first);
1301 } else
1302 continue_packet_error = true;
1303 }
1304
1305 if (!continue_packet_error && !m_continue_s_tids.empty()) {
1306 if (m_gdb_comm.GetVContSupported('s')) {
1307 for (tid_collection::const_iterator
1308 t_pos = m_continue_s_tids.begin(),
1309 t_end = m_continue_s_tids.end();
1310 t_pos != t_end; ++t_pos)
1311 continue_packet.Printf(";s:%4.4" PRIx64, *t_pos);
1312 } else
1313 continue_packet_error = true;
1314 }
1315
1316 if (!continue_packet_error && !m_continue_S_tids.empty()) {
1317 if (m_gdb_comm.GetVContSupported('S')) {
1318 for (tid_sig_collection::const_iterator
1319 s_pos = m_continue_S_tids.begin(),
1320 s_end = m_continue_S_tids.end();
1321 s_pos != s_end; ++s_pos)
1322 continue_packet.Printf(";S%2.2x:%4.4" PRIx64, s_pos->second,
1323 s_pos->first);
1324 } else
1325 continue_packet_error = true;
1326 }
1327
1328 if (continue_packet_error)
1329 continue_packet.Clear();
1330 }
1331 } else
1332 continue_packet_error = true;
1333
1334 if (continue_packet_error) {
1335 // Either no vCont support, or we tried to use part of the vCont packet
1336 // that wasn't supported by the remote GDB server. We need to try and
1337 // make a simple packet that can do our continue
1338 const size_t num_continue_c_tids = m_continue_c_tids.size();
1339 const size_t num_continue_C_tids = m_continue_C_tids.size();
1340 const size_t num_continue_s_tids = m_continue_s_tids.size();
1341 const size_t num_continue_S_tids = m_continue_S_tids.size();
1342 if (num_continue_c_tids > 0) {
1343 if (num_continue_c_tids == num_threads) {
1344 // All threads are resuming...
1345 m_gdb_comm.SetCurrentThreadForRun(-1);
1346 continue_packet.PutChar('c');
1347 continue_packet_error = false;
1348 } else if (num_continue_c_tids == 1 && num_continue_C_tids == 0 &&
1349 num_continue_s_tids == 0 && num_continue_S_tids == 0) {
1350 // Only one thread is continuing
1351 m_gdb_comm.SetCurrentThreadForRun(m_continue_c_tids.front());
1352 continue_packet.PutChar('c');
1353 continue_packet_error = false;
1354 }
1355 }
1356
1357 if (continue_packet_error && num_continue_C_tids > 0) {
1358 if ((num_continue_C_tids + num_continue_c_tids) == num_threads &&
1359 num_continue_C_tids > 0 && num_continue_s_tids == 0 &&
1360 num_continue_S_tids == 0) {
1361 const int continue_signo = m_continue_C_tids.front().second;
1362 // Only one thread is continuing
1363 if (num_continue_C_tids > 1) {
1364 // More that one thread with a signal, yet we don't have vCont
1365 // support and we are being asked to resume each thread with a
1366 // signal, we need to make sure they are all the same signal, or we
1367 // can't issue the continue accurately with the current support...
1368 if (num_continue_C_tids > 1) {
1369 continue_packet_error = false;
1370 for (size_t i = 1; i < m_continue_C_tids.size(); ++i) {
1371 if (m_continue_C_tids[i].second != continue_signo)
1372 continue_packet_error = true;
1373 }
1374 }
1375 if (!continue_packet_error)
1376 m_gdb_comm.SetCurrentThreadForRun(-1);
1377 } else {
1378 // Set the continue thread ID
1379 continue_packet_error = false;
1380 m_gdb_comm.SetCurrentThreadForRun(m_continue_C_tids.front().first);
1381 }
1382 if (!continue_packet_error) {
1383 // Add threads continuing with the same signo...
1384 continue_packet.Printf("C%2.2x", continue_signo);
1385 }
1386 }
1387 }
1388
1389 if (continue_packet_error && num_continue_s_tids > 0) {
1390 if (num_continue_s_tids == num_threads) {
1391 // All threads are resuming...
1392 m_gdb_comm.SetCurrentThreadForRun(-1);
1393
1394 // If in Non-Stop-Mode use vCont when stepping
1395 if (GetTarget().GetNonStopModeEnabled()) {
1396 if (m_gdb_comm.GetVContSupported('s'))
1397 continue_packet.PutCString("vCont;s");
1398 else
1399 continue_packet.PutChar('s');
1400 } else
1401 continue_packet.PutChar('s');
1402
1403 continue_packet_error = false;
1404 } else if (num_continue_c_tids == 0 && num_continue_C_tids == 0 &&
1405 num_continue_s_tids == 1 && num_continue_S_tids == 0) {
1406 // Only one thread is stepping
1407 m_gdb_comm.SetCurrentThreadForRun(m_continue_s_tids.front());
1408 continue_packet.PutChar('s');
1409 continue_packet_error = false;
1410 }
1411 }
1412
1413 if (!continue_packet_error && num_continue_S_tids > 0) {
1414 if (num_continue_S_tids == num_threads) {
1415 const int step_signo = m_continue_S_tids.front().second;
1416 // Are all threads trying to step with the same signal?
1417 continue_packet_error = false;
1418 if (num_continue_S_tids > 1) {
1419 for (size_t i = 1; i < num_threads; ++i) {
1420 if (m_continue_S_tids[i].second != step_signo)
1421 continue_packet_error = true;
1422 }
1423 }
1424 if (!continue_packet_error) {
1425 // Add threads stepping with the same signo...
1426 m_gdb_comm.SetCurrentThreadForRun(-1);
1427 continue_packet.Printf("S%2.2x", step_signo);
1428 }
1429 } else if (num_continue_c_tids == 0 && num_continue_C_tids == 0 &&
1430 num_continue_s_tids == 0 && num_continue_S_tids == 1) {
1431 // Only one thread is stepping with signal
1432 m_gdb_comm.SetCurrentThreadForRun(m_continue_S_tids.front().first);
1433 continue_packet.Printf("S%2.2x", m_continue_S_tids.front().second);
1434 continue_packet_error = false;
1435 }
1436 }
1437 }
1438
1439 if (continue_packet_error) {
1440 error.SetErrorString("can't make continue packet for this resume");
1441 } else {
1442 EventSP event_sp;
1443 if (!m_async_thread.IsJoinable()) {
1444 error.SetErrorString("Trying to resume but the async thread is dead.");
1445 LLDB_LOGF(log, "ProcessGDBRemote::DoResume: Trying to resume but the "
1446 "async thread is dead.");
1447 return error;
1448 }
1449
1450 m_async_broadcaster.BroadcastEvent(
1451 eBroadcastBitAsyncContinue,
1452 new EventDataBytes(continue_packet.GetString().data(),
1453 continue_packet.GetSize()));
1454
1455 if (!listener_sp->GetEvent(event_sp, std::chrono::seconds(5))) {
1456 error.SetErrorString("Resume timed out.");
1457 LLDB_LOGF(log, "ProcessGDBRemote::DoResume: Resume timed out.");
1458 } else if (event_sp->BroadcasterIs(&m_async_broadcaster)) {
1459 error.SetErrorString("Broadcast continue, but the async thread was "
1460 "killed before we got an ack back.");
1461 LLDB_LOGF(log,
1462 "ProcessGDBRemote::DoResume: Broadcast continue, but the "
1463 "async thread was killed before we got an ack back.");
1464 return error;
1465 }
1466 }
1467 }
1468
1469 return error;
1470 }
1471
HandleStopReplySequence()1472 void ProcessGDBRemote::HandleStopReplySequence() {
1473 while (true) {
1474 // Send vStopped
1475 StringExtractorGDBRemote response;
1476 m_gdb_comm.SendPacketAndWaitForResponse("vStopped", response);
1477
1478 // OK represents end of signal list
1479 if (response.IsOKResponse())
1480 break;
1481
1482 // If not OK or a normal packet we have a problem
1483 if (!response.IsNormalResponse())
1484 break;
1485
1486 SetLastStopPacket(response);
1487 }
1488 }
1489
ClearThreadIDList()1490 void ProcessGDBRemote::ClearThreadIDList() {
1491 std::lock_guard<std::recursive_mutex> guard(m_thread_list_real.GetMutex());
1492 m_thread_ids.clear();
1493 m_thread_pcs.clear();
1494 }
1495
UpdateThreadIDsFromStopReplyThreadsValue(llvm::StringRef value)1496 size_t ProcessGDBRemote::UpdateThreadIDsFromStopReplyThreadsValue(
1497 llvm::StringRef value) {
1498 m_thread_ids.clear();
1499 lldb::pid_t pid = m_gdb_comm.GetCurrentProcessID();
1500 StringExtractorGDBRemote thread_ids{value};
1501
1502 do {
1503 auto pid_tid = thread_ids.GetPidTid(pid);
1504 if (pid_tid && pid_tid->first == pid) {
1505 lldb::tid_t tid = pid_tid->second;
1506 if (tid != LLDB_INVALID_THREAD_ID &&
1507 tid != StringExtractorGDBRemote::AllProcesses)
1508 m_thread_ids.push_back(tid);
1509 }
1510 } while (thread_ids.GetChar() == ',');
1511
1512 return m_thread_ids.size();
1513 }
1514
1515 size_t
UpdateThreadPCsFromStopReplyThreadsValue(std::string & value)1516 ProcessGDBRemote::UpdateThreadPCsFromStopReplyThreadsValue(std::string &value) {
1517 m_thread_pcs.clear();
1518 size_t comma_pos;
1519 lldb::addr_t pc;
1520 while ((comma_pos = value.find(',')) != std::string::npos) {
1521 value[comma_pos] = '\0';
1522 pc = StringConvert::ToUInt64(value.c_str(), LLDB_INVALID_ADDRESS, 16);
1523 if (pc != LLDB_INVALID_ADDRESS)
1524 m_thread_pcs.push_back(pc);
1525 value.erase(0, comma_pos + 1);
1526 }
1527 pc = StringConvert::ToUInt64(value.c_str(), LLDB_INVALID_ADDRESS, 16);
1528 if (pc != LLDB_INVALID_ADDRESS)
1529 m_thread_pcs.push_back(pc);
1530 return m_thread_pcs.size();
1531 }
1532
UpdateThreadIDList()1533 bool ProcessGDBRemote::UpdateThreadIDList() {
1534 std::lock_guard<std::recursive_mutex> guard(m_thread_list_real.GetMutex());
1535
1536 if (m_jthreadsinfo_sp) {
1537 // If we have the JSON threads info, we can get the thread list from that
1538 StructuredData::Array *thread_infos = m_jthreadsinfo_sp->GetAsArray();
1539 if (thread_infos && thread_infos->GetSize() > 0) {
1540 m_thread_ids.clear();
1541 m_thread_pcs.clear();
1542 thread_infos->ForEach([this](StructuredData::Object *object) -> bool {
1543 StructuredData::Dictionary *thread_dict = object->GetAsDictionary();
1544 if (thread_dict) {
1545 // Set the thread stop info from the JSON dictionary
1546 SetThreadStopInfo(thread_dict);
1547 lldb::tid_t tid = LLDB_INVALID_THREAD_ID;
1548 if (thread_dict->GetValueForKeyAsInteger<lldb::tid_t>("tid", tid))
1549 m_thread_ids.push_back(tid);
1550 }
1551 return true; // Keep iterating through all thread_info objects
1552 });
1553 }
1554 if (!m_thread_ids.empty())
1555 return true;
1556 } else {
1557 // See if we can get the thread IDs from the current stop reply packets
1558 // that might contain a "threads" key/value pair
1559
1560 // Lock the thread stack while we access it
1561 // Mutex::Locker stop_stack_lock(m_last_stop_packet_mutex);
1562 std::unique_lock<std::recursive_mutex> stop_stack_lock(
1563 m_last_stop_packet_mutex, std::defer_lock);
1564 if (stop_stack_lock.try_lock()) {
1565 // Get the number of stop packets on the stack
1566 int nItems = m_stop_packet_stack.size();
1567 // Iterate over them
1568 for (int i = 0; i < nItems; i++) {
1569 // Get the thread stop info
1570 StringExtractorGDBRemote &stop_info = m_stop_packet_stack[i];
1571 const std::string &stop_info_str =
1572 std::string(stop_info.GetStringRef());
1573
1574 m_thread_pcs.clear();
1575 const size_t thread_pcs_pos = stop_info_str.find(";thread-pcs:");
1576 if (thread_pcs_pos != std::string::npos) {
1577 const size_t start = thread_pcs_pos + strlen(";thread-pcs:");
1578 const size_t end = stop_info_str.find(';', start);
1579 if (end != std::string::npos) {
1580 std::string value = stop_info_str.substr(start, end - start);
1581 UpdateThreadPCsFromStopReplyThreadsValue(value);
1582 }
1583 }
1584
1585 const size_t threads_pos = stop_info_str.find(";threads:");
1586 if (threads_pos != std::string::npos) {
1587 const size_t start = threads_pos + strlen(";threads:");
1588 const size_t end = stop_info_str.find(';', start);
1589 if (end != std::string::npos) {
1590 std::string value = stop_info_str.substr(start, end - start);
1591 if (UpdateThreadIDsFromStopReplyThreadsValue(value))
1592 return true;
1593 }
1594 }
1595 }
1596 }
1597 }
1598
1599 bool sequence_mutex_unavailable = false;
1600 m_gdb_comm.GetCurrentThreadIDs(m_thread_ids, sequence_mutex_unavailable);
1601 if (sequence_mutex_unavailable) {
1602 return false; // We just didn't get the list
1603 }
1604 return true;
1605 }
1606
DoUpdateThreadList(ThreadList & old_thread_list,ThreadList & new_thread_list)1607 bool ProcessGDBRemote::DoUpdateThreadList(ThreadList &old_thread_list,
1608 ThreadList &new_thread_list) {
1609 // locker will keep a mutex locked until it goes out of scope
1610 Log *log(ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_THREAD));
1611 LLDB_LOGV(log, "pid = {0}", GetID());
1612
1613 size_t num_thread_ids = m_thread_ids.size();
1614 // The "m_thread_ids" thread ID list should always be updated after each stop
1615 // reply packet, but in case it isn't, update it here.
1616 if (num_thread_ids == 0) {
1617 if (!UpdateThreadIDList())
1618 return false;
1619 num_thread_ids = m_thread_ids.size();
1620 }
1621
1622 ThreadList old_thread_list_copy(old_thread_list);
1623 if (num_thread_ids > 0) {
1624 for (size_t i = 0; i < num_thread_ids; ++i) {
1625 tid_t tid = m_thread_ids[i];
1626 ThreadSP thread_sp(
1627 old_thread_list_copy.RemoveThreadByProtocolID(tid, false));
1628 if (!thread_sp) {
1629 thread_sp = std::make_shared<ThreadGDBRemote>(*this, tid);
1630 LLDB_LOGV(log, "Making new thread: {0} for thread ID: {1:x}.",
1631 thread_sp.get(), thread_sp->GetID());
1632 } else {
1633 LLDB_LOGV(log, "Found old thread: {0} for thread ID: {1:x}.",
1634 thread_sp.get(), thread_sp->GetID());
1635 }
1636
1637 SetThreadPc(thread_sp, i);
1638 new_thread_list.AddThreadSortedByIndexID(thread_sp);
1639 }
1640 }
1641
1642 // Whatever that is left in old_thread_list_copy are not present in
1643 // new_thread_list. Remove non-existent threads from internal id table.
1644 size_t old_num_thread_ids = old_thread_list_copy.GetSize(false);
1645 for (size_t i = 0; i < old_num_thread_ids; i++) {
1646 ThreadSP old_thread_sp(old_thread_list_copy.GetThreadAtIndex(i, false));
1647 if (old_thread_sp) {
1648 lldb::tid_t old_thread_id = old_thread_sp->GetProtocolID();
1649 m_thread_id_to_index_id_map.erase(old_thread_id);
1650 }
1651 }
1652
1653 return true;
1654 }
1655
SetThreadPc(const ThreadSP & thread_sp,uint64_t index)1656 void ProcessGDBRemote::SetThreadPc(const ThreadSP &thread_sp, uint64_t index) {
1657 if (m_thread_ids.size() == m_thread_pcs.size() && thread_sp.get() &&
1658 GetByteOrder() != eByteOrderInvalid) {
1659 ThreadGDBRemote *gdb_thread =
1660 static_cast<ThreadGDBRemote *>(thread_sp.get());
1661 RegisterContextSP reg_ctx_sp(thread_sp->GetRegisterContext());
1662 if (reg_ctx_sp) {
1663 uint32_t pc_regnum = reg_ctx_sp->ConvertRegisterKindToRegisterNumber(
1664 eRegisterKindGeneric, LLDB_REGNUM_GENERIC_PC);
1665 if (pc_regnum != LLDB_INVALID_REGNUM) {
1666 gdb_thread->PrivateSetRegisterValue(pc_regnum, m_thread_pcs[index]);
1667 }
1668 }
1669 }
1670 }
1671
GetThreadStopInfoFromJSON(ThreadGDBRemote * thread,const StructuredData::ObjectSP & thread_infos_sp)1672 bool ProcessGDBRemote::GetThreadStopInfoFromJSON(
1673 ThreadGDBRemote *thread, const StructuredData::ObjectSP &thread_infos_sp) {
1674 // See if we got thread stop infos for all threads via the "jThreadsInfo"
1675 // packet
1676 if (thread_infos_sp) {
1677 StructuredData::Array *thread_infos = thread_infos_sp->GetAsArray();
1678 if (thread_infos) {
1679 lldb::tid_t tid;
1680 const size_t n = thread_infos->GetSize();
1681 for (size_t i = 0; i < n; ++i) {
1682 StructuredData::Dictionary *thread_dict =
1683 thread_infos->GetItemAtIndex(i)->GetAsDictionary();
1684 if (thread_dict) {
1685 if (thread_dict->GetValueForKeyAsInteger<lldb::tid_t>(
1686 "tid", tid, LLDB_INVALID_THREAD_ID)) {
1687 if (tid == thread->GetID())
1688 return (bool)SetThreadStopInfo(thread_dict);
1689 }
1690 }
1691 }
1692 }
1693 }
1694 return false;
1695 }
1696
CalculateThreadStopInfo(ThreadGDBRemote * thread)1697 bool ProcessGDBRemote::CalculateThreadStopInfo(ThreadGDBRemote *thread) {
1698 // See if we got thread stop infos for all threads via the "jThreadsInfo"
1699 // packet
1700 if (GetThreadStopInfoFromJSON(thread, m_jthreadsinfo_sp))
1701 return true;
1702
1703 // See if we got thread stop info for any threads valid stop info reasons
1704 // threads via the "jstopinfo" packet stop reply packet key/value pair?
1705 if (m_jstopinfo_sp) {
1706 // If we have "jstopinfo" then we have stop descriptions for all threads
1707 // that have stop reasons, and if there is no entry for a thread, then it
1708 // has no stop reason.
1709 thread->GetRegisterContext()->InvalidateIfNeeded(true);
1710 if (!GetThreadStopInfoFromJSON(thread, m_jstopinfo_sp)) {
1711 thread->SetStopInfo(StopInfoSP());
1712 }
1713 return true;
1714 }
1715
1716 // Fall back to using the qThreadStopInfo packet
1717 StringExtractorGDBRemote stop_packet;
1718 if (GetGDBRemote().GetThreadStopInfo(thread->GetProtocolID(), stop_packet))
1719 return SetThreadStopInfo(stop_packet) == eStateStopped;
1720 return false;
1721 }
1722
SetThreadStopInfo(lldb::tid_t tid,ExpeditedRegisterMap & expedited_register_map,uint8_t signo,const std::string & thread_name,const std::string & reason,const std::string & description,uint32_t exc_type,const std::vector<addr_t> & exc_data,addr_t thread_dispatch_qaddr,bool queue_vars_valid,LazyBool associated_with_dispatch_queue,addr_t dispatch_queue_t,std::string & queue_name,QueueKind queue_kind,uint64_t queue_serial)1723 ThreadSP ProcessGDBRemote::SetThreadStopInfo(
1724 lldb::tid_t tid, ExpeditedRegisterMap &expedited_register_map,
1725 uint8_t signo, const std::string &thread_name, const std::string &reason,
1726 const std::string &description, uint32_t exc_type,
1727 const std::vector<addr_t> &exc_data, addr_t thread_dispatch_qaddr,
1728 bool queue_vars_valid, // Set to true if queue_name, queue_kind and
1729 // queue_serial are valid
1730 LazyBool associated_with_dispatch_queue, addr_t dispatch_queue_t,
1731 std::string &queue_name, QueueKind queue_kind, uint64_t queue_serial) {
1732 ThreadSP thread_sp;
1733 if (tid != LLDB_INVALID_THREAD_ID) {
1734 // Scope for "locker" below
1735 {
1736 // m_thread_list_real does have its own mutex, but we need to hold onto
1737 // the mutex between the call to m_thread_list_real.FindThreadByID(...)
1738 // and the m_thread_list_real.AddThread(...) so it doesn't change on us
1739 std::lock_guard<std::recursive_mutex> guard(
1740 m_thread_list_real.GetMutex());
1741 thread_sp = m_thread_list_real.FindThreadByProtocolID(tid, false);
1742
1743 if (!thread_sp) {
1744 // Create the thread if we need to
1745 thread_sp = std::make_shared<ThreadGDBRemote>(*this, tid);
1746 m_thread_list_real.AddThread(thread_sp);
1747 }
1748 }
1749
1750 if (thread_sp) {
1751 ThreadGDBRemote *gdb_thread =
1752 static_cast<ThreadGDBRemote *>(thread_sp.get());
1753 RegisterContextSP gdb_reg_ctx_sp(gdb_thread->GetRegisterContext());
1754
1755 gdb_reg_ctx_sp->InvalidateIfNeeded(true);
1756
1757 auto iter = std::find(m_thread_ids.begin(), m_thread_ids.end(), tid);
1758 if (iter != m_thread_ids.end()) {
1759 SetThreadPc(thread_sp, iter - m_thread_ids.begin());
1760 }
1761
1762 for (const auto &pair : expedited_register_map) {
1763 StringExtractor reg_value_extractor(pair.second);
1764 DataBufferSP buffer_sp(new DataBufferHeap(
1765 reg_value_extractor.GetStringRef().size() / 2, 0));
1766 reg_value_extractor.GetHexBytes(buffer_sp->GetData(), '\xcc');
1767 uint32_t lldb_regnum =
1768 gdb_reg_ctx_sp->ConvertRegisterKindToRegisterNumber(
1769 eRegisterKindProcessPlugin, pair.first);
1770 gdb_thread->PrivateSetRegisterValue(lldb_regnum, buffer_sp->GetData());
1771 }
1772
1773 // AArch64 SVE specific code below calls AArch64SVEReconfigure to update
1774 // SVE register sizes and offsets if value of VG register has changed
1775 // since last stop.
1776 const ArchSpec &arch = GetTarget().GetArchitecture();
1777 if (arch.IsValid() && arch.GetTriple().isAArch64()) {
1778 GDBRemoteRegisterContext *reg_ctx_sp =
1779 static_cast<GDBRemoteRegisterContext *>(
1780 gdb_thread->GetRegisterContext().get());
1781
1782 if (reg_ctx_sp)
1783 reg_ctx_sp->AArch64SVEReconfigure();
1784 }
1785
1786 thread_sp->SetName(thread_name.empty() ? nullptr : thread_name.c_str());
1787
1788 gdb_thread->SetThreadDispatchQAddr(thread_dispatch_qaddr);
1789 // Check if the GDB server was able to provide the queue name, kind and
1790 // serial number
1791 if (queue_vars_valid)
1792 gdb_thread->SetQueueInfo(std::move(queue_name), queue_kind,
1793 queue_serial, dispatch_queue_t,
1794 associated_with_dispatch_queue);
1795 else
1796 gdb_thread->ClearQueueInfo();
1797
1798 gdb_thread->SetAssociatedWithLibdispatchQueue(
1799 associated_with_dispatch_queue);
1800
1801 if (dispatch_queue_t != LLDB_INVALID_ADDRESS)
1802 gdb_thread->SetQueueLibdispatchQueueAddress(dispatch_queue_t);
1803
1804 // Make sure we update our thread stop reason just once
1805 if (!thread_sp->StopInfoIsUpToDate()) {
1806 thread_sp->SetStopInfo(StopInfoSP());
1807 // If there's a memory thread backed by this thread, we need to use it
1808 // to calculate StopInfo.
1809 if (ThreadSP memory_thread_sp =
1810 m_thread_list.GetBackingThread(thread_sp))
1811 thread_sp = memory_thread_sp;
1812
1813 if (exc_type != 0) {
1814 const size_t exc_data_size = exc_data.size();
1815
1816 thread_sp->SetStopInfo(
1817 StopInfoMachException::CreateStopReasonWithMachException(
1818 *thread_sp, exc_type, exc_data_size,
1819 exc_data_size >= 1 ? exc_data[0] : 0,
1820 exc_data_size >= 2 ? exc_data[1] : 0,
1821 exc_data_size >= 3 ? exc_data[2] : 0));
1822 } else {
1823 bool handled = false;
1824 bool did_exec = false;
1825 if (!reason.empty()) {
1826 if (reason == "trace") {
1827 addr_t pc = thread_sp->GetRegisterContext()->GetPC();
1828 lldb::BreakpointSiteSP bp_site_sp = thread_sp->GetProcess()
1829 ->GetBreakpointSiteList()
1830 .FindByAddress(pc);
1831
1832 // If the current pc is a breakpoint site then the StopInfo
1833 // should be set to Breakpoint Otherwise, it will be set to
1834 // Trace.
1835 if (bp_site_sp && bp_site_sp->ValidForThisThread(*thread_sp)) {
1836 thread_sp->SetStopInfo(
1837 StopInfo::CreateStopReasonWithBreakpointSiteID(
1838 *thread_sp, bp_site_sp->GetID()));
1839 } else
1840 thread_sp->SetStopInfo(
1841 StopInfo::CreateStopReasonToTrace(*thread_sp));
1842 handled = true;
1843 } else if (reason == "breakpoint") {
1844 addr_t pc = thread_sp->GetRegisterContext()->GetPC();
1845 lldb::BreakpointSiteSP bp_site_sp = thread_sp->GetProcess()
1846 ->GetBreakpointSiteList()
1847 .FindByAddress(pc);
1848 if (bp_site_sp) {
1849 // If the breakpoint is for this thread, then we'll report the
1850 // hit, but if it is for another thread, we can just report no
1851 // reason. We don't need to worry about stepping over the
1852 // breakpoint here, that will be taken care of when the thread
1853 // resumes and notices that there's a breakpoint under the pc.
1854 handled = true;
1855 if (bp_site_sp->ValidForThisThread(*thread_sp)) {
1856 thread_sp->SetStopInfo(
1857 StopInfo::CreateStopReasonWithBreakpointSiteID(
1858 *thread_sp, bp_site_sp->GetID()));
1859 } else {
1860 StopInfoSP invalid_stop_info_sp;
1861 thread_sp->SetStopInfo(invalid_stop_info_sp);
1862 }
1863 }
1864 } else if (reason == "trap") {
1865 // Let the trap just use the standard signal stop reason below...
1866 } else if (reason == "watchpoint") {
1867 StringExtractor desc_extractor(description.c_str());
1868 addr_t wp_addr = desc_extractor.GetU64(LLDB_INVALID_ADDRESS);
1869 uint32_t wp_index = desc_extractor.GetU32(LLDB_INVALID_INDEX32);
1870 addr_t wp_hit_addr = desc_extractor.GetU64(LLDB_INVALID_ADDRESS);
1871 watch_id_t watch_id = LLDB_INVALID_WATCH_ID;
1872 if (wp_addr != LLDB_INVALID_ADDRESS) {
1873 WatchpointSP wp_sp;
1874 ArchSpec::Core core = GetTarget().GetArchitecture().GetCore();
1875 if ((core >= ArchSpec::kCore_mips_first &&
1876 core <= ArchSpec::kCore_mips_last) ||
1877 (core >= ArchSpec::eCore_arm_generic &&
1878 core <= ArchSpec::eCore_arm_aarch64))
1879 wp_sp = GetTarget().GetWatchpointList().FindByAddress(
1880 wp_hit_addr);
1881 if (!wp_sp)
1882 wp_sp =
1883 GetTarget().GetWatchpointList().FindByAddress(wp_addr);
1884 if (wp_sp) {
1885 wp_sp->SetHardwareIndex(wp_index);
1886 watch_id = wp_sp->GetID();
1887 }
1888 }
1889 if (watch_id == LLDB_INVALID_WATCH_ID) {
1890 Log *log(ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(
1891 GDBR_LOG_WATCHPOINTS));
1892 LLDB_LOGF(log, "failed to find watchpoint");
1893 }
1894 thread_sp->SetStopInfo(StopInfo::CreateStopReasonWithWatchpointID(
1895 *thread_sp, watch_id, wp_hit_addr));
1896 handled = true;
1897 } else if (reason == "exception") {
1898 thread_sp->SetStopInfo(StopInfo::CreateStopReasonWithException(
1899 *thread_sp, description.c_str()));
1900 handled = true;
1901 } else if (reason == "exec") {
1902 did_exec = true;
1903 thread_sp->SetStopInfo(
1904 StopInfo::CreateStopReasonWithExec(*thread_sp));
1905 handled = true;
1906 } else if (reason == "processor trace") {
1907 thread_sp->SetStopInfo(StopInfo::CreateStopReasonProcessorTrace(
1908 *thread_sp, description.c_str()));
1909 }
1910 } else if (!signo) {
1911 addr_t pc = thread_sp->GetRegisterContext()->GetPC();
1912 lldb::BreakpointSiteSP bp_site_sp =
1913 thread_sp->GetProcess()->GetBreakpointSiteList().FindByAddress(
1914 pc);
1915
1916 // If the current pc is a breakpoint site then the StopInfo should
1917 // be set to Breakpoint even though the remote stub did not set it
1918 // as such. This can happen when the thread is involuntarily
1919 // interrupted (e.g. due to stops on other threads) just as it is
1920 // about to execute the breakpoint instruction.
1921 if (bp_site_sp && bp_site_sp->ValidForThisThread(*thread_sp)) {
1922 thread_sp->SetStopInfo(
1923 StopInfo::CreateStopReasonWithBreakpointSiteID(
1924 *thread_sp, bp_site_sp->GetID()));
1925 handled = true;
1926 }
1927 }
1928
1929 if (!handled && signo && !did_exec) {
1930 if (signo == SIGTRAP) {
1931 // Currently we are going to assume SIGTRAP means we are either
1932 // hitting a breakpoint or hardware single stepping.
1933 handled = true;
1934 addr_t pc = thread_sp->GetRegisterContext()->GetPC() +
1935 m_breakpoint_pc_offset;
1936 lldb::BreakpointSiteSP bp_site_sp = thread_sp->GetProcess()
1937 ->GetBreakpointSiteList()
1938 .FindByAddress(pc);
1939
1940 if (bp_site_sp) {
1941 // If the breakpoint is for this thread, then we'll report the
1942 // hit, but if it is for another thread, we can just report no
1943 // reason. We don't need to worry about stepping over the
1944 // breakpoint here, that will be taken care of when the thread
1945 // resumes and notices that there's a breakpoint under the pc.
1946 if (bp_site_sp->ValidForThisThread(*thread_sp)) {
1947 if (m_breakpoint_pc_offset != 0)
1948 thread_sp->GetRegisterContext()->SetPC(pc);
1949 thread_sp->SetStopInfo(
1950 StopInfo::CreateStopReasonWithBreakpointSiteID(
1951 *thread_sp, bp_site_sp->GetID()));
1952 } else {
1953 StopInfoSP invalid_stop_info_sp;
1954 thread_sp->SetStopInfo(invalid_stop_info_sp);
1955 }
1956 } else {
1957 // If we were stepping then assume the stop was the result of
1958 // the trace. If we were not stepping then report the SIGTRAP.
1959 // FIXME: We are still missing the case where we single step
1960 // over a trap instruction.
1961 if (thread_sp->GetTemporaryResumeState() == eStateStepping)
1962 thread_sp->SetStopInfo(
1963 StopInfo::CreateStopReasonToTrace(*thread_sp));
1964 else
1965 thread_sp->SetStopInfo(StopInfo::CreateStopReasonWithSignal(
1966 *thread_sp, signo, description.c_str()));
1967 }
1968 }
1969 if (!handled)
1970 thread_sp->SetStopInfo(StopInfo::CreateStopReasonWithSignal(
1971 *thread_sp, signo, description.c_str()));
1972 }
1973
1974 if (!description.empty()) {
1975 lldb::StopInfoSP stop_info_sp(thread_sp->GetStopInfo());
1976 if (stop_info_sp) {
1977 const char *stop_info_desc = stop_info_sp->GetDescription();
1978 if (!stop_info_desc || !stop_info_desc[0])
1979 stop_info_sp->SetDescription(description.c_str());
1980 } else {
1981 thread_sp->SetStopInfo(StopInfo::CreateStopReasonWithException(
1982 *thread_sp, description.c_str()));
1983 }
1984 }
1985 }
1986 }
1987 }
1988 }
1989 return thread_sp;
1990 }
1991
1992 lldb::ThreadSP
SetThreadStopInfo(StructuredData::Dictionary * thread_dict)1993 ProcessGDBRemote::SetThreadStopInfo(StructuredData::Dictionary *thread_dict) {
1994 static ConstString g_key_tid("tid");
1995 static ConstString g_key_name("name");
1996 static ConstString g_key_reason("reason");
1997 static ConstString g_key_metype("metype");
1998 static ConstString g_key_medata("medata");
1999 static ConstString g_key_qaddr("qaddr");
2000 static ConstString g_key_dispatch_queue_t("dispatch_queue_t");
2001 static ConstString g_key_associated_with_dispatch_queue(
2002 "associated_with_dispatch_queue");
2003 static ConstString g_key_queue_name("qname");
2004 static ConstString g_key_queue_kind("qkind");
2005 static ConstString g_key_queue_serial_number("qserialnum");
2006 static ConstString g_key_registers("registers");
2007 static ConstString g_key_memory("memory");
2008 static ConstString g_key_address("address");
2009 static ConstString g_key_bytes("bytes");
2010 static ConstString g_key_description("description");
2011 static ConstString g_key_signal("signal");
2012
2013 // Stop with signal and thread info
2014 lldb::tid_t tid = LLDB_INVALID_THREAD_ID;
2015 uint8_t signo = 0;
2016 std::string value;
2017 std::string thread_name;
2018 std::string reason;
2019 std::string description;
2020 uint32_t exc_type = 0;
2021 std::vector<addr_t> exc_data;
2022 addr_t thread_dispatch_qaddr = LLDB_INVALID_ADDRESS;
2023 ExpeditedRegisterMap expedited_register_map;
2024 bool queue_vars_valid = false;
2025 addr_t dispatch_queue_t = LLDB_INVALID_ADDRESS;
2026 LazyBool associated_with_dispatch_queue = eLazyBoolCalculate;
2027 std::string queue_name;
2028 QueueKind queue_kind = eQueueKindUnknown;
2029 uint64_t queue_serial_number = 0;
2030 // Iterate through all of the thread dictionary key/value pairs from the
2031 // structured data dictionary
2032
2033 thread_dict->ForEach([this, &tid, &expedited_register_map, &thread_name,
2034 &signo, &reason, &description, &exc_type, &exc_data,
2035 &thread_dispatch_qaddr, &queue_vars_valid,
2036 &associated_with_dispatch_queue, &dispatch_queue_t,
2037 &queue_name, &queue_kind, &queue_serial_number](
2038 ConstString key,
2039 StructuredData::Object *object) -> bool {
2040 if (key == g_key_tid) {
2041 // thread in big endian hex
2042 tid = object->GetIntegerValue(LLDB_INVALID_THREAD_ID);
2043 } else if (key == g_key_metype) {
2044 // exception type in big endian hex
2045 exc_type = object->GetIntegerValue(0);
2046 } else if (key == g_key_medata) {
2047 // exception data in big endian hex
2048 StructuredData::Array *array = object->GetAsArray();
2049 if (array) {
2050 array->ForEach([&exc_data](StructuredData::Object *object) -> bool {
2051 exc_data.push_back(object->GetIntegerValue());
2052 return true; // Keep iterating through all array items
2053 });
2054 }
2055 } else if (key == g_key_name) {
2056 thread_name = std::string(object->GetStringValue());
2057 } else if (key == g_key_qaddr) {
2058 thread_dispatch_qaddr = object->GetIntegerValue(LLDB_INVALID_ADDRESS);
2059 } else if (key == g_key_queue_name) {
2060 queue_vars_valid = true;
2061 queue_name = std::string(object->GetStringValue());
2062 } else if (key == g_key_queue_kind) {
2063 std::string queue_kind_str = std::string(object->GetStringValue());
2064 if (queue_kind_str == "serial") {
2065 queue_vars_valid = true;
2066 queue_kind = eQueueKindSerial;
2067 } else if (queue_kind_str == "concurrent") {
2068 queue_vars_valid = true;
2069 queue_kind = eQueueKindConcurrent;
2070 }
2071 } else if (key == g_key_queue_serial_number) {
2072 queue_serial_number = object->GetIntegerValue(0);
2073 if (queue_serial_number != 0)
2074 queue_vars_valid = true;
2075 } else if (key == g_key_dispatch_queue_t) {
2076 dispatch_queue_t = object->GetIntegerValue(0);
2077 if (dispatch_queue_t != 0 && dispatch_queue_t != LLDB_INVALID_ADDRESS)
2078 queue_vars_valid = true;
2079 } else if (key == g_key_associated_with_dispatch_queue) {
2080 queue_vars_valid = true;
2081 bool associated = object->GetBooleanValue();
2082 if (associated)
2083 associated_with_dispatch_queue = eLazyBoolYes;
2084 else
2085 associated_with_dispatch_queue = eLazyBoolNo;
2086 } else if (key == g_key_reason) {
2087 reason = std::string(object->GetStringValue());
2088 } else if (key == g_key_description) {
2089 description = std::string(object->GetStringValue());
2090 } else if (key == g_key_registers) {
2091 StructuredData::Dictionary *registers_dict = object->GetAsDictionary();
2092
2093 if (registers_dict) {
2094 registers_dict->ForEach(
2095 [&expedited_register_map](ConstString key,
2096 StructuredData::Object *object) -> bool {
2097 const uint32_t reg =
2098 StringConvert::ToUInt32(key.GetCString(), UINT32_MAX, 10);
2099 if (reg != UINT32_MAX)
2100 expedited_register_map[reg] =
2101 std::string(object->GetStringValue());
2102 return true; // Keep iterating through all array items
2103 });
2104 }
2105 } else if (key == g_key_memory) {
2106 StructuredData::Array *array = object->GetAsArray();
2107 if (array) {
2108 array->ForEach([this](StructuredData::Object *object) -> bool {
2109 StructuredData::Dictionary *mem_cache_dict =
2110 object->GetAsDictionary();
2111 if (mem_cache_dict) {
2112 lldb::addr_t mem_cache_addr = LLDB_INVALID_ADDRESS;
2113 if (mem_cache_dict->GetValueForKeyAsInteger<lldb::addr_t>(
2114 "address", mem_cache_addr)) {
2115 if (mem_cache_addr != LLDB_INVALID_ADDRESS) {
2116 llvm::StringRef str;
2117 if (mem_cache_dict->GetValueForKeyAsString("bytes", str)) {
2118 StringExtractor bytes(str);
2119 bytes.SetFilePos(0);
2120
2121 const size_t byte_size = bytes.GetStringRef().size() / 2;
2122 DataBufferSP data_buffer_sp(new DataBufferHeap(byte_size, 0));
2123 const size_t bytes_copied =
2124 bytes.GetHexBytes(data_buffer_sp->GetData(), 0);
2125 if (bytes_copied == byte_size)
2126 m_memory_cache.AddL1CacheData(mem_cache_addr,
2127 data_buffer_sp);
2128 }
2129 }
2130 }
2131 }
2132 return true; // Keep iterating through all array items
2133 });
2134 }
2135
2136 } else if (key == g_key_signal)
2137 signo = object->GetIntegerValue(LLDB_INVALID_SIGNAL_NUMBER);
2138 return true; // Keep iterating through all dictionary key/value pairs
2139 });
2140
2141 return SetThreadStopInfo(tid, expedited_register_map, signo, thread_name,
2142 reason, description, exc_type, exc_data,
2143 thread_dispatch_qaddr, queue_vars_valid,
2144 associated_with_dispatch_queue, dispatch_queue_t,
2145 queue_name, queue_kind, queue_serial_number);
2146 }
2147
SetThreadStopInfo(StringExtractor & stop_packet)2148 StateType ProcessGDBRemote::SetThreadStopInfo(StringExtractor &stop_packet) {
2149 lldb::pid_t pid = m_gdb_comm.GetCurrentProcessID();
2150 stop_packet.SetFilePos(0);
2151 const char stop_type = stop_packet.GetChar();
2152 switch (stop_type) {
2153 case 'T':
2154 case 'S': {
2155 // This is a bit of a hack, but is is required. If we did exec, we need to
2156 // clear our thread lists and also know to rebuild our dynamic register
2157 // info before we lookup and threads and populate the expedited register
2158 // values so we need to know this right away so we can cleanup and update
2159 // our registers.
2160 const uint32_t stop_id = GetStopID();
2161 if (stop_id == 0) {
2162 // Our first stop, make sure we have a process ID, and also make sure we
2163 // know about our registers
2164 if (GetID() == LLDB_INVALID_PROCESS_ID && pid != LLDB_INVALID_PROCESS_ID)
2165 SetID(pid);
2166 BuildDynamicRegisterInfo(true);
2167 }
2168 // Stop with signal and thread info
2169 lldb::pid_t stop_pid = LLDB_INVALID_PROCESS_ID;
2170 lldb::tid_t tid = LLDB_INVALID_THREAD_ID;
2171 const uint8_t signo = stop_packet.GetHexU8();
2172 llvm::StringRef key;
2173 llvm::StringRef value;
2174 std::string thread_name;
2175 std::string reason;
2176 std::string description;
2177 uint32_t exc_type = 0;
2178 std::vector<addr_t> exc_data;
2179 addr_t thread_dispatch_qaddr = LLDB_INVALID_ADDRESS;
2180 bool queue_vars_valid =
2181 false; // says if locals below that start with "queue_" are valid
2182 addr_t dispatch_queue_t = LLDB_INVALID_ADDRESS;
2183 LazyBool associated_with_dispatch_queue = eLazyBoolCalculate;
2184 std::string queue_name;
2185 QueueKind queue_kind = eQueueKindUnknown;
2186 uint64_t queue_serial_number = 0;
2187 ExpeditedRegisterMap expedited_register_map;
2188 while (stop_packet.GetNameColonValue(key, value)) {
2189 if (key.compare("metype") == 0) {
2190 // exception type in big endian hex
2191 value.getAsInteger(16, exc_type);
2192 } else if (key.compare("medata") == 0) {
2193 // exception data in big endian hex
2194 uint64_t x;
2195 value.getAsInteger(16, x);
2196 exc_data.push_back(x);
2197 } else if (key.compare("thread") == 0) {
2198 // thread-id
2199 StringExtractorGDBRemote thread_id{value};
2200 auto pid_tid = thread_id.GetPidTid(pid);
2201 if (pid_tid) {
2202 stop_pid = pid_tid->first;
2203 tid = pid_tid->second;
2204 } else
2205 tid = LLDB_INVALID_THREAD_ID;
2206 } else if (key.compare("threads") == 0) {
2207 std::lock_guard<std::recursive_mutex> guard(
2208 m_thread_list_real.GetMutex());
2209 UpdateThreadIDsFromStopReplyThreadsValue(value);
2210 } else if (key.compare("thread-pcs") == 0) {
2211 m_thread_pcs.clear();
2212 // A comma separated list of all threads in the current
2213 // process that includes the thread for this stop reply packet
2214 lldb::addr_t pc;
2215 while (!value.empty()) {
2216 llvm::StringRef pc_str;
2217 std::tie(pc_str, value) = value.split(',');
2218 if (pc_str.getAsInteger(16, pc))
2219 pc = LLDB_INVALID_ADDRESS;
2220 m_thread_pcs.push_back(pc);
2221 }
2222 } else if (key.compare("jstopinfo") == 0) {
2223 StringExtractor json_extractor(value);
2224 std::string json;
2225 // Now convert the HEX bytes into a string value
2226 json_extractor.GetHexByteString(json);
2227
2228 // This JSON contains thread IDs and thread stop info for all threads.
2229 // It doesn't contain expedited registers, memory or queue info.
2230 m_jstopinfo_sp = StructuredData::ParseJSON(json);
2231 } else if (key.compare("hexname") == 0) {
2232 StringExtractor name_extractor(value);
2233 std::string name;
2234 // Now convert the HEX bytes into a string value
2235 name_extractor.GetHexByteString(thread_name);
2236 } else if (key.compare("name") == 0) {
2237 thread_name = std::string(value);
2238 } else if (key.compare("qaddr") == 0) {
2239 value.getAsInteger(16, thread_dispatch_qaddr);
2240 } else if (key.compare("dispatch_queue_t") == 0) {
2241 queue_vars_valid = true;
2242 value.getAsInteger(16, dispatch_queue_t);
2243 } else if (key.compare("qname") == 0) {
2244 queue_vars_valid = true;
2245 StringExtractor name_extractor(value);
2246 // Now convert the HEX bytes into a string value
2247 name_extractor.GetHexByteString(queue_name);
2248 } else if (key.compare("qkind") == 0) {
2249 queue_kind = llvm::StringSwitch<QueueKind>(value)
2250 .Case("serial", eQueueKindSerial)
2251 .Case("concurrent", eQueueKindConcurrent)
2252 .Default(eQueueKindUnknown);
2253 queue_vars_valid = queue_kind != eQueueKindUnknown;
2254 } else if (key.compare("qserialnum") == 0) {
2255 if (!value.getAsInteger(0, queue_serial_number))
2256 queue_vars_valid = true;
2257 } else if (key.compare("reason") == 0) {
2258 reason = std::string(value);
2259 } else if (key.compare("description") == 0) {
2260 StringExtractor desc_extractor(value);
2261 // Now convert the HEX bytes into a string value
2262 desc_extractor.GetHexByteString(description);
2263 } else if (key.compare("memory") == 0) {
2264 // Expedited memory. GDB servers can choose to send back expedited
2265 // memory that can populate the L1 memory cache in the process so that
2266 // things like the frame pointer backchain can be expedited. This will
2267 // help stack backtracing be more efficient by not having to send as
2268 // many memory read requests down the remote GDB server.
2269
2270 // Key/value pair format: memory:<addr>=<bytes>;
2271 // <addr> is a number whose base will be interpreted by the prefix:
2272 // "0x[0-9a-fA-F]+" for hex
2273 // "0[0-7]+" for octal
2274 // "[1-9]+" for decimal
2275 // <bytes> is native endian ASCII hex bytes just like the register
2276 // values
2277 llvm::StringRef addr_str, bytes_str;
2278 std::tie(addr_str, bytes_str) = value.split('=');
2279 if (!addr_str.empty() && !bytes_str.empty()) {
2280 lldb::addr_t mem_cache_addr = LLDB_INVALID_ADDRESS;
2281 if (!addr_str.getAsInteger(0, mem_cache_addr)) {
2282 StringExtractor bytes(bytes_str);
2283 const size_t byte_size = bytes.GetBytesLeft() / 2;
2284 DataBufferSP data_buffer_sp(new DataBufferHeap(byte_size, 0));
2285 const size_t bytes_copied =
2286 bytes.GetHexBytes(data_buffer_sp->GetData(), 0);
2287 if (bytes_copied == byte_size)
2288 m_memory_cache.AddL1CacheData(mem_cache_addr, data_buffer_sp);
2289 }
2290 }
2291 } else if (key.compare("watch") == 0 || key.compare("rwatch") == 0 ||
2292 key.compare("awatch") == 0) {
2293 // Support standard GDB remote stop reply packet 'TAAwatch:addr'
2294 lldb::addr_t wp_addr = LLDB_INVALID_ADDRESS;
2295 value.getAsInteger(16, wp_addr);
2296
2297 WatchpointSP wp_sp =
2298 GetTarget().GetWatchpointList().FindByAddress(wp_addr);
2299 uint32_t wp_index = LLDB_INVALID_INDEX32;
2300
2301 if (wp_sp)
2302 wp_index = wp_sp->GetHardwareIndex();
2303
2304 reason = "watchpoint";
2305 StreamString ostr;
2306 ostr.Printf("%" PRIu64 " %" PRIu32, wp_addr, wp_index);
2307 description = std::string(ostr.GetString());
2308 } else if (key.compare("library") == 0) {
2309 auto error = LoadModules();
2310 if (error) {
2311 Log *log(
2312 ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
2313 LLDB_LOG_ERROR(log, std::move(error), "Failed to load modules: {0}");
2314 }
2315 } else if (key.size() == 2 && ::isxdigit(key[0]) && ::isxdigit(key[1])) {
2316 uint32_t reg = UINT32_MAX;
2317 if (!key.getAsInteger(16, reg))
2318 expedited_register_map[reg] = std::string(std::move(value));
2319 }
2320 }
2321
2322 if (stop_pid != LLDB_INVALID_PROCESS_ID && stop_pid != pid) {
2323 Log *log(ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
2324 LLDB_LOG(log,
2325 "Received stop for incorrect PID = {0} (inferior PID = {1})",
2326 stop_pid, pid);
2327 return eStateInvalid;
2328 }
2329
2330 if (tid == LLDB_INVALID_THREAD_ID) {
2331 // A thread id may be invalid if the response is old style 'S' packet
2332 // which does not provide the
2333 // thread information. So update the thread list and choose the first
2334 // one.
2335 UpdateThreadIDList();
2336
2337 if (!m_thread_ids.empty()) {
2338 tid = m_thread_ids.front();
2339 }
2340 }
2341
2342 ThreadSP thread_sp = SetThreadStopInfo(
2343 tid, expedited_register_map, signo, thread_name, reason, description,
2344 exc_type, exc_data, thread_dispatch_qaddr, queue_vars_valid,
2345 associated_with_dispatch_queue, dispatch_queue_t, queue_name,
2346 queue_kind, queue_serial_number);
2347
2348 return eStateStopped;
2349 } break;
2350
2351 case 'W':
2352 case 'X':
2353 // process exited
2354 return eStateExited;
2355
2356 default:
2357 break;
2358 }
2359 return eStateInvalid;
2360 }
2361
RefreshStateAfterStop()2362 void ProcessGDBRemote::RefreshStateAfterStop() {
2363 std::lock_guard<std::recursive_mutex> guard(m_thread_list_real.GetMutex());
2364
2365 m_thread_ids.clear();
2366 m_thread_pcs.clear();
2367
2368 // Set the thread stop info. It might have a "threads" key whose value is a
2369 // list of all thread IDs in the current process, so m_thread_ids might get
2370 // set.
2371 // Check to see if SetThreadStopInfo() filled in m_thread_ids?
2372 if (m_thread_ids.empty()) {
2373 // No, we need to fetch the thread list manually
2374 UpdateThreadIDList();
2375 }
2376
2377 // We might set some stop info's so make sure the thread list is up to
2378 // date before we do that or we might overwrite what was computed here.
2379 UpdateThreadListIfNeeded();
2380
2381 // Scope for the lock
2382 {
2383 // Lock the thread stack while we access it
2384 std::lock_guard<std::recursive_mutex> guard(m_last_stop_packet_mutex);
2385 // Get the number of stop packets on the stack
2386 int nItems = m_stop_packet_stack.size();
2387 // Iterate over them
2388 for (int i = 0; i < nItems; i++) {
2389 // Get the thread stop info
2390 StringExtractorGDBRemote stop_info = m_stop_packet_stack[i];
2391 // Process thread stop info
2392 SetThreadStopInfo(stop_info);
2393 }
2394 // Clear the thread stop stack
2395 m_stop_packet_stack.clear();
2396 }
2397
2398 // If we have queried for a default thread id
2399 if (m_initial_tid != LLDB_INVALID_THREAD_ID) {
2400 m_thread_list.SetSelectedThreadByID(m_initial_tid);
2401 m_initial_tid = LLDB_INVALID_THREAD_ID;
2402 }
2403
2404 // Let all threads recover from stopping and do any clean up based on the
2405 // previous thread state (if any).
2406 m_thread_list_real.RefreshStateAfterStop();
2407 }
2408
DoHalt(bool & caused_stop)2409 Status ProcessGDBRemote::DoHalt(bool &caused_stop) {
2410 Status error;
2411
2412 if (m_public_state.GetValue() == eStateAttaching) {
2413 // We are being asked to halt during an attach. We need to just close our
2414 // file handle and debugserver will go away, and we can be done...
2415 m_gdb_comm.Disconnect();
2416 } else
2417 caused_stop = m_gdb_comm.Interrupt(GetInterruptTimeout());
2418 return error;
2419 }
2420
DoDetach(bool keep_stopped)2421 Status ProcessGDBRemote::DoDetach(bool keep_stopped) {
2422 Status error;
2423 Log *log(ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
2424 LLDB_LOGF(log, "ProcessGDBRemote::DoDetach(keep_stopped: %i)", keep_stopped);
2425
2426 error = m_gdb_comm.Detach(keep_stopped);
2427 if (log) {
2428 if (error.Success())
2429 log->PutCString(
2430 "ProcessGDBRemote::DoDetach() detach packet sent successfully");
2431 else
2432 LLDB_LOGF(log,
2433 "ProcessGDBRemote::DoDetach() detach packet send failed: %s",
2434 error.AsCString() ? error.AsCString() : "<unknown error>");
2435 }
2436
2437 if (!error.Success())
2438 return error;
2439
2440 // Sleep for one second to let the process get all detached...
2441 StopAsyncThread();
2442
2443 SetPrivateState(eStateDetached);
2444 ResumePrivateStateThread();
2445
2446 // KillDebugserverProcess ();
2447 return error;
2448 }
2449
DoDestroy()2450 Status ProcessGDBRemote::DoDestroy() {
2451 Status error;
2452 Log *log(ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
2453 LLDB_LOGF(log, "ProcessGDBRemote::DoDestroy()");
2454
2455 // There is a bug in older iOS debugservers where they don't shut down the
2456 // process they are debugging properly. If the process is sitting at a
2457 // breakpoint or an exception, this can cause problems with restarting. So
2458 // we check to see if any of our threads are stopped at a breakpoint, and if
2459 // so we remove all the breakpoints, resume the process, and THEN destroy it
2460 // again.
2461 //
2462 // Note, we don't have a good way to test the version of debugserver, but I
2463 // happen to know that the set of all the iOS debugservers which don't
2464 // support GetThreadSuffixSupported() and that of the debugservers with this
2465 // bug are equal. There really should be a better way to test this!
2466 //
2467 // We also use m_destroy_tried_resuming to make sure we only do this once, if
2468 // we resume and then halt and get called here to destroy again and we're
2469 // still at a breakpoint or exception, then we should just do the straight-
2470 // forward kill.
2471 //
2472 // And of course, if we weren't able to stop the process by the time we get
2473 // here, it isn't necessary (or helpful) to do any of this.
2474
2475 if (!m_gdb_comm.GetThreadSuffixSupported() &&
2476 m_public_state.GetValue() != eStateRunning) {
2477 PlatformSP platform_sp = GetTarget().GetPlatform();
2478
2479 // FIXME: These should be ConstStrings so we aren't doing strcmp'ing.
2480 if (platform_sp && platform_sp->GetName() &&
2481 platform_sp->GetName() == PlatformRemoteiOS::GetPluginNameStatic()) {
2482 if (m_destroy_tried_resuming) {
2483 if (log)
2484 log->PutCString("ProcessGDBRemote::DoDestroy() - Tried resuming to "
2485 "destroy once already, not doing it again.");
2486 } else {
2487 // At present, the plans are discarded and the breakpoints disabled
2488 // Process::Destroy, but we really need it to happen here and it
2489 // doesn't matter if we do it twice.
2490 m_thread_list.DiscardThreadPlans();
2491 DisableAllBreakpointSites();
2492
2493 bool stop_looks_like_crash = false;
2494 ThreadList &threads = GetThreadList();
2495
2496 {
2497 std::lock_guard<std::recursive_mutex> guard(threads.GetMutex());
2498
2499 size_t num_threads = threads.GetSize();
2500 for (size_t i = 0; i < num_threads; i++) {
2501 ThreadSP thread_sp = threads.GetThreadAtIndex(i);
2502 StopInfoSP stop_info_sp = thread_sp->GetPrivateStopInfo();
2503 StopReason reason = eStopReasonInvalid;
2504 if (stop_info_sp)
2505 reason = stop_info_sp->GetStopReason();
2506 if (reason == eStopReasonBreakpoint ||
2507 reason == eStopReasonException) {
2508 LLDB_LOGF(log,
2509 "ProcessGDBRemote::DoDestroy() - thread: 0x%4.4" PRIx64
2510 " stopped with reason: %s.",
2511 thread_sp->GetProtocolID(),
2512 stop_info_sp->GetDescription());
2513 stop_looks_like_crash = true;
2514 break;
2515 }
2516 }
2517 }
2518
2519 if (stop_looks_like_crash) {
2520 if (log)
2521 log->PutCString("ProcessGDBRemote::DoDestroy() - Stopped at a "
2522 "breakpoint, continue and then kill.");
2523 m_destroy_tried_resuming = true;
2524
2525 // If we are going to run again before killing, it would be good to
2526 // suspend all the threads before resuming so they won't get into
2527 // more trouble. Sadly, for the threads stopped with the breakpoint
2528 // or exception, the exception doesn't get cleared if it is
2529 // suspended, so we do have to run the risk of letting those threads
2530 // proceed a bit.
2531
2532 {
2533 std::lock_guard<std::recursive_mutex> guard(threads.GetMutex());
2534
2535 size_t num_threads = threads.GetSize();
2536 for (size_t i = 0; i < num_threads; i++) {
2537 ThreadSP thread_sp = threads.GetThreadAtIndex(i);
2538 StopInfoSP stop_info_sp = thread_sp->GetPrivateStopInfo();
2539 StopReason reason = eStopReasonInvalid;
2540 if (stop_info_sp)
2541 reason = stop_info_sp->GetStopReason();
2542 if (reason != eStopReasonBreakpoint &&
2543 reason != eStopReasonException) {
2544 LLDB_LOGF(log,
2545 "ProcessGDBRemote::DoDestroy() - Suspending "
2546 "thread: 0x%4.4" PRIx64 " before running.",
2547 thread_sp->GetProtocolID());
2548 thread_sp->SetResumeState(eStateSuspended);
2549 }
2550 }
2551 }
2552 Resume();
2553 return Destroy(false);
2554 }
2555 }
2556 }
2557 }
2558
2559 // Interrupt if our inferior is running...
2560 int exit_status = SIGABRT;
2561 std::string exit_string;
2562
2563 if (m_gdb_comm.IsConnected()) {
2564 if (m_public_state.GetValue() != eStateAttaching) {
2565 StringExtractorGDBRemote response;
2566 GDBRemoteCommunication::ScopedTimeout(m_gdb_comm,
2567 std::chrono::seconds(3));
2568
2569 if (m_gdb_comm.SendPacketAndWaitForResponse("k", response,
2570 GetInterruptTimeout()) ==
2571 GDBRemoteCommunication::PacketResult::Success) {
2572 char packet_cmd = response.GetChar(0);
2573
2574 if (packet_cmd == 'W' || packet_cmd == 'X') {
2575 #if defined(__APPLE__)
2576 // For Native processes on Mac OS X, we launch through the Host
2577 // Platform, then hand the process off to debugserver, which becomes
2578 // the parent process through "PT_ATTACH". Then when we go to kill
2579 // the process on Mac OS X we call ptrace(PT_KILL) to kill it, then
2580 // we call waitpid which returns with no error and the correct
2581 // status. But amusingly enough that doesn't seem to actually reap
2582 // the process, but instead it is left around as a Zombie. Probably
2583 // the kernel is in the process of switching ownership back to lldb
2584 // which was the original parent, and gets confused in the handoff.
2585 // Anyway, so call waitpid here to finally reap it.
2586 PlatformSP platform_sp(GetTarget().GetPlatform());
2587 if (platform_sp && platform_sp->IsHost()) {
2588 int status;
2589 ::pid_t reap_pid;
2590 reap_pid = waitpid(GetID(), &status, WNOHANG);
2591 LLDB_LOGF(log, "Reaped pid: %d, status: %d.\n", reap_pid, status);
2592 }
2593 #endif
2594 SetLastStopPacket(response);
2595 ClearThreadIDList();
2596 exit_status = response.GetHexU8();
2597 } else {
2598 LLDB_LOGF(log,
2599 "ProcessGDBRemote::DoDestroy - got unexpected response "
2600 "to k packet: %s",
2601 response.GetStringRef().data());
2602 exit_string.assign("got unexpected response to k packet: ");
2603 exit_string.append(std::string(response.GetStringRef()));
2604 }
2605 } else {
2606 LLDB_LOGF(log, "ProcessGDBRemote::DoDestroy - failed to send k packet");
2607 exit_string.assign("failed to send the k packet");
2608 }
2609 } else {
2610 LLDB_LOGF(log,
2611 "ProcessGDBRemote::DoDestroy - killed or interrupted while "
2612 "attaching");
2613 exit_string.assign("killed or interrupted while attaching.");
2614 }
2615 } else {
2616 // If we missed setting the exit status on the way out, do it here.
2617 // NB set exit status can be called multiple times, the first one sets the
2618 // status.
2619 exit_string.assign("destroying when not connected to debugserver");
2620 }
2621
2622 SetExitStatus(exit_status, exit_string.c_str());
2623
2624 StopAsyncThread();
2625 KillDebugserverProcess();
2626 return error;
2627 }
2628
SetLastStopPacket(const StringExtractorGDBRemote & response)2629 void ProcessGDBRemote::SetLastStopPacket(
2630 const StringExtractorGDBRemote &response) {
2631 const bool did_exec =
2632 response.GetStringRef().find(";reason:exec;") != std::string::npos;
2633 if (did_exec) {
2634 Log *log(ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
2635 LLDB_LOGF(log, "ProcessGDBRemote::SetLastStopPacket () - detected exec");
2636
2637 m_thread_list_real.Clear();
2638 m_thread_list.Clear();
2639 BuildDynamicRegisterInfo(true);
2640 m_gdb_comm.ResetDiscoverableSettings(did_exec);
2641 }
2642
2643 // Scope the lock
2644 {
2645 // Lock the thread stack while we access it
2646 std::lock_guard<std::recursive_mutex> guard(m_last_stop_packet_mutex);
2647
2648 // We are are not using non-stop mode, there can only be one last stop
2649 // reply packet, so clear the list.
2650 if (!GetTarget().GetNonStopModeEnabled())
2651 m_stop_packet_stack.clear();
2652
2653 // Add this stop packet to the stop packet stack This stack will get popped
2654 // and examined when we switch to the Stopped state
2655 m_stop_packet_stack.push_back(response);
2656 }
2657 }
2658
SetUnixSignals(const UnixSignalsSP & signals_sp)2659 void ProcessGDBRemote::SetUnixSignals(const UnixSignalsSP &signals_sp) {
2660 Process::SetUnixSignals(std::make_shared<GDBRemoteSignals>(signals_sp));
2661 }
2662
2663 // Process Queries
2664
IsAlive()2665 bool ProcessGDBRemote::IsAlive() {
2666 return m_gdb_comm.IsConnected() && Process::IsAlive();
2667 }
2668
GetImageInfoAddress()2669 addr_t ProcessGDBRemote::GetImageInfoAddress() {
2670 // request the link map address via the $qShlibInfoAddr packet
2671 lldb::addr_t addr = m_gdb_comm.GetShlibInfoAddr();
2672
2673 // the loaded module list can also provides a link map address
2674 if (addr == LLDB_INVALID_ADDRESS) {
2675 llvm::Expected<LoadedModuleInfoList> list = GetLoadedModuleList();
2676 if (!list) {
2677 Log *log(ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
2678 LLDB_LOG_ERROR(log, list.takeError(), "Failed to read module list: {0}.");
2679 } else {
2680 addr = list->m_link_map;
2681 }
2682 }
2683
2684 return addr;
2685 }
2686
WillPublicStop()2687 void ProcessGDBRemote::WillPublicStop() {
2688 // See if the GDB remote client supports the JSON threads info. If so, we
2689 // gather stop info for all threads, expedited registers, expedited memory,
2690 // runtime queue information (iOS and MacOSX only), and more. Expediting
2691 // memory will help stack backtracing be much faster. Expediting registers
2692 // will make sure we don't have to read the thread registers for GPRs.
2693 m_jthreadsinfo_sp = m_gdb_comm.GetThreadsInfo();
2694
2695 if (m_jthreadsinfo_sp) {
2696 // Now set the stop info for each thread and also expedite any registers
2697 // and memory that was in the jThreadsInfo response.
2698 StructuredData::Array *thread_infos = m_jthreadsinfo_sp->GetAsArray();
2699 if (thread_infos) {
2700 const size_t n = thread_infos->GetSize();
2701 for (size_t i = 0; i < n; ++i) {
2702 StructuredData::Dictionary *thread_dict =
2703 thread_infos->GetItemAtIndex(i)->GetAsDictionary();
2704 if (thread_dict)
2705 SetThreadStopInfo(thread_dict);
2706 }
2707 }
2708 }
2709 }
2710
2711 // Process Memory
DoReadMemory(addr_t addr,void * buf,size_t size,Status & error)2712 size_t ProcessGDBRemote::DoReadMemory(addr_t addr, void *buf, size_t size,
2713 Status &error) {
2714 GetMaxMemorySize();
2715 bool binary_memory_read = m_gdb_comm.GetxPacketSupported();
2716 // M and m packets take 2 bytes for 1 byte of memory
2717 size_t max_memory_size =
2718 binary_memory_read ? m_max_memory_size : m_max_memory_size / 2;
2719 if (size > max_memory_size) {
2720 // Keep memory read sizes down to a sane limit. This function will be
2721 // called multiple times in order to complete the task by
2722 // lldb_private::Process so it is ok to do this.
2723 size = max_memory_size;
2724 }
2725
2726 char packet[64];
2727 int packet_len;
2728 packet_len = ::snprintf(packet, sizeof(packet), "%c%" PRIx64 ",%" PRIx64,
2729 binary_memory_read ? 'x' : 'm', (uint64_t)addr,
2730 (uint64_t)size);
2731 assert(packet_len + 1 < (int)sizeof(packet));
2732 UNUSED_IF_ASSERT_DISABLED(packet_len);
2733 StringExtractorGDBRemote response;
2734 if (m_gdb_comm.SendPacketAndWaitForResponse(packet, response,
2735 GetInterruptTimeout()) ==
2736 GDBRemoteCommunication::PacketResult::Success) {
2737 if (response.IsNormalResponse()) {
2738 error.Clear();
2739 if (binary_memory_read) {
2740 // The lower level GDBRemoteCommunication packet receive layer has
2741 // already de-quoted any 0x7d character escaping that was present in
2742 // the packet
2743
2744 size_t data_received_size = response.GetBytesLeft();
2745 if (data_received_size > size) {
2746 // Don't write past the end of BUF if the remote debug server gave us
2747 // too much data for some reason.
2748 data_received_size = size;
2749 }
2750 memcpy(buf, response.GetStringRef().data(), data_received_size);
2751 return data_received_size;
2752 } else {
2753 return response.GetHexBytes(
2754 llvm::MutableArrayRef<uint8_t>((uint8_t *)buf, size), '\xdd');
2755 }
2756 } else if (response.IsErrorResponse())
2757 error.SetErrorStringWithFormat("memory read failed for 0x%" PRIx64, addr);
2758 else if (response.IsUnsupportedResponse())
2759 error.SetErrorStringWithFormat(
2760 "GDB server does not support reading memory");
2761 else
2762 error.SetErrorStringWithFormat(
2763 "unexpected response to GDB server memory read packet '%s': '%s'",
2764 packet, response.GetStringRef().data());
2765 } else {
2766 error.SetErrorStringWithFormat("failed to send packet: '%s'", packet);
2767 }
2768 return 0;
2769 }
2770
SupportsMemoryTagging()2771 bool ProcessGDBRemote::SupportsMemoryTagging() {
2772 return m_gdb_comm.GetMemoryTaggingSupported();
2773 }
2774
2775 llvm::Expected<std::vector<uint8_t>>
DoReadMemoryTags(lldb::addr_t addr,size_t len,int32_t type)2776 ProcessGDBRemote::DoReadMemoryTags(lldb::addr_t addr, size_t len,
2777 int32_t type) {
2778 // By this point ReadMemoryTags has validated that tagging is enabled
2779 // for this target/process/address.
2780 DataBufferSP buffer_sp = m_gdb_comm.ReadMemoryTags(addr, len, type);
2781 if (!buffer_sp) {
2782 return llvm::createStringError(llvm::inconvertibleErrorCode(),
2783 "Error reading memory tags from remote");
2784 }
2785
2786 // Return the raw tag data
2787 llvm::ArrayRef<uint8_t> tag_data = buffer_sp->GetData();
2788 std::vector<uint8_t> got;
2789 got.reserve(tag_data.size());
2790 std::copy(tag_data.begin(), tag_data.end(), std::back_inserter(got));
2791 return got;
2792 }
2793
DoWriteMemoryTags(lldb::addr_t addr,size_t len,int32_t type,const std::vector<uint8_t> & tags)2794 Status ProcessGDBRemote::DoWriteMemoryTags(lldb::addr_t addr, size_t len,
2795 int32_t type,
2796 const std::vector<uint8_t> &tags) {
2797 // By now WriteMemoryTags should have validated that tagging is enabled
2798 // for this target/process.
2799 return m_gdb_comm.WriteMemoryTags(addr, len, type, tags);
2800 }
2801
WriteObjectFile(std::vector<ObjectFile::LoadableData> entries)2802 Status ProcessGDBRemote::WriteObjectFile(
2803 std::vector<ObjectFile::LoadableData> entries) {
2804 Status error;
2805 // Sort the entries by address because some writes, like those to flash
2806 // memory, must happen in order of increasing address.
2807 std::stable_sort(
2808 std::begin(entries), std::end(entries),
2809 [](const ObjectFile::LoadableData a, const ObjectFile::LoadableData b) {
2810 return a.Dest < b.Dest;
2811 });
2812 m_allow_flash_writes = true;
2813 error = Process::WriteObjectFile(entries);
2814 if (error.Success())
2815 error = FlashDone();
2816 else
2817 // Even though some of the writing failed, try to send a flash done if some
2818 // of the writing succeeded so the flash state is reset to normal, but
2819 // don't stomp on the error status that was set in the write failure since
2820 // that's the one we want to report back.
2821 FlashDone();
2822 m_allow_flash_writes = false;
2823 return error;
2824 }
2825
HasErased(FlashRange range)2826 bool ProcessGDBRemote::HasErased(FlashRange range) {
2827 auto size = m_erased_flash_ranges.GetSize();
2828 for (size_t i = 0; i < size; ++i)
2829 if (m_erased_flash_ranges.GetEntryAtIndex(i)->Contains(range))
2830 return true;
2831 return false;
2832 }
2833
FlashErase(lldb::addr_t addr,size_t size)2834 Status ProcessGDBRemote::FlashErase(lldb::addr_t addr, size_t size) {
2835 Status status;
2836
2837 MemoryRegionInfo region;
2838 status = GetMemoryRegionInfo(addr, region);
2839 if (!status.Success())
2840 return status;
2841
2842 // The gdb spec doesn't say if erasures are allowed across multiple regions,
2843 // but we'll disallow it to be safe and to keep the logic simple by worring
2844 // about only one region's block size. DoMemoryWrite is this function's
2845 // primary user, and it can easily keep writes within a single memory region
2846 if (addr + size > region.GetRange().GetRangeEnd()) {
2847 status.SetErrorString("Unable to erase flash in multiple regions");
2848 return status;
2849 }
2850
2851 uint64_t blocksize = region.GetBlocksize();
2852 if (blocksize == 0) {
2853 status.SetErrorString("Unable to erase flash because blocksize is 0");
2854 return status;
2855 }
2856
2857 // Erasures can only be done on block boundary adresses, so round down addr
2858 // and round up size
2859 lldb::addr_t block_start_addr = addr - (addr % blocksize);
2860 size += (addr - block_start_addr);
2861 if ((size % blocksize) != 0)
2862 size += (blocksize - size % blocksize);
2863
2864 FlashRange range(block_start_addr, size);
2865
2866 if (HasErased(range))
2867 return status;
2868
2869 // We haven't erased the entire range, but we may have erased part of it.
2870 // (e.g., block A is already erased and range starts in A and ends in B). So,
2871 // adjust range if necessary to exclude already erased blocks.
2872 if (!m_erased_flash_ranges.IsEmpty()) {
2873 // Assuming that writes and erasures are done in increasing addr order,
2874 // because that is a requirement of the vFlashWrite command. Therefore, we
2875 // only need to look at the last range in the list for overlap.
2876 const auto &last_range = *m_erased_flash_ranges.Back();
2877 if (range.GetRangeBase() < last_range.GetRangeEnd()) {
2878 auto overlap = last_range.GetRangeEnd() - range.GetRangeBase();
2879 // overlap will be less than range.GetByteSize() or else HasErased()
2880 // would have been true
2881 range.SetByteSize(range.GetByteSize() - overlap);
2882 range.SetRangeBase(range.GetRangeBase() + overlap);
2883 }
2884 }
2885
2886 StreamString packet;
2887 packet.Printf("vFlashErase:%" PRIx64 ",%" PRIx64, range.GetRangeBase(),
2888 (uint64_t)range.GetByteSize());
2889
2890 StringExtractorGDBRemote response;
2891 if (m_gdb_comm.SendPacketAndWaitForResponse(packet.GetString(), response,
2892 GetInterruptTimeout()) ==
2893 GDBRemoteCommunication::PacketResult::Success) {
2894 if (response.IsOKResponse()) {
2895 m_erased_flash_ranges.Insert(range, true);
2896 } else {
2897 if (response.IsErrorResponse())
2898 status.SetErrorStringWithFormat("flash erase failed for 0x%" PRIx64,
2899 addr);
2900 else if (response.IsUnsupportedResponse())
2901 status.SetErrorStringWithFormat("GDB server does not support flashing");
2902 else
2903 status.SetErrorStringWithFormat(
2904 "unexpected response to GDB server flash erase packet '%s': '%s'",
2905 packet.GetData(), response.GetStringRef().data());
2906 }
2907 } else {
2908 status.SetErrorStringWithFormat("failed to send packet: '%s'",
2909 packet.GetData());
2910 }
2911 return status;
2912 }
2913
FlashDone()2914 Status ProcessGDBRemote::FlashDone() {
2915 Status status;
2916 // If we haven't erased any blocks, then we must not have written anything
2917 // either, so there is no need to actually send a vFlashDone command
2918 if (m_erased_flash_ranges.IsEmpty())
2919 return status;
2920 StringExtractorGDBRemote response;
2921 if (m_gdb_comm.SendPacketAndWaitForResponse("vFlashDone", response,
2922 GetInterruptTimeout()) ==
2923 GDBRemoteCommunication::PacketResult::Success) {
2924 if (response.IsOKResponse()) {
2925 m_erased_flash_ranges.Clear();
2926 } else {
2927 if (response.IsErrorResponse())
2928 status.SetErrorStringWithFormat("flash done failed");
2929 else if (response.IsUnsupportedResponse())
2930 status.SetErrorStringWithFormat("GDB server does not support flashing");
2931 else
2932 status.SetErrorStringWithFormat(
2933 "unexpected response to GDB server flash done packet: '%s'",
2934 response.GetStringRef().data());
2935 }
2936 } else {
2937 status.SetErrorStringWithFormat("failed to send flash done packet");
2938 }
2939 return status;
2940 }
2941
DoWriteMemory(addr_t addr,const void * buf,size_t size,Status & error)2942 size_t ProcessGDBRemote::DoWriteMemory(addr_t addr, const void *buf,
2943 size_t size, Status &error) {
2944 GetMaxMemorySize();
2945 // M and m packets take 2 bytes for 1 byte of memory
2946 size_t max_memory_size = m_max_memory_size / 2;
2947 if (size > max_memory_size) {
2948 // Keep memory read sizes down to a sane limit. This function will be
2949 // called multiple times in order to complete the task by
2950 // lldb_private::Process so it is ok to do this.
2951 size = max_memory_size;
2952 }
2953
2954 StreamGDBRemote packet;
2955
2956 MemoryRegionInfo region;
2957 Status region_status = GetMemoryRegionInfo(addr, region);
2958
2959 bool is_flash =
2960 region_status.Success() && region.GetFlash() == MemoryRegionInfo::eYes;
2961
2962 if (is_flash) {
2963 if (!m_allow_flash_writes) {
2964 error.SetErrorString("Writing to flash memory is not allowed");
2965 return 0;
2966 }
2967 // Keep the write within a flash memory region
2968 if (addr + size > region.GetRange().GetRangeEnd())
2969 size = region.GetRange().GetRangeEnd() - addr;
2970 // Flash memory must be erased before it can be written
2971 error = FlashErase(addr, size);
2972 if (!error.Success())
2973 return 0;
2974 packet.Printf("vFlashWrite:%" PRIx64 ":", addr);
2975 packet.PutEscapedBytes(buf, size);
2976 } else {
2977 packet.Printf("M%" PRIx64 ",%" PRIx64 ":", addr, (uint64_t)size);
2978 packet.PutBytesAsRawHex8(buf, size, endian::InlHostByteOrder(),
2979 endian::InlHostByteOrder());
2980 }
2981 StringExtractorGDBRemote response;
2982 if (m_gdb_comm.SendPacketAndWaitForResponse(packet.GetString(), response,
2983 GetInterruptTimeout()) ==
2984 GDBRemoteCommunication::PacketResult::Success) {
2985 if (response.IsOKResponse()) {
2986 error.Clear();
2987 return size;
2988 } else if (response.IsErrorResponse())
2989 error.SetErrorStringWithFormat("memory write failed for 0x%" PRIx64,
2990 addr);
2991 else if (response.IsUnsupportedResponse())
2992 error.SetErrorStringWithFormat(
2993 "GDB server does not support writing memory");
2994 else
2995 error.SetErrorStringWithFormat(
2996 "unexpected response to GDB server memory write packet '%s': '%s'",
2997 packet.GetData(), response.GetStringRef().data());
2998 } else {
2999 error.SetErrorStringWithFormat("failed to send packet: '%s'",
3000 packet.GetData());
3001 }
3002 return 0;
3003 }
3004
DoAllocateMemory(size_t size,uint32_t permissions,Status & error)3005 lldb::addr_t ProcessGDBRemote::DoAllocateMemory(size_t size,
3006 uint32_t permissions,
3007 Status &error) {
3008 Log *log(
3009 GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS | LIBLLDB_LOG_EXPRESSIONS));
3010 addr_t allocated_addr = LLDB_INVALID_ADDRESS;
3011
3012 if (m_gdb_comm.SupportsAllocDeallocMemory() != eLazyBoolNo) {
3013 allocated_addr = m_gdb_comm.AllocateMemory(size, permissions);
3014 if (allocated_addr != LLDB_INVALID_ADDRESS ||
3015 m_gdb_comm.SupportsAllocDeallocMemory() == eLazyBoolYes)
3016 return allocated_addr;
3017 }
3018
3019 if (m_gdb_comm.SupportsAllocDeallocMemory() == eLazyBoolNo) {
3020 // Call mmap() to create memory in the inferior..
3021 unsigned prot = 0;
3022 if (permissions & lldb::ePermissionsReadable)
3023 prot |= eMmapProtRead;
3024 if (permissions & lldb::ePermissionsWritable)
3025 prot |= eMmapProtWrite;
3026 if (permissions & lldb::ePermissionsExecutable)
3027 prot |= eMmapProtExec;
3028
3029 if (InferiorCallMmap(this, allocated_addr, 0, size, prot,
3030 eMmapFlagsAnon | eMmapFlagsPrivate, -1, 0))
3031 m_addr_to_mmap_size[allocated_addr] = size;
3032 else {
3033 allocated_addr = LLDB_INVALID_ADDRESS;
3034 LLDB_LOGF(log,
3035 "ProcessGDBRemote::%s no direct stub support for memory "
3036 "allocation, and InferiorCallMmap also failed - is stub "
3037 "missing register context save/restore capability?",
3038 __FUNCTION__);
3039 }
3040 }
3041
3042 if (allocated_addr == LLDB_INVALID_ADDRESS)
3043 error.SetErrorStringWithFormat(
3044 "unable to allocate %" PRIu64 " bytes of memory with permissions %s",
3045 (uint64_t)size, GetPermissionsAsCString(permissions));
3046 else
3047 error.Clear();
3048 return allocated_addr;
3049 }
3050
GetMemoryRegionInfo(addr_t load_addr,MemoryRegionInfo & region_info)3051 Status ProcessGDBRemote::GetMemoryRegionInfo(addr_t load_addr,
3052 MemoryRegionInfo ®ion_info) {
3053
3054 Status error(m_gdb_comm.GetMemoryRegionInfo(load_addr, region_info));
3055 return error;
3056 }
3057
GetWatchpointSupportInfo(uint32_t & num)3058 Status ProcessGDBRemote::GetWatchpointSupportInfo(uint32_t &num) {
3059
3060 Status error(m_gdb_comm.GetWatchpointSupportInfo(num));
3061 return error;
3062 }
3063
GetWatchpointSupportInfo(uint32_t & num,bool & after)3064 Status ProcessGDBRemote::GetWatchpointSupportInfo(uint32_t &num, bool &after) {
3065 Status error(m_gdb_comm.GetWatchpointSupportInfo(
3066 num, after, GetTarget().GetArchitecture()));
3067 return error;
3068 }
3069
DoDeallocateMemory(lldb::addr_t addr)3070 Status ProcessGDBRemote::DoDeallocateMemory(lldb::addr_t addr) {
3071 Status error;
3072 LazyBool supported = m_gdb_comm.SupportsAllocDeallocMemory();
3073
3074 switch (supported) {
3075 case eLazyBoolCalculate:
3076 // We should never be deallocating memory without allocating memory first
3077 // so we should never get eLazyBoolCalculate
3078 error.SetErrorString(
3079 "tried to deallocate memory without ever allocating memory");
3080 break;
3081
3082 case eLazyBoolYes:
3083 if (!m_gdb_comm.DeallocateMemory(addr))
3084 error.SetErrorStringWithFormat(
3085 "unable to deallocate memory at 0x%" PRIx64, addr);
3086 break;
3087
3088 case eLazyBoolNo:
3089 // Call munmap() to deallocate memory in the inferior..
3090 {
3091 MMapMap::iterator pos = m_addr_to_mmap_size.find(addr);
3092 if (pos != m_addr_to_mmap_size.end() &&
3093 InferiorCallMunmap(this, addr, pos->second))
3094 m_addr_to_mmap_size.erase(pos);
3095 else
3096 error.SetErrorStringWithFormat(
3097 "unable to deallocate memory at 0x%" PRIx64, addr);
3098 }
3099 break;
3100 }
3101
3102 return error;
3103 }
3104
3105 // Process STDIO
PutSTDIN(const char * src,size_t src_len,Status & error)3106 size_t ProcessGDBRemote::PutSTDIN(const char *src, size_t src_len,
3107 Status &error) {
3108 if (m_stdio_communication.IsConnected()) {
3109 ConnectionStatus status;
3110 m_stdio_communication.Write(src, src_len, status, nullptr);
3111 } else if (m_stdin_forward) {
3112 m_gdb_comm.SendStdinNotification(src, src_len);
3113 }
3114 return 0;
3115 }
3116
EnableBreakpointSite(BreakpointSite * bp_site)3117 Status ProcessGDBRemote::EnableBreakpointSite(BreakpointSite *bp_site) {
3118 Status error;
3119 assert(bp_site != nullptr);
3120
3121 // Get logging info
3122 Log *log(ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_BREAKPOINTS));
3123 user_id_t site_id = bp_site->GetID();
3124
3125 // Get the breakpoint address
3126 const addr_t addr = bp_site->GetLoadAddress();
3127
3128 // Log that a breakpoint was requested
3129 LLDB_LOGF(log,
3130 "ProcessGDBRemote::EnableBreakpointSite (size_id = %" PRIu64
3131 ") address = 0x%" PRIx64,
3132 site_id, (uint64_t)addr);
3133
3134 // Breakpoint already exists and is enabled
3135 if (bp_site->IsEnabled()) {
3136 LLDB_LOGF(log,
3137 "ProcessGDBRemote::EnableBreakpointSite (size_id = %" PRIu64
3138 ") address = 0x%" PRIx64 " -- SUCCESS (already enabled)",
3139 site_id, (uint64_t)addr);
3140 return error;
3141 }
3142
3143 // Get the software breakpoint trap opcode size
3144 const size_t bp_op_size = GetSoftwareBreakpointTrapOpcode(bp_site);
3145
3146 // SupportsGDBStoppointPacket() simply checks a boolean, indicating if this
3147 // breakpoint type is supported by the remote stub. These are set to true by
3148 // default, and later set to false only after we receive an unimplemented
3149 // response when sending a breakpoint packet. This means initially that
3150 // unless we were specifically instructed to use a hardware breakpoint, LLDB
3151 // will attempt to set a software breakpoint. HardwareRequired() also queries
3152 // a boolean variable which indicates if the user specifically asked for
3153 // hardware breakpoints. If true then we will skip over software
3154 // breakpoints.
3155 if (m_gdb_comm.SupportsGDBStoppointPacket(eBreakpointSoftware) &&
3156 (!bp_site->HardwareRequired())) {
3157 // Try to send off a software breakpoint packet ($Z0)
3158 uint8_t error_no = m_gdb_comm.SendGDBStoppointTypePacket(
3159 eBreakpointSoftware, true, addr, bp_op_size, GetInterruptTimeout());
3160 if (error_no == 0) {
3161 // The breakpoint was placed successfully
3162 bp_site->SetEnabled(true);
3163 bp_site->SetType(BreakpointSite::eExternal);
3164 return error;
3165 }
3166
3167 // SendGDBStoppointTypePacket() will return an error if it was unable to
3168 // set this breakpoint. We need to differentiate between a error specific
3169 // to placing this breakpoint or if we have learned that this breakpoint
3170 // type is unsupported. To do this, we must test the support boolean for
3171 // this breakpoint type to see if it now indicates that this breakpoint
3172 // type is unsupported. If they are still supported then we should return
3173 // with the error code. If they are now unsupported, then we would like to
3174 // fall through and try another form of breakpoint.
3175 if (m_gdb_comm.SupportsGDBStoppointPacket(eBreakpointSoftware)) {
3176 if (error_no != UINT8_MAX)
3177 error.SetErrorStringWithFormat(
3178 "error: %d sending the breakpoint request", error_no);
3179 else
3180 error.SetErrorString("error sending the breakpoint request");
3181 return error;
3182 }
3183
3184 // We reach here when software breakpoints have been found to be
3185 // unsupported. For future calls to set a breakpoint, we will not attempt
3186 // to set a breakpoint with a type that is known not to be supported.
3187 LLDB_LOGF(log, "Software breakpoints are unsupported");
3188
3189 // So we will fall through and try a hardware breakpoint
3190 }
3191
3192 // The process of setting a hardware breakpoint is much the same as above.
3193 // We check the supported boolean for this breakpoint type, and if it is
3194 // thought to be supported then we will try to set this breakpoint with a
3195 // hardware breakpoint.
3196 if (m_gdb_comm.SupportsGDBStoppointPacket(eBreakpointHardware)) {
3197 // Try to send off a hardware breakpoint packet ($Z1)
3198 uint8_t error_no = m_gdb_comm.SendGDBStoppointTypePacket(
3199 eBreakpointHardware, true, addr, bp_op_size, GetInterruptTimeout());
3200 if (error_no == 0) {
3201 // The breakpoint was placed successfully
3202 bp_site->SetEnabled(true);
3203 bp_site->SetType(BreakpointSite::eHardware);
3204 return error;
3205 }
3206
3207 // Check if the error was something other then an unsupported breakpoint
3208 // type
3209 if (m_gdb_comm.SupportsGDBStoppointPacket(eBreakpointHardware)) {
3210 // Unable to set this hardware breakpoint
3211 if (error_no != UINT8_MAX)
3212 error.SetErrorStringWithFormat(
3213 "error: %d sending the hardware breakpoint request "
3214 "(hardware breakpoint resources might be exhausted or unavailable)",
3215 error_no);
3216 else
3217 error.SetErrorString("error sending the hardware breakpoint request "
3218 "(hardware breakpoint resources "
3219 "might be exhausted or unavailable)");
3220 return error;
3221 }
3222
3223 // We will reach here when the stub gives an unsupported response to a
3224 // hardware breakpoint
3225 LLDB_LOGF(log, "Hardware breakpoints are unsupported");
3226
3227 // Finally we will falling through to a #trap style breakpoint
3228 }
3229
3230 // Don't fall through when hardware breakpoints were specifically requested
3231 if (bp_site->HardwareRequired()) {
3232 error.SetErrorString("hardware breakpoints are not supported");
3233 return error;
3234 }
3235
3236 // As a last resort we want to place a manual breakpoint. An instruction is
3237 // placed into the process memory using memory write packets.
3238 return EnableSoftwareBreakpoint(bp_site);
3239 }
3240
DisableBreakpointSite(BreakpointSite * bp_site)3241 Status ProcessGDBRemote::DisableBreakpointSite(BreakpointSite *bp_site) {
3242 Status error;
3243 assert(bp_site != nullptr);
3244 addr_t addr = bp_site->GetLoadAddress();
3245 user_id_t site_id = bp_site->GetID();
3246 Log *log(ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_BREAKPOINTS));
3247 LLDB_LOGF(log,
3248 "ProcessGDBRemote::DisableBreakpointSite (site_id = %" PRIu64
3249 ") addr = 0x%8.8" PRIx64,
3250 site_id, (uint64_t)addr);
3251
3252 if (bp_site->IsEnabled()) {
3253 const size_t bp_op_size = GetSoftwareBreakpointTrapOpcode(bp_site);
3254
3255 BreakpointSite::Type bp_type = bp_site->GetType();
3256 switch (bp_type) {
3257 case BreakpointSite::eSoftware:
3258 error = DisableSoftwareBreakpoint(bp_site);
3259 break;
3260
3261 case BreakpointSite::eHardware:
3262 if (m_gdb_comm.SendGDBStoppointTypePacket(eBreakpointHardware, false,
3263 addr, bp_op_size,
3264 GetInterruptTimeout()))
3265 error.SetErrorToGenericError();
3266 break;
3267
3268 case BreakpointSite::eExternal: {
3269 if (m_gdb_comm.SendGDBStoppointTypePacket(eBreakpointSoftware, false,
3270 addr, bp_op_size,
3271 GetInterruptTimeout()))
3272 error.SetErrorToGenericError();
3273 } break;
3274 }
3275 if (error.Success())
3276 bp_site->SetEnabled(false);
3277 } else {
3278 LLDB_LOGF(log,
3279 "ProcessGDBRemote::DisableBreakpointSite (site_id = %" PRIu64
3280 ") addr = 0x%8.8" PRIx64 " -- SUCCESS (already disabled)",
3281 site_id, (uint64_t)addr);
3282 return error;
3283 }
3284
3285 if (error.Success())
3286 error.SetErrorToGenericError();
3287 return error;
3288 }
3289
3290 // Pre-requisite: wp != NULL.
GetGDBStoppointType(Watchpoint * wp)3291 static GDBStoppointType GetGDBStoppointType(Watchpoint *wp) {
3292 assert(wp);
3293 bool watch_read = wp->WatchpointRead();
3294 bool watch_write = wp->WatchpointWrite();
3295
3296 // watch_read and watch_write cannot both be false.
3297 assert(watch_read || watch_write);
3298 if (watch_read && watch_write)
3299 return eWatchpointReadWrite;
3300 else if (watch_read)
3301 return eWatchpointRead;
3302 else // Must be watch_write, then.
3303 return eWatchpointWrite;
3304 }
3305
EnableWatchpoint(Watchpoint * wp,bool notify)3306 Status ProcessGDBRemote::EnableWatchpoint(Watchpoint *wp, bool notify) {
3307 Status error;
3308 if (wp) {
3309 user_id_t watchID = wp->GetID();
3310 addr_t addr = wp->GetLoadAddress();
3311 Log *log(
3312 ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_WATCHPOINTS));
3313 LLDB_LOGF(log, "ProcessGDBRemote::EnableWatchpoint(watchID = %" PRIu64 ")",
3314 watchID);
3315 if (wp->IsEnabled()) {
3316 LLDB_LOGF(log,
3317 "ProcessGDBRemote::EnableWatchpoint(watchID = %" PRIu64
3318 ") addr = 0x%8.8" PRIx64 ": watchpoint already enabled.",
3319 watchID, (uint64_t)addr);
3320 return error;
3321 }
3322
3323 GDBStoppointType type = GetGDBStoppointType(wp);
3324 // Pass down an appropriate z/Z packet...
3325 if (m_gdb_comm.SupportsGDBStoppointPacket(type)) {
3326 if (m_gdb_comm.SendGDBStoppointTypePacket(type, true, addr,
3327 wp->GetByteSize(),
3328 GetInterruptTimeout()) == 0) {
3329 wp->SetEnabled(true, notify);
3330 return error;
3331 } else
3332 error.SetErrorString("sending gdb watchpoint packet failed");
3333 } else
3334 error.SetErrorString("watchpoints not supported");
3335 } else {
3336 error.SetErrorString("Watchpoint argument was NULL.");
3337 }
3338 if (error.Success())
3339 error.SetErrorToGenericError();
3340 return error;
3341 }
3342
DisableWatchpoint(Watchpoint * wp,bool notify)3343 Status ProcessGDBRemote::DisableWatchpoint(Watchpoint *wp, bool notify) {
3344 Status error;
3345 if (wp) {
3346 user_id_t watchID = wp->GetID();
3347
3348 Log *log(
3349 ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_WATCHPOINTS));
3350
3351 addr_t addr = wp->GetLoadAddress();
3352
3353 LLDB_LOGF(log,
3354 "ProcessGDBRemote::DisableWatchpoint (watchID = %" PRIu64
3355 ") addr = 0x%8.8" PRIx64,
3356 watchID, (uint64_t)addr);
3357
3358 if (!wp->IsEnabled()) {
3359 LLDB_LOGF(log,
3360 "ProcessGDBRemote::DisableWatchpoint (watchID = %" PRIu64
3361 ") addr = 0x%8.8" PRIx64 " -- SUCCESS (already disabled)",
3362 watchID, (uint64_t)addr);
3363 // See also 'class WatchpointSentry' within StopInfo.cpp. This disabling
3364 // attempt might come from the user-supplied actions, we'll route it in
3365 // order for the watchpoint object to intelligently process this action.
3366 wp->SetEnabled(false, notify);
3367 return error;
3368 }
3369
3370 if (wp->IsHardware()) {
3371 GDBStoppointType type = GetGDBStoppointType(wp);
3372 // Pass down an appropriate z/Z packet...
3373 if (m_gdb_comm.SendGDBStoppointTypePacket(type, false, addr,
3374 wp->GetByteSize(),
3375 GetInterruptTimeout()) == 0) {
3376 wp->SetEnabled(false, notify);
3377 return error;
3378 } else
3379 error.SetErrorString("sending gdb watchpoint packet failed");
3380 }
3381 // TODO: clear software watchpoints if we implement them
3382 } else {
3383 error.SetErrorString("Watchpoint argument was NULL.");
3384 }
3385 if (error.Success())
3386 error.SetErrorToGenericError();
3387 return error;
3388 }
3389
Clear()3390 void ProcessGDBRemote::Clear() {
3391 m_thread_list_real.Clear();
3392 m_thread_list.Clear();
3393 }
3394
DoSignal(int signo)3395 Status ProcessGDBRemote::DoSignal(int signo) {
3396 Status error;
3397 Log *log(ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
3398 LLDB_LOGF(log, "ProcessGDBRemote::DoSignal (signal = %d)", signo);
3399
3400 if (!m_gdb_comm.SendAsyncSignal(signo, GetInterruptTimeout()))
3401 error.SetErrorStringWithFormat("failed to send signal %i", signo);
3402 return error;
3403 }
3404
ConnectToReplayServer()3405 Status ProcessGDBRemote::ConnectToReplayServer() {
3406 Status status = m_gdb_replay_server.Connect(m_gdb_comm);
3407 if (status.Fail())
3408 return status;
3409
3410 // Enable replay mode.
3411 m_replay_mode = true;
3412
3413 // Start server thread.
3414 m_gdb_replay_server.StartAsyncThread();
3415
3416 // Start client thread.
3417 StartAsyncThread();
3418
3419 // Do the usual setup.
3420 return ConnectToDebugserver("");
3421 }
3422
3423 Status
EstablishConnectionIfNeeded(const ProcessInfo & process_info)3424 ProcessGDBRemote::EstablishConnectionIfNeeded(const ProcessInfo &process_info) {
3425 // Make sure we aren't already connected?
3426 if (m_gdb_comm.IsConnected())
3427 return Status();
3428
3429 PlatformSP platform_sp(GetTarget().GetPlatform());
3430 if (platform_sp && !platform_sp->IsHost())
3431 return Status("Lost debug server connection");
3432
3433 if (repro::Reproducer::Instance().IsReplaying())
3434 return ConnectToReplayServer();
3435
3436 auto error = LaunchAndConnectToDebugserver(process_info);
3437 if (error.Fail()) {
3438 const char *error_string = error.AsCString();
3439 if (error_string == nullptr)
3440 error_string = "unable to launch " DEBUGSERVER_BASENAME;
3441 }
3442 return error;
3443 }
3444 #if !defined(_WIN32)
3445 #define USE_SOCKETPAIR_FOR_LOCAL_CONNECTION 1
3446 #endif
3447
3448 #ifdef USE_SOCKETPAIR_FOR_LOCAL_CONNECTION
SetCloexecFlag(int fd)3449 static bool SetCloexecFlag(int fd) {
3450 #if defined(FD_CLOEXEC)
3451 int flags = ::fcntl(fd, F_GETFD);
3452 if (flags == -1)
3453 return false;
3454 return (::fcntl(fd, F_SETFD, flags | FD_CLOEXEC) == 0);
3455 #else
3456 return false;
3457 #endif
3458 }
3459 #endif
3460
LaunchAndConnectToDebugserver(const ProcessInfo & process_info)3461 Status ProcessGDBRemote::LaunchAndConnectToDebugserver(
3462 const ProcessInfo &process_info) {
3463 using namespace std::placeholders; // For _1, _2, etc.
3464
3465 Status error;
3466 if (m_debugserver_pid == LLDB_INVALID_PROCESS_ID) {
3467 // If we locate debugserver, keep that located version around
3468 static FileSpec g_debugserver_file_spec;
3469
3470 ProcessLaunchInfo debugserver_launch_info;
3471 // Make debugserver run in its own session so signals generated by special
3472 // terminal key sequences (^C) don't affect debugserver.
3473 debugserver_launch_info.SetLaunchInSeparateProcessGroup(true);
3474
3475 const std::weak_ptr<ProcessGDBRemote> this_wp =
3476 std::static_pointer_cast<ProcessGDBRemote>(shared_from_this());
3477 debugserver_launch_info.SetMonitorProcessCallback(
3478 std::bind(MonitorDebugserverProcess, this_wp, _1, _2, _3, _4), false);
3479 debugserver_launch_info.SetUserID(process_info.GetUserID());
3480
3481 #if defined(__APPLE__)
3482 // On macOS 11, we need to support x86_64 applications translated to
3483 // arm64. We check whether a binary is translated and spawn the correct
3484 // debugserver accordingly.
3485 int mib[] = { CTL_KERN, KERN_PROC, KERN_PROC_PID,
3486 static_cast<int>(process_info.GetProcessID()) };
3487 struct kinfo_proc processInfo;
3488 size_t bufsize = sizeof(processInfo);
3489 if (sysctl(mib, (unsigned)(sizeof(mib)/sizeof(int)), &processInfo,
3490 &bufsize, NULL, 0) == 0 && bufsize > 0) {
3491 if (processInfo.kp_proc.p_flag & P_TRANSLATED) {
3492 FileSpec rosetta_debugserver("/Library/Apple/usr/libexec/oah/debugserver");
3493 debugserver_launch_info.SetExecutableFile(rosetta_debugserver, false);
3494 }
3495 }
3496 #endif
3497
3498 int communication_fd = -1;
3499 #ifdef USE_SOCKETPAIR_FOR_LOCAL_CONNECTION
3500 // Use a socketpair on non-Windows systems for security and performance
3501 // reasons.
3502 int sockets[2]; /* the pair of socket descriptors */
3503 if (socketpair(AF_UNIX, SOCK_STREAM, 0, sockets) == -1) {
3504 error.SetErrorToErrno();
3505 return error;
3506 }
3507
3508 int our_socket = sockets[0];
3509 int gdb_socket = sockets[1];
3510 auto cleanup_our = llvm::make_scope_exit([&]() { close(our_socket); });
3511 auto cleanup_gdb = llvm::make_scope_exit([&]() { close(gdb_socket); });
3512
3513 // Don't let any child processes inherit our communication socket
3514 SetCloexecFlag(our_socket);
3515 communication_fd = gdb_socket;
3516 #endif
3517
3518 error = m_gdb_comm.StartDebugserverProcess(
3519 nullptr, GetTarget().GetPlatform().get(), debugserver_launch_info,
3520 nullptr, nullptr, communication_fd);
3521
3522 if (error.Success())
3523 m_debugserver_pid = debugserver_launch_info.GetProcessID();
3524 else
3525 m_debugserver_pid = LLDB_INVALID_PROCESS_ID;
3526
3527 if (m_debugserver_pid != LLDB_INVALID_PROCESS_ID) {
3528 #ifdef USE_SOCKETPAIR_FOR_LOCAL_CONNECTION
3529 // Our process spawned correctly, we can now set our connection to use
3530 // our end of the socket pair
3531 cleanup_our.release();
3532 m_gdb_comm.SetConnection(
3533 std::make_unique<ConnectionFileDescriptor>(our_socket, true));
3534 #endif
3535 StartAsyncThread();
3536 }
3537
3538 if (error.Fail()) {
3539 Log *log(ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
3540
3541 LLDB_LOGF(log, "failed to start debugserver process: %s",
3542 error.AsCString());
3543 return error;
3544 }
3545
3546 if (m_gdb_comm.IsConnected()) {
3547 // Finish the connection process by doing the handshake without
3548 // connecting (send NULL URL)
3549 error = ConnectToDebugserver("");
3550 } else {
3551 error.SetErrorString("connection failed");
3552 }
3553 }
3554 return error;
3555 }
3556
MonitorDebugserverProcess(std::weak_ptr<ProcessGDBRemote> process_wp,lldb::pid_t debugserver_pid,bool exited,int signo,int exit_status)3557 bool ProcessGDBRemote::MonitorDebugserverProcess(
3558 std::weak_ptr<ProcessGDBRemote> process_wp, lldb::pid_t debugserver_pid,
3559 bool exited, // True if the process did exit
3560 int signo, // Zero for no signal
3561 int exit_status // Exit value of process if signal is zero
3562 ) {
3563 // "debugserver_pid" argument passed in is the process ID for debugserver
3564 // that we are tracking...
3565 Log *log(ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
3566 const bool handled = true;
3567
3568 LLDB_LOGF(log,
3569 "ProcessGDBRemote::%s(process_wp, pid=%" PRIu64
3570 ", signo=%i (0x%x), exit_status=%i)",
3571 __FUNCTION__, debugserver_pid, signo, signo, exit_status);
3572
3573 std::shared_ptr<ProcessGDBRemote> process_sp = process_wp.lock();
3574 LLDB_LOGF(log, "ProcessGDBRemote::%s(process = %p)", __FUNCTION__,
3575 static_cast<void *>(process_sp.get()));
3576 if (!process_sp || process_sp->m_debugserver_pid != debugserver_pid)
3577 return handled;
3578
3579 // Sleep for a half a second to make sure our inferior process has time to
3580 // set its exit status before we set it incorrectly when both the debugserver
3581 // and the inferior process shut down.
3582 std::this_thread::sleep_for(std::chrono::milliseconds(500));
3583
3584 // If our process hasn't yet exited, debugserver might have died. If the
3585 // process did exit, then we are reaping it.
3586 const StateType state = process_sp->GetState();
3587
3588 if (state != eStateInvalid && state != eStateUnloaded &&
3589 state != eStateExited && state != eStateDetached) {
3590 char error_str[1024];
3591 if (signo) {
3592 const char *signal_cstr =
3593 process_sp->GetUnixSignals()->GetSignalAsCString(signo);
3594 if (signal_cstr)
3595 ::snprintf(error_str, sizeof(error_str),
3596 DEBUGSERVER_BASENAME " died with signal %s", signal_cstr);
3597 else
3598 ::snprintf(error_str, sizeof(error_str),
3599 DEBUGSERVER_BASENAME " died with signal %i", signo);
3600 } else {
3601 ::snprintf(error_str, sizeof(error_str),
3602 DEBUGSERVER_BASENAME " died with an exit status of 0x%8.8x",
3603 exit_status);
3604 }
3605
3606 process_sp->SetExitStatus(-1, error_str);
3607 }
3608 // Debugserver has exited we need to let our ProcessGDBRemote know that it no
3609 // longer has a debugserver instance
3610 process_sp->m_debugserver_pid = LLDB_INVALID_PROCESS_ID;
3611 return handled;
3612 }
3613
KillDebugserverProcess()3614 void ProcessGDBRemote::KillDebugserverProcess() {
3615 m_gdb_comm.Disconnect();
3616 if (m_debugserver_pid != LLDB_INVALID_PROCESS_ID) {
3617 Host::Kill(m_debugserver_pid, SIGINT);
3618 m_debugserver_pid = LLDB_INVALID_PROCESS_ID;
3619 }
3620 }
3621
Initialize()3622 void ProcessGDBRemote::Initialize() {
3623 static llvm::once_flag g_once_flag;
3624
3625 llvm::call_once(g_once_flag, []() {
3626 PluginManager::RegisterPlugin(GetPluginNameStatic(),
3627 GetPluginDescriptionStatic(), CreateInstance,
3628 DebuggerInitialize);
3629 });
3630 }
3631
DebuggerInitialize(Debugger & debugger)3632 void ProcessGDBRemote::DebuggerInitialize(Debugger &debugger) {
3633 if (!PluginManager::GetSettingForProcessPlugin(
3634 debugger, PluginProperties::GetSettingName())) {
3635 const bool is_global_setting = true;
3636 PluginManager::CreateSettingForProcessPlugin(
3637 debugger, GetGlobalPluginProperties()->GetValueProperties(),
3638 ConstString("Properties for the gdb-remote process plug-in."),
3639 is_global_setting);
3640 }
3641 }
3642
StartAsyncThread()3643 bool ProcessGDBRemote::StartAsyncThread() {
3644 Log *log(ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
3645
3646 LLDB_LOGF(log, "ProcessGDBRemote::%s ()", __FUNCTION__);
3647
3648 std::lock_guard<std::recursive_mutex> guard(m_async_thread_state_mutex);
3649 if (!m_async_thread.IsJoinable()) {
3650 // Create a thread that watches our internal state and controls which
3651 // events make it to clients (into the DCProcess event queue).
3652
3653 llvm::Expected<HostThread> async_thread = ThreadLauncher::LaunchThread(
3654 "<lldb.process.gdb-remote.async>", ProcessGDBRemote::AsyncThread, this);
3655 if (!async_thread) {
3656 LLDB_LOG_ERROR(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_HOST),
3657 async_thread.takeError(),
3658 "failed to launch host thread: {}");
3659 return false;
3660 }
3661 m_async_thread = *async_thread;
3662 } else
3663 LLDB_LOGF(log,
3664 "ProcessGDBRemote::%s () - Called when Async thread was "
3665 "already running.",
3666 __FUNCTION__);
3667
3668 return m_async_thread.IsJoinable();
3669 }
3670
StopAsyncThread()3671 void ProcessGDBRemote::StopAsyncThread() {
3672 Log *log(ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
3673
3674 LLDB_LOGF(log, "ProcessGDBRemote::%s ()", __FUNCTION__);
3675
3676 std::lock_guard<std::recursive_mutex> guard(m_async_thread_state_mutex);
3677 if (m_async_thread.IsJoinable()) {
3678 m_async_broadcaster.BroadcastEvent(eBroadcastBitAsyncThreadShouldExit);
3679
3680 // This will shut down the async thread.
3681 m_gdb_comm.Disconnect(); // Disconnect from the debug server.
3682
3683 // Stop the stdio thread
3684 m_async_thread.Join(nullptr);
3685 m_async_thread.Reset();
3686 } else
3687 LLDB_LOGF(
3688 log,
3689 "ProcessGDBRemote::%s () - Called when Async thread was not running.",
3690 __FUNCTION__);
3691 }
3692
HandleNotifyPacket(StringExtractorGDBRemote & packet)3693 bool ProcessGDBRemote::HandleNotifyPacket(StringExtractorGDBRemote &packet) {
3694 // get the packet at a string
3695 const std::string &pkt = std::string(packet.GetStringRef());
3696 // skip %stop:
3697 StringExtractorGDBRemote stop_info(pkt.c_str() + 5);
3698
3699 // pass as a thread stop info packet
3700 SetLastStopPacket(stop_info);
3701
3702 // check for more stop reasons
3703 HandleStopReplySequence();
3704
3705 // if the process is stopped then we need to fake a resume so that we can
3706 // stop properly with the new break. This is possible due to
3707 // SetPrivateState() broadcasting the state change as a side effect.
3708 if (GetPrivateState() == lldb::StateType::eStateStopped) {
3709 SetPrivateState(lldb::StateType::eStateRunning);
3710 }
3711
3712 // since we have some stopped packets we can halt the process
3713 SetPrivateState(lldb::StateType::eStateStopped);
3714
3715 return true;
3716 }
3717
AsyncThread(void * arg)3718 thread_result_t ProcessGDBRemote::AsyncThread(void *arg) {
3719 ProcessGDBRemote *process = (ProcessGDBRemote *)arg;
3720
3721 Log *log(ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
3722 LLDB_LOGF(log,
3723 "ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64
3724 ") thread starting...",
3725 __FUNCTION__, arg, process->GetID());
3726
3727 EventSP event_sp;
3728
3729 // We need to ignore any packets that come in after we have
3730 // have decided the process has exited. There are some
3731 // situations, for instance when we try to interrupt a running
3732 // process and the interrupt fails, where another packet might
3733 // get delivered after we've decided to give up on the process.
3734 // But once we've decided we are done with the process we will
3735 // not be in a state to do anything useful with new packets.
3736 // So it is safer to simply ignore any remaining packets by
3737 // explicitly checking for eStateExited before reentering the
3738 // fetch loop.
3739
3740 bool done = false;
3741 while (!done && process->GetPrivateState() != eStateExited) {
3742 LLDB_LOGF(log,
3743 "ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64
3744 ") listener.WaitForEvent (NULL, event_sp)...",
3745 __FUNCTION__, arg, process->GetID());
3746
3747 if (process->m_async_listener_sp->GetEvent(event_sp, llvm::None)) {
3748 const uint32_t event_type = event_sp->GetType();
3749 if (event_sp->BroadcasterIs(&process->m_async_broadcaster)) {
3750 LLDB_LOGF(log,
3751 "ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64
3752 ") Got an event of type: %d...",
3753 __FUNCTION__, arg, process->GetID(), event_type);
3754
3755 switch (event_type) {
3756 case eBroadcastBitAsyncContinue: {
3757 const EventDataBytes *continue_packet =
3758 EventDataBytes::GetEventDataFromEvent(event_sp.get());
3759
3760 if (continue_packet) {
3761 const char *continue_cstr =
3762 (const char *)continue_packet->GetBytes();
3763 const size_t continue_cstr_len = continue_packet->GetByteSize();
3764 LLDB_LOGF(log,
3765 "ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64
3766 ") got eBroadcastBitAsyncContinue: %s",
3767 __FUNCTION__, arg, process->GetID(), continue_cstr);
3768
3769 if (::strstr(continue_cstr, "vAttach") == nullptr)
3770 process->SetPrivateState(eStateRunning);
3771 StringExtractorGDBRemote response;
3772
3773 // If in Non-Stop-Mode
3774 if (process->GetTarget().GetNonStopModeEnabled()) {
3775 // send the vCont packet
3776 if (!process->GetGDBRemote().SendvContPacket(
3777 llvm::StringRef(continue_cstr, continue_cstr_len),
3778 process->GetInterruptTimeout(), response)) {
3779 // Something went wrong
3780 done = true;
3781 break;
3782 }
3783 }
3784 // If in All-Stop-Mode
3785 else {
3786 StateType stop_state =
3787 process->GetGDBRemote().SendContinuePacketAndWaitForResponse(
3788 *process, *process->GetUnixSignals(),
3789 llvm::StringRef(continue_cstr, continue_cstr_len),
3790 process->GetInterruptTimeout(),
3791 response);
3792
3793 // We need to immediately clear the thread ID list so we are sure
3794 // to get a valid list of threads. The thread ID list might be
3795 // contained within the "response", or the stop reply packet that
3796 // caused the stop. So clear it now before we give the stop reply
3797 // packet to the process using the
3798 // process->SetLastStopPacket()...
3799 process->ClearThreadIDList();
3800
3801 switch (stop_state) {
3802 case eStateStopped:
3803 case eStateCrashed:
3804 case eStateSuspended:
3805 process->SetLastStopPacket(response);
3806 process->SetPrivateState(stop_state);
3807 break;
3808
3809 case eStateExited: {
3810 process->SetLastStopPacket(response);
3811 process->ClearThreadIDList();
3812 response.SetFilePos(1);
3813
3814 int exit_status = response.GetHexU8();
3815 std::string desc_string;
3816 if (response.GetBytesLeft() > 0 &&
3817 response.GetChar('-') == ';') {
3818 llvm::StringRef desc_str;
3819 llvm::StringRef desc_token;
3820 while (response.GetNameColonValue(desc_token, desc_str)) {
3821 if (desc_token != "description")
3822 continue;
3823 StringExtractor extractor(desc_str);
3824 extractor.GetHexByteString(desc_string);
3825 }
3826 }
3827 process->SetExitStatus(exit_status, desc_string.c_str());
3828 done = true;
3829 break;
3830 }
3831 case eStateInvalid: {
3832 // Check to see if we were trying to attach and if we got back
3833 // the "E87" error code from debugserver -- this indicates that
3834 // the process is not debuggable. Return a slightly more
3835 // helpful error message about why the attach failed.
3836 if (::strstr(continue_cstr, "vAttach") != nullptr &&
3837 response.GetError() == 0x87) {
3838 process->SetExitStatus(-1, "cannot attach to process due to "
3839 "System Integrity Protection");
3840 } else if (::strstr(continue_cstr, "vAttach") != nullptr &&
3841 response.GetStatus().Fail()) {
3842 process->SetExitStatus(-1, response.GetStatus().AsCString());
3843 } else {
3844 process->SetExitStatus(-1, "lost connection");
3845 }
3846 done = true;
3847 break;
3848 }
3849
3850 default:
3851 process->SetPrivateState(stop_state);
3852 break;
3853 } // switch(stop_state)
3854 } // else // if in All-stop-mode
3855 } // if (continue_packet)
3856 } // case eBroadcastBitAsyncContinue
3857 break;
3858
3859 case eBroadcastBitAsyncThreadShouldExit:
3860 LLDB_LOGF(log,
3861 "ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64
3862 ") got eBroadcastBitAsyncThreadShouldExit...",
3863 __FUNCTION__, arg, process->GetID());
3864 done = true;
3865 break;
3866
3867 default:
3868 LLDB_LOGF(log,
3869 "ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64
3870 ") got unknown event 0x%8.8x",
3871 __FUNCTION__, arg, process->GetID(), event_type);
3872 done = true;
3873 break;
3874 }
3875 } else if (event_sp->BroadcasterIs(&process->m_gdb_comm)) {
3876 switch (event_type) {
3877 case Communication::eBroadcastBitReadThreadDidExit:
3878 process->SetExitStatus(-1, "lost connection");
3879 done = true;
3880 break;
3881
3882 case GDBRemoteCommunication::eBroadcastBitGdbReadThreadGotNotify: {
3883 lldb_private::Event *event = event_sp.get();
3884 const EventDataBytes *continue_packet =
3885 EventDataBytes::GetEventDataFromEvent(event);
3886 StringExtractorGDBRemote notify(
3887 (const char *)continue_packet->GetBytes());
3888 // Hand this over to the process to handle
3889 process->HandleNotifyPacket(notify);
3890 break;
3891 }
3892
3893 default:
3894 LLDB_LOGF(log,
3895 "ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64
3896 ") got unknown event 0x%8.8x",
3897 __FUNCTION__, arg, process->GetID(), event_type);
3898 done = true;
3899 break;
3900 }
3901 }
3902 } else {
3903 LLDB_LOGF(log,
3904 "ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64
3905 ") listener.WaitForEvent (NULL, event_sp) => false",
3906 __FUNCTION__, arg, process->GetID());
3907 done = true;
3908 }
3909 }
3910
3911 LLDB_LOGF(log,
3912 "ProcessGDBRemote::%s (arg = %p, pid = %" PRIu64
3913 ") thread exiting...",
3914 __FUNCTION__, arg, process->GetID());
3915
3916 return {};
3917 }
3918
3919 // uint32_t
3920 // ProcessGDBRemote::ListProcessesMatchingName (const char *name, StringList
3921 // &matches, std::vector<lldb::pid_t> &pids)
3922 //{
3923 // // If we are planning to launch the debugserver remotely, then we need to
3924 // fire up a debugserver
3925 // // process and ask it for the list of processes. But if we are local, we
3926 // can let the Host do it.
3927 // if (m_local_debugserver)
3928 // {
3929 // return Host::ListProcessesMatchingName (name, matches, pids);
3930 // }
3931 // else
3932 // {
3933 // // FIXME: Implement talking to the remote debugserver.
3934 // return 0;
3935 // }
3936 //
3937 //}
3938 //
NewThreadNotifyBreakpointHit(void * baton,StoppointCallbackContext * context,lldb::user_id_t break_id,lldb::user_id_t break_loc_id)3939 bool ProcessGDBRemote::NewThreadNotifyBreakpointHit(
3940 void *baton, StoppointCallbackContext *context, lldb::user_id_t break_id,
3941 lldb::user_id_t break_loc_id) {
3942 // I don't think I have to do anything here, just make sure I notice the new
3943 // thread when it starts to
3944 // run so I can stop it if that's what I want to do.
3945 Log *log(GetLogIfAllCategoriesSet(LIBLLDB_LOG_STEP));
3946 LLDB_LOGF(log, "Hit New Thread Notification breakpoint.");
3947 return false;
3948 }
3949
UpdateAutomaticSignalFiltering()3950 Status ProcessGDBRemote::UpdateAutomaticSignalFiltering() {
3951 Log *log(ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
3952 LLDB_LOG(log, "Check if need to update ignored signals");
3953
3954 // QPassSignals package is not supported by the server, there is no way we
3955 // can ignore any signals on server side.
3956 if (!m_gdb_comm.GetQPassSignalsSupported())
3957 return Status();
3958
3959 // No signals, nothing to send.
3960 if (m_unix_signals_sp == nullptr)
3961 return Status();
3962
3963 // Signals' version hasn't changed, no need to send anything.
3964 uint64_t new_signals_version = m_unix_signals_sp->GetVersion();
3965 if (new_signals_version == m_last_signals_version) {
3966 LLDB_LOG(log, "Signals' version hasn't changed. version={0}",
3967 m_last_signals_version);
3968 return Status();
3969 }
3970
3971 auto signals_to_ignore =
3972 m_unix_signals_sp->GetFilteredSignals(false, false, false);
3973 Status error = m_gdb_comm.SendSignalsToIgnore(signals_to_ignore);
3974
3975 LLDB_LOG(log,
3976 "Signals' version changed. old version={0}, new version={1}, "
3977 "signals ignored={2}, update result={3}",
3978 m_last_signals_version, new_signals_version,
3979 signals_to_ignore.size(), error);
3980
3981 if (error.Success())
3982 m_last_signals_version = new_signals_version;
3983
3984 return error;
3985 }
3986
StartNoticingNewThreads()3987 bool ProcessGDBRemote::StartNoticingNewThreads() {
3988 Log *log(GetLogIfAllCategoriesSet(LIBLLDB_LOG_STEP));
3989 if (m_thread_create_bp_sp) {
3990 if (log && log->GetVerbose())
3991 LLDB_LOGF(log, "Enabled noticing new thread breakpoint.");
3992 m_thread_create_bp_sp->SetEnabled(true);
3993 } else {
3994 PlatformSP platform_sp(GetTarget().GetPlatform());
3995 if (platform_sp) {
3996 m_thread_create_bp_sp =
3997 platform_sp->SetThreadCreationBreakpoint(GetTarget());
3998 if (m_thread_create_bp_sp) {
3999 if (log && log->GetVerbose())
4000 LLDB_LOGF(
4001 log, "Successfully created new thread notification breakpoint %i",
4002 m_thread_create_bp_sp->GetID());
4003 m_thread_create_bp_sp->SetCallback(
4004 ProcessGDBRemote::NewThreadNotifyBreakpointHit, this, true);
4005 } else {
4006 LLDB_LOGF(log, "Failed to create new thread notification breakpoint.");
4007 }
4008 }
4009 }
4010 return m_thread_create_bp_sp.get() != nullptr;
4011 }
4012
StopNoticingNewThreads()4013 bool ProcessGDBRemote::StopNoticingNewThreads() {
4014 Log *log(GetLogIfAllCategoriesSet(LIBLLDB_LOG_STEP));
4015 if (log && log->GetVerbose())
4016 LLDB_LOGF(log, "Disabling new thread notification breakpoint.");
4017
4018 if (m_thread_create_bp_sp)
4019 m_thread_create_bp_sp->SetEnabled(false);
4020
4021 return true;
4022 }
4023
GetDynamicLoader()4024 DynamicLoader *ProcessGDBRemote::GetDynamicLoader() {
4025 if (m_dyld_up.get() == nullptr)
4026 m_dyld_up.reset(DynamicLoader::FindPlugin(this, nullptr));
4027 return m_dyld_up.get();
4028 }
4029
SendEventData(const char * data)4030 Status ProcessGDBRemote::SendEventData(const char *data) {
4031 int return_value;
4032 bool was_supported;
4033
4034 Status error;
4035
4036 return_value = m_gdb_comm.SendLaunchEventDataPacket(data, &was_supported);
4037 if (return_value != 0) {
4038 if (!was_supported)
4039 error.SetErrorString("Sending events is not supported for this process.");
4040 else
4041 error.SetErrorStringWithFormat("Error sending event data: %d.",
4042 return_value);
4043 }
4044 return error;
4045 }
4046
GetAuxvData()4047 DataExtractor ProcessGDBRemote::GetAuxvData() {
4048 DataBufferSP buf;
4049 if (m_gdb_comm.GetQXferAuxvReadSupported()) {
4050 std::string response_string;
4051 if (m_gdb_comm.SendPacketsAndConcatenateResponses("qXfer:auxv:read::",
4052 response_string) ==
4053 GDBRemoteCommunication::PacketResult::Success)
4054 buf = std::make_shared<DataBufferHeap>(response_string.c_str(),
4055 response_string.length());
4056 }
4057 return DataExtractor(buf, GetByteOrder(), GetAddressByteSize());
4058 }
4059
4060 StructuredData::ObjectSP
GetExtendedInfoForThread(lldb::tid_t tid)4061 ProcessGDBRemote::GetExtendedInfoForThread(lldb::tid_t tid) {
4062 StructuredData::ObjectSP object_sp;
4063
4064 if (m_gdb_comm.GetThreadExtendedInfoSupported()) {
4065 StructuredData::ObjectSP args_dict(new StructuredData::Dictionary());
4066 SystemRuntime *runtime = GetSystemRuntime();
4067 if (runtime) {
4068 runtime->AddThreadExtendedInfoPacketHints(args_dict);
4069 }
4070 args_dict->GetAsDictionary()->AddIntegerItem("thread", tid);
4071
4072 StreamString packet;
4073 packet << "jThreadExtendedInfo:";
4074 args_dict->Dump(packet, false);
4075
4076 // FIXME the final character of a JSON dictionary, '}', is the escape
4077 // character in gdb-remote binary mode. lldb currently doesn't escape
4078 // these characters in its packet output -- so we add the quoted version of
4079 // the } character here manually in case we talk to a debugserver which un-
4080 // escapes the characters at packet read time.
4081 packet << (char)(0x7d ^ 0x20);
4082
4083 StringExtractorGDBRemote response;
4084 response.SetResponseValidatorToJSON();
4085 if (m_gdb_comm.SendPacketAndWaitForResponse(packet.GetString(), response) ==
4086 GDBRemoteCommunication::PacketResult::Success) {
4087 StringExtractorGDBRemote::ResponseType response_type =
4088 response.GetResponseType();
4089 if (response_type == StringExtractorGDBRemote::eResponse) {
4090 if (!response.Empty()) {
4091 object_sp =
4092 StructuredData::ParseJSON(std::string(response.GetStringRef()));
4093 }
4094 }
4095 }
4096 }
4097 return object_sp;
4098 }
4099
GetLoadedDynamicLibrariesInfos(lldb::addr_t image_list_address,lldb::addr_t image_count)4100 StructuredData::ObjectSP ProcessGDBRemote::GetLoadedDynamicLibrariesInfos(
4101 lldb::addr_t image_list_address, lldb::addr_t image_count) {
4102
4103 StructuredData::ObjectSP args_dict(new StructuredData::Dictionary());
4104 args_dict->GetAsDictionary()->AddIntegerItem("image_list_address",
4105 image_list_address);
4106 args_dict->GetAsDictionary()->AddIntegerItem("image_count", image_count);
4107
4108 return GetLoadedDynamicLibrariesInfos_sender(args_dict);
4109 }
4110
GetLoadedDynamicLibrariesInfos()4111 StructuredData::ObjectSP ProcessGDBRemote::GetLoadedDynamicLibrariesInfos() {
4112 StructuredData::ObjectSP args_dict(new StructuredData::Dictionary());
4113
4114 args_dict->GetAsDictionary()->AddBooleanItem("fetch_all_solibs", true);
4115
4116 return GetLoadedDynamicLibrariesInfos_sender(args_dict);
4117 }
4118
GetLoadedDynamicLibrariesInfos(const std::vector<lldb::addr_t> & load_addresses)4119 StructuredData::ObjectSP ProcessGDBRemote::GetLoadedDynamicLibrariesInfos(
4120 const std::vector<lldb::addr_t> &load_addresses) {
4121 StructuredData::ObjectSP args_dict(new StructuredData::Dictionary());
4122 StructuredData::ArraySP addresses(new StructuredData::Array);
4123
4124 for (auto addr : load_addresses) {
4125 StructuredData::ObjectSP addr_sp(new StructuredData::Integer(addr));
4126 addresses->AddItem(addr_sp);
4127 }
4128
4129 args_dict->GetAsDictionary()->AddItem("solib_addresses", addresses);
4130
4131 return GetLoadedDynamicLibrariesInfos_sender(args_dict);
4132 }
4133
4134 StructuredData::ObjectSP
GetLoadedDynamicLibrariesInfos_sender(StructuredData::ObjectSP args_dict)4135 ProcessGDBRemote::GetLoadedDynamicLibrariesInfos_sender(
4136 StructuredData::ObjectSP args_dict) {
4137 StructuredData::ObjectSP object_sp;
4138
4139 if (m_gdb_comm.GetLoadedDynamicLibrariesInfosSupported()) {
4140 // Scope for the scoped timeout object
4141 GDBRemoteCommunication::ScopedTimeout timeout(m_gdb_comm,
4142 std::chrono::seconds(10));
4143
4144 StreamString packet;
4145 packet << "jGetLoadedDynamicLibrariesInfos:";
4146 args_dict->Dump(packet, false);
4147
4148 // FIXME the final character of a JSON dictionary, '}', is the escape
4149 // character in gdb-remote binary mode. lldb currently doesn't escape
4150 // these characters in its packet output -- so we add the quoted version of
4151 // the } character here manually in case we talk to a debugserver which un-
4152 // escapes the characters at packet read time.
4153 packet << (char)(0x7d ^ 0x20);
4154
4155 StringExtractorGDBRemote response;
4156 response.SetResponseValidatorToJSON();
4157 if (m_gdb_comm.SendPacketAndWaitForResponse(packet.GetString(), response) ==
4158 GDBRemoteCommunication::PacketResult::Success) {
4159 StringExtractorGDBRemote::ResponseType response_type =
4160 response.GetResponseType();
4161 if (response_type == StringExtractorGDBRemote::eResponse) {
4162 if (!response.Empty()) {
4163 object_sp =
4164 StructuredData::ParseJSON(std::string(response.GetStringRef()));
4165 }
4166 }
4167 }
4168 }
4169 return object_sp;
4170 }
4171
GetSharedCacheInfo()4172 StructuredData::ObjectSP ProcessGDBRemote::GetSharedCacheInfo() {
4173 StructuredData::ObjectSP object_sp;
4174 StructuredData::ObjectSP args_dict(new StructuredData::Dictionary());
4175
4176 if (m_gdb_comm.GetSharedCacheInfoSupported()) {
4177 StreamString packet;
4178 packet << "jGetSharedCacheInfo:";
4179 args_dict->Dump(packet, false);
4180
4181 // FIXME the final character of a JSON dictionary, '}', is the escape
4182 // character in gdb-remote binary mode. lldb currently doesn't escape
4183 // these characters in its packet output -- so we add the quoted version of
4184 // the } character here manually in case we talk to a debugserver which un-
4185 // escapes the characters at packet read time.
4186 packet << (char)(0x7d ^ 0x20);
4187
4188 StringExtractorGDBRemote response;
4189 response.SetResponseValidatorToJSON();
4190 if (m_gdb_comm.SendPacketAndWaitForResponse(packet.GetString(), response) ==
4191 GDBRemoteCommunication::PacketResult::Success) {
4192 StringExtractorGDBRemote::ResponseType response_type =
4193 response.GetResponseType();
4194 if (response_type == StringExtractorGDBRemote::eResponse) {
4195 if (!response.Empty()) {
4196 object_sp =
4197 StructuredData::ParseJSON(std::string(response.GetStringRef()));
4198 }
4199 }
4200 }
4201 }
4202 return object_sp;
4203 }
4204
ConfigureStructuredData(ConstString type_name,const StructuredData::ObjectSP & config_sp)4205 Status ProcessGDBRemote::ConfigureStructuredData(
4206 ConstString type_name, const StructuredData::ObjectSP &config_sp) {
4207 return m_gdb_comm.ConfigureRemoteStructuredData(type_name, config_sp);
4208 }
4209
4210 // Establish the largest memory read/write payloads we should use. If the
4211 // remote stub has a max packet size, stay under that size.
4212 //
4213 // If the remote stub's max packet size is crazy large, use a reasonable
4214 // largeish default.
4215 //
4216 // If the remote stub doesn't advertise a max packet size, use a conservative
4217 // default.
4218
GetMaxMemorySize()4219 void ProcessGDBRemote::GetMaxMemorySize() {
4220 const uint64_t reasonable_largeish_default = 128 * 1024;
4221 const uint64_t conservative_default = 512;
4222
4223 if (m_max_memory_size == 0) {
4224 uint64_t stub_max_size = m_gdb_comm.GetRemoteMaxPacketSize();
4225 if (stub_max_size != UINT64_MAX && stub_max_size != 0) {
4226 // Save the stub's claimed maximum packet size
4227 m_remote_stub_max_memory_size = stub_max_size;
4228
4229 // Even if the stub says it can support ginormous packets, don't exceed
4230 // our reasonable largeish default packet size.
4231 if (stub_max_size > reasonable_largeish_default) {
4232 stub_max_size = reasonable_largeish_default;
4233 }
4234
4235 // Memory packet have other overheads too like Maddr,size:#NN Instead of
4236 // calculating the bytes taken by size and addr every time, we take a
4237 // maximum guess here.
4238 if (stub_max_size > 70)
4239 stub_max_size -= 32 + 32 + 6;
4240 else {
4241 // In unlikely scenario that max packet size is less then 70, we will
4242 // hope that data being written is small enough to fit.
4243 Log *log(ProcessGDBRemoteLog::GetLogIfAnyCategoryIsSet(
4244 GDBR_LOG_COMM | GDBR_LOG_MEMORY));
4245 if (log)
4246 log->Warning("Packet size is too small. "
4247 "LLDB may face problems while writing memory");
4248 }
4249
4250 m_max_memory_size = stub_max_size;
4251 } else {
4252 m_max_memory_size = conservative_default;
4253 }
4254 }
4255 }
4256
SetUserSpecifiedMaxMemoryTransferSize(uint64_t user_specified_max)4257 void ProcessGDBRemote::SetUserSpecifiedMaxMemoryTransferSize(
4258 uint64_t user_specified_max) {
4259 if (user_specified_max != 0) {
4260 GetMaxMemorySize();
4261
4262 if (m_remote_stub_max_memory_size != 0) {
4263 if (m_remote_stub_max_memory_size < user_specified_max) {
4264 m_max_memory_size = m_remote_stub_max_memory_size; // user specified a
4265 // packet size too
4266 // big, go as big
4267 // as the remote stub says we can go.
4268 } else {
4269 m_max_memory_size = user_specified_max; // user's packet size is good
4270 }
4271 } else {
4272 m_max_memory_size =
4273 user_specified_max; // user's packet size is probably fine
4274 }
4275 }
4276 }
4277
GetModuleSpec(const FileSpec & module_file_spec,const ArchSpec & arch,ModuleSpec & module_spec)4278 bool ProcessGDBRemote::GetModuleSpec(const FileSpec &module_file_spec,
4279 const ArchSpec &arch,
4280 ModuleSpec &module_spec) {
4281 Log *log = GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PLATFORM);
4282
4283 const ModuleCacheKey key(module_file_spec.GetPath(),
4284 arch.GetTriple().getTriple());
4285 auto cached = m_cached_module_specs.find(key);
4286 if (cached != m_cached_module_specs.end()) {
4287 module_spec = cached->second;
4288 return bool(module_spec);
4289 }
4290
4291 if (!m_gdb_comm.GetModuleInfo(module_file_spec, arch, module_spec)) {
4292 LLDB_LOGF(log, "ProcessGDBRemote::%s - failed to get module info for %s:%s",
4293 __FUNCTION__, module_file_spec.GetPath().c_str(),
4294 arch.GetTriple().getTriple().c_str());
4295 return false;
4296 }
4297
4298 if (log) {
4299 StreamString stream;
4300 module_spec.Dump(stream);
4301 LLDB_LOGF(log, "ProcessGDBRemote::%s - got module info for (%s:%s) : %s",
4302 __FUNCTION__, module_file_spec.GetPath().c_str(),
4303 arch.GetTriple().getTriple().c_str(), stream.GetData());
4304 }
4305
4306 m_cached_module_specs[key] = module_spec;
4307 return true;
4308 }
4309
PrefetchModuleSpecs(llvm::ArrayRef<FileSpec> module_file_specs,const llvm::Triple & triple)4310 void ProcessGDBRemote::PrefetchModuleSpecs(
4311 llvm::ArrayRef<FileSpec> module_file_specs, const llvm::Triple &triple) {
4312 auto module_specs = m_gdb_comm.GetModulesInfo(module_file_specs, triple);
4313 if (module_specs) {
4314 for (const FileSpec &spec : module_file_specs)
4315 m_cached_module_specs[ModuleCacheKey(spec.GetPath(),
4316 triple.getTriple())] = ModuleSpec();
4317 for (const ModuleSpec &spec : *module_specs)
4318 m_cached_module_specs[ModuleCacheKey(spec.GetFileSpec().GetPath(),
4319 triple.getTriple())] = spec;
4320 }
4321 }
4322
GetHostOSVersion()4323 llvm::VersionTuple ProcessGDBRemote::GetHostOSVersion() {
4324 return m_gdb_comm.GetOSVersion();
4325 }
4326
GetHostMacCatalystVersion()4327 llvm::VersionTuple ProcessGDBRemote::GetHostMacCatalystVersion() {
4328 return m_gdb_comm.GetMacCatalystVersion();
4329 }
4330
4331 namespace {
4332
4333 typedef std::vector<std::string> stringVec;
4334
4335 typedef std::vector<struct GdbServerRegisterInfo> GDBServerRegisterVec;
4336 struct RegisterSetInfo {
4337 ConstString name;
4338 };
4339
4340 typedef std::map<uint32_t, RegisterSetInfo> RegisterSetMap;
4341
4342 struct GdbServerTargetInfo {
4343 std::string arch;
4344 std::string osabi;
4345 stringVec includes;
4346 RegisterSetMap reg_set_map;
4347 };
4348
ParseRegisters(XMLNode feature_node,GdbServerTargetInfo & target_info,GDBRemoteDynamicRegisterInfo & dyn_reg_info,ABISP abi_sp,uint32_t & reg_num_remote,uint32_t & reg_num_local)4349 bool ParseRegisters(XMLNode feature_node, GdbServerTargetInfo &target_info,
4350 GDBRemoteDynamicRegisterInfo &dyn_reg_info, ABISP abi_sp,
4351 uint32_t ®_num_remote, uint32_t ®_num_local) {
4352 if (!feature_node)
4353 return false;
4354
4355 uint32_t reg_offset = LLDB_INVALID_INDEX32;
4356 feature_node.ForEachChildElementWithName(
4357 "reg", [&target_info, &dyn_reg_info, ®_num_remote, ®_num_local,
4358 ®_offset, &abi_sp](const XMLNode ®_node) -> bool {
4359 std::string gdb_group;
4360 std::string gdb_type;
4361 ConstString reg_name;
4362 ConstString alt_name;
4363 ConstString set_name;
4364 std::vector<uint32_t> value_regs;
4365 std::vector<uint32_t> invalidate_regs;
4366 std::vector<uint8_t> dwarf_opcode_bytes;
4367 bool encoding_set = false;
4368 bool format_set = false;
4369 RegisterInfo reg_info = {
4370 nullptr, // Name
4371 nullptr, // Alt name
4372 0, // byte size
4373 reg_offset, // offset
4374 eEncodingUint, // encoding
4375 eFormatHex, // format
4376 {
4377 LLDB_INVALID_REGNUM, // eh_frame reg num
4378 LLDB_INVALID_REGNUM, // DWARF reg num
4379 LLDB_INVALID_REGNUM, // generic reg num
4380 reg_num_remote, // process plugin reg num
4381 reg_num_local // native register number
4382 },
4383 nullptr,
4384 nullptr,
4385 nullptr, // Dwarf Expression opcode bytes pointer
4386 0 // Dwarf Expression opcode bytes length
4387 };
4388
4389 reg_node.ForEachAttribute([&target_info, &gdb_group, &gdb_type,
4390 ®_name, &alt_name, &set_name, &value_regs,
4391 &invalidate_regs, &encoding_set, &format_set,
4392 ®_info, ®_offset, &dwarf_opcode_bytes](
4393 const llvm::StringRef &name,
4394 const llvm::StringRef &value) -> bool {
4395 if (name == "name") {
4396 reg_name.SetString(value);
4397 } else if (name == "bitsize") {
4398 reg_info.byte_size =
4399 StringConvert::ToUInt32(value.data(), 0, 0) / CHAR_BIT;
4400 } else if (name == "type") {
4401 gdb_type = value.str();
4402 } else if (name == "group") {
4403 gdb_group = value.str();
4404 } else if (name == "regnum") {
4405 const uint32_t regnum =
4406 StringConvert::ToUInt32(value.data(), LLDB_INVALID_REGNUM, 0);
4407 if (regnum != LLDB_INVALID_REGNUM) {
4408 reg_info.kinds[eRegisterKindProcessPlugin] = regnum;
4409 }
4410 } else if (name == "offset") {
4411 reg_offset = StringConvert::ToUInt32(value.data(), UINT32_MAX, 0);
4412 } else if (name == "altname") {
4413 alt_name.SetString(value);
4414 } else if (name == "encoding") {
4415 encoding_set = true;
4416 reg_info.encoding = Args::StringToEncoding(value, eEncodingUint);
4417 } else if (name == "format") {
4418 format_set = true;
4419 Format format = eFormatInvalid;
4420 if (OptionArgParser::ToFormat(value.data(), format, nullptr)
4421 .Success())
4422 reg_info.format = format;
4423 else if (value == "vector-sint8")
4424 reg_info.format = eFormatVectorOfSInt8;
4425 else if (value == "vector-uint8")
4426 reg_info.format = eFormatVectorOfUInt8;
4427 else if (value == "vector-sint16")
4428 reg_info.format = eFormatVectorOfSInt16;
4429 else if (value == "vector-uint16")
4430 reg_info.format = eFormatVectorOfUInt16;
4431 else if (value == "vector-sint32")
4432 reg_info.format = eFormatVectorOfSInt32;
4433 else if (value == "vector-uint32")
4434 reg_info.format = eFormatVectorOfUInt32;
4435 else if (value == "vector-float32")
4436 reg_info.format = eFormatVectorOfFloat32;
4437 else if (value == "vector-uint64")
4438 reg_info.format = eFormatVectorOfUInt64;
4439 else if (value == "vector-uint128")
4440 reg_info.format = eFormatVectorOfUInt128;
4441 } else if (name == "group_id") {
4442 const uint32_t set_id =
4443 StringConvert::ToUInt32(value.data(), UINT32_MAX, 0);
4444 RegisterSetMap::const_iterator pos =
4445 target_info.reg_set_map.find(set_id);
4446 if (pos != target_info.reg_set_map.end())
4447 set_name = pos->second.name;
4448 } else if (name == "gcc_regnum" || name == "ehframe_regnum") {
4449 reg_info.kinds[eRegisterKindEHFrame] =
4450 StringConvert::ToUInt32(value.data(), LLDB_INVALID_REGNUM, 0);
4451 } else if (name == "dwarf_regnum") {
4452 reg_info.kinds[eRegisterKindDWARF] =
4453 StringConvert::ToUInt32(value.data(), LLDB_INVALID_REGNUM, 0);
4454 } else if (name == "generic") {
4455 reg_info.kinds[eRegisterKindGeneric] =
4456 Args::StringToGenericRegister(value);
4457 } else if (name == "value_regnums") {
4458 SplitCommaSeparatedRegisterNumberString(value, value_regs, 0);
4459 } else if (name == "invalidate_regnums") {
4460 SplitCommaSeparatedRegisterNumberString(value, invalidate_regs, 0);
4461 } else if (name == "dynamic_size_dwarf_expr_bytes") {
4462 std::string opcode_string = value.str();
4463 size_t dwarf_opcode_len = opcode_string.length() / 2;
4464 assert(dwarf_opcode_len > 0);
4465
4466 dwarf_opcode_bytes.resize(dwarf_opcode_len);
4467 reg_info.dynamic_size_dwarf_len = dwarf_opcode_len;
4468 StringExtractor opcode_extractor(opcode_string);
4469 uint32_t ret_val =
4470 opcode_extractor.GetHexBytesAvail(dwarf_opcode_bytes);
4471 assert(dwarf_opcode_len == ret_val);
4472 UNUSED_IF_ASSERT_DISABLED(ret_val);
4473 reg_info.dynamic_size_dwarf_expr_bytes = dwarf_opcode_bytes.data();
4474 } else {
4475 printf("unhandled attribute %s = %s\n", name.data(), value.data());
4476 }
4477 return true; // Keep iterating through all attributes
4478 });
4479
4480 if (!gdb_type.empty() && !(encoding_set || format_set)) {
4481 if (llvm::StringRef(gdb_type).startswith("int")) {
4482 reg_info.format = eFormatHex;
4483 reg_info.encoding = eEncodingUint;
4484 } else if (gdb_type == "data_ptr" || gdb_type == "code_ptr") {
4485 reg_info.format = eFormatAddressInfo;
4486 reg_info.encoding = eEncodingUint;
4487 } else if (gdb_type == "i387_ext" || gdb_type == "float") {
4488 reg_info.format = eFormatFloat;
4489 reg_info.encoding = eEncodingIEEE754;
4490 }
4491 }
4492
4493 // Only update the register set name if we didn't get a "reg_set"
4494 // attribute. "set_name" will be empty if we didn't have a "reg_set"
4495 // attribute.
4496 if (!set_name) {
4497 if (!gdb_group.empty()) {
4498 set_name.SetCString(gdb_group.c_str());
4499 } else {
4500 // If no register group name provided anywhere,
4501 // we'll create a 'general' register set
4502 set_name.SetCString("general");
4503 }
4504 }
4505
4506 reg_info.byte_offset = reg_offset;
4507 assert(reg_info.byte_size != 0);
4508 reg_offset = LLDB_INVALID_INDEX32;
4509 if (!value_regs.empty()) {
4510 value_regs.push_back(LLDB_INVALID_REGNUM);
4511 reg_info.value_regs = value_regs.data();
4512 }
4513 if (!invalidate_regs.empty()) {
4514 invalidate_regs.push_back(LLDB_INVALID_REGNUM);
4515 reg_info.invalidate_regs = invalidate_regs.data();
4516 }
4517
4518 reg_num_remote = reg_info.kinds[eRegisterKindProcessPlugin] + 1;
4519 ++reg_num_local;
4520 reg_info.name = reg_name.AsCString();
4521 if (abi_sp)
4522 abi_sp->AugmentRegisterInfo(reg_info);
4523 dyn_reg_info.AddRegister(reg_info, reg_name, alt_name, set_name);
4524
4525 return true; // Keep iterating through all "reg" elements
4526 });
4527 return true;
4528 }
4529
4530 } // namespace
4531
4532 // This method fetches a register description feature xml file from
4533 // the remote stub and adds registers/register groupsets/architecture
4534 // information to the current process. It will call itself recursively
4535 // for nested register definition files. It returns true if it was able
4536 // to fetch and parse an xml file.
GetGDBServerRegisterInfoXMLAndProcess(ArchSpec & arch_to_use,std::string xml_filename,uint32_t & reg_num_remote,uint32_t & reg_num_local)4537 bool ProcessGDBRemote::GetGDBServerRegisterInfoXMLAndProcess(
4538 ArchSpec &arch_to_use, std::string xml_filename, uint32_t ®_num_remote,
4539 uint32_t ®_num_local) {
4540 // request the target xml file
4541 std::string raw;
4542 lldb_private::Status lldberr;
4543 if (!m_gdb_comm.ReadExtFeature(ConstString("features"),
4544 ConstString(xml_filename.c_str()), raw,
4545 lldberr)) {
4546 return false;
4547 }
4548
4549 XMLDocument xml_document;
4550
4551 if (xml_document.ParseMemory(raw.c_str(), raw.size(), xml_filename.c_str())) {
4552 GdbServerTargetInfo target_info;
4553 std::vector<XMLNode> feature_nodes;
4554
4555 // The top level feature XML file will start with a <target> tag.
4556 XMLNode target_node = xml_document.GetRootElement("target");
4557 if (target_node) {
4558 target_node.ForEachChildElement([&target_info, &feature_nodes](
4559 const XMLNode &node) -> bool {
4560 llvm::StringRef name = node.GetName();
4561 if (name == "architecture") {
4562 node.GetElementText(target_info.arch);
4563 } else if (name == "osabi") {
4564 node.GetElementText(target_info.osabi);
4565 } else if (name == "xi:include" || name == "include") {
4566 llvm::StringRef href = node.GetAttributeValue("href");
4567 if (!href.empty())
4568 target_info.includes.push_back(href.str());
4569 } else if (name == "feature") {
4570 feature_nodes.push_back(node);
4571 } else if (name == "groups") {
4572 node.ForEachChildElementWithName(
4573 "group", [&target_info](const XMLNode &node) -> bool {
4574 uint32_t set_id = UINT32_MAX;
4575 RegisterSetInfo set_info;
4576
4577 node.ForEachAttribute(
4578 [&set_id, &set_info](const llvm::StringRef &name,
4579 const llvm::StringRef &value) -> bool {
4580 if (name == "id")
4581 set_id = StringConvert::ToUInt32(value.data(),
4582 UINT32_MAX, 0);
4583 if (name == "name")
4584 set_info.name = ConstString(value);
4585 return true; // Keep iterating through all attributes
4586 });
4587
4588 if (set_id != UINT32_MAX)
4589 target_info.reg_set_map[set_id] = set_info;
4590 return true; // Keep iterating through all "group" elements
4591 });
4592 }
4593 return true; // Keep iterating through all children of the target_node
4594 });
4595 } else {
4596 // In an included XML feature file, we're already "inside" the <target>
4597 // tag of the initial XML file; this included file will likely only have
4598 // a <feature> tag. Need to check for any more included files in this
4599 // <feature> element.
4600 XMLNode feature_node = xml_document.GetRootElement("feature");
4601 if (feature_node) {
4602 feature_nodes.push_back(feature_node);
4603 feature_node.ForEachChildElement([&target_info](
4604 const XMLNode &node) -> bool {
4605 llvm::StringRef name = node.GetName();
4606 if (name == "xi:include" || name == "include") {
4607 llvm::StringRef href = node.GetAttributeValue("href");
4608 if (!href.empty())
4609 target_info.includes.push_back(href.str());
4610 }
4611 return true;
4612 });
4613 }
4614 }
4615
4616 // If the target.xml includes an architecture entry like
4617 // <architecture>i386:x86-64</architecture> (seen from VMWare ESXi)
4618 // <architecture>arm</architecture> (seen from Segger JLink on unspecified arm board)
4619 // use that if we don't have anything better.
4620 if (!arch_to_use.IsValid() && !target_info.arch.empty()) {
4621 if (target_info.arch == "i386:x86-64") {
4622 // We don't have any information about vendor or OS.
4623 arch_to_use.SetTriple("x86_64--");
4624 GetTarget().MergeArchitecture(arch_to_use);
4625 }
4626
4627 // SEGGER J-Link jtag boards send this very-generic arch name,
4628 // we'll need to use this if we have absolutely nothing better
4629 // to work with or the register definitions won't be accepted.
4630 if (target_info.arch == "arm") {
4631 arch_to_use.SetTriple("arm--");
4632 GetTarget().MergeArchitecture(arch_to_use);
4633 }
4634 }
4635
4636 if (arch_to_use.IsValid()) {
4637 // Don't use Process::GetABI, this code gets called from DidAttach, and
4638 // in that context we haven't set the Target's architecture yet, so the
4639 // ABI is also potentially incorrect.
4640 ABISP abi_to_use_sp = ABI::FindPlugin(shared_from_this(), arch_to_use);
4641 for (auto &feature_node : feature_nodes) {
4642 ParseRegisters(feature_node, target_info, *this->m_register_info_sp,
4643 abi_to_use_sp, reg_num_remote, reg_num_local);
4644 }
4645
4646 for (const auto &include : target_info.includes) {
4647 GetGDBServerRegisterInfoXMLAndProcess(arch_to_use, include,
4648 reg_num_remote, reg_num_local);
4649 }
4650 }
4651 } else {
4652 return false;
4653 }
4654 return true;
4655 }
4656
4657 // query the target of gdb-remote for extended target information returns
4658 // true on success (got register definitions), false on failure (did not).
GetGDBServerRegisterInfo(ArchSpec & arch_to_use)4659 bool ProcessGDBRemote::GetGDBServerRegisterInfo(ArchSpec &arch_to_use) {
4660 // Make sure LLDB has an XML parser it can use first
4661 if (!XMLDocument::XMLEnabled())
4662 return false;
4663
4664 // check that we have extended feature read support
4665 if (!m_gdb_comm.GetQXferFeaturesReadSupported())
4666 return false;
4667
4668 uint32_t reg_num_remote = 0;
4669 uint32_t reg_num_local = 0;
4670 if (GetGDBServerRegisterInfoXMLAndProcess(arch_to_use, "target.xml",
4671 reg_num_remote, reg_num_local))
4672 this->m_register_info_sp->Finalize(arch_to_use);
4673
4674 return m_register_info_sp->GetNumRegisters() > 0;
4675 }
4676
GetLoadedModuleList()4677 llvm::Expected<LoadedModuleInfoList> ProcessGDBRemote::GetLoadedModuleList() {
4678 // Make sure LLDB has an XML parser it can use first
4679 if (!XMLDocument::XMLEnabled())
4680 return llvm::createStringError(llvm::inconvertibleErrorCode(),
4681 "XML parsing not available");
4682
4683 Log *log = GetLogIfAnyCategoriesSet(LIBLLDB_LOG_PROCESS);
4684 LLDB_LOGF(log, "ProcessGDBRemote::%s", __FUNCTION__);
4685
4686 LoadedModuleInfoList list;
4687 GDBRemoteCommunicationClient &comm = m_gdb_comm;
4688 bool can_use_svr4 = GetGlobalPluginProperties()->GetUseSVR4();
4689
4690 // check that we have extended feature read support
4691 if (can_use_svr4 && comm.GetQXferLibrariesSVR4ReadSupported()) {
4692 // request the loaded library list
4693 std::string raw;
4694 lldb_private::Status lldberr;
4695
4696 if (!comm.ReadExtFeature(ConstString("libraries-svr4"), ConstString(""),
4697 raw, lldberr))
4698 return llvm::createStringError(llvm::inconvertibleErrorCode(),
4699 "Error in libraries-svr4 packet");
4700
4701 // parse the xml file in memory
4702 LLDB_LOGF(log, "parsing: %s", raw.c_str());
4703 XMLDocument doc;
4704
4705 if (!doc.ParseMemory(raw.c_str(), raw.size(), "noname.xml"))
4706 return llvm::createStringError(llvm::inconvertibleErrorCode(),
4707 "Error reading noname.xml");
4708
4709 XMLNode root_element = doc.GetRootElement("library-list-svr4");
4710 if (!root_element)
4711 return llvm::createStringError(
4712 llvm::inconvertibleErrorCode(),
4713 "Error finding library-list-svr4 xml element");
4714
4715 // main link map structure
4716 llvm::StringRef main_lm = root_element.GetAttributeValue("main-lm");
4717 if (!main_lm.empty()) {
4718 list.m_link_map =
4719 StringConvert::ToUInt64(main_lm.data(), LLDB_INVALID_ADDRESS, 0);
4720 }
4721
4722 root_element.ForEachChildElementWithName(
4723 "library", [log, &list](const XMLNode &library) -> bool {
4724
4725 LoadedModuleInfoList::LoadedModuleInfo module;
4726
4727 library.ForEachAttribute(
4728 [&module](const llvm::StringRef &name,
4729 const llvm::StringRef &value) -> bool {
4730
4731 if (name == "name")
4732 module.set_name(value.str());
4733 else if (name == "lm") {
4734 // the address of the link_map struct.
4735 module.set_link_map(StringConvert::ToUInt64(
4736 value.data(), LLDB_INVALID_ADDRESS, 0));
4737 } else if (name == "l_addr") {
4738 // the displacement as read from the field 'l_addr' of the
4739 // link_map struct.
4740 module.set_base(StringConvert::ToUInt64(
4741 value.data(), LLDB_INVALID_ADDRESS, 0));
4742 // base address is always a displacement, not an absolute
4743 // value.
4744 module.set_base_is_offset(true);
4745 } else if (name == "l_ld") {
4746 // the memory address of the libraries PT_DYNAMIC section.
4747 module.set_dynamic(StringConvert::ToUInt64(
4748 value.data(), LLDB_INVALID_ADDRESS, 0));
4749 }
4750
4751 return true; // Keep iterating over all properties of "library"
4752 });
4753
4754 if (log) {
4755 std::string name;
4756 lldb::addr_t lm = 0, base = 0, ld = 0;
4757 bool base_is_offset;
4758
4759 module.get_name(name);
4760 module.get_link_map(lm);
4761 module.get_base(base);
4762 module.get_base_is_offset(base_is_offset);
4763 module.get_dynamic(ld);
4764
4765 LLDB_LOGF(log,
4766 "found (link_map:0x%08" PRIx64 ", base:0x%08" PRIx64
4767 "[%s], ld:0x%08" PRIx64 ", name:'%s')",
4768 lm, base, (base_is_offset ? "offset" : "absolute"), ld,
4769 name.c_str());
4770 }
4771
4772 list.add(module);
4773 return true; // Keep iterating over all "library" elements in the root
4774 // node
4775 });
4776
4777 if (log)
4778 LLDB_LOGF(log, "found %" PRId32 " modules in total",
4779 (int)list.m_list.size());
4780 return list;
4781 } else if (comm.GetQXferLibrariesReadSupported()) {
4782 // request the loaded library list
4783 std::string raw;
4784 lldb_private::Status lldberr;
4785
4786 if (!comm.ReadExtFeature(ConstString("libraries"), ConstString(""), raw,
4787 lldberr))
4788 return llvm::createStringError(llvm::inconvertibleErrorCode(),
4789 "Error in libraries packet");
4790
4791 LLDB_LOGF(log, "parsing: %s", raw.c_str());
4792 XMLDocument doc;
4793
4794 if (!doc.ParseMemory(raw.c_str(), raw.size(), "noname.xml"))
4795 return llvm::createStringError(llvm::inconvertibleErrorCode(),
4796 "Error reading noname.xml");
4797
4798 XMLNode root_element = doc.GetRootElement("library-list");
4799 if (!root_element)
4800 return llvm::createStringError(llvm::inconvertibleErrorCode(),
4801 "Error finding library-list xml element");
4802
4803 root_element.ForEachChildElementWithName(
4804 "library", [log, &list](const XMLNode &library) -> bool {
4805 LoadedModuleInfoList::LoadedModuleInfo module;
4806
4807 llvm::StringRef name = library.GetAttributeValue("name");
4808 module.set_name(name.str());
4809
4810 // The base address of a given library will be the address of its
4811 // first section. Most remotes send only one section for Windows
4812 // targets for example.
4813 const XMLNode §ion =
4814 library.FindFirstChildElementWithName("section");
4815 llvm::StringRef address = section.GetAttributeValue("address");
4816 module.set_base(
4817 StringConvert::ToUInt64(address.data(), LLDB_INVALID_ADDRESS, 0));
4818 // These addresses are absolute values.
4819 module.set_base_is_offset(false);
4820
4821 if (log) {
4822 std::string name;
4823 lldb::addr_t base = 0;
4824 bool base_is_offset;
4825 module.get_name(name);
4826 module.get_base(base);
4827 module.get_base_is_offset(base_is_offset);
4828
4829 LLDB_LOGF(log, "found (base:0x%08" PRIx64 "[%s], name:'%s')", base,
4830 (base_is_offset ? "offset" : "absolute"), name.c_str());
4831 }
4832
4833 list.add(module);
4834 return true; // Keep iterating over all "library" elements in the root
4835 // node
4836 });
4837
4838 if (log)
4839 LLDB_LOGF(log, "found %" PRId32 " modules in total",
4840 (int)list.m_list.size());
4841 return list;
4842 } else {
4843 return llvm::createStringError(llvm::inconvertibleErrorCode(),
4844 "Remote libraries not supported");
4845 }
4846 }
4847
LoadModuleAtAddress(const FileSpec & file,lldb::addr_t link_map,lldb::addr_t base_addr,bool value_is_offset)4848 lldb::ModuleSP ProcessGDBRemote::LoadModuleAtAddress(const FileSpec &file,
4849 lldb::addr_t link_map,
4850 lldb::addr_t base_addr,
4851 bool value_is_offset) {
4852 DynamicLoader *loader = GetDynamicLoader();
4853 if (!loader)
4854 return nullptr;
4855
4856 return loader->LoadModuleAtAddress(file, link_map, base_addr,
4857 value_is_offset);
4858 }
4859
LoadModules()4860 llvm::Error ProcessGDBRemote::LoadModules() {
4861 using lldb_private::process_gdb_remote::ProcessGDBRemote;
4862
4863 // request a list of loaded libraries from GDBServer
4864 llvm::Expected<LoadedModuleInfoList> module_list = GetLoadedModuleList();
4865 if (!module_list)
4866 return module_list.takeError();
4867
4868 // get a list of all the modules
4869 ModuleList new_modules;
4870
4871 for (LoadedModuleInfoList::LoadedModuleInfo &modInfo : module_list->m_list) {
4872 std::string mod_name;
4873 lldb::addr_t mod_base;
4874 lldb::addr_t link_map;
4875 bool mod_base_is_offset;
4876
4877 bool valid = true;
4878 valid &= modInfo.get_name(mod_name);
4879 valid &= modInfo.get_base(mod_base);
4880 valid &= modInfo.get_base_is_offset(mod_base_is_offset);
4881 if (!valid)
4882 continue;
4883
4884 if (!modInfo.get_link_map(link_map))
4885 link_map = LLDB_INVALID_ADDRESS;
4886
4887 FileSpec file(mod_name);
4888 FileSystem::Instance().Resolve(file);
4889 lldb::ModuleSP module_sp =
4890 LoadModuleAtAddress(file, link_map, mod_base, mod_base_is_offset);
4891
4892 if (module_sp.get())
4893 new_modules.Append(module_sp);
4894 }
4895
4896 if (new_modules.GetSize() > 0) {
4897 ModuleList removed_modules;
4898 Target &target = GetTarget();
4899 ModuleList &loaded_modules = m_process->GetTarget().GetImages();
4900
4901 for (size_t i = 0; i < loaded_modules.GetSize(); ++i) {
4902 const lldb::ModuleSP loaded_module = loaded_modules.GetModuleAtIndex(i);
4903
4904 bool found = false;
4905 for (size_t j = 0; j < new_modules.GetSize(); ++j) {
4906 if (new_modules.GetModuleAtIndex(j).get() == loaded_module.get())
4907 found = true;
4908 }
4909
4910 // The main executable will never be included in libraries-svr4, don't
4911 // remove it
4912 if (!found &&
4913 loaded_module.get() != target.GetExecutableModulePointer()) {
4914 removed_modules.Append(loaded_module);
4915 }
4916 }
4917
4918 loaded_modules.Remove(removed_modules);
4919 m_process->GetTarget().ModulesDidUnload(removed_modules, false);
4920
4921 new_modules.ForEach([&target](const lldb::ModuleSP module_sp) -> bool {
4922 lldb_private::ObjectFile *obj = module_sp->GetObjectFile();
4923 if (!obj)
4924 return true;
4925
4926 if (obj->GetType() != ObjectFile::Type::eTypeExecutable)
4927 return true;
4928
4929 lldb::ModuleSP module_copy_sp = module_sp;
4930 target.SetExecutableModule(module_copy_sp, eLoadDependentsNo);
4931 return false;
4932 });
4933
4934 loaded_modules.AppendIfNeeded(new_modules);
4935 m_process->GetTarget().ModulesDidLoad(new_modules);
4936 }
4937
4938 return llvm::ErrorSuccess();
4939 }
4940
GetFileLoadAddress(const FileSpec & file,bool & is_loaded,lldb::addr_t & load_addr)4941 Status ProcessGDBRemote::GetFileLoadAddress(const FileSpec &file,
4942 bool &is_loaded,
4943 lldb::addr_t &load_addr) {
4944 is_loaded = false;
4945 load_addr = LLDB_INVALID_ADDRESS;
4946
4947 std::string file_path = file.GetPath(false);
4948 if (file_path.empty())
4949 return Status("Empty file name specified");
4950
4951 StreamString packet;
4952 packet.PutCString("qFileLoadAddress:");
4953 packet.PutStringAsRawHex8(file_path);
4954
4955 StringExtractorGDBRemote response;
4956 if (m_gdb_comm.SendPacketAndWaitForResponse(packet.GetString(), response) !=
4957 GDBRemoteCommunication::PacketResult::Success)
4958 return Status("Sending qFileLoadAddress packet failed");
4959
4960 if (response.IsErrorResponse()) {
4961 if (response.GetError() == 1) {
4962 // The file is not loaded into the inferior
4963 is_loaded = false;
4964 load_addr = LLDB_INVALID_ADDRESS;
4965 return Status();
4966 }
4967
4968 return Status(
4969 "Fetching file load address from remote server returned an error");
4970 }
4971
4972 if (response.IsNormalResponse()) {
4973 is_loaded = true;
4974 load_addr = response.GetHexMaxU64(false, LLDB_INVALID_ADDRESS);
4975 return Status();
4976 }
4977
4978 return Status(
4979 "Unknown error happened during sending the load address packet");
4980 }
4981
ModulesDidLoad(ModuleList & module_list)4982 void ProcessGDBRemote::ModulesDidLoad(ModuleList &module_list) {
4983 // We must call the lldb_private::Process::ModulesDidLoad () first before we
4984 // do anything
4985 Process::ModulesDidLoad(module_list);
4986
4987 // After loading shared libraries, we can ask our remote GDB server if it
4988 // needs any symbols.
4989 m_gdb_comm.ServeSymbolLookups(this);
4990 }
4991
HandleAsyncStdout(llvm::StringRef out)4992 void ProcessGDBRemote::HandleAsyncStdout(llvm::StringRef out) {
4993 AppendSTDOUT(out.data(), out.size());
4994 }
4995
4996 static const char *end_delimiter = "--end--;";
4997 static const int end_delimiter_len = 8;
4998
HandleAsyncMisc(llvm::StringRef data)4999 void ProcessGDBRemote::HandleAsyncMisc(llvm::StringRef data) {
5000 std::string input = data.str(); // '1' to move beyond 'A'
5001 if (m_partial_profile_data.length() > 0) {
5002 m_partial_profile_data.append(input);
5003 input = m_partial_profile_data;
5004 m_partial_profile_data.clear();
5005 }
5006
5007 size_t found, pos = 0, len = input.length();
5008 while ((found = input.find(end_delimiter, pos)) != std::string::npos) {
5009 StringExtractorGDBRemote profileDataExtractor(
5010 input.substr(pos, found).c_str());
5011 std::string profile_data =
5012 HarmonizeThreadIdsForProfileData(profileDataExtractor);
5013 BroadcastAsyncProfileData(profile_data);
5014
5015 pos = found + end_delimiter_len;
5016 }
5017
5018 if (pos < len) {
5019 // Last incomplete chunk.
5020 m_partial_profile_data = input.substr(pos);
5021 }
5022 }
5023
HarmonizeThreadIdsForProfileData(StringExtractorGDBRemote & profileDataExtractor)5024 std::string ProcessGDBRemote::HarmonizeThreadIdsForProfileData(
5025 StringExtractorGDBRemote &profileDataExtractor) {
5026 std::map<uint64_t, uint32_t> new_thread_id_to_used_usec_map;
5027 std::string output;
5028 llvm::raw_string_ostream output_stream(output);
5029 llvm::StringRef name, value;
5030
5031 // Going to assuming thread_used_usec comes first, else bail out.
5032 while (profileDataExtractor.GetNameColonValue(name, value)) {
5033 if (name.compare("thread_used_id") == 0) {
5034 StringExtractor threadIDHexExtractor(value);
5035 uint64_t thread_id = threadIDHexExtractor.GetHexMaxU64(false, 0);
5036
5037 bool has_used_usec = false;
5038 uint32_t curr_used_usec = 0;
5039 llvm::StringRef usec_name, usec_value;
5040 uint32_t input_file_pos = profileDataExtractor.GetFilePos();
5041 if (profileDataExtractor.GetNameColonValue(usec_name, usec_value)) {
5042 if (usec_name.equals("thread_used_usec")) {
5043 has_used_usec = true;
5044 usec_value.getAsInteger(0, curr_used_usec);
5045 } else {
5046 // We didn't find what we want, it is probably an older version. Bail
5047 // out.
5048 profileDataExtractor.SetFilePos(input_file_pos);
5049 }
5050 }
5051
5052 if (has_used_usec) {
5053 uint32_t prev_used_usec = 0;
5054 std::map<uint64_t, uint32_t>::iterator iterator =
5055 m_thread_id_to_used_usec_map.find(thread_id);
5056 if (iterator != m_thread_id_to_used_usec_map.end()) {
5057 prev_used_usec = m_thread_id_to_used_usec_map[thread_id];
5058 }
5059
5060 uint32_t real_used_usec = curr_used_usec - prev_used_usec;
5061 // A good first time record is one that runs for at least 0.25 sec
5062 bool good_first_time =
5063 (prev_used_usec == 0) && (real_used_usec > 250000);
5064 bool good_subsequent_time =
5065 (prev_used_usec > 0) &&
5066 ((real_used_usec > 0) || (HasAssignedIndexIDToThread(thread_id)));
5067
5068 if (good_first_time || good_subsequent_time) {
5069 // We try to avoid doing too many index id reservation, resulting in
5070 // fast increase of index ids.
5071
5072 output_stream << name << ":";
5073 int32_t index_id = AssignIndexIDToThread(thread_id);
5074 output_stream << index_id << ";";
5075
5076 output_stream << usec_name << ":" << usec_value << ";";
5077 } else {
5078 // Skip past 'thread_used_name'.
5079 llvm::StringRef local_name, local_value;
5080 profileDataExtractor.GetNameColonValue(local_name, local_value);
5081 }
5082
5083 // Store current time as previous time so that they can be compared
5084 // later.
5085 new_thread_id_to_used_usec_map[thread_id] = curr_used_usec;
5086 } else {
5087 // Bail out and use old string.
5088 output_stream << name << ":" << value << ";";
5089 }
5090 } else {
5091 output_stream << name << ":" << value << ";";
5092 }
5093 }
5094 output_stream << end_delimiter;
5095 m_thread_id_to_used_usec_map = new_thread_id_to_used_usec_map;
5096
5097 return output_stream.str();
5098 }
5099
HandleStopReply()5100 void ProcessGDBRemote::HandleStopReply() {
5101 if (GetStopID() != 0)
5102 return;
5103
5104 if (GetID() == LLDB_INVALID_PROCESS_ID) {
5105 lldb::pid_t pid = m_gdb_comm.GetCurrentProcessID();
5106 if (pid != LLDB_INVALID_PROCESS_ID)
5107 SetID(pid);
5108 }
5109 BuildDynamicRegisterInfo(true);
5110 }
5111
5112 static const char *const s_async_json_packet_prefix = "JSON-async:";
5113
5114 static StructuredData::ObjectSP
ParseStructuredDataPacket(llvm::StringRef packet)5115 ParseStructuredDataPacket(llvm::StringRef packet) {
5116 Log *log(ProcessGDBRemoteLog::GetLogIfAllCategoriesSet(GDBR_LOG_PROCESS));
5117
5118 if (!packet.consume_front(s_async_json_packet_prefix)) {
5119 if (log) {
5120 LLDB_LOGF(
5121 log,
5122 "GDBRemoteCommunicationClientBase::%s() received $J packet "
5123 "but was not a StructuredData packet: packet starts with "
5124 "%s",
5125 __FUNCTION__,
5126 packet.slice(0, strlen(s_async_json_packet_prefix)).str().c_str());
5127 }
5128 return StructuredData::ObjectSP();
5129 }
5130
5131 // This is an asynchronous JSON packet, destined for a StructuredDataPlugin.
5132 StructuredData::ObjectSP json_sp =
5133 StructuredData::ParseJSON(std::string(packet));
5134 if (log) {
5135 if (json_sp) {
5136 StreamString json_str;
5137 json_sp->Dump(json_str, true);
5138 json_str.Flush();
5139 LLDB_LOGF(log,
5140 "ProcessGDBRemote::%s() "
5141 "received Async StructuredData packet: %s",
5142 __FUNCTION__, json_str.GetData());
5143 } else {
5144 LLDB_LOGF(log,
5145 "ProcessGDBRemote::%s"
5146 "() received StructuredData packet:"
5147 " parse failure",
5148 __FUNCTION__);
5149 }
5150 }
5151 return json_sp;
5152 }
5153
HandleAsyncStructuredDataPacket(llvm::StringRef data)5154 void ProcessGDBRemote::HandleAsyncStructuredDataPacket(llvm::StringRef data) {
5155 auto structured_data_sp = ParseStructuredDataPacket(data);
5156 if (structured_data_sp)
5157 RouteAsyncStructuredData(structured_data_sp);
5158 }
5159
5160 class CommandObjectProcessGDBRemoteSpeedTest : public CommandObjectParsed {
5161 public:
CommandObjectProcessGDBRemoteSpeedTest(CommandInterpreter & interpreter)5162 CommandObjectProcessGDBRemoteSpeedTest(CommandInterpreter &interpreter)
5163 : CommandObjectParsed(interpreter, "process plugin packet speed-test",
5164 "Tests packet speeds of various sizes to determine "
5165 "the performance characteristics of the GDB remote "
5166 "connection. ",
5167 nullptr),
5168 m_option_group(),
5169 m_num_packets(LLDB_OPT_SET_1, false, "count", 'c', 0, eArgTypeCount,
5170 "The number of packets to send of each varying size "
5171 "(default is 1000).",
5172 1000),
5173 m_max_send(LLDB_OPT_SET_1, false, "max-send", 's', 0, eArgTypeCount,
5174 "The maximum number of bytes to send in a packet. Sizes "
5175 "increase in powers of 2 while the size is less than or "
5176 "equal to this option value. (default 1024).",
5177 1024),
5178 m_max_recv(LLDB_OPT_SET_1, false, "max-receive", 'r', 0, eArgTypeCount,
5179 "The maximum number of bytes to receive in a packet. Sizes "
5180 "increase in powers of 2 while the size is less than or "
5181 "equal to this option value. (default 1024).",
5182 1024),
5183 m_json(LLDB_OPT_SET_1, false, "json", 'j',
5184 "Print the output as JSON data for easy parsing.", false, true) {
5185 m_option_group.Append(&m_num_packets, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1);
5186 m_option_group.Append(&m_max_send, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1);
5187 m_option_group.Append(&m_max_recv, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1);
5188 m_option_group.Append(&m_json, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1);
5189 m_option_group.Finalize();
5190 }
5191
5192 ~CommandObjectProcessGDBRemoteSpeedTest() override = default;
5193
GetOptions()5194 Options *GetOptions() override { return &m_option_group; }
5195
DoExecute(Args & command,CommandReturnObject & result)5196 bool DoExecute(Args &command, CommandReturnObject &result) override {
5197 const size_t argc = command.GetArgumentCount();
5198 if (argc == 0) {
5199 ProcessGDBRemote *process =
5200 (ProcessGDBRemote *)m_interpreter.GetExecutionContext()
5201 .GetProcessPtr();
5202 if (process) {
5203 StreamSP output_stream_sp(
5204 m_interpreter.GetDebugger().GetAsyncOutputStream());
5205 result.SetImmediateOutputStream(output_stream_sp);
5206
5207 const uint32_t num_packets =
5208 (uint32_t)m_num_packets.GetOptionValue().GetCurrentValue();
5209 const uint64_t max_send = m_max_send.GetOptionValue().GetCurrentValue();
5210 const uint64_t max_recv = m_max_recv.GetOptionValue().GetCurrentValue();
5211 const bool json = m_json.GetOptionValue().GetCurrentValue();
5212 const uint64_t k_recv_amount =
5213 4 * 1024 * 1024; // Receive amount in bytes
5214 process->GetGDBRemote().TestPacketSpeed(
5215 num_packets, max_send, max_recv, k_recv_amount, json,
5216 output_stream_sp ? *output_stream_sp : result.GetOutputStream());
5217 result.SetStatus(eReturnStatusSuccessFinishResult);
5218 return true;
5219 }
5220 } else {
5221 result.AppendErrorWithFormat("'%s' takes no arguments",
5222 m_cmd_name.c_str());
5223 }
5224 result.SetStatus(eReturnStatusFailed);
5225 return false;
5226 }
5227
5228 protected:
5229 OptionGroupOptions m_option_group;
5230 OptionGroupUInt64 m_num_packets;
5231 OptionGroupUInt64 m_max_send;
5232 OptionGroupUInt64 m_max_recv;
5233 OptionGroupBoolean m_json;
5234 };
5235
5236 class CommandObjectProcessGDBRemotePacketHistory : public CommandObjectParsed {
5237 private:
5238 public:
CommandObjectProcessGDBRemotePacketHistory(CommandInterpreter & interpreter)5239 CommandObjectProcessGDBRemotePacketHistory(CommandInterpreter &interpreter)
5240 : CommandObjectParsed(interpreter, "process plugin packet history",
5241 "Dumps the packet history buffer. ", nullptr) {}
5242
5243 ~CommandObjectProcessGDBRemotePacketHistory() override = default;
5244
DoExecute(Args & command,CommandReturnObject & result)5245 bool DoExecute(Args &command, CommandReturnObject &result) override {
5246 const size_t argc = command.GetArgumentCount();
5247 if (argc == 0) {
5248 ProcessGDBRemote *process =
5249 (ProcessGDBRemote *)m_interpreter.GetExecutionContext()
5250 .GetProcessPtr();
5251 if (process) {
5252 process->GetGDBRemote().DumpHistory(result.GetOutputStream());
5253 result.SetStatus(eReturnStatusSuccessFinishResult);
5254 return true;
5255 }
5256 } else {
5257 result.AppendErrorWithFormat("'%s' takes no arguments",
5258 m_cmd_name.c_str());
5259 }
5260 result.SetStatus(eReturnStatusFailed);
5261 return false;
5262 }
5263 };
5264
5265 class CommandObjectProcessGDBRemotePacketXferSize : public CommandObjectParsed {
5266 private:
5267 public:
CommandObjectProcessGDBRemotePacketXferSize(CommandInterpreter & interpreter)5268 CommandObjectProcessGDBRemotePacketXferSize(CommandInterpreter &interpreter)
5269 : CommandObjectParsed(
5270 interpreter, "process plugin packet xfer-size",
5271 "Maximum size that lldb will try to read/write one one chunk.",
5272 nullptr) {}
5273
5274 ~CommandObjectProcessGDBRemotePacketXferSize() override = default;
5275
DoExecute(Args & command,CommandReturnObject & result)5276 bool DoExecute(Args &command, CommandReturnObject &result) override {
5277 const size_t argc = command.GetArgumentCount();
5278 if (argc == 0) {
5279 result.AppendErrorWithFormat("'%s' takes an argument to specify the max "
5280 "amount to be transferred when "
5281 "reading/writing",
5282 m_cmd_name.c_str());
5283 return false;
5284 }
5285
5286 ProcessGDBRemote *process =
5287 (ProcessGDBRemote *)m_interpreter.GetExecutionContext().GetProcessPtr();
5288 if (process) {
5289 const char *packet_size = command.GetArgumentAtIndex(0);
5290 errno = 0;
5291 uint64_t user_specified_max = strtoul(packet_size, nullptr, 10);
5292 if (errno == 0 && user_specified_max != 0) {
5293 process->SetUserSpecifiedMaxMemoryTransferSize(user_specified_max);
5294 result.SetStatus(eReturnStatusSuccessFinishResult);
5295 return true;
5296 }
5297 }
5298 result.SetStatus(eReturnStatusFailed);
5299 return false;
5300 }
5301 };
5302
5303 class CommandObjectProcessGDBRemotePacketSend : public CommandObjectParsed {
5304 private:
5305 public:
CommandObjectProcessGDBRemotePacketSend(CommandInterpreter & interpreter)5306 CommandObjectProcessGDBRemotePacketSend(CommandInterpreter &interpreter)
5307 : CommandObjectParsed(interpreter, "process plugin packet send",
5308 "Send a custom packet through the GDB remote "
5309 "protocol and print the answer. "
5310 "The packet header and footer will automatically "
5311 "be added to the packet prior to sending and "
5312 "stripped from the result.",
5313 nullptr) {}
5314
5315 ~CommandObjectProcessGDBRemotePacketSend() override = default;
5316
DoExecute(Args & command,CommandReturnObject & result)5317 bool DoExecute(Args &command, CommandReturnObject &result) override {
5318 const size_t argc = command.GetArgumentCount();
5319 if (argc == 0) {
5320 result.AppendErrorWithFormat(
5321 "'%s' takes a one or more packet content arguments",
5322 m_cmd_name.c_str());
5323 return false;
5324 }
5325
5326 ProcessGDBRemote *process =
5327 (ProcessGDBRemote *)m_interpreter.GetExecutionContext().GetProcessPtr();
5328 if (process) {
5329 for (size_t i = 0; i < argc; ++i) {
5330 const char *packet_cstr = command.GetArgumentAtIndex(0);
5331 StringExtractorGDBRemote response;
5332 process->GetGDBRemote().SendPacketAndWaitForResponse(
5333 packet_cstr, response, process->GetInterruptTimeout());
5334 result.SetStatus(eReturnStatusSuccessFinishResult);
5335 Stream &output_strm = result.GetOutputStream();
5336 output_strm.Printf(" packet: %s\n", packet_cstr);
5337 std::string response_str = std::string(response.GetStringRef());
5338
5339 if (strstr(packet_cstr, "qGetProfileData") != nullptr) {
5340 response_str = process->HarmonizeThreadIdsForProfileData(response);
5341 }
5342
5343 if (response_str.empty())
5344 output_strm.PutCString("response: \nerror: UNIMPLEMENTED\n");
5345 else
5346 output_strm.Printf("response: %s\n", response.GetStringRef().data());
5347 }
5348 }
5349 return true;
5350 }
5351 };
5352
5353 class CommandObjectProcessGDBRemotePacketMonitor : public CommandObjectRaw {
5354 private:
5355 public:
CommandObjectProcessGDBRemotePacketMonitor(CommandInterpreter & interpreter)5356 CommandObjectProcessGDBRemotePacketMonitor(CommandInterpreter &interpreter)
5357 : CommandObjectRaw(interpreter, "process plugin packet monitor",
5358 "Send a qRcmd packet through the GDB remote protocol "
5359 "and print the response."
5360 "The argument passed to this command will be hex "
5361 "encoded into a valid 'qRcmd' packet, sent and the "
5362 "response will be printed.") {}
5363
5364 ~CommandObjectProcessGDBRemotePacketMonitor() override = default;
5365
DoExecute(llvm::StringRef command,CommandReturnObject & result)5366 bool DoExecute(llvm::StringRef command,
5367 CommandReturnObject &result) override {
5368 if (command.empty()) {
5369 result.AppendErrorWithFormat("'%s' takes a command string argument",
5370 m_cmd_name.c_str());
5371 return false;
5372 }
5373
5374 ProcessGDBRemote *process =
5375 (ProcessGDBRemote *)m_interpreter.GetExecutionContext().GetProcessPtr();
5376 if (process) {
5377 StreamString packet;
5378 packet.PutCString("qRcmd,");
5379 packet.PutBytesAsRawHex8(command.data(), command.size());
5380
5381 StringExtractorGDBRemote response;
5382 Stream &output_strm = result.GetOutputStream();
5383 process->GetGDBRemote().SendPacketAndReceiveResponseWithOutputSupport(
5384 packet.GetString(), response, process->GetInterruptTimeout(),
5385 [&output_strm](llvm::StringRef output) { output_strm << output; });
5386 result.SetStatus(eReturnStatusSuccessFinishResult);
5387 output_strm.Printf(" packet: %s\n", packet.GetData());
5388 const std::string &response_str = std::string(response.GetStringRef());
5389
5390 if (response_str.empty())
5391 output_strm.PutCString("response: \nerror: UNIMPLEMENTED\n");
5392 else
5393 output_strm.Printf("response: %s\n", response.GetStringRef().data());
5394 }
5395 return true;
5396 }
5397 };
5398
5399 class CommandObjectProcessGDBRemotePacket : public CommandObjectMultiword {
5400 private:
5401 public:
CommandObjectProcessGDBRemotePacket(CommandInterpreter & interpreter)5402 CommandObjectProcessGDBRemotePacket(CommandInterpreter &interpreter)
5403 : CommandObjectMultiword(interpreter, "process plugin packet",
5404 "Commands that deal with GDB remote packets.",
5405 nullptr) {
5406 LoadSubCommand(
5407 "history",
5408 CommandObjectSP(
5409 new CommandObjectProcessGDBRemotePacketHistory(interpreter)));
5410 LoadSubCommand(
5411 "send", CommandObjectSP(
5412 new CommandObjectProcessGDBRemotePacketSend(interpreter)));
5413 LoadSubCommand(
5414 "monitor",
5415 CommandObjectSP(
5416 new CommandObjectProcessGDBRemotePacketMonitor(interpreter)));
5417 LoadSubCommand(
5418 "xfer-size",
5419 CommandObjectSP(
5420 new CommandObjectProcessGDBRemotePacketXferSize(interpreter)));
5421 LoadSubCommand("speed-test",
5422 CommandObjectSP(new CommandObjectProcessGDBRemoteSpeedTest(
5423 interpreter)));
5424 }
5425
5426 ~CommandObjectProcessGDBRemotePacket() override = default;
5427 };
5428
5429 class CommandObjectMultiwordProcessGDBRemote : public CommandObjectMultiword {
5430 public:
CommandObjectMultiwordProcessGDBRemote(CommandInterpreter & interpreter)5431 CommandObjectMultiwordProcessGDBRemote(CommandInterpreter &interpreter)
5432 : CommandObjectMultiword(
5433 interpreter, "process plugin",
5434 "Commands for operating on a ProcessGDBRemote process.",
5435 "process plugin <subcommand> [<subcommand-options>]") {
5436 LoadSubCommand(
5437 "packet",
5438 CommandObjectSP(new CommandObjectProcessGDBRemotePacket(interpreter)));
5439 }
5440
5441 ~CommandObjectMultiwordProcessGDBRemote() override = default;
5442 };
5443
GetPluginCommandObject()5444 CommandObject *ProcessGDBRemote::GetPluginCommandObject() {
5445 if (!m_command_sp)
5446 m_command_sp = std::make_shared<CommandObjectMultiwordProcessGDBRemote>(
5447 GetTarget().GetDebugger().GetCommandInterpreter());
5448 return m_command_sp.get();
5449 }
5450