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