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