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