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