1 //===-- ProcessKDP.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 // C Includes 11 #include <errno.h> 12 #include <stdlib.h> 13 14 // C++ Includes 15 #include <mutex> 16 17 // Other libraries and framework includes 18 #include "lldb/Core/Debugger.h" 19 #include "lldb/Core/PluginManager.h" 20 #include "lldb/Core/Module.h" 21 #include "lldb/Core/ModuleSpec.h" 22 #include "lldb/Core/State.h" 23 #include "lldb/Core/UUID.h" 24 #include "lldb/Host/ConnectionFileDescriptor.h" 25 #include "lldb/Host/Host.h" 26 #include "lldb/Host/Symbols.h" 27 #include "lldb/Host/Socket.h" 28 #include "lldb/Host/ThreadLauncher.h" 29 #include "lldb/Interpreter/CommandInterpreter.h" 30 #include "lldb/Interpreter/CommandObject.h" 31 #include "lldb/Interpreter/CommandObjectMultiword.h" 32 #include "lldb/Interpreter/CommandReturnObject.h" 33 #include "lldb/Interpreter/OptionGroupString.h" 34 #include "lldb/Interpreter/OptionGroupUInt64.h" 35 #include "lldb/Interpreter/OptionValueProperties.h" 36 #include "lldb/Symbol/ObjectFile.h" 37 #include "lldb/Target/RegisterContext.h" 38 #include "lldb/Target/Target.h" 39 #include "lldb/Target/Thread.h" 40 #include "lldb/Utility/StringExtractor.h" 41 42 #define USEC_PER_SEC 1000000 43 44 // Project includes 45 #include "ProcessKDP.h" 46 #include "ProcessKDPLog.h" 47 #include "ThreadKDP.h" 48 #include "Plugins/DynamicLoader/Darwin-Kernel/DynamicLoaderDarwinKernel.h" 49 #include "Plugins/DynamicLoader/Static/DynamicLoaderStatic.h" 50 51 using namespace lldb; 52 using namespace lldb_private; 53 54 namespace { 55 56 static PropertyDefinition 57 g_properties[] = 58 { 59 { "packet-timeout" , OptionValue::eTypeUInt64 , true , 5, NULL, NULL, "Specify the default packet timeout in seconds." }, 60 { NULL , OptionValue::eTypeInvalid, false, 0, NULL, NULL, NULL } 61 }; 62 63 enum 64 { 65 ePropertyPacketTimeout 66 }; 67 68 class PluginProperties : public Properties 69 { 70 public: 71 72 static ConstString 73 GetSettingName () 74 { 75 return ProcessKDP::GetPluginNameStatic(); 76 } 77 78 PluginProperties() : 79 Properties () 80 { 81 m_collection_sp.reset (new OptionValueProperties(GetSettingName())); 82 m_collection_sp->Initialize(g_properties); 83 } 84 85 virtual 86 ~PluginProperties() 87 { 88 } 89 90 uint64_t 91 GetPacketTimeout() 92 { 93 const uint32_t idx = ePropertyPacketTimeout; 94 return m_collection_sp->GetPropertyAtIndexAsUInt64(NULL, idx, g_properties[idx].default_uint_value); 95 } 96 }; 97 98 typedef std::shared_ptr<PluginProperties> ProcessKDPPropertiesSP; 99 100 static const ProcessKDPPropertiesSP & 101 GetGlobalPluginProperties() 102 { 103 static ProcessKDPPropertiesSP g_settings_sp; 104 if (!g_settings_sp) 105 g_settings_sp.reset (new PluginProperties ()); 106 return g_settings_sp; 107 } 108 109 } // anonymous namespace end 110 111 static const lldb::tid_t g_kernel_tid = 1; 112 113 ConstString 114 ProcessKDP::GetPluginNameStatic() 115 { 116 static ConstString g_name("kdp-remote"); 117 return g_name; 118 } 119 120 const char * 121 ProcessKDP::GetPluginDescriptionStatic() 122 { 123 return "KDP Remote protocol based debugging plug-in for darwin kernel debugging."; 124 } 125 126 void 127 ProcessKDP::Terminate() 128 { 129 PluginManager::UnregisterPlugin (ProcessKDP::CreateInstance); 130 } 131 132 133 lldb::ProcessSP 134 ProcessKDP::CreateInstance (Target &target, 135 Listener &listener, 136 const FileSpec *crash_file_path) 137 { 138 lldb::ProcessSP process_sp; 139 if (crash_file_path == NULL) 140 process_sp.reset(new ProcessKDP (target, listener)); 141 return process_sp; 142 } 143 144 bool 145 ProcessKDP::CanDebug(Target &target, bool plugin_specified_by_name) 146 { 147 if (plugin_specified_by_name) 148 return true; 149 150 // For now we are just making sure the file exists for a given module 151 Module *exe_module = target.GetExecutableModulePointer(); 152 if (exe_module) 153 { 154 const llvm::Triple &triple_ref = target.GetArchitecture().GetTriple(); 155 switch (triple_ref.getOS()) 156 { 157 case llvm::Triple::Darwin: // Should use "macosx" for desktop and "ios" for iOS, but accept darwin just in case 158 case llvm::Triple::MacOSX: // For desktop targets 159 case llvm::Triple::IOS: // For arm targets 160 if (triple_ref.getVendor() == llvm::Triple::Apple) 161 { 162 ObjectFile *exe_objfile = exe_module->GetObjectFile(); 163 if (exe_objfile->GetType() == ObjectFile::eTypeExecutable && 164 exe_objfile->GetStrata() == ObjectFile::eStrataKernel) 165 return true; 166 } 167 break; 168 169 default: 170 break; 171 } 172 } 173 return false; 174 } 175 176 //---------------------------------------------------------------------- 177 // ProcessKDP constructor 178 //---------------------------------------------------------------------- 179 ProcessKDP::ProcessKDP(Target& target, Listener &listener) : 180 Process (target, listener), 181 m_comm("lldb.process.kdp-remote.communication"), 182 m_async_broadcaster (NULL, "lldb.process.kdp-remote.async-broadcaster"), 183 m_dyld_plugin_name (), 184 m_kernel_load_addr (LLDB_INVALID_ADDRESS), 185 m_command_sp(), 186 m_kernel_thread_wp() 187 { 188 m_async_broadcaster.SetEventName (eBroadcastBitAsyncThreadShouldExit, "async thread should exit"); 189 m_async_broadcaster.SetEventName (eBroadcastBitAsyncContinue, "async thread continue"); 190 const uint64_t timeout_seconds = GetGlobalPluginProperties()->GetPacketTimeout(); 191 if (timeout_seconds > 0) 192 m_comm.SetPacketTimeout(timeout_seconds); 193 } 194 195 //---------------------------------------------------------------------- 196 // Destructor 197 //---------------------------------------------------------------------- 198 ProcessKDP::~ProcessKDP() 199 { 200 Clear(); 201 // We need to call finalize on the process before destroying ourselves 202 // to make sure all of the broadcaster cleanup goes as planned. If we 203 // destruct this class, then Process::~Process() might have problems 204 // trying to fully destroy the broadcaster. 205 Finalize(); 206 } 207 208 //---------------------------------------------------------------------- 209 // PluginInterface 210 //---------------------------------------------------------------------- 211 lldb_private::ConstString 212 ProcessKDP::GetPluginName() 213 { 214 return GetPluginNameStatic(); 215 } 216 217 uint32_t 218 ProcessKDP::GetPluginVersion() 219 { 220 return 1; 221 } 222 223 Error 224 ProcessKDP::WillLaunch (Module* module) 225 { 226 Error error; 227 error.SetErrorString ("launching not supported in kdp-remote plug-in"); 228 return error; 229 } 230 231 Error 232 ProcessKDP::WillAttachToProcessWithID (lldb::pid_t pid) 233 { 234 Error error; 235 error.SetErrorString ("attaching to a by process ID not supported in kdp-remote plug-in"); 236 return error; 237 } 238 239 Error 240 ProcessKDP::WillAttachToProcessWithName (const char *process_name, bool wait_for_launch) 241 { 242 Error error; 243 error.SetErrorString ("attaching to a by process name not supported in kdp-remote plug-in"); 244 return error; 245 } 246 247 Error 248 ProcessKDP::DoConnectRemote (Stream *strm, const char *remote_url) 249 { 250 Error error; 251 252 // Don't let any JIT happen when doing KDP as we can't allocate 253 // memory and we don't want to be mucking with threads that might 254 // already be handling exceptions 255 SetCanJIT(false); 256 257 if (remote_url == NULL || remote_url[0] == '\0') 258 { 259 error.SetErrorStringWithFormat ("invalid connection URL '%s'", remote_url); 260 return error; 261 } 262 263 std::unique_ptr<ConnectionFileDescriptor> conn_ap(new ConnectionFileDescriptor()); 264 if (conn_ap.get()) 265 { 266 // Only try once for now. 267 // TODO: check if we should be retrying? 268 const uint32_t max_retry_count = 1; 269 for (uint32_t retry_count = 0; retry_count < max_retry_count; ++retry_count) 270 { 271 if (conn_ap->Connect(remote_url, &error) == eConnectionStatusSuccess) 272 break; 273 usleep (100000); 274 } 275 } 276 277 if (conn_ap->IsConnected()) 278 { 279 const Socket& socket = static_cast<const Socket&>(*conn_ap->GetReadObject()); 280 const uint16_t reply_port = socket.GetLocalPortNumber(); 281 282 if (reply_port != 0) 283 { 284 m_comm.SetConnection(conn_ap.release()); 285 286 if (m_comm.SendRequestReattach(reply_port)) 287 { 288 if (m_comm.SendRequestConnect(reply_port, reply_port, "Greetings from LLDB...")) 289 { 290 m_comm.GetVersion(); 291 uint32_t cpu = m_comm.GetCPUType(); 292 uint32_t sub = m_comm.GetCPUSubtype(); 293 ArchSpec kernel_arch; 294 kernel_arch.SetArchitecture(eArchTypeMachO, cpu, sub); 295 m_target.SetArchitecture(kernel_arch); 296 297 /* Get the kernel's UUID and load address via KDP_KERNELVERSION packet. */ 298 /* An EFI kdp session has neither UUID nor load address. */ 299 300 UUID kernel_uuid = m_comm.GetUUID (); 301 addr_t kernel_load_addr = m_comm.GetLoadAddress (); 302 303 if (m_comm.RemoteIsEFI ()) 304 { 305 // Select an invalid plugin name for the dynamic loader so one doesn't get used 306 // since EFI does its own manual loading via python scripting 307 static ConstString g_none_dynamic_loader("none"); 308 m_dyld_plugin_name = g_none_dynamic_loader; 309 310 if (kernel_uuid.IsValid()) { 311 // If EFI passed in a UUID= try to lookup UUID 312 // The slide will not be provided. But the UUID 313 // lookup will be used to launch EFI debug scripts 314 // from the dSYM, that can load all of the symbols. 315 ModuleSpec module_spec; 316 module_spec.GetUUID() = kernel_uuid; 317 module_spec.GetArchitecture() = m_target.GetArchitecture(); 318 319 // Lookup UUID locally, before attempting dsymForUUID like action 320 module_spec.GetSymbolFileSpec() = Symbols::LocateExecutableSymbolFile(module_spec); 321 if (module_spec.GetSymbolFileSpec()) 322 module_spec.GetFileSpec() = Symbols::LocateExecutableObjectFile (module_spec); 323 if (!module_spec.GetSymbolFileSpec() || !module_spec.GetSymbolFileSpec()) 324 Symbols::DownloadObjectAndSymbolFile (module_spec, true); 325 326 if (module_spec.GetFileSpec().Exists()) 327 { 328 ModuleSP module_sp(new Module (module_spec.GetFileSpec(), m_target.GetArchitecture())); 329 if (module_sp.get() && module_sp->MatchesModuleSpec (module_spec)) 330 { 331 // Get the current target executable 332 ModuleSP exe_module_sp (m_target.GetExecutableModule ()); 333 334 // Make sure you don't already have the right module loaded and they will be uniqued 335 if (exe_module_sp.get() != module_sp.get()) 336 m_target.SetExecutableModule (module_sp, false); 337 } 338 } 339 } 340 } 341 else if (m_comm.RemoteIsDarwinKernel ()) 342 { 343 m_dyld_plugin_name = DynamicLoaderDarwinKernel::GetPluginNameStatic(); 344 if (kernel_load_addr != LLDB_INVALID_ADDRESS) 345 { 346 m_kernel_load_addr = kernel_load_addr; 347 } 348 } 349 350 // Set the thread ID 351 UpdateThreadListIfNeeded (); 352 SetID (1); 353 GetThreadList (); 354 SetPrivateState (eStateStopped); 355 StreamSP async_strm_sp(m_target.GetDebugger().GetAsyncOutputStream()); 356 if (async_strm_sp) 357 { 358 const char *cstr; 359 if ((cstr = m_comm.GetKernelVersion ()) != NULL) 360 { 361 async_strm_sp->Printf ("Version: %s\n", cstr); 362 async_strm_sp->Flush(); 363 } 364 // if ((cstr = m_comm.GetImagePath ()) != NULL) 365 // { 366 // async_strm_sp->Printf ("Image Path: %s\n", cstr); 367 // async_strm_sp->Flush(); 368 // } 369 } 370 } 371 else 372 { 373 error.SetErrorString("KDP_REATTACH failed"); 374 } 375 } 376 else 377 { 378 error.SetErrorString("KDP_REATTACH failed"); 379 } 380 } 381 else 382 { 383 error.SetErrorString("invalid reply port from UDP connection"); 384 } 385 } 386 else 387 { 388 if (error.Success()) 389 error.SetErrorStringWithFormat ("failed to connect to '%s'", remote_url); 390 } 391 if (error.Fail()) 392 m_comm.Disconnect(); 393 394 return error; 395 } 396 397 //---------------------------------------------------------------------- 398 // Process Control 399 //---------------------------------------------------------------------- 400 Error 401 ProcessKDP::DoLaunch (Module *exe_module, 402 ProcessLaunchInfo &launch_info) 403 { 404 Error error; 405 error.SetErrorString ("launching not supported in kdp-remote plug-in"); 406 return error; 407 } 408 409 Error 410 ProcessKDP::DoAttachToProcessWithID (lldb::pid_t attach_pid, const ProcessAttachInfo &attach_info) 411 { 412 Error error; 413 error.SetErrorString ("attach to process by ID is not suppported in kdp remote debugging"); 414 return error; 415 } 416 417 Error 418 ProcessKDP::DoAttachToProcessWithName (const char *process_name, const ProcessAttachInfo &attach_info) 419 { 420 Error error; 421 error.SetErrorString ("attach to process by name is not suppported in kdp remote debugging"); 422 return error; 423 } 424 425 426 void 427 ProcessKDP::DidAttach (ArchSpec &process_arch) 428 { 429 Process::DidAttach(process_arch); 430 431 Log *log (ProcessKDPLog::GetLogIfAllCategoriesSet (KDP_LOG_PROCESS)); 432 if (log) 433 log->Printf ("ProcessKDP::DidAttach()"); 434 if (GetID() != LLDB_INVALID_PROCESS_ID) 435 { 436 uint32_t cpu = m_comm.GetCPUType(); 437 if (cpu) 438 { 439 uint32_t sub = m_comm.GetCPUSubtype(); 440 process_arch.SetArchitecture(eArchTypeMachO, cpu, sub); 441 } 442 } 443 } 444 445 addr_t 446 ProcessKDP::GetImageInfoAddress() 447 { 448 return m_kernel_load_addr; 449 } 450 451 lldb_private::DynamicLoader * 452 ProcessKDP::GetDynamicLoader () 453 { 454 if (m_dyld_ap.get() == NULL) 455 m_dyld_ap.reset (DynamicLoader::FindPlugin(this, m_dyld_plugin_name.IsEmpty() ? NULL : m_dyld_plugin_name.GetCString())); 456 return m_dyld_ap.get(); 457 } 458 459 Error 460 ProcessKDP::WillResume () 461 { 462 return Error(); 463 } 464 465 Error 466 ProcessKDP::DoResume () 467 { 468 Error error; 469 Log *log (ProcessKDPLog::GetLogIfAllCategoriesSet (KDP_LOG_PROCESS)); 470 // Only start the async thread if we try to do any process control 471 if (!m_async_thread.IsJoinable()) 472 StartAsyncThread(); 473 474 bool resume = false; 475 476 // With KDP there is only one thread we can tell what to do 477 ThreadSP kernel_thread_sp (m_thread_list.FindThreadByProtocolID(g_kernel_tid)); 478 479 if (kernel_thread_sp) 480 { 481 const StateType thread_resume_state = kernel_thread_sp->GetTemporaryResumeState(); 482 483 if (log) 484 log->Printf ("ProcessKDP::DoResume() thread_resume_state = %s", StateAsCString(thread_resume_state)); 485 switch (thread_resume_state) 486 { 487 case eStateSuspended: 488 // Nothing to do here when a thread will stay suspended 489 // we just leave the CPU mask bit set to zero for the thread 490 if (log) 491 log->Printf ("ProcessKDP::DoResume() = suspended???"); 492 break; 493 494 case eStateStepping: 495 { 496 lldb::RegisterContextSP reg_ctx_sp (kernel_thread_sp->GetRegisterContext()); 497 498 if (reg_ctx_sp) 499 { 500 if (log) 501 log->Printf ("ProcessKDP::DoResume () reg_ctx_sp->HardwareSingleStep (true);"); 502 reg_ctx_sp->HardwareSingleStep (true); 503 resume = true; 504 } 505 else 506 { 507 error.SetErrorStringWithFormat("KDP thread 0x%llx has no register context", kernel_thread_sp->GetID()); 508 } 509 } 510 break; 511 512 case eStateRunning: 513 { 514 lldb::RegisterContextSP reg_ctx_sp (kernel_thread_sp->GetRegisterContext()); 515 516 if (reg_ctx_sp) 517 { 518 if (log) 519 log->Printf ("ProcessKDP::DoResume () reg_ctx_sp->HardwareSingleStep (false);"); 520 reg_ctx_sp->HardwareSingleStep (false); 521 resume = true; 522 } 523 else 524 { 525 error.SetErrorStringWithFormat("KDP thread 0x%llx has no register context", kernel_thread_sp->GetID()); 526 } 527 } 528 break; 529 530 default: 531 // The only valid thread resume states are listed above 532 assert (!"invalid thread resume state"); 533 break; 534 } 535 } 536 537 if (resume) 538 { 539 if (log) 540 log->Printf ("ProcessKDP::DoResume () sending resume"); 541 542 if (m_comm.SendRequestResume ()) 543 { 544 m_async_broadcaster.BroadcastEvent (eBroadcastBitAsyncContinue); 545 SetPrivateState(eStateRunning); 546 } 547 else 548 error.SetErrorString ("KDP resume failed"); 549 } 550 else 551 { 552 error.SetErrorString ("kernel thread is suspended"); 553 } 554 555 return error; 556 } 557 558 lldb::ThreadSP 559 ProcessKDP::GetKernelThread() 560 { 561 // KDP only tells us about one thread/core. Any other threads will usually 562 // be the ones that are read from memory by the OS plug-ins. 563 564 ThreadSP thread_sp (m_kernel_thread_wp.lock()); 565 if (!thread_sp) 566 { 567 thread_sp.reset(new ThreadKDP (*this, g_kernel_tid)); 568 m_kernel_thread_wp = thread_sp; 569 } 570 return thread_sp; 571 } 572 573 574 575 576 bool 577 ProcessKDP::UpdateThreadList (ThreadList &old_thread_list, ThreadList &new_thread_list) 578 { 579 // locker will keep a mutex locked until it goes out of scope 580 Log *log (ProcessKDPLog::GetLogIfAllCategoriesSet (KDP_LOG_THREAD)); 581 if (log && log->GetMask().Test(KDP_LOG_VERBOSE)) 582 log->Printf ("ProcessKDP::%s (pid = %" PRIu64 ")", __FUNCTION__, GetID()); 583 584 // Even though there is a CPU mask, it doesn't mean we can see each CPU 585 // individually, there is really only one. Lets call this thread 1. 586 ThreadSP thread_sp (old_thread_list.FindThreadByProtocolID(g_kernel_tid, false)); 587 if (!thread_sp) 588 thread_sp = GetKernelThread (); 589 new_thread_list.AddThread(thread_sp); 590 591 return new_thread_list.GetSize(false) > 0; 592 } 593 594 void 595 ProcessKDP::RefreshStateAfterStop () 596 { 597 // Let all threads recover from stopping and do any clean up based 598 // on the previous thread state (if any). 599 m_thread_list.RefreshStateAfterStop(); 600 } 601 602 Error 603 ProcessKDP::DoHalt (bool &caused_stop) 604 { 605 Error error; 606 607 if (m_comm.IsRunning()) 608 { 609 if (m_destroy_in_process) 610 { 611 // If we are attemping to destroy, we need to not return an error to 612 // Halt or DoDestroy won't get called. 613 // We are also currently running, so send a process stopped event 614 SetPrivateState (eStateStopped); 615 } 616 else 617 { 618 error.SetErrorString ("KDP cannot interrupt a running kernel"); 619 } 620 } 621 return error; 622 } 623 624 Error 625 ProcessKDP::DoDetach(bool keep_stopped) 626 { 627 Error error; 628 Log *log (ProcessKDPLog::GetLogIfAllCategoriesSet(KDP_LOG_PROCESS)); 629 if (log) 630 log->Printf ("ProcessKDP::DoDetach(keep_stopped = %i)", keep_stopped); 631 632 if (m_comm.IsRunning()) 633 { 634 // We are running and we can't interrupt a running kernel, so we need 635 // to just close the connection to the kernel and hope for the best 636 } 637 else 638 { 639 // If we are going to keep the target stopped, then don't send the disconnect message. 640 if (!keep_stopped && m_comm.IsConnected()) 641 { 642 const bool success = m_comm.SendRequestDisconnect(); 643 if (log) 644 { 645 if (success) 646 log->PutCString ("ProcessKDP::DoDetach() detach packet sent successfully"); 647 else 648 log->PutCString ("ProcessKDP::DoDetach() connection channel shutdown failed"); 649 } 650 m_comm.Disconnect (); 651 } 652 } 653 StopAsyncThread (); 654 m_comm.Clear(); 655 656 SetPrivateState (eStateDetached); 657 ResumePrivateStateThread(); 658 659 //KillDebugserverProcess (); 660 return error; 661 } 662 663 Error 664 ProcessKDP::DoDestroy () 665 { 666 // For KDP there really is no difference between destroy and detach 667 bool keep_stopped = false; 668 return DoDetach(keep_stopped); 669 } 670 671 //------------------------------------------------------------------ 672 // Process Queries 673 //------------------------------------------------------------------ 674 675 bool 676 ProcessKDP::IsAlive () 677 { 678 return m_comm.IsConnected() && m_private_state.GetValue() != eStateExited; 679 } 680 681 //------------------------------------------------------------------ 682 // Process Memory 683 //------------------------------------------------------------------ 684 size_t 685 ProcessKDP::DoReadMemory (addr_t addr, void *buf, size_t size, Error &error) 686 { 687 uint8_t *data_buffer = (uint8_t *) buf; 688 if (m_comm.IsConnected()) 689 { 690 const size_t max_read_size = 512; 691 size_t total_bytes_read = 0; 692 693 // Read the requested amount of memory in 512 byte chunks 694 while (total_bytes_read < size) 695 { 696 size_t bytes_to_read_this_request = size - total_bytes_read; 697 if (bytes_to_read_this_request > max_read_size) 698 { 699 bytes_to_read_this_request = max_read_size; 700 } 701 size_t bytes_read = m_comm.SendRequestReadMemory (addr + total_bytes_read, 702 data_buffer + total_bytes_read, 703 bytes_to_read_this_request, error); 704 total_bytes_read += bytes_read; 705 if (error.Fail() || bytes_read == 0) 706 { 707 return total_bytes_read; 708 } 709 } 710 711 return total_bytes_read; 712 } 713 error.SetErrorString ("not connected"); 714 return 0; 715 } 716 717 size_t 718 ProcessKDP::DoWriteMemory (addr_t addr, const void *buf, size_t size, Error &error) 719 { 720 if (m_comm.IsConnected()) 721 return m_comm.SendRequestWriteMemory (addr, buf, size, error); 722 error.SetErrorString ("not connected"); 723 return 0; 724 } 725 726 lldb::addr_t 727 ProcessKDP::DoAllocateMemory (size_t size, uint32_t permissions, Error &error) 728 { 729 error.SetErrorString ("memory allocation not suppported in kdp remote debugging"); 730 return LLDB_INVALID_ADDRESS; 731 } 732 733 Error 734 ProcessKDP::DoDeallocateMemory (lldb::addr_t addr) 735 { 736 Error error; 737 error.SetErrorString ("memory deallocation not suppported in kdp remote debugging"); 738 return error; 739 } 740 741 Error 742 ProcessKDP::EnableBreakpointSite (BreakpointSite *bp_site) 743 { 744 if (m_comm.LocalBreakpointsAreSupported ()) 745 { 746 Error error; 747 if (!bp_site->IsEnabled()) 748 { 749 if (m_comm.SendRequestBreakpoint(true, bp_site->GetLoadAddress())) 750 { 751 bp_site->SetEnabled(true); 752 bp_site->SetType (BreakpointSite::eExternal); 753 } 754 else 755 { 756 error.SetErrorString ("KDP set breakpoint failed"); 757 } 758 } 759 return error; 760 } 761 return EnableSoftwareBreakpoint (bp_site); 762 } 763 764 Error 765 ProcessKDP::DisableBreakpointSite (BreakpointSite *bp_site) 766 { 767 if (m_comm.LocalBreakpointsAreSupported ()) 768 { 769 Error error; 770 if (bp_site->IsEnabled()) 771 { 772 BreakpointSite::Type bp_type = bp_site->GetType(); 773 if (bp_type == BreakpointSite::eExternal) 774 { 775 if (m_destroy_in_process && m_comm.IsRunning()) 776 { 777 // We are trying to destroy our connection and we are running 778 bp_site->SetEnabled(false); 779 } 780 else 781 { 782 if (m_comm.SendRequestBreakpoint(false, bp_site->GetLoadAddress())) 783 bp_site->SetEnabled(false); 784 else 785 error.SetErrorString ("KDP remove breakpoint failed"); 786 } 787 } 788 else 789 { 790 error = DisableSoftwareBreakpoint (bp_site); 791 } 792 } 793 return error; 794 } 795 return DisableSoftwareBreakpoint (bp_site); 796 } 797 798 Error 799 ProcessKDP::EnableWatchpoint (Watchpoint *wp, bool notify) 800 { 801 Error error; 802 error.SetErrorString ("watchpoints are not suppported in kdp remote debugging"); 803 return error; 804 } 805 806 Error 807 ProcessKDP::DisableWatchpoint (Watchpoint *wp, bool notify) 808 { 809 Error error; 810 error.SetErrorString ("watchpoints are not suppported in kdp remote debugging"); 811 return error; 812 } 813 814 void 815 ProcessKDP::Clear() 816 { 817 m_thread_list.Clear(); 818 } 819 820 Error 821 ProcessKDP::DoSignal (int signo) 822 { 823 Error error; 824 error.SetErrorString ("sending signals is not suppported in kdp remote debugging"); 825 return error; 826 } 827 828 void 829 ProcessKDP::Initialize() 830 { 831 static std::once_flag g_once_flag; 832 833 std::call_once(g_once_flag, []() 834 { 835 PluginManager::RegisterPlugin (GetPluginNameStatic(), 836 GetPluginDescriptionStatic(), 837 CreateInstance, 838 DebuggerInitialize); 839 840 Log::Callbacks log_callbacks = { 841 ProcessKDPLog::DisableLog, 842 ProcessKDPLog::EnableLog, 843 ProcessKDPLog::ListLogCategories 844 }; 845 846 Log::RegisterLogChannel (ProcessKDP::GetPluginNameStatic(), log_callbacks); 847 }); 848 } 849 850 void 851 ProcessKDP::DebuggerInitialize (lldb_private::Debugger &debugger) 852 { 853 if (!PluginManager::GetSettingForProcessPlugin(debugger, PluginProperties::GetSettingName())) 854 { 855 const bool is_global_setting = true; 856 PluginManager::CreateSettingForProcessPlugin (debugger, 857 GetGlobalPluginProperties()->GetValueProperties(), 858 ConstString ("Properties for the kdp-remote process plug-in."), 859 is_global_setting); 860 } 861 } 862 863 bool 864 ProcessKDP::StartAsyncThread () 865 { 866 Log *log (ProcessKDPLog::GetLogIfAllCategoriesSet(KDP_LOG_PROCESS)); 867 868 if (log) 869 log->Printf ("ProcessKDP::StartAsyncThread ()"); 870 871 if (m_async_thread.IsJoinable()) 872 return true; 873 874 m_async_thread = ThreadLauncher::LaunchThread("<lldb.process.kdp-remote.async>", ProcessKDP::AsyncThread, this, NULL); 875 return m_async_thread.IsJoinable(); 876 } 877 878 void 879 ProcessKDP::StopAsyncThread () 880 { 881 Log *log (ProcessKDPLog::GetLogIfAllCategoriesSet(KDP_LOG_PROCESS)); 882 883 if (log) 884 log->Printf ("ProcessKDP::StopAsyncThread ()"); 885 886 m_async_broadcaster.BroadcastEvent (eBroadcastBitAsyncThreadShouldExit); 887 888 // Stop the stdio thread 889 if (m_async_thread.IsJoinable()) 890 m_async_thread.Join(nullptr); 891 } 892 893 894 void * 895 ProcessKDP::AsyncThread (void *arg) 896 { 897 ProcessKDP *process = (ProcessKDP*) arg; 898 899 const lldb::pid_t pid = process->GetID(); 900 901 Log *log (ProcessKDPLog::GetLogIfAllCategoriesSet (KDP_LOG_PROCESS)); 902 if (log) 903 log->Printf ("ProcessKDP::AsyncThread (arg = %p, pid = %" PRIu64 ") thread starting...", arg, pid); 904 905 Listener listener ("ProcessKDP::AsyncThread"); 906 EventSP event_sp; 907 const uint32_t desired_event_mask = eBroadcastBitAsyncContinue | 908 eBroadcastBitAsyncThreadShouldExit; 909 910 911 if (listener.StartListeningForEvents (&process->m_async_broadcaster, desired_event_mask) == desired_event_mask) 912 { 913 bool done = false; 914 while (!done) 915 { 916 if (log) 917 log->Printf ("ProcessKDP::AsyncThread (pid = %" PRIu64 ") listener.WaitForEvent (NULL, event_sp)...", 918 pid); 919 if (listener.WaitForEvent (NULL, event_sp)) 920 { 921 uint32_t event_type = event_sp->GetType(); 922 if (log) 923 log->Printf ("ProcessKDP::AsyncThread (pid = %" PRIu64 ") Got an event of type: %d...", 924 pid, 925 event_type); 926 927 // When we are running, poll for 1 second to try and get an exception 928 // to indicate the process has stopped. If we don't get one, check to 929 // make sure no one asked us to exit 930 bool is_running = false; 931 DataExtractor exc_reply_packet; 932 do 933 { 934 switch (event_type) 935 { 936 case eBroadcastBitAsyncContinue: 937 { 938 is_running = true; 939 if (process->m_comm.WaitForPacketWithTimeoutMicroSeconds (exc_reply_packet, 1 * USEC_PER_SEC)) 940 { 941 ThreadSP thread_sp (process->GetKernelThread()); 942 if (thread_sp) 943 { 944 lldb::RegisterContextSP reg_ctx_sp (thread_sp->GetRegisterContext()); 945 if (reg_ctx_sp) 946 reg_ctx_sp->InvalidateAllRegisters(); 947 static_cast<ThreadKDP *>(thread_sp.get())->SetStopInfoFrom_KDP_EXCEPTION (exc_reply_packet); 948 } 949 950 // TODO: parse the stop reply packet 951 is_running = false; 952 process->SetPrivateState(eStateStopped); 953 } 954 else 955 { 956 // Check to see if we are supposed to exit. There is no way to 957 // interrupt a running kernel, so all we can do is wait for an 958 // exception or detach... 959 if (listener.GetNextEvent(event_sp)) 960 { 961 // We got an event, go through the loop again 962 event_type = event_sp->GetType(); 963 } 964 } 965 } 966 break; 967 968 case eBroadcastBitAsyncThreadShouldExit: 969 if (log) 970 log->Printf ("ProcessKDP::AsyncThread (pid = %" PRIu64 ") got eBroadcastBitAsyncThreadShouldExit...", 971 pid); 972 done = true; 973 is_running = false; 974 break; 975 976 default: 977 if (log) 978 log->Printf ("ProcessKDP::AsyncThread (pid = %" PRIu64 ") got unknown event 0x%8.8x", 979 pid, 980 event_type); 981 done = true; 982 is_running = false; 983 break; 984 } 985 } while (is_running); 986 } 987 else 988 { 989 if (log) 990 log->Printf ("ProcessKDP::AsyncThread (pid = %" PRIu64 ") listener.WaitForEvent (NULL, event_sp) => false", 991 pid); 992 done = true; 993 } 994 } 995 } 996 997 if (log) 998 log->Printf ("ProcessKDP::AsyncThread (arg = %p, pid = %" PRIu64 ") thread exiting...", 999 arg, 1000 pid); 1001 1002 process->m_async_thread.Reset(); 1003 return NULL; 1004 } 1005 1006 1007 class CommandObjectProcessKDPPacketSend : public CommandObjectParsed 1008 { 1009 private: 1010 1011 OptionGroupOptions m_option_group; 1012 OptionGroupUInt64 m_command_byte; 1013 OptionGroupString m_packet_data; 1014 1015 virtual Options * 1016 GetOptions () 1017 { 1018 return &m_option_group; 1019 } 1020 1021 1022 public: 1023 CommandObjectProcessKDPPacketSend(CommandInterpreter &interpreter) : 1024 CommandObjectParsed (interpreter, 1025 "process plugin packet send", 1026 "Send a custom packet through the KDP protocol by specifying the command byte and the packet payload data. A packet will be sent with a correct header and payload, and the raw result bytes will be displayed as a string value. ", 1027 NULL), 1028 m_option_group (interpreter), 1029 m_command_byte(LLDB_OPT_SET_1, true , "command", 'c', 0, eArgTypeNone, "Specify the command byte to use when sending the KDP request packet.", 0), 1030 m_packet_data (LLDB_OPT_SET_1, false, "payload", 'p', 0, eArgTypeNone, "Specify packet payload bytes as a hex ASCII string with no spaces or hex prefixes.", NULL) 1031 { 1032 m_option_group.Append (&m_command_byte, LLDB_OPT_SET_ALL, LLDB_OPT_SET_1); 1033 m_option_group.Append (&m_packet_data , LLDB_OPT_SET_ALL, LLDB_OPT_SET_1); 1034 m_option_group.Finalize(); 1035 } 1036 1037 ~CommandObjectProcessKDPPacketSend () 1038 { 1039 } 1040 1041 bool 1042 DoExecute (Args& command, CommandReturnObject &result) 1043 { 1044 const size_t argc = command.GetArgumentCount(); 1045 if (argc == 0) 1046 { 1047 if (!m_command_byte.GetOptionValue().OptionWasSet()) 1048 { 1049 result.AppendError ("the --command option must be set to a valid command byte"); 1050 result.SetStatus (eReturnStatusFailed); 1051 } 1052 else 1053 { 1054 const uint64_t command_byte = m_command_byte.GetOptionValue().GetUInt64Value(0); 1055 if (command_byte > 0 && command_byte <= UINT8_MAX) 1056 { 1057 ProcessKDP *process = (ProcessKDP *)m_interpreter.GetExecutionContext().GetProcessPtr(); 1058 if (process) 1059 { 1060 const StateType state = process->GetState(); 1061 1062 if (StateIsStoppedState (state, true)) 1063 { 1064 std::vector<uint8_t> payload_bytes; 1065 const char *ascii_hex_bytes_cstr = m_packet_data.GetOptionValue().GetCurrentValue(); 1066 if (ascii_hex_bytes_cstr && ascii_hex_bytes_cstr[0]) 1067 { 1068 StringExtractor extractor(ascii_hex_bytes_cstr); 1069 const size_t ascii_hex_bytes_cstr_len = extractor.GetStringRef().size(); 1070 if (ascii_hex_bytes_cstr_len & 1) 1071 { 1072 result.AppendErrorWithFormat ("payload data must contain an even number of ASCII hex characters: '%s'", ascii_hex_bytes_cstr); 1073 result.SetStatus (eReturnStatusFailed); 1074 return false; 1075 } 1076 payload_bytes.resize(ascii_hex_bytes_cstr_len/2); 1077 if (extractor.GetHexBytes(&payload_bytes[0], payload_bytes.size(), '\xdd') != payload_bytes.size()) 1078 { 1079 result.AppendErrorWithFormat ("payload data must only contain ASCII hex characters (no spaces or hex prefixes): '%s'", ascii_hex_bytes_cstr); 1080 result.SetStatus (eReturnStatusFailed); 1081 return false; 1082 } 1083 } 1084 Error error; 1085 DataExtractor reply; 1086 process->GetCommunication().SendRawRequest (command_byte, 1087 payload_bytes.empty() ? NULL : payload_bytes.data(), 1088 payload_bytes.size(), 1089 reply, 1090 error); 1091 1092 if (error.Success()) 1093 { 1094 // Copy the binary bytes into a hex ASCII string for the result 1095 StreamString packet; 1096 packet.PutBytesAsRawHex8(reply.GetDataStart(), 1097 reply.GetByteSize(), 1098 lldb::endian::InlHostByteOrder(), 1099 lldb::endian::InlHostByteOrder()); 1100 result.AppendMessage(packet.GetString().c_str()); 1101 result.SetStatus (eReturnStatusSuccessFinishResult); 1102 return true; 1103 } 1104 else 1105 { 1106 const char *error_cstr = error.AsCString(); 1107 if (error_cstr && error_cstr[0]) 1108 result.AppendError (error_cstr); 1109 else 1110 result.AppendErrorWithFormat ("unknown error 0x%8.8x", error.GetError()); 1111 result.SetStatus (eReturnStatusFailed); 1112 return false; 1113 } 1114 } 1115 else 1116 { 1117 result.AppendErrorWithFormat ("process must be stopped in order to send KDP packets, state is %s", StateAsCString (state)); 1118 result.SetStatus (eReturnStatusFailed); 1119 } 1120 } 1121 else 1122 { 1123 result.AppendError ("invalid process"); 1124 result.SetStatus (eReturnStatusFailed); 1125 } 1126 } 1127 else 1128 { 1129 result.AppendErrorWithFormat ("invalid command byte 0x%" PRIx64 ", valid values are 1 - 255", command_byte); 1130 result.SetStatus (eReturnStatusFailed); 1131 } 1132 } 1133 } 1134 else 1135 { 1136 result.AppendErrorWithFormat ("'%s' takes no arguments, only options.", m_cmd_name.c_str()); 1137 result.SetStatus (eReturnStatusFailed); 1138 } 1139 return false; 1140 } 1141 }; 1142 1143 class CommandObjectProcessKDPPacket : public CommandObjectMultiword 1144 { 1145 private: 1146 1147 public: 1148 CommandObjectProcessKDPPacket(CommandInterpreter &interpreter) : 1149 CommandObjectMultiword (interpreter, 1150 "process plugin packet", 1151 "Commands that deal with KDP remote packets.", 1152 NULL) 1153 { 1154 LoadSubCommand ("send", CommandObjectSP (new CommandObjectProcessKDPPacketSend (interpreter))); 1155 } 1156 1157 ~CommandObjectProcessKDPPacket () 1158 { 1159 } 1160 }; 1161 1162 class CommandObjectMultiwordProcessKDP : public CommandObjectMultiword 1163 { 1164 public: 1165 CommandObjectMultiwordProcessKDP (CommandInterpreter &interpreter) : 1166 CommandObjectMultiword (interpreter, 1167 "process plugin", 1168 "A set of commands for operating on a ProcessKDP process.", 1169 "process plugin <subcommand> [<subcommand-options>]") 1170 { 1171 LoadSubCommand ("packet", CommandObjectSP (new CommandObjectProcessKDPPacket (interpreter))); 1172 } 1173 1174 ~CommandObjectMultiwordProcessKDP () 1175 { 1176 } 1177 }; 1178 1179 CommandObject * 1180 ProcessKDP::GetPluginCommandObject() 1181 { 1182 if (!m_command_sp) 1183 m_command_sp.reset (new CommandObjectMultiwordProcessKDP (GetTarget().GetDebugger().GetCommandInterpreter())); 1184 return m_command_sp.get(); 1185 } 1186 1187