1 //===-- Process.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 // C++ Includes 12 #include <atomic> 13 #include <mutex> 14 15 // Other libraries and framework includes 16 // Project includes 17 #include "lldb/Target/Process.h" 18 #include "lldb/Breakpoint/StoppointCallbackContext.h" 19 #include "lldb/Breakpoint/BreakpointLocation.h" 20 #include "lldb/Core/Event.h" 21 #include "lldb/Core/Debugger.h" 22 #include "lldb/Core/Log.h" 23 #include "lldb/Core/Module.h" 24 #include "lldb/Core/ModuleSpec.h" 25 #include "lldb/Core/PluginManager.h" 26 #include "lldb/Core/State.h" 27 #include "lldb/Core/StreamFile.h" 28 #include "lldb/Expression/UserExpression.h" 29 #include "lldb/Expression/IRDynamicChecks.h" 30 #include "lldb/Host/ConnectionFileDescriptor.h" 31 #include "lldb/Host/FileSystem.h" 32 #include "lldb/Host/Host.h" 33 #include "lldb/Host/HostInfo.h" 34 #include "lldb/Host/Pipe.h" 35 #include "lldb/Host/Terminal.h" 36 #include "lldb/Host/ThreadLauncher.h" 37 #include "lldb/Interpreter/CommandInterpreter.h" 38 #include "lldb/Interpreter/OptionValueProperties.h" 39 #include "lldb/Symbol/Function.h" 40 #include "lldb/Symbol/Symbol.h" 41 #include "lldb/Target/ABI.h" 42 #include "lldb/Target/DynamicLoader.h" 43 #include "lldb/Target/InstrumentationRuntime.h" 44 #include "lldb/Target/JITLoader.h" 45 #include "lldb/Target/JITLoaderList.h" 46 #include "lldb/Target/MemoryHistory.h" 47 #include "lldb/Target/MemoryRegionInfo.h" 48 #include "lldb/Target/OperatingSystem.h" 49 #include "lldb/Target/LanguageRuntime.h" 50 #include "lldb/Target/CPPLanguageRuntime.h" 51 #include "lldb/Target/ObjCLanguageRuntime.h" 52 #include "lldb/Target/Platform.h" 53 #include "lldb/Target/RegisterContext.h" 54 #include "lldb/Target/StopInfo.h" 55 #include "lldb/Target/SystemRuntime.h" 56 #include "lldb/Target/Target.h" 57 #include "lldb/Target/TargetList.h" 58 #include "lldb/Target/Thread.h" 59 #include "lldb/Target/ThreadPlan.h" 60 #include "lldb/Target/ThreadPlanBase.h" 61 #include "lldb/Target/UnixSignals.h" 62 #include "lldb/Utility/NameMatches.h" 63 #include "Plugins/Process/Utility/InferiorCallPOSIX.h" 64 65 using namespace lldb; 66 using namespace lldb_private; 67 68 // Comment out line below to disable memory caching, overriding the process setting 69 // target.process.disable-memory-cache 70 #define ENABLE_MEMORY_CACHING 71 72 #ifdef ENABLE_MEMORY_CACHING 73 #define DISABLE_MEM_CACHE_DEFAULT false 74 #else 75 #define DISABLE_MEM_CACHE_DEFAULT true 76 #endif 77 78 class ProcessOptionValueProperties : public OptionValueProperties 79 { 80 public: 81 ProcessOptionValueProperties (const ConstString &name) : 82 OptionValueProperties (name) 83 { 84 } 85 86 // This constructor is used when creating ProcessOptionValueProperties when it 87 // is part of a new lldb_private::Process instance. It will copy all current 88 // global property values as needed 89 ProcessOptionValueProperties (ProcessProperties *global_properties) : 90 OptionValueProperties(*global_properties->GetValueProperties()) 91 { 92 } 93 94 const Property * 95 GetPropertyAtIndex(const ExecutionContext *exe_ctx, bool will_modify, uint32_t idx) const override 96 { 97 // When getting the value for a key from the process options, we will always 98 // try and grab the setting from the current process if there is one. Else we just 99 // use the one from this instance. 100 if (exe_ctx) 101 { 102 Process *process = exe_ctx->GetProcessPtr(); 103 if (process) 104 { 105 ProcessOptionValueProperties *instance_properties = static_cast<ProcessOptionValueProperties *>(process->GetValueProperties().get()); 106 if (this != instance_properties) 107 return instance_properties->ProtectedGetPropertyAtIndex (idx); 108 } 109 } 110 return ProtectedGetPropertyAtIndex (idx); 111 } 112 }; 113 114 static PropertyDefinition 115 g_properties[] = 116 { 117 { "disable-memory-cache" , OptionValue::eTypeBoolean, false, DISABLE_MEM_CACHE_DEFAULT, nullptr, nullptr, "Disable reading and caching of memory in fixed-size units." }, 118 { "extra-startup-command", OptionValue::eTypeArray , false, OptionValue::eTypeString, nullptr, nullptr, "A list containing extra commands understood by the particular process plugin used. " 119 "For instance, to turn on debugserver logging set this to \"QSetLogging:bitmask=LOG_DEFAULT;\"" }, 120 { "ignore-breakpoints-in-expressions", OptionValue::eTypeBoolean, true, true, nullptr, nullptr, "If true, breakpoints will be ignored during expression evaluation." }, 121 { "unwind-on-error-in-expressions", OptionValue::eTypeBoolean, true, true, nullptr, nullptr, "If true, errors in expression evaluation will unwind the stack back to the state before the call." }, 122 { "python-os-plugin-path", OptionValue::eTypeFileSpec, false, true, nullptr, nullptr, "A path to a python OS plug-in module file that contains a OperatingSystemPlugIn class." }, 123 { "stop-on-sharedlibrary-events" , OptionValue::eTypeBoolean, true, false, nullptr, nullptr, "If true, stop when a shared library is loaded or unloaded." }, 124 { "detach-keeps-stopped" , OptionValue::eTypeBoolean, true, false, nullptr, nullptr, "If true, detach will attempt to keep the process stopped." }, 125 { "memory-cache-line-size" , OptionValue::eTypeUInt64, false, 512, nullptr, nullptr, "The memory cache line size" }, 126 { "optimization-warnings" , OptionValue::eTypeBoolean, false, true, nullptr, nullptr, "If true, warn when stopped in code that is optimized where stepping and variable availability may not behave as expected." }, 127 { nullptr , OptionValue::eTypeInvalid, false, 0, nullptr, nullptr, nullptr } 128 }; 129 130 enum { 131 ePropertyDisableMemCache, 132 ePropertyExtraStartCommand, 133 ePropertyIgnoreBreakpointsInExpressions, 134 ePropertyUnwindOnErrorInExpressions, 135 ePropertyPythonOSPluginPath, 136 ePropertyStopOnSharedLibraryEvents, 137 ePropertyDetachKeepsStopped, 138 ePropertyMemCacheLineSize, 139 ePropertyWarningOptimization 140 }; 141 142 ProcessProperties::ProcessProperties (lldb_private::Process *process) : 143 Properties(), 144 m_process(process) // Can be nullptr for global ProcessProperties 145 { 146 if (process == nullptr) 147 { 148 // Global process properties, set them up one time 149 m_collection_sp.reset (new ProcessOptionValueProperties(ConstString("process"))); 150 m_collection_sp->Initialize(g_properties); 151 m_collection_sp->AppendProperty(ConstString("thread"), 152 ConstString("Settings specific to threads."), 153 true, 154 Thread::GetGlobalProperties()->GetValueProperties()); 155 } 156 else 157 { 158 m_collection_sp.reset (new ProcessOptionValueProperties(Process::GetGlobalProperties().get())); 159 m_collection_sp->SetValueChangedCallback(ePropertyPythonOSPluginPath, ProcessProperties::OptionValueChangedCallback, this); 160 } 161 } 162 163 ProcessProperties::~ProcessProperties() = default; 164 165 void 166 ProcessProperties::OptionValueChangedCallback (void *baton, OptionValue *option_value) 167 { 168 ProcessProperties *properties = (ProcessProperties *)baton; 169 if (properties->m_process) 170 properties->m_process->LoadOperatingSystemPlugin(true); 171 } 172 173 bool 174 ProcessProperties::GetDisableMemoryCache() const 175 { 176 const uint32_t idx = ePropertyDisableMemCache; 177 return m_collection_sp->GetPropertyAtIndexAsBoolean(nullptr, idx, g_properties[idx].default_uint_value != 0); 178 } 179 180 uint64_t 181 ProcessProperties::GetMemoryCacheLineSize() const 182 { 183 const uint32_t idx = ePropertyMemCacheLineSize; 184 return m_collection_sp->GetPropertyAtIndexAsUInt64(nullptr, idx, g_properties[idx].default_uint_value); 185 } 186 187 Args 188 ProcessProperties::GetExtraStartupCommands () const 189 { 190 Args args; 191 const uint32_t idx = ePropertyExtraStartCommand; 192 m_collection_sp->GetPropertyAtIndexAsArgs(nullptr, idx, args); 193 return args; 194 } 195 196 void 197 ProcessProperties::SetExtraStartupCommands (const Args &args) 198 { 199 const uint32_t idx = ePropertyExtraStartCommand; 200 m_collection_sp->SetPropertyAtIndexFromArgs(nullptr, idx, args); 201 } 202 203 FileSpec 204 ProcessProperties::GetPythonOSPluginPath () const 205 { 206 const uint32_t idx = ePropertyPythonOSPluginPath; 207 return m_collection_sp->GetPropertyAtIndexAsFileSpec(nullptr, idx); 208 } 209 210 void 211 ProcessProperties::SetPythonOSPluginPath (const FileSpec &file) 212 { 213 const uint32_t idx = ePropertyPythonOSPluginPath; 214 m_collection_sp->SetPropertyAtIndexAsFileSpec(nullptr, idx, file); 215 } 216 217 bool 218 ProcessProperties::GetIgnoreBreakpointsInExpressions () const 219 { 220 const uint32_t idx = ePropertyIgnoreBreakpointsInExpressions; 221 return m_collection_sp->GetPropertyAtIndexAsBoolean(nullptr, idx, g_properties[idx].default_uint_value != 0); 222 } 223 224 void 225 ProcessProperties::SetIgnoreBreakpointsInExpressions (bool ignore) 226 { 227 const uint32_t idx = ePropertyIgnoreBreakpointsInExpressions; 228 m_collection_sp->SetPropertyAtIndexAsBoolean(nullptr, idx, ignore); 229 } 230 231 bool 232 ProcessProperties::GetUnwindOnErrorInExpressions () const 233 { 234 const uint32_t idx = ePropertyUnwindOnErrorInExpressions; 235 return m_collection_sp->GetPropertyAtIndexAsBoolean(nullptr, idx, g_properties[idx].default_uint_value != 0); 236 } 237 238 void 239 ProcessProperties::SetUnwindOnErrorInExpressions (bool ignore) 240 { 241 const uint32_t idx = ePropertyUnwindOnErrorInExpressions; 242 m_collection_sp->SetPropertyAtIndexAsBoolean(nullptr, idx, ignore); 243 } 244 245 bool 246 ProcessProperties::GetStopOnSharedLibraryEvents () const 247 { 248 const uint32_t idx = ePropertyStopOnSharedLibraryEvents; 249 return m_collection_sp->GetPropertyAtIndexAsBoolean(nullptr, idx, g_properties[idx].default_uint_value != 0); 250 } 251 252 void 253 ProcessProperties::SetStopOnSharedLibraryEvents (bool stop) 254 { 255 const uint32_t idx = ePropertyStopOnSharedLibraryEvents; 256 m_collection_sp->SetPropertyAtIndexAsBoolean(nullptr, idx, stop); 257 } 258 259 bool 260 ProcessProperties::GetDetachKeepsStopped () const 261 { 262 const uint32_t idx = ePropertyDetachKeepsStopped; 263 return m_collection_sp->GetPropertyAtIndexAsBoolean(nullptr, idx, g_properties[idx].default_uint_value != 0); 264 } 265 266 void 267 ProcessProperties::SetDetachKeepsStopped (bool stop) 268 { 269 const uint32_t idx = ePropertyDetachKeepsStopped; 270 m_collection_sp->SetPropertyAtIndexAsBoolean(nullptr, idx, stop); 271 } 272 273 bool 274 ProcessProperties::GetWarningsOptimization () const 275 { 276 const uint32_t idx = ePropertyWarningOptimization; 277 return m_collection_sp->GetPropertyAtIndexAsBoolean(nullptr, idx, g_properties[idx].default_uint_value != 0); 278 } 279 280 void 281 ProcessInstanceInfo::Dump (Stream &s, Platform *platform) const 282 { 283 const char *cstr; 284 if (m_pid != LLDB_INVALID_PROCESS_ID) 285 s.Printf (" pid = %" PRIu64 "\n", m_pid); 286 287 if (m_parent_pid != LLDB_INVALID_PROCESS_ID) 288 s.Printf (" parent = %" PRIu64 "\n", m_parent_pid); 289 290 if (m_executable) 291 { 292 s.Printf (" name = %s\n", m_executable.GetFilename().GetCString()); 293 s.PutCString (" file = "); 294 m_executable.Dump(&s); 295 s.EOL(); 296 } 297 const uint32_t argc = m_arguments.GetArgumentCount(); 298 if (argc > 0) 299 { 300 for (uint32_t i = 0; i < argc; i++) 301 { 302 const char *arg = m_arguments.GetArgumentAtIndex(i); 303 if (i < 10) 304 s.Printf (" arg[%u] = %s\n", i, arg); 305 else 306 s.Printf ("arg[%u] = %s\n", i, arg); 307 } 308 } 309 310 const uint32_t envc = m_environment.GetArgumentCount(); 311 if (envc > 0) 312 { 313 for (uint32_t i = 0; i < envc; i++) 314 { 315 const char *env = m_environment.GetArgumentAtIndex(i); 316 if (i < 10) 317 s.Printf (" env[%u] = %s\n", i, env); 318 else 319 s.Printf ("env[%u] = %s\n", i, env); 320 } 321 } 322 323 if (m_arch.IsValid()) 324 { 325 s.Printf (" arch = "); 326 m_arch.DumpTriple(s); 327 s.EOL(); 328 } 329 330 if (m_uid != UINT32_MAX) 331 { 332 cstr = platform->GetUserName (m_uid); 333 s.Printf (" uid = %-5u (%s)\n", m_uid, cstr ? cstr : ""); 334 } 335 if (m_gid != UINT32_MAX) 336 { 337 cstr = platform->GetGroupName (m_gid); 338 s.Printf (" gid = %-5u (%s)\n", m_gid, cstr ? cstr : ""); 339 } 340 if (m_euid != UINT32_MAX) 341 { 342 cstr = platform->GetUserName (m_euid); 343 s.Printf (" euid = %-5u (%s)\n", m_euid, cstr ? cstr : ""); 344 } 345 if (m_egid != UINT32_MAX) 346 { 347 cstr = platform->GetGroupName (m_egid); 348 s.Printf (" egid = %-5u (%s)\n", m_egid, cstr ? cstr : ""); 349 } 350 } 351 352 void 353 ProcessInstanceInfo::DumpTableHeader (Stream &s, Platform *platform, bool show_args, bool verbose) 354 { 355 const char *label; 356 if (show_args || verbose) 357 label = "ARGUMENTS"; 358 else 359 label = "NAME"; 360 361 if (verbose) 362 { 363 s.Printf ("PID PARENT USER GROUP EFF USER EFF GROUP TRIPLE %s\n", label); 364 s.PutCString ("====== ====== ========== ========== ========== ========== ======================== ============================\n"); 365 } 366 else 367 { 368 s.Printf ("PID PARENT USER TRIPLE %s\n", label); 369 s.PutCString ("====== ====== ========== ======================== ============================\n"); 370 } 371 } 372 373 void 374 ProcessInstanceInfo::DumpAsTableRow (Stream &s, Platform *platform, bool show_args, bool verbose) const 375 { 376 if (m_pid != LLDB_INVALID_PROCESS_ID) 377 { 378 const char *cstr; 379 s.Printf ("%-6" PRIu64 " %-6" PRIu64 " ", m_pid, m_parent_pid); 380 381 StreamString arch_strm; 382 if (m_arch.IsValid()) 383 m_arch.DumpTriple(arch_strm); 384 385 if (verbose) 386 { 387 cstr = platform->GetUserName (m_uid); 388 if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed 389 s.Printf ("%-10s ", cstr); 390 else 391 s.Printf ("%-10u ", m_uid); 392 393 cstr = platform->GetGroupName (m_gid); 394 if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed 395 s.Printf ("%-10s ", cstr); 396 else 397 s.Printf ("%-10u ", m_gid); 398 399 cstr = platform->GetUserName (m_euid); 400 if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed 401 s.Printf ("%-10s ", cstr); 402 else 403 s.Printf ("%-10u ", m_euid); 404 405 cstr = platform->GetGroupName (m_egid); 406 if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed 407 s.Printf ("%-10s ", cstr); 408 else 409 s.Printf ("%-10u ", m_egid); 410 411 s.Printf ("%-24s ", arch_strm.GetString().c_str()); 412 } 413 else 414 { 415 s.Printf ("%-10s %-24s ", 416 platform->GetUserName (m_euid), 417 arch_strm.GetString().c_str()); 418 } 419 420 if (verbose || show_args) 421 { 422 const uint32_t argc = m_arguments.GetArgumentCount(); 423 if (argc > 0) 424 { 425 for (uint32_t i = 0; i < argc; i++) 426 { 427 if (i > 0) 428 s.PutChar (' '); 429 s.PutCString (m_arguments.GetArgumentAtIndex(i)); 430 } 431 } 432 } 433 else 434 { 435 s.PutCString (GetName()); 436 } 437 438 s.EOL(); 439 } 440 } 441 442 Error 443 ProcessLaunchCommandOptions::SetOptionValue (uint32_t option_idx, const char *option_arg) 444 { 445 Error error; 446 const int short_option = m_getopt_table[option_idx].val; 447 448 switch (short_option) 449 { 450 case 's': // Stop at program entry point 451 launch_info.GetFlags().Set (eLaunchFlagStopAtEntry); 452 break; 453 454 case 'i': // STDIN for read only 455 { 456 FileAction action; 457 if (action.Open(STDIN_FILENO, FileSpec{option_arg, false}, true, false)) 458 launch_info.AppendFileAction (action); 459 break; 460 } 461 462 case 'o': // Open STDOUT for write only 463 { 464 FileAction action; 465 if (action.Open(STDOUT_FILENO, FileSpec{option_arg, false}, false, true)) 466 launch_info.AppendFileAction (action); 467 break; 468 } 469 470 case 'e': // STDERR for write only 471 { 472 FileAction action; 473 if (action.Open(STDERR_FILENO, FileSpec{option_arg, false}, false, true)) 474 launch_info.AppendFileAction (action); 475 break; 476 } 477 478 case 'p': // Process plug-in name 479 launch_info.SetProcessPluginName (option_arg); 480 break; 481 482 case 'n': // Disable STDIO 483 { 484 FileAction action; 485 const FileSpec dev_null{FileSystem::DEV_NULL, false}; 486 if (action.Open(STDIN_FILENO, dev_null, true, false)) 487 launch_info.AppendFileAction (action); 488 if (action.Open(STDOUT_FILENO, dev_null, false, true)) 489 launch_info.AppendFileAction (action); 490 if (action.Open(STDERR_FILENO, dev_null, false, true)) 491 launch_info.AppendFileAction (action); 492 break; 493 } 494 495 case 'w': 496 launch_info.SetWorkingDirectory(FileSpec{option_arg, false}); 497 break; 498 499 case 't': // Open process in new terminal window 500 launch_info.GetFlags().Set (eLaunchFlagLaunchInTTY); 501 break; 502 503 case 'a': 504 if (!launch_info.GetArchitecture().SetTriple (option_arg, m_interpreter.GetPlatform(true).get())) 505 launch_info.GetArchitecture().SetTriple (option_arg); 506 break; 507 508 case 'A': // Disable ASLR. 509 { 510 bool success; 511 const bool disable_aslr_arg = Args::StringToBoolean (option_arg, true, &success); 512 if (success) 513 disable_aslr = disable_aslr_arg ? eLazyBoolYes : eLazyBoolNo; 514 else 515 error.SetErrorStringWithFormat ("Invalid boolean value for disable-aslr option: '%s'", option_arg ? option_arg : "<null>"); 516 break; 517 } 518 519 case 'X': // shell expand args. 520 { 521 bool success; 522 const bool expand_args = Args::StringToBoolean (option_arg, true, &success); 523 if (success) 524 launch_info.SetShellExpandArguments(expand_args); 525 else 526 error.SetErrorStringWithFormat ("Invalid boolean value for shell-expand-args option: '%s'", option_arg ? option_arg : "<null>"); 527 break; 528 } 529 530 case 'c': 531 if (option_arg && option_arg[0]) 532 launch_info.SetShell (FileSpec(option_arg, false)); 533 else 534 launch_info.SetShell (HostInfo::GetDefaultShell()); 535 break; 536 537 case 'v': 538 launch_info.GetEnvironmentEntries().AppendArgument(option_arg); 539 break; 540 541 default: 542 error.SetErrorStringWithFormat("unrecognized short option character '%c'", short_option); 543 break; 544 } 545 return error; 546 } 547 548 OptionDefinition 549 ProcessLaunchCommandOptions::g_option_table[] = 550 { 551 { LLDB_OPT_SET_ALL, false, "stop-at-entry", 's', OptionParser::eNoArgument, nullptr, nullptr, 0, eArgTypeNone, "Stop at the entry point of the program when launching a process." }, 552 { LLDB_OPT_SET_ALL, false, "disable-aslr", 'A', OptionParser::eRequiredArgument, nullptr, nullptr, 0, eArgTypeBoolean, "Set whether to disable address space layout randomization when launching a process." }, 553 { LLDB_OPT_SET_ALL, false, "plugin", 'p', OptionParser::eRequiredArgument, nullptr, nullptr, 0, eArgTypePlugin, "Name of the process plugin you want to use." }, 554 { LLDB_OPT_SET_ALL, false, "working-dir", 'w', OptionParser::eRequiredArgument, nullptr, nullptr, 0, eArgTypeDirectoryName, "Set the current working directory to <path> when running the inferior." }, 555 { LLDB_OPT_SET_ALL, false, "arch", 'a', OptionParser::eRequiredArgument, nullptr, nullptr, 0, eArgTypeArchitecture, "Set the architecture for the process to launch when ambiguous." }, 556 { LLDB_OPT_SET_ALL, false, "environment", 'v', OptionParser::eRequiredArgument, nullptr, nullptr, 0, eArgTypeNone, "Specify an environment variable name/value string (--environment NAME=VALUE). Can be specified multiple times for subsequent environment entries." }, 557 { LLDB_OPT_SET_1|LLDB_OPT_SET_2|LLDB_OPT_SET_3, false, "shell", 'c', OptionParser::eOptionalArgument, nullptr, nullptr, 0, eArgTypeFilename, "Run the process in a shell (not supported on all platforms)." }, 558 559 { LLDB_OPT_SET_1 , false, "stdin", 'i', OptionParser::eRequiredArgument, nullptr, nullptr, 0, eArgTypeFilename, "Redirect stdin for the process to <filename>." }, 560 { LLDB_OPT_SET_1 , false, "stdout", 'o', OptionParser::eRequiredArgument, nullptr, nullptr, 0, eArgTypeFilename, "Redirect stdout for the process to <filename>." }, 561 { LLDB_OPT_SET_1 , false, "stderr", 'e', OptionParser::eRequiredArgument, nullptr, nullptr, 0, eArgTypeFilename, "Redirect stderr for the process to <filename>." }, 562 563 { LLDB_OPT_SET_2 , false, "tty", 't', OptionParser::eNoArgument, nullptr, nullptr, 0, eArgTypeNone, "Start the process in a terminal (not supported on all platforms)." }, 564 565 { LLDB_OPT_SET_3 , false, "no-stdio", 'n', OptionParser::eNoArgument, nullptr, nullptr, 0, eArgTypeNone, "Do not set up for terminal I/O to go to running process." }, 566 { LLDB_OPT_SET_4, false, "shell-expand-args", 'X', OptionParser::eRequiredArgument, nullptr, nullptr, 0, eArgTypeBoolean, "Set whether to shell expand arguments to the process when launching." }, 567 { 0 , false, nullptr, 0, 0, nullptr, nullptr, 0, eArgTypeNone, nullptr } 568 }; 569 570 bool 571 ProcessInstanceInfoMatch::NameMatches (const char *process_name) const 572 { 573 if (m_name_match_type == eNameMatchIgnore || process_name == nullptr) 574 return true; 575 const char *match_name = m_match_info.GetName(); 576 if (!match_name) 577 return true; 578 579 return lldb_private::NameMatches (process_name, m_name_match_type, match_name); 580 } 581 582 bool 583 ProcessInstanceInfoMatch::Matches (const ProcessInstanceInfo &proc_info) const 584 { 585 if (!NameMatches (proc_info.GetName())) 586 return false; 587 588 if (m_match_info.ProcessIDIsValid() && 589 m_match_info.GetProcessID() != proc_info.GetProcessID()) 590 return false; 591 592 if (m_match_info.ParentProcessIDIsValid() && 593 m_match_info.GetParentProcessID() != proc_info.GetParentProcessID()) 594 return false; 595 596 if (m_match_info.UserIDIsValid () && 597 m_match_info.GetUserID() != proc_info.GetUserID()) 598 return false; 599 600 if (m_match_info.GroupIDIsValid () && 601 m_match_info.GetGroupID() != proc_info.GetGroupID()) 602 return false; 603 604 if (m_match_info.EffectiveUserIDIsValid () && 605 m_match_info.GetEffectiveUserID() != proc_info.GetEffectiveUserID()) 606 return false; 607 608 if (m_match_info.EffectiveGroupIDIsValid () && 609 m_match_info.GetEffectiveGroupID() != proc_info.GetEffectiveGroupID()) 610 return false; 611 612 if (m_match_info.GetArchitecture().IsValid() && 613 !m_match_info.GetArchitecture().IsCompatibleMatch(proc_info.GetArchitecture())) 614 return false; 615 return true; 616 } 617 618 bool 619 ProcessInstanceInfoMatch::MatchAllProcesses () const 620 { 621 if (m_name_match_type != eNameMatchIgnore) 622 return false; 623 624 if (m_match_info.ProcessIDIsValid()) 625 return false; 626 627 if (m_match_info.ParentProcessIDIsValid()) 628 return false; 629 630 if (m_match_info.UserIDIsValid ()) 631 return false; 632 633 if (m_match_info.GroupIDIsValid ()) 634 return false; 635 636 if (m_match_info.EffectiveUserIDIsValid ()) 637 return false; 638 639 if (m_match_info.EffectiveGroupIDIsValid ()) 640 return false; 641 642 if (m_match_info.GetArchitecture().IsValid()) 643 return false; 644 645 if (m_match_all_users) 646 return false; 647 648 return true; 649 } 650 651 void 652 ProcessInstanceInfoMatch::Clear() 653 { 654 m_match_info.Clear(); 655 m_name_match_type = eNameMatchIgnore; 656 m_match_all_users = false; 657 } 658 659 ProcessSP 660 Process::FindPlugin (lldb::TargetSP target_sp, const char *plugin_name, ListenerSP listener_sp, const FileSpec *crash_file_path) 661 { 662 static uint32_t g_process_unique_id = 0; 663 664 ProcessSP process_sp; 665 ProcessCreateInstance create_callback = nullptr; 666 if (plugin_name) 667 { 668 ConstString const_plugin_name(plugin_name); 669 create_callback = PluginManager::GetProcessCreateCallbackForPluginName (const_plugin_name); 670 if (create_callback) 671 { 672 process_sp = create_callback(target_sp, listener_sp, crash_file_path); 673 if (process_sp) 674 { 675 if (process_sp->CanDebug(target_sp, true)) 676 { 677 process_sp->m_process_unique_id = ++g_process_unique_id; 678 } 679 else 680 process_sp.reset(); 681 } 682 } 683 } 684 else 685 { 686 for (uint32_t idx = 0; (create_callback = PluginManager::GetProcessCreateCallbackAtIndex(idx)) != nullptr; ++idx) 687 { 688 process_sp = create_callback(target_sp, listener_sp, crash_file_path); 689 if (process_sp) 690 { 691 if (process_sp->CanDebug(target_sp, false)) 692 { 693 process_sp->m_process_unique_id = ++g_process_unique_id; 694 break; 695 } 696 else 697 process_sp.reset(); 698 } 699 } 700 } 701 return process_sp; 702 } 703 704 ConstString & 705 Process::GetStaticBroadcasterClass () 706 { 707 static ConstString class_name ("lldb.process"); 708 return class_name; 709 } 710 711 Process::Process(lldb::TargetSP target_sp, ListenerSP listener_sp) : 712 Process(target_sp, listener_sp, UnixSignals::Create(HostInfo::GetArchitecture())) 713 { 714 // This constructor just delegates to the full Process constructor, 715 // defaulting to using the Host's UnixSignals. 716 } 717 718 Process::Process(lldb::TargetSP target_sp, ListenerSP listener_sp, const UnixSignalsSP &unix_signals_sp) : 719 ProcessProperties (this), 720 UserID (LLDB_INVALID_PROCESS_ID), 721 Broadcaster ((target_sp->GetDebugger().GetBroadcasterManager()), Process::GetStaticBroadcasterClass().AsCString()), 722 m_target_sp (target_sp), 723 m_public_state (eStateUnloaded), 724 m_private_state (eStateUnloaded), 725 m_private_state_broadcaster(nullptr, "lldb.process.internal_state_broadcaster"), 726 m_private_state_control_broadcaster(nullptr, "lldb.process.internal_state_control_broadcaster"), 727 m_private_state_listener_sp (Listener::MakeListener("lldb.process.internal_state_listener")), 728 m_private_state_control_wait(), 729 m_mod_id (), 730 m_process_unique_id(0), 731 m_thread_index_id (0), 732 m_thread_id_to_index_id_map (), 733 m_exit_status (-1), 734 m_exit_string (), 735 m_exit_status_mutex(), 736 m_thread_mutex (Mutex::eMutexTypeRecursive), 737 m_thread_list_real (this), 738 m_thread_list (this), 739 m_extended_thread_list (this), 740 m_extended_thread_stop_id (0), 741 m_queue_list (this), 742 m_queue_list_stop_id (0), 743 m_notifications (), 744 m_image_tokens (), 745 m_listener_sp (listener_sp), 746 m_breakpoint_site_list (), 747 m_dynamic_checkers_ap (), 748 m_unix_signals_sp (unix_signals_sp), 749 m_abi_sp (), 750 m_process_input_reader (), 751 m_stdio_communication ("process.stdio"), 752 m_stdio_communication_mutex (Mutex::eMutexTypeRecursive), 753 m_stdin_forward (false), 754 m_stdout_data (), 755 m_stderr_data (), 756 m_profile_data_comm_mutex (Mutex::eMutexTypeRecursive), 757 m_profile_data (), 758 m_iohandler_sync (0), 759 m_memory_cache (*this), 760 m_allocated_memory_cache (*this), 761 m_should_detach (false), 762 m_next_event_action_ap(), 763 m_public_run_lock (), 764 m_private_run_lock (), 765 m_stop_info_override_callback(nullptr), 766 m_finalizing (false), 767 m_finalize_called (false), 768 m_clear_thread_plans_on_stop (false), 769 m_force_next_event_delivery (false), 770 m_last_broadcast_state (eStateInvalid), 771 m_destroy_in_process (false), 772 m_can_interpret_function_calls(false), 773 m_warnings_issued (), 774 m_can_jit(eCanJITDontKnow) 775 { 776 CheckInWithManager (); 777 778 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_OBJECT)); 779 if (log) 780 log->Printf ("%p Process::Process()", static_cast<void*>(this)); 781 782 if (!m_unix_signals_sp) 783 m_unix_signals_sp = std::make_shared<UnixSignals>(); 784 785 SetEventName (eBroadcastBitStateChanged, "state-changed"); 786 SetEventName (eBroadcastBitInterrupt, "interrupt"); 787 SetEventName (eBroadcastBitSTDOUT, "stdout-available"); 788 SetEventName (eBroadcastBitSTDERR, "stderr-available"); 789 SetEventName (eBroadcastBitProfileData, "profile-data-available"); 790 791 m_private_state_control_broadcaster.SetEventName (eBroadcastInternalStateControlStop , "control-stop" ); 792 m_private_state_control_broadcaster.SetEventName (eBroadcastInternalStateControlPause , "control-pause" ); 793 m_private_state_control_broadcaster.SetEventName (eBroadcastInternalStateControlResume, "control-resume"); 794 795 m_listener_sp->StartListeningForEvents (this, 796 eBroadcastBitStateChanged | 797 eBroadcastBitInterrupt | 798 eBroadcastBitSTDOUT | 799 eBroadcastBitSTDERR | 800 eBroadcastBitProfileData); 801 802 m_private_state_listener_sp->StartListeningForEvents(&m_private_state_broadcaster, 803 eBroadcastBitStateChanged | 804 eBroadcastBitInterrupt); 805 806 m_private_state_listener_sp->StartListeningForEvents(&m_private_state_control_broadcaster, 807 eBroadcastInternalStateControlStop | 808 eBroadcastInternalStateControlPause | 809 eBroadcastInternalStateControlResume); 810 // We need something valid here, even if just the default UnixSignalsSP. 811 assert (m_unix_signals_sp && "null m_unix_signals_sp after initialization"); 812 813 // Allow the platform to override the default cache line size 814 OptionValueSP value_sp = 815 m_collection_sp->GetPropertyAtIndex(nullptr, true, ePropertyMemCacheLineSize)->GetValue(); 816 uint32_t platform_cache_line_size = target_sp->GetPlatform()->GetDefaultMemoryCacheLineSize(); 817 if (! value_sp->OptionWasSet() && platform_cache_line_size != 0) 818 value_sp->SetUInt64Value(platform_cache_line_size); 819 } 820 821 Process::~Process() 822 { 823 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_OBJECT)); 824 if (log) 825 log->Printf ("%p Process::~Process()", static_cast<void*>(this)); 826 StopPrivateStateThread(); 827 828 // ThreadList::Clear() will try to acquire this process's mutex, so 829 // explicitly clear the thread list here to ensure that the mutex 830 // is not destroyed before the thread list. 831 m_thread_list.Clear(); 832 } 833 834 const ProcessPropertiesSP & 835 Process::GetGlobalProperties() 836 { 837 // NOTE: intentional leak so we don't crash if global destructor chain gets 838 // called as other threads still use the result of this function 839 static ProcessPropertiesSP *g_settings_sp_ptr = nullptr; 840 static std::once_flag g_once_flag; 841 std::call_once(g_once_flag, []() { 842 g_settings_sp_ptr = new ProcessPropertiesSP(new ProcessProperties(nullptr)); 843 }); 844 return *g_settings_sp_ptr; 845 } 846 847 void 848 Process::Finalize() 849 { 850 m_finalizing = true; 851 852 // Destroy this process if needed 853 switch (GetPrivateState()) 854 { 855 case eStateConnected: 856 case eStateAttaching: 857 case eStateLaunching: 858 case eStateStopped: 859 case eStateRunning: 860 case eStateStepping: 861 case eStateCrashed: 862 case eStateSuspended: 863 Destroy(false); 864 break; 865 866 case eStateInvalid: 867 case eStateUnloaded: 868 case eStateDetached: 869 case eStateExited: 870 break; 871 } 872 873 // Clear our broadcaster before we proceed with destroying 874 Broadcaster::Clear(); 875 876 // Do any cleanup needed prior to being destructed... Subclasses 877 // that override this method should call this superclass method as well. 878 879 // We need to destroy the loader before the derived Process class gets destroyed 880 // since it is very likely that undoing the loader will require access to the real process. 881 m_dynamic_checkers_ap.reset(); 882 m_abi_sp.reset(); 883 m_os_ap.reset(); 884 m_system_runtime_ap.reset(); 885 m_dyld_ap.reset(); 886 m_jit_loaders_ap.reset(); 887 m_thread_list_real.Destroy(); 888 m_thread_list.Destroy(); 889 m_extended_thread_list.Destroy(); 890 m_queue_list.Clear(); 891 m_queue_list_stop_id = 0; 892 std::vector<Notifications> empty_notifications; 893 m_notifications.swap(empty_notifications); 894 m_image_tokens.clear(); 895 m_memory_cache.Clear(); 896 m_allocated_memory_cache.Clear(); 897 m_language_runtimes.clear(); 898 m_instrumentation_runtimes.clear(); 899 m_next_event_action_ap.reset(); 900 m_stop_info_override_callback = nullptr; 901 // Clear the last natural stop ID since it has a strong 902 // reference to this process 903 m_mod_id.SetStopEventForLastNaturalStopID(EventSP()); 904 //#ifdef LLDB_CONFIGURATION_DEBUG 905 // StreamFile s(stdout, false); 906 // EventSP event_sp; 907 // while (m_private_state_listener_sp->GetNextEvent(event_sp)) 908 // { 909 // event_sp->Dump (&s); 910 // s.EOL(); 911 // } 912 //#endif 913 // We have to be very careful here as the m_private_state_listener might 914 // contain events that have ProcessSP values in them which can keep this 915 // process around forever. These events need to be cleared out. 916 m_private_state_listener_sp->Clear(); 917 m_public_run_lock.TrySetRunning(); // This will do nothing if already locked 918 m_public_run_lock.SetStopped(); 919 m_private_run_lock.TrySetRunning(); // This will do nothing if already locked 920 m_private_run_lock.SetStopped(); 921 m_finalize_called = true; 922 } 923 924 void 925 Process::RegisterNotificationCallbacks (const Notifications& callbacks) 926 { 927 m_notifications.push_back(callbacks); 928 if (callbacks.initialize != nullptr) 929 callbacks.initialize (callbacks.baton, this); 930 } 931 932 bool 933 Process::UnregisterNotificationCallbacks(const Notifications& callbacks) 934 { 935 std::vector<Notifications>::iterator pos, end = m_notifications.end(); 936 for (pos = m_notifications.begin(); pos != end; ++pos) 937 { 938 if (pos->baton == callbacks.baton && 939 pos->initialize == callbacks.initialize && 940 pos->process_state_changed == callbacks.process_state_changed) 941 { 942 m_notifications.erase(pos); 943 return true; 944 } 945 } 946 return false; 947 } 948 949 void 950 Process::SynchronouslyNotifyStateChanged (StateType state) 951 { 952 std::vector<Notifications>::iterator notification_pos, notification_end = m_notifications.end(); 953 for (notification_pos = m_notifications.begin(); notification_pos != notification_end; ++notification_pos) 954 { 955 if (notification_pos->process_state_changed) 956 notification_pos->process_state_changed (notification_pos->baton, this, state); 957 } 958 } 959 960 // FIXME: We need to do some work on events before the general Listener sees them. 961 // For instance if we are continuing from a breakpoint, we need to ensure that we do 962 // the little "insert real insn, step & stop" trick. But we can't do that when the 963 // event is delivered by the broadcaster - since that is done on the thread that is 964 // waiting for new events, so if we needed more than one event for our handling, we would 965 // stall. So instead we do it when we fetch the event off of the queue. 966 // 967 968 StateType 969 Process::GetNextEvent (EventSP &event_sp) 970 { 971 StateType state = eStateInvalid; 972 973 if (m_listener_sp->GetNextEventForBroadcaster (this, event_sp) && event_sp) 974 state = Process::ProcessEventData::GetStateFromEvent (event_sp.get()); 975 976 return state; 977 } 978 979 void 980 Process::SyncIOHandler (uint32_t iohandler_id, uint64_t timeout_msec) 981 { 982 // don't sync (potentially context switch) in case where there is no process IO 983 if (!m_process_input_reader) 984 return; 985 986 TimeValue timeout = TimeValue::Now(); 987 timeout.OffsetWithMicroSeconds(timeout_msec*1000); 988 uint32_t new_iohandler_id = 0; 989 m_iohandler_sync.WaitForValueNotEqualTo(iohandler_id, new_iohandler_id, &timeout); 990 991 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS)); 992 if (log) 993 log->Printf("Process::%s waited for m_iohandler_sync to change from %u, new value is %u", __FUNCTION__, iohandler_id, new_iohandler_id); 994 } 995 996 StateType 997 Process::WaitForProcessToStop (const TimeValue *timeout, 998 EventSP *event_sp_ptr, 999 bool wait_always, 1000 ListenerSP hijack_listener_sp, 1001 Stream *stream, 1002 bool use_run_lock) 1003 { 1004 // We can't just wait for a "stopped" event, because the stopped event may have restarted the target. 1005 // We have to actually check each event, and in the case of a stopped event check the restarted flag 1006 // on the event. 1007 if (event_sp_ptr) 1008 event_sp_ptr->reset(); 1009 StateType state = GetState(); 1010 // If we are exited or detached, we won't ever get back to any 1011 // other valid state... 1012 if (state == eStateDetached || state == eStateExited) 1013 return state; 1014 1015 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS)); 1016 if (log) 1017 log->Printf ("Process::%s (timeout = %p)", __FUNCTION__, 1018 static_cast<const void*>(timeout)); 1019 1020 if (!wait_always && 1021 StateIsStoppedState(state, true) && 1022 StateIsStoppedState(GetPrivateState(), true)) 1023 { 1024 if (log) 1025 log->Printf("Process::%s returning without waiting for events; process private and public states are already 'stopped'.", 1026 __FUNCTION__); 1027 // We need to toggle the run lock as this won't get done in 1028 // SetPublicState() if the process is hijacked. 1029 if (hijack_listener_sp && use_run_lock) 1030 m_public_run_lock.SetStopped(); 1031 return state; 1032 } 1033 1034 while (state != eStateInvalid) 1035 { 1036 EventSP event_sp; 1037 state = WaitForStateChangedEvents (timeout, event_sp, hijack_listener_sp); 1038 if (event_sp_ptr && event_sp) 1039 *event_sp_ptr = event_sp; 1040 1041 bool pop_process_io_handler = (hijack_listener_sp.get() != nullptr); 1042 Process::HandleProcessStateChangedEvent (event_sp, stream, pop_process_io_handler); 1043 1044 switch (state) 1045 { 1046 case eStateCrashed: 1047 case eStateDetached: 1048 case eStateExited: 1049 case eStateUnloaded: 1050 // We need to toggle the run lock as this won't get done in 1051 // SetPublicState() if the process is hijacked. 1052 if (hijack_listener_sp && use_run_lock) 1053 m_public_run_lock.SetStopped(); 1054 return state; 1055 case eStateStopped: 1056 if (Process::ProcessEventData::GetRestartedFromEvent(event_sp.get())) 1057 continue; 1058 else 1059 { 1060 // We need to toggle the run lock as this won't get done in 1061 // SetPublicState() if the process is hijacked. 1062 if (hijack_listener_sp && use_run_lock) 1063 m_public_run_lock.SetStopped(); 1064 return state; 1065 } 1066 default: 1067 continue; 1068 } 1069 } 1070 return state; 1071 } 1072 1073 bool 1074 Process::HandleProcessStateChangedEvent (const EventSP &event_sp, 1075 Stream *stream, 1076 bool &pop_process_io_handler) 1077 { 1078 const bool handle_pop = pop_process_io_handler; 1079 1080 pop_process_io_handler = false; 1081 ProcessSP process_sp = Process::ProcessEventData::GetProcessFromEvent(event_sp.get()); 1082 1083 if (!process_sp) 1084 return false; 1085 1086 StateType event_state = Process::ProcessEventData::GetStateFromEvent (event_sp.get()); 1087 if (event_state == eStateInvalid) 1088 return false; 1089 1090 switch (event_state) 1091 { 1092 case eStateInvalid: 1093 case eStateUnloaded: 1094 case eStateAttaching: 1095 case eStateLaunching: 1096 case eStateStepping: 1097 case eStateDetached: 1098 if (stream) 1099 stream->Printf("Process %" PRIu64 " %s\n", 1100 process_sp->GetID(), 1101 StateAsCString (event_state)); 1102 if (event_state == eStateDetached) 1103 pop_process_io_handler = true; 1104 break; 1105 1106 case eStateConnected: 1107 case eStateRunning: 1108 // Don't be chatty when we run... 1109 break; 1110 1111 case eStateExited: 1112 if (stream) 1113 process_sp->GetStatus(*stream); 1114 pop_process_io_handler = true; 1115 break; 1116 1117 case eStateStopped: 1118 case eStateCrashed: 1119 case eStateSuspended: 1120 // Make sure the program hasn't been auto-restarted: 1121 if (Process::ProcessEventData::GetRestartedFromEvent (event_sp.get())) 1122 { 1123 if (stream) 1124 { 1125 size_t num_reasons = Process::ProcessEventData::GetNumRestartedReasons(event_sp.get()); 1126 if (num_reasons > 0) 1127 { 1128 // FIXME: Do we want to report this, or would that just be annoyingly chatty? 1129 if (num_reasons == 1) 1130 { 1131 const char *reason = Process::ProcessEventData::GetRestartedReasonAtIndex (event_sp.get(), 0); 1132 stream->Printf ("Process %" PRIu64 " stopped and restarted: %s\n", 1133 process_sp->GetID(), 1134 reason ? reason : "<UNKNOWN REASON>"); 1135 } 1136 else 1137 { 1138 stream->Printf ("Process %" PRIu64 " stopped and restarted, reasons:\n", 1139 process_sp->GetID()); 1140 1141 1142 for (size_t i = 0; i < num_reasons; i++) 1143 { 1144 const char *reason = Process::ProcessEventData::GetRestartedReasonAtIndex (event_sp.get(), i); 1145 stream->Printf("\t%s\n", reason ? reason : "<UNKNOWN REASON>"); 1146 } 1147 } 1148 } 1149 } 1150 } 1151 else 1152 { 1153 // Lock the thread list so it doesn't change on us, this is the scope for the locker: 1154 { 1155 ThreadList &thread_list = process_sp->GetThreadList(); 1156 Mutex::Locker locker (thread_list.GetMutex()); 1157 1158 ThreadSP curr_thread (thread_list.GetSelectedThread()); 1159 ThreadSP thread; 1160 StopReason curr_thread_stop_reason = eStopReasonInvalid; 1161 if (curr_thread) 1162 curr_thread_stop_reason = curr_thread->GetStopReason(); 1163 if (!curr_thread || 1164 !curr_thread->IsValid() || 1165 curr_thread_stop_reason == eStopReasonInvalid || 1166 curr_thread_stop_reason == eStopReasonNone) 1167 { 1168 // Prefer a thread that has just completed its plan over another thread as current thread. 1169 ThreadSP plan_thread; 1170 ThreadSP other_thread; 1171 1172 const size_t num_threads = thread_list.GetSize(); 1173 size_t i; 1174 for (i = 0; i < num_threads; ++i) 1175 { 1176 thread = thread_list.GetThreadAtIndex(i); 1177 StopReason thread_stop_reason = thread->GetStopReason(); 1178 switch (thread_stop_reason) 1179 { 1180 case eStopReasonInvalid: 1181 case eStopReasonNone: 1182 break; 1183 1184 case eStopReasonSignal: 1185 { 1186 // Don't select a signal thread if we weren't going to stop at that 1187 // signal. We have to have had another reason for stopping here, and 1188 // the user doesn't want to see this thread. 1189 uint64_t signo = thread->GetStopInfo()->GetValue(); 1190 if (process_sp->GetUnixSignals()->GetShouldStop(signo)) 1191 { 1192 if (!other_thread) 1193 other_thread = thread; 1194 } 1195 break; 1196 } 1197 case eStopReasonTrace: 1198 case eStopReasonBreakpoint: 1199 case eStopReasonWatchpoint: 1200 case eStopReasonException: 1201 case eStopReasonExec: 1202 case eStopReasonThreadExiting: 1203 case eStopReasonInstrumentation: 1204 if (!other_thread) 1205 other_thread = thread; 1206 break; 1207 case eStopReasonPlanComplete: 1208 if (!plan_thread) 1209 plan_thread = thread; 1210 break; 1211 } 1212 } 1213 if (plan_thread) 1214 thread_list.SetSelectedThreadByID (plan_thread->GetID()); 1215 else if (other_thread) 1216 thread_list.SetSelectedThreadByID (other_thread->GetID()); 1217 else 1218 { 1219 if (curr_thread && curr_thread->IsValid()) 1220 thread = curr_thread; 1221 else 1222 thread = thread_list.GetThreadAtIndex(0); 1223 1224 if (thread) 1225 thread_list.SetSelectedThreadByID (thread->GetID()); 1226 } 1227 } 1228 } 1229 // Drop the ThreadList mutex by here, since GetThreadStatus below might have to run code, 1230 // e.g. for Data formatters, and if we hold the ThreadList mutex, then the process is going to 1231 // have a hard time restarting the process. 1232 if (stream) 1233 { 1234 Debugger &debugger = process_sp->GetTarget().GetDebugger(); 1235 if (debugger.GetTargetList().GetSelectedTarget().get() == &process_sp->GetTarget()) 1236 { 1237 const bool only_threads_with_stop_reason = true; 1238 const uint32_t start_frame = 0; 1239 const uint32_t num_frames = 1; 1240 const uint32_t num_frames_with_source = 1; 1241 process_sp->GetStatus(*stream); 1242 process_sp->GetThreadStatus (*stream, 1243 only_threads_with_stop_reason, 1244 start_frame, 1245 num_frames, 1246 num_frames_with_source); 1247 } 1248 else 1249 { 1250 uint32_t target_idx = debugger.GetTargetList().GetIndexOfTarget(process_sp->GetTarget().shared_from_this()); 1251 if (target_idx != UINT32_MAX) 1252 stream->Printf ("Target %d: (", target_idx); 1253 else 1254 stream->Printf ("Target <unknown index>: ("); 1255 process_sp->GetTarget().Dump (stream, eDescriptionLevelBrief); 1256 stream->Printf (") stopped.\n"); 1257 } 1258 } 1259 1260 // Pop the process IO handler 1261 pop_process_io_handler = true; 1262 } 1263 break; 1264 } 1265 1266 if (handle_pop && pop_process_io_handler) 1267 process_sp->PopProcessIOHandler(); 1268 1269 return true; 1270 } 1271 1272 StateType 1273 Process::WaitForState(const TimeValue *timeout, 1274 const StateType *match_states, 1275 const uint32_t num_match_states) 1276 { 1277 EventSP event_sp; 1278 StateType state = GetState(); 1279 while (state != eStateInvalid) 1280 { 1281 // If we are exited or detached, we won't ever get back to any 1282 // other valid state... 1283 if (state == eStateDetached || state == eStateExited) 1284 return state; 1285 1286 state = WaitForStateChangedEvents(timeout, event_sp, nullptr); 1287 1288 for (uint32_t i = 0; i < num_match_states; ++i) 1289 { 1290 if (match_states[i] == state) 1291 return state; 1292 } 1293 } 1294 return state; 1295 } 1296 1297 bool 1298 Process::HijackProcessEvents (ListenerSP listener_sp) 1299 { 1300 if (listener_sp) 1301 { 1302 return HijackBroadcaster(listener_sp, eBroadcastBitStateChanged | eBroadcastBitInterrupt); 1303 } 1304 else 1305 return false; 1306 } 1307 1308 void 1309 Process::RestoreProcessEvents () 1310 { 1311 RestoreBroadcaster(); 1312 } 1313 1314 StateType 1315 Process::WaitForStateChangedEvents (const TimeValue *timeout, EventSP &event_sp, ListenerSP hijack_listener_sp) 1316 { 1317 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS)); 1318 1319 if (log) 1320 log->Printf ("Process::%s (timeout = %p, event_sp)...", __FUNCTION__, 1321 static_cast<const void*>(timeout)); 1322 1323 ListenerSP listener_sp = hijack_listener_sp; 1324 if (!listener_sp) 1325 listener_sp = m_listener_sp; 1326 1327 StateType state = eStateInvalid; 1328 if (listener_sp->WaitForEventForBroadcasterWithType (timeout, 1329 this, 1330 eBroadcastBitStateChanged | eBroadcastBitInterrupt, 1331 event_sp)) 1332 { 1333 if (event_sp && event_sp->GetType() == eBroadcastBitStateChanged) 1334 state = Process::ProcessEventData::GetStateFromEvent(event_sp.get()); 1335 else if (log) 1336 log->Printf ("Process::%s got no event or was interrupted.", __FUNCTION__); 1337 } 1338 1339 if (log) 1340 log->Printf ("Process::%s (timeout = %p, event_sp) => %s", 1341 __FUNCTION__, static_cast<const void*>(timeout), 1342 StateAsCString(state)); 1343 return state; 1344 } 1345 1346 Event * 1347 Process::PeekAtStateChangedEvents () 1348 { 1349 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS)); 1350 1351 if (log) 1352 log->Printf ("Process::%s...", __FUNCTION__); 1353 1354 Event *event_ptr; 1355 event_ptr = m_listener_sp->PeekAtNextEventForBroadcasterWithType (this, 1356 eBroadcastBitStateChanged); 1357 if (log) 1358 { 1359 if (event_ptr) 1360 { 1361 log->Printf ("Process::%s (event_ptr) => %s", 1362 __FUNCTION__, 1363 StateAsCString(ProcessEventData::GetStateFromEvent (event_ptr))); 1364 } 1365 else 1366 { 1367 log->Printf ("Process::%s no events found", 1368 __FUNCTION__); 1369 } 1370 } 1371 return event_ptr; 1372 } 1373 1374 StateType 1375 Process::WaitForStateChangedEventsPrivate (const TimeValue *timeout, EventSP &event_sp) 1376 { 1377 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS)); 1378 1379 if (log) 1380 log->Printf ("Process::%s (timeout = %p, event_sp)...", __FUNCTION__, 1381 static_cast<const void*>(timeout)); 1382 1383 StateType state = eStateInvalid; 1384 if (m_private_state_listener_sp->WaitForEventForBroadcasterWithType (timeout, 1385 &m_private_state_broadcaster, 1386 eBroadcastBitStateChanged | eBroadcastBitInterrupt, 1387 event_sp)) 1388 if (event_sp && event_sp->GetType() == eBroadcastBitStateChanged) 1389 state = Process::ProcessEventData::GetStateFromEvent(event_sp.get()); 1390 1391 // This is a bit of a hack, but when we wait here we could very well return 1392 // to the command-line, and that could disable the log, which would render the 1393 // log we got above invalid. 1394 if (log) 1395 log->Printf ("Process::%s (timeout = %p, event_sp) => %s", 1396 __FUNCTION__, static_cast<const void *>(timeout), 1397 state == eStateInvalid ? "TIMEOUT" : StateAsCString(state)); 1398 return state; 1399 } 1400 1401 bool 1402 Process::WaitForEventsPrivate (const TimeValue *timeout, EventSP &event_sp, bool control_only) 1403 { 1404 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS)); 1405 1406 if (log) 1407 log->Printf ("Process::%s (timeout = %p, event_sp)...", __FUNCTION__, 1408 static_cast<const void*>(timeout)); 1409 1410 if (control_only) 1411 return m_private_state_listener_sp->WaitForEventForBroadcaster(timeout, &m_private_state_control_broadcaster, event_sp); 1412 else 1413 return m_private_state_listener_sp->WaitForEvent(timeout, event_sp); 1414 } 1415 1416 bool 1417 Process::IsRunning () const 1418 { 1419 return StateIsRunningState (m_public_state.GetValue()); 1420 } 1421 1422 int 1423 Process::GetExitStatus () 1424 { 1425 Mutex::Locker locker (m_exit_status_mutex); 1426 1427 if (m_public_state.GetValue() == eStateExited) 1428 return m_exit_status; 1429 return -1; 1430 } 1431 1432 const char * 1433 Process::GetExitDescription () 1434 { 1435 Mutex::Locker locker (m_exit_status_mutex); 1436 1437 if (m_public_state.GetValue() == eStateExited && !m_exit_string.empty()) 1438 return m_exit_string.c_str(); 1439 return nullptr; 1440 } 1441 1442 bool 1443 Process::SetExitStatus (int status, const char *cstr) 1444 { 1445 // Use a mutex to protect setting the exit status. 1446 Mutex::Locker locker (m_exit_status_mutex); 1447 1448 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS)); 1449 if (log) 1450 log->Printf("Process::SetExitStatus (status=%i (0x%8.8x), description=%s%s%s)", 1451 status, status, 1452 cstr ? "\"" : "", 1453 cstr ? cstr : "NULL", 1454 cstr ? "\"" : ""); 1455 1456 // We were already in the exited state 1457 if (m_private_state.GetValue() == eStateExited) 1458 { 1459 if (log) 1460 log->Printf("Process::SetExitStatus () ignoring exit status because state was already set to eStateExited"); 1461 return false; 1462 } 1463 1464 m_exit_status = status; 1465 if (cstr) 1466 m_exit_string = cstr; 1467 else 1468 m_exit_string.clear(); 1469 1470 // When we exit, we don't need the input reader anymore 1471 if (m_process_input_reader) 1472 { 1473 m_process_input_reader->SetIsDone(true); 1474 m_process_input_reader->Cancel(); 1475 m_process_input_reader.reset(); 1476 } 1477 1478 // Clear the last natural stop ID since it has a strong 1479 // reference to this process 1480 m_mod_id.SetStopEventForLastNaturalStopID(EventSP()); 1481 1482 SetPrivateState (eStateExited); 1483 1484 // Allow subclasses to do some cleanup 1485 DidExit (); 1486 1487 return true; 1488 } 1489 1490 bool 1491 Process::IsAlive () 1492 { 1493 switch (m_private_state.GetValue()) 1494 { 1495 case eStateConnected: 1496 case eStateAttaching: 1497 case eStateLaunching: 1498 case eStateStopped: 1499 case eStateRunning: 1500 case eStateStepping: 1501 case eStateCrashed: 1502 case eStateSuspended: 1503 return true; 1504 default: 1505 return false; 1506 } 1507 } 1508 1509 // This static callback can be used to watch for local child processes on 1510 // the current host. The child process exits, the process will be 1511 // found in the global target list (we want to be completely sure that the 1512 // lldb_private::Process doesn't go away before we can deliver the signal. 1513 bool 1514 Process::SetProcessExitStatus (void *callback_baton, 1515 lldb::pid_t pid, 1516 bool exited, 1517 int signo, // Zero for no signal 1518 int exit_status // Exit value of process if signal is zero 1519 ) 1520 { 1521 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_PROCESS)); 1522 if (log) 1523 log->Printf ("Process::SetProcessExitStatus (baton=%p, pid=%" PRIu64 ", exited=%i, signal=%i, exit_status=%i)\n", 1524 callback_baton, 1525 pid, 1526 exited, 1527 signo, 1528 exit_status); 1529 1530 if (exited) 1531 { 1532 TargetSP target_sp(Debugger::FindTargetWithProcessID (pid)); 1533 if (target_sp) 1534 { 1535 ProcessSP process_sp (target_sp->GetProcessSP()); 1536 if (process_sp) 1537 { 1538 const char *signal_cstr = nullptr; 1539 if (signo) 1540 signal_cstr = process_sp->GetUnixSignals()->GetSignalAsCString(signo); 1541 1542 process_sp->SetExitStatus (exit_status, signal_cstr); 1543 } 1544 } 1545 return true; 1546 } 1547 return false; 1548 } 1549 1550 void 1551 Process::UpdateThreadListIfNeeded () 1552 { 1553 const uint32_t stop_id = GetStopID(); 1554 if (m_thread_list.GetSize(false) == 0 || stop_id != m_thread_list.GetStopID()) 1555 { 1556 const StateType state = GetPrivateState(); 1557 if (StateIsStoppedState (state, true)) 1558 { 1559 Mutex::Locker locker (m_thread_list.GetMutex ()); 1560 // m_thread_list does have its own mutex, but we need to 1561 // hold onto the mutex between the call to UpdateThreadList(...) 1562 // and the os->UpdateThreadList(...) so it doesn't change on us 1563 ThreadList &old_thread_list = m_thread_list; 1564 ThreadList real_thread_list(this); 1565 ThreadList new_thread_list(this); 1566 // Always update the thread list with the protocol specific 1567 // thread list, but only update if "true" is returned 1568 if (UpdateThreadList (m_thread_list_real, real_thread_list)) 1569 { 1570 // Don't call into the OperatingSystem to update the thread list if we are shutting down, since 1571 // that may call back into the SBAPI's, requiring the API lock which is already held by whoever is 1572 // shutting us down, causing a deadlock. 1573 OperatingSystem *os = GetOperatingSystem (); 1574 if (os && !m_destroy_in_process) 1575 { 1576 // Clear any old backing threads where memory threads might have been 1577 // backed by actual threads from the lldb_private::Process subclass 1578 size_t num_old_threads = old_thread_list.GetSize(false); 1579 for (size_t i = 0; i < num_old_threads; ++i) 1580 old_thread_list.GetThreadAtIndex(i, false)->ClearBackingThread(); 1581 1582 // Turn off dynamic types to ensure we don't run any expressions. Objective C 1583 // can run an expression to determine if a SBValue is a dynamic type or not 1584 // and we need to avoid this. OperatingSystem plug-ins can't run expressions 1585 // that require running code... 1586 1587 Target &target = GetTarget(); 1588 const lldb::DynamicValueType saved_prefer_dynamic = target.GetPreferDynamicValue (); 1589 if (saved_prefer_dynamic != lldb::eNoDynamicValues) 1590 target.SetPreferDynamicValue(lldb::eNoDynamicValues); 1591 1592 // Now let the OperatingSystem plug-in update the thread list 1593 1594 os->UpdateThreadList (old_thread_list, // Old list full of threads created by OS plug-in 1595 real_thread_list, // The actual thread list full of threads created by each lldb_private::Process subclass 1596 new_thread_list); // The new thread list that we will show to the user that gets filled in 1597 1598 if (saved_prefer_dynamic != lldb::eNoDynamicValues) 1599 target.SetPreferDynamicValue(saved_prefer_dynamic); 1600 } 1601 else 1602 { 1603 // No OS plug-in, the new thread list is the same as the real thread list 1604 new_thread_list = real_thread_list; 1605 } 1606 1607 m_thread_list_real.Update(real_thread_list); 1608 m_thread_list.Update (new_thread_list); 1609 m_thread_list.SetStopID (stop_id); 1610 1611 if (GetLastNaturalStopID () != m_extended_thread_stop_id) 1612 { 1613 // Clear any extended threads that we may have accumulated previously 1614 m_extended_thread_list.Clear(); 1615 m_extended_thread_stop_id = GetLastNaturalStopID (); 1616 1617 m_queue_list.Clear(); 1618 m_queue_list_stop_id = GetLastNaturalStopID (); 1619 } 1620 } 1621 } 1622 } 1623 } 1624 1625 void 1626 Process::UpdateQueueListIfNeeded () 1627 { 1628 if (m_system_runtime_ap) 1629 { 1630 if (m_queue_list.GetSize() == 0 || m_queue_list_stop_id != GetLastNaturalStopID()) 1631 { 1632 const StateType state = GetPrivateState(); 1633 if (StateIsStoppedState (state, true)) 1634 { 1635 m_system_runtime_ap->PopulateQueueList (m_queue_list); 1636 m_queue_list_stop_id = GetLastNaturalStopID(); 1637 } 1638 } 1639 } 1640 } 1641 1642 ThreadSP 1643 Process::CreateOSPluginThread (lldb::tid_t tid, lldb::addr_t context) 1644 { 1645 OperatingSystem *os = GetOperatingSystem (); 1646 if (os) 1647 return os->CreateThread(tid, context); 1648 return ThreadSP(); 1649 } 1650 1651 uint32_t 1652 Process::GetNextThreadIndexID (uint64_t thread_id) 1653 { 1654 return AssignIndexIDToThread(thread_id); 1655 } 1656 1657 bool 1658 Process::HasAssignedIndexIDToThread(uint64_t thread_id) 1659 { 1660 return (m_thread_id_to_index_id_map.find(thread_id) != m_thread_id_to_index_id_map.end()); 1661 } 1662 1663 uint32_t 1664 Process::AssignIndexIDToThread(uint64_t thread_id) 1665 { 1666 uint32_t result = 0; 1667 std::map<uint64_t, uint32_t>::iterator iterator = m_thread_id_to_index_id_map.find(thread_id); 1668 if (iterator == m_thread_id_to_index_id_map.end()) 1669 { 1670 result = ++m_thread_index_id; 1671 m_thread_id_to_index_id_map[thread_id] = result; 1672 } 1673 else 1674 { 1675 result = iterator->second; 1676 } 1677 1678 return result; 1679 } 1680 1681 StateType 1682 Process::GetState() 1683 { 1684 // If any other threads access this we will need a mutex for it 1685 return m_public_state.GetValue (); 1686 } 1687 1688 bool 1689 Process::StateChangedIsExternallyHijacked() 1690 { 1691 if (IsHijackedForEvent(eBroadcastBitStateChanged)) 1692 { 1693 const char *hijacking_name = GetHijackingListenerName(); 1694 if (hijacking_name && strcmp(hijacking_name, "lldb.Process.ResumeSynchronous.hijack")) 1695 return true; 1696 } 1697 return false; 1698 } 1699 1700 void 1701 Process::SetPublicState (StateType new_state, bool restarted) 1702 { 1703 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS)); 1704 if (log) 1705 log->Printf("Process::SetPublicState (state = %s, restarted = %i)", StateAsCString(new_state), restarted); 1706 const StateType old_state = m_public_state.GetValue(); 1707 m_public_state.SetValue (new_state); 1708 1709 // On the transition from Run to Stopped, we unlock the writer end of the 1710 // run lock. The lock gets locked in Resume, which is the public API 1711 // to tell the program to run. 1712 if (!StateChangedIsExternallyHijacked()) 1713 { 1714 if (new_state == eStateDetached) 1715 { 1716 if (log) 1717 log->Printf("Process::SetPublicState (%s) -- unlocking run lock for detach", StateAsCString(new_state)); 1718 m_public_run_lock.SetStopped(); 1719 } 1720 else 1721 { 1722 const bool old_state_is_stopped = StateIsStoppedState(old_state, false); 1723 const bool new_state_is_stopped = StateIsStoppedState(new_state, false); 1724 if ((old_state_is_stopped != new_state_is_stopped)) 1725 { 1726 if (new_state_is_stopped && !restarted) 1727 { 1728 if (log) 1729 log->Printf("Process::SetPublicState (%s) -- unlocking run lock", StateAsCString(new_state)); 1730 m_public_run_lock.SetStopped(); 1731 } 1732 } 1733 } 1734 } 1735 } 1736 1737 Error 1738 Process::Resume () 1739 { 1740 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS)); 1741 if (log) 1742 log->Printf("Process::Resume -- locking run lock"); 1743 if (!m_public_run_lock.TrySetRunning()) 1744 { 1745 Error error("Resume request failed - process still running."); 1746 if (log) 1747 log->Printf ("Process::Resume: -- TrySetRunning failed, not resuming."); 1748 return error; 1749 } 1750 return PrivateResume(); 1751 } 1752 1753 Error 1754 Process::ResumeSynchronous (Stream *stream) 1755 { 1756 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS)); 1757 if (log) 1758 log->Printf("Process::ResumeSynchronous -- locking run lock"); 1759 if (!m_public_run_lock.TrySetRunning()) 1760 { 1761 Error error("Resume request failed - process still running."); 1762 if (log) 1763 log->Printf ("Process::Resume: -- TrySetRunning failed, not resuming."); 1764 return error; 1765 } 1766 1767 ListenerSP listener_sp (Listener::MakeListener("lldb.Process.ResumeSynchronous.hijack")); 1768 HijackProcessEvents(listener_sp); 1769 1770 Error error = PrivateResume(); 1771 if (error.Success()) 1772 { 1773 StateType state = WaitForProcessToStop (NULL, NULL, true, listener_sp, stream); 1774 const bool must_be_alive = false; // eStateExited is ok, so this must be false 1775 if (!StateIsStoppedState(state, must_be_alive)) 1776 error.SetErrorStringWithFormat("process not in stopped state after synchronous resume: %s", StateAsCString(state)); 1777 } 1778 1779 // Undo the hijacking of process events... 1780 RestoreProcessEvents(); 1781 1782 return error; 1783 } 1784 1785 StateType 1786 Process::GetPrivateState () 1787 { 1788 return m_private_state.GetValue(); 1789 } 1790 1791 void 1792 Process::SetPrivateState (StateType new_state) 1793 { 1794 if (m_finalize_called) 1795 return; 1796 1797 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS)); 1798 bool state_changed = false; 1799 1800 if (log) 1801 log->Printf("Process::SetPrivateState (%s)", StateAsCString(new_state)); 1802 1803 Mutex::Locker thread_locker(m_thread_list.GetMutex()); 1804 Mutex::Locker locker(m_private_state.GetMutex()); 1805 1806 const StateType old_state = m_private_state.GetValueNoLock (); 1807 state_changed = old_state != new_state; 1808 1809 const bool old_state_is_stopped = StateIsStoppedState(old_state, false); 1810 const bool new_state_is_stopped = StateIsStoppedState(new_state, false); 1811 if (old_state_is_stopped != new_state_is_stopped) 1812 { 1813 if (new_state_is_stopped) 1814 m_private_run_lock.SetStopped(); 1815 else 1816 m_private_run_lock.SetRunning(); 1817 } 1818 1819 if (state_changed) 1820 { 1821 m_private_state.SetValueNoLock (new_state); 1822 EventSP event_sp (new Event (eBroadcastBitStateChanged, new ProcessEventData (shared_from_this(), new_state))); 1823 if (StateIsStoppedState(new_state, false)) 1824 { 1825 // Note, this currently assumes that all threads in the list 1826 // stop when the process stops. In the future we will want to 1827 // support a debugging model where some threads continue to run 1828 // while others are stopped. When that happens we will either need 1829 // a way for the thread list to identify which threads are stopping 1830 // or create a special thread list containing only threads which 1831 // actually stopped. 1832 // 1833 // The process plugin is responsible for managing the actual 1834 // behavior of the threads and should have stopped any threads 1835 // that are going to stop before we get here. 1836 m_thread_list.DidStop(); 1837 1838 m_mod_id.BumpStopID(); 1839 if (!m_mod_id.IsLastResumeForUserExpression()) 1840 m_mod_id.SetStopEventForLastNaturalStopID(event_sp); 1841 m_memory_cache.Clear(); 1842 if (log) 1843 log->Printf("Process::SetPrivateState (%s) stop_id = %u", StateAsCString(new_state), m_mod_id.GetStopID()); 1844 } 1845 1846 // Use our target to get a shared pointer to ourselves... 1847 if (m_finalize_called && !PrivateStateThreadIsValid()) 1848 BroadcastEvent (event_sp); 1849 else 1850 m_private_state_broadcaster.BroadcastEvent (event_sp); 1851 } 1852 else 1853 { 1854 if (log) 1855 log->Printf("Process::SetPrivateState (%s) state didn't change. Ignoring...", StateAsCString(new_state)); 1856 } 1857 } 1858 1859 void 1860 Process::SetRunningUserExpression (bool on) 1861 { 1862 m_mod_id.SetRunningUserExpression (on); 1863 } 1864 1865 addr_t 1866 Process::GetImageInfoAddress() 1867 { 1868 return LLDB_INVALID_ADDRESS; 1869 } 1870 1871 const lldb::ABISP & 1872 Process::GetABI() 1873 { 1874 if (!m_abi_sp) 1875 m_abi_sp = ABI::FindPlugin(GetTarget().GetArchitecture()); 1876 return m_abi_sp; 1877 } 1878 1879 LanguageRuntime * 1880 Process::GetLanguageRuntime(lldb::LanguageType language, bool retry_if_null) 1881 { 1882 if (m_finalizing) 1883 return nullptr; 1884 1885 LanguageRuntimeCollection::iterator pos; 1886 pos = m_language_runtimes.find (language); 1887 if (pos == m_language_runtimes.end() || (retry_if_null && !(*pos).second)) 1888 { 1889 lldb::LanguageRuntimeSP runtime_sp(LanguageRuntime::FindPlugin(this, language)); 1890 1891 m_language_runtimes[language] = runtime_sp; 1892 return runtime_sp.get(); 1893 } 1894 else 1895 return (*pos).second.get(); 1896 } 1897 1898 CPPLanguageRuntime * 1899 Process::GetCPPLanguageRuntime (bool retry_if_null) 1900 { 1901 LanguageRuntime *runtime = GetLanguageRuntime(eLanguageTypeC_plus_plus, retry_if_null); 1902 if (runtime != nullptr && runtime->GetLanguageType() == eLanguageTypeC_plus_plus) 1903 return static_cast<CPPLanguageRuntime *> (runtime); 1904 return nullptr; 1905 } 1906 1907 ObjCLanguageRuntime * 1908 Process::GetObjCLanguageRuntime (bool retry_if_null) 1909 { 1910 LanguageRuntime *runtime = GetLanguageRuntime(eLanguageTypeObjC, retry_if_null); 1911 if (runtime != nullptr && runtime->GetLanguageType() == eLanguageTypeObjC) 1912 return static_cast<ObjCLanguageRuntime *> (runtime); 1913 return nullptr; 1914 } 1915 1916 bool 1917 Process::IsPossibleDynamicValue (ValueObject& in_value) 1918 { 1919 if (m_finalizing) 1920 return false; 1921 1922 if (in_value.IsDynamic()) 1923 return false; 1924 LanguageType known_type = in_value.GetObjectRuntimeLanguage(); 1925 1926 if (known_type != eLanguageTypeUnknown && known_type != eLanguageTypeC) 1927 { 1928 LanguageRuntime *runtime = GetLanguageRuntime (known_type); 1929 return runtime ? runtime->CouldHaveDynamicValue(in_value) : false; 1930 } 1931 1932 LanguageRuntime *cpp_runtime = GetLanguageRuntime (eLanguageTypeC_plus_plus); 1933 if (cpp_runtime && cpp_runtime->CouldHaveDynamicValue(in_value)) 1934 return true; 1935 1936 LanguageRuntime *objc_runtime = GetLanguageRuntime (eLanguageTypeObjC); 1937 return objc_runtime ? objc_runtime->CouldHaveDynamicValue(in_value) : false; 1938 } 1939 1940 void 1941 Process::SetDynamicCheckers(DynamicCheckerFunctions *dynamic_checkers) 1942 { 1943 m_dynamic_checkers_ap.reset(dynamic_checkers); 1944 } 1945 1946 BreakpointSiteList & 1947 Process::GetBreakpointSiteList() 1948 { 1949 return m_breakpoint_site_list; 1950 } 1951 1952 const BreakpointSiteList & 1953 Process::GetBreakpointSiteList() const 1954 { 1955 return m_breakpoint_site_list; 1956 } 1957 1958 void 1959 Process::DisableAllBreakpointSites () 1960 { 1961 m_breakpoint_site_list.ForEach([this](BreakpointSite *bp_site) -> void { 1962 // bp_site->SetEnabled(true); 1963 DisableBreakpointSite(bp_site); 1964 }); 1965 } 1966 1967 Error 1968 Process::ClearBreakpointSiteByID (lldb::user_id_t break_id) 1969 { 1970 Error error (DisableBreakpointSiteByID (break_id)); 1971 1972 if (error.Success()) 1973 m_breakpoint_site_list.Remove(break_id); 1974 1975 return error; 1976 } 1977 1978 Error 1979 Process::DisableBreakpointSiteByID (lldb::user_id_t break_id) 1980 { 1981 Error error; 1982 BreakpointSiteSP bp_site_sp = m_breakpoint_site_list.FindByID (break_id); 1983 if (bp_site_sp) 1984 { 1985 if (bp_site_sp->IsEnabled()) 1986 error = DisableBreakpointSite (bp_site_sp.get()); 1987 } 1988 else 1989 { 1990 error.SetErrorStringWithFormat("invalid breakpoint site ID: %" PRIu64, break_id); 1991 } 1992 1993 return error; 1994 } 1995 1996 Error 1997 Process::EnableBreakpointSiteByID (lldb::user_id_t break_id) 1998 { 1999 Error error; 2000 BreakpointSiteSP bp_site_sp = m_breakpoint_site_list.FindByID (break_id); 2001 if (bp_site_sp) 2002 { 2003 if (!bp_site_sp->IsEnabled()) 2004 error = EnableBreakpointSite (bp_site_sp.get()); 2005 } 2006 else 2007 { 2008 error.SetErrorStringWithFormat("invalid breakpoint site ID: %" PRIu64, break_id); 2009 } 2010 return error; 2011 } 2012 2013 lldb::break_id_t 2014 Process::CreateBreakpointSite (const BreakpointLocationSP &owner, bool use_hardware) 2015 { 2016 addr_t load_addr = LLDB_INVALID_ADDRESS; 2017 2018 bool show_error = true; 2019 switch (GetState()) 2020 { 2021 case eStateInvalid: 2022 case eStateUnloaded: 2023 case eStateConnected: 2024 case eStateAttaching: 2025 case eStateLaunching: 2026 case eStateDetached: 2027 case eStateExited: 2028 show_error = false; 2029 break; 2030 2031 case eStateStopped: 2032 case eStateRunning: 2033 case eStateStepping: 2034 case eStateCrashed: 2035 case eStateSuspended: 2036 show_error = IsAlive(); 2037 break; 2038 } 2039 2040 // Reset the IsIndirect flag here, in case the location changes from 2041 // pointing to a indirect symbol to a regular symbol. 2042 owner->SetIsIndirect (false); 2043 2044 if (owner->ShouldResolveIndirectFunctions()) 2045 { 2046 Symbol *symbol = owner->GetAddress().CalculateSymbolContextSymbol(); 2047 if (symbol && symbol->IsIndirect()) 2048 { 2049 Error error; 2050 Address symbol_address = symbol->GetAddress(); 2051 load_addr = ResolveIndirectFunction (&symbol_address, error); 2052 if (!error.Success() && show_error) 2053 { 2054 GetTarget().GetDebugger().GetErrorFile()->Printf ("warning: failed to resolve indirect function at 0x%" PRIx64 " for breakpoint %i.%i: %s\n", 2055 symbol->GetLoadAddress(&GetTarget()), 2056 owner->GetBreakpoint().GetID(), 2057 owner->GetID(), 2058 error.AsCString() ? error.AsCString() : "unknown error"); 2059 return LLDB_INVALID_BREAK_ID; 2060 } 2061 Address resolved_address(load_addr); 2062 load_addr = resolved_address.GetOpcodeLoadAddress (&GetTarget()); 2063 owner->SetIsIndirect(true); 2064 } 2065 else 2066 load_addr = owner->GetAddress().GetOpcodeLoadAddress (&GetTarget()); 2067 } 2068 else 2069 load_addr = owner->GetAddress().GetOpcodeLoadAddress (&GetTarget()); 2070 2071 if (load_addr != LLDB_INVALID_ADDRESS) 2072 { 2073 BreakpointSiteSP bp_site_sp; 2074 2075 // Look up this breakpoint site. If it exists, then add this new owner, otherwise 2076 // create a new breakpoint site and add it. 2077 2078 bp_site_sp = m_breakpoint_site_list.FindByAddress (load_addr); 2079 2080 if (bp_site_sp) 2081 { 2082 bp_site_sp->AddOwner (owner); 2083 owner->SetBreakpointSite (bp_site_sp); 2084 return bp_site_sp->GetID(); 2085 } 2086 else 2087 { 2088 bp_site_sp.reset (new BreakpointSite (&m_breakpoint_site_list, owner, load_addr, use_hardware)); 2089 if (bp_site_sp) 2090 { 2091 Error error = EnableBreakpointSite (bp_site_sp.get()); 2092 if (error.Success()) 2093 { 2094 owner->SetBreakpointSite (bp_site_sp); 2095 return m_breakpoint_site_list.Add (bp_site_sp); 2096 } 2097 else 2098 { 2099 if (show_error) 2100 { 2101 // Report error for setting breakpoint... 2102 GetTarget().GetDebugger().GetErrorFile()->Printf ("warning: failed to set breakpoint site at 0x%" PRIx64 " for breakpoint %i.%i: %s\n", 2103 load_addr, 2104 owner->GetBreakpoint().GetID(), 2105 owner->GetID(), 2106 error.AsCString() ? error.AsCString() : "unknown error"); 2107 } 2108 } 2109 } 2110 } 2111 } 2112 // We failed to enable the breakpoint 2113 return LLDB_INVALID_BREAK_ID; 2114 } 2115 2116 void 2117 Process::RemoveOwnerFromBreakpointSite (lldb::user_id_t owner_id, lldb::user_id_t owner_loc_id, BreakpointSiteSP &bp_site_sp) 2118 { 2119 uint32_t num_owners = bp_site_sp->RemoveOwner (owner_id, owner_loc_id); 2120 if (num_owners == 0) 2121 { 2122 // Don't try to disable the site if we don't have a live process anymore. 2123 if (IsAlive()) 2124 DisableBreakpointSite (bp_site_sp.get()); 2125 m_breakpoint_site_list.RemoveByAddress(bp_site_sp->GetLoadAddress()); 2126 } 2127 } 2128 2129 size_t 2130 Process::RemoveBreakpointOpcodesFromBuffer (addr_t bp_addr, size_t size, uint8_t *buf) const 2131 { 2132 size_t bytes_removed = 0; 2133 BreakpointSiteList bp_sites_in_range; 2134 2135 if (m_breakpoint_site_list.FindInRange (bp_addr, bp_addr + size, bp_sites_in_range)) 2136 { 2137 bp_sites_in_range.ForEach([bp_addr, size, buf, &bytes_removed](BreakpointSite *bp_site) -> void { 2138 if (bp_site->GetType() == BreakpointSite::eSoftware) 2139 { 2140 addr_t intersect_addr; 2141 size_t intersect_size; 2142 size_t opcode_offset; 2143 if (bp_site->IntersectsRange(bp_addr, size, &intersect_addr, &intersect_size, &opcode_offset)) 2144 { 2145 assert(bp_addr <= intersect_addr && intersect_addr < bp_addr + size); 2146 assert(bp_addr < intersect_addr + intersect_size && intersect_addr + intersect_size <= bp_addr + size); 2147 assert(opcode_offset + intersect_size <= bp_site->GetByteSize()); 2148 size_t buf_offset = intersect_addr - bp_addr; 2149 ::memcpy(buf + buf_offset, bp_site->GetSavedOpcodeBytes() + opcode_offset, intersect_size); 2150 } 2151 } 2152 }); 2153 } 2154 return bytes_removed; 2155 } 2156 2157 size_t 2158 Process::GetSoftwareBreakpointTrapOpcode (BreakpointSite* bp_site) 2159 { 2160 PlatformSP platform_sp (GetTarget().GetPlatform()); 2161 if (platform_sp) 2162 return platform_sp->GetSoftwareBreakpointTrapOpcode (GetTarget(), bp_site); 2163 return 0; 2164 } 2165 2166 Error 2167 Process::EnableSoftwareBreakpoint (BreakpointSite *bp_site) 2168 { 2169 Error error; 2170 assert(bp_site != nullptr); 2171 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_BREAKPOINTS)); 2172 const addr_t bp_addr = bp_site->GetLoadAddress(); 2173 if (log) 2174 log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64, bp_site->GetID(), (uint64_t)bp_addr); 2175 if (bp_site->IsEnabled()) 2176 { 2177 if (log) 2178 log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- already enabled", bp_site->GetID(), (uint64_t)bp_addr); 2179 return error; 2180 } 2181 2182 if (bp_addr == LLDB_INVALID_ADDRESS) 2183 { 2184 error.SetErrorString("BreakpointSite contains an invalid load address."); 2185 return error; 2186 } 2187 // Ask the lldb::Process subclass to fill in the correct software breakpoint 2188 // trap for the breakpoint site 2189 const size_t bp_opcode_size = GetSoftwareBreakpointTrapOpcode(bp_site); 2190 2191 if (bp_opcode_size == 0) 2192 { 2193 error.SetErrorStringWithFormat ("Process::GetSoftwareBreakpointTrapOpcode() returned zero, unable to get breakpoint trap for address 0x%" PRIx64, bp_addr); 2194 } 2195 else 2196 { 2197 const uint8_t * const bp_opcode_bytes = bp_site->GetTrapOpcodeBytes(); 2198 2199 if (bp_opcode_bytes == nullptr) 2200 { 2201 error.SetErrorString ("BreakpointSite doesn't contain a valid breakpoint trap opcode."); 2202 return error; 2203 } 2204 2205 // Save the original opcode by reading it 2206 if (DoReadMemory(bp_addr, bp_site->GetSavedOpcodeBytes(), bp_opcode_size, error) == bp_opcode_size) 2207 { 2208 // Write a software breakpoint in place of the original opcode 2209 if (DoWriteMemory(bp_addr, bp_opcode_bytes, bp_opcode_size, error) == bp_opcode_size) 2210 { 2211 uint8_t verify_bp_opcode_bytes[64]; 2212 if (DoReadMemory(bp_addr, verify_bp_opcode_bytes, bp_opcode_size, error) == bp_opcode_size) 2213 { 2214 if (::memcmp(bp_opcode_bytes, verify_bp_opcode_bytes, bp_opcode_size) == 0) 2215 { 2216 bp_site->SetEnabled(true); 2217 bp_site->SetType (BreakpointSite::eSoftware); 2218 if (log) 2219 log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- SUCCESS", 2220 bp_site->GetID(), 2221 (uint64_t)bp_addr); 2222 } 2223 else 2224 error.SetErrorString("failed to verify the breakpoint trap in memory."); 2225 } 2226 else 2227 error.SetErrorString("Unable to read memory to verify breakpoint trap."); 2228 } 2229 else 2230 error.SetErrorString("Unable to write breakpoint trap to memory."); 2231 } 2232 else 2233 error.SetErrorString("Unable to read memory at breakpoint address."); 2234 } 2235 if (log && error.Fail()) 2236 log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- FAILED: %s", 2237 bp_site->GetID(), 2238 (uint64_t)bp_addr, 2239 error.AsCString()); 2240 return error; 2241 } 2242 2243 Error 2244 Process::DisableSoftwareBreakpoint (BreakpointSite *bp_site) 2245 { 2246 Error error; 2247 assert(bp_site != nullptr); 2248 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_BREAKPOINTS)); 2249 addr_t bp_addr = bp_site->GetLoadAddress(); 2250 lldb::user_id_t breakID = bp_site->GetID(); 2251 if (log) 2252 log->Printf ("Process::DisableSoftwareBreakpoint (breakID = %" PRIu64 ") addr = 0x%" PRIx64, breakID, (uint64_t)bp_addr); 2253 2254 if (bp_site->IsHardware()) 2255 { 2256 error.SetErrorString("Breakpoint site is a hardware breakpoint."); 2257 } 2258 else if (bp_site->IsEnabled()) 2259 { 2260 const size_t break_op_size = bp_site->GetByteSize(); 2261 const uint8_t * const break_op = bp_site->GetTrapOpcodeBytes(); 2262 if (break_op_size > 0) 2263 { 2264 // Clear a software breakpoint instruction 2265 uint8_t curr_break_op[8]; 2266 assert (break_op_size <= sizeof(curr_break_op)); 2267 bool break_op_found = false; 2268 2269 // Read the breakpoint opcode 2270 if (DoReadMemory (bp_addr, curr_break_op, break_op_size, error) == break_op_size) 2271 { 2272 bool verify = false; 2273 // Make sure the breakpoint opcode exists at this address 2274 if (::memcmp (curr_break_op, break_op, break_op_size) == 0) 2275 { 2276 break_op_found = true; 2277 // We found a valid breakpoint opcode at this address, now restore 2278 // the saved opcode. 2279 if (DoWriteMemory (bp_addr, bp_site->GetSavedOpcodeBytes(), break_op_size, error) == break_op_size) 2280 { 2281 verify = true; 2282 } 2283 else 2284 error.SetErrorString("Memory write failed when restoring original opcode."); 2285 } 2286 else 2287 { 2288 error.SetErrorString("Original breakpoint trap is no longer in memory."); 2289 // Set verify to true and so we can check if the original opcode has already been restored 2290 verify = true; 2291 } 2292 2293 if (verify) 2294 { 2295 uint8_t verify_opcode[8]; 2296 assert (break_op_size < sizeof(verify_opcode)); 2297 // Verify that our original opcode made it back to the inferior 2298 if (DoReadMemory (bp_addr, verify_opcode, break_op_size, error) == break_op_size) 2299 { 2300 // compare the memory we just read with the original opcode 2301 if (::memcmp (bp_site->GetSavedOpcodeBytes(), verify_opcode, break_op_size) == 0) 2302 { 2303 // SUCCESS 2304 bp_site->SetEnabled(false); 2305 if (log) 2306 log->Printf ("Process::DisableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- SUCCESS", bp_site->GetID(), (uint64_t)bp_addr); 2307 return error; 2308 } 2309 else 2310 { 2311 if (break_op_found) 2312 error.SetErrorString("Failed to restore original opcode."); 2313 } 2314 } 2315 else 2316 error.SetErrorString("Failed to read memory to verify that breakpoint trap was restored."); 2317 } 2318 } 2319 else 2320 error.SetErrorString("Unable to read memory that should contain the breakpoint trap."); 2321 } 2322 } 2323 else 2324 { 2325 if (log) 2326 log->Printf ("Process::DisableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- already disabled", bp_site->GetID(), (uint64_t)bp_addr); 2327 return error; 2328 } 2329 2330 if (log) 2331 log->Printf ("Process::DisableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- FAILED: %s", 2332 bp_site->GetID(), 2333 (uint64_t)bp_addr, 2334 error.AsCString()); 2335 return error; 2336 } 2337 2338 // Uncomment to verify memory caching works after making changes to caching code 2339 //#define VERIFY_MEMORY_READS 2340 2341 size_t 2342 Process::ReadMemory (addr_t addr, void *buf, size_t size, Error &error) 2343 { 2344 error.Clear(); 2345 if (!GetDisableMemoryCache()) 2346 { 2347 #if defined (VERIFY_MEMORY_READS) 2348 // Memory caching is enabled, with debug verification 2349 2350 if (buf && size) 2351 { 2352 // Uncomment the line below to make sure memory caching is working. 2353 // I ran this through the test suite and got no assertions, so I am 2354 // pretty confident this is working well. If any changes are made to 2355 // memory caching, uncomment the line below and test your changes! 2356 2357 // Verify all memory reads by using the cache first, then redundantly 2358 // reading the same memory from the inferior and comparing to make sure 2359 // everything is exactly the same. 2360 std::string verify_buf (size, '\0'); 2361 assert (verify_buf.size() == size); 2362 const size_t cache_bytes_read = m_memory_cache.Read (this, addr, buf, size, error); 2363 Error verify_error; 2364 const size_t verify_bytes_read = ReadMemoryFromInferior (addr, const_cast<char *>(verify_buf.data()), verify_buf.size(), verify_error); 2365 assert (cache_bytes_read == verify_bytes_read); 2366 assert (memcmp(buf, verify_buf.data(), verify_buf.size()) == 0); 2367 assert (verify_error.Success() == error.Success()); 2368 return cache_bytes_read; 2369 } 2370 return 0; 2371 #else // !defined(VERIFY_MEMORY_READS) 2372 // Memory caching is enabled, without debug verification 2373 2374 return m_memory_cache.Read (addr, buf, size, error); 2375 #endif // defined (VERIFY_MEMORY_READS) 2376 } 2377 else 2378 { 2379 // Memory caching is disabled 2380 2381 return ReadMemoryFromInferior (addr, buf, size, error); 2382 } 2383 } 2384 2385 size_t 2386 Process::ReadCStringFromMemory (addr_t addr, std::string &out_str, Error &error) 2387 { 2388 char buf[256]; 2389 out_str.clear(); 2390 addr_t curr_addr = addr; 2391 while (true) 2392 { 2393 size_t length = ReadCStringFromMemory (curr_addr, buf, sizeof(buf), error); 2394 if (length == 0) 2395 break; 2396 out_str.append(buf, length); 2397 // If we got "length - 1" bytes, we didn't get the whole C string, we 2398 // need to read some more characters 2399 if (length == sizeof(buf) - 1) 2400 curr_addr += length; 2401 else 2402 break; 2403 } 2404 return out_str.size(); 2405 } 2406 2407 size_t 2408 Process::ReadStringFromMemory (addr_t addr, char *dst, size_t max_bytes, Error &error, 2409 size_t type_width) 2410 { 2411 size_t total_bytes_read = 0; 2412 if (dst && max_bytes && type_width && max_bytes >= type_width) 2413 { 2414 // Ensure a null terminator independent of the number of bytes that is read. 2415 memset (dst, 0, max_bytes); 2416 size_t bytes_left = max_bytes - type_width; 2417 2418 const char terminator[4] = {'\0', '\0', '\0', '\0'}; 2419 assert(sizeof(terminator) >= type_width && 2420 "Attempting to validate a string with more than 4 bytes per character!"); 2421 2422 addr_t curr_addr = addr; 2423 const size_t cache_line_size = m_memory_cache.GetMemoryCacheLineSize(); 2424 char *curr_dst = dst; 2425 2426 error.Clear(); 2427 while (bytes_left > 0 && error.Success()) 2428 { 2429 addr_t cache_line_bytes_left = cache_line_size - (curr_addr % cache_line_size); 2430 addr_t bytes_to_read = std::min<addr_t>(bytes_left, cache_line_bytes_left); 2431 size_t bytes_read = ReadMemory (curr_addr, curr_dst, bytes_to_read, error); 2432 2433 if (bytes_read == 0) 2434 break; 2435 2436 // Search for a null terminator of correct size and alignment in bytes_read 2437 size_t aligned_start = total_bytes_read - total_bytes_read % type_width; 2438 for (size_t i = aligned_start; i + type_width <= total_bytes_read + bytes_read; i += type_width) 2439 if (::strncmp(&dst[i], terminator, type_width) == 0) 2440 { 2441 error.Clear(); 2442 return i; 2443 } 2444 2445 total_bytes_read += bytes_read; 2446 curr_dst += bytes_read; 2447 curr_addr += bytes_read; 2448 bytes_left -= bytes_read; 2449 } 2450 } 2451 else 2452 { 2453 if (max_bytes) 2454 error.SetErrorString("invalid arguments"); 2455 } 2456 return total_bytes_read; 2457 } 2458 2459 // Deprecated in favor of ReadStringFromMemory which has wchar support and correct code to find 2460 // null terminators. 2461 size_t 2462 Process::ReadCStringFromMemory (addr_t addr, char *dst, size_t dst_max_len, Error &result_error) 2463 { 2464 size_t total_cstr_len = 0; 2465 if (dst && dst_max_len) 2466 { 2467 result_error.Clear(); 2468 // NULL out everything just to be safe 2469 memset (dst, 0, dst_max_len); 2470 Error error; 2471 addr_t curr_addr = addr; 2472 const size_t cache_line_size = m_memory_cache.GetMemoryCacheLineSize(); 2473 size_t bytes_left = dst_max_len - 1; 2474 char *curr_dst = dst; 2475 2476 while (bytes_left > 0) 2477 { 2478 addr_t cache_line_bytes_left = cache_line_size - (curr_addr % cache_line_size); 2479 addr_t bytes_to_read = std::min<addr_t>(bytes_left, cache_line_bytes_left); 2480 size_t bytes_read = ReadMemory (curr_addr, curr_dst, bytes_to_read, error); 2481 2482 if (bytes_read == 0) 2483 { 2484 result_error = error; 2485 dst[total_cstr_len] = '\0'; 2486 break; 2487 } 2488 const size_t len = strlen(curr_dst); 2489 2490 total_cstr_len += len; 2491 2492 if (len < bytes_to_read) 2493 break; 2494 2495 curr_dst += bytes_read; 2496 curr_addr += bytes_read; 2497 bytes_left -= bytes_read; 2498 } 2499 } 2500 else 2501 { 2502 if (dst == nullptr) 2503 result_error.SetErrorString("invalid arguments"); 2504 else 2505 result_error.Clear(); 2506 } 2507 return total_cstr_len; 2508 } 2509 2510 size_t 2511 Process::ReadMemoryFromInferior (addr_t addr, void *buf, size_t size, Error &error) 2512 { 2513 if (buf == nullptr || size == 0) 2514 return 0; 2515 2516 size_t bytes_read = 0; 2517 uint8_t *bytes = (uint8_t *)buf; 2518 2519 while (bytes_read < size) 2520 { 2521 const size_t curr_size = size - bytes_read; 2522 const size_t curr_bytes_read = DoReadMemory (addr + bytes_read, 2523 bytes + bytes_read, 2524 curr_size, 2525 error); 2526 bytes_read += curr_bytes_read; 2527 if (curr_bytes_read == curr_size || curr_bytes_read == 0) 2528 break; 2529 } 2530 2531 // Replace any software breakpoint opcodes that fall into this range back 2532 // into "buf" before we return 2533 if (bytes_read > 0) 2534 RemoveBreakpointOpcodesFromBuffer (addr, bytes_read, (uint8_t *)buf); 2535 return bytes_read; 2536 } 2537 2538 uint64_t 2539 Process::ReadUnsignedIntegerFromMemory (lldb::addr_t vm_addr, size_t integer_byte_size, uint64_t fail_value, Error &error) 2540 { 2541 Scalar scalar; 2542 if (ReadScalarIntegerFromMemory(vm_addr, integer_byte_size, false, scalar, error)) 2543 return scalar.ULongLong(fail_value); 2544 return fail_value; 2545 } 2546 2547 addr_t 2548 Process::ReadPointerFromMemory (lldb::addr_t vm_addr, Error &error) 2549 { 2550 Scalar scalar; 2551 if (ReadScalarIntegerFromMemory(vm_addr, GetAddressByteSize(), false, scalar, error)) 2552 return scalar.ULongLong(LLDB_INVALID_ADDRESS); 2553 return LLDB_INVALID_ADDRESS; 2554 } 2555 2556 bool 2557 Process::WritePointerToMemory (lldb::addr_t vm_addr, 2558 lldb::addr_t ptr_value, 2559 Error &error) 2560 { 2561 Scalar scalar; 2562 const uint32_t addr_byte_size = GetAddressByteSize(); 2563 if (addr_byte_size <= 4) 2564 scalar = (uint32_t)ptr_value; 2565 else 2566 scalar = ptr_value; 2567 return WriteScalarToMemory(vm_addr, scalar, addr_byte_size, error) == addr_byte_size; 2568 } 2569 2570 size_t 2571 Process::WriteMemoryPrivate (addr_t addr, const void *buf, size_t size, Error &error) 2572 { 2573 size_t bytes_written = 0; 2574 const uint8_t *bytes = (const uint8_t *)buf; 2575 2576 while (bytes_written < size) 2577 { 2578 const size_t curr_size = size - bytes_written; 2579 const size_t curr_bytes_written = DoWriteMemory (addr + bytes_written, 2580 bytes + bytes_written, 2581 curr_size, 2582 error); 2583 bytes_written += curr_bytes_written; 2584 if (curr_bytes_written == curr_size || curr_bytes_written == 0) 2585 break; 2586 } 2587 return bytes_written; 2588 } 2589 2590 size_t 2591 Process::WriteMemory (addr_t addr, const void *buf, size_t size, Error &error) 2592 { 2593 #if defined (ENABLE_MEMORY_CACHING) 2594 m_memory_cache.Flush (addr, size); 2595 #endif 2596 2597 if (buf == nullptr || size == 0) 2598 return 0; 2599 2600 m_mod_id.BumpMemoryID(); 2601 2602 // We need to write any data that would go where any current software traps 2603 // (enabled software breakpoints) any software traps (breakpoints) that we 2604 // may have placed in our tasks memory. 2605 2606 BreakpointSiteList bp_sites_in_range; 2607 2608 if (m_breakpoint_site_list.FindInRange (addr, addr + size, bp_sites_in_range)) 2609 { 2610 // No breakpoint sites overlap 2611 if (bp_sites_in_range.IsEmpty()) 2612 return WriteMemoryPrivate (addr, buf, size, error); 2613 else 2614 { 2615 const uint8_t *ubuf = (const uint8_t *)buf; 2616 uint64_t bytes_written = 0; 2617 2618 bp_sites_in_range.ForEach([this, addr, size, &bytes_written, &ubuf, &error](BreakpointSite *bp) -> void { 2619 2620 if (error.Success()) 2621 { 2622 addr_t intersect_addr; 2623 size_t intersect_size; 2624 size_t opcode_offset; 2625 const bool intersects = bp->IntersectsRange(addr, size, &intersect_addr, &intersect_size, &opcode_offset); 2626 UNUSED_IF_ASSERT_DISABLED(intersects); 2627 assert(intersects); 2628 assert(addr <= intersect_addr && intersect_addr < addr + size); 2629 assert(addr < intersect_addr + intersect_size && intersect_addr + intersect_size <= addr + size); 2630 assert(opcode_offset + intersect_size <= bp->GetByteSize()); 2631 2632 // Check for bytes before this breakpoint 2633 const addr_t curr_addr = addr + bytes_written; 2634 if (intersect_addr > curr_addr) 2635 { 2636 // There are some bytes before this breakpoint that we need to 2637 // just write to memory 2638 size_t curr_size = intersect_addr - curr_addr; 2639 size_t curr_bytes_written = WriteMemoryPrivate (curr_addr, 2640 ubuf + bytes_written, 2641 curr_size, 2642 error); 2643 bytes_written += curr_bytes_written; 2644 if (curr_bytes_written != curr_size) 2645 { 2646 // We weren't able to write all of the requested bytes, we 2647 // are done looping and will return the number of bytes that 2648 // we have written so far. 2649 if (error.Success()) 2650 error.SetErrorToGenericError(); 2651 } 2652 } 2653 // Now write any bytes that would cover up any software breakpoints 2654 // directly into the breakpoint opcode buffer 2655 ::memcpy(bp->GetSavedOpcodeBytes() + opcode_offset, ubuf + bytes_written, intersect_size); 2656 bytes_written += intersect_size; 2657 } 2658 }); 2659 2660 if (bytes_written < size) 2661 WriteMemoryPrivate (addr + bytes_written, 2662 ubuf + bytes_written, 2663 size - bytes_written, 2664 error); 2665 } 2666 } 2667 else 2668 { 2669 return WriteMemoryPrivate (addr, buf, size, error); 2670 } 2671 2672 // Write any remaining bytes after the last breakpoint if we have any left 2673 return 0; //bytes_written; 2674 } 2675 2676 size_t 2677 Process::WriteScalarToMemory (addr_t addr, const Scalar &scalar, size_t byte_size, Error &error) 2678 { 2679 if (byte_size == UINT32_MAX) 2680 byte_size = scalar.GetByteSize(); 2681 if (byte_size > 0) 2682 { 2683 uint8_t buf[32]; 2684 const size_t mem_size = scalar.GetAsMemoryData (buf, byte_size, GetByteOrder(), error); 2685 if (mem_size > 0) 2686 return WriteMemory(addr, buf, mem_size, error); 2687 else 2688 error.SetErrorString ("failed to get scalar as memory data"); 2689 } 2690 else 2691 { 2692 error.SetErrorString ("invalid scalar value"); 2693 } 2694 return 0; 2695 } 2696 2697 size_t 2698 Process::ReadScalarIntegerFromMemory (addr_t addr, 2699 uint32_t byte_size, 2700 bool is_signed, 2701 Scalar &scalar, 2702 Error &error) 2703 { 2704 uint64_t uval = 0; 2705 if (byte_size == 0) 2706 { 2707 error.SetErrorString ("byte size is zero"); 2708 } 2709 else if (byte_size & (byte_size - 1)) 2710 { 2711 error.SetErrorStringWithFormat ("byte size %u is not a power of 2", byte_size); 2712 } 2713 else if (byte_size <= sizeof(uval)) 2714 { 2715 const size_t bytes_read = ReadMemory (addr, &uval, byte_size, error); 2716 if (bytes_read == byte_size) 2717 { 2718 DataExtractor data (&uval, sizeof(uval), GetByteOrder(), GetAddressByteSize()); 2719 lldb::offset_t offset = 0; 2720 if (byte_size <= 4) 2721 scalar = data.GetMaxU32 (&offset, byte_size); 2722 else 2723 scalar = data.GetMaxU64 (&offset, byte_size); 2724 if (is_signed) 2725 scalar.SignExtend(byte_size * 8); 2726 return bytes_read; 2727 } 2728 } 2729 else 2730 { 2731 error.SetErrorStringWithFormat ("byte size of %u is too large for integer scalar type", byte_size); 2732 } 2733 return 0; 2734 } 2735 2736 #define USE_ALLOCATE_MEMORY_CACHE 1 2737 addr_t 2738 Process::AllocateMemory(size_t size, uint32_t permissions, Error &error) 2739 { 2740 if (GetPrivateState() != eStateStopped) 2741 return LLDB_INVALID_ADDRESS; 2742 2743 #if defined (USE_ALLOCATE_MEMORY_CACHE) 2744 return m_allocated_memory_cache.AllocateMemory(size, permissions, error); 2745 #else 2746 addr_t allocated_addr = DoAllocateMemory (size, permissions, error); 2747 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS)); 2748 if (log) 2749 log->Printf("Process::AllocateMemory(size=%" PRIu64 ", permissions=%s) => 0x%16.16" PRIx64 " (m_stop_id = %u m_memory_id = %u)", 2750 (uint64_t)size, 2751 GetPermissionsAsCString (permissions), 2752 (uint64_t)allocated_addr, 2753 m_mod_id.GetStopID(), 2754 m_mod_id.GetMemoryID()); 2755 return allocated_addr; 2756 #endif 2757 } 2758 2759 addr_t 2760 Process::CallocateMemory(size_t size, uint32_t permissions, Error &error) 2761 { 2762 addr_t return_addr = AllocateMemory(size, permissions, error); 2763 if (error.Success()) 2764 { 2765 std::string buffer(size, 0); 2766 WriteMemory(return_addr, buffer.c_str(), size, error); 2767 } 2768 return return_addr; 2769 } 2770 2771 bool 2772 Process::CanJIT () 2773 { 2774 if (m_can_jit == eCanJITDontKnow) 2775 { 2776 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS)); 2777 Error err; 2778 2779 uint64_t allocated_memory = AllocateMemory(8, 2780 ePermissionsReadable | ePermissionsWritable | ePermissionsExecutable, 2781 err); 2782 2783 if (err.Success()) 2784 { 2785 m_can_jit = eCanJITYes; 2786 if (log) 2787 log->Printf ("Process::%s pid %" PRIu64 " allocation test passed, CanJIT () is true", __FUNCTION__, GetID ()); 2788 } 2789 else 2790 { 2791 m_can_jit = eCanJITNo; 2792 if (log) 2793 log->Printf ("Process::%s pid %" PRIu64 " allocation test failed, CanJIT () is false: %s", __FUNCTION__, GetID (), err.AsCString ()); 2794 } 2795 2796 DeallocateMemory (allocated_memory); 2797 } 2798 2799 return m_can_jit == eCanJITYes; 2800 } 2801 2802 void 2803 Process::SetCanJIT (bool can_jit) 2804 { 2805 m_can_jit = (can_jit ? eCanJITYes : eCanJITNo); 2806 } 2807 2808 void 2809 Process::SetCanRunCode (bool can_run_code) 2810 { 2811 SetCanJIT(can_run_code); 2812 m_can_interpret_function_calls = can_run_code; 2813 } 2814 2815 Error 2816 Process::DeallocateMemory (addr_t ptr) 2817 { 2818 Error error; 2819 #if defined (USE_ALLOCATE_MEMORY_CACHE) 2820 if (!m_allocated_memory_cache.DeallocateMemory(ptr)) 2821 { 2822 error.SetErrorStringWithFormat ("deallocation of memory at 0x%" PRIx64 " failed.", (uint64_t)ptr); 2823 } 2824 #else 2825 error = DoDeallocateMemory (ptr); 2826 2827 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS)); 2828 if (log) 2829 log->Printf("Process::DeallocateMemory(addr=0x%16.16" PRIx64 ") => err = %s (m_stop_id = %u, m_memory_id = %u)", 2830 ptr, 2831 error.AsCString("SUCCESS"), 2832 m_mod_id.GetStopID(), 2833 m_mod_id.GetMemoryID()); 2834 #endif 2835 return error; 2836 } 2837 2838 ModuleSP 2839 Process::ReadModuleFromMemory (const FileSpec& file_spec, 2840 lldb::addr_t header_addr, 2841 size_t size_to_read) 2842 { 2843 Log *log = lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_HOST); 2844 if (log) 2845 { 2846 log->Printf ("Process::ReadModuleFromMemory reading %s binary from memory", file_spec.GetPath().c_str()); 2847 } 2848 ModuleSP module_sp (new Module (file_spec, ArchSpec())); 2849 if (module_sp) 2850 { 2851 Error error; 2852 ObjectFile *objfile = module_sp->GetMemoryObjectFile (shared_from_this(), header_addr, error, size_to_read); 2853 if (objfile) 2854 return module_sp; 2855 } 2856 return ModuleSP(); 2857 } 2858 2859 bool 2860 Process::GetLoadAddressPermissions (lldb::addr_t load_addr, uint32_t &permissions) 2861 { 2862 MemoryRegionInfo range_info; 2863 permissions = 0; 2864 Error error (GetMemoryRegionInfo (load_addr, range_info)); 2865 if (!error.Success()) 2866 return false; 2867 if (range_info.GetReadable() == MemoryRegionInfo::eDontKnow 2868 || range_info.GetWritable() == MemoryRegionInfo::eDontKnow 2869 || range_info.GetExecutable() == MemoryRegionInfo::eDontKnow) 2870 { 2871 return false; 2872 } 2873 2874 if (range_info.GetReadable() == MemoryRegionInfo::eYes) 2875 permissions |= lldb::ePermissionsReadable; 2876 2877 if (range_info.GetWritable() == MemoryRegionInfo::eYes) 2878 permissions |= lldb::ePermissionsWritable; 2879 2880 if (range_info.GetExecutable() == MemoryRegionInfo::eYes) 2881 permissions |= lldb::ePermissionsExecutable; 2882 2883 return true; 2884 } 2885 2886 Error 2887 Process::EnableWatchpoint (Watchpoint *watchpoint, bool notify) 2888 { 2889 Error error; 2890 error.SetErrorString("watchpoints are not supported"); 2891 return error; 2892 } 2893 2894 Error 2895 Process::DisableWatchpoint (Watchpoint *watchpoint, bool notify) 2896 { 2897 Error error; 2898 error.SetErrorString("watchpoints are not supported"); 2899 return error; 2900 } 2901 2902 StateType 2903 Process::WaitForProcessStopPrivate (const TimeValue *timeout, EventSP &event_sp) 2904 { 2905 StateType state; 2906 // Now wait for the process to launch and return control to us, and then 2907 // call DidLaunch: 2908 while (true) 2909 { 2910 event_sp.reset(); 2911 state = WaitForStateChangedEventsPrivate (timeout, event_sp); 2912 2913 if (StateIsStoppedState(state, false)) 2914 break; 2915 2916 // If state is invalid, then we timed out 2917 if (state == eStateInvalid) 2918 break; 2919 2920 if (event_sp) 2921 HandlePrivateEvent (event_sp); 2922 } 2923 return state; 2924 } 2925 2926 void 2927 Process::LoadOperatingSystemPlugin(bool flush) 2928 { 2929 if (flush) 2930 m_thread_list.Clear(); 2931 m_os_ap.reset(OperatingSystem::FindPlugin(this, nullptr)); 2932 if (flush) 2933 Flush(); 2934 } 2935 2936 Error 2937 Process::Launch (ProcessLaunchInfo &launch_info) 2938 { 2939 Error error; 2940 m_abi_sp.reset(); 2941 m_dyld_ap.reset(); 2942 m_jit_loaders_ap.reset(); 2943 m_system_runtime_ap.reset(); 2944 m_os_ap.reset(); 2945 m_process_input_reader.reset(); 2946 m_stop_info_override_callback = nullptr; 2947 2948 Module *exe_module = GetTarget().GetExecutableModulePointer(); 2949 if (exe_module) 2950 { 2951 char local_exec_file_path[PATH_MAX]; 2952 char platform_exec_file_path[PATH_MAX]; 2953 exe_module->GetFileSpec().GetPath(local_exec_file_path, sizeof(local_exec_file_path)); 2954 exe_module->GetPlatformFileSpec().GetPath(platform_exec_file_path, sizeof(platform_exec_file_path)); 2955 if (exe_module->GetFileSpec().Exists()) 2956 { 2957 // Install anything that might need to be installed prior to launching. 2958 // For host systems, this will do nothing, but if we are connected to a 2959 // remote platform it will install any needed binaries 2960 error = GetTarget().Install(&launch_info); 2961 if (error.Fail()) 2962 return error; 2963 2964 if (PrivateStateThreadIsValid ()) 2965 PausePrivateStateThread (); 2966 2967 error = WillLaunch (exe_module); 2968 if (error.Success()) 2969 { 2970 const bool restarted = false; 2971 SetPublicState (eStateLaunching, restarted); 2972 m_should_detach = false; 2973 2974 if (m_public_run_lock.TrySetRunning()) 2975 { 2976 // Now launch using these arguments. 2977 error = DoLaunch (exe_module, launch_info); 2978 } 2979 else 2980 { 2981 // This shouldn't happen 2982 error.SetErrorString("failed to acquire process run lock"); 2983 } 2984 2985 if (error.Fail()) 2986 { 2987 if (GetID() != LLDB_INVALID_PROCESS_ID) 2988 { 2989 SetID (LLDB_INVALID_PROCESS_ID); 2990 const char *error_string = error.AsCString(); 2991 if (error_string == nullptr) 2992 error_string = "launch failed"; 2993 SetExitStatus (-1, error_string); 2994 } 2995 } 2996 else 2997 { 2998 EventSP event_sp; 2999 TimeValue timeout_time; 3000 timeout_time = TimeValue::Now(); 3001 timeout_time.OffsetWithSeconds(10); 3002 StateType state = WaitForProcessStopPrivate(&timeout_time, event_sp); 3003 3004 if (state == eStateInvalid || !event_sp) 3005 { 3006 // We were able to launch the process, but we failed to 3007 // catch the initial stop. 3008 error.SetErrorString ("failed to catch stop after launch"); 3009 SetExitStatus (0, "failed to catch stop after launch"); 3010 Destroy(false); 3011 } 3012 else if (state == eStateStopped || state == eStateCrashed) 3013 { 3014 DidLaunch (); 3015 3016 DynamicLoader *dyld = GetDynamicLoader (); 3017 if (dyld) 3018 dyld->DidLaunch(); 3019 3020 GetJITLoaders().DidLaunch(); 3021 3022 SystemRuntime *system_runtime = GetSystemRuntime (); 3023 if (system_runtime) 3024 system_runtime->DidLaunch(); 3025 3026 LoadOperatingSystemPlugin(false); 3027 3028 // Note, the stop event was consumed above, but not handled. This was done 3029 // to give DidLaunch a chance to run. The target is either stopped or crashed. 3030 // Directly set the state. This is done to prevent a stop message with a bunch 3031 // of spurious output on thread status, as well as not pop a ProcessIOHandler. 3032 SetPublicState(state, false); 3033 3034 if (PrivateStateThreadIsValid ()) 3035 ResumePrivateStateThread (); 3036 else 3037 StartPrivateStateThread (); 3038 3039 m_stop_info_override_callback = GetTarget().GetArchitecture().GetStopInfoOverrideCallback(); 3040 3041 // Target was stopped at entry as was intended. Need to notify the listeners 3042 // about it. 3043 if (state == eStateStopped && launch_info.GetFlags().Test(eLaunchFlagStopAtEntry)) 3044 HandlePrivateEvent(event_sp); 3045 } 3046 else if (state == eStateExited) 3047 { 3048 // We exited while trying to launch somehow. Don't call DidLaunch as that's 3049 // not likely to work, and return an invalid pid. 3050 HandlePrivateEvent (event_sp); 3051 } 3052 } 3053 } 3054 } 3055 else 3056 { 3057 error.SetErrorStringWithFormat("file doesn't exist: '%s'", local_exec_file_path); 3058 } 3059 } 3060 return error; 3061 } 3062 3063 Error 3064 Process::LoadCore () 3065 { 3066 Error error = DoLoadCore(); 3067 if (error.Success()) 3068 { 3069 ListenerSP listener_sp (Listener::MakeListener("lldb.process.load_core_listener")); 3070 HijackProcessEvents(listener_sp); 3071 3072 if (PrivateStateThreadIsValid ()) 3073 ResumePrivateStateThread (); 3074 else 3075 StartPrivateStateThread (); 3076 3077 DynamicLoader *dyld = GetDynamicLoader (); 3078 if (dyld) 3079 dyld->DidAttach(); 3080 3081 GetJITLoaders().DidAttach(); 3082 3083 SystemRuntime *system_runtime = GetSystemRuntime (); 3084 if (system_runtime) 3085 system_runtime->DidAttach(); 3086 3087 m_os_ap.reset(OperatingSystem::FindPlugin(this, nullptr)); 3088 // We successfully loaded a core file, now pretend we stopped so we can 3089 // show all of the threads in the core file and explore the crashed 3090 // state. 3091 SetPrivateState (eStateStopped); 3092 3093 // Wait indefinitely for a stopped event since we just posted one above... 3094 lldb::EventSP event_sp; 3095 listener_sp->WaitForEvent (nullptr, event_sp); 3096 StateType state = ProcessEventData::GetStateFromEvent(event_sp.get()); 3097 3098 if (!StateIsStoppedState (state, false)) 3099 { 3100 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS)); 3101 if (log) 3102 log->Printf("Process::Halt() failed to stop, state is: %s", StateAsCString(state)); 3103 error.SetErrorString ("Did not get stopped event after loading the core file."); 3104 } 3105 RestoreProcessEvents (); 3106 } 3107 return error; 3108 } 3109 3110 DynamicLoader * 3111 Process::GetDynamicLoader () 3112 { 3113 if (!m_dyld_ap) 3114 m_dyld_ap.reset(DynamicLoader::FindPlugin(this, nullptr)); 3115 return m_dyld_ap.get(); 3116 } 3117 3118 const lldb::DataBufferSP 3119 Process::GetAuxvData() 3120 { 3121 return DataBufferSP (); 3122 } 3123 3124 JITLoaderList & 3125 Process::GetJITLoaders () 3126 { 3127 if (!m_jit_loaders_ap) 3128 { 3129 m_jit_loaders_ap.reset(new JITLoaderList()); 3130 JITLoader::LoadPlugins(this, *m_jit_loaders_ap); 3131 } 3132 return *m_jit_loaders_ap; 3133 } 3134 3135 SystemRuntime * 3136 Process::GetSystemRuntime () 3137 { 3138 if (!m_system_runtime_ap) 3139 m_system_runtime_ap.reset(SystemRuntime::FindPlugin(this)); 3140 return m_system_runtime_ap.get(); 3141 } 3142 3143 Process::AttachCompletionHandler::AttachCompletionHandler (Process *process, uint32_t exec_count) : 3144 NextEventAction (process), 3145 m_exec_count (exec_count) 3146 { 3147 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS)); 3148 if (log) 3149 log->Printf ("Process::AttachCompletionHandler::%s process=%p, exec_count=%" PRIu32, __FUNCTION__, static_cast<void*>(process), exec_count); 3150 } 3151 3152 Process::NextEventAction::EventActionResult 3153 Process::AttachCompletionHandler::PerformAction (lldb::EventSP &event_sp) 3154 { 3155 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS)); 3156 3157 StateType state = ProcessEventData::GetStateFromEvent (event_sp.get()); 3158 if (log) 3159 log->Printf ("Process::AttachCompletionHandler::%s called with state %s (%d)", __FUNCTION__, StateAsCString(state), static_cast<int> (state)); 3160 3161 switch (state) 3162 { 3163 case eStateAttaching: 3164 return eEventActionSuccess; 3165 3166 case eStateRunning: 3167 case eStateConnected: 3168 return eEventActionRetry; 3169 3170 case eStateStopped: 3171 case eStateCrashed: 3172 // During attach, prior to sending the eStateStopped event, 3173 // lldb_private::Process subclasses must set the new process ID. 3174 assert (m_process->GetID() != LLDB_INVALID_PROCESS_ID); 3175 // We don't want these events to be reported, so go set the ShouldReportStop here: 3176 m_process->GetThreadList().SetShouldReportStop (eVoteNo); 3177 3178 if (m_exec_count > 0) 3179 { 3180 --m_exec_count; 3181 3182 if (log) 3183 log->Printf ("Process::AttachCompletionHandler::%s state %s: reduced remaining exec count to %" PRIu32 ", requesting resume", __FUNCTION__, StateAsCString(state), m_exec_count); 3184 3185 RequestResume(); 3186 return eEventActionRetry; 3187 } 3188 else 3189 { 3190 if (log) 3191 log->Printf ("Process::AttachCompletionHandler::%s state %s: no more execs expected to start, continuing with attach", __FUNCTION__, StateAsCString(state)); 3192 3193 m_process->CompleteAttach (); 3194 return eEventActionSuccess; 3195 } 3196 break; 3197 3198 default: 3199 case eStateExited: 3200 case eStateInvalid: 3201 break; 3202 } 3203 3204 m_exit_string.assign ("No valid Process"); 3205 return eEventActionExit; 3206 } 3207 3208 Process::NextEventAction::EventActionResult 3209 Process::AttachCompletionHandler::HandleBeingInterrupted() 3210 { 3211 return eEventActionSuccess; 3212 } 3213 3214 const char * 3215 Process::AttachCompletionHandler::GetExitString () 3216 { 3217 return m_exit_string.c_str(); 3218 } 3219 3220 ListenerSP 3221 ProcessAttachInfo::GetListenerForProcess (Debugger &debugger) 3222 { 3223 if (m_listener_sp) 3224 return m_listener_sp; 3225 else 3226 return debugger.GetListener(); 3227 } 3228 3229 Error 3230 Process::Attach (ProcessAttachInfo &attach_info) 3231 { 3232 m_abi_sp.reset(); 3233 m_process_input_reader.reset(); 3234 m_dyld_ap.reset(); 3235 m_jit_loaders_ap.reset(); 3236 m_system_runtime_ap.reset(); 3237 m_os_ap.reset(); 3238 m_stop_info_override_callback = nullptr; 3239 3240 lldb::pid_t attach_pid = attach_info.GetProcessID(); 3241 Error error; 3242 if (attach_pid == LLDB_INVALID_PROCESS_ID) 3243 { 3244 char process_name[PATH_MAX]; 3245 3246 if (attach_info.GetExecutableFile().GetPath (process_name, sizeof(process_name))) 3247 { 3248 const bool wait_for_launch = attach_info.GetWaitForLaunch(); 3249 3250 if (wait_for_launch) 3251 { 3252 error = WillAttachToProcessWithName(process_name, wait_for_launch); 3253 if (error.Success()) 3254 { 3255 if (m_public_run_lock.TrySetRunning()) 3256 { 3257 m_should_detach = true; 3258 const bool restarted = false; 3259 SetPublicState (eStateAttaching, restarted); 3260 // Now attach using these arguments. 3261 error = DoAttachToProcessWithName (process_name, attach_info); 3262 } 3263 else 3264 { 3265 // This shouldn't happen 3266 error.SetErrorString("failed to acquire process run lock"); 3267 } 3268 3269 if (error.Fail()) 3270 { 3271 if (GetID() != LLDB_INVALID_PROCESS_ID) 3272 { 3273 SetID (LLDB_INVALID_PROCESS_ID); 3274 if (error.AsCString() == nullptr) 3275 error.SetErrorString("attach failed"); 3276 3277 SetExitStatus(-1, error.AsCString()); 3278 } 3279 } 3280 else 3281 { 3282 SetNextEventAction(new Process::AttachCompletionHandler(this, attach_info.GetResumeCount())); 3283 StartPrivateStateThread(); 3284 } 3285 return error; 3286 } 3287 } 3288 else 3289 { 3290 ProcessInstanceInfoList process_infos; 3291 PlatformSP platform_sp (GetTarget().GetPlatform ()); 3292 3293 if (platform_sp) 3294 { 3295 ProcessInstanceInfoMatch match_info; 3296 match_info.GetProcessInfo() = attach_info; 3297 match_info.SetNameMatchType (eNameMatchEquals); 3298 platform_sp->FindProcesses (match_info, process_infos); 3299 const uint32_t num_matches = process_infos.GetSize(); 3300 if (num_matches == 1) 3301 { 3302 attach_pid = process_infos.GetProcessIDAtIndex(0); 3303 // Fall through and attach using the above process ID 3304 } 3305 else 3306 { 3307 match_info.GetProcessInfo().GetExecutableFile().GetPath (process_name, sizeof(process_name)); 3308 if (num_matches > 1) 3309 { 3310 StreamString s; 3311 ProcessInstanceInfo::DumpTableHeader (s, platform_sp.get(), true, false); 3312 for (size_t i = 0; i < num_matches; i++) 3313 { 3314 process_infos.GetProcessInfoAtIndex(i).DumpAsTableRow(s, platform_sp.get(), true, false); 3315 } 3316 error.SetErrorStringWithFormat ("more than one process named %s:\n%s", 3317 process_name, 3318 s.GetData()); 3319 } 3320 else 3321 error.SetErrorStringWithFormat ("could not find a process named %s", process_name); 3322 } 3323 } 3324 else 3325 { 3326 error.SetErrorString ("invalid platform, can't find processes by name"); 3327 return error; 3328 } 3329 } 3330 } 3331 else 3332 { 3333 error.SetErrorString ("invalid process name"); 3334 } 3335 } 3336 3337 if (attach_pid != LLDB_INVALID_PROCESS_ID) 3338 { 3339 error = WillAttachToProcessWithID(attach_pid); 3340 if (error.Success()) 3341 { 3342 3343 if (m_public_run_lock.TrySetRunning()) 3344 { 3345 // Now attach using these arguments. 3346 m_should_detach = true; 3347 const bool restarted = false; 3348 SetPublicState (eStateAttaching, restarted); 3349 error = DoAttachToProcessWithID (attach_pid, attach_info); 3350 } 3351 else 3352 { 3353 // This shouldn't happen 3354 error.SetErrorString("failed to acquire process run lock"); 3355 } 3356 3357 if (error.Success()) 3358 { 3359 SetNextEventAction(new Process::AttachCompletionHandler(this, attach_info.GetResumeCount())); 3360 StartPrivateStateThread(); 3361 } 3362 else 3363 { 3364 if (GetID() != LLDB_INVALID_PROCESS_ID) 3365 SetID (LLDB_INVALID_PROCESS_ID); 3366 3367 const char *error_string = error.AsCString(); 3368 if (error_string == nullptr) 3369 error_string = "attach failed"; 3370 3371 SetExitStatus(-1, error_string); 3372 } 3373 } 3374 } 3375 return error; 3376 } 3377 3378 void 3379 Process::CompleteAttach () 3380 { 3381 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS)); 3382 if (log) 3383 log->Printf ("Process::%s()", __FUNCTION__); 3384 3385 // Let the process subclass figure out at much as it can about the process 3386 // before we go looking for a dynamic loader plug-in. 3387 ArchSpec process_arch; 3388 DidAttach(process_arch); 3389 3390 if (process_arch.IsValid()) 3391 { 3392 GetTarget().SetArchitecture(process_arch); 3393 if (log) 3394 { 3395 const char *triple_str = process_arch.GetTriple().getTriple().c_str (); 3396 log->Printf ("Process::%s replacing process architecture with DidAttach() architecture: %s", 3397 __FUNCTION__, 3398 triple_str ? triple_str : "<null>"); 3399 } 3400 } 3401 3402 // We just attached. If we have a platform, ask it for the process architecture, and if it isn't 3403 // the same as the one we've already set, switch architectures. 3404 PlatformSP platform_sp (GetTarget().GetPlatform ()); 3405 assert(platform_sp); 3406 if (platform_sp) 3407 { 3408 const ArchSpec &target_arch = GetTarget().GetArchitecture(); 3409 if (target_arch.IsValid() && !platform_sp->IsCompatibleArchitecture(target_arch, false, nullptr)) 3410 { 3411 ArchSpec platform_arch; 3412 platform_sp = platform_sp->GetPlatformForArchitecture (target_arch, &platform_arch); 3413 if (platform_sp) 3414 { 3415 GetTarget().SetPlatform (platform_sp); 3416 GetTarget().SetArchitecture(platform_arch); 3417 if (log) 3418 log->Printf ("Process::%s switching platform to %s and architecture to %s based on info from attach", __FUNCTION__, platform_sp->GetName().AsCString (""), platform_arch.GetTriple().getTriple().c_str ()); 3419 } 3420 } 3421 else if (!process_arch.IsValid()) 3422 { 3423 ProcessInstanceInfo process_info; 3424 platform_sp->GetProcessInfo (GetID(), process_info); 3425 const ArchSpec &process_arch = process_info.GetArchitecture(); 3426 if (process_arch.IsValid() && !GetTarget().GetArchitecture().IsExactMatch(process_arch)) 3427 { 3428 GetTarget().SetArchitecture (process_arch); 3429 if (log) 3430 log->Printf ("Process::%s switching architecture to %s based on info the platform retrieved for pid %" PRIu64, __FUNCTION__, process_arch.GetTriple().getTriple().c_str (), GetID ()); 3431 } 3432 } 3433 } 3434 3435 // We have completed the attach, now it is time to find the dynamic loader 3436 // plug-in 3437 DynamicLoader *dyld = GetDynamicLoader (); 3438 if (dyld) 3439 { 3440 dyld->DidAttach(); 3441 if (log) 3442 { 3443 ModuleSP exe_module_sp = GetTarget().GetExecutableModule (); 3444 log->Printf ("Process::%s after DynamicLoader::DidAttach(), target executable is %s (using %s plugin)", 3445 __FUNCTION__, 3446 exe_module_sp ? exe_module_sp->GetFileSpec().GetPath().c_str () : "<none>", 3447 dyld->GetPluginName().AsCString ("<unnamed>")); 3448 } 3449 } 3450 3451 GetJITLoaders().DidAttach(); 3452 3453 SystemRuntime *system_runtime = GetSystemRuntime (); 3454 if (system_runtime) 3455 { 3456 system_runtime->DidAttach(); 3457 if (log) 3458 { 3459 ModuleSP exe_module_sp = GetTarget().GetExecutableModule (); 3460 log->Printf ("Process::%s after SystemRuntime::DidAttach(), target executable is %s (using %s plugin)", 3461 __FUNCTION__, 3462 exe_module_sp ? exe_module_sp->GetFileSpec().GetPath().c_str () : "<none>", 3463 system_runtime->GetPluginName().AsCString("<unnamed>")); 3464 } 3465 } 3466 3467 m_os_ap.reset(OperatingSystem::FindPlugin(this, nullptr)); 3468 // Figure out which one is the executable, and set that in our target: 3469 const ModuleList &target_modules = GetTarget().GetImages(); 3470 Mutex::Locker modules_locker(target_modules.GetMutex()); 3471 size_t num_modules = target_modules.GetSize(); 3472 ModuleSP new_executable_module_sp; 3473 3474 for (size_t i = 0; i < num_modules; i++) 3475 { 3476 ModuleSP module_sp (target_modules.GetModuleAtIndexUnlocked (i)); 3477 if (module_sp && module_sp->IsExecutable()) 3478 { 3479 if (GetTarget().GetExecutableModulePointer() != module_sp.get()) 3480 new_executable_module_sp = module_sp; 3481 break; 3482 } 3483 } 3484 if (new_executable_module_sp) 3485 { 3486 GetTarget().SetExecutableModule (new_executable_module_sp, false); 3487 if (log) 3488 { 3489 ModuleSP exe_module_sp = GetTarget().GetExecutableModule (); 3490 log->Printf ("Process::%s after looping through modules, target executable is %s", 3491 __FUNCTION__, 3492 exe_module_sp ? exe_module_sp->GetFileSpec().GetPath().c_str () : "<none>"); 3493 } 3494 } 3495 3496 m_stop_info_override_callback = process_arch.GetStopInfoOverrideCallback(); 3497 } 3498 3499 Error 3500 Process::ConnectRemote (Stream *strm, const char *remote_url) 3501 { 3502 m_abi_sp.reset(); 3503 m_process_input_reader.reset(); 3504 3505 // Find the process and its architecture. Make sure it matches the architecture 3506 // of the current Target, and if not adjust it. 3507 3508 Error error (DoConnectRemote (strm, remote_url)); 3509 if (error.Success()) 3510 { 3511 if (GetID() != LLDB_INVALID_PROCESS_ID) 3512 { 3513 EventSP event_sp; 3514 StateType state = WaitForProcessStopPrivate(nullptr, event_sp); 3515 3516 if (state == eStateStopped || state == eStateCrashed) 3517 { 3518 // If we attached and actually have a process on the other end, then 3519 // this ended up being the equivalent of an attach. 3520 CompleteAttach (); 3521 3522 // This delays passing the stopped event to listeners till 3523 // CompleteAttach gets a chance to complete... 3524 HandlePrivateEvent (event_sp); 3525 } 3526 } 3527 3528 if (PrivateStateThreadIsValid ()) 3529 ResumePrivateStateThread (); 3530 else 3531 StartPrivateStateThread (); 3532 } 3533 return error; 3534 } 3535 3536 Error 3537 Process::PrivateResume () 3538 { 3539 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_PROCESS|LIBLLDB_LOG_STEP)); 3540 if (log) 3541 log->Printf("Process::PrivateResume() m_stop_id = %u, public state: %s private state: %s", 3542 m_mod_id.GetStopID(), 3543 StateAsCString(m_public_state.GetValue()), 3544 StateAsCString(m_private_state.GetValue())); 3545 3546 Error error (WillResume()); 3547 // Tell the process it is about to resume before the thread list 3548 if (error.Success()) 3549 { 3550 // Now let the thread list know we are about to resume so it 3551 // can let all of our threads know that they are about to be 3552 // resumed. Threads will each be called with 3553 // Thread::WillResume(StateType) where StateType contains the state 3554 // that they are supposed to have when the process is resumed 3555 // (suspended/running/stepping). Threads should also check 3556 // their resume signal in lldb::Thread::GetResumeSignal() 3557 // to see if they are supposed to start back up with a signal. 3558 if (m_thread_list.WillResume()) 3559 { 3560 // Last thing, do the PreResumeActions. 3561 if (!RunPreResumeActions()) 3562 { 3563 error.SetErrorStringWithFormat ("Process::PrivateResume PreResumeActions failed, not resuming."); 3564 } 3565 else 3566 { 3567 m_mod_id.BumpResumeID(); 3568 error = DoResume(); 3569 if (error.Success()) 3570 { 3571 DidResume(); 3572 m_thread_list.DidResume(); 3573 if (log) 3574 log->Printf ("Process thinks the process has resumed."); 3575 } 3576 } 3577 } 3578 else 3579 { 3580 // Somebody wanted to run without running (e.g. we were faking a step from one frame of a set of inlined 3581 // frames that share the same PC to another.) So generate a continue & a stopped event, 3582 // and let the world handle them. 3583 if (log) 3584 log->Printf ("Process::PrivateResume() asked to simulate a start & stop."); 3585 3586 SetPrivateState(eStateRunning); 3587 SetPrivateState(eStateStopped); 3588 } 3589 } 3590 else if (log) 3591 log->Printf ("Process::PrivateResume() got an error \"%s\".", error.AsCString("<unknown error>")); 3592 return error; 3593 } 3594 3595 Error 3596 Process::Halt (bool clear_thread_plans, bool use_run_lock) 3597 { 3598 if (! StateIsRunningState(m_public_state.GetValue())) 3599 return Error("Process is not running."); 3600 3601 // Don't clear the m_clear_thread_plans_on_stop, only set it to true if 3602 // in case it was already set and some thread plan logic calls halt on its 3603 // own. 3604 m_clear_thread_plans_on_stop |= clear_thread_plans; 3605 3606 ListenerSP halt_listener_sp (Listener::MakeListener("lldb.process.halt_listener")); 3607 HijackProcessEvents(halt_listener_sp); 3608 3609 EventSP event_sp; 3610 3611 SendAsyncInterrupt(); 3612 3613 if (m_public_state.GetValue() == eStateAttaching) 3614 { 3615 // Don't hijack and eat the eStateExited as the code that was doing 3616 // the attach will be waiting for this event... 3617 RestoreProcessEvents(); 3618 SetExitStatus(SIGKILL, "Cancelled async attach."); 3619 Destroy (false); 3620 return Error(); 3621 } 3622 3623 // Wait for 10 second for the process to stop. 3624 TimeValue timeout_time; 3625 timeout_time = TimeValue::Now(); 3626 timeout_time.OffsetWithSeconds(10); 3627 StateType state = WaitForProcessToStop(&timeout_time, &event_sp, true, halt_listener_sp, 3628 nullptr, use_run_lock); 3629 RestoreProcessEvents(); 3630 3631 if (state == eStateInvalid || ! event_sp) 3632 { 3633 // We timed out and didn't get a stop event... 3634 return Error("Halt timed out. State = %s", StateAsCString(GetState())); 3635 } 3636 3637 BroadcastEvent(event_sp); 3638 3639 return Error(); 3640 } 3641 3642 Error 3643 Process::StopForDestroyOrDetach(lldb::EventSP &exit_event_sp) 3644 { 3645 Error error; 3646 if (m_public_state.GetValue() == eStateRunning) 3647 { 3648 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS)); 3649 if (log) 3650 log->Printf("Process::%s() About to stop.", __FUNCTION__); 3651 3652 ListenerSP listener_sp (Listener::MakeListener("lldb.Process.StopForDestroyOrDetach.hijack")); 3653 HijackProcessEvents(listener_sp); 3654 3655 SendAsyncInterrupt(); 3656 3657 // Consume the interrupt event. 3658 TimeValue timeout (TimeValue::Now()); 3659 timeout.OffsetWithSeconds(10); 3660 3661 StateType state = WaitForProcessToStop (&timeout, &exit_event_sp, true, listener_sp); 3662 3663 RestoreProcessEvents(); 3664 3665 // If the process exited while we were waiting for it to stop, put the exited event into 3666 // the shared pointer passed in and return. Our caller doesn't need to do anything else, since 3667 // they don't have a process anymore... 3668 3669 if (state == eStateExited || m_private_state.GetValue() == eStateExited) 3670 { 3671 if (log) 3672 log->Printf("Process::%s() Process exited while waiting to stop.", __FUNCTION__); 3673 return error; 3674 } 3675 else 3676 exit_event_sp.reset(); // It is ok to consume any non-exit stop events 3677 3678 if (state != eStateStopped) 3679 { 3680 if (log) 3681 log->Printf("Process::%s() failed to stop, state is: %s", __FUNCTION__, StateAsCString(state)); 3682 // If we really couldn't stop the process then we should just error out here, but if the 3683 // lower levels just bobbled sending the event and we really are stopped, then continue on. 3684 StateType private_state = m_private_state.GetValue(); 3685 if (private_state != eStateStopped) 3686 { 3687 return error; 3688 } 3689 } 3690 } 3691 return error; 3692 } 3693 3694 Error 3695 Process::Detach (bool keep_stopped) 3696 { 3697 EventSP exit_event_sp; 3698 Error error; 3699 m_destroy_in_process = true; 3700 3701 error = WillDetach(); 3702 3703 if (error.Success()) 3704 { 3705 if (DetachRequiresHalt()) 3706 { 3707 error = StopForDestroyOrDetach (exit_event_sp); 3708 if (!error.Success()) 3709 { 3710 m_destroy_in_process = false; 3711 return error; 3712 } 3713 else if (exit_event_sp) 3714 { 3715 // We shouldn't need to do anything else here. There's no process left to detach from... 3716 StopPrivateStateThread(); 3717 m_destroy_in_process = false; 3718 return error; 3719 } 3720 } 3721 3722 m_thread_list.DiscardThreadPlans(); 3723 DisableAllBreakpointSites(); 3724 3725 error = DoDetach(keep_stopped); 3726 if (error.Success()) 3727 { 3728 DidDetach(); 3729 StopPrivateStateThread(); 3730 } 3731 else 3732 { 3733 return error; 3734 } 3735 } 3736 m_destroy_in_process = false; 3737 3738 // If we exited when we were waiting for a process to stop, then 3739 // forward the event here so we don't lose the event 3740 if (exit_event_sp) 3741 { 3742 // Directly broadcast our exited event because we shut down our 3743 // private state thread above 3744 BroadcastEvent(exit_event_sp); 3745 } 3746 3747 // If we have been interrupted (to kill us) in the middle of running, we may not end up propagating 3748 // the last events through the event system, in which case we might strand the write lock. Unlock 3749 // it here so when we do to tear down the process we don't get an error destroying the lock. 3750 3751 m_public_run_lock.SetStopped(); 3752 return error; 3753 } 3754 3755 Error 3756 Process::Destroy (bool force_kill) 3757 { 3758 3759 // Tell ourselves we are in the process of destroying the process, so that we don't do any unnecessary work 3760 // that might hinder the destruction. Remember to set this back to false when we are done. That way if the attempt 3761 // failed and the process stays around for some reason it won't be in a confused state. 3762 3763 if (force_kill) 3764 m_should_detach = false; 3765 3766 if (GetShouldDetach()) 3767 { 3768 // FIXME: This will have to be a process setting: 3769 bool keep_stopped = false; 3770 Detach(keep_stopped); 3771 } 3772 3773 m_destroy_in_process = true; 3774 3775 Error error (WillDestroy()); 3776 if (error.Success()) 3777 { 3778 EventSP exit_event_sp; 3779 if (DestroyRequiresHalt()) 3780 { 3781 error = StopForDestroyOrDetach(exit_event_sp); 3782 } 3783 3784 if (m_public_state.GetValue() != eStateRunning) 3785 { 3786 // Ditch all thread plans, and remove all our breakpoints: in case we have to restart the target to 3787 // kill it, we don't want it hitting a breakpoint... 3788 // Only do this if we've stopped, however, since if we didn't manage to halt it above, then 3789 // we're not going to have much luck doing this now. 3790 m_thread_list.DiscardThreadPlans(); 3791 DisableAllBreakpointSites(); 3792 } 3793 3794 error = DoDestroy(); 3795 if (error.Success()) 3796 { 3797 DidDestroy(); 3798 StopPrivateStateThread(); 3799 } 3800 m_stdio_communication.Disconnect(); 3801 m_stdio_communication.StopReadThread(); 3802 m_stdin_forward = false; 3803 3804 if (m_process_input_reader) 3805 { 3806 m_process_input_reader->SetIsDone(true); 3807 m_process_input_reader->Cancel(); 3808 m_process_input_reader.reset(); 3809 } 3810 3811 // If we exited when we were waiting for a process to stop, then 3812 // forward the event here so we don't lose the event 3813 if (exit_event_sp) 3814 { 3815 // Directly broadcast our exited event because we shut down our 3816 // private state thread above 3817 BroadcastEvent(exit_event_sp); 3818 } 3819 3820 // If we have been interrupted (to kill us) in the middle of running, we may not end up propagating 3821 // the last events through the event system, in which case we might strand the write lock. Unlock 3822 // it here so when we do to tear down the process we don't get an error destroying the lock. 3823 m_public_run_lock.SetStopped(); 3824 } 3825 3826 m_destroy_in_process = false; 3827 3828 return error; 3829 } 3830 3831 Error 3832 Process::Signal (int signal) 3833 { 3834 Error error (WillSignal()); 3835 if (error.Success()) 3836 { 3837 error = DoSignal(signal); 3838 if (error.Success()) 3839 DidSignal(); 3840 } 3841 return error; 3842 } 3843 3844 void 3845 Process::SetUnixSignals(UnixSignalsSP &&signals_sp) 3846 { 3847 assert (signals_sp && "null signals_sp"); 3848 m_unix_signals_sp = signals_sp; 3849 } 3850 3851 const lldb::UnixSignalsSP & 3852 Process::GetUnixSignals () 3853 { 3854 assert (m_unix_signals_sp && "null m_unix_signals_sp"); 3855 return m_unix_signals_sp; 3856 } 3857 3858 lldb::ByteOrder 3859 Process::GetByteOrder () const 3860 { 3861 return GetTarget().GetArchitecture().GetByteOrder(); 3862 } 3863 3864 uint32_t 3865 Process::GetAddressByteSize () const 3866 { 3867 return GetTarget().GetArchitecture().GetAddressByteSize(); 3868 } 3869 3870 bool 3871 Process::ShouldBroadcastEvent (Event *event_ptr) 3872 { 3873 const StateType state = Process::ProcessEventData::GetStateFromEvent (event_ptr); 3874 bool return_value = true; 3875 Log *log(lldb_private::GetLogIfAnyCategoriesSet(LIBLLDB_LOG_EVENTS | LIBLLDB_LOG_PROCESS)); 3876 3877 switch (state) 3878 { 3879 case eStateDetached: 3880 case eStateExited: 3881 case eStateUnloaded: 3882 m_stdio_communication.SynchronizeWithReadThread(); 3883 m_stdio_communication.Disconnect(); 3884 m_stdio_communication.StopReadThread(); 3885 m_stdin_forward = false; 3886 3887 LLVM_FALLTHROUGH; 3888 case eStateConnected: 3889 case eStateAttaching: 3890 case eStateLaunching: 3891 // These events indicate changes in the state of the debugging session, always report them. 3892 return_value = true; 3893 break; 3894 case eStateInvalid: 3895 // We stopped for no apparent reason, don't report it. 3896 return_value = false; 3897 break; 3898 case eStateRunning: 3899 case eStateStepping: 3900 // If we've started the target running, we handle the cases where we 3901 // are already running and where there is a transition from stopped to 3902 // running differently. 3903 // running -> running: Automatically suppress extra running events 3904 // stopped -> running: Report except when there is one or more no votes 3905 // and no yes votes. 3906 SynchronouslyNotifyStateChanged (state); 3907 if (m_force_next_event_delivery) 3908 return_value = true; 3909 else 3910 { 3911 switch (m_last_broadcast_state) 3912 { 3913 case eStateRunning: 3914 case eStateStepping: 3915 // We always suppress multiple runnings with no PUBLIC stop in between. 3916 return_value = false; 3917 break; 3918 default: 3919 // TODO: make this work correctly. For now always report 3920 // run if we aren't running so we don't miss any running 3921 // events. If I run the lldb/test/thread/a.out file and 3922 // break at main.cpp:58, run and hit the breakpoints on 3923 // multiple threads, then somehow during the stepping over 3924 // of all breakpoints no run gets reported. 3925 3926 // This is a transition from stop to run. 3927 switch (m_thread_list.ShouldReportRun (event_ptr)) 3928 { 3929 case eVoteYes: 3930 case eVoteNoOpinion: 3931 return_value = true; 3932 break; 3933 case eVoteNo: 3934 return_value = false; 3935 break; 3936 } 3937 break; 3938 } 3939 } 3940 break; 3941 case eStateStopped: 3942 case eStateCrashed: 3943 case eStateSuspended: 3944 // We've stopped. First see if we're going to restart the target. 3945 // If we are going to stop, then we always broadcast the event. 3946 // If we aren't going to stop, let the thread plans decide if we're going to report this event. 3947 // If no thread has an opinion, we don't report it. 3948 3949 m_stdio_communication.SynchronizeWithReadThread(); 3950 RefreshStateAfterStop (); 3951 if (ProcessEventData::GetInterruptedFromEvent (event_ptr)) 3952 { 3953 if (log) 3954 log->Printf ("Process::ShouldBroadcastEvent (%p) stopped due to an interrupt, state: %s", 3955 static_cast<void*>(event_ptr), 3956 StateAsCString(state)); 3957 // Even though we know we are going to stop, we should let the threads have a look at the stop, 3958 // so they can properly set their state. 3959 m_thread_list.ShouldStop (event_ptr); 3960 return_value = true; 3961 } 3962 else 3963 { 3964 bool was_restarted = ProcessEventData::GetRestartedFromEvent (event_ptr); 3965 bool should_resume = false; 3966 3967 // It makes no sense to ask "ShouldStop" if we've already been restarted... 3968 // Asking the thread list is also not likely to go well, since we are running again. 3969 // So in that case just report the event. 3970 3971 if (!was_restarted) 3972 should_resume = !m_thread_list.ShouldStop(event_ptr); 3973 3974 if (was_restarted || should_resume || m_resume_requested) 3975 { 3976 Vote stop_vote = m_thread_list.ShouldReportStop (event_ptr); 3977 if (log) 3978 log->Printf ("Process::ShouldBroadcastEvent: should_resume: %i state: %s was_restarted: %i stop_vote: %d.", 3979 should_resume, StateAsCString(state), 3980 was_restarted, stop_vote); 3981 3982 switch (stop_vote) 3983 { 3984 case eVoteYes: 3985 return_value = true; 3986 break; 3987 case eVoteNoOpinion: 3988 case eVoteNo: 3989 return_value = false; 3990 break; 3991 } 3992 3993 if (!was_restarted) 3994 { 3995 if (log) 3996 log->Printf ("Process::ShouldBroadcastEvent (%p) Restarting process from state: %s", 3997 static_cast<void*>(event_ptr), 3998 StateAsCString(state)); 3999 ProcessEventData::SetRestartedInEvent(event_ptr, true); 4000 PrivateResume (); 4001 } 4002 } 4003 else 4004 { 4005 return_value = true; 4006 SynchronouslyNotifyStateChanged (state); 4007 } 4008 } 4009 break; 4010 } 4011 4012 // Forcing the next event delivery is a one shot deal. So reset it here. 4013 m_force_next_event_delivery = false; 4014 4015 // We do some coalescing of events (for instance two consecutive running events get coalesced.) 4016 // But we only coalesce against events we actually broadcast. So we use m_last_broadcast_state 4017 // to track that. NB - you can't use "m_public_state.GetValue()" for that purpose, as was originally done, 4018 // because the PublicState reflects the last event pulled off the queue, and there may be several 4019 // events stacked up on the queue unserviced. So the PublicState may not reflect the last broadcasted event 4020 // yet. m_last_broadcast_state gets updated here. 4021 4022 if (return_value) 4023 m_last_broadcast_state = state; 4024 4025 if (log) 4026 log->Printf ("Process::ShouldBroadcastEvent (%p) => new state: %s, last broadcast state: %s - %s", 4027 static_cast<void*>(event_ptr), StateAsCString(state), 4028 StateAsCString(m_last_broadcast_state), 4029 return_value ? "YES" : "NO"); 4030 return return_value; 4031 } 4032 4033 bool 4034 Process::StartPrivateStateThread (bool is_secondary_thread) 4035 { 4036 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EVENTS)); 4037 4038 bool already_running = PrivateStateThreadIsValid (); 4039 if (log) 4040 log->Printf ("Process::%s()%s ", __FUNCTION__, already_running ? " already running" : " starting private state thread"); 4041 4042 if (!is_secondary_thread && already_running) 4043 return true; 4044 4045 // Create a thread that watches our internal state and controls which 4046 // events make it to clients (into the DCProcess event queue). 4047 char thread_name[1024]; 4048 4049 if (HostInfo::GetMaxThreadNameLength() <= 30) 4050 { 4051 // On platforms with abbreviated thread name lengths, choose thread names that fit within the limit. 4052 if (already_running) 4053 snprintf(thread_name, sizeof(thread_name), "intern-state-OV"); 4054 else 4055 snprintf(thread_name, sizeof(thread_name), "intern-state"); 4056 } 4057 else 4058 { 4059 if (already_running) 4060 snprintf(thread_name, sizeof(thread_name), "<lldb.process.internal-state-override(pid=%" PRIu64 ")>", GetID()); 4061 else 4062 snprintf(thread_name, sizeof(thread_name), "<lldb.process.internal-state(pid=%" PRIu64 ")>", GetID()); 4063 } 4064 4065 // Create the private state thread, and start it running. 4066 PrivateStateThreadArgs *args_ptr = new PrivateStateThreadArgs(this, is_secondary_thread); 4067 m_private_state_thread = ThreadLauncher::LaunchThread(thread_name, Process::PrivateStateThread, (void *) args_ptr, nullptr, 8 * 1024 * 1024); 4068 if (m_private_state_thread.IsJoinable()) 4069 { 4070 ResumePrivateStateThread(); 4071 return true; 4072 } 4073 else 4074 return false; 4075 } 4076 4077 void 4078 Process::PausePrivateStateThread () 4079 { 4080 ControlPrivateStateThread (eBroadcastInternalStateControlPause); 4081 } 4082 4083 void 4084 Process::ResumePrivateStateThread () 4085 { 4086 ControlPrivateStateThread (eBroadcastInternalStateControlResume); 4087 } 4088 4089 void 4090 Process::StopPrivateStateThread () 4091 { 4092 if (PrivateStateThreadIsValid ()) 4093 ControlPrivateStateThread (eBroadcastInternalStateControlStop); 4094 else 4095 { 4096 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_PROCESS)); 4097 if (log) 4098 log->Printf ("Went to stop the private state thread, but it was already invalid."); 4099 } 4100 } 4101 4102 void 4103 Process::ControlPrivateStateThread (uint32_t signal) 4104 { 4105 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_PROCESS)); 4106 4107 assert (signal == eBroadcastInternalStateControlStop || 4108 signal == eBroadcastInternalStateControlPause || 4109 signal == eBroadcastInternalStateControlResume); 4110 4111 if (log) 4112 log->Printf ("Process::%s (signal = %d)", __FUNCTION__, signal); 4113 4114 // Signal the private state thread. First we should copy this is case the 4115 // thread starts exiting since the private state thread will NULL this out 4116 // when it exits 4117 HostThread private_state_thread(m_private_state_thread); 4118 if (private_state_thread.IsJoinable()) 4119 { 4120 TimeValue timeout_time; 4121 bool timed_out; 4122 4123 m_private_state_control_broadcaster.BroadcastEvent(signal, nullptr); 4124 4125 timeout_time = TimeValue::Now(); 4126 timeout_time.OffsetWithSeconds(2); 4127 if (log) 4128 log->Printf ("Sending control event of type: %d.", signal); 4129 m_private_state_control_wait.WaitForValueEqualTo (true, &timeout_time, &timed_out); 4130 m_private_state_control_wait.SetValue (false, eBroadcastNever); 4131 4132 if (signal == eBroadcastInternalStateControlStop) 4133 { 4134 if (timed_out) 4135 { 4136 Error error = private_state_thread.Cancel(); 4137 if (log) 4138 log->Printf ("Timed out responding to the control event, cancel got error: \"%s\".", error.AsCString()); 4139 } 4140 else 4141 { 4142 if (log) 4143 log->Printf ("The control event killed the private state thread without having to cancel."); 4144 } 4145 4146 thread_result_t result = NULL; 4147 private_state_thread.Join(&result); 4148 m_private_state_thread.Reset(); 4149 } 4150 } 4151 else 4152 { 4153 if (log) 4154 log->Printf ("Private state thread already dead, no need to signal it to stop."); 4155 } 4156 } 4157 4158 void 4159 Process::SendAsyncInterrupt () 4160 { 4161 if (PrivateStateThreadIsValid()) 4162 m_private_state_broadcaster.BroadcastEvent(Process::eBroadcastBitInterrupt, nullptr); 4163 else 4164 BroadcastEvent(Process::eBroadcastBitInterrupt, nullptr); 4165 } 4166 4167 void 4168 Process::HandlePrivateEvent (EventSP &event_sp) 4169 { 4170 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS)); 4171 m_resume_requested = false; 4172 4173 const StateType new_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get()); 4174 4175 // First check to see if anybody wants a shot at this event: 4176 if (m_next_event_action_ap) 4177 { 4178 NextEventAction::EventActionResult action_result = m_next_event_action_ap->PerformAction(event_sp); 4179 if (log) 4180 log->Printf ("Ran next event action, result was %d.", action_result); 4181 4182 switch (action_result) 4183 { 4184 case NextEventAction::eEventActionSuccess: 4185 SetNextEventAction(nullptr); 4186 break; 4187 4188 case NextEventAction::eEventActionRetry: 4189 break; 4190 4191 case NextEventAction::eEventActionExit: 4192 // Handle Exiting Here. If we already got an exited event, 4193 // we should just propagate it. Otherwise, swallow this event, 4194 // and set our state to exit so the next event will kill us. 4195 if (new_state != eStateExited) 4196 { 4197 // FIXME: should cons up an exited event, and discard this one. 4198 SetExitStatus(0, m_next_event_action_ap->GetExitString()); 4199 SetNextEventAction(nullptr); 4200 return; 4201 } 4202 SetNextEventAction(nullptr); 4203 break; 4204 } 4205 } 4206 4207 // See if we should broadcast this state to external clients? 4208 const bool should_broadcast = ShouldBroadcastEvent (event_sp.get()); 4209 4210 if (should_broadcast) 4211 { 4212 const bool is_hijacked = IsHijackedForEvent(eBroadcastBitStateChanged); 4213 if (log) 4214 { 4215 log->Printf ("Process::%s (pid = %" PRIu64 ") broadcasting new state %s (old state %s) to %s", 4216 __FUNCTION__, 4217 GetID(), 4218 StateAsCString(new_state), 4219 StateAsCString (GetState ()), 4220 is_hijacked ? "hijacked" : "public"); 4221 } 4222 Process::ProcessEventData::SetUpdateStateOnRemoval(event_sp.get()); 4223 if (StateIsRunningState (new_state)) 4224 { 4225 // Only push the input handler if we aren't fowarding events, 4226 // as this means the curses GUI is in use... 4227 // Or don't push it if we are launching since it will come up stopped. 4228 if (!GetTarget().GetDebugger().IsForwardingEvents() && new_state != eStateLaunching && 4229 new_state != eStateAttaching) 4230 { 4231 PushProcessIOHandler (); 4232 m_iohandler_sync.SetValue(m_iohandler_sync.GetValue()+1, eBroadcastAlways); 4233 if (log) 4234 log->Printf("Process::%s updated m_iohandler_sync to %d", __FUNCTION__, m_iohandler_sync.GetValue()); 4235 } 4236 } 4237 else if (StateIsStoppedState(new_state, false)) 4238 { 4239 if (!Process::ProcessEventData::GetRestartedFromEvent(event_sp.get())) 4240 { 4241 // If the lldb_private::Debugger is handling the events, we don't 4242 // want to pop the process IOHandler here, we want to do it when 4243 // we receive the stopped event so we can carefully control when 4244 // the process IOHandler is popped because when we stop we want to 4245 // display some text stating how and why we stopped, then maybe some 4246 // process/thread/frame info, and then we want the "(lldb) " prompt 4247 // to show up. If we pop the process IOHandler here, then we will 4248 // cause the command interpreter to become the top IOHandler after 4249 // the process pops off and it will update its prompt right away... 4250 // See the Debugger.cpp file where it calls the function as 4251 // "process_sp->PopProcessIOHandler()" to see where I am talking about. 4252 // Otherwise we end up getting overlapping "(lldb) " prompts and 4253 // garbled output. 4254 // 4255 // If we aren't handling the events in the debugger (which is indicated 4256 // by "m_target.GetDebugger().IsHandlingEvents()" returning false) or we 4257 // are hijacked, then we always pop the process IO handler manually. 4258 // Hijacking happens when the internal process state thread is running 4259 // thread plans, or when commands want to run in synchronous mode 4260 // and they call "process->WaitForProcessToStop()". An example of something 4261 // that will hijack the events is a simple expression: 4262 // 4263 // (lldb) expr (int)puts("hello") 4264 // 4265 // This will cause the internal process state thread to resume and halt 4266 // the process (and _it_ will hijack the eBroadcastBitStateChanged 4267 // events) and we do need the IO handler to be pushed and popped 4268 // correctly. 4269 4270 if (is_hijacked || !GetTarget().GetDebugger().IsHandlingEvents()) 4271 PopProcessIOHandler (); 4272 } 4273 } 4274 4275 BroadcastEvent (event_sp); 4276 } 4277 else 4278 { 4279 if (log) 4280 { 4281 log->Printf ("Process::%s (pid = %" PRIu64 ") suppressing state %s (old state %s): should_broadcast == false", 4282 __FUNCTION__, 4283 GetID(), 4284 StateAsCString(new_state), 4285 StateAsCString (GetState ())); 4286 } 4287 } 4288 } 4289 4290 Error 4291 Process::HaltPrivate() 4292 { 4293 EventSP event_sp; 4294 Error error (WillHalt()); 4295 if (error.Fail()) 4296 return error; 4297 4298 // Ask the process subclass to actually halt our process 4299 bool caused_stop; 4300 error = DoHalt(caused_stop); 4301 4302 DidHalt(); 4303 return error; 4304 } 4305 4306 thread_result_t 4307 Process::PrivateStateThread (void *arg) 4308 { 4309 PrivateStateThreadArgs real_args = *static_cast<PrivateStateThreadArgs *> (arg); 4310 free (arg); 4311 thread_result_t result = real_args.process->RunPrivateStateThread(real_args.is_secondary_thread); 4312 return result; 4313 } 4314 4315 thread_result_t 4316 Process::RunPrivateStateThread (bool is_secondary_thread) 4317 { 4318 bool control_only = true; 4319 m_private_state_control_wait.SetValue (false, eBroadcastNever); 4320 4321 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS)); 4322 if (log) 4323 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") thread starting...", 4324 __FUNCTION__, static_cast<void*>(this), GetID()); 4325 4326 bool exit_now = false; 4327 bool interrupt_requested = false; 4328 while (!exit_now) 4329 { 4330 EventSP event_sp; 4331 WaitForEventsPrivate(nullptr, event_sp, control_only); 4332 if (event_sp->BroadcasterIs(&m_private_state_control_broadcaster)) 4333 { 4334 if (log) 4335 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") got a control event: %d", 4336 __FUNCTION__, static_cast<void*>(this), GetID(), 4337 event_sp->GetType()); 4338 4339 switch (event_sp->GetType()) 4340 { 4341 case eBroadcastInternalStateControlStop: 4342 exit_now = true; 4343 break; // doing any internal state management below 4344 4345 case eBroadcastInternalStateControlPause: 4346 control_only = true; 4347 break; 4348 4349 case eBroadcastInternalStateControlResume: 4350 control_only = false; 4351 break; 4352 } 4353 4354 m_private_state_control_wait.SetValue (true, eBroadcastAlways); 4355 continue; 4356 } 4357 else if (event_sp->GetType() == eBroadcastBitInterrupt) 4358 { 4359 if (m_public_state.GetValue() == eStateAttaching) 4360 { 4361 if (log) 4362 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") woke up with an interrupt while attaching - forwarding interrupt.", 4363 __FUNCTION__, static_cast<void*>(this), 4364 GetID()); 4365 BroadcastEvent(eBroadcastBitInterrupt, nullptr); 4366 } 4367 else if(StateIsRunningState(m_last_broadcast_state)) 4368 { 4369 if (log) 4370 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") woke up with an interrupt - Halting.", 4371 __FUNCTION__, static_cast<void*>(this), 4372 GetID()); 4373 Error error = HaltPrivate(); 4374 if (error.Fail() && log) 4375 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") failed to halt the process: %s", 4376 __FUNCTION__, static_cast<void*>(this), 4377 GetID(), error.AsCString()); 4378 // Halt should generate a stopped event. Make a note of the fact that we were 4379 // doing the interrupt, so we can set the interrupted flag after we receive the 4380 // event. We deliberately set this to true even if HaltPrivate failed, so that we 4381 // can interrupt on the next natural stop. 4382 interrupt_requested = true; 4383 } 4384 else 4385 { 4386 // This can happen when someone (e.g. Process::Halt) sees that we are running and 4387 // sends an interrupt request, but the process actually stops before we receive 4388 // it. In that case, we can just ignore the request. We use 4389 // m_last_broadcast_state, because the Stopped event may not have been popped of 4390 // the event queue yet, which is when the public state gets updated. 4391 if (log) 4392 log->Printf("Process::%s ignoring interrupt as we have already stopped.", __FUNCTION__); 4393 } 4394 continue; 4395 } 4396 4397 const StateType internal_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get()); 4398 4399 if (internal_state != eStateInvalid) 4400 { 4401 if (m_clear_thread_plans_on_stop && 4402 StateIsStoppedState(internal_state, true)) 4403 { 4404 m_clear_thread_plans_on_stop = false; 4405 m_thread_list.DiscardThreadPlans(); 4406 } 4407 4408 if (interrupt_requested) 4409 { 4410 if (StateIsStoppedState (internal_state, true)) 4411 { 4412 // We requested the interrupt, so mark this as such in the stop event so 4413 // clients can tell an interrupted process from a natural stop 4414 ProcessEventData::SetInterruptedInEvent (event_sp.get(), true); 4415 interrupt_requested = false; 4416 } 4417 else if (log) 4418 { 4419 log->Printf("Process::%s interrupt_requested, but a non-stopped state '%s' received.", 4420 __FUNCTION__, StateAsCString(internal_state)); 4421 } 4422 } 4423 4424 HandlePrivateEvent (event_sp); 4425 } 4426 4427 if (internal_state == eStateInvalid || 4428 internal_state == eStateExited || 4429 internal_state == eStateDetached ) 4430 { 4431 if (log) 4432 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") about to exit with internal state %s...", 4433 __FUNCTION__, static_cast<void*>(this), GetID(), 4434 StateAsCString(internal_state)); 4435 4436 break; 4437 } 4438 } 4439 4440 // Verify log is still enabled before attempting to write to it... 4441 if (log) 4442 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") thread exiting...", 4443 __FUNCTION__, static_cast<void*>(this), GetID()); 4444 4445 // If we are a secondary thread, then the primary thread we are working for will have already 4446 // acquired the public_run_lock, and isn't done with what it was doing yet, so don't 4447 // try to change it on the way out. 4448 if (!is_secondary_thread) 4449 m_public_run_lock.SetStopped(); 4450 m_private_state_control_wait.SetValue (true, eBroadcastAlways); 4451 m_private_state_thread.Reset(); 4452 return NULL; 4453 } 4454 4455 //------------------------------------------------------------------ 4456 // Process Event Data 4457 //------------------------------------------------------------------ 4458 4459 Process::ProcessEventData::ProcessEventData () : 4460 EventData (), 4461 m_process_wp (), 4462 m_state (eStateInvalid), 4463 m_restarted (false), 4464 m_update_state (0), 4465 m_interrupted (false) 4466 { 4467 } 4468 4469 Process::ProcessEventData::ProcessEventData (const ProcessSP &process_sp, StateType state) : 4470 EventData (), 4471 m_process_wp (), 4472 m_state (state), 4473 m_restarted (false), 4474 m_update_state (0), 4475 m_interrupted (false) 4476 { 4477 if (process_sp) 4478 m_process_wp = process_sp; 4479 } 4480 4481 Process::ProcessEventData::~ProcessEventData() = default; 4482 4483 const ConstString & 4484 Process::ProcessEventData::GetFlavorString () 4485 { 4486 static ConstString g_flavor ("Process::ProcessEventData"); 4487 return g_flavor; 4488 } 4489 4490 const ConstString & 4491 Process::ProcessEventData::GetFlavor () const 4492 { 4493 return ProcessEventData::GetFlavorString (); 4494 } 4495 4496 void 4497 Process::ProcessEventData::DoOnRemoval (Event *event_ptr) 4498 { 4499 ProcessSP process_sp(m_process_wp.lock()); 4500 4501 if (!process_sp) 4502 return; 4503 4504 // This function gets called twice for each event, once when the event gets pulled 4505 // off of the private process event queue, and then any number of times, first when it gets pulled off of 4506 // the public event queue, then other times when we're pretending that this is where we stopped at the 4507 // end of expression evaluation. m_update_state is used to distinguish these 4508 // three cases; it is 0 when we're just pulling it off for private handling, 4509 // and > 1 for expression evaluation, and we don't want to do the breakpoint command handling then. 4510 if (m_update_state != 1) 4511 return; 4512 4513 process_sp->SetPublicState (m_state, Process::ProcessEventData::GetRestartedFromEvent(event_ptr)); 4514 4515 // If this is a halt event, even if the halt stopped with some reason other than a plain interrupt (e.g. we had 4516 // already stopped for a breakpoint when the halt request came through) don't do the StopInfo actions, as they may 4517 // end up restarting the process. 4518 if (m_interrupted) 4519 return; 4520 4521 // If we're stopped and haven't restarted, then do the StopInfo actions here: 4522 if (m_state == eStateStopped && ! m_restarted) 4523 { 4524 // Let process subclasses know we are about to do a public stop and 4525 // do anything they might need to in order to speed up register and 4526 // memory accesses. 4527 process_sp->WillPublicStop(); 4528 4529 ThreadList &curr_thread_list = process_sp->GetThreadList(); 4530 uint32_t num_threads = curr_thread_list.GetSize(); 4531 uint32_t idx; 4532 4533 // The actions might change one of the thread's stop_info's opinions about whether we should 4534 // stop the process, so we need to query that as we go. 4535 4536 // One other complication here, is that we try to catch any case where the target has run (except for expressions) 4537 // and immediately exit, but if we get that wrong (which is possible) then the thread list might have changed, and 4538 // that would cause our iteration here to crash. We could make a copy of the thread list, but we'd really like 4539 // to also know if it has changed at all, so we make up a vector of the thread ID's and check what we get back 4540 // against this list & bag out if anything differs. 4541 std::vector<uint32_t> thread_index_array(num_threads); 4542 for (idx = 0; idx < num_threads; ++idx) 4543 thread_index_array[idx] = curr_thread_list.GetThreadAtIndex(idx)->GetIndexID(); 4544 4545 // Use this to track whether we should continue from here. We will only continue the target running if 4546 // no thread says we should stop. Of course if some thread's PerformAction actually sets the target running, 4547 // then it doesn't matter what the other threads say... 4548 4549 bool still_should_stop = false; 4550 4551 // Sometimes - for instance if we have a bug in the stub we are talking to, we stop but no thread has a 4552 // valid stop reason. In that case we should just stop, because we have no way of telling what the right 4553 // thing to do is, and it's better to let the user decide than continue behind their backs. 4554 4555 bool does_anybody_have_an_opinion = false; 4556 4557 for (idx = 0; idx < num_threads; ++idx) 4558 { 4559 curr_thread_list = process_sp->GetThreadList(); 4560 if (curr_thread_list.GetSize() != num_threads) 4561 { 4562 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STEP | LIBLLDB_LOG_PROCESS)); 4563 if (log) 4564 log->Printf("Number of threads changed from %u to %u while processing event.", num_threads, curr_thread_list.GetSize()); 4565 break; 4566 } 4567 4568 lldb::ThreadSP thread_sp = curr_thread_list.GetThreadAtIndex(idx); 4569 4570 if (thread_sp->GetIndexID() != thread_index_array[idx]) 4571 { 4572 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STEP | LIBLLDB_LOG_PROCESS)); 4573 if (log) 4574 log->Printf("The thread at position %u changed from %u to %u while processing event.", 4575 idx, 4576 thread_index_array[idx], 4577 thread_sp->GetIndexID()); 4578 break; 4579 } 4580 4581 StopInfoSP stop_info_sp = thread_sp->GetStopInfo (); 4582 if (stop_info_sp && stop_info_sp->IsValid()) 4583 { 4584 does_anybody_have_an_opinion = true; 4585 bool this_thread_wants_to_stop; 4586 if (stop_info_sp->GetOverrideShouldStop()) 4587 { 4588 this_thread_wants_to_stop = stop_info_sp->GetOverriddenShouldStopValue(); 4589 } 4590 else 4591 { 4592 stop_info_sp->PerformAction(event_ptr); 4593 // The stop action might restart the target. If it does, then we want to mark that in the 4594 // event so that whoever is receiving it will know to wait for the running event and reflect 4595 // that state appropriately. 4596 // We also need to stop processing actions, since they aren't expecting the target to be running. 4597 4598 // FIXME: we might have run. 4599 if (stop_info_sp->HasTargetRunSinceMe()) 4600 { 4601 SetRestarted (true); 4602 break; 4603 } 4604 4605 this_thread_wants_to_stop = stop_info_sp->ShouldStop(event_ptr); 4606 } 4607 4608 if (!still_should_stop) 4609 still_should_stop = this_thread_wants_to_stop; 4610 } 4611 } 4612 4613 if (!GetRestarted()) 4614 { 4615 if (!still_should_stop && does_anybody_have_an_opinion) 4616 { 4617 // We've been asked to continue, so do that here. 4618 SetRestarted(true); 4619 // Use the public resume method here, since this is just 4620 // extending a public resume. 4621 process_sp->PrivateResume(); 4622 } 4623 else 4624 { 4625 // If we didn't restart, run the Stop Hooks here: 4626 // They might also restart the target, so watch for that. 4627 process_sp->GetTarget().RunStopHooks(); 4628 if (process_sp->GetPrivateState() == eStateRunning) 4629 SetRestarted(true); 4630 } 4631 } 4632 } 4633 } 4634 4635 void 4636 Process::ProcessEventData::Dump (Stream *s) const 4637 { 4638 ProcessSP process_sp(m_process_wp.lock()); 4639 4640 if (process_sp) 4641 s->Printf(" process = %p (pid = %" PRIu64 "), ", 4642 static_cast<void*>(process_sp.get()), process_sp->GetID()); 4643 else 4644 s->PutCString(" process = NULL, "); 4645 4646 s->Printf("state = %s", StateAsCString(GetState())); 4647 } 4648 4649 const Process::ProcessEventData * 4650 Process::ProcessEventData::GetEventDataFromEvent (const Event *event_ptr) 4651 { 4652 if (event_ptr) 4653 { 4654 const EventData *event_data = event_ptr->GetData(); 4655 if (event_data && event_data->GetFlavor() == ProcessEventData::GetFlavorString()) 4656 return static_cast <const ProcessEventData *> (event_ptr->GetData()); 4657 } 4658 return nullptr; 4659 } 4660 4661 ProcessSP 4662 Process::ProcessEventData::GetProcessFromEvent (const Event *event_ptr) 4663 { 4664 ProcessSP process_sp; 4665 const ProcessEventData *data = GetEventDataFromEvent (event_ptr); 4666 if (data) 4667 process_sp = data->GetProcessSP(); 4668 return process_sp; 4669 } 4670 4671 StateType 4672 Process::ProcessEventData::GetStateFromEvent (const Event *event_ptr) 4673 { 4674 const ProcessEventData *data = GetEventDataFromEvent (event_ptr); 4675 if (data == nullptr) 4676 return eStateInvalid; 4677 else 4678 return data->GetState(); 4679 } 4680 4681 bool 4682 Process::ProcessEventData::GetRestartedFromEvent (const Event *event_ptr) 4683 { 4684 const ProcessEventData *data = GetEventDataFromEvent (event_ptr); 4685 if (data == nullptr) 4686 return false; 4687 else 4688 return data->GetRestarted(); 4689 } 4690 4691 void 4692 Process::ProcessEventData::SetRestartedInEvent (Event *event_ptr, bool new_value) 4693 { 4694 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr)); 4695 if (data != nullptr) 4696 data->SetRestarted(new_value); 4697 } 4698 4699 size_t 4700 Process::ProcessEventData::GetNumRestartedReasons(const Event *event_ptr) 4701 { 4702 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr)); 4703 if (data != nullptr) 4704 return data->GetNumRestartedReasons(); 4705 else 4706 return 0; 4707 } 4708 4709 const char * 4710 Process::ProcessEventData::GetRestartedReasonAtIndex(const Event *event_ptr, size_t idx) 4711 { 4712 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr)); 4713 if (data != nullptr) 4714 return data->GetRestartedReasonAtIndex(idx); 4715 else 4716 return nullptr; 4717 } 4718 4719 void 4720 Process::ProcessEventData::AddRestartedReason (Event *event_ptr, const char *reason) 4721 { 4722 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr)); 4723 if (data != nullptr) 4724 data->AddRestartedReason(reason); 4725 } 4726 4727 bool 4728 Process::ProcessEventData::GetInterruptedFromEvent (const Event *event_ptr) 4729 { 4730 const ProcessEventData *data = GetEventDataFromEvent (event_ptr); 4731 if (data == nullptr) 4732 return false; 4733 else 4734 return data->GetInterrupted (); 4735 } 4736 4737 void 4738 Process::ProcessEventData::SetInterruptedInEvent (Event *event_ptr, bool new_value) 4739 { 4740 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr)); 4741 if (data != nullptr) 4742 data->SetInterrupted(new_value); 4743 } 4744 4745 bool 4746 Process::ProcessEventData::SetUpdateStateOnRemoval (Event *event_ptr) 4747 { 4748 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr)); 4749 if (data) 4750 { 4751 data->SetUpdateStateOnRemoval(); 4752 return true; 4753 } 4754 return false; 4755 } 4756 4757 lldb::TargetSP 4758 Process::CalculateTarget () 4759 { 4760 return m_target_sp.lock(); 4761 } 4762 4763 void 4764 Process::CalculateExecutionContext (ExecutionContext &exe_ctx) 4765 { 4766 exe_ctx.SetTargetPtr (&GetTarget()); 4767 exe_ctx.SetProcessPtr (this); 4768 exe_ctx.SetThreadPtr(nullptr); 4769 exe_ctx.SetFramePtr(nullptr); 4770 } 4771 4772 //uint32_t 4773 //Process::ListProcessesMatchingName (const char *name, StringList &matches, std::vector<lldb::pid_t> &pids) 4774 //{ 4775 // return 0; 4776 //} 4777 // 4778 //ArchSpec 4779 //Process::GetArchSpecForExistingProcess (lldb::pid_t pid) 4780 //{ 4781 // return Host::GetArchSpecForExistingProcess (pid); 4782 //} 4783 // 4784 //ArchSpec 4785 //Process::GetArchSpecForExistingProcess (const char *process_name) 4786 //{ 4787 // return Host::GetArchSpecForExistingProcess (process_name); 4788 //} 4789 4790 void 4791 Process::AppendSTDOUT (const char * s, size_t len) 4792 { 4793 Mutex::Locker locker (m_stdio_communication_mutex); 4794 m_stdout_data.append (s, len); 4795 BroadcastEventIfUnique (eBroadcastBitSTDOUT, new ProcessEventData (shared_from_this(), GetState())); 4796 } 4797 4798 void 4799 Process::AppendSTDERR (const char * s, size_t len) 4800 { 4801 Mutex::Locker locker (m_stdio_communication_mutex); 4802 m_stderr_data.append (s, len); 4803 BroadcastEventIfUnique (eBroadcastBitSTDERR, new ProcessEventData (shared_from_this(), GetState())); 4804 } 4805 4806 void 4807 Process::BroadcastAsyncProfileData(const std::string &one_profile_data) 4808 { 4809 Mutex::Locker locker (m_profile_data_comm_mutex); 4810 m_profile_data.push_back(one_profile_data); 4811 BroadcastEventIfUnique (eBroadcastBitProfileData, new ProcessEventData (shared_from_this(), GetState())); 4812 } 4813 4814 size_t 4815 Process::GetAsyncProfileData (char *buf, size_t buf_size, Error &error) 4816 { 4817 Mutex::Locker locker(m_profile_data_comm_mutex); 4818 if (m_profile_data.empty()) 4819 return 0; 4820 4821 std::string &one_profile_data = m_profile_data.front(); 4822 size_t bytes_available = one_profile_data.size(); 4823 if (bytes_available > 0) 4824 { 4825 Log *log (lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS)); 4826 if (log) 4827 log->Printf ("Process::GetProfileData (buf = %p, size = %" PRIu64 ")", 4828 static_cast<void*>(buf), 4829 static_cast<uint64_t>(buf_size)); 4830 if (bytes_available > buf_size) 4831 { 4832 memcpy(buf, one_profile_data.c_str(), buf_size); 4833 one_profile_data.erase(0, buf_size); 4834 bytes_available = buf_size; 4835 } 4836 else 4837 { 4838 memcpy(buf, one_profile_data.c_str(), bytes_available); 4839 m_profile_data.erase(m_profile_data.begin()); 4840 } 4841 } 4842 return bytes_available; 4843 } 4844 4845 //------------------------------------------------------------------ 4846 // Process STDIO 4847 //------------------------------------------------------------------ 4848 4849 size_t 4850 Process::GetSTDOUT (char *buf, size_t buf_size, Error &error) 4851 { 4852 Mutex::Locker locker(m_stdio_communication_mutex); 4853 size_t bytes_available = m_stdout_data.size(); 4854 if (bytes_available > 0) 4855 { 4856 Log *log (lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS)); 4857 if (log) 4858 log->Printf ("Process::GetSTDOUT (buf = %p, size = %" PRIu64 ")", 4859 static_cast<void*>(buf), 4860 static_cast<uint64_t>(buf_size)); 4861 if (bytes_available > buf_size) 4862 { 4863 memcpy(buf, m_stdout_data.c_str(), buf_size); 4864 m_stdout_data.erase(0, buf_size); 4865 bytes_available = buf_size; 4866 } 4867 else 4868 { 4869 memcpy(buf, m_stdout_data.c_str(), bytes_available); 4870 m_stdout_data.clear(); 4871 } 4872 } 4873 return bytes_available; 4874 } 4875 4876 size_t 4877 Process::GetSTDERR (char *buf, size_t buf_size, Error &error) 4878 { 4879 Mutex::Locker locker(m_stdio_communication_mutex); 4880 size_t bytes_available = m_stderr_data.size(); 4881 if (bytes_available > 0) 4882 { 4883 Log *log (lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS)); 4884 if (log) 4885 log->Printf ("Process::GetSTDERR (buf = %p, size = %" PRIu64 ")", 4886 static_cast<void*>(buf), 4887 static_cast<uint64_t>(buf_size)); 4888 if (bytes_available > buf_size) 4889 { 4890 memcpy(buf, m_stderr_data.c_str(), buf_size); 4891 m_stderr_data.erase(0, buf_size); 4892 bytes_available = buf_size; 4893 } 4894 else 4895 { 4896 memcpy(buf, m_stderr_data.c_str(), bytes_available); 4897 m_stderr_data.clear(); 4898 } 4899 } 4900 return bytes_available; 4901 } 4902 4903 void 4904 Process::STDIOReadThreadBytesReceived (void *baton, const void *src, size_t src_len) 4905 { 4906 Process *process = (Process *) baton; 4907 process->AppendSTDOUT (static_cast<const char *>(src), src_len); 4908 } 4909 4910 class IOHandlerProcessSTDIO : 4911 public IOHandler 4912 { 4913 public: 4914 IOHandlerProcessSTDIO (Process *process, 4915 int write_fd) : 4916 IOHandler(process->GetTarget().GetDebugger(), IOHandler::Type::ProcessIO), 4917 m_process (process), 4918 m_read_file (), 4919 m_write_file (write_fd, false), 4920 m_pipe () 4921 { 4922 m_pipe.CreateNew(false); 4923 m_read_file.SetDescriptor(GetInputFD(), false); 4924 } 4925 4926 ~IOHandlerProcessSTDIO() override = default; 4927 4928 // Each IOHandler gets to run until it is done. It should read data 4929 // from the "in" and place output into "out" and "err and return 4930 // when done. 4931 void 4932 Run () override 4933 { 4934 if (!m_read_file.IsValid() || !m_write_file.IsValid() || !m_pipe.CanRead() || !m_pipe.CanWrite()) 4935 { 4936 SetIsDone(true); 4937 return; 4938 } 4939 4940 SetIsDone(false); 4941 const int read_fd = m_read_file.GetDescriptor(); 4942 TerminalState terminal_state; 4943 terminal_state.Save (read_fd, false); 4944 Terminal terminal(read_fd); 4945 terminal.SetCanonical(false); 4946 terminal.SetEcho(false); 4947 // FD_ZERO, FD_SET are not supported on windows 4948 #ifndef _WIN32 4949 const int pipe_read_fd = m_pipe.GetReadFileDescriptor(); 4950 m_is_running = true; 4951 while (!GetIsDone()) 4952 { 4953 fd_set read_fdset; 4954 FD_ZERO (&read_fdset); 4955 FD_SET (read_fd, &read_fdset); 4956 FD_SET (pipe_read_fd, &read_fdset); 4957 const int nfds = std::max<int>(read_fd, pipe_read_fd) + 1; 4958 int num_set_fds = select(nfds, &read_fdset, nullptr, nullptr, nullptr); 4959 4960 if (num_set_fds < 0) 4961 { 4962 const int select_errno = errno; 4963 4964 if (select_errno != EINTR) 4965 SetIsDone(true); 4966 } 4967 else if (num_set_fds > 0) 4968 { 4969 char ch = 0; 4970 size_t n; 4971 if (FD_ISSET (read_fd, &read_fdset)) 4972 { 4973 n = 1; 4974 if (m_read_file.Read(&ch, n).Success() && n == 1) 4975 { 4976 if (m_write_file.Write(&ch, n).Fail() || n != 1) 4977 SetIsDone(true); 4978 } 4979 else 4980 SetIsDone(true); 4981 } 4982 if (FD_ISSET (pipe_read_fd, &read_fdset)) 4983 { 4984 size_t bytes_read; 4985 // Consume the interrupt byte 4986 Error error = m_pipe.Read(&ch, 1, bytes_read); 4987 if (error.Success()) 4988 { 4989 switch (ch) 4990 { 4991 case 'q': 4992 SetIsDone(true); 4993 break; 4994 case 'i': 4995 if (StateIsRunningState(m_process->GetState())) 4996 m_process->SendAsyncInterrupt(); 4997 break; 4998 } 4999 } 5000 } 5001 } 5002 } 5003 m_is_running = false; 5004 #endif 5005 terminal_state.Restore(); 5006 } 5007 5008 void 5009 Cancel () override 5010 { 5011 SetIsDone(true); 5012 // Only write to our pipe to cancel if we are in IOHandlerProcessSTDIO::Run(). 5013 // We can end up with a python command that is being run from the command 5014 // interpreter: 5015 // 5016 // (lldb) step_process_thousands_of_times 5017 // 5018 // In this case the command interpreter will be in the middle of handling 5019 // the command and if the process pushes and pops the IOHandler thousands 5020 // of times, we can end up writing to m_pipe without ever consuming the 5021 // bytes from the pipe in IOHandlerProcessSTDIO::Run() and end up 5022 // deadlocking when the pipe gets fed up and blocks until data is consumed. 5023 if (m_is_running) 5024 { 5025 char ch = 'q'; // Send 'q' for quit 5026 size_t bytes_written = 0; 5027 m_pipe.Write(&ch, 1, bytes_written); 5028 } 5029 } 5030 5031 bool 5032 Interrupt () override 5033 { 5034 // Do only things that are safe to do in an interrupt context (like in 5035 // a SIGINT handler), like write 1 byte to a file descriptor. This will 5036 // interrupt the IOHandlerProcessSTDIO::Run() and we can look at the byte 5037 // that was written to the pipe and then call m_process->SendAsyncInterrupt() 5038 // from a much safer location in code. 5039 if (m_active) 5040 { 5041 char ch = 'i'; // Send 'i' for interrupt 5042 size_t bytes_written = 0; 5043 Error result = m_pipe.Write(&ch, 1, bytes_written); 5044 return result.Success(); 5045 } 5046 else 5047 { 5048 // This IOHandler might be pushed on the stack, but not being run currently 5049 // so do the right thing if we aren't actively watching for STDIN by sending 5050 // the interrupt to the process. Otherwise the write to the pipe above would 5051 // do nothing. This can happen when the command interpreter is running and 5052 // gets a "expression ...". It will be on the IOHandler thread and sending 5053 // the input is complete to the delegate which will cause the expression to 5054 // run, which will push the process IO handler, but not run it. 5055 5056 if (StateIsRunningState(m_process->GetState())) 5057 { 5058 m_process->SendAsyncInterrupt(); 5059 return true; 5060 } 5061 } 5062 return false; 5063 } 5064 5065 void 5066 GotEOF() override 5067 { 5068 } 5069 5070 protected: 5071 Process *m_process; 5072 File m_read_file; // Read from this file (usually actual STDIN for LLDB 5073 File m_write_file; // Write to this file (usually the master pty for getting io to debuggee) 5074 Pipe m_pipe; 5075 std::atomic<bool> m_is_running; 5076 }; 5077 5078 void 5079 Process::SetSTDIOFileDescriptor (int fd) 5080 { 5081 // First set up the Read Thread for reading/handling process I/O 5082 5083 std::unique_ptr<ConnectionFileDescriptor> conn_ap (new ConnectionFileDescriptor (fd, true)); 5084 5085 if (conn_ap) 5086 { 5087 m_stdio_communication.SetConnection (conn_ap.release()); 5088 if (m_stdio_communication.IsConnected()) 5089 { 5090 m_stdio_communication.SetReadThreadBytesReceivedCallback (STDIOReadThreadBytesReceived, this); 5091 m_stdio_communication.StartReadThread(); 5092 5093 // Now read thread is set up, set up input reader. 5094 5095 if (!m_process_input_reader) 5096 m_process_input_reader.reset (new IOHandlerProcessSTDIO (this, fd)); 5097 } 5098 } 5099 } 5100 5101 bool 5102 Process::ProcessIOHandlerIsActive () 5103 { 5104 IOHandlerSP io_handler_sp (m_process_input_reader); 5105 if (io_handler_sp) 5106 return GetTarget().GetDebugger().IsTopIOHandler (io_handler_sp); 5107 return false; 5108 } 5109 bool 5110 Process::PushProcessIOHandler () 5111 { 5112 IOHandlerSP io_handler_sp (m_process_input_reader); 5113 if (io_handler_sp) 5114 { 5115 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS)); 5116 if (log) 5117 log->Printf("Process::%s pushing IO handler", __FUNCTION__); 5118 5119 io_handler_sp->SetIsDone(false); 5120 GetTarget().GetDebugger().PushIOHandler (io_handler_sp); 5121 return true; 5122 } 5123 return false; 5124 } 5125 5126 bool 5127 Process::PopProcessIOHandler () 5128 { 5129 IOHandlerSP io_handler_sp (m_process_input_reader); 5130 if (io_handler_sp) 5131 return GetTarget().GetDebugger().PopIOHandler (io_handler_sp); 5132 return false; 5133 } 5134 5135 // The process needs to know about installed plug-ins 5136 void 5137 Process::SettingsInitialize () 5138 { 5139 Thread::SettingsInitialize (); 5140 } 5141 5142 void 5143 Process::SettingsTerminate () 5144 { 5145 Thread::SettingsTerminate (); 5146 } 5147 5148 namespace 5149 { 5150 // RestorePlanState is used to record the "is private", "is master" and "okay to discard" fields of 5151 // the plan we are running, and reset it on Clean or on destruction. 5152 // It will only reset the state once, so you can call Clean and then monkey with the state and it 5153 // won't get reset on you again. 5154 5155 class RestorePlanState 5156 { 5157 public: 5158 RestorePlanState (lldb::ThreadPlanSP thread_plan_sp) : 5159 m_thread_plan_sp(thread_plan_sp), 5160 m_already_reset(false) 5161 { 5162 if (m_thread_plan_sp) 5163 { 5164 m_private = m_thread_plan_sp->GetPrivate(); 5165 m_is_master = m_thread_plan_sp->IsMasterPlan(); 5166 m_okay_to_discard = m_thread_plan_sp->OkayToDiscard(); 5167 } 5168 } 5169 5170 ~RestorePlanState() 5171 { 5172 Clean(); 5173 } 5174 5175 void 5176 Clean () 5177 { 5178 if (!m_already_reset && m_thread_plan_sp) 5179 { 5180 m_already_reset = true; 5181 m_thread_plan_sp->SetPrivate(m_private); 5182 m_thread_plan_sp->SetIsMasterPlan (m_is_master); 5183 m_thread_plan_sp->SetOkayToDiscard(m_okay_to_discard); 5184 } 5185 } 5186 5187 private: 5188 lldb::ThreadPlanSP m_thread_plan_sp; 5189 bool m_already_reset; 5190 bool m_private; 5191 bool m_is_master; 5192 bool m_okay_to_discard; 5193 }; 5194 } // anonymous namespace 5195 5196 ExpressionResults 5197 Process::RunThreadPlan (ExecutionContext &exe_ctx, 5198 lldb::ThreadPlanSP &thread_plan_sp, 5199 const EvaluateExpressionOptions &options, 5200 Stream &errors) 5201 { 5202 ExpressionResults return_value = eExpressionSetupError; 5203 5204 if (!thread_plan_sp) 5205 { 5206 errors.Printf("RunThreadPlan called with empty thread plan."); 5207 return eExpressionSetupError; 5208 } 5209 5210 if (!thread_plan_sp->ValidatePlan(nullptr)) 5211 { 5212 errors.Printf ("RunThreadPlan called with an invalid thread plan."); 5213 return eExpressionSetupError; 5214 } 5215 5216 if (exe_ctx.GetProcessPtr() != this) 5217 { 5218 errors.Printf("RunThreadPlan called on wrong process."); 5219 return eExpressionSetupError; 5220 } 5221 5222 Thread *thread = exe_ctx.GetThreadPtr(); 5223 if (thread == nullptr) 5224 { 5225 errors.Printf("RunThreadPlan called with invalid thread."); 5226 return eExpressionSetupError; 5227 } 5228 5229 // We need to change some of the thread plan attributes for the thread plan runner. This will restore them 5230 // when we are done: 5231 5232 RestorePlanState thread_plan_restorer(thread_plan_sp); 5233 5234 // We rely on the thread plan we are running returning "PlanCompleted" if when it successfully completes. 5235 // For that to be true the plan can't be private - since private plans suppress themselves in the 5236 // GetCompletedPlan call. 5237 5238 thread_plan_sp->SetPrivate(false); 5239 5240 // The plans run with RunThreadPlan also need to be terminal master plans or when they are done we will end 5241 // up asking the plan above us whether we should stop, which may give the wrong answer. 5242 5243 thread_plan_sp->SetIsMasterPlan (true); 5244 thread_plan_sp->SetOkayToDiscard(false); 5245 5246 if (m_private_state.GetValue() != eStateStopped) 5247 { 5248 errors.Printf ("RunThreadPlan called while the private state was not stopped."); 5249 return eExpressionSetupError; 5250 } 5251 5252 // Save the thread & frame from the exe_ctx for restoration after we run 5253 const uint32_t thread_idx_id = thread->GetIndexID(); 5254 StackFrameSP selected_frame_sp = thread->GetSelectedFrame(); 5255 if (!selected_frame_sp) 5256 { 5257 thread->SetSelectedFrame(nullptr); 5258 selected_frame_sp = thread->GetSelectedFrame(); 5259 if (!selected_frame_sp) 5260 { 5261 errors.Printf("RunThreadPlan called without a selected frame on thread %d", thread_idx_id); 5262 return eExpressionSetupError; 5263 } 5264 } 5265 5266 StackID ctx_frame_id = selected_frame_sp->GetStackID(); 5267 5268 // N.B. Running the target may unset the currently selected thread and frame. We don't want to do that either, 5269 // so we should arrange to reset them as well. 5270 5271 lldb::ThreadSP selected_thread_sp = GetThreadList().GetSelectedThread(); 5272 5273 uint32_t selected_tid; 5274 StackID selected_stack_id; 5275 if (selected_thread_sp) 5276 { 5277 selected_tid = selected_thread_sp->GetIndexID(); 5278 selected_stack_id = selected_thread_sp->GetSelectedFrame()->GetStackID(); 5279 } 5280 else 5281 { 5282 selected_tid = LLDB_INVALID_THREAD_ID; 5283 } 5284 5285 HostThread backup_private_state_thread; 5286 lldb::StateType old_state = eStateInvalid; 5287 lldb::ThreadPlanSP stopper_base_plan_sp; 5288 5289 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STEP | LIBLLDB_LOG_PROCESS)); 5290 if (m_private_state_thread.EqualsThread(Host::GetCurrentThread())) 5291 { 5292 // Yikes, we are running on the private state thread! So we can't wait for public events on this thread, since 5293 // we are the thread that is generating public events. 5294 // The simplest thing to do is to spin up a temporary thread to handle private state thread events while 5295 // we are fielding public events here. 5296 if (log) 5297 log->Printf ("Running thread plan on private state thread, spinning up another state thread to handle the events."); 5298 5299 backup_private_state_thread = m_private_state_thread; 5300 5301 // One other bit of business: we want to run just this thread plan and anything it pushes, and then stop, 5302 // returning control here. 5303 // But in the normal course of things, the plan above us on the stack would be given a shot at the stop 5304 // event before deciding to stop, and we don't want that. So we insert a "stopper" base plan on the stack 5305 // before the plan we want to run. Since base plans always stop and return control to the user, that will 5306 // do just what we want. 5307 stopper_base_plan_sp.reset(new ThreadPlanBase (*thread)); 5308 thread->QueueThreadPlan (stopper_base_plan_sp, false); 5309 // Have to make sure our public state is stopped, since otherwise the reporting logic below doesn't work correctly. 5310 old_state = m_public_state.GetValue(); 5311 m_public_state.SetValueNoLock(eStateStopped); 5312 5313 // Now spin up the private state thread: 5314 StartPrivateStateThread(true); 5315 } 5316 5317 thread->QueueThreadPlan(thread_plan_sp, false); // This used to pass "true" does that make sense? 5318 5319 if (options.GetDebug()) 5320 { 5321 // In this case, we aren't actually going to run, we just want to stop right away. 5322 // Flush this thread so we will refetch the stacks and show the correct backtrace. 5323 // FIXME: To make this prettier we should invent some stop reason for this, but that 5324 // is only cosmetic, and this functionality is only of use to lldb developers who can 5325 // live with not pretty... 5326 thread->Flush(); 5327 return eExpressionStoppedForDebug; 5328 } 5329 5330 ListenerSP listener_sp(Listener::MakeListener("lldb.process.listener.run-thread-plan")); 5331 5332 lldb::EventSP event_to_broadcast_sp; 5333 5334 { 5335 // This process event hijacker Hijacks the Public events and its destructor makes sure that the process events get 5336 // restored on exit to the function. 5337 // 5338 // If the event needs to propagate beyond the hijacker (e.g., the process exits during execution), then the event 5339 // is put into event_to_broadcast_sp for rebroadcasting. 5340 5341 ProcessEventHijacker run_thread_plan_hijacker (*this, listener_sp); 5342 5343 if (log) 5344 { 5345 StreamString s; 5346 thread_plan_sp->GetDescription(&s, lldb::eDescriptionLevelVerbose); 5347 log->Printf ("Process::RunThreadPlan(): Resuming thread %u - 0x%4.4" PRIx64 " to run thread plan \"%s\".", 5348 thread->GetIndexID(), 5349 thread->GetID(), 5350 s.GetData()); 5351 } 5352 5353 bool got_event; 5354 lldb::EventSP event_sp; 5355 lldb::StateType stop_state = lldb::eStateInvalid; 5356 5357 TimeValue* timeout_ptr = nullptr; 5358 TimeValue real_timeout; 5359 5360 bool before_first_timeout = true; // This is set to false the first time that we have to halt the target. 5361 bool do_resume = true; 5362 bool handle_running_event = true; 5363 const uint64_t default_one_thread_timeout_usec = 250000; 5364 5365 // This is just for accounting: 5366 uint32_t num_resumes = 0; 5367 5368 uint32_t timeout_usec = options.GetTimeoutUsec(); 5369 uint32_t one_thread_timeout_usec; 5370 uint32_t all_threads_timeout_usec = 0; 5371 5372 // If we are going to run all threads the whole time, or if we are only going to run one thread, 5373 // then we don't need the first timeout. So we set the final timeout, and pretend we are after the 5374 // first timeout already. 5375 5376 if (!options.GetStopOthers() || !options.GetTryAllThreads()) 5377 { 5378 before_first_timeout = false; 5379 one_thread_timeout_usec = 0; 5380 all_threads_timeout_usec = timeout_usec; 5381 } 5382 else 5383 { 5384 uint32_t option_one_thread_timeout = options.GetOneThreadTimeoutUsec(); 5385 5386 // If the overall wait is forever, then we only need to set the one thread timeout: 5387 if (timeout_usec == 0) 5388 { 5389 if (option_one_thread_timeout != 0) 5390 one_thread_timeout_usec = option_one_thread_timeout; 5391 else 5392 one_thread_timeout_usec = default_one_thread_timeout_usec; 5393 } 5394 else 5395 { 5396 // Otherwise, if the one thread timeout is set, make sure it isn't longer than the overall timeout, 5397 // and use it, otherwise use half the total timeout, bounded by the default_one_thread_timeout_usec. 5398 uint64_t computed_one_thread_timeout; 5399 if (option_one_thread_timeout != 0) 5400 { 5401 if (timeout_usec < option_one_thread_timeout) 5402 { 5403 errors.Printf("RunThreadPlan called without one thread timeout greater than total timeout"); 5404 return eExpressionSetupError; 5405 } 5406 computed_one_thread_timeout = option_one_thread_timeout; 5407 } 5408 else 5409 { 5410 computed_one_thread_timeout = timeout_usec / 2; 5411 if (computed_one_thread_timeout > default_one_thread_timeout_usec) 5412 computed_one_thread_timeout = default_one_thread_timeout_usec; 5413 } 5414 one_thread_timeout_usec = computed_one_thread_timeout; 5415 all_threads_timeout_usec = timeout_usec - one_thread_timeout_usec; 5416 } 5417 } 5418 5419 if (log) 5420 log->Printf ("Stop others: %u, try all: %u, before_first: %u, one thread: %" PRIu32 " - all threads: %" PRIu32 ".\n", 5421 options.GetStopOthers(), 5422 options.GetTryAllThreads(), 5423 before_first_timeout, 5424 one_thread_timeout_usec, 5425 all_threads_timeout_usec); 5426 5427 // This isn't going to work if there are unfetched events on the queue. 5428 // Are there cases where we might want to run the remaining events here, and then try to 5429 // call the function? That's probably being too tricky for our own good. 5430 5431 Event *other_events = listener_sp->PeekAtNextEvent(); 5432 if (other_events != nullptr) 5433 { 5434 errors.Printf("Calling RunThreadPlan with pending events on the queue."); 5435 return eExpressionSetupError; 5436 } 5437 5438 // We also need to make sure that the next event is delivered. We might be calling a function as part of 5439 // a thread plan, in which case the last delivered event could be the running event, and we don't want 5440 // event coalescing to cause us to lose OUR running event... 5441 ForceNextEventDelivery(); 5442 5443 // This while loop must exit out the bottom, there's cleanup that we need to do when we are done. 5444 // So don't call return anywhere within it. 5445 5446 #ifdef LLDB_RUN_THREAD_HALT_WITH_EVENT 5447 // It's pretty much impossible to write test cases for things like: 5448 // One thread timeout expires, I go to halt, but the process already stopped 5449 // on the function call stop breakpoint. Turning on this define will make us not 5450 // fetch the first event till after the halt. So if you run a quick function, it will have 5451 // completed, and the completion event will be waiting, when you interrupt for halt. 5452 // The expression evaluation should still succeed. 5453 bool miss_first_event = true; 5454 #endif 5455 TimeValue one_thread_timeout; 5456 TimeValue final_timeout; 5457 5458 while (true) 5459 { 5460 // We usually want to resume the process if we get to the top of the loop. 5461 // The only exception is if we get two running events with no intervening 5462 // stop, which can happen, we will just wait for then next stop event. 5463 if (log) 5464 log->Printf ("Top of while loop: do_resume: %i handle_running_event: %i before_first_timeout: %i.", 5465 do_resume, 5466 handle_running_event, 5467 before_first_timeout); 5468 5469 if (do_resume || handle_running_event) 5470 { 5471 // Do the initial resume and wait for the running event before going further. 5472 5473 if (do_resume) 5474 { 5475 num_resumes++; 5476 Error resume_error = PrivateResume (); 5477 if (!resume_error.Success()) 5478 { 5479 errors.Printf("Error resuming inferior the %d time: \"%s\".\n", 5480 num_resumes, 5481 resume_error.AsCString()); 5482 return_value = eExpressionSetupError; 5483 break; 5484 } 5485 } 5486 5487 TimeValue resume_timeout = TimeValue::Now(); 5488 resume_timeout.OffsetWithMicroSeconds(500000); 5489 5490 got_event = listener_sp->WaitForEvent(&resume_timeout, event_sp); 5491 if (!got_event) 5492 { 5493 if (log) 5494 log->Printf ("Process::RunThreadPlan(): didn't get any event after resume %d, exiting.", 5495 num_resumes); 5496 5497 errors.Printf("Didn't get any event after resume %d, exiting.", num_resumes); 5498 return_value = eExpressionSetupError; 5499 break; 5500 } 5501 5502 stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get()); 5503 5504 if (stop_state != eStateRunning) 5505 { 5506 bool restarted = false; 5507 5508 if (stop_state == eStateStopped) 5509 { 5510 restarted = Process::ProcessEventData::GetRestartedFromEvent(event_sp.get()); 5511 if (log) 5512 log->Printf("Process::RunThreadPlan(): didn't get running event after " 5513 "resume %d, got %s instead (restarted: %i, do_resume: %i, handle_running_event: %i).", 5514 num_resumes, 5515 StateAsCString(stop_state), 5516 restarted, 5517 do_resume, 5518 handle_running_event); 5519 } 5520 5521 if (restarted) 5522 { 5523 // This is probably an overabundance of caution, I don't think I should ever get a stopped & restarted 5524 // event here. But if I do, the best thing is to Halt and then get out of here. 5525 const bool clear_thread_plans = false; 5526 const bool use_run_lock = false; 5527 Halt(clear_thread_plans, use_run_lock); 5528 } 5529 5530 errors.Printf("Didn't get running event after initial resume, got %s instead.", 5531 StateAsCString(stop_state)); 5532 return_value = eExpressionSetupError; 5533 break; 5534 } 5535 5536 if (log) 5537 log->PutCString ("Process::RunThreadPlan(): resuming succeeded."); 5538 // We need to call the function synchronously, so spin waiting for it to return. 5539 // If we get interrupted while executing, we're going to lose our context, and 5540 // won't be able to gather the result at this point. 5541 // We set the timeout AFTER the resume, since the resume takes some time and we 5542 // don't want to charge that to the timeout. 5543 } 5544 else 5545 { 5546 if (log) 5547 log->PutCString ("Process::RunThreadPlan(): waiting for next event."); 5548 } 5549 5550 if (before_first_timeout) 5551 { 5552 if (options.GetTryAllThreads()) 5553 { 5554 one_thread_timeout = TimeValue::Now(); 5555 one_thread_timeout.OffsetWithMicroSeconds(one_thread_timeout_usec); 5556 timeout_ptr = &one_thread_timeout; 5557 } 5558 else 5559 { 5560 if (timeout_usec == 0) 5561 timeout_ptr = nullptr; 5562 else 5563 { 5564 final_timeout = TimeValue::Now(); 5565 final_timeout.OffsetWithMicroSeconds (timeout_usec); 5566 timeout_ptr = &final_timeout; 5567 } 5568 } 5569 } 5570 else 5571 { 5572 if (timeout_usec == 0) 5573 timeout_ptr = nullptr; 5574 else 5575 { 5576 final_timeout = TimeValue::Now(); 5577 final_timeout.OffsetWithMicroSeconds (all_threads_timeout_usec); 5578 timeout_ptr = &final_timeout; 5579 } 5580 } 5581 5582 do_resume = true; 5583 handle_running_event = true; 5584 5585 // Now wait for the process to stop again: 5586 event_sp.reset(); 5587 5588 if (log) 5589 { 5590 if (timeout_ptr) 5591 { 5592 log->Printf ("Process::RunThreadPlan(): about to wait - now is %" PRIu64 " - endpoint is %" PRIu64, 5593 TimeValue::Now().GetAsMicroSecondsSinceJan1_1970(), 5594 timeout_ptr->GetAsMicroSecondsSinceJan1_1970()); 5595 } 5596 else 5597 { 5598 log->Printf ("Process::RunThreadPlan(): about to wait forever."); 5599 } 5600 } 5601 5602 #ifdef LLDB_RUN_THREAD_HALT_WITH_EVENT 5603 // See comment above... 5604 if (miss_first_event) 5605 { 5606 usleep(1000); 5607 miss_first_event = false; 5608 got_event = false; 5609 } 5610 else 5611 #endif 5612 got_event = listener_sp->WaitForEvent (timeout_ptr, event_sp); 5613 5614 if (got_event) 5615 { 5616 if (event_sp) 5617 { 5618 bool keep_going = false; 5619 if (event_sp->GetType() == eBroadcastBitInterrupt) 5620 { 5621 const bool clear_thread_plans = false; 5622 const bool use_run_lock = false; 5623 Halt(clear_thread_plans, use_run_lock); 5624 return_value = eExpressionInterrupted; 5625 errors.Printf ("Execution halted by user interrupt."); 5626 if (log) 5627 log->Printf ("Process::RunThreadPlan(): Got interrupted by eBroadcastBitInterrupted, exiting."); 5628 break; 5629 } 5630 else 5631 { 5632 stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get()); 5633 if (log) 5634 log->Printf("Process::RunThreadPlan(): in while loop, got event: %s.", StateAsCString(stop_state)); 5635 5636 switch (stop_state) 5637 { 5638 case lldb::eStateStopped: 5639 { 5640 // We stopped, figure out what we are going to do now. 5641 ThreadSP thread_sp = GetThreadList().FindThreadByIndexID (thread_idx_id); 5642 if (!thread_sp) 5643 { 5644 // Ooh, our thread has vanished. Unlikely that this was successful execution... 5645 if (log) 5646 log->Printf ("Process::RunThreadPlan(): execution completed but our thread (index-id=%u) has vanished.", thread_idx_id); 5647 return_value = eExpressionInterrupted; 5648 } 5649 else 5650 { 5651 // If we were restarted, we just need to go back up to fetch another event. 5652 if (Process::ProcessEventData::GetRestartedFromEvent(event_sp.get())) 5653 { 5654 if (log) 5655 { 5656 log->Printf ("Process::RunThreadPlan(): Got a stop and restart, so we'll continue waiting."); 5657 } 5658 keep_going = true; 5659 do_resume = false; 5660 handle_running_event = true; 5661 } 5662 else 5663 { 5664 StopInfoSP stop_info_sp (thread_sp->GetStopInfo ()); 5665 StopReason stop_reason = eStopReasonInvalid; 5666 if (stop_info_sp) 5667 stop_reason = stop_info_sp->GetStopReason(); 5668 5669 // FIXME: We only check if the stop reason is plan complete, should we make sure that 5670 // it is OUR plan that is complete? 5671 if (stop_reason == eStopReasonPlanComplete) 5672 { 5673 if (log) 5674 log->PutCString ("Process::RunThreadPlan(): execution completed successfully."); 5675 5676 // Restore the plan state so it will get reported as intended when we are done. 5677 thread_plan_restorer.Clean(); 5678 5679 return_value = eExpressionCompleted; 5680 } 5681 else 5682 { 5683 // Something restarted the target, so just wait for it to stop for real. 5684 if (stop_reason == eStopReasonBreakpoint) 5685 { 5686 if (log) 5687 log->Printf ("Process::RunThreadPlan() stopped for breakpoint: %s.", stop_info_sp->GetDescription()); 5688 return_value = eExpressionHitBreakpoint; 5689 if (!options.DoesIgnoreBreakpoints()) 5690 { 5691 // Restore the plan state and then force Private to false. We are 5692 // going to stop because of this plan so we need it to become a public 5693 // plan or it won't report correctly when we continue to its termination 5694 // later on. 5695 thread_plan_restorer.Clean(); 5696 if (thread_plan_sp) 5697 thread_plan_sp->SetPrivate(false); 5698 event_to_broadcast_sp = event_sp; 5699 } 5700 } 5701 else 5702 { 5703 if (log) 5704 log->PutCString ("Process::RunThreadPlan(): thread plan didn't successfully complete."); 5705 if (!options.DoesUnwindOnError()) 5706 event_to_broadcast_sp = event_sp; 5707 return_value = eExpressionInterrupted; 5708 } 5709 } 5710 } 5711 } 5712 } 5713 break; 5714 5715 case lldb::eStateRunning: 5716 // This shouldn't really happen, but sometimes we do get two running events without an 5717 // intervening stop, and in that case we should just go back to waiting for the stop. 5718 do_resume = false; 5719 keep_going = true; 5720 handle_running_event = false; 5721 break; 5722 5723 default: 5724 if (log) 5725 log->Printf("Process::RunThreadPlan(): execution stopped with unexpected state: %s.", StateAsCString(stop_state)); 5726 5727 if (stop_state == eStateExited) 5728 event_to_broadcast_sp = event_sp; 5729 5730 errors.Printf ("Execution stopped with unexpected state.\n"); 5731 return_value = eExpressionInterrupted; 5732 break; 5733 } 5734 } 5735 5736 if (keep_going) 5737 continue; 5738 else 5739 break; 5740 } 5741 else 5742 { 5743 if (log) 5744 log->PutCString ("Process::RunThreadPlan(): got_event was true, but the event pointer was null. How odd..."); 5745 return_value = eExpressionInterrupted; 5746 break; 5747 } 5748 } 5749 else 5750 { 5751 // If we didn't get an event that means we've timed out... 5752 // We will interrupt the process here. Depending on what we were asked to do we will 5753 // either exit, or try with all threads running for the same timeout. 5754 5755 if (log) { 5756 if (options.GetTryAllThreads()) 5757 { 5758 if (before_first_timeout) 5759 { 5760 if (timeout_usec != 0) 5761 { 5762 log->Printf ("Process::RunThreadPlan(): Running function with one thread timeout timed out, " 5763 "running for %" PRIu32 " usec with all threads enabled.", 5764 all_threads_timeout_usec); 5765 } 5766 else 5767 { 5768 log->Printf ("Process::RunThreadPlan(): Running function with one thread timeout timed out, " 5769 "running forever with all threads enabled."); 5770 } 5771 } 5772 else 5773 log->Printf ("Process::RunThreadPlan(): Restarting function with all threads enabled " 5774 "and timeout: %u timed out, abandoning execution.", 5775 timeout_usec); 5776 } 5777 else 5778 log->Printf ("Process::RunThreadPlan(): Running function with timeout: %u timed out, " 5779 "abandoning execution.", 5780 timeout_usec); 5781 } 5782 5783 // It is possible that between the time we issued the Halt, and we get around to calling Halt the target 5784 // could have stopped. That's fine, Halt will figure that out and send the appropriate Stopped event. 5785 // BUT it is also possible that we stopped & restarted (e.g. hit a signal with "stop" set to false.) In 5786 // that case, we'll get the stopped & restarted event, and we should go back to waiting for the Halt's 5787 // stopped event. That's what this while loop does. 5788 5789 bool back_to_top = true; 5790 uint32_t try_halt_again = 0; 5791 bool do_halt = true; 5792 const uint32_t num_retries = 5; 5793 while (try_halt_again < num_retries) 5794 { 5795 Error halt_error; 5796 if (do_halt) 5797 { 5798 if (log) 5799 log->Printf ("Process::RunThreadPlan(): Running Halt."); 5800 const bool clear_thread_plans = false; 5801 const bool use_run_lock = false; 5802 Halt(clear_thread_plans, use_run_lock); 5803 } 5804 if (halt_error.Success()) 5805 { 5806 if (log) 5807 log->PutCString ("Process::RunThreadPlan(): Halt succeeded."); 5808 5809 real_timeout = TimeValue::Now(); 5810 real_timeout.OffsetWithMicroSeconds(500000); 5811 5812 got_event = listener_sp->WaitForEvent(&real_timeout, event_sp); 5813 5814 if (got_event) 5815 { 5816 stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get()); 5817 if (log) 5818 { 5819 log->Printf ("Process::RunThreadPlan(): Stopped with event: %s", StateAsCString(stop_state)); 5820 if (stop_state == lldb::eStateStopped 5821 && Process::ProcessEventData::GetInterruptedFromEvent(event_sp.get())) 5822 log->PutCString (" Event was the Halt interruption event."); 5823 } 5824 5825 if (stop_state == lldb::eStateStopped) 5826 { 5827 // Between the time we initiated the Halt and the time we delivered it, the process could have 5828 // already finished its job. Check that here: 5829 5830 if (thread->IsThreadPlanDone (thread_plan_sp.get())) 5831 { 5832 if (log) 5833 log->PutCString ("Process::RunThreadPlan(): Even though we timed out, the call plan was done. " 5834 "Exiting wait loop."); 5835 return_value = eExpressionCompleted; 5836 back_to_top = false; 5837 break; 5838 } 5839 5840 if (Process::ProcessEventData::GetRestartedFromEvent(event_sp.get())) 5841 { 5842 if (log) 5843 log->PutCString ("Process::RunThreadPlan(): Went to halt but got a restarted event, there must be an un-restarted stopped event so try again... " 5844 "Exiting wait loop."); 5845 try_halt_again++; 5846 do_halt = false; 5847 continue; 5848 } 5849 5850 if (!options.GetTryAllThreads()) 5851 { 5852 if (log) 5853 log->PutCString ("Process::RunThreadPlan(): try_all_threads was false, we stopped so now we're quitting."); 5854 return_value = eExpressionInterrupted; 5855 back_to_top = false; 5856 break; 5857 } 5858 5859 if (before_first_timeout) 5860 { 5861 // Set all the other threads to run, and return to the top of the loop, which will continue; 5862 before_first_timeout = false; 5863 thread_plan_sp->SetStopOthers (false); 5864 if (log) 5865 log->PutCString ("Process::RunThreadPlan(): about to resume."); 5866 5867 back_to_top = true; 5868 break; 5869 } 5870 else 5871 { 5872 // Running all threads failed, so return Interrupted. 5873 if (log) 5874 log->PutCString("Process::RunThreadPlan(): running all threads timed out."); 5875 return_value = eExpressionInterrupted; 5876 back_to_top = false; 5877 break; 5878 } 5879 } 5880 } 5881 else 5882 { if (log) 5883 log->PutCString("Process::RunThreadPlan(): halt said it succeeded, but I got no event. " 5884 "I'm getting out of here passing Interrupted."); 5885 return_value = eExpressionInterrupted; 5886 back_to_top = false; 5887 break; 5888 } 5889 } 5890 else 5891 { 5892 try_halt_again++; 5893 continue; 5894 } 5895 } 5896 5897 if (!back_to_top || try_halt_again > num_retries) 5898 break; 5899 else 5900 continue; 5901 } 5902 } // END WAIT LOOP 5903 5904 // If we had to start up a temporary private state thread to run this thread plan, shut it down now. 5905 if (backup_private_state_thread.IsJoinable()) 5906 { 5907 StopPrivateStateThread(); 5908 Error error; 5909 m_private_state_thread = backup_private_state_thread; 5910 if (stopper_base_plan_sp) 5911 { 5912 thread->DiscardThreadPlansUpToPlan(stopper_base_plan_sp); 5913 } 5914 if (old_state != eStateInvalid) 5915 m_public_state.SetValueNoLock(old_state); 5916 } 5917 5918 if (return_value != eExpressionCompleted && log) 5919 { 5920 // Print a backtrace into the log so we can figure out where we are: 5921 StreamString s; 5922 s.PutCString("Thread state after unsuccessful completion: \n"); 5923 thread->GetStackFrameStatus (s, 5924 0, 5925 UINT32_MAX, 5926 true, 5927 UINT32_MAX); 5928 log->PutCString(s.GetData()); 5929 5930 } 5931 // Restore the thread state if we are going to discard the plan execution. There are three cases where this 5932 // could happen: 5933 // 1) The execution successfully completed 5934 // 2) We hit a breakpoint, and ignore_breakpoints was true 5935 // 3) We got some other error, and discard_on_error was true 5936 bool should_unwind = (return_value == eExpressionInterrupted && options.DoesUnwindOnError()) 5937 || (return_value == eExpressionHitBreakpoint && options.DoesIgnoreBreakpoints()); 5938 5939 if (return_value == eExpressionCompleted 5940 || should_unwind) 5941 { 5942 thread_plan_sp->RestoreThreadState(); 5943 } 5944 5945 // Now do some processing on the results of the run: 5946 if (return_value == eExpressionInterrupted || return_value == eExpressionHitBreakpoint) 5947 { 5948 if (log) 5949 { 5950 StreamString s; 5951 if (event_sp) 5952 event_sp->Dump (&s); 5953 else 5954 { 5955 log->PutCString ("Process::RunThreadPlan(): Stop event that interrupted us is NULL."); 5956 } 5957 5958 StreamString ts; 5959 5960 const char *event_explanation = nullptr; 5961 5962 do 5963 { 5964 if (!event_sp) 5965 { 5966 event_explanation = "<no event>"; 5967 break; 5968 } 5969 else if (event_sp->GetType() == eBroadcastBitInterrupt) 5970 { 5971 event_explanation = "<user interrupt>"; 5972 break; 5973 } 5974 else 5975 { 5976 const Process::ProcessEventData *event_data = Process::ProcessEventData::GetEventDataFromEvent (event_sp.get()); 5977 5978 if (!event_data) 5979 { 5980 event_explanation = "<no event data>"; 5981 break; 5982 } 5983 5984 Process *process = event_data->GetProcessSP().get(); 5985 5986 if (!process) 5987 { 5988 event_explanation = "<no process>"; 5989 break; 5990 } 5991 5992 ThreadList &thread_list = process->GetThreadList(); 5993 5994 uint32_t num_threads = thread_list.GetSize(); 5995 uint32_t thread_index; 5996 5997 ts.Printf("<%u threads> ", num_threads); 5998 5999 for (thread_index = 0; 6000 thread_index < num_threads; 6001 ++thread_index) 6002 { 6003 Thread *thread = thread_list.GetThreadAtIndex(thread_index).get(); 6004 6005 if (!thread) 6006 { 6007 ts.Printf("<?> "); 6008 continue; 6009 } 6010 6011 ts.Printf("<0x%4.4" PRIx64 " ", thread->GetID()); 6012 RegisterContext *register_context = thread->GetRegisterContext().get(); 6013 6014 if (register_context) 6015 ts.Printf("[ip 0x%" PRIx64 "] ", register_context->GetPC()); 6016 else 6017 ts.Printf("[ip unknown] "); 6018 6019 // Show the private stop info here, the public stop info will be from the last natural stop. 6020 lldb::StopInfoSP stop_info_sp = thread->GetPrivateStopInfo(); 6021 if (stop_info_sp) 6022 { 6023 const char *stop_desc = stop_info_sp->GetDescription(); 6024 if (stop_desc) 6025 ts.PutCString (stop_desc); 6026 } 6027 ts.Printf(">"); 6028 } 6029 6030 event_explanation = ts.GetData(); 6031 } 6032 } while (0); 6033 6034 if (event_explanation) 6035 log->Printf("Process::RunThreadPlan(): execution interrupted: %s %s", s.GetData(), event_explanation); 6036 else 6037 log->Printf("Process::RunThreadPlan(): execution interrupted: %s", s.GetData()); 6038 } 6039 6040 if (should_unwind) 6041 { 6042 if (log) 6043 log->Printf ("Process::RunThreadPlan: ExecutionInterrupted - discarding thread plans up to %p.", 6044 static_cast<void*>(thread_plan_sp.get())); 6045 thread->DiscardThreadPlansUpToPlan (thread_plan_sp); 6046 } 6047 else 6048 { 6049 if (log) 6050 log->Printf ("Process::RunThreadPlan: ExecutionInterrupted - for plan: %p not discarding.", 6051 static_cast<void*>(thread_plan_sp.get())); 6052 } 6053 } 6054 else if (return_value == eExpressionSetupError) 6055 { 6056 if (log) 6057 log->PutCString("Process::RunThreadPlan(): execution set up error."); 6058 6059 if (options.DoesUnwindOnError()) 6060 { 6061 thread->DiscardThreadPlansUpToPlan (thread_plan_sp); 6062 } 6063 } 6064 else 6065 { 6066 if (thread->IsThreadPlanDone (thread_plan_sp.get())) 6067 { 6068 if (log) 6069 log->PutCString("Process::RunThreadPlan(): thread plan is done"); 6070 return_value = eExpressionCompleted; 6071 } 6072 else if (thread->WasThreadPlanDiscarded (thread_plan_sp.get())) 6073 { 6074 if (log) 6075 log->PutCString("Process::RunThreadPlan(): thread plan was discarded"); 6076 return_value = eExpressionDiscarded; 6077 } 6078 else 6079 { 6080 if (log) 6081 log->PutCString("Process::RunThreadPlan(): thread plan stopped in mid course"); 6082 if (options.DoesUnwindOnError() && thread_plan_sp) 6083 { 6084 if (log) 6085 log->PutCString("Process::RunThreadPlan(): discarding thread plan 'cause unwind_on_error is set."); 6086 thread->DiscardThreadPlansUpToPlan (thread_plan_sp); 6087 } 6088 } 6089 } 6090 6091 // Thread we ran the function in may have gone away because we ran the target 6092 // Check that it's still there, and if it is put it back in the context. Also restore the 6093 // frame in the context if it is still present. 6094 thread = GetThreadList().FindThreadByIndexID(thread_idx_id, true).get(); 6095 if (thread) 6096 { 6097 exe_ctx.SetFrameSP (thread->GetFrameWithStackID (ctx_frame_id)); 6098 } 6099 6100 // Also restore the current process'es selected frame & thread, since this function calling may 6101 // be done behind the user's back. 6102 6103 if (selected_tid != LLDB_INVALID_THREAD_ID) 6104 { 6105 if (GetThreadList().SetSelectedThreadByIndexID (selected_tid) && selected_stack_id.IsValid()) 6106 { 6107 // We were able to restore the selected thread, now restore the frame: 6108 Mutex::Locker lock(GetThreadList().GetMutex()); 6109 StackFrameSP old_frame_sp = GetThreadList().GetSelectedThread()->GetFrameWithStackID(selected_stack_id); 6110 if (old_frame_sp) 6111 GetThreadList().GetSelectedThread()->SetSelectedFrame(old_frame_sp.get()); 6112 } 6113 } 6114 } 6115 6116 // If the process exited during the run of the thread plan, notify everyone. 6117 6118 if (event_to_broadcast_sp) 6119 { 6120 if (log) 6121 log->PutCString("Process::RunThreadPlan(): rebroadcasting event."); 6122 BroadcastEvent(event_to_broadcast_sp); 6123 } 6124 6125 return return_value; 6126 } 6127 6128 const char * 6129 Process::ExecutionResultAsCString (ExpressionResults result) 6130 { 6131 const char *result_name; 6132 6133 switch (result) 6134 { 6135 case eExpressionCompleted: 6136 result_name = "eExpressionCompleted"; 6137 break; 6138 case eExpressionDiscarded: 6139 result_name = "eExpressionDiscarded"; 6140 break; 6141 case eExpressionInterrupted: 6142 result_name = "eExpressionInterrupted"; 6143 break; 6144 case eExpressionHitBreakpoint: 6145 result_name = "eExpressionHitBreakpoint"; 6146 break; 6147 case eExpressionSetupError: 6148 result_name = "eExpressionSetupError"; 6149 break; 6150 case eExpressionParseError: 6151 result_name = "eExpressionParseError"; 6152 break; 6153 case eExpressionResultUnavailable: 6154 result_name = "eExpressionResultUnavailable"; 6155 break; 6156 case eExpressionTimedOut: 6157 result_name = "eExpressionTimedOut"; 6158 break; 6159 case eExpressionStoppedForDebug: 6160 result_name = "eExpressionStoppedForDebug"; 6161 break; 6162 } 6163 return result_name; 6164 } 6165 6166 void 6167 Process::GetStatus (Stream &strm) 6168 { 6169 const StateType state = GetState(); 6170 if (StateIsStoppedState(state, false)) 6171 { 6172 if (state == eStateExited) 6173 { 6174 int exit_status = GetExitStatus(); 6175 const char *exit_description = GetExitDescription(); 6176 strm.Printf ("Process %" PRIu64 " exited with status = %i (0x%8.8x) %s\n", 6177 GetID(), 6178 exit_status, 6179 exit_status, 6180 exit_description ? exit_description : ""); 6181 } 6182 else 6183 { 6184 if (state == eStateConnected) 6185 strm.Printf ("Connected to remote target.\n"); 6186 else 6187 strm.Printf ("Process %" PRIu64 " %s\n", GetID(), StateAsCString (state)); 6188 } 6189 } 6190 else 6191 { 6192 strm.Printf ("Process %" PRIu64 " is running.\n", GetID()); 6193 } 6194 } 6195 6196 size_t 6197 Process::GetThreadStatus (Stream &strm, 6198 bool only_threads_with_stop_reason, 6199 uint32_t start_frame, 6200 uint32_t num_frames, 6201 uint32_t num_frames_with_source) 6202 { 6203 size_t num_thread_infos_dumped = 0; 6204 6205 // You can't hold the thread list lock while calling Thread::GetStatus. That very well might run code (e.g. if we need it 6206 // to get return values or arguments.) For that to work the process has to be able to acquire it. So instead copy the thread 6207 // ID's, and look them up one by one: 6208 6209 uint32_t num_threads; 6210 std::vector<lldb::tid_t> thread_id_array; 6211 //Scope for thread list locker; 6212 { 6213 Mutex::Locker locker (GetThreadList().GetMutex()); 6214 ThreadList &curr_thread_list = GetThreadList(); 6215 num_threads = curr_thread_list.GetSize(); 6216 uint32_t idx; 6217 thread_id_array.resize(num_threads); 6218 for (idx = 0; idx < num_threads; ++idx) 6219 thread_id_array[idx] = curr_thread_list.GetThreadAtIndex(idx)->GetID(); 6220 } 6221 6222 for (uint32_t i = 0; i < num_threads; i++) 6223 { 6224 ThreadSP thread_sp(GetThreadList().FindThreadByID(thread_id_array[i])); 6225 if (thread_sp) 6226 { 6227 if (only_threads_with_stop_reason) 6228 { 6229 StopInfoSP stop_info_sp = thread_sp->GetStopInfo(); 6230 if (!stop_info_sp || !stop_info_sp->IsValid()) 6231 continue; 6232 } 6233 thread_sp->GetStatus (strm, 6234 start_frame, 6235 num_frames, 6236 num_frames_with_source); 6237 ++num_thread_infos_dumped; 6238 } 6239 else 6240 { 6241 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_PROCESS)); 6242 if (log) 6243 log->Printf("Process::GetThreadStatus - thread 0x" PRIu64 " vanished while running Thread::GetStatus."); 6244 } 6245 } 6246 return num_thread_infos_dumped; 6247 } 6248 6249 void 6250 Process::AddInvalidMemoryRegion (const LoadRange ®ion) 6251 { 6252 m_memory_cache.AddInvalidRange(region.GetRangeBase(), region.GetByteSize()); 6253 } 6254 6255 bool 6256 Process::RemoveInvalidMemoryRange (const LoadRange ®ion) 6257 { 6258 return m_memory_cache.RemoveInvalidRange(region.GetRangeBase(), region.GetByteSize()); 6259 } 6260 6261 void 6262 Process::AddPreResumeAction (PreResumeActionCallback callback, void *baton) 6263 { 6264 m_pre_resume_actions.push_back(PreResumeCallbackAndBaton (callback, baton)); 6265 } 6266 6267 bool 6268 Process::RunPreResumeActions () 6269 { 6270 bool result = true; 6271 while (!m_pre_resume_actions.empty()) 6272 { 6273 struct PreResumeCallbackAndBaton action = m_pre_resume_actions.back(); 6274 m_pre_resume_actions.pop_back(); 6275 bool this_result = action.callback (action.baton); 6276 if (result) 6277 result = this_result; 6278 } 6279 return result; 6280 } 6281 6282 void 6283 Process::ClearPreResumeActions () 6284 { 6285 m_pre_resume_actions.clear(); 6286 } 6287 6288 ProcessRunLock & 6289 Process::GetRunLock() 6290 { 6291 if (m_private_state_thread.EqualsThread(Host::GetCurrentThread())) 6292 return m_private_run_lock; 6293 else 6294 return m_public_run_lock; 6295 } 6296 6297 void 6298 Process::Flush () 6299 { 6300 m_thread_list.Flush(); 6301 m_extended_thread_list.Flush(); 6302 m_extended_thread_stop_id = 0; 6303 m_queue_list.Clear(); 6304 m_queue_list_stop_id = 0; 6305 } 6306 6307 void 6308 Process::DidExec () 6309 { 6310 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS)); 6311 if (log) 6312 log->Printf ("Process::%s()", __FUNCTION__); 6313 6314 Target &target = GetTarget(); 6315 target.CleanupProcess (); 6316 target.ClearModules(false); 6317 m_dynamic_checkers_ap.reset(); 6318 m_abi_sp.reset(); 6319 m_system_runtime_ap.reset(); 6320 m_os_ap.reset(); 6321 m_dyld_ap.reset(); 6322 m_jit_loaders_ap.reset(); 6323 m_image_tokens.clear(); 6324 m_allocated_memory_cache.Clear(); 6325 m_language_runtimes.clear(); 6326 m_instrumentation_runtimes.clear(); 6327 m_thread_list.DiscardThreadPlans(); 6328 m_memory_cache.Clear(true); 6329 m_stop_info_override_callback = nullptr; 6330 DoDidExec(); 6331 CompleteAttach (); 6332 // Flush the process (threads and all stack frames) after running CompleteAttach() 6333 // in case the dynamic loader loaded things in new locations. 6334 Flush(); 6335 6336 // After we figure out what was loaded/unloaded in CompleteAttach, 6337 // we need to let the target know so it can do any cleanup it needs to. 6338 target.DidExec(); 6339 } 6340 6341 addr_t 6342 Process::ResolveIndirectFunction(const Address *address, Error &error) 6343 { 6344 if (address == nullptr) 6345 { 6346 error.SetErrorString("Invalid address argument"); 6347 return LLDB_INVALID_ADDRESS; 6348 } 6349 6350 addr_t function_addr = LLDB_INVALID_ADDRESS; 6351 6352 addr_t addr = address->GetLoadAddress(&GetTarget()); 6353 std::map<addr_t,addr_t>::const_iterator iter = m_resolved_indirect_addresses.find(addr); 6354 if (iter != m_resolved_indirect_addresses.end()) 6355 { 6356 function_addr = (*iter).second; 6357 } 6358 else 6359 { 6360 if (!InferiorCall(this, address, function_addr)) 6361 { 6362 Symbol *symbol = address->CalculateSymbolContextSymbol(); 6363 error.SetErrorStringWithFormat ("Unable to call resolver for indirect function %s", 6364 symbol ? symbol->GetName().AsCString() : "<UNKNOWN>"); 6365 function_addr = LLDB_INVALID_ADDRESS; 6366 } 6367 else 6368 { 6369 m_resolved_indirect_addresses.insert(std::pair<addr_t, addr_t>(addr, function_addr)); 6370 } 6371 } 6372 return function_addr; 6373 } 6374 6375 void 6376 Process::ModulesDidLoad (ModuleList &module_list) 6377 { 6378 SystemRuntime *sys_runtime = GetSystemRuntime(); 6379 if (sys_runtime) 6380 { 6381 sys_runtime->ModulesDidLoad (module_list); 6382 } 6383 6384 GetJITLoaders().ModulesDidLoad (module_list); 6385 6386 // Give runtimes a chance to be created. 6387 InstrumentationRuntime::ModulesDidLoad(module_list, this, m_instrumentation_runtimes); 6388 6389 // Tell runtimes about new modules. 6390 for (auto pos = m_instrumentation_runtimes.begin(); pos != m_instrumentation_runtimes.end(); ++pos) 6391 { 6392 InstrumentationRuntimeSP runtime = pos->second; 6393 runtime->ModulesDidLoad(module_list); 6394 } 6395 6396 // Let any language runtimes we have already created know 6397 // about the modules that loaded. 6398 6399 // Iterate over a copy of this language runtime list in case 6400 // the language runtime ModulesDidLoad somehow causes the language 6401 // riuntime to be unloaded. 6402 LanguageRuntimeCollection language_runtimes(m_language_runtimes); 6403 for (const auto &pair: language_runtimes) 6404 { 6405 // We must check language_runtime_sp to make sure it is not 6406 // nullptr as we might cache the fact that we didn't have a 6407 // language runtime for a language. 6408 LanguageRuntimeSP language_runtime_sp = pair.second; 6409 if (language_runtime_sp) 6410 language_runtime_sp->ModulesDidLoad(module_list); 6411 } 6412 6413 LoadOperatingSystemPlugin(false); 6414 } 6415 6416 void 6417 Process::PrintWarning (uint64_t warning_type, const void *repeat_key, const char *fmt, ...) 6418 { 6419 bool print_warning = true; 6420 6421 StreamSP stream_sp = GetTarget().GetDebugger().GetAsyncOutputStream(); 6422 if (!stream_sp) 6423 return; 6424 if (warning_type == eWarningsOptimization 6425 && !GetWarningsOptimization()) 6426 { 6427 return; 6428 } 6429 6430 if (repeat_key != nullptr) 6431 { 6432 WarningsCollection::iterator it = m_warnings_issued.find (warning_type); 6433 if (it == m_warnings_issued.end()) 6434 { 6435 m_warnings_issued[warning_type] = WarningsPointerSet(); 6436 m_warnings_issued[warning_type].insert (repeat_key); 6437 } 6438 else 6439 { 6440 if (it->second.find (repeat_key) != it->second.end()) 6441 { 6442 print_warning = false; 6443 } 6444 else 6445 { 6446 it->second.insert (repeat_key); 6447 } 6448 } 6449 } 6450 6451 if (print_warning) 6452 { 6453 va_list args; 6454 va_start (args, fmt); 6455 stream_sp->PrintfVarArg (fmt, args); 6456 va_end (args); 6457 } 6458 } 6459 6460 void 6461 Process::PrintWarningOptimization (const SymbolContext &sc) 6462 { 6463 if (GetWarningsOptimization() 6464 && sc.module_sp 6465 && !sc.module_sp->GetFileSpec().GetFilename().IsEmpty() 6466 && sc.function 6467 && sc.function->GetIsOptimized()) 6468 { 6469 PrintWarning (Process::Warnings::eWarningsOptimization, sc.module_sp.get(), "%s was compiled with optimization - stepping may behave oddly; variables may not be available.\n", sc.module_sp->GetFileSpec().GetFilename().GetCString()); 6470 } 6471 } 6472 6473 ThreadCollectionSP 6474 Process::GetHistoryThreads(lldb::addr_t addr) 6475 { 6476 ThreadCollectionSP threads; 6477 6478 const MemoryHistorySP &memory_history = MemoryHistory::FindPlugin(shared_from_this()); 6479 6480 if (!memory_history) { 6481 return threads; 6482 } 6483 6484 threads.reset(new ThreadCollection(memory_history->GetHistoryThreads(addr))); 6485 6486 return threads; 6487 } 6488 6489 InstrumentationRuntimeSP 6490 Process::GetInstrumentationRuntime(lldb::InstrumentationRuntimeType type) 6491 { 6492 InstrumentationRuntimeCollection::iterator pos; 6493 pos = m_instrumentation_runtimes.find (type); 6494 if (pos == m_instrumentation_runtimes.end()) 6495 { 6496 return InstrumentationRuntimeSP(); 6497 } 6498 else 6499 return (*pos).second; 6500 } 6501 6502 bool 6503 Process::GetModuleSpec(const FileSpec& module_file_spec, 6504 const ArchSpec& arch, 6505 ModuleSpec& module_spec) 6506 { 6507 module_spec.Clear(); 6508 return false; 6509 } 6510 6511 size_t 6512 Process::AddImageToken(lldb::addr_t image_ptr) 6513 { 6514 m_image_tokens.push_back(image_ptr); 6515 return m_image_tokens.size() - 1; 6516 } 6517 6518 lldb::addr_t 6519 Process::GetImagePtrFromToken(size_t token) const 6520 { 6521 if (token < m_image_tokens.size()) 6522 return m_image_tokens[token]; 6523 return LLDB_INVALID_IMAGE_TOKEN; 6524 } 6525 6526 void 6527 Process::ResetImageToken(size_t token) 6528 { 6529 if (token < m_image_tokens.size()) 6530 m_image_tokens[token] = LLDB_INVALID_IMAGE_TOKEN; 6531 } 6532 6533 Address 6534 Process::AdvanceAddressToNextBranchInstruction (Address default_stop_addr, AddressRange range_bounds) 6535 { 6536 Target &target = GetTarget(); 6537 DisassemblerSP disassembler_sp; 6538 InstructionList *insn_list = nullptr; 6539 6540 Address retval = default_stop_addr; 6541 6542 if (!target.GetUseFastStepping()) 6543 return retval; 6544 if (!default_stop_addr.IsValid()) 6545 return retval; 6546 6547 ExecutionContext exe_ctx (this); 6548 const char *plugin_name = nullptr; 6549 const char *flavor = nullptr; 6550 const bool prefer_file_cache = true; 6551 disassembler_sp = Disassembler::DisassembleRange(target.GetArchitecture(), 6552 plugin_name, 6553 flavor, 6554 exe_ctx, 6555 range_bounds, 6556 prefer_file_cache); 6557 if (disassembler_sp) 6558 insn_list = &disassembler_sp->GetInstructionList(); 6559 6560 if (insn_list == nullptr) 6561 { 6562 return retval; 6563 } 6564 6565 size_t insn_offset = insn_list->GetIndexOfInstructionAtAddress (default_stop_addr); 6566 if (insn_offset == UINT32_MAX) 6567 { 6568 return retval; 6569 } 6570 6571 uint32_t branch_index = insn_list->GetIndexOfNextBranchInstruction (insn_offset, target); 6572 if (branch_index == UINT32_MAX) 6573 { 6574 return retval; 6575 } 6576 6577 if (branch_index > insn_offset) 6578 { 6579 Address next_branch_insn_address = insn_list->GetInstructionAtIndex (branch_index)->GetAddress(); 6580 if (next_branch_insn_address.IsValid() && range_bounds.ContainsFileAddress (next_branch_insn_address)) 6581 { 6582 retval = next_branch_insn_address; 6583 } 6584 } 6585 6586 if (disassembler_sp) 6587 { 6588 // FIXME: The DisassemblerLLVMC has a reference cycle and won't go away if it has any active instructions. 6589 disassembler_sp->GetInstructionList().Clear(); 6590 } 6591 6592 return retval; 6593 } 6594