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