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