1 //===-- Process.cpp ---------------------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
12 // Other libraries and framework includes
14 #include "lldb/Target/Process.h"
15 #include "lldb/Breakpoint/StoppointCallbackContext.h"
16 #include "lldb/Breakpoint/BreakpointLocation.h"
17 #include "lldb/Core/Event.h"
18 #include "lldb/Core/Debugger.h"
19 #include "lldb/Core/Log.h"
20 #include "lldb/Core/Module.h"
21 #include "lldb/Core/ModuleSpec.h"
22 #include "lldb/Core/PluginManager.h"
23 #include "lldb/Core/State.h"
24 #include "lldb/Core/StreamFile.h"
25 #include "lldb/Expression/UserExpression.h"
26 #include "lldb/Expression/IRDynamicChecks.h"
27 #include "lldb/Host/ConnectionFileDescriptor.h"
28 #include "lldb/Host/FileSystem.h"
29 #include "lldb/Host/Host.h"
30 #include "lldb/Host/HostInfo.h"
31 #include "lldb/Host/Pipe.h"
32 #include "lldb/Host/Terminal.h"
33 #include "lldb/Host/ThreadLauncher.h"
34 #include "lldb/Interpreter/CommandInterpreter.h"
35 #include "lldb/Interpreter/OptionValueProperties.h"
36 #include "lldb/Symbol/Function.h"
37 #include "lldb/Symbol/Symbol.h"
38 #include "lldb/Target/ABI.h"
39 #include "lldb/Target/DynamicLoader.h"
40 #include "lldb/Target/InstrumentationRuntime.h"
41 #include "lldb/Target/JITLoader.h"
42 #include "lldb/Target/JITLoaderList.h"
43 #include "lldb/Target/MemoryHistory.h"
44 #include "lldb/Target/MemoryRegionInfo.h"
45 #include "lldb/Target/OperatingSystem.h"
46 #include "lldb/Target/LanguageRuntime.h"
47 #include "lldb/Target/CPPLanguageRuntime.h"
48 #include "lldb/Target/ObjCLanguageRuntime.h"
49 #include "lldb/Target/Platform.h"
50 #include "lldb/Target/RegisterContext.h"
51 #include "lldb/Target/StopInfo.h"
52 #include "lldb/Target/SystemRuntime.h"
53 #include "lldb/Target/Target.h"
54 #include "lldb/Target/TargetList.h"
55 #include "lldb/Target/Thread.h"
56 #include "lldb/Target/ThreadPlan.h"
57 #include "lldb/Target/ThreadPlanBase.h"
58 #include "lldb/Target/UnixSignals.h"
59 #include "lldb/Utility/NameMatches.h"
60 #include "Plugins/Process/Utility/InferiorCallPOSIX.h"
63 using namespace lldb_private;
65 // Comment out line below to disable memory caching, overriding the process setting
66 // target.process.disable-memory-cache
67 #define ENABLE_MEMORY_CACHING
69 #ifdef ENABLE_MEMORY_CACHING
70 #define DISABLE_MEM_CACHE_DEFAULT false
72 #define DISABLE_MEM_CACHE_DEFAULT true
75 class ProcessOptionValueProperties : public OptionValueProperties
78 ProcessOptionValueProperties (const ConstString &name) :
79 OptionValueProperties (name)
83 // This constructor is used when creating ProcessOptionValueProperties when it
84 // is part of a new lldb_private::Process instance. It will copy all current
85 // global property values as needed
86 ProcessOptionValueProperties (ProcessProperties *global_properties) :
87 OptionValueProperties(*global_properties->GetValueProperties())
92 GetPropertyAtIndex(const ExecutionContext *exe_ctx, bool will_modify, uint32_t idx) const override
94 // When getting the value for a key from the process options, we will always
95 // try and grab the setting from the current process if there is one. Else we just
96 // use the one from this instance.
99 Process *process = exe_ctx->GetProcessPtr();
102 ProcessOptionValueProperties *instance_properties = static_cast<ProcessOptionValueProperties *>(process->GetValueProperties().get());
103 if (this != instance_properties)
104 return instance_properties->ProtectedGetPropertyAtIndex (idx);
107 return ProtectedGetPropertyAtIndex (idx);
111 static PropertyDefinition
114 { "disable-memory-cache" , OptionValue::eTypeBoolean, false, DISABLE_MEM_CACHE_DEFAULT, NULL, NULL, "Disable reading and caching of memory in fixed-size units." },
115 { "extra-startup-command", OptionValue::eTypeArray , false, OptionValue::eTypeString, NULL, NULL, "A list containing extra commands understood by the particular process plugin used. "
116 "For instance, to turn on debugserver logging set this to \"QSetLogging:bitmask=LOG_DEFAULT;\"" },
117 { "ignore-breakpoints-in-expressions", OptionValue::eTypeBoolean, true, true, NULL, NULL, "If true, breakpoints will be ignored during expression evaluation." },
118 { "unwind-on-error-in-expressions", OptionValue::eTypeBoolean, true, true, NULL, NULL, "If true, errors in expression evaluation will unwind the stack back to the state before the call." },
119 { "python-os-plugin-path", OptionValue::eTypeFileSpec, false, true, NULL, NULL, "A path to a python OS plug-in module file that contains a OperatingSystemPlugIn class." },
120 { "stop-on-sharedlibrary-events" , OptionValue::eTypeBoolean, true, false, NULL, NULL, "If true, stop when a shared library is loaded or unloaded." },
121 { "detach-keeps-stopped" , OptionValue::eTypeBoolean, true, false, NULL, NULL, "If true, detach will attempt to keep the process stopped." },
122 { "memory-cache-line-size" , OptionValue::eTypeUInt64, false, 512, NULL, NULL, "The memory cache line size" },
123 { "optimization-warnings" , OptionValue::eTypeBoolean, false, true, NULL, NULL, "If true, warn when stopped in code that is optimized where stepping and variable availability may not behave as expected." },
124 { NULL , OptionValue::eTypeInvalid, false, 0, NULL, NULL, NULL }
128 ePropertyDisableMemCache,
129 ePropertyExtraStartCommand,
130 ePropertyIgnoreBreakpointsInExpressions,
131 ePropertyUnwindOnErrorInExpressions,
132 ePropertyPythonOSPluginPath,
133 ePropertyStopOnSharedLibraryEvents,
134 ePropertyDetachKeepsStopped,
135 ePropertyMemCacheLineSize,
136 ePropertyWarningOptimization
139 ProcessProperties::ProcessProperties (lldb_private::Process *process) :
141 m_process (process) // Can be NULL for global ProcessProperties
145 // Global process properties, set them up one time
146 m_collection_sp.reset (new ProcessOptionValueProperties(ConstString("process")));
147 m_collection_sp->Initialize(g_properties);
148 m_collection_sp->AppendProperty(ConstString("thread"),
149 ConstString("Settings specific to threads."),
151 Thread::GetGlobalProperties()->GetValueProperties());
155 m_collection_sp.reset (new ProcessOptionValueProperties(Process::GetGlobalProperties().get()));
156 m_collection_sp->SetValueChangedCallback(ePropertyPythonOSPluginPath, ProcessProperties::OptionValueChangedCallback, this);
160 ProcessProperties::~ProcessProperties() = default;
163 ProcessProperties::OptionValueChangedCallback (void *baton, OptionValue *option_value)
165 ProcessProperties *properties = (ProcessProperties *)baton;
166 if (properties->m_process)
167 properties->m_process->LoadOperatingSystemPlugin(true);
171 ProcessProperties::GetDisableMemoryCache() const
173 const uint32_t idx = ePropertyDisableMemCache;
174 return m_collection_sp->GetPropertyAtIndexAsBoolean (NULL, idx, g_properties[idx].default_uint_value != 0);
178 ProcessProperties::GetMemoryCacheLineSize() const
180 const uint32_t idx = ePropertyMemCacheLineSize;
181 return m_collection_sp->GetPropertyAtIndexAsUInt64 (NULL, idx, g_properties[idx].default_uint_value);
185 ProcessProperties::GetExtraStartupCommands () const
188 const uint32_t idx = ePropertyExtraStartCommand;
189 m_collection_sp->GetPropertyAtIndexAsArgs(NULL, idx, args);
194 ProcessProperties::SetExtraStartupCommands (const Args &args)
196 const uint32_t idx = ePropertyExtraStartCommand;
197 m_collection_sp->SetPropertyAtIndexFromArgs(NULL, idx, args);
201 ProcessProperties::GetPythonOSPluginPath () const
203 const uint32_t idx = ePropertyPythonOSPluginPath;
204 return m_collection_sp->GetPropertyAtIndexAsFileSpec(NULL, idx);
208 ProcessProperties::SetPythonOSPluginPath (const FileSpec &file)
210 const uint32_t idx = ePropertyPythonOSPluginPath;
211 m_collection_sp->SetPropertyAtIndexAsFileSpec(NULL, idx, file);
215 ProcessProperties::GetIgnoreBreakpointsInExpressions () const
217 const uint32_t idx = ePropertyIgnoreBreakpointsInExpressions;
218 return m_collection_sp->GetPropertyAtIndexAsBoolean(NULL, idx, g_properties[idx].default_uint_value != 0);
222 ProcessProperties::SetIgnoreBreakpointsInExpressions (bool ignore)
224 const uint32_t idx = ePropertyIgnoreBreakpointsInExpressions;
225 m_collection_sp->SetPropertyAtIndexAsBoolean(NULL, idx, ignore);
229 ProcessProperties::GetUnwindOnErrorInExpressions () const
231 const uint32_t idx = ePropertyUnwindOnErrorInExpressions;
232 return m_collection_sp->GetPropertyAtIndexAsBoolean(NULL, idx, g_properties[idx].default_uint_value != 0);
236 ProcessProperties::SetUnwindOnErrorInExpressions (bool ignore)
238 const uint32_t idx = ePropertyUnwindOnErrorInExpressions;
239 m_collection_sp->SetPropertyAtIndexAsBoolean(NULL, idx, ignore);
243 ProcessProperties::GetStopOnSharedLibraryEvents () const
245 const uint32_t idx = ePropertyStopOnSharedLibraryEvents;
246 return m_collection_sp->GetPropertyAtIndexAsBoolean(NULL, idx, g_properties[idx].default_uint_value != 0);
250 ProcessProperties::SetStopOnSharedLibraryEvents (bool stop)
252 const uint32_t idx = ePropertyStopOnSharedLibraryEvents;
253 m_collection_sp->SetPropertyAtIndexAsBoolean(NULL, idx, stop);
257 ProcessProperties::GetDetachKeepsStopped () const
259 const uint32_t idx = ePropertyDetachKeepsStopped;
260 return m_collection_sp->GetPropertyAtIndexAsBoolean(NULL, idx, g_properties[idx].default_uint_value != 0);
264 ProcessProperties::SetDetachKeepsStopped (bool stop)
266 const uint32_t idx = ePropertyDetachKeepsStopped;
267 m_collection_sp->SetPropertyAtIndexAsBoolean(NULL, idx, stop);
271 ProcessProperties::GetWarningsOptimization () const
273 const uint32_t idx = ePropertyWarningOptimization;
274 return m_collection_sp->GetPropertyAtIndexAsBoolean (NULL, idx, g_properties[idx].default_uint_value != 0);
278 ProcessInstanceInfo::Dump (Stream &s, Platform *platform) const
281 if (m_pid != LLDB_INVALID_PROCESS_ID)
282 s.Printf (" pid = %" PRIu64 "\n", m_pid);
284 if (m_parent_pid != LLDB_INVALID_PROCESS_ID)
285 s.Printf (" parent = %" PRIu64 "\n", m_parent_pid);
289 s.Printf (" name = %s\n", m_executable.GetFilename().GetCString());
290 s.PutCString (" file = ");
291 m_executable.Dump(&s);
294 const uint32_t argc = m_arguments.GetArgumentCount();
297 for (uint32_t i=0; i<argc; i++)
299 const char *arg = m_arguments.GetArgumentAtIndex(i);
301 s.Printf (" arg[%u] = %s\n", i, arg);
303 s.Printf ("arg[%u] = %s\n", i, arg);
307 const uint32_t envc = m_environment.GetArgumentCount();
310 for (uint32_t i=0; i<envc; i++)
312 const char *env = m_environment.GetArgumentAtIndex(i);
314 s.Printf (" env[%u] = %s\n", i, env);
316 s.Printf ("env[%u] = %s\n", i, env);
320 if (m_arch.IsValid())
322 s.Printf (" arch = ");
323 m_arch.DumpTriple(s);
327 if (m_uid != UINT32_MAX)
329 cstr = platform->GetUserName (m_uid);
330 s.Printf (" uid = %-5u (%s)\n", m_uid, cstr ? cstr : "");
332 if (m_gid != UINT32_MAX)
334 cstr = platform->GetGroupName (m_gid);
335 s.Printf (" gid = %-5u (%s)\n", m_gid, cstr ? cstr : "");
337 if (m_euid != UINT32_MAX)
339 cstr = platform->GetUserName (m_euid);
340 s.Printf (" euid = %-5u (%s)\n", m_euid, cstr ? cstr : "");
342 if (m_egid != UINT32_MAX)
344 cstr = platform->GetGroupName (m_egid);
345 s.Printf (" egid = %-5u (%s)\n", m_egid, cstr ? cstr : "");
350 ProcessInstanceInfo::DumpTableHeader (Stream &s, Platform *platform, bool show_args, bool verbose)
353 if (show_args || verbose)
360 s.Printf ("PID PARENT USER GROUP EFF USER EFF GROUP TRIPLE %s\n", label);
361 s.PutCString ("====== ====== ========== ========== ========== ========== ======================== ============================\n");
365 s.Printf ("PID PARENT USER TRIPLE %s\n", label);
366 s.PutCString ("====== ====== ========== ======================== ============================\n");
371 ProcessInstanceInfo::DumpAsTableRow (Stream &s, Platform *platform, bool show_args, bool verbose) const
373 if (m_pid != LLDB_INVALID_PROCESS_ID)
376 s.Printf ("%-6" PRIu64 " %-6" PRIu64 " ", m_pid, m_parent_pid);
378 StreamString arch_strm;
379 if (m_arch.IsValid())
380 m_arch.DumpTriple(arch_strm);
384 cstr = platform->GetUserName (m_uid);
385 if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
386 s.Printf ("%-10s ", cstr);
388 s.Printf ("%-10u ", m_uid);
390 cstr = platform->GetGroupName (m_gid);
391 if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
392 s.Printf ("%-10s ", cstr);
394 s.Printf ("%-10u ", m_gid);
396 cstr = platform->GetUserName (m_euid);
397 if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
398 s.Printf ("%-10s ", cstr);
400 s.Printf ("%-10u ", m_euid);
402 cstr = platform->GetGroupName (m_egid);
403 if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
404 s.Printf ("%-10s ", cstr);
406 s.Printf ("%-10u ", m_egid);
408 s.Printf ("%-24s ", arch_strm.GetString().c_str());
412 s.Printf ("%-10s %-24s ",
413 platform->GetUserName (m_euid),
414 arch_strm.GetString().c_str());
417 if (verbose || show_args)
419 const uint32_t argc = m_arguments.GetArgumentCount();
422 for (uint32_t i=0; i<argc; i++)
426 s.PutCString (m_arguments.GetArgumentAtIndex(i));
432 s.PutCString (GetName());
440 ProcessLaunchCommandOptions::SetOptionValue (uint32_t option_idx, const char *option_arg)
443 const int short_option = m_getopt_table[option_idx].val;
445 switch (short_option)
447 case 's': // Stop at program entry point
448 launch_info.GetFlags().Set (eLaunchFlagStopAtEntry);
451 case 'i': // STDIN for read only
454 if (action.Open(STDIN_FILENO, FileSpec{option_arg, false}, true, false))
455 launch_info.AppendFileAction (action);
459 case 'o': // Open STDOUT for write only
462 if (action.Open(STDOUT_FILENO, FileSpec{option_arg, false}, false, true))
463 launch_info.AppendFileAction (action);
467 case 'e': // STDERR for write only
470 if (action.Open(STDERR_FILENO, FileSpec{option_arg, false}, false, true))
471 launch_info.AppendFileAction (action);
475 case 'p': // Process plug-in name
476 launch_info.SetProcessPluginName (option_arg);
479 case 'n': // Disable STDIO
482 const FileSpec dev_null{FileSystem::DEV_NULL, false};
483 if (action.Open(STDIN_FILENO, dev_null, true, false))
484 launch_info.AppendFileAction (action);
485 if (action.Open(STDOUT_FILENO, dev_null, false, true))
486 launch_info.AppendFileAction (action);
487 if (action.Open(STDERR_FILENO, dev_null, false, true))
488 launch_info.AppendFileAction (action);
493 launch_info.SetWorkingDirectory(FileSpec{option_arg, false});
496 case 't': // Open process in new terminal window
497 launch_info.GetFlags().Set (eLaunchFlagLaunchInTTY);
501 if (!launch_info.GetArchitecture().SetTriple (option_arg, m_interpreter.GetPlatform(true).get()))
502 launch_info.GetArchitecture().SetTriple (option_arg);
505 case 'A': // Disable ASLR.
508 const bool disable_aslr_arg = Args::StringToBoolean (option_arg, true, &success);
510 disable_aslr = disable_aslr_arg ? eLazyBoolYes : eLazyBoolNo;
512 error.SetErrorStringWithFormat ("Invalid boolean value for disable-aslr option: '%s'", option_arg ? option_arg : "<null>");
516 case 'X': // shell expand args.
519 const bool expand_args = Args::StringToBoolean (option_arg, true, &success);
521 launch_info.SetShellExpandArguments(expand_args);
523 error.SetErrorStringWithFormat ("Invalid boolean value for shell-expand-args option: '%s'", option_arg ? option_arg : "<null>");
528 if (option_arg && option_arg[0])
529 launch_info.SetShell (FileSpec(option_arg, false));
531 launch_info.SetShell (HostInfo::GetDefaultShell());
535 launch_info.GetEnvironmentEntries().AppendArgument(option_arg);
539 error.SetErrorStringWithFormat("unrecognized short option character '%c'", short_option);
546 ProcessLaunchCommandOptions::g_option_table[] =
548 { LLDB_OPT_SET_ALL, false, "stop-at-entry", 's', OptionParser::eNoArgument, NULL, NULL, 0, eArgTypeNone, "Stop at the entry point of the program when launching a process."},
549 { LLDB_OPT_SET_ALL, false, "disable-aslr", 'A', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypeBoolean, "Set whether to disable address space layout randomization when launching a process."},
550 { LLDB_OPT_SET_ALL, false, "plugin", 'p', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypePlugin, "Name of the process plugin you want to use."},
551 { LLDB_OPT_SET_ALL, false, "working-dir", 'w', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypeDirectoryName, "Set the current working directory to <path> when running the inferior."},
552 { LLDB_OPT_SET_ALL, false, "arch", 'a', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypeArchitecture, "Set the architecture for the process to launch when ambiguous."},
553 { LLDB_OPT_SET_ALL, false, "environment", 'v', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypeNone, "Specify an environment variable name/value string (--environment NAME=VALUE). Can be specified multiple times for subsequent environment entries."},
554 { LLDB_OPT_SET_1|LLDB_OPT_SET_2|LLDB_OPT_SET_3, false, "shell", 'c', OptionParser::eOptionalArgument, NULL, NULL, 0, eArgTypeFilename, "Run the process in a shell (not supported on all platforms)."},
556 { LLDB_OPT_SET_1 , false, "stdin", 'i', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypeFilename, "Redirect stdin for the process to <filename>."},
557 { LLDB_OPT_SET_1 , false, "stdout", 'o', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypeFilename, "Redirect stdout for the process to <filename>."},
558 { LLDB_OPT_SET_1 , false, "stderr", 'e', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypeFilename, "Redirect stderr for the process to <filename>."},
560 { LLDB_OPT_SET_2 , false, "tty", 't', OptionParser::eNoArgument, NULL, NULL, 0, eArgTypeNone, "Start the process in a terminal (not supported on all platforms)."},
562 { LLDB_OPT_SET_3 , false, "no-stdio", 'n', OptionParser::eNoArgument, NULL, NULL, 0, eArgTypeNone, "Do not set up for terminal I/O to go to running process."},
563 { LLDB_OPT_SET_4, false, "shell-expand-args", 'X', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypeBoolean, "Set whether to shell expand arguments to the process when launching."},
564 { 0 , false, NULL, 0, 0, NULL, NULL, 0, eArgTypeNone, NULL }
568 ProcessInstanceInfoMatch::NameMatches (const char *process_name) const
570 if (m_name_match_type == eNameMatchIgnore || process_name == NULL)
572 const char *match_name = m_match_info.GetName();
576 return lldb_private::NameMatches (process_name, m_name_match_type, match_name);
580 ProcessInstanceInfoMatch::Matches (const ProcessInstanceInfo &proc_info) const
582 if (!NameMatches (proc_info.GetName()))
585 if (m_match_info.ProcessIDIsValid() &&
586 m_match_info.GetProcessID() != proc_info.GetProcessID())
589 if (m_match_info.ParentProcessIDIsValid() &&
590 m_match_info.GetParentProcessID() != proc_info.GetParentProcessID())
593 if (m_match_info.UserIDIsValid () &&
594 m_match_info.GetUserID() != proc_info.GetUserID())
597 if (m_match_info.GroupIDIsValid () &&
598 m_match_info.GetGroupID() != proc_info.GetGroupID())
601 if (m_match_info.EffectiveUserIDIsValid () &&
602 m_match_info.GetEffectiveUserID() != proc_info.GetEffectiveUserID())
605 if (m_match_info.EffectiveGroupIDIsValid () &&
606 m_match_info.GetEffectiveGroupID() != proc_info.GetEffectiveGroupID())
609 if (m_match_info.GetArchitecture().IsValid() &&
610 !m_match_info.GetArchitecture().IsCompatibleMatch(proc_info.GetArchitecture()))
616 ProcessInstanceInfoMatch::MatchAllProcesses () const
618 if (m_name_match_type != eNameMatchIgnore)
621 if (m_match_info.ProcessIDIsValid())
624 if (m_match_info.ParentProcessIDIsValid())
627 if (m_match_info.UserIDIsValid ())
630 if (m_match_info.GroupIDIsValid ())
633 if (m_match_info.EffectiveUserIDIsValid ())
636 if (m_match_info.EffectiveGroupIDIsValid ())
639 if (m_match_info.GetArchitecture().IsValid())
642 if (m_match_all_users)
649 ProcessInstanceInfoMatch::Clear()
651 m_match_info.Clear();
652 m_name_match_type = eNameMatchIgnore;
653 m_match_all_users = false;
657 Process::FindPlugin (lldb::TargetSP target_sp, const char *plugin_name, Listener &listener, const FileSpec *crash_file_path)
659 static uint32_t g_process_unique_id = 0;
661 ProcessSP process_sp;
662 ProcessCreateInstance create_callback = NULL;
665 ConstString const_plugin_name(plugin_name);
666 create_callback = PluginManager::GetProcessCreateCallbackForPluginName (const_plugin_name);
669 process_sp = create_callback(target_sp, listener, crash_file_path);
672 if (process_sp->CanDebug(target_sp, true))
674 process_sp->m_process_unique_id = ++g_process_unique_id;
683 for (uint32_t idx = 0; (create_callback = PluginManager::GetProcessCreateCallbackAtIndex(idx)) != NULL; ++idx)
685 process_sp = create_callback(target_sp, listener, crash_file_path);
688 if (process_sp->CanDebug(target_sp, false))
690 process_sp->m_process_unique_id = ++g_process_unique_id;
702 Process::GetStaticBroadcasterClass ()
704 static ConstString class_name ("lldb.process");
708 Process::Process(lldb::TargetSP target_sp, Listener &listener) :
709 Process(target_sp, listener, UnixSignals::Create(HostInfo::GetArchitecture()))
711 // This constructor just delegates to the full Process constructor,
712 // defaulting to using the Host's UnixSignals.
715 Process::Process(lldb::TargetSP target_sp, Listener &listener, const UnixSignalsSP &unix_signals_sp) :
716 ProcessProperties (this),
717 UserID (LLDB_INVALID_PROCESS_ID),
718 Broadcaster (&(target_sp->GetDebugger()), Process::GetStaticBroadcasterClass().AsCString()),
719 m_target_sp (target_sp),
720 m_public_state (eStateUnloaded),
721 m_private_state (eStateUnloaded),
722 m_private_state_broadcaster (NULL, "lldb.process.internal_state_broadcaster"),
723 m_private_state_control_broadcaster (NULL, "lldb.process.internal_state_control_broadcaster"),
724 m_private_state_listener ("lldb.process.internal_state_listener"),
725 m_private_state_control_wait(),
727 m_process_unique_id(0),
728 m_thread_index_id (0),
729 m_thread_id_to_index_id_map (),
732 m_exit_status_mutex(),
733 m_thread_mutex (Mutex::eMutexTypeRecursive),
734 m_thread_list_real (this),
735 m_thread_list (this),
736 m_extended_thread_list (this),
737 m_extended_thread_stop_id (0),
739 m_queue_list_stop_id (0),
742 m_listener (listener),
743 m_breakpoint_site_list (),
744 m_dynamic_checkers_ap (),
745 m_unix_signals_sp (unix_signals_sp),
747 m_process_input_reader (),
748 m_stdio_communication ("process.stdio"),
749 m_stdio_communication_mutex (Mutex::eMutexTypeRecursive),
750 m_stdin_forward (false),
753 m_profile_data_comm_mutex (Mutex::eMutexTypeRecursive),
755 m_iohandler_sync (0),
756 m_memory_cache (*this),
757 m_allocated_memory_cache (*this),
758 m_should_detach (false),
759 m_next_event_action_ap(),
760 m_public_run_lock (),
761 m_private_run_lock (),
762 m_stop_info_override_callback (NULL),
763 m_finalizing (false),
764 m_finalize_called (false),
765 m_clear_thread_plans_on_stop (false),
766 m_force_next_event_delivery (false),
767 m_last_broadcast_state (eStateInvalid),
768 m_destroy_in_process (false),
769 m_can_interpret_function_calls(false),
770 m_warnings_issued (),
771 m_can_jit(eCanJITDontKnow)
773 CheckInWithManager ();
775 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_OBJECT));
777 log->Printf ("%p Process::Process()", static_cast<void*>(this));
779 if (!m_unix_signals_sp)
780 m_unix_signals_sp = std::make_shared<UnixSignals>();
782 SetEventName (eBroadcastBitStateChanged, "state-changed");
783 SetEventName (eBroadcastBitInterrupt, "interrupt");
784 SetEventName (eBroadcastBitSTDOUT, "stdout-available");
785 SetEventName (eBroadcastBitSTDERR, "stderr-available");
786 SetEventName (eBroadcastBitProfileData, "profile-data-available");
788 m_private_state_control_broadcaster.SetEventName (eBroadcastInternalStateControlStop , "control-stop" );
789 m_private_state_control_broadcaster.SetEventName (eBroadcastInternalStateControlPause , "control-pause" );
790 m_private_state_control_broadcaster.SetEventName (eBroadcastInternalStateControlResume, "control-resume");
792 listener.StartListeningForEvents (this,
793 eBroadcastBitStateChanged |
794 eBroadcastBitInterrupt |
795 eBroadcastBitSTDOUT |
796 eBroadcastBitSTDERR |
797 eBroadcastBitProfileData);
799 m_private_state_listener.StartListeningForEvents(&m_private_state_broadcaster,
800 eBroadcastBitStateChanged |
801 eBroadcastBitInterrupt);
803 m_private_state_listener.StartListeningForEvents(&m_private_state_control_broadcaster,
804 eBroadcastInternalStateControlStop |
805 eBroadcastInternalStateControlPause |
806 eBroadcastInternalStateControlResume);
807 // We need something valid here, even if just the default UnixSignalsSP.
808 assert (m_unix_signals_sp && "null m_unix_signals_sp after initialization");
810 // Allow the platform to override the default cache line size
811 OptionValueSP value_sp =
812 m_collection_sp->GetPropertyAtIndex(nullptr, true, ePropertyMemCacheLineSize)->GetValue();
813 uint32_t platform_cache_line_size = target_sp->GetPlatform()->GetDefaultMemoryCacheLineSize();
814 if (! value_sp->OptionWasSet() && platform_cache_line_size != 0)
815 value_sp->SetUInt64Value(platform_cache_line_size);
820 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_OBJECT));
822 log->Printf ("%p Process::~Process()", static_cast<void*>(this));
823 StopPrivateStateThread();
825 // ThreadList::Clear() will try to acquire this process's mutex, so
826 // explicitly clear the thread list here to ensure that the mutex
827 // is not destroyed before the thread list.
828 m_thread_list.Clear();
831 const ProcessPropertiesSP &
832 Process::GetGlobalProperties()
834 static ProcessPropertiesSP g_settings_sp;
836 g_settings_sp.reset (new ProcessProperties (NULL));
837 return g_settings_sp;
845 // Destroy this process if needed
846 switch (GetPrivateState())
848 case eStateConnected:
849 case eStateAttaching:
850 case eStateLaunching:
855 case eStateSuspended:
866 // Clear our broadcaster before we proceed with destroying
867 Broadcaster::Clear();
869 // Do any cleanup needed prior to being destructed... Subclasses
870 // that override this method should call this superclass method as well.
872 // We need to destroy the loader before the derived Process class gets destroyed
873 // since it is very likely that undoing the loader will require access to the real process.
874 m_dynamic_checkers_ap.reset();
877 m_system_runtime_ap.reset();
879 m_jit_loaders_ap.reset();
880 m_thread_list_real.Destroy();
881 m_thread_list.Destroy();
882 m_extended_thread_list.Destroy();
883 m_queue_list.Clear();
884 m_queue_list_stop_id = 0;
885 std::vector<Notifications> empty_notifications;
886 m_notifications.swap(empty_notifications);
887 m_image_tokens.clear();
888 m_memory_cache.Clear();
889 m_allocated_memory_cache.Clear();
890 m_language_runtimes.clear();
891 m_instrumentation_runtimes.clear();
892 m_next_event_action_ap.reset();
893 m_stop_info_override_callback = NULL;
894 // Clear the last natural stop ID since it has a strong
895 // reference to this process
896 m_mod_id.SetStopEventForLastNaturalStopID(EventSP());
897 //#ifdef LLDB_CONFIGURATION_DEBUG
898 // StreamFile s(stdout, false);
900 // while (m_private_state_listener.GetNextEvent(event_sp))
902 // event_sp->Dump (&s);
906 // We have to be very careful here as the m_private_state_listener might
907 // contain events that have ProcessSP values in them which can keep this
908 // process around forever. These events need to be cleared out.
909 m_private_state_listener.Clear();
910 m_public_run_lock.TrySetRunning(); // This will do nothing if already locked
911 m_public_run_lock.SetStopped();
912 m_private_run_lock.TrySetRunning(); // This will do nothing if already locked
913 m_private_run_lock.SetStopped();
914 m_finalize_called = true;
918 Process::RegisterNotificationCallbacks (const Notifications& callbacks)
920 m_notifications.push_back(callbacks);
921 if (callbacks.initialize != NULL)
922 callbacks.initialize (callbacks.baton, this);
926 Process::UnregisterNotificationCallbacks(const Notifications& callbacks)
928 std::vector<Notifications>::iterator pos, end = m_notifications.end();
929 for (pos = m_notifications.begin(); pos != end; ++pos)
931 if (pos->baton == callbacks.baton &&
932 pos->initialize == callbacks.initialize &&
933 pos->process_state_changed == callbacks.process_state_changed)
935 m_notifications.erase(pos);
943 Process::SynchronouslyNotifyStateChanged (StateType state)
945 std::vector<Notifications>::iterator notification_pos, notification_end = m_notifications.end();
946 for (notification_pos = m_notifications.begin(); notification_pos != notification_end; ++notification_pos)
948 if (notification_pos->process_state_changed)
949 notification_pos->process_state_changed (notification_pos->baton, this, state);
953 // FIXME: We need to do some work on events before the general Listener sees them.
954 // For instance if we are continuing from a breakpoint, we need to ensure that we do
955 // the little "insert real insn, step & stop" trick. But we can't do that when the
956 // event is delivered by the broadcaster - since that is done on the thread that is
957 // waiting for new events, so if we needed more than one event for our handling, we would
958 // stall. So instead we do it when we fetch the event off of the queue.
962 Process::GetNextEvent (EventSP &event_sp)
964 StateType state = eStateInvalid;
966 if (m_listener.GetNextEventForBroadcaster (this, event_sp) && event_sp)
967 state = Process::ProcessEventData::GetStateFromEvent (event_sp.get());
973 Process::SyncIOHandler (uint32_t iohandler_id, uint64_t timeout_msec)
975 // don't sync (potentially context switch) in case where there is no process IO
976 if (! m_process_input_reader)
979 TimeValue timeout = TimeValue::Now();
980 timeout.OffsetWithMicroSeconds(timeout_msec*1000);
981 uint32_t new_iohandler_id = 0;
982 m_iohandler_sync.WaitForValueNotEqualTo(iohandler_id, new_iohandler_id, &timeout);
984 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
986 log->Printf("Process::%s waited for m_iohandler_sync to change from %u, new value is %u", __FUNCTION__, iohandler_id, new_iohandler_id);
990 Process::WaitForProcessToStop (const TimeValue *timeout,
991 EventSP *event_sp_ptr,
993 Listener *hijack_listener,
997 // We can't just wait for a "stopped" event, because the stopped event may have restarted the target.
998 // We have to actually check each event, and in the case of a stopped event check the restarted flag
1001 event_sp_ptr->reset();
1002 StateType state = GetState();
1003 // If we are exited or detached, we won't ever get back to any
1004 // other valid state...
1005 if (state == eStateDetached || state == eStateExited)
1008 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
1010 log->Printf ("Process::%s (timeout = %p)", __FUNCTION__,
1011 static_cast<const void*>(timeout));
1014 StateIsStoppedState(state, true) &&
1015 StateIsStoppedState(GetPrivateState(), true))
1018 log->Printf("Process::%s returning without waiting for events; process private and public states are already 'stopped'.",
1020 // We need to toggle the run lock as this won't get done in
1021 // SetPublicState() if the process is hijacked.
1022 if (hijack_listener && use_run_lock)
1023 m_public_run_lock.SetStopped();
1027 while (state != eStateInvalid)
1030 state = WaitForStateChangedEvents (timeout, event_sp, hijack_listener);
1031 if (event_sp_ptr && event_sp)
1032 *event_sp_ptr = event_sp;
1034 bool pop_process_io_handler = hijack_listener != NULL;
1035 Process::HandleProcessStateChangedEvent (event_sp, stream, pop_process_io_handler);
1040 case eStateDetached:
1042 case eStateUnloaded:
1043 // We need to toggle the run lock as this won't get done in
1044 // SetPublicState() if the process is hijacked.
1045 if (hijack_listener && use_run_lock)
1046 m_public_run_lock.SetStopped();
1049 if (Process::ProcessEventData::GetRestartedFromEvent(event_sp.get()))
1053 // We need to toggle the run lock as this won't get done in
1054 // SetPublicState() if the process is hijacked.
1055 if (hijack_listener && use_run_lock)
1056 m_public_run_lock.SetStopped();
1067 Process::HandleProcessStateChangedEvent (const EventSP &event_sp,
1069 bool &pop_process_io_handler)
1071 const bool handle_pop = pop_process_io_handler == true;
1073 pop_process_io_handler = false;
1074 ProcessSP process_sp = Process::ProcessEventData::GetProcessFromEvent(event_sp.get());
1079 StateType event_state = Process::ProcessEventData::GetStateFromEvent (event_sp.get());
1080 if (event_state == eStateInvalid)
1083 switch (event_state)
1086 case eStateUnloaded:
1087 case eStateAttaching:
1088 case eStateLaunching:
1089 case eStateStepping:
1090 case eStateDetached:
1093 stream->Printf ("Process %" PRIu64 " %s\n",
1094 process_sp->GetID(),
1095 StateAsCString (event_state));
1097 if (event_state == eStateDetached)
1098 pop_process_io_handler = true;
1102 case eStateConnected:
1104 // Don't be chatty when we run...
1109 process_sp->GetStatus(*stream);
1110 pop_process_io_handler = true;
1115 case eStateSuspended:
1116 // Make sure the program hasn't been auto-restarted:
1117 if (Process::ProcessEventData::GetRestartedFromEvent (event_sp.get()))
1121 size_t num_reasons = Process::ProcessEventData::GetNumRestartedReasons(event_sp.get());
1122 if (num_reasons > 0)
1124 // FIXME: Do we want to report this, or would that just be annoyingly chatty?
1125 if (num_reasons == 1)
1127 const char *reason = Process::ProcessEventData::GetRestartedReasonAtIndex (event_sp.get(), 0);
1128 stream->Printf ("Process %" PRIu64 " stopped and restarted: %s\n",
1129 process_sp->GetID(),
1130 reason ? reason : "<UNKNOWN REASON>");
1134 stream->Printf ("Process %" PRIu64 " stopped and restarted, reasons:\n",
1135 process_sp->GetID());
1138 for (size_t i = 0; i < num_reasons; i++)
1140 const char *reason = Process::ProcessEventData::GetRestartedReasonAtIndex (event_sp.get(), i);
1141 stream->Printf("\t%s\n", reason ? reason : "<UNKNOWN REASON>");
1149 // Lock the thread list so it doesn't change on us, this is the scope for the locker:
1151 ThreadList &thread_list = process_sp->GetThreadList();
1152 Mutex::Locker locker (thread_list.GetMutex());
1154 ThreadSP curr_thread (thread_list.GetSelectedThread());
1156 StopReason curr_thread_stop_reason = eStopReasonInvalid;
1158 curr_thread_stop_reason = curr_thread->GetStopReason();
1160 !curr_thread->IsValid() ||
1161 curr_thread_stop_reason == eStopReasonInvalid ||
1162 curr_thread_stop_reason == eStopReasonNone)
1164 // Prefer a thread that has just completed its plan over another thread as current thread.
1165 ThreadSP plan_thread;
1166 ThreadSP other_thread;
1168 const size_t num_threads = thread_list.GetSize();
1170 for (i = 0; i < num_threads; ++i)
1172 thread = thread_list.GetThreadAtIndex(i);
1173 StopReason thread_stop_reason = thread->GetStopReason();
1174 switch (thread_stop_reason)
1176 case eStopReasonInvalid:
1177 case eStopReasonNone:
1180 case eStopReasonSignal:
1182 // Don't select a signal thread if we weren't going to stop at that
1183 // signal. We have to have had another reason for stopping here, and
1184 // the user doesn't want to see this thread.
1185 uint64_t signo = thread->GetStopInfo()->GetValue();
1186 if (process_sp->GetUnixSignals()->GetShouldStop(signo))
1189 other_thread = thread;
1193 case eStopReasonTrace:
1194 case eStopReasonBreakpoint:
1195 case eStopReasonWatchpoint:
1196 case eStopReasonException:
1197 case eStopReasonExec:
1198 case eStopReasonThreadExiting:
1199 case eStopReasonInstrumentation:
1201 other_thread = thread;
1203 case eStopReasonPlanComplete:
1205 plan_thread = thread;
1210 thread_list.SetSelectedThreadByID (plan_thread->GetID());
1211 else if (other_thread)
1212 thread_list.SetSelectedThreadByID (other_thread->GetID());
1215 if (curr_thread && curr_thread->IsValid())
1216 thread = curr_thread;
1218 thread = thread_list.GetThreadAtIndex(0);
1221 thread_list.SetSelectedThreadByID (thread->GetID());
1225 // Drop the ThreadList mutex by here, since GetThreadStatus below might have to run code,
1226 // e.g. for Data formatters, and if we hold the ThreadList mutex, then the process is going to
1227 // have a hard time restarting the process.
1230 Debugger &debugger = process_sp->GetTarget().GetDebugger();
1231 if (debugger.GetTargetList().GetSelectedTarget().get() == &process_sp->GetTarget())
1233 const bool only_threads_with_stop_reason = true;
1234 const uint32_t start_frame = 0;
1235 const uint32_t num_frames = 1;
1236 const uint32_t num_frames_with_source = 1;
1237 process_sp->GetStatus(*stream);
1238 process_sp->GetThreadStatus (*stream,
1239 only_threads_with_stop_reason,
1242 num_frames_with_source);
1246 uint32_t target_idx = debugger.GetTargetList().GetIndexOfTarget(process_sp->GetTarget().shared_from_this());
1247 if (target_idx != UINT32_MAX)
1248 stream->Printf ("Target %d: (", target_idx);
1250 stream->Printf ("Target <unknown index>: (");
1251 process_sp->GetTarget().Dump (stream, eDescriptionLevelBrief);
1252 stream->Printf (") stopped.\n");
1256 // Pop the process IO handler
1257 pop_process_io_handler = true;
1262 if (handle_pop && pop_process_io_handler)
1263 process_sp->PopProcessIOHandler();
1269 Process::WaitForState(const TimeValue *timeout,
1270 const StateType *match_states,
1271 const uint32_t num_match_states)
1275 StateType state = GetState();
1276 while (state != eStateInvalid)
1278 // If we are exited or detached, we won't ever get back to any
1279 // other valid state...
1280 if (state == eStateDetached || state == eStateExited)
1283 state = WaitForStateChangedEvents (timeout, event_sp, NULL);
1285 for (i=0; i<num_match_states; ++i)
1287 if (match_states[i] == state)
1295 Process::HijackProcessEvents (Listener *listener)
1297 if (listener != NULL)
1299 return HijackBroadcaster(listener, eBroadcastBitStateChanged | eBroadcastBitInterrupt);
1306 Process::RestoreProcessEvents ()
1308 RestoreBroadcaster();
1312 Process::WaitForStateChangedEvents (const TimeValue *timeout, EventSP &event_sp, Listener *hijack_listener)
1314 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
1317 log->Printf ("Process::%s (timeout = %p, event_sp)...", __FUNCTION__,
1318 static_cast<const void*>(timeout));
1320 Listener *listener = hijack_listener;
1321 if (listener == NULL)
1322 listener = &m_listener;
1324 StateType state = eStateInvalid;
1325 if (listener->WaitForEventForBroadcasterWithType (timeout,
1327 eBroadcastBitStateChanged | eBroadcastBitInterrupt,
1330 if (event_sp && event_sp->GetType() == eBroadcastBitStateChanged)
1331 state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
1333 log->Printf ("Process::%s got no event or was interrupted.", __FUNCTION__);
1337 log->Printf ("Process::%s (timeout = %p, event_sp) => %s",
1338 __FUNCTION__, static_cast<const void*>(timeout),
1339 StateAsCString(state));
1344 Process::PeekAtStateChangedEvents ()
1346 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
1349 log->Printf ("Process::%s...", __FUNCTION__);
1352 event_ptr = m_listener.PeekAtNextEventForBroadcasterWithType (this,
1353 eBroadcastBitStateChanged);
1358 log->Printf ("Process::%s (event_ptr) => %s",
1360 StateAsCString(ProcessEventData::GetStateFromEvent (event_ptr)));
1364 log->Printf ("Process::%s no events found",
1372 Process::WaitForStateChangedEventsPrivate (const TimeValue *timeout, EventSP &event_sp)
1374 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
1377 log->Printf ("Process::%s (timeout = %p, event_sp)...", __FUNCTION__,
1378 static_cast<const void*>(timeout));
1380 StateType state = eStateInvalid;
1381 if (m_private_state_listener.WaitForEventForBroadcasterWithType (timeout,
1382 &m_private_state_broadcaster,
1383 eBroadcastBitStateChanged | eBroadcastBitInterrupt,
1385 if (event_sp && event_sp->GetType() == eBroadcastBitStateChanged)
1386 state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
1388 // This is a bit of a hack, but when we wait here we could very well return
1389 // to the command-line, and that could disable the log, which would render the
1390 // log we got above invalid.
1392 log->Printf ("Process::%s (timeout = %p, event_sp) => %s",
1393 __FUNCTION__, static_cast<const void *>(timeout),
1394 state == eStateInvalid ? "TIMEOUT" : StateAsCString(state));
1399 Process::WaitForEventsPrivate (const TimeValue *timeout, EventSP &event_sp, bool control_only)
1401 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
1404 log->Printf ("Process::%s (timeout = %p, event_sp)...", __FUNCTION__,
1405 static_cast<const void*>(timeout));
1408 return m_private_state_listener.WaitForEventForBroadcaster(timeout, &m_private_state_control_broadcaster, event_sp);
1410 return m_private_state_listener.WaitForEvent(timeout, event_sp);
1414 Process::IsRunning () const
1416 return StateIsRunningState (m_public_state.GetValue());
1420 Process::GetExitStatus ()
1422 Mutex::Locker locker (m_exit_status_mutex);
1424 if (m_public_state.GetValue() == eStateExited)
1425 return m_exit_status;
1430 Process::GetExitDescription ()
1432 Mutex::Locker locker (m_exit_status_mutex);
1434 if (m_public_state.GetValue() == eStateExited && !m_exit_string.empty())
1435 return m_exit_string.c_str();
1440 Process::SetExitStatus (int status, const char *cstr)
1442 // Use a mutex to protect setting the exit status.
1443 Mutex::Locker locker (m_exit_status_mutex);
1445 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
1447 log->Printf("Process::SetExitStatus (status=%i (0x%8.8x), description=%s%s%s)",
1450 cstr ? cstr : "NULL",
1453 // We were already in the exited state
1454 if (m_private_state.GetValue() == eStateExited)
1457 log->Printf("Process::SetExitStatus () ignoring exit status because state was already set to eStateExited");
1461 m_exit_status = status;
1463 m_exit_string = cstr;
1465 m_exit_string.clear();
1467 // When we exit, we don't need the input reader anymore
1468 if (m_process_input_reader)
1470 m_process_input_reader->SetIsDone(true);
1471 m_process_input_reader->Cancel();
1472 m_process_input_reader.reset();
1475 // Clear the last natural stop ID since it has a strong
1476 // reference to this process
1477 m_mod_id.SetStopEventForLastNaturalStopID(EventSP());
1479 SetPrivateState (eStateExited);
1481 // Allow subclasses to do some cleanup
1490 switch (m_private_state.GetValue())
1493 case eStateUnloaded:
1494 case eStateDetached:
1498 case eStateConnected:
1499 case eStateAttaching:
1500 case eStateLaunching:
1503 case eStateStepping:
1505 case eStateSuspended:
1510 // This static callback can be used to watch for local child processes on
1511 // the current host. The child process exits, the process will be
1512 // found in the global target list (we want to be completely sure that the
1513 // lldb_private::Process doesn't go away before we can deliver the signal.
1515 Process::SetProcessExitStatus (void *callback_baton,
1518 int signo, // Zero for no signal
1519 int exit_status // Exit value of process if signal is zero
1522 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_PROCESS));
1524 log->Printf ("Process::SetProcessExitStatus (baton=%p, pid=%" PRIu64 ", exited=%i, signal=%i, exit_status=%i)\n",
1533 TargetSP target_sp(Debugger::FindTargetWithProcessID (pid));
1536 ProcessSP process_sp (target_sp->GetProcessSP());
1539 const char *signal_cstr = NULL;
1541 signal_cstr = process_sp->GetUnixSignals()->GetSignalAsCString(signo);
1543 process_sp->SetExitStatus (exit_status, signal_cstr);
1552 Process::UpdateThreadListIfNeeded ()
1554 const uint32_t stop_id = GetStopID();
1555 if (m_thread_list.GetSize(false) == 0 || stop_id != m_thread_list.GetStopID())
1557 const StateType state = GetPrivateState();
1558 if (StateIsStoppedState (state, true))
1560 Mutex::Locker locker (m_thread_list.GetMutex ());
1561 // m_thread_list does have its own mutex, but we need to
1562 // hold onto the mutex between the call to UpdateThreadList(...)
1563 // and the os->UpdateThreadList(...) so it doesn't change on us
1564 ThreadList &old_thread_list = m_thread_list;
1565 ThreadList real_thread_list(this);
1566 ThreadList new_thread_list(this);
1567 // Always update the thread list with the protocol specific
1568 // thread list, but only update if "true" is returned
1569 if (UpdateThreadList (m_thread_list_real, real_thread_list))
1571 // Don't call into the OperatingSystem to update the thread list if we are shutting down, since
1572 // that may call back into the SBAPI's, requiring the API lock which is already held by whoever is
1573 // shutting us down, causing a deadlock.
1574 OperatingSystem *os = GetOperatingSystem ();
1575 if (os && !m_destroy_in_process)
1577 // Clear any old backing threads where memory threads might have been
1578 // backed by actual threads from the lldb_private::Process subclass
1579 size_t num_old_threads = old_thread_list.GetSize(false);
1580 for (size_t i=0; i<num_old_threads; ++i)
1581 old_thread_list.GetThreadAtIndex(i, false)->ClearBackingThread();
1583 // Turn off dynamic types to ensure we don't run any expressions. Objective C
1584 // can run an expression to determine if a SBValue is a dynamic type or not
1585 // and we need to avoid this. OperatingSystem plug-ins can't run expressions
1586 // that require running code...
1588 Target &target = GetTarget();
1589 const lldb::DynamicValueType saved_prefer_dynamic = target.GetPreferDynamicValue ();
1590 if (saved_prefer_dynamic != lldb::eNoDynamicValues)
1591 target.SetPreferDynamicValue(lldb::eNoDynamicValues);
1593 // Now let the OperatingSystem plug-in update the thread list
1595 os->UpdateThreadList (old_thread_list, // Old list full of threads created by OS plug-in
1596 real_thread_list, // The actual thread list full of threads created by each lldb_private::Process subclass
1597 new_thread_list); // The new thread list that we will show to the user that gets filled in
1599 if (saved_prefer_dynamic != lldb::eNoDynamicValues)
1600 target.SetPreferDynamicValue(saved_prefer_dynamic);
1604 // No OS plug-in, the new thread list is the same as the real thread list
1605 new_thread_list = real_thread_list;
1608 m_thread_list_real.Update(real_thread_list);
1609 m_thread_list.Update (new_thread_list);
1610 m_thread_list.SetStopID (stop_id);
1612 if (GetLastNaturalStopID () != m_extended_thread_stop_id)
1614 // Clear any extended threads that we may have accumulated previously
1615 m_extended_thread_list.Clear();
1616 m_extended_thread_stop_id = GetLastNaturalStopID ();
1618 m_queue_list.Clear();
1619 m_queue_list_stop_id = GetLastNaturalStopID ();
1627 Process::UpdateQueueListIfNeeded ()
1629 if (m_system_runtime_ap.get())
1631 if (m_queue_list.GetSize() == 0 || m_queue_list_stop_id != GetLastNaturalStopID())
1633 const StateType state = GetPrivateState();
1634 if (StateIsStoppedState (state, true))
1636 m_system_runtime_ap->PopulateQueueList (m_queue_list);
1637 m_queue_list_stop_id = GetLastNaturalStopID();
1644 Process::CreateOSPluginThread (lldb::tid_t tid, lldb::addr_t context)
1646 OperatingSystem *os = GetOperatingSystem ();
1648 return os->CreateThread(tid, context);
1653 Process::GetNextThreadIndexID (uint64_t thread_id)
1655 return AssignIndexIDToThread(thread_id);
1659 Process::HasAssignedIndexIDToThread(uint64_t thread_id)
1661 return (m_thread_id_to_index_id_map.find(thread_id) != m_thread_id_to_index_id_map.end());
1665 Process::AssignIndexIDToThread(uint64_t thread_id)
1667 uint32_t result = 0;
1668 std::map<uint64_t, uint32_t>::iterator iterator = m_thread_id_to_index_id_map.find(thread_id);
1669 if (iterator == m_thread_id_to_index_id_map.end())
1671 result = ++m_thread_index_id;
1672 m_thread_id_to_index_id_map[thread_id] = result;
1676 result = iterator->second;
1685 // If any other threads access this we will need a mutex for it
1686 return m_public_state.GetValue ();
1690 Process::StateChangedIsExternallyHijacked()
1692 if (IsHijackedForEvent(eBroadcastBitStateChanged))
1694 if (strcmp(m_hijacking_listeners.back()->GetName(), "lldb.Process.ResumeSynchronous.hijack"))
1701 Process::SetPublicState (StateType new_state, bool restarted)
1703 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
1705 log->Printf("Process::SetPublicState (state = %s, restarted = %i)", StateAsCString(new_state), restarted);
1706 const StateType old_state = m_public_state.GetValue();
1707 m_public_state.SetValue (new_state);
1709 // On the transition from Run to Stopped, we unlock the writer end of the
1710 // run lock. The lock gets locked in Resume, which is the public API
1711 // to tell the program to run.
1712 if (!StateChangedIsExternallyHijacked())
1714 if (new_state == eStateDetached)
1717 log->Printf("Process::SetPublicState (%s) -- unlocking run lock for detach", StateAsCString(new_state));
1718 m_public_run_lock.SetStopped();
1722 const bool old_state_is_stopped = StateIsStoppedState(old_state, false);
1723 const bool new_state_is_stopped = StateIsStoppedState(new_state, false);
1724 if ((old_state_is_stopped != new_state_is_stopped))
1726 if (new_state_is_stopped && !restarted)
1729 log->Printf("Process::SetPublicState (%s) -- unlocking run lock", StateAsCString(new_state));
1730 m_public_run_lock.SetStopped();
1740 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
1742 log->Printf("Process::Resume -- locking run lock");
1743 if (!m_public_run_lock.TrySetRunning())
1745 Error error("Resume request failed - process still running.");
1747 log->Printf ("Process::Resume: -- TrySetRunning failed, not resuming.");
1750 return PrivateResume();
1754 Process::ResumeSynchronous (Stream *stream)
1756 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
1758 log->Printf("Process::ResumeSynchronous -- locking run lock");
1759 if (!m_public_run_lock.TrySetRunning())
1761 Error error("Resume request failed - process still running.");
1763 log->Printf ("Process::Resume: -- TrySetRunning failed, not resuming.");
1767 ListenerSP listener_sp (new Listener("lldb.Process.ResumeSynchronous.hijack"));
1768 HijackProcessEvents(listener_sp.get());
1770 Error error = PrivateResume();
1771 if (error.Success())
1773 StateType state = WaitForProcessToStop (NULL, NULL, true, listener_sp.get(), stream);
1774 const bool must_be_alive = false; // eStateExited is ok, so this must be false
1775 if (!StateIsStoppedState(state, must_be_alive))
1776 error.SetErrorStringWithFormat("process not in stopped state after synchronous resume: %s", StateAsCString(state));
1779 // Undo the hijacking of process events...
1780 RestoreProcessEvents();
1786 Process::GetPrivateState ()
1788 return m_private_state.GetValue();
1792 Process::SetPrivateState (StateType new_state)
1794 if (m_finalize_called)
1797 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
1798 bool state_changed = false;
1801 log->Printf("Process::SetPrivateState (%s)", StateAsCString(new_state));
1803 Mutex::Locker thread_locker(m_thread_list.GetMutex());
1804 Mutex::Locker locker(m_private_state.GetMutex());
1806 const StateType old_state = m_private_state.GetValueNoLock ();
1807 state_changed = old_state != new_state;
1809 const bool old_state_is_stopped = StateIsStoppedState(old_state, false);
1810 const bool new_state_is_stopped = StateIsStoppedState(new_state, false);
1811 if (old_state_is_stopped != new_state_is_stopped)
1813 if (new_state_is_stopped)
1814 m_private_run_lock.SetStopped();
1816 m_private_run_lock.SetRunning();
1821 m_private_state.SetValueNoLock (new_state);
1822 EventSP event_sp (new Event (eBroadcastBitStateChanged, new ProcessEventData (shared_from_this(), new_state)));
1823 if (StateIsStoppedState(new_state, false))
1825 // Note, this currently assumes that all threads in the list
1826 // stop when the process stops. In the future we will want to
1827 // support a debugging model where some threads continue to run
1828 // while others are stopped. When that happens we will either need
1829 // a way for the thread list to identify which threads are stopping
1830 // or create a special thread list containing only threads which
1831 // actually stopped.
1833 // The process plugin is responsible for managing the actual
1834 // behavior of the threads and should have stopped any threads
1835 // that are going to stop before we get here.
1836 m_thread_list.DidStop();
1838 m_mod_id.BumpStopID();
1839 if (!m_mod_id.IsLastResumeForUserExpression())
1840 m_mod_id.SetStopEventForLastNaturalStopID(event_sp);
1841 m_memory_cache.Clear();
1843 log->Printf("Process::SetPrivateState (%s) stop_id = %u", StateAsCString(new_state), m_mod_id.GetStopID());
1846 // Use our target to get a shared pointer to ourselves...
1847 if (m_finalize_called && PrivateStateThreadIsValid() == false)
1848 BroadcastEvent (event_sp);
1850 m_private_state_broadcaster.BroadcastEvent (event_sp);
1855 log->Printf("Process::SetPrivateState (%s) state didn't change. Ignoring...", StateAsCString(new_state));
1860 Process::SetRunningUserExpression (bool on)
1862 m_mod_id.SetRunningUserExpression (on);
1866 Process::GetImageInfoAddress()
1868 return LLDB_INVALID_ADDRESS;
1875 m_abi_sp = ABI::FindPlugin(GetTarget().GetArchitecture());
1880 Process::GetLanguageRuntime(lldb::LanguageType language, bool retry_if_null)
1885 LanguageRuntimeCollection::iterator pos;
1886 pos = m_language_runtimes.find (language);
1887 if (pos == m_language_runtimes.end() || (retry_if_null && !(*pos).second))
1889 lldb::LanguageRuntimeSP runtime_sp(LanguageRuntime::FindPlugin(this, language));
1891 m_language_runtimes[language] = runtime_sp;
1892 return runtime_sp.get();
1895 return (*pos).second.get();
1898 CPPLanguageRuntime *
1899 Process::GetCPPLanguageRuntime (bool retry_if_null)
1901 LanguageRuntime *runtime = GetLanguageRuntime(eLanguageTypeC_plus_plus, retry_if_null);
1902 if (runtime != NULL && runtime->GetLanguageType() == eLanguageTypeC_plus_plus)
1903 return static_cast<CPPLanguageRuntime *> (runtime);
1907 ObjCLanguageRuntime *
1908 Process::GetObjCLanguageRuntime (bool retry_if_null)
1910 LanguageRuntime *runtime = GetLanguageRuntime(eLanguageTypeObjC, retry_if_null);
1911 if (runtime != NULL && runtime->GetLanguageType() == eLanguageTypeObjC)
1912 return static_cast<ObjCLanguageRuntime *> (runtime);
1917 Process::IsPossibleDynamicValue (ValueObject& in_value)
1922 if (in_value.IsDynamic())
1924 LanguageType known_type = in_value.GetObjectRuntimeLanguage();
1926 if (known_type != eLanguageTypeUnknown && known_type != eLanguageTypeC)
1928 LanguageRuntime *runtime = GetLanguageRuntime (known_type);
1929 return runtime ? runtime->CouldHaveDynamicValue(in_value) : false;
1932 LanguageRuntime *cpp_runtime = GetLanguageRuntime (eLanguageTypeC_plus_plus);
1933 if (cpp_runtime && cpp_runtime->CouldHaveDynamicValue(in_value))
1936 LanguageRuntime *objc_runtime = GetLanguageRuntime (eLanguageTypeObjC);
1937 return objc_runtime ? objc_runtime->CouldHaveDynamicValue(in_value) : false;
1941 Process::SetDynamicCheckers(DynamicCheckerFunctions *dynamic_checkers)
1943 m_dynamic_checkers_ap.reset(dynamic_checkers);
1946 BreakpointSiteList &
1947 Process::GetBreakpointSiteList()
1949 return m_breakpoint_site_list;
1952 const BreakpointSiteList &
1953 Process::GetBreakpointSiteList() const
1955 return m_breakpoint_site_list;
1959 Process::DisableAllBreakpointSites ()
1961 m_breakpoint_site_list.ForEach([this](BreakpointSite *bp_site) -> void {
1962 // bp_site->SetEnabled(true);
1963 DisableBreakpointSite(bp_site);
1968 Process::ClearBreakpointSiteByID (lldb::user_id_t break_id)
1970 Error error (DisableBreakpointSiteByID (break_id));
1972 if (error.Success())
1973 m_breakpoint_site_list.Remove(break_id);
1979 Process::DisableBreakpointSiteByID (lldb::user_id_t break_id)
1982 BreakpointSiteSP bp_site_sp = m_breakpoint_site_list.FindByID (break_id);
1985 if (bp_site_sp->IsEnabled())
1986 error = DisableBreakpointSite (bp_site_sp.get());
1990 error.SetErrorStringWithFormat("invalid breakpoint site ID: %" PRIu64, break_id);
1997 Process::EnableBreakpointSiteByID (lldb::user_id_t break_id)
2000 BreakpointSiteSP bp_site_sp = m_breakpoint_site_list.FindByID (break_id);
2003 if (!bp_site_sp->IsEnabled())
2004 error = EnableBreakpointSite (bp_site_sp.get());
2008 error.SetErrorStringWithFormat("invalid breakpoint site ID: %" PRIu64, break_id);
2014 Process::CreateBreakpointSite (const BreakpointLocationSP &owner, bool use_hardware)
2016 addr_t load_addr = LLDB_INVALID_ADDRESS;
2018 bool show_error = true;
2022 case eStateUnloaded:
2023 case eStateConnected:
2024 case eStateAttaching:
2025 case eStateLaunching:
2026 case eStateDetached:
2033 case eStateStepping:
2035 case eStateSuspended:
2036 show_error = IsAlive();
2040 // Reset the IsIndirect flag here, in case the location changes from
2041 // pointing to a indirect symbol to a regular symbol.
2042 owner->SetIsIndirect (false);
2044 if (owner->ShouldResolveIndirectFunctions())
2046 Symbol *symbol = owner->GetAddress().CalculateSymbolContextSymbol();
2047 if (symbol && symbol->IsIndirect())
2050 Address symbol_address = symbol->GetAddress();
2051 load_addr = ResolveIndirectFunction (&symbol_address, error);
2052 if (!error.Success() && show_error)
2054 GetTarget().GetDebugger().GetErrorFile()->Printf ("warning: failed to resolve indirect function at 0x%" PRIx64 " for breakpoint %i.%i: %s\n",
2055 symbol->GetLoadAddress(&GetTarget()),
2056 owner->GetBreakpoint().GetID(),
2058 error.AsCString() ? error.AsCString() : "unknown error");
2059 return LLDB_INVALID_BREAK_ID;
2061 Address resolved_address(load_addr);
2062 load_addr = resolved_address.GetOpcodeLoadAddress (&GetTarget());
2063 owner->SetIsIndirect(true);
2066 load_addr = owner->GetAddress().GetOpcodeLoadAddress (&GetTarget());
2069 load_addr = owner->GetAddress().GetOpcodeLoadAddress (&GetTarget());
2071 if (load_addr != LLDB_INVALID_ADDRESS)
2073 BreakpointSiteSP bp_site_sp;
2075 // Look up this breakpoint site. If it exists, then add this new owner, otherwise
2076 // create a new breakpoint site and add it.
2078 bp_site_sp = m_breakpoint_site_list.FindByAddress (load_addr);
2082 bp_site_sp->AddOwner (owner);
2083 owner->SetBreakpointSite (bp_site_sp);
2084 return bp_site_sp->GetID();
2088 bp_site_sp.reset (new BreakpointSite (&m_breakpoint_site_list, owner, load_addr, use_hardware));
2091 Error error = EnableBreakpointSite (bp_site_sp.get());
2092 if (error.Success())
2094 owner->SetBreakpointSite (bp_site_sp);
2095 return m_breakpoint_site_list.Add (bp_site_sp);
2101 // Report error for setting breakpoint...
2102 GetTarget().GetDebugger().GetErrorFile()->Printf ("warning: failed to set breakpoint site at 0x%" PRIx64 " for breakpoint %i.%i: %s\n",
2104 owner->GetBreakpoint().GetID(),
2106 error.AsCString() ? error.AsCString() : "unknown error");
2112 // We failed to enable the breakpoint
2113 return LLDB_INVALID_BREAK_ID;
2117 Process::RemoveOwnerFromBreakpointSite (lldb::user_id_t owner_id, lldb::user_id_t owner_loc_id, BreakpointSiteSP &bp_site_sp)
2119 uint32_t num_owners = bp_site_sp->RemoveOwner (owner_id, owner_loc_id);
2120 if (num_owners == 0)
2122 // Don't try to disable the site if we don't have a live process anymore.
2124 DisableBreakpointSite (bp_site_sp.get());
2125 m_breakpoint_site_list.RemoveByAddress(bp_site_sp->GetLoadAddress());
2130 Process::RemoveBreakpointOpcodesFromBuffer (addr_t bp_addr, size_t size, uint8_t *buf) const
2132 size_t bytes_removed = 0;
2133 BreakpointSiteList bp_sites_in_range;
2135 if (m_breakpoint_site_list.FindInRange (bp_addr, bp_addr + size, bp_sites_in_range))
2137 bp_sites_in_range.ForEach([bp_addr, size, buf, &bytes_removed](BreakpointSite *bp_site) -> void {
2138 if (bp_site->GetType() == BreakpointSite::eSoftware)
2140 addr_t intersect_addr;
2141 size_t intersect_size;
2142 size_t opcode_offset;
2143 if (bp_site->IntersectsRange(bp_addr, size, &intersect_addr, &intersect_size, &opcode_offset))
2145 assert(bp_addr <= intersect_addr && intersect_addr < bp_addr + size);
2146 assert(bp_addr < intersect_addr + intersect_size && intersect_addr + intersect_size <= bp_addr + size);
2147 assert(opcode_offset + intersect_size <= bp_site->GetByteSize());
2148 size_t buf_offset = intersect_addr - bp_addr;
2149 ::memcpy(buf + buf_offset, bp_site->GetSavedOpcodeBytes() + opcode_offset, intersect_size);
2154 return bytes_removed;
2158 Process::GetSoftwareBreakpointTrapOpcode (BreakpointSite* bp_site)
2160 PlatformSP platform_sp (GetTarget().GetPlatform());
2162 return platform_sp->GetSoftwareBreakpointTrapOpcode (GetTarget(), bp_site);
2167 Process::EnableSoftwareBreakpoint (BreakpointSite *bp_site)
2170 assert (bp_site != NULL);
2171 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_BREAKPOINTS));
2172 const addr_t bp_addr = bp_site->GetLoadAddress();
2174 log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64, bp_site->GetID(), (uint64_t)bp_addr);
2175 if (bp_site->IsEnabled())
2178 log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- already enabled", bp_site->GetID(), (uint64_t)bp_addr);
2182 if (bp_addr == LLDB_INVALID_ADDRESS)
2184 error.SetErrorString("BreakpointSite contains an invalid load address.");
2187 // Ask the lldb::Process subclass to fill in the correct software breakpoint
2188 // trap for the breakpoint site
2189 const size_t bp_opcode_size = GetSoftwareBreakpointTrapOpcode(bp_site);
2191 if (bp_opcode_size == 0)
2193 error.SetErrorStringWithFormat ("Process::GetSoftwareBreakpointTrapOpcode() returned zero, unable to get breakpoint trap for address 0x%" PRIx64, bp_addr);
2197 const uint8_t * const bp_opcode_bytes = bp_site->GetTrapOpcodeBytes();
2199 if (bp_opcode_bytes == NULL)
2201 error.SetErrorString ("BreakpointSite doesn't contain a valid breakpoint trap opcode.");
2205 // Save the original opcode by reading it
2206 if (DoReadMemory(bp_addr, bp_site->GetSavedOpcodeBytes(), bp_opcode_size, error) == bp_opcode_size)
2208 // Write a software breakpoint in place of the original opcode
2209 if (DoWriteMemory(bp_addr, bp_opcode_bytes, bp_opcode_size, error) == bp_opcode_size)
2211 uint8_t verify_bp_opcode_bytes[64];
2212 if (DoReadMemory(bp_addr, verify_bp_opcode_bytes, bp_opcode_size, error) == bp_opcode_size)
2214 if (::memcmp(bp_opcode_bytes, verify_bp_opcode_bytes, bp_opcode_size) == 0)
2216 bp_site->SetEnabled(true);
2217 bp_site->SetType (BreakpointSite::eSoftware);
2219 log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- SUCCESS",
2224 error.SetErrorString("failed to verify the breakpoint trap in memory.");
2227 error.SetErrorString("Unable to read memory to verify breakpoint trap.");
2230 error.SetErrorString("Unable to write breakpoint trap to memory.");
2233 error.SetErrorString("Unable to read memory at breakpoint address.");
2235 if (log && error.Fail())
2236 log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- FAILED: %s",
2244 Process::DisableSoftwareBreakpoint (BreakpointSite *bp_site)
2247 assert (bp_site != NULL);
2248 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_BREAKPOINTS));
2249 addr_t bp_addr = bp_site->GetLoadAddress();
2250 lldb::user_id_t breakID = bp_site->GetID();
2252 log->Printf ("Process::DisableSoftwareBreakpoint (breakID = %" PRIu64 ") addr = 0x%" PRIx64, breakID, (uint64_t)bp_addr);
2254 if (bp_site->IsHardware())
2256 error.SetErrorString("Breakpoint site is a hardware breakpoint.");
2258 else if (bp_site->IsEnabled())
2260 const size_t break_op_size = bp_site->GetByteSize();
2261 const uint8_t * const break_op = bp_site->GetTrapOpcodeBytes();
2262 if (break_op_size > 0)
2264 // Clear a software breakpoint instruction
2265 uint8_t curr_break_op[8];
2266 assert (break_op_size <= sizeof(curr_break_op));
2267 bool break_op_found = false;
2269 // Read the breakpoint opcode
2270 if (DoReadMemory (bp_addr, curr_break_op, break_op_size, error) == break_op_size)
2272 bool verify = false;
2273 // Make sure the breakpoint opcode exists at this address
2274 if (::memcmp (curr_break_op, break_op, break_op_size) == 0)
2276 break_op_found = true;
2277 // We found a valid breakpoint opcode at this address, now restore
2278 // the saved opcode.
2279 if (DoWriteMemory (bp_addr, bp_site->GetSavedOpcodeBytes(), break_op_size, error) == break_op_size)
2284 error.SetErrorString("Memory write failed when restoring original opcode.");
2288 error.SetErrorString("Original breakpoint trap is no longer in memory.");
2289 // Set verify to true and so we can check if the original opcode has already been restored
2295 uint8_t verify_opcode[8];
2296 assert (break_op_size < sizeof(verify_opcode));
2297 // Verify that our original opcode made it back to the inferior
2298 if (DoReadMemory (bp_addr, verify_opcode, break_op_size, error) == break_op_size)
2300 // compare the memory we just read with the original opcode
2301 if (::memcmp (bp_site->GetSavedOpcodeBytes(), verify_opcode, break_op_size) == 0)
2304 bp_site->SetEnabled(false);
2306 log->Printf ("Process::DisableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- SUCCESS", bp_site->GetID(), (uint64_t)bp_addr);
2312 error.SetErrorString("Failed to restore original opcode.");
2316 error.SetErrorString("Failed to read memory to verify that breakpoint trap was restored.");
2320 error.SetErrorString("Unable to read memory that should contain the breakpoint trap.");
2326 log->Printf ("Process::DisableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- already disabled", bp_site->GetID(), (uint64_t)bp_addr);
2331 log->Printf ("Process::DisableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- FAILED: %s",
2338 // Uncomment to verify memory caching works after making changes to caching code
2339 //#define VERIFY_MEMORY_READS
2342 Process::ReadMemory (addr_t addr, void *buf, size_t size, Error &error)
2345 if (!GetDisableMemoryCache())
2347 #if defined (VERIFY_MEMORY_READS)
2348 // Memory caching is enabled, with debug verification
2352 // Uncomment the line below to make sure memory caching is working.
2353 // I ran this through the test suite and got no assertions, so I am
2354 // pretty confident this is working well. If any changes are made to
2355 // memory caching, uncomment the line below and test your changes!
2357 // Verify all memory reads by using the cache first, then redundantly
2358 // reading the same memory from the inferior and comparing to make sure
2359 // everything is exactly the same.
2360 std::string verify_buf (size, '\0');
2361 assert (verify_buf.size() == size);
2362 const size_t cache_bytes_read = m_memory_cache.Read (this, addr, buf, size, error);
2364 const size_t verify_bytes_read = ReadMemoryFromInferior (addr, const_cast<char *>(verify_buf.data()), verify_buf.size(), verify_error);
2365 assert (cache_bytes_read == verify_bytes_read);
2366 assert (memcmp(buf, verify_buf.data(), verify_buf.size()) == 0);
2367 assert (verify_error.Success() == error.Success());
2368 return cache_bytes_read;
2371 #else // !defined(VERIFY_MEMORY_READS)
2372 // Memory caching is enabled, without debug verification
2374 return m_memory_cache.Read (addr, buf, size, error);
2375 #endif // defined (VERIFY_MEMORY_READS)
2379 // Memory caching is disabled
2381 return ReadMemoryFromInferior (addr, buf, size, error);
2386 Process::ReadCStringFromMemory (addr_t addr, std::string &out_str, Error &error)
2390 addr_t curr_addr = addr;
2393 size_t length = ReadCStringFromMemory (curr_addr, buf, sizeof(buf), error);
2396 out_str.append(buf, length);
2397 // If we got "length - 1" bytes, we didn't get the whole C string, we
2398 // need to read some more characters
2399 if (length == sizeof(buf) - 1)
2400 curr_addr += length;
2404 return out_str.size();
2408 Process::ReadStringFromMemory (addr_t addr, char *dst, size_t max_bytes, Error &error,
2411 size_t total_bytes_read = 0;
2412 if (dst && max_bytes && type_width && max_bytes >= type_width)
2414 // Ensure a null terminator independent of the number of bytes that is read.
2415 memset (dst, 0, max_bytes);
2416 size_t bytes_left = max_bytes - type_width;
2418 const char terminator[4] = {'\0', '\0', '\0', '\0'};
2419 assert(sizeof(terminator) >= type_width &&
2420 "Attempting to validate a string with more than 4 bytes per character!");
2422 addr_t curr_addr = addr;
2423 const size_t cache_line_size = m_memory_cache.GetMemoryCacheLineSize();
2424 char *curr_dst = dst;
2427 while (bytes_left > 0 && error.Success())
2429 addr_t cache_line_bytes_left = cache_line_size - (curr_addr % cache_line_size);
2430 addr_t bytes_to_read = std::min<addr_t>(bytes_left, cache_line_bytes_left);
2431 size_t bytes_read = ReadMemory (curr_addr, curr_dst, bytes_to_read, error);
2433 if (bytes_read == 0)
2436 // Search for a null terminator of correct size and alignment in bytes_read
2437 size_t aligned_start = total_bytes_read - total_bytes_read % type_width;
2438 for (size_t i = aligned_start; i + type_width <= total_bytes_read + bytes_read; i += type_width)
2439 if (::strncmp(&dst[i], terminator, type_width) == 0)
2445 total_bytes_read += bytes_read;
2446 curr_dst += bytes_read;
2447 curr_addr += bytes_read;
2448 bytes_left -= bytes_read;
2454 error.SetErrorString("invalid arguments");
2456 return total_bytes_read;
2459 // Deprecated in favor of ReadStringFromMemory which has wchar support and correct code to find
2460 // null terminators.
2462 Process::ReadCStringFromMemory (addr_t addr, char *dst, size_t dst_max_len, Error &result_error)
2464 size_t total_cstr_len = 0;
2465 if (dst && dst_max_len)
2467 result_error.Clear();
2468 // NULL out everything just to be safe
2469 memset (dst, 0, dst_max_len);
2471 addr_t curr_addr = addr;
2472 const size_t cache_line_size = m_memory_cache.GetMemoryCacheLineSize();
2473 size_t bytes_left = dst_max_len - 1;
2474 char *curr_dst = dst;
2476 while (bytes_left > 0)
2478 addr_t cache_line_bytes_left = cache_line_size - (curr_addr % cache_line_size);
2479 addr_t bytes_to_read = std::min<addr_t>(bytes_left, cache_line_bytes_left);
2480 size_t bytes_read = ReadMemory (curr_addr, curr_dst, bytes_to_read, error);
2482 if (bytes_read == 0)
2484 result_error = error;
2485 dst[total_cstr_len] = '\0';
2488 const size_t len = strlen(curr_dst);
2490 total_cstr_len += len;
2492 if (len < bytes_to_read)
2495 curr_dst += bytes_read;
2496 curr_addr += bytes_read;
2497 bytes_left -= bytes_read;
2503 result_error.SetErrorString("invalid arguments");
2505 result_error.Clear();
2507 return total_cstr_len;
2511 Process::ReadMemoryFromInferior (addr_t addr, void *buf, size_t size, Error &error)
2513 if (buf == NULL || size == 0)
2516 size_t bytes_read = 0;
2517 uint8_t *bytes = (uint8_t *)buf;
2519 while (bytes_read < size)
2521 const size_t curr_size = size - bytes_read;
2522 const size_t curr_bytes_read = DoReadMemory (addr + bytes_read,
2526 bytes_read += curr_bytes_read;
2527 if (curr_bytes_read == curr_size || curr_bytes_read == 0)
2531 // Replace any software breakpoint opcodes that fall into this range back
2532 // into "buf" before we return
2534 RemoveBreakpointOpcodesFromBuffer (addr, bytes_read, (uint8_t *)buf);
2539 Process::ReadUnsignedIntegerFromMemory (lldb::addr_t vm_addr, size_t integer_byte_size, uint64_t fail_value, Error &error)
2542 if (ReadScalarIntegerFromMemory(vm_addr, integer_byte_size, false, scalar, error))
2543 return scalar.ULongLong(fail_value);
2548 Process::ReadPointerFromMemory (lldb::addr_t vm_addr, Error &error)
2551 if (ReadScalarIntegerFromMemory(vm_addr, GetAddressByteSize(), false, scalar, error))
2552 return scalar.ULongLong(LLDB_INVALID_ADDRESS);
2553 return LLDB_INVALID_ADDRESS;
2557 Process::WritePointerToMemory (lldb::addr_t vm_addr,
2558 lldb::addr_t ptr_value,
2562 const uint32_t addr_byte_size = GetAddressByteSize();
2563 if (addr_byte_size <= 4)
2564 scalar = (uint32_t)ptr_value;
2567 return WriteScalarToMemory(vm_addr, scalar, addr_byte_size, error) == addr_byte_size;
2571 Process::WriteMemoryPrivate (addr_t addr, const void *buf, size_t size, Error &error)
2573 size_t bytes_written = 0;
2574 const uint8_t *bytes = (const uint8_t *)buf;
2576 while (bytes_written < size)
2578 const size_t curr_size = size - bytes_written;
2579 const size_t curr_bytes_written = DoWriteMemory (addr + bytes_written,
2580 bytes + bytes_written,
2583 bytes_written += curr_bytes_written;
2584 if (curr_bytes_written == curr_size || curr_bytes_written == 0)
2587 return bytes_written;
2591 Process::WriteMemory (addr_t addr, const void *buf, size_t size, Error &error)
2593 #if defined (ENABLE_MEMORY_CACHING)
2594 m_memory_cache.Flush (addr, size);
2597 if (buf == NULL || size == 0)
2600 m_mod_id.BumpMemoryID();
2602 // We need to write any data that would go where any current software traps
2603 // (enabled software breakpoints) any software traps (breakpoints) that we
2604 // may have placed in our tasks memory.
2606 BreakpointSiteList bp_sites_in_range;
2608 if (m_breakpoint_site_list.FindInRange (addr, addr + size, bp_sites_in_range))
2610 // No breakpoint sites overlap
2611 if (bp_sites_in_range.IsEmpty())
2612 return WriteMemoryPrivate (addr, buf, size, error);
2615 const uint8_t *ubuf = (const uint8_t *)buf;
2616 uint64_t bytes_written = 0;
2618 bp_sites_in_range.ForEach([this, addr, size, &bytes_written, &ubuf, &error](BreakpointSite *bp) -> void {
2620 if (error.Success())
2622 addr_t intersect_addr;
2623 size_t intersect_size;
2624 size_t opcode_offset;
2625 const bool intersects = bp->IntersectsRange(addr, size, &intersect_addr, &intersect_size, &opcode_offset);
2626 UNUSED_IF_ASSERT_DISABLED(intersects);
2628 assert(addr <= intersect_addr && intersect_addr < addr + size);
2629 assert(addr < intersect_addr + intersect_size && intersect_addr + intersect_size <= addr + size);
2630 assert(opcode_offset + intersect_size <= bp->GetByteSize());
2632 // Check for bytes before this breakpoint
2633 const addr_t curr_addr = addr + bytes_written;
2634 if (intersect_addr > curr_addr)
2636 // There are some bytes before this breakpoint that we need to
2637 // just write to memory
2638 size_t curr_size = intersect_addr - curr_addr;
2639 size_t curr_bytes_written = WriteMemoryPrivate (curr_addr,
2640 ubuf + bytes_written,
2643 bytes_written += curr_bytes_written;
2644 if (curr_bytes_written != curr_size)
2646 // We weren't able to write all of the requested bytes, we
2647 // are done looping and will return the number of bytes that
2648 // we have written so far.
2649 if (error.Success())
2650 error.SetErrorToGenericError();
2653 // Now write any bytes that would cover up any software breakpoints
2654 // directly into the breakpoint opcode buffer
2655 ::memcpy(bp->GetSavedOpcodeBytes() + opcode_offset, ubuf + bytes_written, intersect_size);
2656 bytes_written += intersect_size;
2660 if (bytes_written < size)
2661 WriteMemoryPrivate (addr + bytes_written,
2662 ubuf + bytes_written,
2663 size - bytes_written,
2669 return WriteMemoryPrivate (addr, buf, size, error);
2672 // Write any remaining bytes after the last breakpoint if we have any left
2673 return 0; //bytes_written;
2677 Process::WriteScalarToMemory (addr_t addr, const Scalar &scalar, size_t byte_size, Error &error)
2679 if (byte_size == UINT32_MAX)
2680 byte_size = scalar.GetByteSize();
2684 const size_t mem_size = scalar.GetAsMemoryData (buf, byte_size, GetByteOrder(), error);
2686 return WriteMemory(addr, buf, mem_size, error);
2688 error.SetErrorString ("failed to get scalar as memory data");
2692 error.SetErrorString ("invalid scalar value");
2698 Process::ReadScalarIntegerFromMemory (addr_t addr,
2707 error.SetErrorString ("byte size is zero");
2709 else if (byte_size & (byte_size - 1))
2711 error.SetErrorStringWithFormat ("byte size %u is not a power of 2", byte_size);
2713 else if (byte_size <= sizeof(uval))
2715 const size_t bytes_read = ReadMemory (addr, &uval, byte_size, error);
2716 if (bytes_read == byte_size)
2718 DataExtractor data (&uval, sizeof(uval), GetByteOrder(), GetAddressByteSize());
2719 lldb::offset_t offset = 0;
2721 scalar = data.GetMaxU32 (&offset, byte_size);
2723 scalar = data.GetMaxU64 (&offset, byte_size);
2725 scalar.SignExtend(byte_size * 8);
2731 error.SetErrorStringWithFormat ("byte size of %u is too large for integer scalar type", byte_size);
2736 #define USE_ALLOCATE_MEMORY_CACHE 1
2738 Process::AllocateMemory(size_t size, uint32_t permissions, Error &error)
2740 if (GetPrivateState() != eStateStopped)
2741 return LLDB_INVALID_ADDRESS;
2743 #if defined (USE_ALLOCATE_MEMORY_CACHE)
2744 return m_allocated_memory_cache.AllocateMemory(size, permissions, error);
2746 addr_t allocated_addr = DoAllocateMemory (size, permissions, error);
2747 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
2749 log->Printf("Process::AllocateMemory(size=%" PRIu64 ", permissions=%s) => 0x%16.16" PRIx64 " (m_stop_id = %u m_memory_id = %u)",
2751 GetPermissionsAsCString (permissions),
2752 (uint64_t)allocated_addr,
2753 m_mod_id.GetStopID(),
2754 m_mod_id.GetMemoryID());
2755 return allocated_addr;
2760 Process::CallocateMemory(size_t size, uint32_t permissions, Error &error)
2762 addr_t return_addr = AllocateMemory(size, permissions, error);
2763 if (error.Success())
2765 std::string buffer(size, 0);
2766 WriteMemory(return_addr, buffer.c_str(), size, error);
2774 if (m_can_jit == eCanJITDontKnow)
2776 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
2779 uint64_t allocated_memory = AllocateMemory(8,
2780 ePermissionsReadable | ePermissionsWritable | ePermissionsExecutable,
2785 m_can_jit = eCanJITYes;
2787 log->Printf ("Process::%s pid %" PRIu64 " allocation test passed, CanJIT () is true", __FUNCTION__, GetID ());
2791 m_can_jit = eCanJITNo;
2793 log->Printf ("Process::%s pid %" PRIu64 " allocation test failed, CanJIT () is false: %s", __FUNCTION__, GetID (), err.AsCString ());
2796 DeallocateMemory (allocated_memory);
2799 return m_can_jit == eCanJITYes;
2803 Process::SetCanJIT (bool can_jit)
2805 m_can_jit = (can_jit ? eCanJITYes : eCanJITNo);
2809 Process::SetCanRunCode (bool can_run_code)
2811 SetCanJIT(can_run_code);
2812 m_can_interpret_function_calls = can_run_code;
2816 Process::DeallocateMemory (addr_t ptr)
2819 #if defined (USE_ALLOCATE_MEMORY_CACHE)
2820 if (!m_allocated_memory_cache.DeallocateMemory(ptr))
2822 error.SetErrorStringWithFormat ("deallocation of memory at 0x%" PRIx64 " failed.", (uint64_t)ptr);
2825 error = DoDeallocateMemory (ptr);
2827 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
2829 log->Printf("Process::DeallocateMemory(addr=0x%16.16" PRIx64 ") => err = %s (m_stop_id = %u, m_memory_id = %u)",
2831 error.AsCString("SUCCESS"),
2832 m_mod_id.GetStopID(),
2833 m_mod_id.GetMemoryID());
2839 Process::ReadModuleFromMemory (const FileSpec& file_spec,
2840 lldb::addr_t header_addr,
2841 size_t size_to_read)
2843 Log *log = lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_HOST);
2846 log->Printf ("Process::ReadModuleFromMemory reading %s binary from memory", file_spec.GetPath().c_str());
2848 ModuleSP module_sp (new Module (file_spec, ArchSpec()));
2852 ObjectFile *objfile = module_sp->GetMemoryObjectFile (shared_from_this(), header_addr, error, size_to_read);
2860 Process::GetLoadAddressPermissions (lldb::addr_t load_addr, uint32_t &permissions)
2862 MemoryRegionInfo range_info;
2864 Error error (GetMemoryRegionInfo (load_addr, range_info));
2865 if (!error.Success())
2867 if (range_info.GetReadable() == MemoryRegionInfo::eDontKnow
2868 || range_info.GetWritable() == MemoryRegionInfo::eDontKnow
2869 || range_info.GetExecutable() == MemoryRegionInfo::eDontKnow)
2874 if (range_info.GetReadable() == MemoryRegionInfo::eYes)
2875 permissions |= lldb::ePermissionsReadable;
2877 if (range_info.GetWritable() == MemoryRegionInfo::eYes)
2878 permissions |= lldb::ePermissionsWritable;
2880 if (range_info.GetExecutable() == MemoryRegionInfo::eYes)
2881 permissions |= lldb::ePermissionsExecutable;
2887 Process::EnableWatchpoint (Watchpoint *watchpoint, bool notify)
2890 error.SetErrorString("watchpoints are not supported");
2895 Process::DisableWatchpoint (Watchpoint *watchpoint, bool notify)
2898 error.SetErrorString("watchpoints are not supported");
2903 Process::WaitForProcessStopPrivate (const TimeValue *timeout, EventSP &event_sp)
2906 // Now wait for the process to launch and return control to us, and then
2911 state = WaitForStateChangedEventsPrivate (timeout, event_sp);
2913 if (StateIsStoppedState(state, false))
2916 // If state is invalid, then we timed out
2917 if (state == eStateInvalid)
2921 HandlePrivateEvent (event_sp);
2927 Process::LoadOperatingSystemPlugin(bool flush)
2930 m_thread_list.Clear();
2931 m_os_ap.reset (OperatingSystem::FindPlugin (this, NULL));
2937 Process::Launch (ProcessLaunchInfo &launch_info)
2942 m_jit_loaders_ap.reset();
2943 m_system_runtime_ap.reset();
2945 m_process_input_reader.reset();
2946 m_stop_info_override_callback = NULL;
2948 Module *exe_module = GetTarget().GetExecutableModulePointer();
2951 char local_exec_file_path[PATH_MAX];
2952 char platform_exec_file_path[PATH_MAX];
2953 exe_module->GetFileSpec().GetPath(local_exec_file_path, sizeof(local_exec_file_path));
2954 exe_module->GetPlatformFileSpec().GetPath(platform_exec_file_path, sizeof(platform_exec_file_path));
2955 if (exe_module->GetFileSpec().Exists())
2957 // Install anything that might need to be installed prior to launching.
2958 // For host systems, this will do nothing, but if we are connected to a
2959 // remote platform it will install any needed binaries
2960 error = GetTarget().Install(&launch_info);
2964 if (PrivateStateThreadIsValid ())
2965 PausePrivateStateThread ();
2967 error = WillLaunch (exe_module);
2968 if (error.Success())
2970 const bool restarted = false;
2971 SetPublicState (eStateLaunching, restarted);
2972 m_should_detach = false;
2974 if (m_public_run_lock.TrySetRunning())
2976 // Now launch using these arguments.
2977 error = DoLaunch (exe_module, launch_info);
2981 // This shouldn't happen
2982 error.SetErrorString("failed to acquire process run lock");
2987 if (GetID() != LLDB_INVALID_PROCESS_ID)
2989 SetID (LLDB_INVALID_PROCESS_ID);
2990 const char *error_string = error.AsCString();
2991 if (error_string == NULL)
2992 error_string = "launch failed";
2993 SetExitStatus (-1, error_string);
2999 TimeValue timeout_time;
3000 timeout_time = TimeValue::Now();
3001 timeout_time.OffsetWithSeconds(10);
3002 StateType state = WaitForProcessStopPrivate(&timeout_time, event_sp);
3004 if (state == eStateInvalid || event_sp.get() == NULL)
3006 // We were able to launch the process, but we failed to
3007 // catch the initial stop.
3008 error.SetErrorString ("failed to catch stop after launch");
3009 SetExitStatus (0, "failed to catch stop after launch");
3012 else if (state == eStateStopped || state == eStateCrashed)
3016 DynamicLoader *dyld = GetDynamicLoader ();
3020 GetJITLoaders().DidLaunch();
3022 SystemRuntime *system_runtime = GetSystemRuntime ();
3024 system_runtime->DidLaunch();
3026 LoadOperatingSystemPlugin(false);
3028 // Note, the stop event was consumed above, but not handled. This was done
3029 // to give DidLaunch a chance to run. The target is either stopped or crashed.
3030 // Directly set the state. This is done to prevent a stop message with a bunch
3031 // of spurious output on thread status, as well as not pop a ProcessIOHandler.
3032 SetPublicState(state, false);
3034 if (PrivateStateThreadIsValid ())
3035 ResumePrivateStateThread ();
3037 StartPrivateStateThread ();
3039 m_stop_info_override_callback = GetTarget().GetArchitecture().GetStopInfoOverrideCallback();
3041 // Target was stopped at entry as was intended. Need to notify the listeners
3043 if (state == eStateStopped && launch_info.GetFlags().Test(eLaunchFlagStopAtEntry))
3044 HandlePrivateEvent(event_sp);
3046 else if (state == eStateExited)
3048 // We exited while trying to launch somehow. Don't call DidLaunch as that's
3049 // not likely to work, and return an invalid pid.
3050 HandlePrivateEvent (event_sp);
3057 error.SetErrorStringWithFormat("file doesn't exist: '%s'", local_exec_file_path);
3064 Process::LoadCore ()
3066 Error error = DoLoadCore();
3067 if (error.Success())
3069 Listener listener ("lldb.process.load_core_listener");
3070 HijackProcessEvents(&listener);
3072 if (PrivateStateThreadIsValid ())
3073 ResumePrivateStateThread ();
3075 StartPrivateStateThread ();
3077 DynamicLoader *dyld = GetDynamicLoader ();
3081 GetJITLoaders().DidAttach();
3083 SystemRuntime *system_runtime = GetSystemRuntime ();
3085 system_runtime->DidAttach();
3087 m_os_ap.reset (OperatingSystem::FindPlugin (this, NULL));
3088 // We successfully loaded a core file, now pretend we stopped so we can
3089 // show all of the threads in the core file and explore the crashed
3091 SetPrivateState (eStateStopped);
3093 // Wait indefinitely for a stopped event since we just posted one above...
3094 lldb::EventSP event_sp;
3095 listener.WaitForEvent (NULL, event_sp);
3096 StateType state = ProcessEventData::GetStateFromEvent(event_sp.get());
3098 if (!StateIsStoppedState (state, false))
3100 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3102 log->Printf("Process::Halt() failed to stop, state is: %s", StateAsCString(state));
3103 error.SetErrorString ("Did not get stopped event after loading the core file.");
3105 RestoreProcessEvents ();
3111 Process::GetDynamicLoader ()
3113 if (m_dyld_ap.get() == NULL)
3114 m_dyld_ap.reset (DynamicLoader::FindPlugin(this, NULL));
3115 return m_dyld_ap.get();
3118 const lldb::DataBufferSP
3119 Process::GetAuxvData()
3121 return DataBufferSP ();
3125 Process::GetJITLoaders ()
3127 if (!m_jit_loaders_ap)
3129 m_jit_loaders_ap.reset(new JITLoaderList());
3130 JITLoader::LoadPlugins(this, *m_jit_loaders_ap);
3132 return *m_jit_loaders_ap;
3136 Process::GetSystemRuntime ()
3138 if (m_system_runtime_ap.get() == NULL)
3139 m_system_runtime_ap.reset (SystemRuntime::FindPlugin(this));
3140 return m_system_runtime_ap.get();
3143 Process::AttachCompletionHandler::AttachCompletionHandler (Process *process, uint32_t exec_count) :
3144 NextEventAction (process),
3145 m_exec_count (exec_count)
3147 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3149 log->Printf ("Process::AttachCompletionHandler::%s process=%p, exec_count=%" PRIu32, __FUNCTION__, static_cast<void*>(process), exec_count);
3152 Process::NextEventAction::EventActionResult
3153 Process::AttachCompletionHandler::PerformAction (lldb::EventSP &event_sp)
3155 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3157 StateType state = ProcessEventData::GetStateFromEvent (event_sp.get());
3159 log->Printf ("Process::AttachCompletionHandler::%s called with state %s (%d)", __FUNCTION__, StateAsCString(state), static_cast<int> (state));
3163 case eStateAttaching:
3164 return eEventActionSuccess;
3167 case eStateConnected:
3168 return eEventActionRetry;
3173 // During attach, prior to sending the eStateStopped event,
3174 // lldb_private::Process subclasses must set the new process ID.
3175 assert (m_process->GetID() != LLDB_INVALID_PROCESS_ID);
3176 // We don't want these events to be reported, so go set the ShouldReportStop here:
3177 m_process->GetThreadList().SetShouldReportStop (eVoteNo);
3179 if (m_exec_count > 0)
3184 log->Printf ("Process::AttachCompletionHandler::%s state %s: reduced remaining exec count to %" PRIu32 ", requesting resume", __FUNCTION__, StateAsCString(state), m_exec_count);
3187 return eEventActionRetry;
3192 log->Printf ("Process::AttachCompletionHandler::%s state %s: no more execs expected to start, continuing with attach", __FUNCTION__, StateAsCString(state));
3194 m_process->CompleteAttach ();
3195 return eEventActionSuccess;
3206 m_exit_string.assign ("No valid Process");
3207 return eEventActionExit;
3210 Process::NextEventAction::EventActionResult
3211 Process::AttachCompletionHandler::HandleBeingInterrupted()
3213 return eEventActionSuccess;
3217 Process::AttachCompletionHandler::GetExitString ()
3219 return m_exit_string.c_str();
3223 ProcessAttachInfo::GetListenerForProcess (Debugger &debugger)
3226 return *m_listener_sp;
3228 return debugger.GetListener();
3232 Process::Attach (ProcessAttachInfo &attach_info)
3235 m_process_input_reader.reset();
3237 m_jit_loaders_ap.reset();
3238 m_system_runtime_ap.reset();
3240 m_stop_info_override_callback = NULL;
3242 lldb::pid_t attach_pid = attach_info.GetProcessID();
3244 if (attach_pid == LLDB_INVALID_PROCESS_ID)
3246 char process_name[PATH_MAX];
3248 if (attach_info.GetExecutableFile().GetPath (process_name, sizeof(process_name)))
3250 const bool wait_for_launch = attach_info.GetWaitForLaunch();
3252 if (wait_for_launch)
3254 error = WillAttachToProcessWithName(process_name, wait_for_launch);
3255 if (error.Success())
3257 if (m_public_run_lock.TrySetRunning())
3259 m_should_detach = true;
3260 const bool restarted = false;
3261 SetPublicState (eStateAttaching, restarted);
3262 // Now attach using these arguments.
3263 error = DoAttachToProcessWithName (process_name, attach_info);
3267 // This shouldn't happen
3268 error.SetErrorString("failed to acquire process run lock");
3273 if (GetID() != LLDB_INVALID_PROCESS_ID)
3275 SetID (LLDB_INVALID_PROCESS_ID);
3276 if (error.AsCString() == NULL)
3277 error.SetErrorString("attach failed");
3279 SetExitStatus(-1, error.AsCString());
3284 SetNextEventAction(new Process::AttachCompletionHandler(this, attach_info.GetResumeCount()));
3285 StartPrivateStateThread();
3292 ProcessInstanceInfoList process_infos;
3293 PlatformSP platform_sp (GetTarget().GetPlatform ());
3297 ProcessInstanceInfoMatch match_info;
3298 match_info.GetProcessInfo() = attach_info;
3299 match_info.SetNameMatchType (eNameMatchEquals);
3300 platform_sp->FindProcesses (match_info, process_infos);
3301 const uint32_t num_matches = process_infos.GetSize();
3302 if (num_matches == 1)
3304 attach_pid = process_infos.GetProcessIDAtIndex(0);
3305 // Fall through and attach using the above process ID
3309 match_info.GetProcessInfo().GetExecutableFile().GetPath (process_name, sizeof(process_name));
3310 if (num_matches > 1)
3313 ProcessInstanceInfo::DumpTableHeader (s, platform_sp.get(), true, false);
3314 for (size_t i = 0; i < num_matches; i++)
3316 process_infos.GetProcessInfoAtIndex(i).DumpAsTableRow(s, platform_sp.get(), true, false);
3318 error.SetErrorStringWithFormat ("more than one process named %s:\n%s",
3323 error.SetErrorStringWithFormat ("could not find a process named %s", process_name);
3328 error.SetErrorString ("invalid platform, can't find processes by name");
3335 error.SetErrorString ("invalid process name");
3339 if (attach_pid != LLDB_INVALID_PROCESS_ID)
3341 error = WillAttachToProcessWithID(attach_pid);
3342 if (error.Success())
3345 if (m_public_run_lock.TrySetRunning())
3347 // Now attach using these arguments.
3348 m_should_detach = true;
3349 const bool restarted = false;
3350 SetPublicState (eStateAttaching, restarted);
3351 error = DoAttachToProcessWithID (attach_pid, attach_info);
3355 // This shouldn't happen
3356 error.SetErrorString("failed to acquire process run lock");
3359 if (error.Success())
3362 SetNextEventAction(new Process::AttachCompletionHandler(this, attach_info.GetResumeCount()));
3363 StartPrivateStateThread();
3367 if (GetID() != LLDB_INVALID_PROCESS_ID)
3368 SetID (LLDB_INVALID_PROCESS_ID);
3370 const char *error_string = error.AsCString();
3371 if (error_string == NULL)
3372 error_string = "attach failed";
3374 SetExitStatus(-1, error_string);
3382 Process::CompleteAttach ()
3384 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3386 log->Printf ("Process::%s()", __FUNCTION__);
3388 // Let the process subclass figure out at much as it can about the process
3389 // before we go looking for a dynamic loader plug-in.
3390 ArchSpec process_arch;
3391 DidAttach(process_arch);
3393 if (process_arch.IsValid())
3395 GetTarget().SetArchitecture(process_arch);
3398 const char *triple_str = process_arch.GetTriple().getTriple().c_str ();
3399 log->Printf ("Process::%s replacing process architecture with DidAttach() architecture: %s",
3401 triple_str ? triple_str : "<null>");
3405 // We just attached. If we have a platform, ask it for the process architecture, and if it isn't
3406 // the same as the one we've already set, switch architectures.
3407 PlatformSP platform_sp (GetTarget().GetPlatform ());
3408 assert (platform_sp.get());
3411 const ArchSpec &target_arch = GetTarget().GetArchitecture();
3412 if (target_arch.IsValid() && !platform_sp->IsCompatibleArchitecture (target_arch, false, NULL))
3414 ArchSpec platform_arch;
3415 platform_sp = platform_sp->GetPlatformForArchitecture (target_arch, &platform_arch);
3418 GetTarget().SetPlatform (platform_sp);
3419 GetTarget().SetArchitecture(platform_arch);
3421 log->Printf ("Process::%s switching platform to %s and architecture to %s based on info from attach", __FUNCTION__, platform_sp->GetName().AsCString (""), platform_arch.GetTriple().getTriple().c_str ());
3424 else if (!process_arch.IsValid())
3426 ProcessInstanceInfo process_info;
3427 platform_sp->GetProcessInfo (GetID(), process_info);
3428 const ArchSpec &process_arch = process_info.GetArchitecture();
3429 if (process_arch.IsValid() && !GetTarget().GetArchitecture().IsExactMatch(process_arch))
3431 GetTarget().SetArchitecture (process_arch);
3433 log->Printf ("Process::%s switching architecture to %s based on info the platform retrieved for pid %" PRIu64, __FUNCTION__, process_arch.GetTriple().getTriple().c_str (), GetID ());
3438 // We have completed the attach, now it is time to find the dynamic loader
3440 DynamicLoader *dyld = GetDynamicLoader ();
3446 ModuleSP exe_module_sp = GetTarget().GetExecutableModule ();
3447 log->Printf ("Process::%s after DynamicLoader::DidAttach(), target executable is %s (using %s plugin)",
3449 exe_module_sp ? exe_module_sp->GetFileSpec().GetPath().c_str () : "<none>",
3450 dyld->GetPluginName().AsCString ("<unnamed>"));
3454 GetJITLoaders().DidAttach();
3456 SystemRuntime *system_runtime = GetSystemRuntime ();
3459 system_runtime->DidAttach();
3462 ModuleSP exe_module_sp = GetTarget().GetExecutableModule ();
3463 log->Printf ("Process::%s after SystemRuntime::DidAttach(), target executable is %s (using %s plugin)",
3465 exe_module_sp ? exe_module_sp->GetFileSpec().GetPath().c_str () : "<none>",
3466 system_runtime->GetPluginName().AsCString("<unnamed>"));
3470 m_os_ap.reset (OperatingSystem::FindPlugin (this, NULL));
3471 // Figure out which one is the executable, and set that in our target:
3472 const ModuleList &target_modules = GetTarget().GetImages();
3473 Mutex::Locker modules_locker(target_modules.GetMutex());
3474 size_t num_modules = target_modules.GetSize();
3475 ModuleSP new_executable_module_sp;
3477 for (size_t i = 0; i < num_modules; i++)
3479 ModuleSP module_sp (target_modules.GetModuleAtIndexUnlocked (i));
3480 if (module_sp && module_sp->IsExecutable())
3482 if (GetTarget().GetExecutableModulePointer() != module_sp.get())
3483 new_executable_module_sp = module_sp;
3487 if (new_executable_module_sp)
3489 GetTarget().SetExecutableModule (new_executable_module_sp, false);
3492 ModuleSP exe_module_sp = GetTarget().GetExecutableModule ();
3493 log->Printf ("Process::%s after looping through modules, target executable is %s",
3495 exe_module_sp ? exe_module_sp->GetFileSpec().GetPath().c_str () : "<none>");
3499 m_stop_info_override_callback = process_arch.GetStopInfoOverrideCallback();
3503 Process::ConnectRemote (Stream *strm, const char *remote_url)
3506 m_process_input_reader.reset();
3508 // Find the process and its architecture. Make sure it matches the architecture
3509 // of the current Target, and if not adjust it.
3511 Error error (DoConnectRemote (strm, remote_url));
3512 if (error.Success())
3514 if (GetID() != LLDB_INVALID_PROCESS_ID)
3517 StateType state = WaitForProcessStopPrivate(NULL, event_sp);
3519 if (state == eStateStopped || state == eStateCrashed)
3521 // If we attached and actually have a process on the other end, then
3522 // this ended up being the equivalent of an attach.
3525 // This delays passing the stopped event to listeners till
3526 // CompleteAttach gets a chance to complete...
3527 HandlePrivateEvent (event_sp);
3532 if (PrivateStateThreadIsValid ())
3533 ResumePrivateStateThread ();
3535 StartPrivateStateThread ();
3541 Process::PrivateResume ()
3543 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_PROCESS|LIBLLDB_LOG_STEP));
3545 log->Printf("Process::PrivateResume() m_stop_id = %u, public state: %s private state: %s",
3546 m_mod_id.GetStopID(),
3547 StateAsCString(m_public_state.GetValue()),
3548 StateAsCString(m_private_state.GetValue()));
3550 Error error (WillResume());
3551 // Tell the process it is about to resume before the thread list
3552 if (error.Success())
3554 // Now let the thread list know we are about to resume so it
3555 // can let all of our threads know that they are about to be
3556 // resumed. Threads will each be called with
3557 // Thread::WillResume(StateType) where StateType contains the state
3558 // that they are supposed to have when the process is resumed
3559 // (suspended/running/stepping). Threads should also check
3560 // their resume signal in lldb::Thread::GetResumeSignal()
3561 // to see if they are supposed to start back up with a signal.
3562 if (m_thread_list.WillResume())
3564 // Last thing, do the PreResumeActions.
3565 if (!RunPreResumeActions())
3567 error.SetErrorStringWithFormat ("Process::PrivateResume PreResumeActions failed, not resuming.");
3571 m_mod_id.BumpResumeID();
3573 if (error.Success())
3576 m_thread_list.DidResume();
3578 log->Printf ("Process thinks the process has resumed.");
3584 // Somebody wanted to run without running (e.g. we were faking a step from one frame of a set of inlined
3585 // frames that share the same PC to another.) So generate a continue & a stopped event,
3586 // and let the world handle them.
3588 log->Printf ("Process::PrivateResume() asked to simulate a start & stop.");
3590 SetPrivateState(eStateRunning);
3591 SetPrivateState(eStateStopped);
3595 log->Printf ("Process::PrivateResume() got an error \"%s\".", error.AsCString("<unknown error>"));
3600 Process::Halt (bool clear_thread_plans, bool use_run_lock)
3602 if (! StateIsRunningState(m_public_state.GetValue()))
3603 return Error("Process is not running.");
3605 // Don't clear the m_clear_thread_plans_on_stop, only set it to true if
3606 // in case it was already set and some thread plan logic calls halt on its
3608 m_clear_thread_plans_on_stop |= clear_thread_plans;
3610 Listener halt_listener ("lldb.process.halt_listener");
3611 HijackProcessEvents(&halt_listener);
3615 SendAsyncInterrupt();
3617 if (m_public_state.GetValue() == eStateAttaching)
3619 // Don't hijack and eat the eStateExited as the code that was doing
3620 // the attach will be waiting for this event...
3621 RestoreProcessEvents();
3622 SetExitStatus(SIGKILL, "Cancelled async attach.");
3627 // Wait for 10 second for the process to stop.
3628 TimeValue timeout_time;
3629 timeout_time = TimeValue::Now();
3630 timeout_time.OffsetWithSeconds(10);
3631 StateType state = WaitForProcessToStop(&timeout_time, &event_sp, true, &halt_listener,
3632 nullptr, use_run_lock);
3633 RestoreProcessEvents();
3635 if (state == eStateInvalid || ! event_sp)
3637 // We timed out and didn't get a stop event...
3638 return Error("Halt timed out. State = %s", StateAsCString(GetState()));
3641 BroadcastEvent(event_sp);
3647 Process::StopForDestroyOrDetach(lldb::EventSP &exit_event_sp)
3650 if (m_public_state.GetValue() == eStateRunning)
3652 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3654 log->Printf("Process::%s() About to stop.", __FUNCTION__);
3656 ListenerSP listener_sp (new Listener("lldb.Process.StopForDestroyOrDetach.hijack"));
3657 HijackProcessEvents(listener_sp.get());
3659 SendAsyncInterrupt();
3661 // Consume the interrupt event.
3662 TimeValue timeout (TimeValue::Now());
3663 timeout.OffsetWithSeconds(10);
3665 StateType state = WaitForProcessToStop (&timeout, &exit_event_sp, true, listener_sp.get());
3667 RestoreProcessEvents();
3669 // If the process exited while we were waiting for it to stop, put the exited event into
3670 // the shared pointer passed in and return. Our caller doesn't need to do anything else, since
3671 // they don't have a process anymore...
3673 if (state == eStateExited || m_private_state.GetValue() == eStateExited)
3676 log->Printf("Process::%s() Process exited while waiting to stop.", __FUNCTION__);
3680 exit_event_sp.reset(); // It is ok to consume any non-exit stop events
3682 if (state != eStateStopped)
3685 log->Printf("Process::%s() failed to stop, state is: %s", __FUNCTION__, StateAsCString(state));
3686 // If we really couldn't stop the process then we should just error out here, but if the
3687 // lower levels just bobbled sending the event and we really are stopped, then continue on.
3688 StateType private_state = m_private_state.GetValue();
3689 if (private_state != eStateStopped)
3699 Process::Detach (bool keep_stopped)
3701 EventSP exit_event_sp;
3703 m_destroy_in_process = true;
3705 error = WillDetach();
3707 if (error.Success())
3709 if (DetachRequiresHalt())
3711 error = StopForDestroyOrDetach (exit_event_sp);
3712 if (!error.Success())
3714 m_destroy_in_process = false;
3717 else if (exit_event_sp)
3719 // We shouldn't need to do anything else here. There's no process left to detach from...
3720 StopPrivateStateThread();
3721 m_destroy_in_process = false;
3726 m_thread_list.DiscardThreadPlans();
3727 DisableAllBreakpointSites();
3729 error = DoDetach(keep_stopped);
3730 if (error.Success())
3733 StopPrivateStateThread();
3740 m_destroy_in_process = false;
3742 // If we exited when we were waiting for a process to stop, then
3743 // forward the event here so we don't lose the event
3746 // Directly broadcast our exited event because we shut down our
3747 // private state thread above
3748 BroadcastEvent(exit_event_sp);
3751 // If we have been interrupted (to kill us) in the middle of running, we may not end up propagating
3752 // the last events through the event system, in which case we might strand the write lock. Unlock
3753 // it here so when we do to tear down the process we don't get an error destroying the lock.
3755 m_public_run_lock.SetStopped();
3760 Process::Destroy (bool force_kill)
3763 // Tell ourselves we are in the process of destroying the process, so that we don't do any unnecessary work
3764 // that might hinder the destruction. Remember to set this back to false when we are done. That way if the attempt
3765 // failed and the process stays around for some reason it won't be in a confused state.
3768 m_should_detach = false;
3770 if (GetShouldDetach())
3772 // FIXME: This will have to be a process setting:
3773 bool keep_stopped = false;
3774 Detach(keep_stopped);
3777 m_destroy_in_process = true;
3779 Error error (WillDestroy());
3780 if (error.Success())
3782 EventSP exit_event_sp;
3783 if (DestroyRequiresHalt())
3785 error = StopForDestroyOrDetach(exit_event_sp);
3788 if (m_public_state.GetValue() != eStateRunning)
3790 // Ditch all thread plans, and remove all our breakpoints: in case we have to restart the target to
3791 // kill it, we don't want it hitting a breakpoint...
3792 // Only do this if we've stopped, however, since if we didn't manage to halt it above, then
3793 // we're not going to have much luck doing this now.
3794 m_thread_list.DiscardThreadPlans();
3795 DisableAllBreakpointSites();
3798 error = DoDestroy();
3799 if (error.Success())
3802 StopPrivateStateThread();
3804 m_stdio_communication.Disconnect();
3805 m_stdio_communication.StopReadThread();
3806 m_stdin_forward = false;
3808 if (m_process_input_reader)
3810 m_process_input_reader->SetIsDone(true);
3811 m_process_input_reader->Cancel();
3812 m_process_input_reader.reset();
3815 // If we exited when we were waiting for a process to stop, then
3816 // forward the event here so we don't lose the event
3819 // Directly broadcast our exited event because we shut down our
3820 // private state thread above
3821 BroadcastEvent(exit_event_sp);
3824 // If we have been interrupted (to kill us) in the middle of running, we may not end up propagating
3825 // the last events through the event system, in which case we might strand the write lock. Unlock
3826 // it here so when we do to tear down the process we don't get an error destroying the lock.
3827 m_public_run_lock.SetStopped();
3830 m_destroy_in_process = false;
3836 Process::Signal (int signal)
3838 Error error (WillSignal());
3839 if (error.Success())
3841 error = DoSignal(signal);
3842 if (error.Success())
3849 Process::SetUnixSignals(UnixSignalsSP &&signals_sp)
3851 assert (signals_sp && "null signals_sp");
3852 m_unix_signals_sp = signals_sp;
3855 const lldb::UnixSignalsSP &
3856 Process::GetUnixSignals ()
3858 assert (m_unix_signals_sp && "null m_unix_signals_sp");
3859 return m_unix_signals_sp;
3863 Process::GetByteOrder () const
3865 return GetTarget().GetArchitecture().GetByteOrder();
3869 Process::GetAddressByteSize () const
3871 return GetTarget().GetArchitecture().GetAddressByteSize();
3875 Process::ShouldBroadcastEvent (Event *event_ptr)
3877 const StateType state = Process::ProcessEventData::GetStateFromEvent (event_ptr);
3878 bool return_value = true;
3879 Log *log(lldb_private::GetLogIfAnyCategoriesSet(LIBLLDB_LOG_EVENTS | LIBLLDB_LOG_PROCESS));
3883 case eStateDetached:
3885 case eStateUnloaded:
3886 m_stdio_communication.SynchronizeWithReadThread();
3887 m_stdio_communication.Disconnect();
3888 m_stdio_communication.StopReadThread();
3889 m_stdin_forward = false;
3892 case eStateConnected:
3893 case eStateAttaching:
3894 case eStateLaunching:
3895 // These events indicate changes in the state of the debugging session, always report them.
3896 return_value = true;
3899 // We stopped for no apparent reason, don't report it.
3900 return_value = false;
3903 case eStateStepping:
3904 // If we've started the target running, we handle the cases where we
3905 // are already running and where there is a transition from stopped to
3906 // running differently.
3907 // running -> running: Automatically suppress extra running events
3908 // stopped -> running: Report except when there is one or more no votes
3909 // and no yes votes.
3910 SynchronouslyNotifyStateChanged (state);
3911 if (m_force_next_event_delivery)
3912 return_value = true;
3915 switch (m_last_broadcast_state)
3918 case eStateStepping:
3919 // We always suppress multiple runnings with no PUBLIC stop in between.
3920 return_value = false;
3923 // TODO: make this work correctly. For now always report
3924 // run if we aren't running so we don't miss any running
3925 // events. If I run the lldb/test/thread/a.out file and
3926 // break at main.cpp:58, run and hit the breakpoints on
3927 // multiple threads, then somehow during the stepping over
3928 // of all breakpoints no run gets reported.
3930 // This is a transition from stop to run.
3931 switch (m_thread_list.ShouldReportRun (event_ptr))
3934 case eVoteNoOpinion:
3935 return_value = true;
3938 return_value = false;
3947 case eStateSuspended:
3949 // We've stopped. First see if we're going to restart the target.
3950 // If we are going to stop, then we always broadcast the event.
3951 // If we aren't going to stop, let the thread plans decide if we're going to report this event.
3952 // If no thread has an opinion, we don't report it.
3954 m_stdio_communication.SynchronizeWithReadThread();
3955 RefreshStateAfterStop ();
3956 if (ProcessEventData::GetInterruptedFromEvent (event_ptr))
3959 log->Printf ("Process::ShouldBroadcastEvent (%p) stopped due to an interrupt, state: %s",
3960 static_cast<void*>(event_ptr),
3961 StateAsCString(state));
3962 // Even though we know we are going to stop, we should let the threads have a look at the stop,
3963 // so they can properly set their state.
3964 m_thread_list.ShouldStop (event_ptr);
3965 return_value = true;
3969 bool was_restarted = ProcessEventData::GetRestartedFromEvent (event_ptr);
3970 bool should_resume = false;
3972 // It makes no sense to ask "ShouldStop" if we've already been restarted...
3973 // Asking the thread list is also not likely to go well, since we are running again.
3974 // So in that case just report the event.
3977 should_resume = m_thread_list.ShouldStop (event_ptr) == false;
3979 if (was_restarted || should_resume || m_resume_requested)
3981 Vote stop_vote = m_thread_list.ShouldReportStop (event_ptr);
3983 log->Printf ("Process::ShouldBroadcastEvent: should_resume: %i state: %s was_restarted: %i stop_vote: %d.",
3984 should_resume, StateAsCString(state),
3985 was_restarted, stop_vote);
3990 return_value = true;
3992 case eVoteNoOpinion:
3994 return_value = false;
4001 log->Printf ("Process::ShouldBroadcastEvent (%p) Restarting process from state: %s",
4002 static_cast<void*>(event_ptr),
4003 StateAsCString(state));
4004 ProcessEventData::SetRestartedInEvent(event_ptr, true);
4010 return_value = true;
4011 SynchronouslyNotifyStateChanged (state);
4018 // Forcing the next event delivery is a one shot deal. So reset it here.
4019 m_force_next_event_delivery = false;
4021 // We do some coalescing of events (for instance two consecutive running events get coalesced.)
4022 // But we only coalesce against events we actually broadcast. So we use m_last_broadcast_state
4023 // to track that. NB - you can't use "m_public_state.GetValue()" for that purpose, as was originally done,
4024 // because the PublicState reflects the last event pulled off the queue, and there may be several
4025 // events stacked up on the queue unserviced. So the PublicState may not reflect the last broadcasted event
4026 // yet. m_last_broadcast_state gets updated here.
4029 m_last_broadcast_state = state;
4032 log->Printf ("Process::ShouldBroadcastEvent (%p) => new state: %s, last broadcast state: %s - %s",
4033 static_cast<void*>(event_ptr), StateAsCString(state),
4034 StateAsCString(m_last_broadcast_state),
4035 return_value ? "YES" : "NO");
4036 return return_value;
4040 Process::StartPrivateStateThread (bool is_secondary_thread)
4042 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EVENTS));
4044 bool already_running = PrivateStateThreadIsValid ();
4046 log->Printf ("Process::%s()%s ", __FUNCTION__, already_running ? " already running" : " starting private state thread");
4048 if (!is_secondary_thread && already_running)
4051 // Create a thread that watches our internal state and controls which
4052 // events make it to clients (into the DCProcess event queue).
4053 char thread_name[1024];
4055 if (HostInfo::GetMaxThreadNameLength() <= 30)
4057 // On platforms with abbreviated thread name lengths, choose thread names that fit within the limit.
4058 if (already_running)
4059 snprintf(thread_name, sizeof(thread_name), "intern-state-OV");
4061 snprintf(thread_name, sizeof(thread_name), "intern-state");
4065 if (already_running)
4066 snprintf(thread_name, sizeof(thread_name), "<lldb.process.internal-state-override(pid=%" PRIu64 ")>", GetID());
4068 snprintf(thread_name, sizeof(thread_name), "<lldb.process.internal-state(pid=%" PRIu64 ")>", GetID());
4071 // Create the private state thread, and start it running.
4072 PrivateStateThreadArgs args = {this, is_secondary_thread};
4073 m_private_state_thread = ThreadLauncher::LaunchThread(thread_name, Process::PrivateStateThread, (void *) &args, NULL, 8 * 1024 * 1024);
4074 if (m_private_state_thread.IsJoinable())
4076 ResumePrivateStateThread();
4084 Process::PausePrivateStateThread ()
4086 ControlPrivateStateThread (eBroadcastInternalStateControlPause);
4090 Process::ResumePrivateStateThread ()
4092 ControlPrivateStateThread (eBroadcastInternalStateControlResume);
4096 Process::StopPrivateStateThread ()
4098 if (PrivateStateThreadIsValid ())
4099 ControlPrivateStateThread (eBroadcastInternalStateControlStop);
4102 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_PROCESS));
4104 log->Printf ("Went to stop the private state thread, but it was already invalid.");
4109 Process::ControlPrivateStateThread (uint32_t signal)
4111 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_PROCESS));
4113 assert (signal == eBroadcastInternalStateControlStop ||
4114 signal == eBroadcastInternalStateControlPause ||
4115 signal == eBroadcastInternalStateControlResume);
4118 log->Printf ("Process::%s (signal = %d)", __FUNCTION__, signal);
4120 // Signal the private state thread. First we should copy this is case the
4121 // thread starts exiting since the private state thread will NULL this out
4123 HostThread private_state_thread(m_private_state_thread);
4124 if (private_state_thread.IsJoinable())
4126 TimeValue timeout_time;
4129 m_private_state_control_broadcaster.BroadcastEvent (signal, NULL);
4131 timeout_time = TimeValue::Now();
4132 timeout_time.OffsetWithSeconds(2);
4134 log->Printf ("Sending control event of type: %d.", signal);
4135 m_private_state_control_wait.WaitForValueEqualTo (true, &timeout_time, &timed_out);
4136 m_private_state_control_wait.SetValue (false, eBroadcastNever);
4138 if (signal == eBroadcastInternalStateControlStop)
4142 Error error = private_state_thread.Cancel();
4144 log->Printf ("Timed out responding to the control event, cancel got error: \"%s\".", error.AsCString());
4149 log->Printf ("The control event killed the private state thread without having to cancel.");
4152 thread_result_t result = NULL;
4153 private_state_thread.Join(&result);
4154 m_private_state_thread.Reset();
4160 log->Printf ("Private state thread already dead, no need to signal it to stop.");
4165 Process::SendAsyncInterrupt ()
4167 if (PrivateStateThreadIsValid())
4168 m_private_state_broadcaster.BroadcastEvent (Process::eBroadcastBitInterrupt, NULL);
4170 BroadcastEvent (Process::eBroadcastBitInterrupt, NULL);
4174 Process::HandlePrivateEvent (EventSP &event_sp)
4176 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
4177 m_resume_requested = false;
4179 const StateType new_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
4181 // First check to see if anybody wants a shot at this event:
4182 if (m_next_event_action_ap.get() != NULL)
4184 NextEventAction::EventActionResult action_result = m_next_event_action_ap->PerformAction(event_sp);
4186 log->Printf ("Ran next event action, result was %d.", action_result);
4188 switch (action_result)
4190 case NextEventAction::eEventActionSuccess:
4191 SetNextEventAction(NULL);
4194 case NextEventAction::eEventActionRetry:
4197 case NextEventAction::eEventActionExit:
4198 // Handle Exiting Here. If we already got an exited event,
4199 // we should just propagate it. Otherwise, swallow this event,
4200 // and set our state to exit so the next event will kill us.
4201 if (new_state != eStateExited)
4203 // FIXME: should cons up an exited event, and discard this one.
4204 SetExitStatus(0, m_next_event_action_ap->GetExitString());
4205 SetNextEventAction(NULL);
4208 SetNextEventAction(NULL);
4213 // See if we should broadcast this state to external clients?
4214 const bool should_broadcast = ShouldBroadcastEvent (event_sp.get());
4216 if (should_broadcast)
4218 const bool is_hijacked = IsHijackedForEvent(eBroadcastBitStateChanged);
4221 log->Printf ("Process::%s (pid = %" PRIu64 ") broadcasting new state %s (old state %s) to %s",
4224 StateAsCString(new_state),
4225 StateAsCString (GetState ()),
4226 is_hijacked ? "hijacked" : "public");
4228 Process::ProcessEventData::SetUpdateStateOnRemoval(event_sp.get());
4229 if (StateIsRunningState (new_state))
4231 // Only push the input handler if we aren't fowarding events,
4232 // as this means the curses GUI is in use...
4233 // Or don't push it if we are launching since it will come up stopped.
4234 if (!GetTarget().GetDebugger().IsForwardingEvents() && new_state != eStateLaunching &&
4235 new_state != eStateAttaching)
4237 PushProcessIOHandler ();
4238 m_iohandler_sync.SetValue(m_iohandler_sync.GetValue()+1, eBroadcastAlways);
4240 log->Printf("Process::%s updated m_iohandler_sync to %d", __FUNCTION__, m_iohandler_sync.GetValue());
4243 else if (StateIsStoppedState(new_state, false))
4245 if (!Process::ProcessEventData::GetRestartedFromEvent(event_sp.get()))
4247 // If the lldb_private::Debugger is handling the events, we don't
4248 // want to pop the process IOHandler here, we want to do it when
4249 // we receive the stopped event so we can carefully control when
4250 // the process IOHandler is popped because when we stop we want to
4251 // display some text stating how and why we stopped, then maybe some
4252 // process/thread/frame info, and then we want the "(lldb) " prompt
4253 // to show up. If we pop the process IOHandler here, then we will
4254 // cause the command interpreter to become the top IOHandler after
4255 // the process pops off and it will update its prompt right away...
4256 // See the Debugger.cpp file where it calls the function as
4257 // "process_sp->PopProcessIOHandler()" to see where I am talking about.
4258 // Otherwise we end up getting overlapping "(lldb) " prompts and
4261 // If we aren't handling the events in the debugger (which is indicated
4262 // by "m_target.GetDebugger().IsHandlingEvents()" returning false) or we
4263 // are hijacked, then we always pop the process IO handler manually.
4264 // Hijacking happens when the internal process state thread is running
4265 // thread plans, or when commands want to run in synchronous mode
4266 // and they call "process->WaitForProcessToStop()". An example of something
4267 // that will hijack the events is a simple expression:
4269 // (lldb) expr (int)puts("hello")
4271 // This will cause the internal process state thread to resume and halt
4272 // the process (and _it_ will hijack the eBroadcastBitStateChanged
4273 // events) and we do need the IO handler to be pushed and popped
4276 if (is_hijacked || GetTarget().GetDebugger().IsHandlingEvents() == false)
4277 PopProcessIOHandler ();
4281 BroadcastEvent (event_sp);
4287 log->Printf ("Process::%s (pid = %" PRIu64 ") suppressing state %s (old state %s): should_broadcast == false",
4290 StateAsCString(new_state),
4291 StateAsCString (GetState ()));
4297 Process::HaltPrivate()
4300 Error error (WillHalt());
4304 // Ask the process subclass to actually halt our process
4306 error = DoHalt(caused_stop);
4313 Process::PrivateStateThread (void *arg)
4315 PrivateStateThreadArgs *real_args = static_cast<PrivateStateThreadArgs *> (arg);
4316 thread_result_t result = real_args->process->RunPrivateStateThread(real_args->is_secondary_thread);
4321 Process::RunPrivateStateThread (bool is_secondary_thread)
4323 bool control_only = true;
4324 m_private_state_control_wait.SetValue (false, eBroadcastNever);
4326 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
4328 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") thread starting...",
4329 __FUNCTION__, static_cast<void*>(this), GetID());
4331 bool exit_now = false;
4332 bool interrupt_requested = false;
4336 WaitForEventsPrivate (NULL, event_sp, control_only);
4337 if (event_sp->BroadcasterIs(&m_private_state_control_broadcaster))
4340 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") got a control event: %d",
4341 __FUNCTION__, static_cast<void*>(this), GetID(),
4342 event_sp->GetType());
4344 switch (event_sp->GetType())
4346 case eBroadcastInternalStateControlStop:
4348 break; // doing any internal state management below
4350 case eBroadcastInternalStateControlPause:
4351 control_only = true;
4354 case eBroadcastInternalStateControlResume:
4355 control_only = false;
4359 m_private_state_control_wait.SetValue (true, eBroadcastAlways);
4362 else if (event_sp->GetType() == eBroadcastBitInterrupt)
4364 if (m_public_state.GetValue() == eStateAttaching)
4367 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") woke up with an interrupt while attaching - forwarding interrupt.",
4368 __FUNCTION__, static_cast<void*>(this),
4370 BroadcastEvent (eBroadcastBitInterrupt, NULL);
4372 else if(StateIsRunningState(m_last_broadcast_state))
4375 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") woke up with an interrupt - Halting.",
4376 __FUNCTION__, static_cast<void*>(this),
4378 Error error = HaltPrivate();
4379 if (error.Fail() && log)
4380 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") failed to halt the process: %s",
4381 __FUNCTION__, static_cast<void*>(this),
4382 GetID(), error.AsCString());
4383 // Halt should generate a stopped event. Make a note of the fact that we were
4384 // doing the interrupt, so we can set the interrupted flag after we receive the
4385 // event. We deliberately set this to true even if HaltPrivate failed, so that we
4386 // can interrupt on the next natural stop.
4387 interrupt_requested = true;
4391 // This can happen when someone (e.g. Process::Halt) sees that we are running and
4392 // sends an interrupt request, but the process actually stops before we receive
4393 // it. In that case, we can just ignore the request. We use
4394 // m_last_broadcast_state, because the Stopped event may not have been popped of
4395 // the event queue yet, which is when the public state gets updated.
4397 log->Printf("Process::%s ignoring interrupt as we have already stopped.", __FUNCTION__);
4402 const StateType internal_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
4404 if (internal_state != eStateInvalid)
4406 if (m_clear_thread_plans_on_stop &&
4407 StateIsStoppedState(internal_state, true))
4409 m_clear_thread_plans_on_stop = false;
4410 m_thread_list.DiscardThreadPlans();
4413 if (interrupt_requested)
4415 if (StateIsStoppedState (internal_state, true))
4417 // We requested the interrupt, so mark this as such in the stop event so
4418 // clients can tell an interrupted process from a natural stop
4419 ProcessEventData::SetInterruptedInEvent (event_sp.get(), true);
4420 interrupt_requested = false;
4424 log->Printf("Process::%s interrupt_requested, but a non-stopped state '%s' received.",
4425 __FUNCTION__, StateAsCString(internal_state));
4429 HandlePrivateEvent (event_sp);
4432 if (internal_state == eStateInvalid ||
4433 internal_state == eStateExited ||
4434 internal_state == eStateDetached )
4437 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") about to exit with internal state %s...",
4438 __FUNCTION__, static_cast<void*>(this), GetID(),
4439 StateAsCString(internal_state));
4445 // Verify log is still enabled before attempting to write to it...
4447 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") thread exiting...",
4448 __FUNCTION__, static_cast<void*>(this), GetID());
4450 // If we are a secondary thread, then the primary thread we are working for will have already
4451 // acquired the public_run_lock, and isn't done with what it was doing yet, so don't
4452 // try to change it on the way out.
4453 if (!is_secondary_thread)
4454 m_public_run_lock.SetStopped();
4455 m_private_state_control_wait.SetValue (true, eBroadcastAlways);
4456 m_private_state_thread.Reset();
4460 //------------------------------------------------------------------
4461 // Process Event Data
4462 //------------------------------------------------------------------
4464 Process::ProcessEventData::ProcessEventData () :
4467 m_state (eStateInvalid),
4468 m_restarted (false),
4470 m_interrupted (false)
4474 Process::ProcessEventData::ProcessEventData (const ProcessSP &process_sp, StateType state) :
4478 m_restarted (false),
4480 m_interrupted (false)
4483 m_process_wp = process_sp;
4486 Process::ProcessEventData::~ProcessEventData() = default;
4489 Process::ProcessEventData::GetFlavorString ()
4491 static ConstString g_flavor ("Process::ProcessEventData");
4496 Process::ProcessEventData::GetFlavor () const
4498 return ProcessEventData::GetFlavorString ();
4502 Process::ProcessEventData::DoOnRemoval (Event *event_ptr)
4504 ProcessSP process_sp(m_process_wp.lock());
4509 // This function gets called twice for each event, once when the event gets pulled
4510 // off of the private process event queue, and then any number of times, first when it gets pulled off of
4511 // the public event queue, then other times when we're pretending that this is where we stopped at the
4512 // end of expression evaluation. m_update_state is used to distinguish these
4513 // three cases; it is 0 when we're just pulling it off for private handling,
4514 // and > 1 for expression evaluation, and we don't want to do the breakpoint command handling then.
4515 if (m_update_state != 1)
4518 process_sp->SetPublicState (m_state, Process::ProcessEventData::GetRestartedFromEvent(event_ptr));
4520 // If this is a halt event, even if the halt stopped with some reason other than a plain interrupt (e.g. we had
4521 // already stopped for a breakpoint when the halt request came through) don't do the StopInfo actions, as they may
4522 // end up restarting the process.
4526 // If we're stopped and haven't restarted, then do the StopInfo actions here:
4527 if (m_state == eStateStopped && ! m_restarted)
4529 // Let process subclasses know we are about to do a public stop and
4530 // do anything they might need to in order to speed up register and
4532 process_sp->WillPublicStop();
4534 ThreadList &curr_thread_list = process_sp->GetThreadList();
4535 uint32_t num_threads = curr_thread_list.GetSize();
4538 // The actions might change one of the thread's stop_info's opinions about whether we should
4539 // stop the process, so we need to query that as we go.
4541 // One other complication here, is that we try to catch any case where the target has run (except for expressions)
4542 // and immediately exit, but if we get that wrong (which is possible) then the thread list might have changed, and
4543 // that would cause our iteration here to crash. We could make a copy of the thread list, but we'd really like
4544 // 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
4545 // against this list & bag out if anything differs.
4546 std::vector<uint32_t> thread_index_array(num_threads);
4547 for (idx = 0; idx < num_threads; ++idx)
4548 thread_index_array[idx] = curr_thread_list.GetThreadAtIndex(idx)->GetIndexID();
4550 // Use this to track whether we should continue from here. We will only continue the target running if
4551 // no thread says we should stop. Of course if some thread's PerformAction actually sets the target running,
4552 // then it doesn't matter what the other threads say...
4554 bool still_should_stop = false;
4556 // Sometimes - for instance if we have a bug in the stub we are talking to, we stop but no thread has a
4557 // valid stop reason. In that case we should just stop, because we have no way of telling what the right
4558 // thing to do is, and it's better to let the user decide than continue behind their backs.
4560 bool does_anybody_have_an_opinion = false;
4562 for (idx = 0; idx < num_threads; ++idx)
4564 curr_thread_list = process_sp->GetThreadList();
4565 if (curr_thread_list.GetSize() != num_threads)
4567 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STEP | LIBLLDB_LOG_PROCESS));
4569 log->Printf("Number of threads changed from %u to %u while processing event.", num_threads, curr_thread_list.GetSize());
4573 lldb::ThreadSP thread_sp = curr_thread_list.GetThreadAtIndex(idx);
4575 if (thread_sp->GetIndexID() != thread_index_array[idx])
4577 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STEP | LIBLLDB_LOG_PROCESS));
4579 log->Printf("The thread at position %u changed from %u to %u while processing event.",
4581 thread_index_array[idx],
4582 thread_sp->GetIndexID());
4586 StopInfoSP stop_info_sp = thread_sp->GetStopInfo ();
4587 if (stop_info_sp && stop_info_sp->IsValid())
4589 does_anybody_have_an_opinion = true;
4590 bool this_thread_wants_to_stop;
4591 if (stop_info_sp->GetOverrideShouldStop())
4593 this_thread_wants_to_stop = stop_info_sp->GetOverriddenShouldStopValue();
4597 stop_info_sp->PerformAction(event_ptr);
4598 // The stop action might restart the target. If it does, then we want to mark that in the
4599 // event so that whoever is receiving it will know to wait for the running event and reflect
4600 // that state appropriately.
4601 // We also need to stop processing actions, since they aren't expecting the target to be running.
4603 // FIXME: we might have run.
4604 if (stop_info_sp->HasTargetRunSinceMe())
4606 SetRestarted (true);
4610 this_thread_wants_to_stop = stop_info_sp->ShouldStop(event_ptr);
4613 if (still_should_stop == false)
4614 still_should_stop = this_thread_wants_to_stop;
4618 if (!GetRestarted())
4620 if (!still_should_stop && does_anybody_have_an_opinion)
4622 // We've been asked to continue, so do that here.
4624 // Use the public resume method here, since this is just
4625 // extending a public resume.
4626 process_sp->PrivateResume();
4630 // If we didn't restart, run the Stop Hooks here:
4631 // They might also restart the target, so watch for that.
4632 process_sp->GetTarget().RunStopHooks();
4633 if (process_sp->GetPrivateState() == eStateRunning)
4641 Process::ProcessEventData::Dump (Stream *s) const
4643 ProcessSP process_sp(m_process_wp.lock());
4646 s->Printf(" process = %p (pid = %" PRIu64 "), ",
4647 static_cast<void*>(process_sp.get()), process_sp->GetID());
4649 s->PutCString(" process = NULL, ");
4651 s->Printf("state = %s", StateAsCString(GetState()));
4654 const Process::ProcessEventData *
4655 Process::ProcessEventData::GetEventDataFromEvent (const Event *event_ptr)
4659 const EventData *event_data = event_ptr->GetData();
4660 if (event_data && event_data->GetFlavor() == ProcessEventData::GetFlavorString())
4661 return static_cast <const ProcessEventData *> (event_ptr->GetData());
4667 Process::ProcessEventData::GetProcessFromEvent (const Event *event_ptr)
4669 ProcessSP process_sp;
4670 const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
4672 process_sp = data->GetProcessSP();
4677 Process::ProcessEventData::GetStateFromEvent (const Event *event_ptr)
4679 const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
4681 return eStateInvalid;
4683 return data->GetState();
4687 Process::ProcessEventData::GetRestartedFromEvent (const Event *event_ptr)
4689 const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
4693 return data->GetRestarted();
4697 Process::ProcessEventData::SetRestartedInEvent (Event *event_ptr, bool new_value)
4699 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4701 data->SetRestarted(new_value);
4705 Process::ProcessEventData::GetNumRestartedReasons(const Event *event_ptr)
4707 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4709 return data->GetNumRestartedReasons();
4715 Process::ProcessEventData::GetRestartedReasonAtIndex(const Event *event_ptr, size_t idx)
4717 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4719 return data->GetRestartedReasonAtIndex(idx);
4725 Process::ProcessEventData::AddRestartedReason (Event *event_ptr, const char *reason)
4727 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4729 data->AddRestartedReason(reason);
4733 Process::ProcessEventData::GetInterruptedFromEvent (const Event *event_ptr)
4735 const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
4739 return data->GetInterrupted ();
4743 Process::ProcessEventData::SetInterruptedInEvent (Event *event_ptr, bool new_value)
4745 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4747 data->SetInterrupted(new_value);
4751 Process::ProcessEventData::SetUpdateStateOnRemoval (Event *event_ptr)
4753 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4756 data->SetUpdateStateOnRemoval();
4763 Process::CalculateTarget ()
4765 return m_target_sp.lock();
4769 Process::CalculateExecutionContext (ExecutionContext &exe_ctx)
4771 exe_ctx.SetTargetPtr (&GetTarget());
4772 exe_ctx.SetProcessPtr (this);
4773 exe_ctx.SetThreadPtr(NULL);
4774 exe_ctx.SetFramePtr (NULL);
4778 //Process::ListProcessesMatchingName (const char *name, StringList &matches, std::vector<lldb::pid_t> &pids)
4784 //Process::GetArchSpecForExistingProcess (lldb::pid_t pid)
4786 // return Host::GetArchSpecForExistingProcess (pid);
4790 //Process::GetArchSpecForExistingProcess (const char *process_name)
4792 // return Host::GetArchSpecForExistingProcess (process_name);
4796 Process::AppendSTDOUT (const char * s, size_t len)
4798 Mutex::Locker locker (m_stdio_communication_mutex);
4799 m_stdout_data.append (s, len);
4800 BroadcastEventIfUnique (eBroadcastBitSTDOUT, new ProcessEventData (shared_from_this(), GetState()));
4804 Process::AppendSTDERR (const char * s, size_t len)
4806 Mutex::Locker locker (m_stdio_communication_mutex);
4807 m_stderr_data.append (s, len);
4808 BroadcastEventIfUnique (eBroadcastBitSTDERR, new ProcessEventData (shared_from_this(), GetState()));
4812 Process::BroadcastAsyncProfileData(const std::string &one_profile_data)
4814 Mutex::Locker locker (m_profile_data_comm_mutex);
4815 m_profile_data.push_back(one_profile_data);
4816 BroadcastEventIfUnique (eBroadcastBitProfileData, new ProcessEventData (shared_from_this(), GetState()));
4820 Process::GetAsyncProfileData (char *buf, size_t buf_size, Error &error)
4822 Mutex::Locker locker(m_profile_data_comm_mutex);
4823 if (m_profile_data.empty())
4826 std::string &one_profile_data = m_profile_data.front();
4827 size_t bytes_available = one_profile_data.size();
4828 if (bytes_available > 0)
4830 Log *log (lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
4832 log->Printf ("Process::GetProfileData (buf = %p, size = %" PRIu64 ")",
4833 static_cast<void*>(buf),
4834 static_cast<uint64_t>(buf_size));
4835 if (bytes_available > buf_size)
4837 memcpy(buf, one_profile_data.c_str(), buf_size);
4838 one_profile_data.erase(0, buf_size);
4839 bytes_available = buf_size;
4843 memcpy(buf, one_profile_data.c_str(), bytes_available);
4844 m_profile_data.erase(m_profile_data.begin());
4847 return bytes_available;
4850 //------------------------------------------------------------------
4852 //------------------------------------------------------------------
4855 Process::GetSTDOUT (char *buf, size_t buf_size, Error &error)
4857 Mutex::Locker locker(m_stdio_communication_mutex);
4858 size_t bytes_available = m_stdout_data.size();
4859 if (bytes_available > 0)
4861 Log *log (lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
4863 log->Printf ("Process::GetSTDOUT (buf = %p, size = %" PRIu64 ")",
4864 static_cast<void*>(buf),
4865 static_cast<uint64_t>(buf_size));
4866 if (bytes_available > buf_size)
4868 memcpy(buf, m_stdout_data.c_str(), buf_size);
4869 m_stdout_data.erase(0, buf_size);
4870 bytes_available = buf_size;
4874 memcpy(buf, m_stdout_data.c_str(), bytes_available);
4875 m_stdout_data.clear();
4878 return bytes_available;
4882 Process::GetSTDERR (char *buf, size_t buf_size, Error &error)
4884 Mutex::Locker locker(m_stdio_communication_mutex);
4885 size_t bytes_available = m_stderr_data.size();
4886 if (bytes_available > 0)
4888 Log *log (lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
4890 log->Printf ("Process::GetSTDERR (buf = %p, size = %" PRIu64 ")",
4891 static_cast<void*>(buf),
4892 static_cast<uint64_t>(buf_size));
4893 if (bytes_available > buf_size)
4895 memcpy(buf, m_stderr_data.c_str(), buf_size);
4896 m_stderr_data.erase(0, buf_size);
4897 bytes_available = buf_size;
4901 memcpy(buf, m_stderr_data.c_str(), bytes_available);
4902 m_stderr_data.clear();
4905 return bytes_available;
4909 Process::STDIOReadThreadBytesReceived (void *baton, const void *src, size_t src_len)
4911 Process *process = (Process *) baton;
4912 process->AppendSTDOUT (static_cast<const char *>(src), src_len);
4915 class IOHandlerProcessSTDIO :
4919 IOHandlerProcessSTDIO (Process *process,
4921 IOHandler(process->GetTarget().GetDebugger(), IOHandler::Type::ProcessIO),
4922 m_process (process),
4924 m_write_file (write_fd, false),
4927 m_pipe.CreateNew(false);
4928 m_read_file.SetDescriptor(GetInputFD(), false);
4931 ~IOHandlerProcessSTDIO() override = default;
4933 // Each IOHandler gets to run until it is done. It should read data
4934 // from the "in" and place output into "out" and "err and return
4939 if (!m_read_file.IsValid() || !m_write_file.IsValid() || !m_pipe.CanRead() || !m_pipe.CanWrite())
4946 const int read_fd = m_read_file.GetDescriptor();
4947 TerminalState terminal_state;
4948 terminal_state.Save (read_fd, false);
4949 Terminal terminal(read_fd);
4950 terminal.SetCanonical(false);
4951 terminal.SetEcho(false);
4952 // FD_ZERO, FD_SET are not supported on windows
4954 const int pipe_read_fd = m_pipe.GetReadFileDescriptor();
4955 while (!GetIsDone())
4958 FD_ZERO (&read_fdset);
4959 FD_SET (read_fd, &read_fdset);
4960 FD_SET (pipe_read_fd, &read_fdset);
4961 const int nfds = std::max<int>(read_fd, pipe_read_fd) + 1;
4962 int num_set_fds = select (nfds, &read_fdset, NULL, NULL, NULL);
4963 if (num_set_fds < 0)
4965 const int select_errno = errno;
4967 if (select_errno != EINTR)
4970 else if (num_set_fds > 0)
4974 if (FD_ISSET (read_fd, &read_fdset))
4977 if (m_read_file.Read(&ch, n).Success() && n == 1)
4979 if (m_write_file.Write(&ch, n).Fail() || n != 1)
4985 if (FD_ISSET (pipe_read_fd, &read_fdset))
4988 // Consume the interrupt byte
4989 Error error = m_pipe.Read(&ch, 1, bytes_read);
4990 if (error.Success())
4998 if (StateIsRunningState(m_process->GetState()))
4999 m_process->SendAsyncInterrupt();
5007 terminal_state.Restore();
5013 char ch = 'q'; // Send 'q' for quit
5014 size_t bytes_written = 0;
5015 m_pipe.Write(&ch, 1, bytes_written);
5019 Interrupt () override
5021 // Do only things that are safe to do in an interrupt context (like in
5022 // a SIGINT handler), like write 1 byte to a file descriptor. This will
5023 // interrupt the IOHandlerProcessSTDIO::Run() and we can look at the byte
5024 // that was written to the pipe and then call m_process->SendAsyncInterrupt()
5025 // from a much safer location in code.
5028 char ch = 'i'; // Send 'i' for interrupt
5029 size_t bytes_written = 0;
5030 Error result = m_pipe.Write(&ch, 1, bytes_written);
5031 return result.Success();
5035 // This IOHandler might be pushed on the stack, but not being run currently
5036 // so do the right thing if we aren't actively watching for STDIN by sending
5037 // the interrupt to the process. Otherwise the write to the pipe above would
5038 // do nothing. This can happen when the command interpreter is running and
5039 // gets a "expression ...". It will be on the IOHandler thread and sending
5040 // the input is complete to the delegate which will cause the expression to
5041 // run, which will push the process IO handler, but not run it.
5043 if (StateIsRunningState(m_process->GetState()))
5045 m_process->SendAsyncInterrupt();
5059 File m_read_file; // Read from this file (usually actual STDIN for LLDB
5060 File m_write_file; // Write to this file (usually the master pty for getting io to debuggee)
5065 Process::SetSTDIOFileDescriptor (int fd)
5067 // First set up the Read Thread for reading/handling process I/O
5069 std::unique_ptr<ConnectionFileDescriptor> conn_ap (new ConnectionFileDescriptor (fd, true));
5073 m_stdio_communication.SetConnection (conn_ap.release());
5074 if (m_stdio_communication.IsConnected())
5076 m_stdio_communication.SetReadThreadBytesReceivedCallback (STDIOReadThreadBytesReceived, this);
5077 m_stdio_communication.StartReadThread();
5079 // Now read thread is set up, set up input reader.
5081 if (!m_process_input_reader.get())
5082 m_process_input_reader.reset (new IOHandlerProcessSTDIO (this, fd));
5088 Process::ProcessIOHandlerIsActive ()
5090 IOHandlerSP io_handler_sp (m_process_input_reader);
5092 return GetTarget().GetDebugger().IsTopIOHandler (io_handler_sp);
5096 Process::PushProcessIOHandler ()
5098 IOHandlerSP io_handler_sp (m_process_input_reader);
5101 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
5103 log->Printf("Process::%s pushing IO handler", __FUNCTION__);
5105 io_handler_sp->SetIsDone(false);
5106 GetTarget().GetDebugger().PushIOHandler (io_handler_sp);
5113 Process::PopProcessIOHandler ()
5115 IOHandlerSP io_handler_sp (m_process_input_reader);
5117 return GetTarget().GetDebugger().PopIOHandler (io_handler_sp);
5121 // The process needs to know about installed plug-ins
5123 Process::SettingsInitialize ()
5125 Thread::SettingsInitialize ();
5129 Process::SettingsTerminate ()
5131 Thread::SettingsTerminate ();
5136 // RestorePlanState is used to record the "is private", "is master" and "okay to discard" fields of
5137 // the plan we are running, and reset it on Clean or on destruction.
5138 // It will only reset the state once, so you can call Clean and then monkey with the state and it
5139 // won't get reset on you again.
5141 class RestorePlanState
5144 RestorePlanState (lldb::ThreadPlanSP thread_plan_sp) :
5145 m_thread_plan_sp(thread_plan_sp),
5146 m_already_reset(false)
5148 if (m_thread_plan_sp)
5150 m_private = m_thread_plan_sp->GetPrivate();
5151 m_is_master = m_thread_plan_sp->IsMasterPlan();
5152 m_okay_to_discard = m_thread_plan_sp->OkayToDiscard();
5164 if (!m_already_reset && m_thread_plan_sp)
5166 m_already_reset = true;
5167 m_thread_plan_sp->SetPrivate(m_private);
5168 m_thread_plan_sp->SetIsMasterPlan (m_is_master);
5169 m_thread_plan_sp->SetOkayToDiscard(m_okay_to_discard);
5174 lldb::ThreadPlanSP m_thread_plan_sp;
5175 bool m_already_reset;
5178 bool m_okay_to_discard;
5180 } // anonymous namespace
5183 Process::RunThreadPlan (ExecutionContext &exe_ctx,
5184 lldb::ThreadPlanSP &thread_plan_sp,
5185 const EvaluateExpressionOptions &options,
5188 ExpressionResults return_value = eExpressionSetupError;
5190 if (thread_plan_sp.get() == NULL)
5192 errors.Printf("RunThreadPlan called with empty thread plan.");
5193 return eExpressionSetupError;
5196 if (!thread_plan_sp->ValidatePlan(NULL))
5198 errors.Printf ("RunThreadPlan called with an invalid thread plan.");
5199 return eExpressionSetupError;
5202 if (exe_ctx.GetProcessPtr() != this)
5204 errors.Printf("RunThreadPlan called on wrong process.");
5205 return eExpressionSetupError;
5208 Thread *thread = exe_ctx.GetThreadPtr();
5211 errors.Printf("RunThreadPlan called with invalid thread.");
5212 return eExpressionSetupError;
5215 // We need to change some of the thread plan attributes for the thread plan runner. This will restore them
5216 // when we are done:
5218 RestorePlanState thread_plan_restorer(thread_plan_sp);
5220 // We rely on the thread plan we are running returning "PlanCompleted" if when it successfully completes.
5221 // For that to be true the plan can't be private - since private plans suppress themselves in the
5222 // GetCompletedPlan call.
5224 thread_plan_sp->SetPrivate(false);
5226 // The plans run with RunThreadPlan also need to be terminal master plans or when they are done we will end
5227 // up asking the plan above us whether we should stop, which may give the wrong answer.
5229 thread_plan_sp->SetIsMasterPlan (true);
5230 thread_plan_sp->SetOkayToDiscard(false);
5232 if (m_private_state.GetValue() != eStateStopped)
5234 errors.Printf ("RunThreadPlan called while the private state was not stopped.");
5235 return eExpressionSetupError;
5238 // Save the thread & frame from the exe_ctx for restoration after we run
5239 const uint32_t thread_idx_id = thread->GetIndexID();
5240 StackFrameSP selected_frame_sp = thread->GetSelectedFrame();
5241 if (!selected_frame_sp)
5243 thread->SetSelectedFrame(0);
5244 selected_frame_sp = thread->GetSelectedFrame();
5245 if (!selected_frame_sp)
5247 errors.Printf("RunThreadPlan called without a selected frame on thread %d", thread_idx_id);
5248 return eExpressionSetupError;
5252 StackID ctx_frame_id = selected_frame_sp->GetStackID();
5254 // N.B. Running the target may unset the currently selected thread and frame. We don't want to do that either,
5255 // so we should arrange to reset them as well.
5257 lldb::ThreadSP selected_thread_sp = GetThreadList().GetSelectedThread();
5259 uint32_t selected_tid;
5260 StackID selected_stack_id;
5261 if (selected_thread_sp)
5263 selected_tid = selected_thread_sp->GetIndexID();
5264 selected_stack_id = selected_thread_sp->GetSelectedFrame()->GetStackID();
5268 selected_tid = LLDB_INVALID_THREAD_ID;
5271 HostThread backup_private_state_thread;
5272 lldb::StateType old_state = eStateInvalid;
5273 lldb::ThreadPlanSP stopper_base_plan_sp;
5275 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STEP | LIBLLDB_LOG_PROCESS));
5276 if (m_private_state_thread.EqualsThread(Host::GetCurrentThread()))
5278 // Yikes, we are running on the private state thread! So we can't wait for public events on this thread, since
5279 // we are the thread that is generating public events.
5280 // The simplest thing to do is to spin up a temporary thread to handle private state thread events while
5281 // we are fielding public events here.
5283 log->Printf ("Running thread plan on private state thread, spinning up another state thread to handle the events.");
5285 backup_private_state_thread = m_private_state_thread;
5287 // One other bit of business: we want to run just this thread plan and anything it pushes, and then stop,
5288 // returning control here.
5289 // But in the normal course of things, the plan above us on the stack would be given a shot at the stop
5290 // event before deciding to stop, and we don't want that. So we insert a "stopper" base plan on the stack
5291 // before the plan we want to run. Since base plans always stop and return control to the user, that will
5292 // do just what we want.
5293 stopper_base_plan_sp.reset(new ThreadPlanBase (*thread));
5294 thread->QueueThreadPlan (stopper_base_plan_sp, false);
5295 // Have to make sure our public state is stopped, since otherwise the reporting logic below doesn't work correctly.
5296 old_state = m_public_state.GetValue();
5297 m_public_state.SetValueNoLock(eStateStopped);
5299 // Now spin up the private state thread:
5300 StartPrivateStateThread(true);
5303 thread->QueueThreadPlan(thread_plan_sp, false); // This used to pass "true" does that make sense?
5305 if (options.GetDebug())
5307 // In this case, we aren't actually going to run, we just want to stop right away.
5308 // Flush this thread so we will refetch the stacks and show the correct backtrace.
5309 // FIXME: To make this prettier we should invent some stop reason for this, but that
5310 // is only cosmetic, and this functionality is only of use to lldb developers who can
5311 // live with not pretty...
5313 return eExpressionStoppedForDebug;
5316 Listener listener("lldb.process.listener.run-thread-plan");
5318 lldb::EventSP event_to_broadcast_sp;
5321 // This process event hijacker Hijacks the Public events and its destructor makes sure that the process events get
5322 // restored on exit to the function.
5324 // If the event needs to propagate beyond the hijacker (e.g., the process exits during execution), then the event
5325 // is put into event_to_broadcast_sp for rebroadcasting.
5327 ProcessEventHijacker run_thread_plan_hijacker (*this, &listener);
5332 thread_plan_sp->GetDescription(&s, lldb::eDescriptionLevelVerbose);
5333 log->Printf ("Process::RunThreadPlan(): Resuming thread %u - 0x%4.4" PRIx64 " to run thread plan \"%s\".",
5334 thread->GetIndexID(),
5340 lldb::EventSP event_sp;
5341 lldb::StateType stop_state = lldb::eStateInvalid;
5343 TimeValue* timeout_ptr = NULL;
5344 TimeValue real_timeout;
5346 bool before_first_timeout = true; // This is set to false the first time that we have to halt the target.
5347 bool do_resume = true;
5348 bool handle_running_event = true;
5349 const uint64_t default_one_thread_timeout_usec = 250000;
5351 // This is just for accounting:
5352 uint32_t num_resumes = 0;
5354 uint32_t timeout_usec = options.GetTimeoutUsec();
5355 uint32_t one_thread_timeout_usec;
5356 uint32_t all_threads_timeout_usec = 0;
5358 // If we are going to run all threads the whole time, or if we are only going to run one thread,
5359 // then we don't need the first timeout. So we set the final timeout, and pretend we are after the
5360 // first timeout already.
5362 if (!options.GetStopOthers() || !options.GetTryAllThreads())
5364 before_first_timeout = false;
5365 one_thread_timeout_usec = 0;
5366 all_threads_timeout_usec = timeout_usec;
5370 uint32_t option_one_thread_timeout = options.GetOneThreadTimeoutUsec();
5372 // If the overall wait is forever, then we only need to set the one thread timeout:
5373 if (timeout_usec == 0)
5375 if (option_one_thread_timeout != 0)
5376 one_thread_timeout_usec = option_one_thread_timeout;
5378 one_thread_timeout_usec = default_one_thread_timeout_usec;
5382 // Otherwise, if the one thread timeout is set, make sure it isn't longer than the overall timeout,
5383 // and use it, otherwise use half the total timeout, bounded by the default_one_thread_timeout_usec.
5384 uint64_t computed_one_thread_timeout;
5385 if (option_one_thread_timeout != 0)
5387 if (timeout_usec < option_one_thread_timeout)
5389 errors.Printf("RunThreadPlan called without one thread timeout greater than total timeout");
5390 return eExpressionSetupError;
5392 computed_one_thread_timeout = option_one_thread_timeout;
5396 computed_one_thread_timeout = timeout_usec / 2;
5397 if (computed_one_thread_timeout > default_one_thread_timeout_usec)
5398 computed_one_thread_timeout = default_one_thread_timeout_usec;
5400 one_thread_timeout_usec = computed_one_thread_timeout;
5401 all_threads_timeout_usec = timeout_usec - one_thread_timeout_usec;
5406 log->Printf ("Stop others: %u, try all: %u, before_first: %u, one thread: %" PRIu32 " - all threads: %" PRIu32 ".\n",
5407 options.GetStopOthers(),
5408 options.GetTryAllThreads(),
5409 before_first_timeout,
5410 one_thread_timeout_usec,
5411 all_threads_timeout_usec);
5413 // This isn't going to work if there are unfetched events on the queue.
5414 // Are there cases where we might want to run the remaining events here, and then try to
5415 // call the function? That's probably being too tricky for our own good.
5417 Event *other_events = listener.PeekAtNextEvent();
5418 if (other_events != NULL)
5420 errors.Printf("Calling RunThreadPlan with pending events on the queue.");
5421 return eExpressionSetupError;
5424 // We also need to make sure that the next event is delivered. We might be calling a function as part of
5425 // a thread plan, in which case the last delivered event could be the running event, and we don't want
5426 // event coalescing to cause us to lose OUR running event...
5427 ForceNextEventDelivery();
5429 // This while loop must exit out the bottom, there's cleanup that we need to do when we are done.
5430 // So don't call return anywhere within it.
5432 #ifdef LLDB_RUN_THREAD_HALT_WITH_EVENT
5433 // It's pretty much impossible to write test cases for things like:
5434 // One thread timeout expires, I go to halt, but the process already stopped
5435 // on the function call stop breakpoint. Turning on this define will make us not
5436 // fetch the first event till after the halt. So if you run a quick function, it will have
5437 // completed, and the completion event will be waiting, when you interrupt for halt.
5438 // The expression evaluation should still succeed.
5439 bool miss_first_event = true;
5441 TimeValue one_thread_timeout;
5442 TimeValue final_timeout;
5446 // We usually want to resume the process if we get to the top of the loop.
5447 // The only exception is if we get two running events with no intervening
5448 // stop, which can happen, we will just wait for then next stop event.
5450 log->Printf ("Top of while loop: do_resume: %i handle_running_event: %i before_first_timeout: %i.",
5452 handle_running_event,
5453 before_first_timeout);
5455 if (do_resume || handle_running_event)
5457 // Do the initial resume and wait for the running event before going further.
5462 Error resume_error = PrivateResume ();
5463 if (!resume_error.Success())
5465 errors.Printf("Error resuming inferior the %d time: \"%s\".\n",
5467 resume_error.AsCString());
5468 return_value = eExpressionSetupError;
5473 TimeValue resume_timeout = TimeValue::Now();
5474 resume_timeout.OffsetWithMicroSeconds(500000);
5476 got_event = listener.WaitForEvent(&resume_timeout, event_sp);
5480 log->Printf ("Process::RunThreadPlan(): didn't get any event after resume %d, exiting.",
5483 errors.Printf("Didn't get any event after resume %d, exiting.", num_resumes);
5484 return_value = eExpressionSetupError;
5488 stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
5490 if (stop_state != eStateRunning)
5492 bool restarted = false;
5494 if (stop_state == eStateStopped)
5496 restarted = Process::ProcessEventData::GetRestartedFromEvent(event_sp.get());
5498 log->Printf("Process::RunThreadPlan(): didn't get running event after "
5499 "resume %d, got %s instead (restarted: %i, do_resume: %i, handle_running_event: %i).",
5501 StateAsCString(stop_state),
5504 handle_running_event);
5509 // This is probably an overabundance of caution, I don't think I should ever get a stopped & restarted
5510 // event here. But if I do, the best thing is to Halt and then get out of here.
5511 const bool clear_thread_plans = false;
5512 const bool use_run_lock = false;
5513 Halt(clear_thread_plans, use_run_lock);
5516 errors.Printf("Didn't get running event after initial resume, got %s instead.",
5517 StateAsCString(stop_state));
5518 return_value = eExpressionSetupError;
5523 log->PutCString ("Process::RunThreadPlan(): resuming succeeded.");
5524 // We need to call the function synchronously, so spin waiting for it to return.
5525 // If we get interrupted while executing, we're going to lose our context, and
5526 // won't be able to gather the result at this point.
5527 // We set the timeout AFTER the resume, since the resume takes some time and we
5528 // don't want to charge that to the timeout.
5533 log->PutCString ("Process::RunThreadPlan(): waiting for next event.");
5536 if (before_first_timeout)
5538 if (options.GetTryAllThreads())
5540 one_thread_timeout = TimeValue::Now();
5541 one_thread_timeout.OffsetWithMicroSeconds(one_thread_timeout_usec);
5542 timeout_ptr = &one_thread_timeout;
5546 if (timeout_usec == 0)
5550 final_timeout = TimeValue::Now();
5551 final_timeout.OffsetWithMicroSeconds (timeout_usec);
5552 timeout_ptr = &final_timeout;
5558 if (timeout_usec == 0)
5562 final_timeout = TimeValue::Now();
5563 final_timeout.OffsetWithMicroSeconds (all_threads_timeout_usec);
5564 timeout_ptr = &final_timeout;
5569 handle_running_event = true;
5571 // Now wait for the process to stop again:
5578 log->Printf ("Process::RunThreadPlan(): about to wait - now is %" PRIu64 " - endpoint is %" PRIu64,
5579 TimeValue::Now().GetAsMicroSecondsSinceJan1_1970(),
5580 timeout_ptr->GetAsMicroSecondsSinceJan1_1970());
5584 log->Printf ("Process::RunThreadPlan(): about to wait forever.");
5588 #ifdef LLDB_RUN_THREAD_HALT_WITH_EVENT
5589 // See comment above...
5590 if (miss_first_event)
5593 miss_first_event = false;
5598 got_event = listener.WaitForEvent (timeout_ptr, event_sp);
5604 bool keep_going = false;
5605 if (event_sp->GetType() == eBroadcastBitInterrupt)
5607 const bool clear_thread_plans = false;
5608 const bool use_run_lock = false;
5609 Halt(clear_thread_plans, use_run_lock);
5610 return_value = eExpressionInterrupted;
5611 errors.Printf ("Execution halted by user interrupt.");
5613 log->Printf ("Process::RunThreadPlan(): Got interrupted by eBroadcastBitInterrupted, exiting.");
5618 stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
5620 log->Printf("Process::RunThreadPlan(): in while loop, got event: %s.", StateAsCString(stop_state));
5624 case lldb::eStateStopped:
5626 // We stopped, figure out what we are going to do now.
5627 ThreadSP thread_sp = GetThreadList().FindThreadByIndexID (thread_idx_id);
5630 // Ooh, our thread has vanished. Unlikely that this was successful execution...
5632 log->Printf ("Process::RunThreadPlan(): execution completed but our thread (index-id=%u) has vanished.", thread_idx_id);
5633 return_value = eExpressionInterrupted;
5637 // If we were restarted, we just need to go back up to fetch another event.
5638 if (Process::ProcessEventData::GetRestartedFromEvent(event_sp.get()))
5642 log->Printf ("Process::RunThreadPlan(): Got a stop and restart, so we'll continue waiting.");
5646 handle_running_event = true;
5650 StopInfoSP stop_info_sp (thread_sp->GetStopInfo ());
5651 StopReason stop_reason = eStopReasonInvalid;
5653 stop_reason = stop_info_sp->GetStopReason();
5655 // FIXME: We only check if the stop reason is plan complete, should we make sure that
5656 // it is OUR plan that is complete?
5657 if (stop_reason == eStopReasonPlanComplete)
5660 log->PutCString ("Process::RunThreadPlan(): execution completed successfully.");
5662 // Restore the plan state so it will get reported as intended when we are done.
5663 thread_plan_restorer.Clean();
5665 return_value = eExpressionCompleted;
5669 // Something restarted the target, so just wait for it to stop for real.
5670 if (stop_reason == eStopReasonBreakpoint)
5673 log->Printf ("Process::RunThreadPlan() stopped for breakpoint: %s.", stop_info_sp->GetDescription());
5674 return_value = eExpressionHitBreakpoint;
5675 if (!options.DoesIgnoreBreakpoints())
5677 // Restore the plan state and then force Private to false. We are
5678 // going to stop because of this plan so we need it to become a public
5679 // plan or it won't report correctly when we continue to its termination
5681 thread_plan_restorer.Clean();
5683 thread_plan_sp->SetPrivate(false);
5684 event_to_broadcast_sp = event_sp;
5690 log->PutCString ("Process::RunThreadPlan(): thread plan didn't successfully complete.");
5691 if (!options.DoesUnwindOnError())
5692 event_to_broadcast_sp = event_sp;
5693 return_value = eExpressionInterrupted;
5701 case lldb::eStateRunning:
5702 // This shouldn't really happen, but sometimes we do get two running events without an
5703 // intervening stop, and in that case we should just go back to waiting for the stop.
5706 handle_running_event = false;
5711 log->Printf("Process::RunThreadPlan(): execution stopped with unexpected state: %s.", StateAsCString(stop_state));
5713 if (stop_state == eStateExited)
5714 event_to_broadcast_sp = event_sp;
5716 errors.Printf ("Execution stopped with unexpected state.\n");
5717 return_value = eExpressionInterrupted;
5730 log->PutCString ("Process::RunThreadPlan(): got_event was true, but the event pointer was null. How odd...");
5731 return_value = eExpressionInterrupted;
5737 // If we didn't get an event that means we've timed out...
5738 // We will interrupt the process here. Depending on what we were asked to do we will
5739 // either exit, or try with all threads running for the same timeout.
5742 if (options.GetTryAllThreads())
5744 if (before_first_timeout)
5746 if (timeout_usec != 0)
5748 log->Printf ("Process::RunThreadPlan(): Running function with one thread timeout timed out, "
5749 "running for %" PRIu32 " usec with all threads enabled.",
5750 all_threads_timeout_usec);
5754 log->Printf ("Process::RunThreadPlan(): Running function with one thread timeout timed out, "
5755 "running forever with all threads enabled.");
5759 log->Printf ("Process::RunThreadPlan(): Restarting function with all threads enabled "
5760 "and timeout: %u timed out, abandoning execution.",
5764 log->Printf ("Process::RunThreadPlan(): Running function with timeout: %u timed out, "
5765 "abandoning execution.",
5769 // It is possible that between the time we issued the Halt, and we get around to calling Halt the target
5770 // could have stopped. That's fine, Halt will figure that out and send the appropriate Stopped event.
5771 // BUT it is also possible that we stopped & restarted (e.g. hit a signal with "stop" set to false.) In
5772 // that case, we'll get the stopped & restarted event, and we should go back to waiting for the Halt's
5773 // stopped event. That's what this while loop does.
5775 bool back_to_top = true;
5776 uint32_t try_halt_again = 0;
5777 bool do_halt = true;
5778 const uint32_t num_retries = 5;
5779 while (try_halt_again < num_retries)
5785 log->Printf ("Process::RunThreadPlan(): Running Halt.");
5786 const bool clear_thread_plans = false;
5787 const bool use_run_lock = false;
5788 Halt(clear_thread_plans, use_run_lock);
5790 if (halt_error.Success())
5793 log->PutCString ("Process::RunThreadPlan(): Halt succeeded.");
5795 real_timeout = TimeValue::Now();
5796 real_timeout.OffsetWithMicroSeconds(500000);
5798 got_event = listener.WaitForEvent(&real_timeout, event_sp);
5802 stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
5805 log->Printf ("Process::RunThreadPlan(): Stopped with event: %s", StateAsCString(stop_state));
5806 if (stop_state == lldb::eStateStopped
5807 && Process::ProcessEventData::GetInterruptedFromEvent(event_sp.get()))
5808 log->PutCString (" Event was the Halt interruption event.");
5811 if (stop_state == lldb::eStateStopped)
5813 // Between the time we initiated the Halt and the time we delivered it, the process could have
5814 // already finished its job. Check that here:
5816 if (thread->IsThreadPlanDone (thread_plan_sp.get()))
5819 log->PutCString ("Process::RunThreadPlan(): Even though we timed out, the call plan was done. "
5820 "Exiting wait loop.");
5821 return_value = eExpressionCompleted;
5822 back_to_top = false;
5826 if (Process::ProcessEventData::GetRestartedFromEvent(event_sp.get()))
5829 log->PutCString ("Process::RunThreadPlan(): Went to halt but got a restarted event, there must be an un-restarted stopped event so try again... "
5830 "Exiting wait loop.");
5836 if (!options.GetTryAllThreads())
5839 log->PutCString ("Process::RunThreadPlan(): try_all_threads was false, we stopped so now we're quitting.");
5840 return_value = eExpressionInterrupted;
5841 back_to_top = false;
5845 if (before_first_timeout)
5847 // Set all the other threads to run, and return to the top of the loop, which will continue;
5848 before_first_timeout = false;
5849 thread_plan_sp->SetStopOthers (false);
5851 log->PutCString ("Process::RunThreadPlan(): about to resume.");
5858 // Running all threads failed, so return Interrupted.
5860 log->PutCString("Process::RunThreadPlan(): running all threads timed out.");
5861 return_value = eExpressionInterrupted;
5862 back_to_top = false;
5869 log->PutCString("Process::RunThreadPlan(): halt said it succeeded, but I got no event. "
5870 "I'm getting out of here passing Interrupted.");
5871 return_value = eExpressionInterrupted;
5872 back_to_top = false;
5883 if (!back_to_top || try_halt_again > num_retries)
5890 // If we had to start up a temporary private state thread to run this thread plan, shut it down now.
5891 if (backup_private_state_thread.IsJoinable())
5893 StopPrivateStateThread();
5895 m_private_state_thread = backup_private_state_thread;
5896 if (stopper_base_plan_sp)
5898 thread->DiscardThreadPlansUpToPlan(stopper_base_plan_sp);
5900 if (old_state != eStateInvalid)
5901 m_public_state.SetValueNoLock(old_state);
5904 if (return_value != eExpressionCompleted && log)
5906 // Print a backtrace into the log so we can figure out where we are:
5908 s.PutCString("Thread state after unsuccessful completion: \n");
5909 thread->GetStackFrameStatus (s,
5914 log->PutCString(s.GetData());
5917 // Restore the thread state if we are going to discard the plan execution. There are three cases where this
5919 // 1) The execution successfully completed
5920 // 2) We hit a breakpoint, and ignore_breakpoints was true
5921 // 3) We got some other error, and discard_on_error was true
5922 bool should_unwind = (return_value == eExpressionInterrupted && options.DoesUnwindOnError())
5923 || (return_value == eExpressionHitBreakpoint && options.DoesIgnoreBreakpoints());
5925 if (return_value == eExpressionCompleted
5928 thread_plan_sp->RestoreThreadState();
5931 // Now do some processing on the results of the run:
5932 if (return_value == eExpressionInterrupted || return_value == eExpressionHitBreakpoint)
5938 event_sp->Dump (&s);
5941 log->PutCString ("Process::RunThreadPlan(): Stop event that interrupted us is NULL.");
5946 const char *event_explanation = NULL;
5952 event_explanation = "<no event>";
5955 else if (event_sp->GetType() == eBroadcastBitInterrupt)
5957 event_explanation = "<user interrupt>";
5962 const Process::ProcessEventData *event_data = Process::ProcessEventData::GetEventDataFromEvent (event_sp.get());
5966 event_explanation = "<no event data>";
5970 Process *process = event_data->GetProcessSP().get();
5974 event_explanation = "<no process>";
5978 ThreadList &thread_list = process->GetThreadList();
5980 uint32_t num_threads = thread_list.GetSize();
5981 uint32_t thread_index;
5983 ts.Printf("<%u threads> ", num_threads);
5985 for (thread_index = 0;
5986 thread_index < num_threads;
5989 Thread *thread = thread_list.GetThreadAtIndex(thread_index).get();
5997 ts.Printf("<0x%4.4" PRIx64 " ", thread->GetID());
5998 RegisterContext *register_context = thread->GetRegisterContext().get();
6000 if (register_context)
6001 ts.Printf("[ip 0x%" PRIx64 "] ", register_context->GetPC());
6003 ts.Printf("[ip unknown] ");
6005 // Show the private stop info here, the public stop info will be from the last natural stop.
6006 lldb::StopInfoSP stop_info_sp = thread->GetPrivateStopInfo();
6009 const char *stop_desc = stop_info_sp->GetDescription();
6011 ts.PutCString (stop_desc);
6016 event_explanation = ts.GetData();
6020 if (event_explanation)
6021 log->Printf("Process::RunThreadPlan(): execution interrupted: %s %s", s.GetData(), event_explanation);
6023 log->Printf("Process::RunThreadPlan(): execution interrupted: %s", s.GetData());
6029 log->Printf ("Process::RunThreadPlan: ExecutionInterrupted - discarding thread plans up to %p.",
6030 static_cast<void*>(thread_plan_sp.get()));
6031 thread->DiscardThreadPlansUpToPlan (thread_plan_sp);
6036 log->Printf ("Process::RunThreadPlan: ExecutionInterrupted - for plan: %p not discarding.",
6037 static_cast<void*>(thread_plan_sp.get()));
6040 else if (return_value == eExpressionSetupError)
6043 log->PutCString("Process::RunThreadPlan(): execution set up error.");
6045 if (options.DoesUnwindOnError())
6047 thread->DiscardThreadPlansUpToPlan (thread_plan_sp);
6052 if (thread->IsThreadPlanDone (thread_plan_sp.get()))
6055 log->PutCString("Process::RunThreadPlan(): thread plan is done");
6056 return_value = eExpressionCompleted;
6058 else if (thread->WasThreadPlanDiscarded (thread_plan_sp.get()))
6061 log->PutCString("Process::RunThreadPlan(): thread plan was discarded");
6062 return_value = eExpressionDiscarded;
6067 log->PutCString("Process::RunThreadPlan(): thread plan stopped in mid course");
6068 if (options.DoesUnwindOnError() && thread_plan_sp)
6071 log->PutCString("Process::RunThreadPlan(): discarding thread plan 'cause unwind_on_error is set.");
6072 thread->DiscardThreadPlansUpToPlan (thread_plan_sp);
6077 // Thread we ran the function in may have gone away because we ran the target
6078 // Check that it's still there, and if it is put it back in the context. Also restore the
6079 // frame in the context if it is still present.
6080 thread = GetThreadList().FindThreadByIndexID(thread_idx_id, true).get();
6083 exe_ctx.SetFrameSP (thread->GetFrameWithStackID (ctx_frame_id));
6086 // Also restore the current process'es selected frame & thread, since this function calling may
6087 // be done behind the user's back.
6089 if (selected_tid != LLDB_INVALID_THREAD_ID)
6091 if (GetThreadList().SetSelectedThreadByIndexID (selected_tid) && selected_stack_id.IsValid())
6093 // We were able to restore the selected thread, now restore the frame:
6094 Mutex::Locker lock(GetThreadList().GetMutex());
6095 StackFrameSP old_frame_sp = GetThreadList().GetSelectedThread()->GetFrameWithStackID(selected_stack_id);
6097 GetThreadList().GetSelectedThread()->SetSelectedFrame(old_frame_sp.get());
6102 // If the process exited during the run of the thread plan, notify everyone.
6104 if (event_to_broadcast_sp)
6107 log->PutCString("Process::RunThreadPlan(): rebroadcasting event.");
6108 BroadcastEvent(event_to_broadcast_sp);
6111 return return_value;
6115 Process::ExecutionResultAsCString (ExpressionResults result)
6117 const char *result_name;
6121 case eExpressionCompleted:
6122 result_name = "eExpressionCompleted";
6124 case eExpressionDiscarded:
6125 result_name = "eExpressionDiscarded";
6127 case eExpressionInterrupted:
6128 result_name = "eExpressionInterrupted";
6130 case eExpressionHitBreakpoint:
6131 result_name = "eExpressionHitBreakpoint";
6133 case eExpressionSetupError:
6134 result_name = "eExpressionSetupError";
6136 case eExpressionParseError:
6137 result_name = "eExpressionParseError";
6139 case eExpressionResultUnavailable:
6140 result_name = "eExpressionResultUnavailable";
6142 case eExpressionTimedOut:
6143 result_name = "eExpressionTimedOut";
6145 case eExpressionStoppedForDebug:
6146 result_name = "eExpressionStoppedForDebug";
6153 Process::GetStatus (Stream &strm)
6155 const StateType state = GetState();
6156 if (StateIsStoppedState(state, false))
6158 if (state == eStateExited)
6160 int exit_status = GetExitStatus();
6161 const char *exit_description = GetExitDescription();
6162 strm.Printf ("Process %" PRIu64 " exited with status = %i (0x%8.8x) %s\n",
6166 exit_description ? exit_description : "");
6170 if (state == eStateConnected)
6171 strm.Printf ("Connected to remote target.\n");
6173 strm.Printf ("Process %" PRIu64 " %s\n", GetID(), StateAsCString (state));
6178 strm.Printf ("Process %" PRIu64 " is running.\n", GetID());
6183 Process::GetThreadStatus (Stream &strm,
6184 bool only_threads_with_stop_reason,
6185 uint32_t start_frame,
6186 uint32_t num_frames,
6187 uint32_t num_frames_with_source)
6189 size_t num_thread_infos_dumped = 0;
6191 // You can't hold the thread list lock while calling Thread::GetStatus. That very well might run code (e.g. if we need it
6192 // to get return values or arguments.) For that to work the process has to be able to acquire it. So instead copy the thread
6193 // ID's, and look them up one by one:
6195 uint32_t num_threads;
6196 std::vector<lldb::tid_t> thread_id_array;
6197 //Scope for thread list locker;
6199 Mutex::Locker locker (GetThreadList().GetMutex());
6200 ThreadList &curr_thread_list = GetThreadList();
6201 num_threads = curr_thread_list.GetSize();
6203 thread_id_array.resize(num_threads);
6204 for (idx = 0; idx < num_threads; ++idx)
6205 thread_id_array[idx] = curr_thread_list.GetThreadAtIndex(idx)->GetID();
6208 for (uint32_t i = 0; i < num_threads; i++)
6210 ThreadSP thread_sp(GetThreadList().FindThreadByID(thread_id_array[i]));
6213 if (only_threads_with_stop_reason)
6215 StopInfoSP stop_info_sp = thread_sp->GetStopInfo();
6216 if (stop_info_sp.get() == NULL || !stop_info_sp->IsValid())
6219 thread_sp->GetStatus (strm,
6222 num_frames_with_source);
6223 ++num_thread_infos_dumped;
6227 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_PROCESS));
6229 log->Printf("Process::GetThreadStatus - thread 0x" PRIu64 " vanished while running Thread::GetStatus.");
6232 return num_thread_infos_dumped;
6236 Process::AddInvalidMemoryRegion (const LoadRange ®ion)
6238 m_memory_cache.AddInvalidRange(region.GetRangeBase(), region.GetByteSize());
6242 Process::RemoveInvalidMemoryRange (const LoadRange ®ion)
6244 return m_memory_cache.RemoveInvalidRange(region.GetRangeBase(), region.GetByteSize());
6248 Process::AddPreResumeAction (PreResumeActionCallback callback, void *baton)
6250 m_pre_resume_actions.push_back(PreResumeCallbackAndBaton (callback, baton));
6254 Process::RunPreResumeActions ()
6257 while (!m_pre_resume_actions.empty())
6259 struct PreResumeCallbackAndBaton action = m_pre_resume_actions.back();
6260 m_pre_resume_actions.pop_back();
6261 bool this_result = action.callback (action.baton);
6263 result = this_result;
6269 Process::ClearPreResumeActions ()
6271 m_pre_resume_actions.clear();
6275 Process::GetRunLock()
6277 if (m_private_state_thread.EqualsThread(Host::GetCurrentThread()))
6278 return m_private_run_lock;
6280 return m_public_run_lock;
6286 m_thread_list.Flush();
6287 m_extended_thread_list.Flush();
6288 m_extended_thread_stop_id = 0;
6289 m_queue_list.Clear();
6290 m_queue_list_stop_id = 0;
6296 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
6298 log->Printf ("Process::%s()", __FUNCTION__);
6300 Target &target = GetTarget();
6301 target.CleanupProcess ();
6302 target.ClearModules(false);
6303 m_dynamic_checkers_ap.reset();
6305 m_system_runtime_ap.reset();
6308 m_jit_loaders_ap.reset();
6309 m_image_tokens.clear();
6310 m_allocated_memory_cache.Clear();
6311 m_language_runtimes.clear();
6312 m_instrumentation_runtimes.clear();
6313 m_thread_list.DiscardThreadPlans();
6314 m_memory_cache.Clear(true);
6315 m_stop_info_override_callback = NULL;
6318 // Flush the process (threads and all stack frames) after running CompleteAttach()
6319 // in case the dynamic loader loaded things in new locations.
6322 // After we figure out what was loaded/unloaded in CompleteAttach,
6323 // we need to let the target know so it can do any cleanup it needs to.
6328 Process::ResolveIndirectFunction(const Address *address, Error &error)
6330 if (address == nullptr)
6332 error.SetErrorString("Invalid address argument");
6333 return LLDB_INVALID_ADDRESS;
6336 addr_t function_addr = LLDB_INVALID_ADDRESS;
6338 addr_t addr = address->GetLoadAddress(&GetTarget());
6339 std::map<addr_t,addr_t>::const_iterator iter = m_resolved_indirect_addresses.find(addr);
6340 if (iter != m_resolved_indirect_addresses.end())
6342 function_addr = (*iter).second;
6346 if (!InferiorCall(this, address, function_addr))
6348 Symbol *symbol = address->CalculateSymbolContextSymbol();
6349 error.SetErrorStringWithFormat ("Unable to call resolver for indirect function %s",
6350 symbol ? symbol->GetName().AsCString() : "<UNKNOWN>");
6351 function_addr = LLDB_INVALID_ADDRESS;
6355 m_resolved_indirect_addresses.insert(std::pair<addr_t, addr_t>(addr, function_addr));
6358 return function_addr;
6362 Process::ModulesDidLoad (ModuleList &module_list)
6364 SystemRuntime *sys_runtime = GetSystemRuntime();
6367 sys_runtime->ModulesDidLoad (module_list);
6370 GetJITLoaders().ModulesDidLoad (module_list);
6372 // Give runtimes a chance to be created.
6373 InstrumentationRuntime::ModulesDidLoad(module_list, this, m_instrumentation_runtimes);
6375 // Tell runtimes about new modules.
6376 for (auto pos = m_instrumentation_runtimes.begin(); pos != m_instrumentation_runtimes.end(); ++pos)
6378 InstrumentationRuntimeSP runtime = pos->second;
6379 runtime->ModulesDidLoad(module_list);
6382 // Let any language runtimes we have already created know
6383 // about the modules that loaded.
6385 // Iterate over a copy of this language runtime list in case
6386 // the language runtime ModulesDidLoad somehow causes the language
6387 // riuntime to be unloaded.
6388 LanguageRuntimeCollection language_runtimes(m_language_runtimes);
6389 for (const auto &pair: language_runtimes)
6391 // We must check language_runtime_sp to make sure it is not
6392 // NULL as we might cache the fact that we didn't have a
6393 // language runtime for a language.
6394 LanguageRuntimeSP language_runtime_sp = pair.second;
6395 if (language_runtime_sp)
6396 language_runtime_sp->ModulesDidLoad(module_list);
6399 LoadOperatingSystemPlugin(false);
6403 Process::PrintWarning (uint64_t warning_type, const void *repeat_key, const char *fmt, ...)
6405 bool print_warning = true;
6407 StreamSP stream_sp = GetTarget().GetDebugger().GetAsyncOutputStream();
6408 if (stream_sp.get() == nullptr)
6410 if (warning_type == eWarningsOptimization
6411 && GetWarningsOptimization() == false)
6416 if (repeat_key != nullptr)
6418 WarningsCollection::iterator it = m_warnings_issued.find (warning_type);
6419 if (it == m_warnings_issued.end())
6421 m_warnings_issued[warning_type] = WarningsPointerSet();
6422 m_warnings_issued[warning_type].insert (repeat_key);
6426 if (it->second.find (repeat_key) != it->second.end())
6428 print_warning = false;
6432 it->second.insert (repeat_key);
6440 va_start (args, fmt);
6441 stream_sp->PrintfVarArg (fmt, args);
6447 Process::PrintWarningOptimization (const SymbolContext &sc)
6449 if (GetWarningsOptimization() == true
6450 && sc.module_sp.get()
6451 && sc.module_sp->GetFileSpec().GetFilename().IsEmpty() == false
6453 && sc.function->GetIsOptimized() == true)
6455 PrintWarning (Process::Warnings::eWarningsOptimization, sc.module_sp.get(), "%s was compiled with optimization - stepping may behave oddly; variables may not be available.\n", sc.module_sp->GetFileSpec().GetFilename().GetCString());
6460 Process::GetHistoryThreads(lldb::addr_t addr)
6462 ThreadCollectionSP threads;
6464 const MemoryHistorySP &memory_history = MemoryHistory::FindPlugin(shared_from_this());
6466 if (! memory_history.get()) {
6470 threads.reset(new ThreadCollection(memory_history->GetHistoryThreads(addr)));
6475 InstrumentationRuntimeSP
6476 Process::GetInstrumentationRuntime(lldb::InstrumentationRuntimeType type)
6478 InstrumentationRuntimeCollection::iterator pos;
6479 pos = m_instrumentation_runtimes.find (type);
6480 if (pos == m_instrumentation_runtimes.end())
6482 return InstrumentationRuntimeSP();
6485 return (*pos).second;
6489 Process::GetModuleSpec(const FileSpec& module_file_spec,
6490 const ArchSpec& arch,
6491 ModuleSpec& module_spec)
6493 module_spec.Clear();
6498 Process::AddImageToken(lldb::addr_t image_ptr)
6500 m_image_tokens.push_back(image_ptr);
6501 return m_image_tokens.size() - 1;
6505 Process::GetImagePtrFromToken(size_t token) const
6507 if (token < m_image_tokens.size())
6508 return m_image_tokens[token];
6509 return LLDB_INVALID_IMAGE_TOKEN;
6513 Process::ResetImageToken(size_t token)
6515 if (token < m_image_tokens.size())
6516 m_image_tokens[token] = LLDB_INVALID_IMAGE_TOKEN;