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