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