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