blob: 699063ff93814a3be084c7a300bfa0a6e019d3c3 [file] [log] [blame]
Chris Lattner24943d22010-06-08 16:52:24 +00001//===-- Process.cpp ---------------------------------------------*- C++ -*-===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9
Daniel Malead891f9b2012-12-05 00:20:57 +000010#include "lldb/lldb-python.h"
11
Chris Lattner24943d22010-06-08 16:52:24 +000012#include "lldb/Target/Process.h"
13
14#include "lldb/lldb-private-log.h"
15
16#include "lldb/Breakpoint/StoppointCallbackContext.h"
17#include "lldb/Breakpoint/BreakpointLocation.h"
18#include "lldb/Core/Event.h"
Caroline Tice861efb32010-11-16 05:07:41 +000019#include "lldb/Core/ConnectionFileDescriptor.h"
Chris Lattner24943d22010-06-08 16:52:24 +000020#include "lldb/Core/Debugger.h"
Caroline Tice861efb32010-11-16 05:07:41 +000021#include "lldb/Core/InputReader.h"
Chris Lattner24943d22010-06-08 16:52:24 +000022#include "lldb/Core/Log.h"
Greg Clayton49ce8962012-08-29 21:13:06 +000023#include "lldb/Core/Module.h"
Chris Lattner24943d22010-06-08 16:52:24 +000024#include "lldb/Core/PluginManager.h"
25#include "lldb/Core/State.h"
Greg Claytonf15996e2011-04-07 22:46:35 +000026#include "lldb/Expression/ClangUserExpression.h"
Caroline Tice6e4c5ce2010-09-04 00:03:46 +000027#include "lldb/Interpreter/CommandInterpreter.h"
Chris Lattner24943d22010-06-08 16:52:24 +000028#include "lldb/Host/Host.h"
29#include "lldb/Target/ABI.h"
Greg Clayton0baa3942010-11-04 01:54:29 +000030#include "lldb/Target/DynamicLoader.h"
Greg Clayton37f962e2011-08-22 02:49:39 +000031#include "lldb/Target/OperatingSystem.h"
Jim Ingham642036f2010-09-23 02:01:19 +000032#include "lldb/Target/LanguageRuntime.h"
33#include "lldb/Target/CPPLanguageRuntime.h"
34#include "lldb/Target/ObjCLanguageRuntime.h"
Greg Claytone4b9c1f2011-03-08 22:40:15 +000035#include "lldb/Target/Platform.h"
Chris Lattner24943d22010-06-08 16:52:24 +000036#include "lldb/Target/RegisterContext.h"
Greg Clayton643ee732010-08-04 01:40:35 +000037#include "lldb/Target/StopInfo.h"
Chris Lattner24943d22010-06-08 16:52:24 +000038#include "lldb/Target/Target.h"
39#include "lldb/Target/TargetList.h"
40#include "lldb/Target/Thread.h"
41#include "lldb/Target/ThreadPlan.h"
Jim Inghamd21d98b2012-04-10 01:21:57 +000042#include "lldb/Target/ThreadPlanBase.h"
Chris Lattner24943d22010-06-08 16:52:24 +000043
44using namespace lldb;
45using namespace lldb_private;
46
Greg Clayton73844aa2012-08-22 17:17:09 +000047
48// Comment out line below to disable memory caching, overriding the process setting
49// target.process.disable-memory-cache
50#define ENABLE_MEMORY_CACHING
51
52#ifdef ENABLE_MEMORY_CACHING
53#define DISABLE_MEM_CACHE_DEFAULT false
54#else
55#define DISABLE_MEM_CACHE_DEFAULT true
56#endif
57
58class ProcessOptionValueProperties : public OptionValueProperties
59{
60public:
61 ProcessOptionValueProperties (const ConstString &name) :
62 OptionValueProperties (name)
63 {
64 }
65
66 // This constructor is used when creating ProcessOptionValueProperties when it
67 // is part of a new lldb_private::Process instance. It will copy all current
68 // global property values as needed
69 ProcessOptionValueProperties (ProcessProperties *global_properties) :
70 OptionValueProperties(*global_properties->GetValueProperties())
71 {
72 }
73
74 virtual const Property *
75 GetPropertyAtIndex (const ExecutionContext *exe_ctx, bool will_modify, uint32_t idx) const
76 {
77 // When gettings the value for a key from the process options, we will always
78 // try and grab the setting from the current process if there is one. Else we just
79 // use the one from this instance.
80 if (exe_ctx)
81 {
82 Process *process = exe_ctx->GetProcessPtr();
83 if (process)
84 {
85 ProcessOptionValueProperties *instance_properties = static_cast<ProcessOptionValueProperties *>(process->GetValueProperties().get());
86 if (this != instance_properties)
87 return instance_properties->ProtectedGetPropertyAtIndex (idx);
88 }
89 }
90 return ProtectedGetPropertyAtIndex (idx);
91 }
92};
93
94static PropertyDefinition
95g_properties[] =
96{
97 { "disable-memory-cache" , OptionValue::eTypeBoolean, false, DISABLE_MEM_CACHE_DEFAULT, NULL, NULL, "Disable reading and caching of memory in fixed-size units." },
Jim Inghamdacdc012012-11-29 00:41:12 +000098 { "extra-startup-command", OptionValue::eTypeArray , false, OptionValue::eTypeString, NULL, NULL, "A list containing extra commands understood by the particular process plugin used. "
99 "For instance, to turn on debugserver logging set this to \"QSetLogging:bitmask=LOG_DEFAULT;\"" },
Jim Inghamb7940202013-01-15 02:47:48 +0000100 { "ignore-breakpoints-in-expressions", OptionValue::eTypeBoolean, true, false, NULL, NULL, "If true, breakpoints will be ignored during expression evaluation." },
101 { "unwind-on-error-in-expressions", OptionValue::eTypeBoolean, true, false, NULL, NULL, "If true, errors in expression evaluation will unwind the stack back to the state before the call." },
Greg Clayton507a6382012-11-29 18:48:47 +0000102 { "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." },
Jim Ingham090f8312013-01-26 02:19:28 +0000103 { "stop-on-sharedlibrary-events" , OptionValue::eTypeBoolean, true, false, NULL, NULL, "If true, stop when a shared library is loaded or unloaded." },
Greg Clayton73844aa2012-08-22 17:17:09 +0000104 { NULL , OptionValue::eTypeInvalid, false, 0, NULL, NULL, NULL }
105};
106
107enum {
108 ePropertyDisableMemCache,
Greg Clayton2e7f3132012-10-18 22:40:37 +0000109 ePropertyExtraStartCommand,
Jim Inghamb7940202013-01-15 02:47:48 +0000110 ePropertyIgnoreBreakpointsInExpressions,
111 ePropertyUnwindOnErrorInExpressions,
Jim Ingham090f8312013-01-26 02:19:28 +0000112 ePropertyPythonOSPluginPath,
113 ePropertyStopOnSharedLibraryEvents
Greg Clayton73844aa2012-08-22 17:17:09 +0000114};
115
116ProcessProperties::ProcessProperties (bool is_global) :
117 Properties ()
118{
119 if (is_global)
120 {
121 m_collection_sp.reset (new ProcessOptionValueProperties(ConstString("process")));
122 m_collection_sp->Initialize(g_properties);
123 m_collection_sp->AppendProperty(ConstString("thread"),
Jim Ingham090f8312013-01-26 02:19:28 +0000124 ConstString("Settings specific to threads."),
Greg Clayton73844aa2012-08-22 17:17:09 +0000125 true,
126 Thread::GetGlobalProperties()->GetValueProperties());
127 }
128 else
129 m_collection_sp.reset (new ProcessOptionValueProperties(Process::GetGlobalProperties().get()));
130}
131
132ProcessProperties::~ProcessProperties()
133{
134}
135
136bool
137ProcessProperties::GetDisableMemoryCache() const
138{
139 const uint32_t idx = ePropertyDisableMemCache;
140 return m_collection_sp->GetPropertyAtIndexAsBoolean (NULL, idx, g_properties[idx].default_uint_value != 0);
141}
142
143Args
144ProcessProperties::GetExtraStartupCommands () const
145{
146 Args args;
147 const uint32_t idx = ePropertyExtraStartCommand;
148 m_collection_sp->GetPropertyAtIndexAsArgs(NULL, idx, args);
149 return args;
150}
151
152void
153ProcessProperties::SetExtraStartupCommands (const Args &args)
154{
155 const uint32_t idx = ePropertyExtraStartCommand;
156 m_collection_sp->SetPropertyAtIndexFromArgs(NULL, idx, args);
157}
158
Greg Clayton2e7f3132012-10-18 22:40:37 +0000159FileSpec
160ProcessProperties::GetPythonOSPluginPath () const
161{
162 const uint32_t idx = ePropertyPythonOSPluginPath;
163 return m_collection_sp->GetPropertyAtIndexAsFileSpec(NULL, idx);
164}
165
166void
167ProcessProperties::SetPythonOSPluginPath (const FileSpec &file)
168{
169 const uint32_t idx = ePropertyPythonOSPluginPath;
170 m_collection_sp->SetPropertyAtIndexAsFileSpec(NULL, idx, file);
171}
172
Jim Inghamb7940202013-01-15 02:47:48 +0000173
174bool
175ProcessProperties::GetIgnoreBreakpointsInExpressions () const
176{
177 const uint32_t idx = ePropertyIgnoreBreakpointsInExpressions;
178 return m_collection_sp->GetPropertyAtIndexAsBoolean(NULL, idx, g_properties[idx].default_uint_value != 0);
179}
180
181void
182ProcessProperties::SetIgnoreBreakpointsInExpressions (bool ignore)
183{
184 const uint32_t idx = ePropertyIgnoreBreakpointsInExpressions;
185 m_collection_sp->SetPropertyAtIndexAsBoolean(NULL, idx, ignore);
186}
187
188bool
189ProcessProperties::GetUnwindOnErrorInExpressions () const
190{
191 const uint32_t idx = ePropertyUnwindOnErrorInExpressions;
192 return m_collection_sp->GetPropertyAtIndexAsBoolean(NULL, idx, g_properties[idx].default_uint_value != 0);
193}
194
195void
196ProcessProperties::SetUnwindOnErrorInExpressions (bool ignore)
197{
198 const uint32_t idx = ePropertyUnwindOnErrorInExpressions;
199 m_collection_sp->SetPropertyAtIndexAsBoolean(NULL, idx, ignore);
200}
201
Jim Ingham090f8312013-01-26 02:19:28 +0000202bool
203ProcessProperties::GetStopOnSharedLibraryEvents () const
204{
205 const uint32_t idx = ePropertyStopOnSharedLibraryEvents;
206 return m_collection_sp->GetPropertyAtIndexAsBoolean(NULL, idx, g_properties[idx].default_uint_value != 0);
207}
208
209void
210ProcessProperties::SetStopOnSharedLibraryEvents (bool stop)
211{
212 const uint32_t idx = ePropertyStopOnSharedLibraryEvents;
213 m_collection_sp->SetPropertyAtIndexAsBoolean(NULL, idx, stop);
214}
215
Greg Clayton24bc5d92011-03-30 18:16:51 +0000216void
Greg Claytonb72d0f02011-04-12 05:54:46 +0000217ProcessInstanceInfo::Dump (Stream &s, Platform *platform) const
Greg Clayton24bc5d92011-03-30 18:16:51 +0000218{
219 const char *cstr;
Greg Claytonff39f742011-04-01 00:29:43 +0000220 if (m_pid != LLDB_INVALID_PROCESS_ID)
Daniel Malea5f35a4b2012-11-29 21:49:15 +0000221 s.Printf (" pid = %" PRIu64 "\n", m_pid);
Greg Claytonff39f742011-04-01 00:29:43 +0000222
223 if (m_parent_pid != LLDB_INVALID_PROCESS_ID)
Daniel Malea5f35a4b2012-11-29 21:49:15 +0000224 s.Printf (" parent = %" PRIu64 "\n", m_parent_pid);
Greg Claytonff39f742011-04-01 00:29:43 +0000225
226 if (m_executable)
227 {
228 s.Printf (" name = %s\n", m_executable.GetFilename().GetCString());
229 s.PutCString (" file = ");
230 m_executable.Dump(&s);
231 s.EOL();
232 }
Greg Claytonb72d0f02011-04-12 05:54:46 +0000233 const uint32_t argc = m_arguments.GetArgumentCount();
Greg Claytonff39f742011-04-01 00:29:43 +0000234 if (argc > 0)
235 {
236 for (uint32_t i=0; i<argc; i++)
237 {
Greg Claytonb72d0f02011-04-12 05:54:46 +0000238 const char *arg = m_arguments.GetArgumentAtIndex(i);
Greg Claytonff39f742011-04-01 00:29:43 +0000239 if (i < 10)
Greg Claytonb72d0f02011-04-12 05:54:46 +0000240 s.Printf (" arg[%u] = %s\n", i, arg);
Greg Claytonff39f742011-04-01 00:29:43 +0000241 else
Greg Claytonb72d0f02011-04-12 05:54:46 +0000242 s.Printf ("arg[%u] = %s\n", i, arg);
Greg Claytonff39f742011-04-01 00:29:43 +0000243 }
244 }
Greg Claytonb72d0f02011-04-12 05:54:46 +0000245
246 const uint32_t envc = m_environment.GetArgumentCount();
247 if (envc > 0)
248 {
249 for (uint32_t i=0; i<envc; i++)
250 {
251 const char *env = m_environment.GetArgumentAtIndex(i);
252 if (i < 10)
253 s.Printf (" env[%u] = %s\n", i, env);
254 else
255 s.Printf ("env[%u] = %s\n", i, env);
256 }
257 }
258
Greg Claytonff39f742011-04-01 00:29:43 +0000259 if (m_arch.IsValid())
260 s.Printf (" arch = %s\n", m_arch.GetTriple().str().c_str());
261
Greg Claytonb72d0f02011-04-12 05:54:46 +0000262 if (m_uid != UINT32_MAX)
Greg Clayton24bc5d92011-03-30 18:16:51 +0000263 {
Greg Claytonb72d0f02011-04-12 05:54:46 +0000264 cstr = platform->GetUserName (m_uid);
265 s.Printf (" uid = %-5u (%s)\n", m_uid, cstr ? cstr : "");
Greg Clayton24bc5d92011-03-30 18:16:51 +0000266 }
Greg Claytonb72d0f02011-04-12 05:54:46 +0000267 if (m_gid != UINT32_MAX)
Greg Clayton24bc5d92011-03-30 18:16:51 +0000268 {
Greg Claytonb72d0f02011-04-12 05:54:46 +0000269 cstr = platform->GetGroupName (m_gid);
270 s.Printf (" gid = %-5u (%s)\n", m_gid, cstr ? cstr : "");
Greg Clayton24bc5d92011-03-30 18:16:51 +0000271 }
Greg Claytonb72d0f02011-04-12 05:54:46 +0000272 if (m_euid != UINT32_MAX)
Greg Clayton24bc5d92011-03-30 18:16:51 +0000273 {
Greg Claytonb72d0f02011-04-12 05:54:46 +0000274 cstr = platform->GetUserName (m_euid);
275 s.Printf (" euid = %-5u (%s)\n", m_euid, cstr ? cstr : "");
Greg Clayton24bc5d92011-03-30 18:16:51 +0000276 }
Greg Claytonb72d0f02011-04-12 05:54:46 +0000277 if (m_egid != UINT32_MAX)
Greg Clayton24bc5d92011-03-30 18:16:51 +0000278 {
Greg Claytonb72d0f02011-04-12 05:54:46 +0000279 cstr = platform->GetGroupName (m_egid);
280 s.Printf (" egid = %-5u (%s)\n", m_egid, cstr ? cstr : "");
Greg Clayton24bc5d92011-03-30 18:16:51 +0000281 }
282}
283
284void
Greg Claytonb72d0f02011-04-12 05:54:46 +0000285ProcessInstanceInfo::DumpTableHeader (Stream &s, Platform *platform, bool show_args, bool verbose)
Greg Clayton24bc5d92011-03-30 18:16:51 +0000286{
Greg Claytonb72d0f02011-04-12 05:54:46 +0000287 const char *label;
288 if (show_args || verbose)
289 label = "ARGUMENTS";
290 else
291 label = "NAME";
292
Greg Claytonff39f742011-04-01 00:29:43 +0000293 if (verbose)
294 {
Greg Claytonb72d0f02011-04-12 05:54:46 +0000295 s.Printf ("PID PARENT USER GROUP EFF USER EFF GROUP TRIPLE %s\n", label);
Greg Claytonff39f742011-04-01 00:29:43 +0000296 s.PutCString ("====== ====== ========== ========== ========== ========== ======================== ============================\n");
297 }
298 else
299 {
Greg Claytonb72d0f02011-04-12 05:54:46 +0000300 s.Printf ("PID PARENT USER ARCH %s\n", label);
Greg Claytonff39f742011-04-01 00:29:43 +0000301 s.PutCString ("====== ====== ========== ======= ============================\n");
302 }
Greg Clayton24bc5d92011-03-30 18:16:51 +0000303}
304
305void
Greg Claytonb72d0f02011-04-12 05:54:46 +0000306ProcessInstanceInfo::DumpAsTableRow (Stream &s, Platform *platform, bool show_args, bool verbose) const
Greg Clayton24bc5d92011-03-30 18:16:51 +0000307{
308 if (m_pid != LLDB_INVALID_PROCESS_ID)
309 {
310 const char *cstr;
Daniel Malea5f35a4b2012-11-29 21:49:15 +0000311 s.Printf ("%-6" PRIu64 " %-6" PRIu64 " ", m_pid, m_parent_pid);
Greg Clayton24bc5d92011-03-30 18:16:51 +0000312
Greg Clayton24bc5d92011-03-30 18:16:51 +0000313
Greg Claytonff39f742011-04-01 00:29:43 +0000314 if (verbose)
315 {
Greg Claytonb72d0f02011-04-12 05:54:46 +0000316 cstr = platform->GetUserName (m_uid);
Greg Claytonff39f742011-04-01 00:29:43 +0000317 if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
318 s.Printf ("%-10s ", cstr);
319 else
Greg Claytonb72d0f02011-04-12 05:54:46 +0000320 s.Printf ("%-10u ", m_uid);
Greg Clayton24bc5d92011-03-30 18:16:51 +0000321
Greg Claytonb72d0f02011-04-12 05:54:46 +0000322 cstr = platform->GetGroupName (m_gid);
Greg Claytonff39f742011-04-01 00:29:43 +0000323 if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
324 s.Printf ("%-10s ", cstr);
325 else
Greg Claytonb72d0f02011-04-12 05:54:46 +0000326 s.Printf ("%-10u ", m_gid);
Greg Clayton24bc5d92011-03-30 18:16:51 +0000327
Greg Claytonb72d0f02011-04-12 05:54:46 +0000328 cstr = platform->GetUserName (m_euid);
Greg Claytonff39f742011-04-01 00:29:43 +0000329 if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
330 s.Printf ("%-10s ", cstr);
331 else
Greg Claytonb72d0f02011-04-12 05:54:46 +0000332 s.Printf ("%-10u ", m_euid);
Greg Claytonff39f742011-04-01 00:29:43 +0000333
Greg Claytonb72d0f02011-04-12 05:54:46 +0000334 cstr = platform->GetGroupName (m_egid);
Greg Claytonff39f742011-04-01 00:29:43 +0000335 if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
336 s.Printf ("%-10s ", cstr);
337 else
Greg Claytonb72d0f02011-04-12 05:54:46 +0000338 s.Printf ("%-10u ", m_egid);
Greg Claytonff39f742011-04-01 00:29:43 +0000339 s.Printf ("%-24s ", m_arch.IsValid() ? m_arch.GetTriple().str().c_str() : "");
340 }
341 else
342 {
Jason Molenda7e5fa7f2011-09-20 21:44:10 +0000343 s.Printf ("%-10s %-7d %s ",
Greg Claytonb72d0f02011-04-12 05:54:46 +0000344 platform->GetUserName (m_euid),
Greg Claytonff39f742011-04-01 00:29:43 +0000345 (int)m_arch.GetTriple().getArchName().size(),
346 m_arch.GetTriple().getArchName().data());
347 }
348
Greg Claytonb72d0f02011-04-12 05:54:46 +0000349 if (verbose || show_args)
Greg Claytonff39f742011-04-01 00:29:43 +0000350 {
Greg Claytonb72d0f02011-04-12 05:54:46 +0000351 const uint32_t argc = m_arguments.GetArgumentCount();
Greg Claytonff39f742011-04-01 00:29:43 +0000352 if (argc > 0)
353 {
354 for (uint32_t i=0; i<argc; i++)
355 {
356 if (i > 0)
357 s.PutChar (' ');
Greg Claytonb72d0f02011-04-12 05:54:46 +0000358 s.PutCString (m_arguments.GetArgumentAtIndex(i));
Greg Claytonff39f742011-04-01 00:29:43 +0000359 }
360 }
361 }
362 else
363 {
364 s.PutCString (GetName());
365 }
366
367 s.EOL();
Greg Clayton24bc5d92011-03-30 18:16:51 +0000368 }
369}
370
Greg Claytonb72d0f02011-04-12 05:54:46 +0000371
372void
Greg Clayton0c8446c2012-10-17 22:57:12 +0000373ProcessInfo::SetArguments (char const **argv, bool first_arg_is_executable)
Greg Clayton36bc5ea2011-11-03 21:22:33 +0000374{
375 m_arguments.SetArguments (argv);
376
377 // Is the first argument the executable?
378 if (first_arg_is_executable)
379 {
380 const char *first_arg = m_arguments.GetArgumentAtIndex (0);
381 if (first_arg)
382 {
383 // Yes the first argument is an executable, set it as the executable
384 // in the launch options. Don't resolve the file path as the path
385 // could be a remote platform path
386 const bool resolve = false;
387 m_executable.SetFile(first_arg, resolve);
Greg Clayton36bc5ea2011-11-03 21:22:33 +0000388 }
389 }
390}
391void
Greg Clayton0c8446c2012-10-17 22:57:12 +0000392ProcessInfo::SetArguments (const Args& args, bool first_arg_is_executable)
Greg Claytonb72d0f02011-04-12 05:54:46 +0000393{
394 // Copy all arguments
395 m_arguments = args;
396
397 // Is the first argument the executable?
398 if (first_arg_is_executable)
399 {
Greg Clayton36bc5ea2011-11-03 21:22:33 +0000400 const char *first_arg = m_arguments.GetArgumentAtIndex (0);
Greg Claytonb72d0f02011-04-12 05:54:46 +0000401 if (first_arg)
402 {
403 // Yes the first argument is an executable, set it as the executable
404 // in the launch options. Don't resolve the file path as the path
405 // could be a remote platform path
406 const bool resolve = false;
407 m_executable.SetFile(first_arg, resolve);
Greg Claytonb72d0f02011-04-12 05:54:46 +0000408 }
409 }
410}
411
Greg Claytonabb33022011-11-08 02:43:13 +0000412void
Greg Clayton464c6162011-11-17 22:14:31 +0000413ProcessLaunchInfo::FinalizeFileActions (Target *target, bool default_to_use_pty)
Greg Claytonabb33022011-11-08 02:43:13 +0000414{
415 // If notthing was specified, then check the process for any default
416 // settings that were set with "settings set"
417 if (m_file_actions.empty())
418 {
Greg Claytonabb33022011-11-08 02:43:13 +0000419 if (m_flags.Test(eLaunchFlagDisableSTDIO))
420 {
Greg Clayton95ec1682012-03-06 04:01:04 +0000421 AppendSuppressFileAction (STDIN_FILENO , true, false);
422 AppendSuppressFileAction (STDOUT_FILENO, false, true);
423 AppendSuppressFileAction (STDERR_FILENO, false, true);
Greg Claytonabb33022011-11-08 02:43:13 +0000424 }
425 else
426 {
427 // Check for any values that might have gotten set with any of:
428 // (lldb) settings set target.input-path
429 // (lldb) settings set target.output-path
430 // (lldb) settings set target.error-path
Greg Clayton73844aa2012-08-22 17:17:09 +0000431 FileSpec in_path;
432 FileSpec out_path;
433 FileSpec err_path;
Greg Claytonabb33022011-11-08 02:43:13 +0000434 if (target)
435 {
Greg Clayton95ec1682012-03-06 04:01:04 +0000436 in_path = target->GetStandardInputPath();
437 out_path = target->GetStandardOutputPath();
438 err_path = target->GetStandardErrorPath();
Greg Clayton464c6162011-11-17 22:14:31 +0000439 }
440
Greg Clayton73844aa2012-08-22 17:17:09 +0000441 if (in_path || out_path || err_path)
442 {
443 char path[PATH_MAX];
444 if (in_path && in_path.GetPath(path, sizeof(path)))
445 AppendOpenFileAction(STDIN_FILENO, path, true, false);
446
447 if (out_path && out_path.GetPath(path, sizeof(path)))
448 AppendOpenFileAction(STDOUT_FILENO, path, false, true);
449
450 if (err_path && err_path.GetPath(path, sizeof(path)))
451 AppendOpenFileAction(STDERR_FILENO, path, false, true);
452 }
453 else if (default_to_use_pty)
Greg Clayton464c6162011-11-17 22:14:31 +0000454 {
455 if (m_pty.OpenFirstAvailableMaster (O_RDWR|O_NOCTTY, NULL, 0))
Greg Claytonabb33022011-11-08 02:43:13 +0000456 {
Greg Clayton73844aa2012-08-22 17:17:09 +0000457 const char *slave_path = m_pty.GetSlaveName (NULL, 0);
458 AppendOpenFileAction(STDIN_FILENO, slave_path, true, false);
459 AppendOpenFileAction(STDOUT_FILENO, slave_path, false, true);
460 AppendOpenFileAction(STDERR_FILENO, slave_path, false, true);
Greg Claytonabb33022011-11-08 02:43:13 +0000461 }
462 }
Greg Claytonabb33022011-11-08 02:43:13 +0000463 }
464 }
465}
466
Greg Clayton527154d2011-11-15 03:53:30 +0000467
468bool
Greg Clayton97471182012-04-14 01:42:46 +0000469ProcessLaunchInfo::ConvertArgumentsForLaunchingInShell (Error &error,
470 bool localhost,
471 bool will_debug,
472 bool first_arg_is_full_shell_command)
Greg Clayton527154d2011-11-15 03:53:30 +0000473{
474 error.Clear();
475
476 if (GetFlags().Test (eLaunchFlagLaunchInShell))
477 {
478 const char *shell_executable = GetShell();
479 if (shell_executable)
480 {
481 char shell_resolved_path[PATH_MAX];
482
483 if (localhost)
484 {
485 FileSpec shell_filespec (shell_executable, true);
486
487 if (!shell_filespec.Exists())
488 {
489 // Resolve the path in case we just got "bash", "sh" or "tcsh"
490 if (!shell_filespec.ResolveExecutableLocation ())
491 {
492 error.SetErrorStringWithFormat("invalid shell path '%s'", shell_executable);
493 return false;
494 }
495 }
496 shell_filespec.GetPath (shell_resolved_path, sizeof(shell_resolved_path));
497 shell_executable = shell_resolved_path;
498 }
499
Greg Clayton0c8446c2012-10-17 22:57:12 +0000500 const char **argv = GetArguments().GetConstArgumentVector ();
501 if (argv == NULL || argv[0] == NULL)
502 return false;
Greg Clayton527154d2011-11-15 03:53:30 +0000503 Args shell_arguments;
504 std::string safe_arg;
505 shell_arguments.AppendArgument (shell_executable);
Greg Clayton527154d2011-11-15 03:53:30 +0000506 shell_arguments.AppendArgument ("-c");
Greg Clayton97471182012-04-14 01:42:46 +0000507 StreamString shell_command;
508 if (will_debug)
Greg Clayton527154d2011-11-15 03:53:30 +0000509 {
Greg Clayton0c8446c2012-10-17 22:57:12 +0000510 // Add a modified PATH environment variable in case argv[0]
511 // is a relative path
512 const char *argv0 = argv[0];
513 if (argv0 && (argv0[0] != '/' && argv0[0] != '~'))
514 {
515 // We have a relative path to our executable which may not work if
516 // we just try to run "a.out" (without it being converted to "./a.out")
517 const char *working_dir = GetWorkingDirectory();
518 std::string new_path("PATH=");
519 const size_t empty_path_len = new_path.size();
520
521 if (working_dir && working_dir[0])
522 {
523 new_path += working_dir;
524 }
525 else
526 {
527 char current_working_dir[PATH_MAX];
528 const char *cwd = getcwd(current_working_dir, sizeof(current_working_dir));
529 if (cwd && cwd[0])
530 new_path += cwd;
531 }
532 const char *curr_path = getenv("PATH");
533 if (curr_path)
534 {
535 if (new_path.size() > empty_path_len)
536 new_path += ':';
537 new_path += curr_path;
538 }
539 new_path += ' ';
540 shell_command.PutCString(new_path.c_str());
541 }
542
Greg Clayton97471182012-04-14 01:42:46 +0000543 shell_command.PutCString ("exec");
Greg Clayton0c8446c2012-10-17 22:57:12 +0000544
545#if defined(__APPLE__)
546 // Only Apple supports /usr/bin/arch being able to specify the architecture
Greg Clayton97471182012-04-14 01:42:46 +0000547 if (GetArchitecture().IsValid())
548 {
549 shell_command.Printf(" /usr/bin/arch -arch %s", GetArchitecture().GetArchitectureName());
Greg Clayton0c8446c2012-10-17 22:57:12 +0000550 // Set the resume count to 2:
Greg Clayton97471182012-04-14 01:42:46 +0000551 // 1 - stop in shell
552 // 2 - stop in /usr/bin/arch
553 // 3 - then we will stop in our program
554 SetResumeCount(2);
555 }
556 else
557 {
Greg Clayton0c8446c2012-10-17 22:57:12 +0000558 // Set the resume count to 1:
Greg Clayton97471182012-04-14 01:42:46 +0000559 // 1 - stop in shell
560 // 2 - then we will stop in our program
561 SetResumeCount(1);
562 }
Greg Clayton0c8446c2012-10-17 22:57:12 +0000563#else
564 // Set the resume count to 1:
565 // 1 - stop in shell
566 // 2 - then we will stop in our program
567 SetResumeCount(1);
568#endif
Greg Clayton527154d2011-11-15 03:53:30 +0000569 }
Greg Clayton0c8446c2012-10-17 22:57:12 +0000570
571 if (first_arg_is_full_shell_command)
Greg Clayton527154d2011-11-15 03:53:30 +0000572 {
Greg Clayton0c8446c2012-10-17 22:57:12 +0000573 // There should only be one argument that is the shell command itself to be used as is
574 if (argv[0] && !argv[1])
575 shell_command.Printf("%s", argv[0]);
Greg Clayton97471182012-04-14 01:42:46 +0000576 else
Greg Clayton0c8446c2012-10-17 22:57:12 +0000577 return false;
Greg Clayton527154d2011-11-15 03:53:30 +0000578 }
Greg Clayton97471182012-04-14 01:42:46 +0000579 else
580 {
Greg Clayton0c8446c2012-10-17 22:57:12 +0000581 for (size_t i=0; argv[i] != NULL; ++i)
582 {
583 const char *arg = Args::GetShellSafeArgument (argv[i], safe_arg);
584 shell_command.Printf(" %s", arg);
585 }
Greg Clayton97471182012-04-14 01:42:46 +0000586 }
Greg Clayton0c8446c2012-10-17 22:57:12 +0000587 shell_arguments.AppendArgument (shell_command.GetString().c_str());
Greg Clayton527154d2011-11-15 03:53:30 +0000588 m_executable.SetFile(shell_executable, false);
589 m_arguments = shell_arguments;
590 return true;
591 }
592 else
593 {
594 error.SetErrorString ("invalid shell path");
595 }
596 }
597 else
598 {
599 error.SetErrorString ("not launching in shell");
600 }
601 return false;
602}
603
604
Greg Clayton24bc5d92011-03-30 18:16:51 +0000605bool
Greg Claytonb72d0f02011-04-12 05:54:46 +0000606ProcessLaunchInfo::FileAction::Open (int fd, const char *path, bool read, bool write)
607{
608 if ((read || write) && fd >= 0 && path && path[0])
609 {
610 m_action = eFileActionOpen;
611 m_fd = fd;
612 if (read && write)
Greg Clayton527154d2011-11-15 03:53:30 +0000613 m_arg = O_NOCTTY | O_CREAT | O_RDWR;
Greg Claytonb72d0f02011-04-12 05:54:46 +0000614 else if (read)
Greg Clayton527154d2011-11-15 03:53:30 +0000615 m_arg = O_NOCTTY | O_RDONLY;
Greg Claytonb72d0f02011-04-12 05:54:46 +0000616 else
Greg Clayton527154d2011-11-15 03:53:30 +0000617 m_arg = O_NOCTTY | O_CREAT | O_WRONLY;
Greg Claytonb72d0f02011-04-12 05:54:46 +0000618 m_path.assign (path);
619 return true;
620 }
621 else
622 {
623 Clear();
624 }
625 return false;
626}
627
628bool
629ProcessLaunchInfo::FileAction::Close (int fd)
630{
631 Clear();
632 if (fd >= 0)
633 {
634 m_action = eFileActionClose;
635 m_fd = fd;
636 }
637 return m_fd >= 0;
638}
639
640
641bool
642ProcessLaunchInfo::FileAction::Duplicate (int fd, int dup_fd)
643{
644 Clear();
645 if (fd >= 0 && dup_fd >= 0)
646 {
647 m_action = eFileActionDuplicate;
648 m_fd = fd;
649 m_arg = dup_fd;
650 }
651 return m_fd >= 0;
652}
653
654
655
656bool
657ProcessLaunchInfo::FileAction::AddPosixSpawnFileAction (posix_spawn_file_actions_t *file_actions,
658 const FileAction *info,
659 Log *log,
660 Error& error)
661{
662 if (info == NULL)
663 return false;
664
665 switch (info->m_action)
666 {
667 case eFileActionNone:
668 error.Clear();
669 break;
670
671 case eFileActionClose:
672 if (info->m_fd == -1)
673 error.SetErrorString ("invalid fd for posix_spawn_file_actions_addclose(...)");
674 else
675 {
676 error.SetError (::posix_spawn_file_actions_addclose (file_actions, info->m_fd),
677 eErrorTypePOSIX);
678 if (log && (error.Fail() || log))
679 error.PutToLog(log, "posix_spawn_file_actions_addclose (action=%p, fd=%i)",
680 file_actions, info->m_fd);
681 }
682 break;
683
684 case eFileActionDuplicate:
685 if (info->m_fd == -1)
686 error.SetErrorString ("invalid fd for posix_spawn_file_actions_adddup2(...)");
687 else if (info->m_arg == -1)
688 error.SetErrorString ("invalid duplicate fd for posix_spawn_file_actions_adddup2(...)");
689 else
690 {
691 error.SetError (::posix_spawn_file_actions_adddup2 (file_actions, info->m_fd, info->m_arg),
692 eErrorTypePOSIX);
693 if (log && (error.Fail() || log))
694 error.PutToLog(log, "posix_spawn_file_actions_adddup2 (action=%p, fd=%i, dup_fd=%i)",
695 file_actions, info->m_fd, info->m_arg);
696 }
697 break;
698
699 case eFileActionOpen:
700 if (info->m_fd == -1)
701 error.SetErrorString ("invalid fd in posix_spawn_file_actions_addopen(...)");
702 else
703 {
704 int oflag = info->m_arg;
Greg Clayton527154d2011-11-15 03:53:30 +0000705
Greg Claytonb72d0f02011-04-12 05:54:46 +0000706 mode_t mode = 0;
707
Greg Clayton527154d2011-11-15 03:53:30 +0000708 if (oflag & O_CREAT)
709 mode = 0640;
710
Greg Claytonb72d0f02011-04-12 05:54:46 +0000711 error.SetError (::posix_spawn_file_actions_addopen (file_actions,
712 info->m_fd,
713 info->m_path.c_str(),
714 oflag,
715 mode),
716 eErrorTypePOSIX);
717 if (error.Fail() || log)
718 error.PutToLog(log,
719 "posix_spawn_file_actions_addopen (action=%p, fd=%i, path='%s', oflag=%i, mode=%i)",
720 file_actions, info->m_fd, info->m_path.c_str(), oflag, mode);
721 }
722 break;
Greg Claytonb72d0f02011-04-12 05:54:46 +0000723 }
724 return error.Success();
725}
726
727Error
Greg Clayton143fcc32011-04-13 00:18:08 +0000728ProcessLaunchCommandOptions::SetOptionValue (uint32_t option_idx, const char *option_arg)
Greg Claytonb72d0f02011-04-12 05:54:46 +0000729{
730 Error error;
Greg Clayton6475c422012-12-04 00:32:51 +0000731 const int short_option = m_getopt_table[option_idx].val;
Greg Claytonb72d0f02011-04-12 05:54:46 +0000732
733 switch (short_option)
734 {
735 case 's': // Stop at program entry point
736 launch_info.GetFlags().Set (eLaunchFlagStopAtEntry);
737 break;
738
Greg Claytonb72d0f02011-04-12 05:54:46 +0000739 case 'i': // STDIN for read only
740 {
741 ProcessLaunchInfo::FileAction action;
Greg Clayton95ec1682012-03-06 04:01:04 +0000742 if (action.Open (STDIN_FILENO, option_arg, true, false))
Greg Claytonb72d0f02011-04-12 05:54:46 +0000743 launch_info.AppendFileAction (action);
744 }
745 break;
746
747 case 'o': // Open STDOUT for write only
748 {
749 ProcessLaunchInfo::FileAction action;
Greg Clayton95ec1682012-03-06 04:01:04 +0000750 if (action.Open (STDOUT_FILENO, option_arg, false, true))
751 launch_info.AppendFileAction (action);
752 }
753 break;
754
755 case 'e': // STDERR for write only
756 {
757 ProcessLaunchInfo::FileAction action;
758 if (action.Open (STDERR_FILENO, option_arg, false, true))
Greg Claytonb72d0f02011-04-12 05:54:46 +0000759 launch_info.AppendFileAction (action);
760 }
761 break;
762
Greg Clayton95ec1682012-03-06 04:01:04 +0000763
Greg Claytonb72d0f02011-04-12 05:54:46 +0000764 case 'p': // Process plug-in name
765 launch_info.SetProcessPluginName (option_arg);
766 break;
767
768 case 'n': // Disable STDIO
769 {
770 ProcessLaunchInfo::FileAction action;
Greg Clayton95ec1682012-03-06 04:01:04 +0000771 if (action.Open (STDIN_FILENO, "/dev/null", true, false))
Greg Claytonb72d0f02011-04-12 05:54:46 +0000772 launch_info.AppendFileAction (action);
Greg Clayton95ec1682012-03-06 04:01:04 +0000773 if (action.Open (STDOUT_FILENO, "/dev/null", false, true))
Greg Claytonb72d0f02011-04-12 05:54:46 +0000774 launch_info.AppendFileAction (action);
Greg Clayton95ec1682012-03-06 04:01:04 +0000775 if (action.Open (STDERR_FILENO, "/dev/null", false, true))
Greg Claytonb72d0f02011-04-12 05:54:46 +0000776 launch_info.AppendFileAction (action);
777 }
778 break;
779
780 case 'w':
781 launch_info.SetWorkingDirectory (option_arg);
782 break;
783
784 case 't': // Open process in new terminal window
785 launch_info.GetFlags().Set (eLaunchFlagLaunchInTTY);
786 break;
787
788 case 'a':
Greg Claytonb170aee2012-05-08 01:45:38 +0000789 if (!launch_info.GetArchitecture().SetTriple (option_arg, m_interpreter.GetPlatform(true).get()))
790 launch_info.GetArchitecture().SetTriple (option_arg);
Greg Claytonb72d0f02011-04-12 05:54:46 +0000791 break;
792
793 case 'A':
794 launch_info.GetFlags().Set (eLaunchFlagDisableASLR);
795 break;
796
Greg Clayton36bc5ea2011-11-03 21:22:33 +0000797 case 'c':
Greg Clayton527154d2011-11-15 03:53:30 +0000798 if (option_arg && option_arg[0])
799 launch_info.SetShell (option_arg);
800 else
801 launch_info.SetShell ("/bin/bash");
Greg Clayton36bc5ea2011-11-03 21:22:33 +0000802 break;
803
Greg Claytonb72d0f02011-04-12 05:54:46 +0000804 case 'v':
805 launch_info.GetEnvironmentEntries().AppendArgument(option_arg);
806 break;
807
808 default:
Greg Clayton9c236732011-10-26 00:56:27 +0000809 error.SetErrorStringWithFormat("unrecognized short option character '%c'", short_option);
Greg Claytonb72d0f02011-04-12 05:54:46 +0000810 break;
811
812 }
813 return error;
814}
815
816OptionDefinition
817ProcessLaunchCommandOptions::g_option_table[] =
818{
819{ LLDB_OPT_SET_ALL, false, "stop-at-entry", 's', no_argument, NULL, 0, eArgTypeNone, "Stop at the entry point of the program when launching a process."},
820{ LLDB_OPT_SET_ALL, false, "disable-aslr", 'A', no_argument, NULL, 0, eArgTypeNone, "Disable address space layout randomization when launching a process."},
821{ LLDB_OPT_SET_ALL, false, "plugin", 'p', required_argument, NULL, 0, eArgTypePlugin, "Name of the process plugin you want to use."},
Sean Callanan9a91ef62012-10-24 01:12:14 +0000822{ LLDB_OPT_SET_ALL, false, "working-dir", 'w', required_argument, NULL, 0, eArgTypeDirectoryName, "Set the current working directory to <path> when running the inferior."},
Greg Claytonb72d0f02011-04-12 05:54:46 +0000823{ LLDB_OPT_SET_ALL, false, "arch", 'a', required_argument, NULL, 0, eArgTypeArchitecture, "Set the architecture for the process to launch when ambiguous."},
824{ LLDB_OPT_SET_ALL, false, "environment", 'v', required_argument, NULL, 0, eArgTypeNone, "Specify an environment variable name/value stirng (--environement NAME=VALUE). Can be specified multiple times for subsequent environment entries."},
Sean Callanan9a91ef62012-10-24 01:12:14 +0000825{ LLDB_OPT_SET_ALL, false, "shell", 'c', optional_argument, NULL, 0, eArgTypeFilename, "Run the process in a shell (not supported on all platforms)."},
Greg Claytonb72d0f02011-04-12 05:54:46 +0000826
Sean Callanan9a91ef62012-10-24 01:12:14 +0000827{ LLDB_OPT_SET_1 , false, "stdin", 'i', required_argument, NULL, 0, eArgTypeFilename, "Redirect stdin for the process to <filename>."},
828{ LLDB_OPT_SET_1 , false, "stdout", 'o', required_argument, NULL, 0, eArgTypeFilename, "Redirect stdout for the process to <filename>."},
829{ LLDB_OPT_SET_1 , false, "stderr", 'e', required_argument, NULL, 0, eArgTypeFilename, "Redirect stderr for the process to <filename>."},
Greg Claytonb72d0f02011-04-12 05:54:46 +0000830
831{ LLDB_OPT_SET_2 , false, "tty", 't', no_argument, NULL, 0, eArgTypeNone, "Start the process in a terminal (not supported on all platforms)."},
832
833{ LLDB_OPT_SET_3 , false, "no-stdio", 'n', no_argument, NULL, 0, eArgTypeNone, "Do not set up for terminal I/O to go to running process."},
834
835{ 0 , false, NULL, 0, 0, NULL, 0, eArgTypeNone, NULL }
836};
837
838
839
840bool
841ProcessInstanceInfoMatch::NameMatches (const char *process_name) const
Greg Clayton24bc5d92011-03-30 18:16:51 +0000842{
843 if (m_name_match_type == eNameMatchIgnore || process_name == NULL)
844 return true;
845 const char *match_name = m_match_info.GetName();
846 if (!match_name)
847 return true;
848
849 return lldb_private::NameMatches (process_name, m_name_match_type, match_name);
850}
851
852bool
Greg Claytonb72d0f02011-04-12 05:54:46 +0000853ProcessInstanceInfoMatch::Matches (const ProcessInstanceInfo &proc_info) const
Greg Clayton24bc5d92011-03-30 18:16:51 +0000854{
855 if (!NameMatches (proc_info.GetName()))
856 return false;
857
858 if (m_match_info.ProcessIDIsValid() &&
859 m_match_info.GetProcessID() != proc_info.GetProcessID())
860 return false;
861
862 if (m_match_info.ParentProcessIDIsValid() &&
863 m_match_info.GetParentProcessID() != proc_info.GetParentProcessID())
864 return false;
865
Greg Claytonb72d0f02011-04-12 05:54:46 +0000866 if (m_match_info.UserIDIsValid () &&
867 m_match_info.GetUserID() != proc_info.GetUserID())
Greg Clayton24bc5d92011-03-30 18:16:51 +0000868 return false;
869
Greg Claytonb72d0f02011-04-12 05:54:46 +0000870 if (m_match_info.GroupIDIsValid () &&
871 m_match_info.GetGroupID() != proc_info.GetGroupID())
Greg Clayton24bc5d92011-03-30 18:16:51 +0000872 return false;
873
874 if (m_match_info.EffectiveUserIDIsValid () &&
875 m_match_info.GetEffectiveUserID() != proc_info.GetEffectiveUserID())
876 return false;
877
878 if (m_match_info.EffectiveGroupIDIsValid () &&
879 m_match_info.GetEffectiveGroupID() != proc_info.GetEffectiveGroupID())
880 return false;
881
882 if (m_match_info.GetArchitecture().IsValid() &&
Sean Callanan40e278c2012-12-13 22:07:14 +0000883 !m_match_info.GetArchitecture().IsCompatibleMatch(proc_info.GetArchitecture()))
Greg Clayton24bc5d92011-03-30 18:16:51 +0000884 return false;
885 return true;
886}
887
888bool
Greg Claytonb72d0f02011-04-12 05:54:46 +0000889ProcessInstanceInfoMatch::MatchAllProcesses () const
Greg Clayton24bc5d92011-03-30 18:16:51 +0000890{
891 if (m_name_match_type != eNameMatchIgnore)
892 return false;
893
894 if (m_match_info.ProcessIDIsValid())
895 return false;
896
897 if (m_match_info.ParentProcessIDIsValid())
898 return false;
899
Greg Claytonb72d0f02011-04-12 05:54:46 +0000900 if (m_match_info.UserIDIsValid ())
Greg Clayton24bc5d92011-03-30 18:16:51 +0000901 return false;
902
Greg Claytonb72d0f02011-04-12 05:54:46 +0000903 if (m_match_info.GroupIDIsValid ())
Greg Clayton24bc5d92011-03-30 18:16:51 +0000904 return false;
905
906 if (m_match_info.EffectiveUserIDIsValid ())
907 return false;
908
909 if (m_match_info.EffectiveGroupIDIsValid ())
910 return false;
911
912 if (m_match_info.GetArchitecture().IsValid())
913 return false;
914
915 if (m_match_all_users)
916 return false;
917
918 return true;
919
920}
921
922void
Greg Claytonb72d0f02011-04-12 05:54:46 +0000923ProcessInstanceInfoMatch::Clear()
Greg Clayton24bc5d92011-03-30 18:16:51 +0000924{
925 m_match_info.Clear();
926 m_name_match_type = eNameMatchIgnore;
927 m_match_all_users = false;
928}
Greg Claytonfd119992011-01-07 06:08:19 +0000929
Greg Clayton46c9a352012-02-09 06:16:32 +0000930ProcessSP
931Process::FindPlugin (Target &target, const char *plugin_name, Listener &listener, const FileSpec *crash_file_path)
Chris Lattner24943d22010-06-08 16:52:24 +0000932{
Greg Clayton64742742013-01-16 17:29:04 +0000933 static uint32_t g_process_unique_id = 0;
934
Greg Clayton46c9a352012-02-09 06:16:32 +0000935 ProcessSP process_sp;
Chris Lattner24943d22010-06-08 16:52:24 +0000936 ProcessCreateInstance create_callback = NULL;
937 if (plugin_name)
938 {
939 create_callback = PluginManager::GetProcessCreateCallbackForPluginName (plugin_name);
940 if (create_callback)
941 {
Greg Clayton46c9a352012-02-09 06:16:32 +0000942 process_sp = create_callback(target, listener, crash_file_path);
943 if (process_sp)
944 {
Greg Clayton64742742013-01-16 17:29:04 +0000945 if (process_sp->CanDebug(target, true))
946 {
947 process_sp->m_process_unique_id = ++g_process_unique_id;
948 }
949 else
Greg Clayton46c9a352012-02-09 06:16:32 +0000950 process_sp.reset();
951 }
Chris Lattner24943d22010-06-08 16:52:24 +0000952 }
953 }
954 else
955 {
Greg Clayton54e7afa2010-07-09 20:39:50 +0000956 for (uint32_t idx = 0; (create_callback = PluginManager::GetProcessCreateCallbackAtIndex(idx)) != NULL; ++idx)
Chris Lattner24943d22010-06-08 16:52:24 +0000957 {
Greg Clayton46c9a352012-02-09 06:16:32 +0000958 process_sp = create_callback(target, listener, crash_file_path);
959 if (process_sp)
960 {
Greg Clayton64742742013-01-16 17:29:04 +0000961 if (process_sp->CanDebug(target, false))
962 {
963 process_sp->m_process_unique_id = ++g_process_unique_id;
Greg Clayton46c9a352012-02-09 06:16:32 +0000964 break;
Greg Clayton64742742013-01-16 17:29:04 +0000965 }
966 else
967 process_sp.reset();
Greg Clayton46c9a352012-02-09 06:16:32 +0000968 }
Chris Lattner24943d22010-06-08 16:52:24 +0000969 }
970 }
Greg Clayton46c9a352012-02-09 06:16:32 +0000971 return process_sp;
Chris Lattner24943d22010-06-08 16:52:24 +0000972}
973
Jim Ingham5a15e692012-02-16 06:50:00 +0000974ConstString &
975Process::GetStaticBroadcasterClass ()
976{
977 static ConstString class_name ("lldb.process");
978 return class_name;
979}
Chris Lattner24943d22010-06-08 16:52:24 +0000980
981//----------------------------------------------------------------------
982// Process constructor
983//----------------------------------------------------------------------
984Process::Process(Target &target, Listener &listener) :
Greg Clayton73844aa2012-08-22 17:17:09 +0000985 ProcessProperties (false),
Chris Lattner24943d22010-06-08 16:52:24 +0000986 UserID (LLDB_INVALID_PROCESS_ID),
Jim Ingham5a15e692012-02-16 06:50:00 +0000987 Broadcaster (&(target.GetDebugger()), "lldb.process"),
Chris Lattner24943d22010-06-08 16:52:24 +0000988 m_target (target),
Chris Lattner24943d22010-06-08 16:52:24 +0000989 m_public_state (eStateUnloaded),
990 m_private_state (eStateUnloaded),
Jim Ingham5a15e692012-02-16 06:50:00 +0000991 m_private_state_broadcaster (NULL, "lldb.process.internal_state_broadcaster"),
992 m_private_state_control_broadcaster (NULL, "lldb.process.internal_state_control_broadcaster"),
Chris Lattner24943d22010-06-08 16:52:24 +0000993 m_private_state_listener ("lldb.process.internal_state_listener"),
994 m_private_state_control_wait(),
995 m_private_state_thread (LLDB_INVALID_HOST_THREAD),
Jim Ingham21f37ad2011-08-09 02:12:22 +0000996 m_mod_id (),
Greg Clayton64742742013-01-16 17:29:04 +0000997 m_process_unique_id(0),
Chris Lattner24943d22010-06-08 16:52:24 +0000998 m_thread_index_id (0),
Han Ming Ongccd5c4e2013-01-08 22:10:01 +0000999 m_thread_id_to_index_id_map (),
Chris Lattner24943d22010-06-08 16:52:24 +00001000 m_exit_status (-1),
1001 m_exit_string (),
1002 m_thread_list (this),
1003 m_notifications (),
Greg Clayton20d338f2010-11-18 05:57:03 +00001004 m_image_tokens (),
1005 m_listener (listener),
1006 m_breakpoint_site_list (),
Greg Clayton20d338f2010-11-18 05:57:03 +00001007 m_dynamic_checkers_ap (),
Caroline Tice861efb32010-11-16 05:07:41 +00001008 m_unix_signals (),
Greg Clayton20d338f2010-11-18 05:57:03 +00001009 m_abi_sp (),
Caroline Tice861efb32010-11-16 05:07:41 +00001010 m_process_input_reader (),
Greg Claytona875b642011-01-09 21:07:35 +00001011 m_stdio_communication ("process.stdio"),
Greg Clayton20d338f2010-11-18 05:57:03 +00001012 m_stdio_communication_mutex (Mutex::eMutexTypeRecursive),
Greg Claytonfd119992011-01-07 06:08:19 +00001013 m_stdout_data (),
Greg Claytonbd06ff42011-11-13 04:45:22 +00001014 m_stderr_data (),
Han Ming Ongfb9cee62012-11-17 00:21:04 +00001015 m_profile_data_comm_mutex (Mutex::eMutexTypeRecursive),
1016 m_profile_data (),
Greg Clayton613b8732011-05-17 03:37:42 +00001017 m_memory_cache (*this),
1018 m_allocated_memory_cache (*this),
Greg Claytonffa43a62011-11-17 04:46:02 +00001019 m_should_detach (false),
Sean Callanan6cf6c472011-09-20 23:01:51 +00001020 m_next_event_action_ap(),
Bill Wendlingce96dad2012-04-06 00:10:21 +00001021 m_run_lock (),
Jim Ingham43892562012-06-06 00:29:30 +00001022 m_currently_handling_event(false),
Jim Inghamd0bdddf2012-08-22 21:34:33 +00001023 m_finalize_called(false),
Bill Wendlingce96dad2012-04-06 00:10:21 +00001024 m_can_jit(eCanJITDontKnow)
Chris Lattner24943d22010-06-08 16:52:24 +00001025{
Jim Ingham5a15e692012-02-16 06:50:00 +00001026 CheckInWithManager ();
Caroline Tice1ebef442010-09-27 00:30:10 +00001027
Greg Claytone005f2c2010-11-06 01:53:30 +00001028 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_OBJECT));
Chris Lattner24943d22010-06-08 16:52:24 +00001029 if (log)
1030 log->Printf ("%p Process::Process()", this);
1031
Greg Clayton49ce6822010-10-31 03:01:06 +00001032 SetEventName (eBroadcastBitStateChanged, "state-changed");
1033 SetEventName (eBroadcastBitInterrupt, "interrupt");
1034 SetEventName (eBroadcastBitSTDOUT, "stdout-available");
1035 SetEventName (eBroadcastBitSTDERR, "stderr-available");
Han Ming Ongfb9cee62012-11-17 00:21:04 +00001036 SetEventName (eBroadcastBitProfileData, "profile-data-available");
Greg Clayton49ce6822010-10-31 03:01:06 +00001037
Greg Clayton84332782012-10-29 20:52:08 +00001038 m_private_state_control_broadcaster.SetEventName (eBroadcastInternalStateControlStop , "control-stop" );
1039 m_private_state_control_broadcaster.SetEventName (eBroadcastInternalStateControlPause , "control-pause" );
1040 m_private_state_control_broadcaster.SetEventName (eBroadcastInternalStateControlResume, "control-resume");
1041
Chris Lattner24943d22010-06-08 16:52:24 +00001042 listener.StartListeningForEvents (this,
1043 eBroadcastBitStateChanged |
1044 eBroadcastBitInterrupt |
1045 eBroadcastBitSTDOUT |
Han Ming Ongfb9cee62012-11-17 00:21:04 +00001046 eBroadcastBitSTDERR |
1047 eBroadcastBitProfileData);
Chris Lattner24943d22010-06-08 16:52:24 +00001048
1049 m_private_state_listener.StartListeningForEvents(&m_private_state_broadcaster,
Jim Ingham5d90ade2012-07-27 23:57:19 +00001050 eBroadcastBitStateChanged |
1051 eBroadcastBitInterrupt);
Chris Lattner24943d22010-06-08 16:52:24 +00001052
1053 m_private_state_listener.StartListeningForEvents(&m_private_state_control_broadcaster,
1054 eBroadcastInternalStateControlStop |
1055 eBroadcastInternalStateControlPause |
1056 eBroadcastInternalStateControlResume);
1057}
1058
1059//----------------------------------------------------------------------
1060// Destructor
1061//----------------------------------------------------------------------
1062Process::~Process()
1063{
Greg Claytone005f2c2010-11-06 01:53:30 +00001064 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_OBJECT));
Chris Lattner24943d22010-06-08 16:52:24 +00001065 if (log)
1066 log->Printf ("%p Process::~Process()", this);
1067 StopPrivateStateThread();
1068}
1069
Greg Clayton73844aa2012-08-22 17:17:09 +00001070const ProcessPropertiesSP &
1071Process::GetGlobalProperties()
1072{
1073 static ProcessPropertiesSP g_settings_sp;
1074 if (!g_settings_sp)
1075 g_settings_sp.reset (new ProcessProperties (true));
1076 return g_settings_sp;
1077}
1078
Chris Lattner24943d22010-06-08 16:52:24 +00001079void
1080Process::Finalize()
1081{
Greg Claytonffa43a62011-11-17 04:46:02 +00001082 switch (GetPrivateState())
1083 {
1084 case eStateConnected:
1085 case eStateAttaching:
1086 case eStateLaunching:
1087 case eStateStopped:
1088 case eStateRunning:
1089 case eStateStepping:
1090 case eStateCrashed:
1091 case eStateSuspended:
1092 if (GetShouldDetach())
1093 Detach();
1094 else
1095 Destroy();
1096 break;
1097
1098 case eStateInvalid:
1099 case eStateUnloaded:
1100 case eStateDetached:
1101 case eStateExited:
1102 break;
1103 }
1104
Greg Clayton2f57db02011-10-01 00:45:15 +00001105 // Clear our broadcaster before we proceed with destroying
1106 Broadcaster::Clear();
1107
Chris Lattner24943d22010-06-08 16:52:24 +00001108 // Do any cleanup needed prior to being destructed... Subclasses
1109 // that override this method should call this superclass method as well.
Jim Ingham88fa7bd2011-02-16 17:54:55 +00001110
1111 // We need to destroy the loader before the derived Process class gets destroyed
1112 // since it is very likely that undoing the loader will require access to the real process.
Greg Clayton182be6a2012-01-20 23:08:34 +00001113 m_dynamic_checkers_ap.reset();
1114 m_abi_sp.reset();
Greg Clayton37f962e2011-08-22 02:49:39 +00001115 m_os_ap.reset();
Greg Clayton182be6a2012-01-20 23:08:34 +00001116 m_dyld_ap.reset();
Greg Clayton13d24fb2012-01-29 20:56:30 +00001117 m_thread_list.Destroy();
Greg Clayton182be6a2012-01-20 23:08:34 +00001118 std::vector<Notifications> empty_notifications;
1119 m_notifications.swap(empty_notifications);
1120 m_image_tokens.clear();
1121 m_memory_cache.Clear();
1122 m_allocated_memory_cache.Clear();
1123 m_language_runtimes.clear();
1124 m_next_event_action_ap.reset();
Greg Clayton84332782012-10-29 20:52:08 +00001125//#ifdef LLDB_CONFIGURATION_DEBUG
1126// StreamFile s(stdout, false);
1127// EventSP event_sp;
1128// while (m_private_state_listener.GetNextEvent(event_sp))
1129// {
1130// event_sp->Dump (&s);
1131// s.EOL();
1132// }
1133//#endif
1134 // We have to be very careful here as the m_private_state_listener might
1135 // contain events that have ProcessSP values in them which can keep this
1136 // process around forever. These events need to be cleared out.
1137 m_private_state_listener.Clear();
Jim Inghamd0bdddf2012-08-22 21:34:33 +00001138 m_finalize_called = true;
Chris Lattner24943d22010-06-08 16:52:24 +00001139}
1140
1141void
1142Process::RegisterNotificationCallbacks (const Notifications& callbacks)
1143{
1144 m_notifications.push_back(callbacks);
1145 if (callbacks.initialize != NULL)
1146 callbacks.initialize (callbacks.baton, this);
1147}
1148
1149bool
1150Process::UnregisterNotificationCallbacks(const Notifications& callbacks)
1151{
1152 std::vector<Notifications>::iterator pos, end = m_notifications.end();
1153 for (pos = m_notifications.begin(); pos != end; ++pos)
1154 {
1155 if (pos->baton == callbacks.baton &&
1156 pos->initialize == callbacks.initialize &&
1157 pos->process_state_changed == callbacks.process_state_changed)
1158 {
1159 m_notifications.erase(pos);
1160 return true;
1161 }
1162 }
1163 return false;
1164}
1165
1166void
1167Process::SynchronouslyNotifyStateChanged (StateType state)
1168{
1169 std::vector<Notifications>::iterator notification_pos, notification_end = m_notifications.end();
1170 for (notification_pos = m_notifications.begin(); notification_pos != notification_end; ++notification_pos)
1171 {
1172 if (notification_pos->process_state_changed)
1173 notification_pos->process_state_changed (notification_pos->baton, this, state);
1174 }
1175}
1176
1177// FIXME: We need to do some work on events before the general Listener sees them.
1178// For instance if we are continuing from a breakpoint, we need to ensure that we do
1179// the little "insert real insn, step & stop" trick. But we can't do that when the
1180// event is delivered by the broadcaster - since that is done on the thread that is
1181// waiting for new events, so if we needed more than one event for our handling, we would
1182// stall. So instead we do it when we fetch the event off of the queue.
1183//
1184
1185StateType
1186Process::GetNextEvent (EventSP &event_sp)
1187{
1188 StateType state = eStateInvalid;
1189
1190 if (m_listener.GetNextEventForBroadcaster (this, event_sp) && event_sp)
1191 state = Process::ProcessEventData::GetStateFromEvent (event_sp.get());
1192
1193 return state;
1194}
1195
1196
1197StateType
Greg Claytonbb1af9c2012-09-11 02:33:37 +00001198Process::WaitForProcessToStop (const TimeValue *timeout, lldb::EventSP *event_sp_ptr)
Chris Lattner24943d22010-06-08 16:52:24 +00001199{
Jim Ingham21f37ad2011-08-09 02:12:22 +00001200 // We can't just wait for a "stopped" event, because the stopped event may have restarted the target.
1201 // We have to actually check each event, and in the case of a stopped event check the restarted flag
1202 // on the event.
Greg Claytonbb1af9c2012-09-11 02:33:37 +00001203 if (event_sp_ptr)
1204 event_sp_ptr->reset();
Jim Ingham21f37ad2011-08-09 02:12:22 +00001205 StateType state = GetState();
1206 // If we are exited or detached, we won't ever get back to any
1207 // other valid state...
1208 if (state == eStateDetached || state == eStateExited)
1209 return state;
1210
1211 while (state != eStateInvalid)
1212 {
Greg Claytonbb1af9c2012-09-11 02:33:37 +00001213 EventSP event_sp;
Jim Ingham21f37ad2011-08-09 02:12:22 +00001214 state = WaitForStateChangedEvents (timeout, event_sp);
Greg Claytonbb1af9c2012-09-11 02:33:37 +00001215 if (event_sp_ptr && event_sp)
1216 *event_sp_ptr = event_sp;
1217
Jim Ingham21f37ad2011-08-09 02:12:22 +00001218 switch (state)
1219 {
1220 case eStateCrashed:
1221 case eStateDetached:
1222 case eStateExited:
1223 case eStateUnloaded:
1224 return state;
1225 case eStateStopped:
1226 if (Process::ProcessEventData::GetRestartedFromEvent(event_sp.get()))
1227 continue;
1228 else
1229 return state;
1230 default:
1231 continue;
1232 }
1233 }
1234 return state;
Chris Lattner24943d22010-06-08 16:52:24 +00001235}
1236
1237
1238StateType
1239Process::WaitForState
1240(
1241 const TimeValue *timeout,
1242 const StateType *match_states, const uint32_t num_match_states
1243)
1244{
1245 EventSP event_sp;
1246 uint32_t i;
Greg Claytond8c62532010-10-07 04:19:01 +00001247 StateType state = GetState();
Chris Lattner24943d22010-06-08 16:52:24 +00001248 while (state != eStateInvalid)
1249 {
Greg Claytond8c62532010-10-07 04:19:01 +00001250 // If we are exited or detached, we won't ever get back to any
1251 // other valid state...
1252 if (state == eStateDetached || state == eStateExited)
1253 return state;
1254
Chris Lattner24943d22010-06-08 16:52:24 +00001255 state = WaitForStateChangedEvents (timeout, event_sp);
1256
1257 for (i=0; i<num_match_states; ++i)
1258 {
1259 if (match_states[i] == state)
1260 return state;
1261 }
1262 }
1263 return state;
1264}
1265
Jim Ingham63e24d72010-10-11 23:53:14 +00001266bool
1267Process::HijackProcessEvents (Listener *listener)
1268{
1269 if (listener != NULL)
1270 {
Jim Ingham5d90ade2012-07-27 23:57:19 +00001271 return HijackBroadcaster(listener, eBroadcastBitStateChanged | eBroadcastBitInterrupt);
Jim Ingham63e24d72010-10-11 23:53:14 +00001272 }
1273 else
1274 return false;
1275}
1276
1277void
1278Process::RestoreProcessEvents ()
1279{
1280 RestoreBroadcaster();
1281}
1282
Jim Inghamf9f40c22011-02-08 05:20:59 +00001283bool
1284Process::HijackPrivateProcessEvents (Listener *listener)
1285{
1286 if (listener != NULL)
1287 {
Jim Ingham5d90ade2012-07-27 23:57:19 +00001288 return m_private_state_broadcaster.HijackBroadcaster(listener, eBroadcastBitStateChanged | eBroadcastBitInterrupt);
Jim Inghamf9f40c22011-02-08 05:20:59 +00001289 }
1290 else
1291 return false;
1292}
1293
1294void
1295Process::RestorePrivateProcessEvents ()
1296{
1297 m_private_state_broadcaster.RestoreBroadcaster();
1298}
1299
Chris Lattner24943d22010-06-08 16:52:24 +00001300StateType
1301Process::WaitForStateChangedEvents (const TimeValue *timeout, EventSP &event_sp)
1302{
Greg Claytone005f2c2010-11-06 01:53:30 +00001303 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner24943d22010-06-08 16:52:24 +00001304
1305 if (log)
1306 log->Printf ("Process::%s (timeout = %p, event_sp)...", __FUNCTION__, timeout);
1307
1308 StateType state = eStateInvalid;
Greg Clayton36f63a92010-10-19 03:25:40 +00001309 if (m_listener.WaitForEventForBroadcasterWithType (timeout,
1310 this,
Jim Ingham5d90ade2012-07-27 23:57:19 +00001311 eBroadcastBitStateChanged | eBroadcastBitInterrupt,
Greg Clayton36f63a92010-10-19 03:25:40 +00001312 event_sp))
Jim Ingham5d90ade2012-07-27 23:57:19 +00001313 {
1314 if (event_sp && event_sp->GetType() == eBroadcastBitStateChanged)
1315 state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
1316 else if (log)
1317 log->Printf ("Process::%s got no event or was interrupted.", __FUNCTION__);
1318 }
Chris Lattner24943d22010-06-08 16:52:24 +00001319
1320 if (log)
1321 log->Printf ("Process::%s (timeout = %p, event_sp) => %s",
1322 __FUNCTION__,
1323 timeout,
1324 StateAsCString(state));
1325 return state;
1326}
1327
1328Event *
1329Process::PeekAtStateChangedEvents ()
1330{
Greg Claytone005f2c2010-11-06 01:53:30 +00001331 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner24943d22010-06-08 16:52:24 +00001332
1333 if (log)
1334 log->Printf ("Process::%s...", __FUNCTION__);
1335
1336 Event *event_ptr;
Greg Clayton36f63a92010-10-19 03:25:40 +00001337 event_ptr = m_listener.PeekAtNextEventForBroadcasterWithType (this,
1338 eBroadcastBitStateChanged);
Chris Lattner24943d22010-06-08 16:52:24 +00001339 if (log)
1340 {
1341 if (event_ptr)
1342 {
1343 log->Printf ("Process::%s (event_ptr) => %s",
1344 __FUNCTION__,
1345 StateAsCString(ProcessEventData::GetStateFromEvent (event_ptr)));
1346 }
1347 else
1348 {
1349 log->Printf ("Process::%s no events found",
1350 __FUNCTION__);
1351 }
1352 }
1353 return event_ptr;
1354}
1355
1356StateType
1357Process::WaitForStateChangedEventsPrivate (const TimeValue *timeout, EventSP &event_sp)
1358{
Greg Claytone005f2c2010-11-06 01:53:30 +00001359 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner24943d22010-06-08 16:52:24 +00001360
1361 if (log)
1362 log->Printf ("Process::%s (timeout = %p, event_sp)...", __FUNCTION__, timeout);
1363
1364 StateType state = eStateInvalid;
Greg Clayton72e1c782011-01-22 23:43:18 +00001365 if (m_private_state_listener.WaitForEventForBroadcasterWithType (timeout,
1366 &m_private_state_broadcaster,
Jim Ingham5d90ade2012-07-27 23:57:19 +00001367 eBroadcastBitStateChanged | eBroadcastBitInterrupt,
Greg Clayton72e1c782011-01-22 23:43:18 +00001368 event_sp))
Jim Ingham5d90ade2012-07-27 23:57:19 +00001369 if (event_sp && event_sp->GetType() == eBroadcastBitStateChanged)
1370 state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
Chris Lattner24943d22010-06-08 16:52:24 +00001371
1372 // This is a bit of a hack, but when we wait here we could very well return
1373 // to the command-line, and that could disable the log, which would render the
1374 // log we got above invalid.
Chris Lattner24943d22010-06-08 16:52:24 +00001375 if (log)
Greg Clayton72e1c782011-01-22 23:43:18 +00001376 {
1377 if (state == eStateInvalid)
1378 log->Printf ("Process::%s (timeout = %p, event_sp) => TIMEOUT", __FUNCTION__, timeout);
1379 else
1380 log->Printf ("Process::%s (timeout = %p, event_sp) => %s", __FUNCTION__, timeout, StateAsCString(state));
1381 }
Chris Lattner24943d22010-06-08 16:52:24 +00001382 return state;
1383}
1384
1385bool
1386Process::WaitForEventsPrivate (const TimeValue *timeout, EventSP &event_sp, bool control_only)
1387{
Greg Claytone005f2c2010-11-06 01:53:30 +00001388 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner24943d22010-06-08 16:52:24 +00001389
1390 if (log)
1391 log->Printf ("Process::%s (timeout = %p, event_sp)...", __FUNCTION__, timeout);
1392
1393 if (control_only)
1394 return m_private_state_listener.WaitForEventForBroadcaster(timeout, &m_private_state_control_broadcaster, event_sp);
1395 else
1396 return m_private_state_listener.WaitForEvent(timeout, event_sp);
1397}
1398
1399bool
1400Process::IsRunning () const
1401{
1402 return StateIsRunningState (m_public_state.GetValue());
1403}
1404
1405int
1406Process::GetExitStatus ()
1407{
1408 if (m_public_state.GetValue() == eStateExited)
1409 return m_exit_status;
1410 return -1;
1411}
1412
Greg Clayton638351a2010-12-04 00:10:17 +00001413
Chris Lattner24943d22010-06-08 16:52:24 +00001414const char *
1415Process::GetExitDescription ()
1416{
1417 if (m_public_state.GetValue() == eStateExited && !m_exit_string.empty())
1418 return m_exit_string.c_str();
1419 return NULL;
1420}
1421
Greg Clayton72e1c782011-01-22 23:43:18 +00001422bool
Chris Lattner24943d22010-06-08 16:52:24 +00001423Process::SetExitStatus (int status, const char *cstr)
1424{
Greg Clayton68ca8232011-01-25 02:58:48 +00001425 LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
1426 if (log)
1427 log->Printf("Process::SetExitStatus (status=%i (0x%8.8x), description=%s%s%s)",
1428 status, status,
1429 cstr ? "\"" : "",
1430 cstr ? cstr : "NULL",
1431 cstr ? "\"" : "");
1432
Greg Clayton72e1c782011-01-22 23:43:18 +00001433 // We were already in the exited state
1434 if (m_private_state.GetValue() == eStateExited)
Greg Clayton68ca8232011-01-25 02:58:48 +00001435 {
Greg Clayton644ddfb2011-01-26 23:47:29 +00001436 if (log)
1437 log->Printf("Process::SetExitStatus () ignoring exit status because state was already set to eStateExited");
Greg Clayton72e1c782011-01-22 23:43:18 +00001438 return false;
Greg Clayton68ca8232011-01-25 02:58:48 +00001439 }
Greg Clayton72e1c782011-01-22 23:43:18 +00001440
1441 m_exit_status = status;
1442 if (cstr)
1443 m_exit_string = cstr;
1444 else
1445 m_exit_string.clear();
Chris Lattner24943d22010-06-08 16:52:24 +00001446
Greg Clayton72e1c782011-01-22 23:43:18 +00001447 DidExit ();
Greg Clayton58e844b2010-12-08 05:08:21 +00001448
Greg Clayton72e1c782011-01-22 23:43:18 +00001449 SetPrivateState (eStateExited);
1450 return true;
Chris Lattner24943d22010-06-08 16:52:24 +00001451}
1452
1453// This static callback can be used to watch for local child processes on
1454// the current host. The the child process exits, the process will be
1455// found in the global target list (we want to be completely sure that the
1456// lldb_private::Process doesn't go away before we can deliver the signal.
1457bool
Greg Clayton1c4642c2011-11-16 05:37:56 +00001458Process::SetProcessExitStatus (void *callback_baton,
1459 lldb::pid_t pid,
1460 bool exited,
1461 int signo, // Zero for no signal
1462 int exit_status // Exit value of process if signal is zero
Chris Lattner24943d22010-06-08 16:52:24 +00001463)
1464{
Greg Clayton1c4642c2011-11-16 05:37:56 +00001465 LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_PROCESS));
1466 if (log)
Daniel Malea5f35a4b2012-11-29 21:49:15 +00001467 log->Printf ("Process::SetProcessExitStatus (baton=%p, pid=%" PRIu64 ", exited=%i, signal=%i, exit_status=%i)\n",
Greg Clayton1c4642c2011-11-16 05:37:56 +00001468 callback_baton,
1469 pid,
1470 exited,
1471 signo,
1472 exit_status);
1473
1474 if (exited)
Chris Lattner24943d22010-06-08 16:52:24 +00001475 {
Greg Clayton63094e02010-06-23 01:19:29 +00001476 TargetSP target_sp(Debugger::FindTargetWithProcessID (pid));
Chris Lattner24943d22010-06-08 16:52:24 +00001477 if (target_sp)
1478 {
1479 ProcessSP process_sp (target_sp->GetProcessSP());
1480 if (process_sp)
1481 {
1482 const char *signal_cstr = NULL;
1483 if (signo)
1484 signal_cstr = process_sp->GetUnixSignals().GetSignalAsCString (signo);
1485
1486 process_sp->SetExitStatus (exit_status, signal_cstr);
1487 }
1488 }
1489 return true;
1490 }
1491 return false;
1492}
1493
1494
Greg Clayton37f962e2011-08-22 02:49:39 +00001495void
1496Process::UpdateThreadListIfNeeded ()
1497{
1498 const uint32_t stop_id = GetStopID();
1499 if (m_thread_list.GetSize(false) == 0 || stop_id != m_thread_list.GetStopID())
1500 {
Greg Clayton20206082011-11-17 01:23:07 +00001501 const StateType state = GetPrivateState();
1502 if (StateIsStoppedState (state, true))
1503 {
1504 Mutex::Locker locker (m_thread_list.GetMutex ());
Greg Claytonffa43a62011-11-17 04:46:02 +00001505 // m_thread_list does have its own mutex, but we need to
1506 // hold onto the mutex between the call to UpdateThreadList(...)
1507 // and the os->UpdateThreadList(...) so it doesn't change on us
Greg Clayton20206082011-11-17 01:23:07 +00001508 ThreadList new_thread_list(this);
1509 // Always update the thread list with the protocol specific
Greg Claytonae932352012-04-10 00:18:59 +00001510 // thread list, but only update if "true" is returned
1511 if (UpdateThreadList (m_thread_list, new_thread_list))
1512 {
1513 OperatingSystem *os = GetOperatingSystem ();
1514 if (os)
1515 os->UpdateThreadList (m_thread_list, new_thread_list);
1516 m_thread_list.Update (new_thread_list);
1517 m_thread_list.SetStopID (stop_id);
1518 }
Greg Clayton20206082011-11-17 01:23:07 +00001519 }
Greg Clayton37f962e2011-08-22 02:49:39 +00001520 }
1521}
1522
Greg Clayton52ebc0a2013-01-18 23:41:08 +00001523ThreadSP
1524Process::CreateOSPluginThread (lldb::tid_t tid, lldb::addr_t context)
1525{
1526 OperatingSystem *os = GetOperatingSystem ();
1527 if (os)
1528 return os->CreateThread(tid, context);
1529 return ThreadSP();
1530}
1531
1532
1533
Han Ming Ongccd5c4e2013-01-08 22:10:01 +00001534// This is obsoleted. Staged removal for Xcode.
Chris Lattner24943d22010-06-08 16:52:24 +00001535uint32_t
1536Process::GetNextThreadIndexID ()
1537{
1538 return ++m_thread_index_id;
1539}
1540
Han Ming Ongccd5c4e2013-01-08 22:10:01 +00001541uint32_t
1542Process::GetNextThreadIndexID (uint64_t thread_id)
1543{
1544 return AssignIndexIDToThread(thread_id);
1545}
1546
1547bool
1548Process::HasAssignedIndexIDToThread(uint64_t thread_id)
1549{
1550 std::map<uint64_t, uint32_t>::iterator iterator = m_thread_id_to_index_id_map.find(thread_id);
1551 if (iterator == m_thread_id_to_index_id_map.end())
1552 {
1553 return false;
1554 }
1555 else
1556 {
1557 return true;
1558 }
1559}
1560
1561uint32_t
1562Process::AssignIndexIDToThread(uint64_t thread_id)
1563{
1564 uint32_t result = 0;
1565 std::map<uint64_t, uint32_t>::iterator iterator = m_thread_id_to_index_id_map.find(thread_id);
1566 if (iterator == m_thread_id_to_index_id_map.end())
1567 {
1568 result = ++m_thread_index_id;
1569 m_thread_id_to_index_id_map[thread_id] = result;
1570 }
1571 else
1572 {
1573 result = iterator->second;
1574 }
1575
1576 return result;
1577}
1578
Chris Lattner24943d22010-06-08 16:52:24 +00001579StateType
1580Process::GetState()
1581{
1582 // If any other threads access this we will need a mutex for it
1583 return m_public_state.GetValue ();
1584}
1585
1586void
1587Process::SetPublicState (StateType new_state)
1588{
Greg Clayton68ca8232011-01-25 02:58:48 +00001589 LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
Chris Lattner24943d22010-06-08 16:52:24 +00001590 if (log)
1591 log->Printf("Process::SetPublicState (%s)", StateAsCString(new_state));
Greg Claytona894fe72012-04-05 16:12:35 +00001592 const StateType old_state = m_public_state.GetValue();
Chris Lattner24943d22010-06-08 16:52:24 +00001593 m_public_state.SetValue (new_state);
Jim Ingham027aaa72012-04-19 01:40:33 +00001594
1595 // On the transition from Run to Stopped, we unlock the writer end of the
1596 // run lock. The lock gets locked in Resume, which is the public API
1597 // to tell the program to run.
Greg Claytona894fe72012-04-05 16:12:35 +00001598 if (!IsHijackedForEvent(eBroadcastBitStateChanged))
1599 {
Sean Callanana3772862012-06-02 01:16:20 +00001600 if (new_state == eStateDetached)
Greg Claytona894fe72012-04-05 16:12:35 +00001601 {
Sean Callanana3772862012-06-02 01:16:20 +00001602 if (log)
1603 log->Printf("Process::SetPublicState (%s) -- unlocking run lock for detach", StateAsCString(new_state));
1604 m_run_lock.WriteUnlock();
1605 }
1606 else
1607 {
1608 const bool old_state_is_stopped = StateIsStoppedState(old_state, false);
1609 const bool new_state_is_stopped = StateIsStoppedState(new_state, false);
1610 if (old_state_is_stopped != new_state_is_stopped)
Greg Claytona894fe72012-04-05 16:12:35 +00001611 {
Sean Callanana3772862012-06-02 01:16:20 +00001612 if (new_state_is_stopped)
1613 {
1614 if (log)
1615 log->Printf("Process::SetPublicState (%s) -- unlocking run lock", StateAsCString(new_state));
1616 m_run_lock.WriteUnlock();
1617 }
Greg Claytona894fe72012-04-05 16:12:35 +00001618 }
Greg Claytona894fe72012-04-05 16:12:35 +00001619 }
1620 }
Chris Lattner24943d22010-06-08 16:52:24 +00001621}
1622
Jim Ingham027aaa72012-04-19 01:40:33 +00001623Error
1624Process::Resume ()
1625{
1626 LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
1627 if (log)
1628 log->Printf("Process::Resume -- locking run lock");
1629 if (!m_run_lock.WriteTryLock())
1630 {
1631 Error error("Resume request failed - process still running.");
1632 if (log)
1633 log->Printf ("Process::Resume: -- WriteTryLock failed, not resuming.");
1634 return error;
1635 }
1636 return PrivateResume();
1637}
1638
Chris Lattner24943d22010-06-08 16:52:24 +00001639StateType
1640Process::GetPrivateState ()
1641{
1642 return m_private_state.GetValue();
1643}
1644
1645void
1646Process::SetPrivateState (StateType new_state)
1647{
Greg Clayton68ca8232011-01-25 02:58:48 +00001648 LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
Chris Lattner24943d22010-06-08 16:52:24 +00001649 bool state_changed = false;
1650
1651 if (log)
1652 log->Printf("Process::SetPrivateState (%s)", StateAsCString(new_state));
1653
1654 Mutex::Locker locker(m_private_state.GetMutex());
1655
1656 const StateType old_state = m_private_state.GetValueNoLock ();
1657 state_changed = old_state != new_state;
Greg Claytona894fe72012-04-05 16:12:35 +00001658 // This code is left commented out in case we ever need to control
1659 // the private process state with another run lock. Right now it doesn't
1660 // seem like we need to do this, but if we ever do, we can uncomment and
1661 // use this code.
1662// const bool old_state_is_stopped = StateIsStoppedState(old_state, false);
1663// const bool new_state_is_stopped = StateIsStoppedState(new_state, false);
1664// if (old_state_is_stopped != new_state_is_stopped)
1665// {
1666// if (new_state_is_stopped)
1667// m_private_run_lock.WriteUnlock();
1668// else
1669// m_private_run_lock.WriteLock();
1670// }
1671
Chris Lattner24943d22010-06-08 16:52:24 +00001672 if (state_changed)
1673 {
1674 m_private_state.SetValueNoLock (new_state);
Greg Clayton20206082011-11-17 01:23:07 +00001675 if (StateIsStoppedState(new_state, false))
Chris Lattner24943d22010-06-08 16:52:24 +00001676 {
Jim Ingham21f37ad2011-08-09 02:12:22 +00001677 m_mod_id.BumpStopID();
Greg Claytonfd119992011-01-07 06:08:19 +00001678 m_memory_cache.Clear();
Chris Lattner24943d22010-06-08 16:52:24 +00001679 if (log)
Jim Ingham21f37ad2011-08-09 02:12:22 +00001680 log->Printf("Process::SetPrivateState (%s) stop_id = %u", StateAsCString(new_state), m_mod_id.GetStopID());
Chris Lattner24943d22010-06-08 16:52:24 +00001681 }
1682 // Use our target to get a shared pointer to ourselves...
Greg Clayton84332782012-10-29 20:52:08 +00001683 if (m_finalize_called && PrivateStateThreadIsValid() == false)
1684 BroadcastEvent (eBroadcastBitStateChanged, new ProcessEventData (shared_from_this(), new_state));
1685 else
1686 m_private_state_broadcaster.BroadcastEvent (eBroadcastBitStateChanged, new ProcessEventData (shared_from_this(), new_state));
Chris Lattner24943d22010-06-08 16:52:24 +00001687 }
1688 else
1689 {
1690 if (log)
Jason Molenda7e5fa7f2011-09-20 21:44:10 +00001691 log->Printf("Process::SetPrivateState (%s) state didn't change. Ignoring...", StateAsCString(new_state));
Chris Lattner24943d22010-06-08 16:52:24 +00001692 }
1693}
1694
Jim Ingham0296fe72011-11-08 03:00:11 +00001695void
1696Process::SetRunningUserExpression (bool on)
1697{
1698 m_mod_id.SetRunningUserExpression (on);
1699}
1700
Chris Lattner24943d22010-06-08 16:52:24 +00001701addr_t
1702Process::GetImageInfoAddress()
1703{
1704 return LLDB_INVALID_ADDRESS;
1705}
1706
Greg Clayton0baa3942010-11-04 01:54:29 +00001707//----------------------------------------------------------------------
1708// LoadImage
1709//
1710// This function provides a default implementation that works for most
1711// unix variants. Any Process subclasses that need to do shared library
1712// loading differently should override LoadImage and UnloadImage and
1713// do what is needed.
1714//----------------------------------------------------------------------
1715uint32_t
1716Process::LoadImage (const FileSpec &image_spec, Error &error)
1717{
Greg Clayton77d40712012-04-18 00:05:19 +00001718 char path[PATH_MAX];
1719 image_spec.GetPath(path, sizeof(path));
1720
Greg Clayton0baa3942010-11-04 01:54:29 +00001721 DynamicLoader *loader = GetDynamicLoader();
1722 if (loader)
1723 {
1724 error = loader->CanLoadImage();
1725 if (error.Fail())
1726 return LLDB_INVALID_IMAGE_TOKEN;
1727 }
1728
1729 if (error.Success())
1730 {
1731 ThreadSP thread_sp(GetThreadList ().GetSelectedThread());
Greg Clayton0baa3942010-11-04 01:54:29 +00001732
1733 if (thread_sp)
1734 {
1735 StackFrameSP frame_sp (thread_sp->GetStackFrameAtIndex (0));
1736
1737 if (frame_sp)
1738 {
1739 ExecutionContext exe_ctx;
1740 frame_sp->CalculateExecutionContext (exe_ctx);
Jim Inghamb7940202013-01-15 02:47:48 +00001741 const bool unwind_on_error = true;
1742 const bool ignore_breakpoints = true;
Greg Clayton0baa3942010-11-04 01:54:29 +00001743 StreamString expr;
Greg Clayton0baa3942010-11-04 01:54:29 +00001744 expr.Printf("dlopen (\"%s\", 2)", path);
1745 const char *prefix = "extern \"C\" void* dlopen (const char *path, int mode);\n";
Jim Ingham360f53f2010-11-30 02:22:11 +00001746 lldb::ValueObjectSP result_valobj_sp;
Greg Clayton34507e42012-10-31 20:49:04 +00001747 ClangUserExpression::Evaluate (exe_ctx,
1748 eExecutionPolicyAlways,
1749 lldb::eLanguageTypeUnknown,
1750 ClangUserExpression::eResultTypeAny,
1751 unwind_on_error,
Jim Inghamb7940202013-01-15 02:47:48 +00001752 ignore_breakpoints,
Greg Clayton34507e42012-10-31 20:49:04 +00001753 expr.GetData(),
1754 prefix,
1755 result_valobj_sp,
1756 true,
1757 ClangUserExpression::kDefaultTimeout);
Johnny Chenb14ec342011-09-09 00:01:43 +00001758 error = result_valobj_sp->GetError();
1759 if (error.Success())
Greg Clayton0baa3942010-11-04 01:54:29 +00001760 {
1761 Scalar scalar;
Jim Inghamfa3a16a2011-03-31 00:19:25 +00001762 if (result_valobj_sp->ResolveValue (scalar))
Greg Clayton0baa3942010-11-04 01:54:29 +00001763 {
1764 addr_t image_ptr = scalar.ULongLong(LLDB_INVALID_ADDRESS);
1765 if (image_ptr != 0 && image_ptr != LLDB_INVALID_ADDRESS)
1766 {
1767 uint32_t image_token = m_image_tokens.size();
1768 m_image_tokens.push_back (image_ptr);
1769 return image_token;
1770 }
1771 }
1772 }
1773 }
1774 }
1775 }
Greg Clayton77d40712012-04-18 00:05:19 +00001776 if (!error.AsCString())
1777 error.SetErrorStringWithFormat("unable to load '%s'", path);
Greg Clayton0baa3942010-11-04 01:54:29 +00001778 return LLDB_INVALID_IMAGE_TOKEN;
1779}
1780
1781//----------------------------------------------------------------------
1782// UnloadImage
1783//
1784// This function provides a default implementation that works for most
1785// unix variants. Any Process subclasses that need to do shared library
1786// loading differently should override LoadImage and UnloadImage and
1787// do what is needed.
1788//----------------------------------------------------------------------
1789Error
1790Process::UnloadImage (uint32_t image_token)
1791{
1792 Error error;
1793 if (image_token < m_image_tokens.size())
1794 {
1795 const addr_t image_addr = m_image_tokens[image_token];
1796 if (image_addr == LLDB_INVALID_ADDRESS)
1797 {
1798 error.SetErrorString("image already unloaded");
1799 }
1800 else
1801 {
1802 DynamicLoader *loader = GetDynamicLoader();
1803 if (loader)
1804 error = loader->CanLoadImage();
1805
1806 if (error.Success())
1807 {
1808 ThreadSP thread_sp(GetThreadList ().GetSelectedThread());
Greg Clayton0baa3942010-11-04 01:54:29 +00001809
1810 if (thread_sp)
1811 {
1812 StackFrameSP frame_sp (thread_sp->GetStackFrameAtIndex (0));
1813
1814 if (frame_sp)
1815 {
1816 ExecutionContext exe_ctx;
1817 frame_sp->CalculateExecutionContext (exe_ctx);
Jim Inghamb7940202013-01-15 02:47:48 +00001818 const bool unwind_on_error = true;
1819 const bool ignore_breakpoints = true;
Greg Clayton0baa3942010-11-04 01:54:29 +00001820 StreamString expr;
Daniel Malea5f35a4b2012-11-29 21:49:15 +00001821 expr.Printf("dlclose ((void *)0x%" PRIx64 ")", image_addr);
Greg Clayton0baa3942010-11-04 01:54:29 +00001822 const char *prefix = "extern \"C\" int dlclose(void* handle);\n";
Jim Ingham360f53f2010-11-30 02:22:11 +00001823 lldb::ValueObjectSP result_valobj_sp;
Greg Clayton34507e42012-10-31 20:49:04 +00001824 ClangUserExpression::Evaluate (exe_ctx,
1825 eExecutionPolicyAlways,
1826 lldb::eLanguageTypeUnknown,
1827 ClangUserExpression::eResultTypeAny,
1828 unwind_on_error,
Jim Inghamb7940202013-01-15 02:47:48 +00001829 ignore_breakpoints,
Greg Clayton34507e42012-10-31 20:49:04 +00001830 expr.GetData(),
1831 prefix,
1832 result_valobj_sp,
1833 true,
1834 ClangUserExpression::kDefaultTimeout);
Greg Clayton0baa3942010-11-04 01:54:29 +00001835 if (result_valobj_sp->GetError().Success())
1836 {
1837 Scalar scalar;
Jim Inghamfa3a16a2011-03-31 00:19:25 +00001838 if (result_valobj_sp->ResolveValue (scalar))
Greg Clayton0baa3942010-11-04 01:54:29 +00001839 {
1840 if (scalar.UInt(1))
1841 {
1842 error.SetErrorStringWithFormat("expression failed: \"%s\"", expr.GetData());
1843 }
1844 else
1845 {
1846 m_image_tokens[image_token] = LLDB_INVALID_ADDRESS;
1847 }
1848 }
1849 }
1850 else
1851 {
1852 error = result_valobj_sp->GetError();
1853 }
1854 }
1855 }
1856 }
1857 }
1858 }
1859 else
1860 {
1861 error.SetErrorString("invalid image token");
1862 }
1863 return error;
1864}
1865
Greg Clayton75906e42011-05-11 18:39:18 +00001866const lldb::ABISP &
Chris Lattner24943d22010-06-08 16:52:24 +00001867Process::GetABI()
1868{
Greg Clayton75906e42011-05-11 18:39:18 +00001869 if (!m_abi_sp)
1870 m_abi_sp = ABI::FindPlugin(m_target.GetArchitecture());
1871 return m_abi_sp;
Chris Lattner24943d22010-06-08 16:52:24 +00001872}
1873
Jim Ingham642036f2010-09-23 02:01:19 +00001874LanguageRuntime *
Jim Inghame3117662012-03-10 00:22:19 +00001875Process::GetLanguageRuntime(lldb::LanguageType language, bool retry_if_null)
Jim Ingham642036f2010-09-23 02:01:19 +00001876{
1877 LanguageRuntimeCollection::iterator pos;
1878 pos = m_language_runtimes.find (language);
Jim Inghame3117662012-03-10 00:22:19 +00001879 if (pos == m_language_runtimes.end() || (retry_if_null && !(*pos).second))
Jim Ingham642036f2010-09-23 02:01:19 +00001880 {
Jim Inghame3117662012-03-10 00:22:19 +00001881 lldb::LanguageRuntimeSP runtime_sp(LanguageRuntime::FindPlugin(this, language));
Jim Ingham642036f2010-09-23 02:01:19 +00001882
Jim Inghame3117662012-03-10 00:22:19 +00001883 m_language_runtimes[language] = runtime_sp;
1884 return runtime_sp.get();
Jim Ingham642036f2010-09-23 02:01:19 +00001885 }
1886 else
1887 return (*pos).second.get();
1888}
1889
1890CPPLanguageRuntime *
Jim Inghame3117662012-03-10 00:22:19 +00001891Process::GetCPPLanguageRuntime (bool retry_if_null)
Jim Ingham642036f2010-09-23 02:01:19 +00001892{
Jim Inghame3117662012-03-10 00:22:19 +00001893 LanguageRuntime *runtime = GetLanguageRuntime(eLanguageTypeC_plus_plus, retry_if_null);
Jim Ingham642036f2010-09-23 02:01:19 +00001894 if (runtime != NULL && runtime->GetLanguageType() == eLanguageTypeC_plus_plus)
1895 return static_cast<CPPLanguageRuntime *> (runtime);
1896 return NULL;
1897}
1898
1899ObjCLanguageRuntime *
Jim Inghame3117662012-03-10 00:22:19 +00001900Process::GetObjCLanguageRuntime (bool retry_if_null)
Jim Ingham642036f2010-09-23 02:01:19 +00001901{
Jim Inghame3117662012-03-10 00:22:19 +00001902 LanguageRuntime *runtime = GetLanguageRuntime(eLanguageTypeObjC, retry_if_null);
Jim Ingham642036f2010-09-23 02:01:19 +00001903 if (runtime != NULL && runtime->GetLanguageType() == eLanguageTypeObjC)
1904 return static_cast<ObjCLanguageRuntime *> (runtime);
1905 return NULL;
1906}
1907
Enrico Granata6b1763b2012-05-21 16:51:35 +00001908bool
1909Process::IsPossibleDynamicValue (ValueObject& in_value)
1910{
1911 if (in_value.IsDynamic())
1912 return false;
1913 LanguageType known_type = in_value.GetObjectRuntimeLanguage();
1914
1915 if (known_type != eLanguageTypeUnknown && known_type != eLanguageTypeC)
1916 {
1917 LanguageRuntime *runtime = GetLanguageRuntime (known_type);
1918 return runtime ? runtime->CouldHaveDynamicValue(in_value) : false;
1919 }
1920
1921 LanguageRuntime *cpp_runtime = GetLanguageRuntime (eLanguageTypeC_plus_plus);
1922 if (cpp_runtime && cpp_runtime->CouldHaveDynamicValue(in_value))
1923 return true;
1924
1925 LanguageRuntime *objc_runtime = GetLanguageRuntime (eLanguageTypeObjC);
1926 return objc_runtime ? objc_runtime->CouldHaveDynamicValue(in_value) : false;
1927}
1928
Chris Lattner24943d22010-06-08 16:52:24 +00001929BreakpointSiteList &
1930Process::GetBreakpointSiteList()
1931{
1932 return m_breakpoint_site_list;
1933}
1934
1935const BreakpointSiteList &
1936Process::GetBreakpointSiteList() const
1937{
1938 return m_breakpoint_site_list;
1939}
1940
1941
1942void
1943Process::DisableAllBreakpointSites ()
1944{
1945 m_breakpoint_site_list.SetEnabledForAll (false);
Jim Ingham06b84492012-07-04 00:35:43 +00001946 size_t num_sites = m_breakpoint_site_list.GetSize();
1947 for (size_t i = 0; i < num_sites; i++)
1948 {
1949 DisableBreakpoint (m_breakpoint_site_list.GetByIndex(i).get());
1950 }
Chris Lattner24943d22010-06-08 16:52:24 +00001951}
1952
1953Error
1954Process::ClearBreakpointSiteByID (lldb::user_id_t break_id)
1955{
1956 Error error (DisableBreakpointSiteByID (break_id));
1957
1958 if (error.Success())
1959 m_breakpoint_site_list.Remove(break_id);
1960
1961 return error;
1962}
1963
1964Error
1965Process::DisableBreakpointSiteByID (lldb::user_id_t break_id)
1966{
1967 Error error;
1968 BreakpointSiteSP bp_site_sp = m_breakpoint_site_list.FindByID (break_id);
1969 if (bp_site_sp)
1970 {
1971 if (bp_site_sp->IsEnabled())
1972 error = DisableBreakpoint (bp_site_sp.get());
1973 }
1974 else
1975 {
Daniel Malea5f35a4b2012-11-29 21:49:15 +00001976 error.SetErrorStringWithFormat("invalid breakpoint site ID: %" PRIu64, break_id);
Chris Lattner24943d22010-06-08 16:52:24 +00001977 }
1978
1979 return error;
1980}
1981
1982Error
1983Process::EnableBreakpointSiteByID (lldb::user_id_t break_id)
1984{
1985 Error error;
1986 BreakpointSiteSP bp_site_sp = m_breakpoint_site_list.FindByID (break_id);
1987 if (bp_site_sp)
1988 {
1989 if (!bp_site_sp->IsEnabled())
1990 error = EnableBreakpoint (bp_site_sp.get());
1991 }
1992 else
1993 {
Daniel Malea5f35a4b2012-11-29 21:49:15 +00001994 error.SetErrorStringWithFormat("invalid breakpoint site ID: %" PRIu64, break_id);
Chris Lattner24943d22010-06-08 16:52:24 +00001995 }
1996 return error;
1997}
1998
Stephen Wilson3fd1f362010-07-17 00:56:13 +00001999lldb::break_id_t
Greg Clayton13d24fb2012-01-29 20:56:30 +00002000Process::CreateBreakpointSite (const BreakpointLocationSP &owner, bool use_hardware)
Chris Lattner24943d22010-06-08 16:52:24 +00002001{
Greg Clayton265ab332011-05-19 18:17:41 +00002002 const addr_t load_addr = owner->GetAddress().GetOpcodeLoadAddress (&m_target);
Chris Lattner24943d22010-06-08 16:52:24 +00002003 if (load_addr != LLDB_INVALID_ADDRESS)
2004 {
2005 BreakpointSiteSP bp_site_sp;
2006
2007 // Look up this breakpoint site. If it exists, then add this new owner, otherwise
2008 // create a new breakpoint site and add it.
2009
2010 bp_site_sp = m_breakpoint_site_list.FindByAddress (load_addr);
2011
2012 if (bp_site_sp)
2013 {
2014 bp_site_sp->AddOwner (owner);
2015 owner->SetBreakpointSite (bp_site_sp);
2016 return bp_site_sp->GetID();
2017 }
2018 else
2019 {
Greg Clayton36da2aa2013-01-25 18:06:21 +00002020 bp_site_sp.reset (new BreakpointSite (&m_breakpoint_site_list, owner, load_addr, use_hardware));
Chris Lattner24943d22010-06-08 16:52:24 +00002021 if (bp_site_sp)
2022 {
2023 if (EnableBreakpoint (bp_site_sp.get()).Success())
2024 {
2025 owner->SetBreakpointSite (bp_site_sp);
2026 return m_breakpoint_site_list.Add (bp_site_sp);
2027 }
2028 }
2029 }
2030 }
2031 // We failed to enable the breakpoint
2032 return LLDB_INVALID_BREAK_ID;
2033
2034}
2035
2036void
2037Process::RemoveOwnerFromBreakpointSite (lldb::user_id_t owner_id, lldb::user_id_t owner_loc_id, BreakpointSiteSP &bp_site_sp)
2038{
2039 uint32_t num_owners = bp_site_sp->RemoveOwner (owner_id, owner_loc_id);
2040 if (num_owners == 0)
2041 {
2042 DisableBreakpoint(bp_site_sp.get());
2043 m_breakpoint_site_list.RemoveByAddress(bp_site_sp->GetLoadAddress());
2044 }
2045}
2046
2047
2048size_t
2049Process::RemoveBreakpointOpcodesFromBuffer (addr_t bp_addr, size_t size, uint8_t *buf) const
2050{
2051 size_t bytes_removed = 0;
2052 addr_t intersect_addr;
2053 size_t intersect_size;
2054 size_t opcode_offset;
2055 size_t idx;
Greg Clayton987c7eb2011-09-17 08:33:22 +00002056 BreakpointSiteSP bp_sp;
Jim Ingham82820f92011-06-29 19:42:28 +00002057 BreakpointSiteList bp_sites_in_range;
Chris Lattner24943d22010-06-08 16:52:24 +00002058
Jim Ingham82820f92011-06-29 19:42:28 +00002059 if (m_breakpoint_site_list.FindInRange (bp_addr, bp_addr + size, bp_sites_in_range))
Chris Lattner24943d22010-06-08 16:52:24 +00002060 {
Greg Clayton987c7eb2011-09-17 08:33:22 +00002061 for (idx = 0; (bp_sp = bp_sites_in_range.GetByIndex(idx)); ++idx)
Chris Lattner24943d22010-06-08 16:52:24 +00002062 {
Greg Clayton987c7eb2011-09-17 08:33:22 +00002063 if (bp_sp->GetType() == BreakpointSite::eSoftware)
Chris Lattner24943d22010-06-08 16:52:24 +00002064 {
Greg Clayton987c7eb2011-09-17 08:33:22 +00002065 if (bp_sp->IntersectsRange(bp_addr, size, &intersect_addr, &intersect_size, &opcode_offset))
Jim Ingham82820f92011-06-29 19:42:28 +00002066 {
2067 assert(bp_addr <= intersect_addr && intersect_addr < bp_addr + size);
2068 assert(bp_addr < intersect_addr + intersect_size && intersect_addr + intersect_size <= bp_addr + size);
Greg Clayton987c7eb2011-09-17 08:33:22 +00002069 assert(opcode_offset + intersect_size <= bp_sp->GetByteSize());
Jim Ingham82820f92011-06-29 19:42:28 +00002070 size_t buf_offset = intersect_addr - bp_addr;
Greg Clayton987c7eb2011-09-17 08:33:22 +00002071 ::memcpy(buf + buf_offset, bp_sp->GetSavedOpcodeBytes() + opcode_offset, intersect_size);
Jim Ingham82820f92011-06-29 19:42:28 +00002072 }
Chris Lattner24943d22010-06-08 16:52:24 +00002073 }
2074 }
2075 }
2076 return bytes_removed;
2077}
2078
2079
Greg Claytonb1888f22011-03-19 01:12:21 +00002080
2081size_t
2082Process::GetSoftwareBreakpointTrapOpcode (BreakpointSite* bp_site)
2083{
2084 PlatformSP platform_sp (m_target.GetPlatform());
2085 if (platform_sp)
2086 return platform_sp->GetSoftwareBreakpointTrapOpcode (m_target, bp_site);
2087 return 0;
2088}
2089
Chris Lattner24943d22010-06-08 16:52:24 +00002090Error
2091Process::EnableSoftwareBreakpoint (BreakpointSite *bp_site)
2092{
2093 Error error;
2094 assert (bp_site != NULL);
Greg Claytone005f2c2010-11-06 01:53:30 +00002095 LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_BREAKPOINTS));
Chris Lattner24943d22010-06-08 16:52:24 +00002096 const addr_t bp_addr = bp_site->GetLoadAddress();
2097 if (log)
Daniel Malea5f35a4b2012-11-29 21:49:15 +00002098 log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64, bp_site->GetID(), (uint64_t)bp_addr);
Chris Lattner24943d22010-06-08 16:52:24 +00002099 if (bp_site->IsEnabled())
2100 {
2101 if (log)
Daniel Malea5f35a4b2012-11-29 21:49:15 +00002102 log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- already enabled", bp_site->GetID(), (uint64_t)bp_addr);
Chris Lattner24943d22010-06-08 16:52:24 +00002103 return error;
2104 }
2105
2106 if (bp_addr == LLDB_INVALID_ADDRESS)
2107 {
2108 error.SetErrorString("BreakpointSite contains an invalid load address.");
2109 return error;
2110 }
2111 // Ask the lldb::Process subclass to fill in the correct software breakpoint
2112 // trap for the breakpoint site
2113 const size_t bp_opcode_size = GetSoftwareBreakpointTrapOpcode(bp_site);
2114
2115 if (bp_opcode_size == 0)
2116 {
Daniel Malea5f35a4b2012-11-29 21:49:15 +00002117 error.SetErrorStringWithFormat ("Process::GetSoftwareBreakpointTrapOpcode() returned zero, unable to get breakpoint trap for address 0x%" PRIx64, bp_addr);
Chris Lattner24943d22010-06-08 16:52:24 +00002118 }
2119 else
2120 {
2121 const uint8_t * const bp_opcode_bytes = bp_site->GetTrapOpcodeBytes();
2122
2123 if (bp_opcode_bytes == NULL)
2124 {
2125 error.SetErrorString ("BreakpointSite doesn't contain a valid breakpoint trap opcode.");
2126 return error;
2127 }
2128
2129 // Save the original opcode by reading it
2130 if (DoReadMemory(bp_addr, bp_site->GetSavedOpcodeBytes(), bp_opcode_size, error) == bp_opcode_size)
2131 {
2132 // Write a software breakpoint in place of the original opcode
2133 if (DoWriteMemory(bp_addr, bp_opcode_bytes, bp_opcode_size, error) == bp_opcode_size)
2134 {
2135 uint8_t verify_bp_opcode_bytes[64];
2136 if (DoReadMemory(bp_addr, verify_bp_opcode_bytes, bp_opcode_size, error) == bp_opcode_size)
2137 {
2138 if (::memcmp(bp_opcode_bytes, verify_bp_opcode_bytes, bp_opcode_size) == 0)
2139 {
2140 bp_site->SetEnabled(true);
2141 bp_site->SetType (BreakpointSite::eSoftware);
2142 if (log)
Daniel Malea5f35a4b2012-11-29 21:49:15 +00002143 log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- SUCCESS",
Chris Lattner24943d22010-06-08 16:52:24 +00002144 bp_site->GetID(),
2145 (uint64_t)bp_addr);
2146 }
2147 else
Greg Clayton9c236732011-10-26 00:56:27 +00002148 error.SetErrorString("failed to verify the breakpoint trap in memory.");
Chris Lattner24943d22010-06-08 16:52:24 +00002149 }
2150 else
2151 error.SetErrorString("Unable to read memory to verify breakpoint trap.");
2152 }
2153 else
2154 error.SetErrorString("Unable to write breakpoint trap to memory.");
2155 }
2156 else
2157 error.SetErrorString("Unable to read memory at breakpoint address.");
2158 }
Stephen Wilsonc2b98252011-01-12 04:20:03 +00002159 if (log && error.Fail())
Daniel Malea5f35a4b2012-11-29 21:49:15 +00002160 log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- FAILED: %s",
Chris Lattner24943d22010-06-08 16:52:24 +00002161 bp_site->GetID(),
2162 (uint64_t)bp_addr,
2163 error.AsCString());
2164 return error;
2165}
2166
2167Error
2168Process::DisableSoftwareBreakpoint (BreakpointSite *bp_site)
2169{
2170 Error error;
2171 assert (bp_site != NULL);
Greg Claytone005f2c2010-11-06 01:53:30 +00002172 LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_BREAKPOINTS));
Chris Lattner24943d22010-06-08 16:52:24 +00002173 addr_t bp_addr = bp_site->GetLoadAddress();
2174 lldb::user_id_t breakID = bp_site->GetID();
2175 if (log)
Daniel Malea5f35a4b2012-11-29 21:49:15 +00002176 log->Printf ("Process::DisableBreakpoint (breakID = %" PRIu64 ") addr = 0x%" PRIx64, breakID, (uint64_t)bp_addr);
Chris Lattner24943d22010-06-08 16:52:24 +00002177
2178 if (bp_site->IsHardware())
2179 {
2180 error.SetErrorString("Breakpoint site is a hardware breakpoint.");
2181 }
2182 else if (bp_site->IsEnabled())
2183 {
2184 const size_t break_op_size = bp_site->GetByteSize();
2185 const uint8_t * const break_op = bp_site->GetTrapOpcodeBytes();
2186 if (break_op_size > 0)
2187 {
2188 // Clear a software breakoint instruction
Greg Clayton54e7afa2010-07-09 20:39:50 +00002189 uint8_t curr_break_op[8];
Stephen Wilson141eeac2010-07-20 18:41:11 +00002190 assert (break_op_size <= sizeof(curr_break_op));
Chris Lattner24943d22010-06-08 16:52:24 +00002191 bool break_op_found = false;
2192
2193 // Read the breakpoint opcode
2194 if (DoReadMemory (bp_addr, curr_break_op, break_op_size, error) == break_op_size)
2195 {
2196 bool verify = false;
2197 // Make sure we have the a breakpoint opcode exists at this address
2198 if (::memcmp (curr_break_op, break_op, break_op_size) == 0)
2199 {
2200 break_op_found = true;
2201 // We found a valid breakpoint opcode at this address, now restore
2202 // the saved opcode.
2203 if (DoWriteMemory (bp_addr, bp_site->GetSavedOpcodeBytes(), break_op_size, error) == break_op_size)
2204 {
2205 verify = true;
2206 }
2207 else
2208 error.SetErrorString("Memory write failed when restoring original opcode.");
2209 }
2210 else
2211 {
2212 error.SetErrorString("Original breakpoint trap is no longer in memory.");
2213 // Set verify to true and so we can check if the original opcode has already been restored
2214 verify = true;
2215 }
2216
2217 if (verify)
2218 {
Greg Clayton54e7afa2010-07-09 20:39:50 +00002219 uint8_t verify_opcode[8];
Stephen Wilson141eeac2010-07-20 18:41:11 +00002220 assert (break_op_size < sizeof(verify_opcode));
Chris Lattner24943d22010-06-08 16:52:24 +00002221 // Verify that our original opcode made it back to the inferior
2222 if (DoReadMemory (bp_addr, verify_opcode, break_op_size, error) == break_op_size)
2223 {
2224 // compare the memory we just read with the original opcode
2225 if (::memcmp (bp_site->GetSavedOpcodeBytes(), verify_opcode, break_op_size) == 0)
2226 {
2227 // SUCCESS
2228 bp_site->SetEnabled(false);
2229 if (log)
Daniel Malea5f35a4b2012-11-29 21:49:15 +00002230 log->Printf ("Process::DisableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- SUCCESS", bp_site->GetID(), (uint64_t)bp_addr);
Chris Lattner24943d22010-06-08 16:52:24 +00002231 return error;
2232 }
2233 else
2234 {
2235 if (break_op_found)
2236 error.SetErrorString("Failed to restore original opcode.");
2237 }
2238 }
2239 else
2240 error.SetErrorString("Failed to read memory to verify that breakpoint trap was restored.");
2241 }
2242 }
2243 else
2244 error.SetErrorString("Unable to read memory that should contain the breakpoint trap.");
2245 }
2246 }
2247 else
2248 {
2249 if (log)
Daniel Malea5f35a4b2012-11-29 21:49:15 +00002250 log->Printf ("Process::DisableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- already disabled", bp_site->GetID(), (uint64_t)bp_addr);
Chris Lattner24943d22010-06-08 16:52:24 +00002251 return error;
2252 }
2253
2254 if (log)
Daniel Malea5f35a4b2012-11-29 21:49:15 +00002255 log->Printf ("Process::DisableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- FAILED: %s",
Chris Lattner24943d22010-06-08 16:52:24 +00002256 bp_site->GetID(),
2257 (uint64_t)bp_addr,
2258 error.AsCString());
2259 return error;
2260
2261}
2262
Greg Claytonfd119992011-01-07 06:08:19 +00002263// Uncomment to verify memory caching works after making changes to caching code
2264//#define VERIFY_MEMORY_READS
2265
Sean Callananf90b5f32012-06-07 22:26:42 +00002266size_t
2267Process::ReadMemory (addr_t addr, void *buf, size_t size, Error &error)
2268{
2269 if (!GetDisableMemoryCache())
2270 {
Greg Claytonfd119992011-01-07 06:08:19 +00002271#if defined (VERIFY_MEMORY_READS)
Sean Callananf90b5f32012-06-07 22:26:42 +00002272 // Memory caching is enabled, with debug verification
2273
2274 if (buf && size)
2275 {
2276 // Uncomment the line below to make sure memory caching is working.
2277 // I ran this through the test suite and got no assertions, so I am
2278 // pretty confident this is working well. If any changes are made to
2279 // memory caching, uncomment the line below and test your changes!
2280
2281 // Verify all memory reads by using the cache first, then redundantly
2282 // reading the same memory from the inferior and comparing to make sure
2283 // everything is exactly the same.
2284 std::string verify_buf (size, '\0');
2285 assert (verify_buf.size() == size);
2286 const size_t cache_bytes_read = m_memory_cache.Read (this, addr, buf, size, error);
2287 Error verify_error;
2288 const size_t verify_bytes_read = ReadMemoryFromInferior (addr, const_cast<char *>(verify_buf.data()), verify_buf.size(), verify_error);
2289 assert (cache_bytes_read == verify_bytes_read);
2290 assert (memcmp(buf, verify_buf.data(), verify_buf.size()) == 0);
2291 assert (verify_error.Success() == error.Success());
2292 return cache_bytes_read;
2293 }
2294 return 0;
2295#else // !defined(VERIFY_MEMORY_READS)
2296 // Memory caching is enabled, without debug verification
2297
2298 return m_memory_cache.Read (addr, buf, size, error);
2299#endif // defined (VERIFY_MEMORY_READS)
Greg Claytonfd119992011-01-07 06:08:19 +00002300 }
Sean Callananf90b5f32012-06-07 22:26:42 +00002301 else
2302 {
2303 // Memory caching is disabled
2304
2305 return ReadMemoryFromInferior (addr, buf, size, error);
2306 }
Greg Claytonfd119992011-01-07 06:08:19 +00002307}
Greg Claytonfd119992011-01-07 06:08:19 +00002308
Greg Claytondd29b972012-05-18 23:20:01 +00002309size_t
2310Process::ReadCStringFromMemory (addr_t addr, std::string &out_str, Error &error)
2311{
Greg Claytoneeeb2af2012-05-19 00:18:00 +00002312 char buf[256];
Greg Claytondd29b972012-05-18 23:20:01 +00002313 out_str.clear();
2314 addr_t curr_addr = addr;
2315 while (1)
2316 {
2317 size_t length = ReadCStringFromMemory (curr_addr, buf, sizeof(buf), error);
2318 if (length == 0)
2319 break;
2320 out_str.append(buf, length);
2321 // If we got "length - 1" bytes, we didn't get the whole C string, we
2322 // need to read some more characters
2323 if (length == sizeof(buf) - 1)
2324 curr_addr += length;
2325 else
2326 break;
2327 }
2328 return out_str.size();
2329}
2330
Greg Claytonfd119992011-01-07 06:08:19 +00002331
2332size_t
Greg Clayton4a2e3372011-12-15 03:14:23 +00002333Process::ReadCStringFromMemory (addr_t addr, char *dst, size_t dst_max_len, Error &result_error)
Greg Claytonb72d0f02011-04-12 05:54:46 +00002334{
2335 size_t total_cstr_len = 0;
2336 if (dst && dst_max_len)
2337 {
Greg Clayton4a2e3372011-12-15 03:14:23 +00002338 result_error.Clear();
Greg Claytonb72d0f02011-04-12 05:54:46 +00002339 // NULL out everything just to be safe
2340 memset (dst, 0, dst_max_len);
2341 Error error;
2342 addr_t curr_addr = addr;
2343 const size_t cache_line_size = m_memory_cache.GetMemoryCacheLineSize();
2344 size_t bytes_left = dst_max_len - 1;
2345 char *curr_dst = dst;
2346
2347 while (bytes_left > 0)
2348 {
2349 addr_t cache_line_bytes_left = cache_line_size - (curr_addr % cache_line_size);
2350 addr_t bytes_to_read = std::min<addr_t>(bytes_left, cache_line_bytes_left);
2351 size_t bytes_read = ReadMemory (curr_addr, curr_dst, bytes_to_read, error);
2352
2353 if (bytes_read == 0)
2354 {
Greg Clayton4a2e3372011-12-15 03:14:23 +00002355 result_error = error;
Greg Claytonb72d0f02011-04-12 05:54:46 +00002356 dst[total_cstr_len] = '\0';
2357 break;
2358 }
2359 const size_t len = strlen(curr_dst);
2360
2361 total_cstr_len += len;
2362
2363 if (len < bytes_to_read)
2364 break;
2365
2366 curr_dst += bytes_read;
2367 curr_addr += bytes_read;
2368 bytes_left -= bytes_read;
2369 }
2370 }
Greg Clayton4a2e3372011-12-15 03:14:23 +00002371 else
2372 {
2373 if (dst == NULL)
2374 result_error.SetErrorString("invalid arguments");
2375 else
2376 result_error.Clear();
2377 }
Greg Claytonb72d0f02011-04-12 05:54:46 +00002378 return total_cstr_len;
2379}
2380
2381size_t
Greg Claytonfd119992011-01-07 06:08:19 +00002382Process::ReadMemoryFromInferior (addr_t addr, void *buf, size_t size, Error &error)
2383{
Chris Lattner24943d22010-06-08 16:52:24 +00002384 if (buf == NULL || size == 0)
2385 return 0;
2386
2387 size_t bytes_read = 0;
2388 uint8_t *bytes = (uint8_t *)buf;
2389
2390 while (bytes_read < size)
2391 {
2392 const size_t curr_size = size - bytes_read;
2393 const size_t curr_bytes_read = DoReadMemory (addr + bytes_read,
2394 bytes + bytes_read,
2395 curr_size,
2396 error);
2397 bytes_read += curr_bytes_read;
2398 if (curr_bytes_read == curr_size || curr_bytes_read == 0)
2399 break;
2400 }
2401
2402 // Replace any software breakpoint opcodes that fall into this range back
2403 // into "buf" before we return
2404 if (bytes_read > 0)
2405 RemoveBreakpointOpcodesFromBuffer (addr, bytes_read, (uint8_t *)buf);
2406 return bytes_read;
2407}
2408
Greg Claytonf72fdee2010-12-16 20:01:20 +00002409uint64_t
Greg Claytonc0fa5332011-05-22 22:46:53 +00002410Process::ReadUnsignedIntegerFromMemory (lldb::addr_t vm_addr, size_t integer_byte_size, uint64_t fail_value, Error &error)
Greg Claytonf72fdee2010-12-16 20:01:20 +00002411{
Greg Claytonc0fa5332011-05-22 22:46:53 +00002412 Scalar scalar;
2413 if (ReadScalarIntegerFromMemory(vm_addr, integer_byte_size, false, scalar, error))
2414 return scalar.ULongLong(fail_value);
2415 return fail_value;
2416}
2417
2418addr_t
2419Process::ReadPointerFromMemory (lldb::addr_t vm_addr, Error &error)
2420{
2421 Scalar scalar;
2422 if (ReadScalarIntegerFromMemory(vm_addr, GetAddressByteSize(), false, scalar, error))
2423 return scalar.ULongLong(LLDB_INVALID_ADDRESS);
2424 return LLDB_INVALID_ADDRESS;
2425}
2426
2427
2428bool
2429Process::WritePointerToMemory (lldb::addr_t vm_addr,
2430 lldb::addr_t ptr_value,
2431 Error &error)
2432{
2433 Scalar scalar;
2434 const uint32_t addr_byte_size = GetAddressByteSize();
2435 if (addr_byte_size <= 4)
2436 scalar = (uint32_t)ptr_value;
Greg Claytonf72fdee2010-12-16 20:01:20 +00002437 else
Greg Claytonc0fa5332011-05-22 22:46:53 +00002438 scalar = ptr_value;
2439 return WriteScalarToMemory(vm_addr, scalar, addr_byte_size, error) == addr_byte_size;
Greg Claytonf72fdee2010-12-16 20:01:20 +00002440}
2441
Chris Lattner24943d22010-06-08 16:52:24 +00002442size_t
2443Process::WriteMemoryPrivate (addr_t addr, const void *buf, size_t size, Error &error)
2444{
2445 size_t bytes_written = 0;
2446 const uint8_t *bytes = (const uint8_t *)buf;
2447
2448 while (bytes_written < size)
2449 {
2450 const size_t curr_size = size - bytes_written;
2451 const size_t curr_bytes_written = DoWriteMemory (addr + bytes_written,
2452 bytes + bytes_written,
2453 curr_size,
2454 error);
2455 bytes_written += curr_bytes_written;
2456 if (curr_bytes_written == curr_size || curr_bytes_written == 0)
2457 break;
2458 }
2459 return bytes_written;
2460}
2461
2462size_t
2463Process::WriteMemory (addr_t addr, const void *buf, size_t size, Error &error)
2464{
Greg Claytonfd119992011-01-07 06:08:19 +00002465#if defined (ENABLE_MEMORY_CACHING)
2466 m_memory_cache.Flush (addr, size);
2467#endif
2468
Chris Lattner24943d22010-06-08 16:52:24 +00002469 if (buf == NULL || size == 0)
2470 return 0;
Jim Inghame41494a2011-04-16 00:01:13 +00002471
Jim Ingham21f37ad2011-08-09 02:12:22 +00002472 m_mod_id.BumpMemoryID();
Jim Inghame41494a2011-04-16 00:01:13 +00002473
Chris Lattner24943d22010-06-08 16:52:24 +00002474 // We need to write any data that would go where any current software traps
2475 // (enabled software breakpoints) any software traps (breakpoints) that we
2476 // may have placed in our tasks memory.
2477
2478 BreakpointSiteList::collection::const_iterator iter = m_breakpoint_site_list.GetMap()->lower_bound (addr);
2479 BreakpointSiteList::collection::const_iterator end = m_breakpoint_site_list.GetMap()->end();
2480
2481 if (iter == end || iter->second->GetLoadAddress() > addr + size)
Greg Claytonc8bc1c32011-05-16 02:35:02 +00002482 return WriteMemoryPrivate (addr, buf, size, error);
Chris Lattner24943d22010-06-08 16:52:24 +00002483
2484 BreakpointSiteList::collection::const_iterator pos;
2485 size_t bytes_written = 0;
Greg Clayton54e7afa2010-07-09 20:39:50 +00002486 addr_t intersect_addr = 0;
2487 size_t intersect_size = 0;
2488 size_t opcode_offset = 0;
Chris Lattner24943d22010-06-08 16:52:24 +00002489 const uint8_t *ubuf = (const uint8_t *)buf;
2490
2491 for (pos = iter; pos != end; ++pos)
2492 {
2493 BreakpointSiteSP bp;
2494 bp = pos->second;
2495
2496 assert(bp->IntersectsRange(addr, size, &intersect_addr, &intersect_size, &opcode_offset));
2497 assert(addr <= intersect_addr && intersect_addr < addr + size);
2498 assert(addr < intersect_addr + intersect_size && intersect_addr + intersect_size <= addr + size);
2499 assert(opcode_offset + intersect_size <= bp->GetByteSize());
2500
2501 // Check for bytes before this breakpoint
2502 const addr_t curr_addr = addr + bytes_written;
2503 if (intersect_addr > curr_addr)
2504 {
2505 // There are some bytes before this breakpoint that we need to
2506 // just write to memory
2507 size_t curr_size = intersect_addr - curr_addr;
2508 size_t curr_bytes_written = WriteMemoryPrivate (curr_addr,
2509 ubuf + bytes_written,
2510 curr_size,
2511 error);
2512 bytes_written += curr_bytes_written;
2513 if (curr_bytes_written != curr_size)
2514 {
2515 // We weren't able to write all of the requested bytes, we
2516 // are done looping and will return the number of bytes that
2517 // we have written so far.
2518 break;
2519 }
2520 }
2521
2522 // Now write any bytes that would cover up any software breakpoints
2523 // directly into the breakpoint opcode buffer
2524 ::memcpy(bp->GetSavedOpcodeBytes() + opcode_offset, ubuf + bytes_written, intersect_size);
2525 bytes_written += intersect_size;
2526 }
2527
2528 // Write any remaining bytes after the last breakpoint if we have any left
2529 if (bytes_written < size)
2530 bytes_written += WriteMemoryPrivate (addr + bytes_written,
2531 ubuf + bytes_written,
2532 size - bytes_written,
2533 error);
Jim Inghame41494a2011-04-16 00:01:13 +00002534
Chris Lattner24943d22010-06-08 16:52:24 +00002535 return bytes_written;
2536}
Greg Claytonc0fa5332011-05-22 22:46:53 +00002537
2538size_t
Greg Clayton36da2aa2013-01-25 18:06:21 +00002539Process::WriteScalarToMemory (addr_t addr, const Scalar &scalar, size_t byte_size, Error &error)
Greg Claytonc0fa5332011-05-22 22:46:53 +00002540{
2541 if (byte_size == UINT32_MAX)
2542 byte_size = scalar.GetByteSize();
2543 if (byte_size > 0)
2544 {
2545 uint8_t buf[32];
2546 const size_t mem_size = scalar.GetAsMemoryData (buf, byte_size, GetByteOrder(), error);
2547 if (mem_size > 0)
2548 return WriteMemory(addr, buf, mem_size, error);
2549 else
2550 error.SetErrorString ("failed to get scalar as memory data");
2551 }
2552 else
2553 {
2554 error.SetErrorString ("invalid scalar value");
2555 }
2556 return 0;
2557}
2558
2559size_t
2560Process::ReadScalarIntegerFromMemory (addr_t addr,
2561 uint32_t byte_size,
2562 bool is_signed,
2563 Scalar &scalar,
2564 Error &error)
2565{
2566 uint64_t uval;
2567
2568 if (byte_size <= sizeof(uval))
2569 {
2570 size_t bytes_read = ReadMemory (addr, &uval, byte_size, error);
2571 if (bytes_read == byte_size)
2572 {
2573 DataExtractor data (&uval, sizeof(uval), GetByteOrder(), GetAddressByteSize());
Greg Clayton36da2aa2013-01-25 18:06:21 +00002574 lldb::offset_t offset = 0;
Greg Claytonc0fa5332011-05-22 22:46:53 +00002575 if (byte_size <= 4)
2576 scalar = data.GetMaxU32 (&offset, byte_size);
2577 else
2578 scalar = data.GetMaxU64 (&offset, byte_size);
2579
2580 if (is_signed)
2581 scalar.SignExtend(byte_size * 8);
2582 return bytes_read;
2583 }
2584 }
2585 else
2586 {
2587 error.SetErrorStringWithFormat ("byte size of %u is too large for integer scalar type", byte_size);
2588 }
2589 return 0;
2590}
2591
Greg Clayton613b8732011-05-17 03:37:42 +00002592#define USE_ALLOCATE_MEMORY_CACHE 1
Chris Lattner24943d22010-06-08 16:52:24 +00002593addr_t
2594Process::AllocateMemory(size_t size, uint32_t permissions, Error &error)
2595{
Jim Inghame6bd1422011-06-20 17:32:44 +00002596 if (GetPrivateState() != eStateStopped)
2597 return LLDB_INVALID_ADDRESS;
2598
Greg Clayton613b8732011-05-17 03:37:42 +00002599#if defined (USE_ALLOCATE_MEMORY_CACHE)
2600 return m_allocated_memory_cache.AllocateMemory(size, permissions, error);
2601#else
Greg Clayton2860ba92011-01-23 19:58:49 +00002602 addr_t allocated_addr = DoAllocateMemory (size, permissions, error);
2603 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
2604 if (log)
Daniel Malea5f35a4b2012-11-29 21:49:15 +00002605 log->Printf("Process::AllocateMemory(size=%4zu, permissions=%s) => 0x%16.16" PRIx64 " (m_stop_id = %u m_memory_id = %u)",
Greg Clayton2860ba92011-01-23 19:58:49 +00002606 size,
Greg Clayton613b8732011-05-17 03:37:42 +00002607 GetPermissionsAsCString (permissions),
Greg Clayton2860ba92011-01-23 19:58:49 +00002608 (uint64_t)allocated_addr,
Jim Ingham21f37ad2011-08-09 02:12:22 +00002609 m_mod_id.GetStopID(),
2610 m_mod_id.GetMemoryID());
Greg Clayton2860ba92011-01-23 19:58:49 +00002611 return allocated_addr;
Greg Clayton613b8732011-05-17 03:37:42 +00002612#endif
Chris Lattner24943d22010-06-08 16:52:24 +00002613}
2614
Sean Callanan6cf6c472011-09-20 23:01:51 +00002615bool
2616Process::CanJIT ()
2617{
Sean Callanan04200f62012-02-14 22:50:38 +00002618 if (m_can_jit == eCanJITDontKnow)
2619 {
2620 Error err;
2621
2622 uint64_t allocated_memory = AllocateMemory(8,
2623 ePermissionsReadable | ePermissionsWritable | ePermissionsExecutable,
2624 err);
2625
2626 if (err.Success())
2627 m_can_jit = eCanJITYes;
2628 else
2629 m_can_jit = eCanJITNo;
2630
2631 DeallocateMemory (allocated_memory);
2632 }
2633
Sean Callanan6cf6c472011-09-20 23:01:51 +00002634 return m_can_jit == eCanJITYes;
2635}
2636
2637void
2638Process::SetCanJIT (bool can_jit)
2639{
2640 m_can_jit = (can_jit ? eCanJITYes : eCanJITNo);
2641}
2642
Chris Lattner24943d22010-06-08 16:52:24 +00002643Error
2644Process::DeallocateMemory (addr_t ptr)
2645{
Greg Clayton613b8732011-05-17 03:37:42 +00002646 Error error;
2647#if defined (USE_ALLOCATE_MEMORY_CACHE)
2648 if (!m_allocated_memory_cache.DeallocateMemory(ptr))
2649 {
Daniel Malea5f35a4b2012-11-29 21:49:15 +00002650 error.SetErrorStringWithFormat ("deallocation of memory at 0x%" PRIx64 " failed.", (uint64_t)ptr);
Greg Clayton613b8732011-05-17 03:37:42 +00002651 }
2652#else
2653 error = DoDeallocateMemory (ptr);
Greg Clayton2860ba92011-01-23 19:58:49 +00002654
2655 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
2656 if (log)
Daniel Malea5f35a4b2012-11-29 21:49:15 +00002657 log->Printf("Process::DeallocateMemory(addr=0x%16.16" PRIx64 ") => err = %s (m_stop_id = %u, m_memory_id = %u)",
Greg Clayton2860ba92011-01-23 19:58:49 +00002658 ptr,
2659 error.AsCString("SUCCESS"),
Jim Ingham21f37ad2011-08-09 02:12:22 +00002660 m_mod_id.GetStopID(),
2661 m_mod_id.GetMemoryID());
Greg Clayton613b8732011-05-17 03:37:42 +00002662#endif
Greg Clayton2860ba92011-01-23 19:58:49 +00002663 return error;
Chris Lattner24943d22010-06-08 16:52:24 +00002664}
2665
Han Ming Ong2529aa32012-11-17 00:33:14 +00002666
Greg Claytonb5a8f142012-02-05 02:38:54 +00002667ModuleSP
Greg Clayton9ce95382012-02-13 23:10:39 +00002668Process::ReadModuleFromMemory (const FileSpec& file_spec,
2669 lldb::addr_t header_addr,
2670 bool add_image_to_target,
2671 bool load_sections_in_target)
Greg Claytonb5a8f142012-02-05 02:38:54 +00002672{
Greg Clayton6c5438b2012-02-24 21:55:59 +00002673 ModuleSP module_sp (new Module (file_spec, ArchSpec()));
Greg Claytonb5a8f142012-02-05 02:38:54 +00002674 if (module_sp)
2675 {
Greg Clayton6c5438b2012-02-24 21:55:59 +00002676 Error error;
2677 ObjectFile *objfile = module_sp->GetMemoryObjectFile (shared_from_this(), header_addr, error);
2678 if (objfile)
Greg Clayton9ce95382012-02-13 23:10:39 +00002679 {
Greg Clayton6c5438b2012-02-24 21:55:59 +00002680 if (add_image_to_target)
Greg Clayton9ce95382012-02-13 23:10:39 +00002681 {
Greg Clayton6c5438b2012-02-24 21:55:59 +00002682 m_target.GetImages().Append(module_sp);
2683 if (load_sections_in_target)
2684 {
2685 bool changed = false;
2686 module_sp->SetLoadAddress (m_target, 0, changed);
2687 }
Greg Clayton9ce95382012-02-13 23:10:39 +00002688 }
Greg Clayton6c5438b2012-02-24 21:55:59 +00002689 return module_sp;
Greg Clayton9ce95382012-02-13 23:10:39 +00002690 }
Greg Claytonb5a8f142012-02-05 02:38:54 +00002691 }
Greg Clayton6c5438b2012-02-24 21:55:59 +00002692 return ModuleSP();
Greg Claytonb5a8f142012-02-05 02:38:54 +00002693}
Chris Lattner24943d22010-06-08 16:52:24 +00002694
2695Error
Jim Ingham9c970a32012-12-18 02:03:49 +00002696Process::EnableWatchpoint (Watchpoint *watchpoint, bool notify)
Chris Lattner24943d22010-06-08 16:52:24 +00002697{
2698 Error error;
2699 error.SetErrorString("watchpoints are not supported");
2700 return error;
2701}
2702
2703Error
Jim Ingham9c970a32012-12-18 02:03:49 +00002704Process::DisableWatchpoint (Watchpoint *watchpoint, bool notify)
Chris Lattner24943d22010-06-08 16:52:24 +00002705{
2706 Error error;
2707 error.SetErrorString("watchpoints are not supported");
2708 return error;
2709}
2710
2711StateType
2712Process::WaitForProcessStopPrivate (const TimeValue *timeout, EventSP &event_sp)
2713{
2714 StateType state;
2715 // Now wait for the process to launch and return control to us, and then
2716 // call DidLaunch:
2717 while (1)
2718 {
Greg Clayton72e1c782011-01-22 23:43:18 +00002719 event_sp.reset();
2720 state = WaitForStateChangedEventsPrivate (timeout, event_sp);
2721
Greg Clayton20206082011-11-17 01:23:07 +00002722 if (StateIsStoppedState(state, false))
Chris Lattner24943d22010-06-08 16:52:24 +00002723 break;
Greg Clayton72e1c782011-01-22 23:43:18 +00002724
2725 // If state is invalid, then we timed out
2726 if (state == eStateInvalid)
2727 break;
2728
2729 if (event_sp)
Chris Lattner24943d22010-06-08 16:52:24 +00002730 HandlePrivateEvent (event_sp);
2731 }
2732 return state;
2733}
2734
2735Error
Greg Clayton36bc5ea2011-11-03 21:22:33 +00002736Process::Launch (const ProcessLaunchInfo &launch_info)
Chris Lattner24943d22010-06-08 16:52:24 +00002737{
2738 Error error;
Chris Lattner24943d22010-06-08 16:52:24 +00002739 m_abi_sp.reset();
Greg Clayton75c703d2011-02-16 04:46:07 +00002740 m_dyld_ap.reset();
Greg Clayton37f962e2011-08-22 02:49:39 +00002741 m_os_ap.reset();
Caroline Tice861efb32010-11-16 05:07:41 +00002742 m_process_input_reader.reset();
Chris Lattner24943d22010-06-08 16:52:24 +00002743
Greg Clayton5beb99d2011-08-11 02:48:45 +00002744 Module *exe_module = m_target.GetExecutableModulePointer();
Chris Lattner24943d22010-06-08 16:52:24 +00002745 if (exe_module)
2746 {
Greg Clayton180546b2011-04-30 01:09:13 +00002747 char local_exec_file_path[PATH_MAX];
2748 char platform_exec_file_path[PATH_MAX];
2749 exe_module->GetFileSpec().GetPath(local_exec_file_path, sizeof(local_exec_file_path));
2750 exe_module->GetPlatformFileSpec().GetPath(platform_exec_file_path, sizeof(platform_exec_file_path));
Chris Lattner24943d22010-06-08 16:52:24 +00002751 if (exe_module->GetFileSpec().Exists())
2752 {
Greg Claytona2f74232011-02-24 22:24:29 +00002753 if (PrivateStateThreadIsValid ())
2754 PausePrivateStateThread ();
2755
Chris Lattner24943d22010-06-08 16:52:24 +00002756 error = WillLaunch (exe_module);
2757 if (error.Success())
2758 {
Greg Claytond8c62532010-10-07 04:19:01 +00002759 SetPublicState (eStateLaunching);
Greg Claytonffa43a62011-11-17 04:46:02 +00002760 m_should_detach = false;
Chris Lattner24943d22010-06-08 16:52:24 +00002761
Greg Clayton777c6b72012-09-04 20:29:05 +00002762 if (m_run_lock.WriteTryLock())
2763 {
2764 // Now launch using these arguments.
2765 error = DoLaunch (exe_module, launch_info);
2766 }
2767 else
2768 {
2769 // This shouldn't happen
2770 error.SetErrorString("failed to acquire process run lock");
2771 }
Chris Lattner24943d22010-06-08 16:52:24 +00002772
2773 if (error.Fail())
2774 {
2775 if (GetID() != LLDB_INVALID_PROCESS_ID)
2776 {
2777 SetID (LLDB_INVALID_PROCESS_ID);
2778 const char *error_string = error.AsCString();
2779 if (error_string == NULL)
2780 error_string = "launch failed";
2781 SetExitStatus (-1, error_string);
2782 }
2783 }
2784 else
2785 {
2786 EventSP event_sp;
Greg Clayton49859592011-06-22 01:42:17 +00002787 TimeValue timeout_time;
2788 timeout_time = TimeValue::Now();
2789 timeout_time.OffsetWithSeconds(10);
2790 StateType state = WaitForProcessStopPrivate(&timeout_time, event_sp);
Chris Lattner24943d22010-06-08 16:52:24 +00002791
Greg Clayton49859592011-06-22 01:42:17 +00002792 if (state == eStateInvalid || event_sp.get() == NULL)
2793 {
2794 // We were able to launch the process, but we failed to
2795 // catch the initial stop.
2796 SetExitStatus (0, "failed to catch stop after launch");
2797 Destroy();
2798 }
2799 else if (state == eStateStopped || state == eStateCrashed)
Chris Lattner24943d22010-06-08 16:52:24 +00002800 {
Greg Clayton75c703d2011-02-16 04:46:07 +00002801
Chris Lattner24943d22010-06-08 16:52:24 +00002802 DidLaunch ();
2803
Greg Clayton9ce95382012-02-13 23:10:39 +00002804 DynamicLoader *dyld = GetDynamicLoader ();
2805 if (dyld)
2806 dyld->DidLaunch();
Greg Clayton75c703d2011-02-16 04:46:07 +00002807
Greg Clayton37f962e2011-08-22 02:49:39 +00002808 m_os_ap.reset (OperatingSystem::FindPlugin (this, NULL));
Chris Lattner24943d22010-06-08 16:52:24 +00002809 // This delays passing the stopped event to listeners till DidLaunch gets
2810 // a chance to complete...
2811 HandlePrivateEvent (event_sp);
Greg Claytona2f74232011-02-24 22:24:29 +00002812
2813 if (PrivateStateThreadIsValid ())
2814 ResumePrivateStateThread ();
2815 else
2816 StartPrivateStateThread ();
Chris Lattner24943d22010-06-08 16:52:24 +00002817 }
2818 else if (state == eStateExited)
2819 {
2820 // We exited while trying to launch somehow. Don't call DidLaunch as that's
2821 // not likely to work, and return an invalid pid.
2822 HandlePrivateEvent (event_sp);
2823 }
2824 }
2825 }
2826 }
2827 else
2828 {
Greg Clayton9c236732011-10-26 00:56:27 +00002829 error.SetErrorStringWithFormat("file doesn't exist: '%s'", local_exec_file_path);
Chris Lattner24943d22010-06-08 16:52:24 +00002830 }
2831 }
2832 return error;
2833}
2834
Greg Clayton46c9a352012-02-09 06:16:32 +00002835
2836Error
2837Process::LoadCore ()
2838{
2839 Error error = DoLoadCore();
2840 if (error.Success())
2841 {
2842 if (PrivateStateThreadIsValid ())
2843 ResumePrivateStateThread ();
2844 else
2845 StartPrivateStateThread ();
2846
Greg Clayton9ce95382012-02-13 23:10:39 +00002847 DynamicLoader *dyld = GetDynamicLoader ();
2848 if (dyld)
2849 dyld->DidAttach();
2850
2851 m_os_ap.reset (OperatingSystem::FindPlugin (this, NULL));
Greg Clayton46c9a352012-02-09 06:16:32 +00002852 // We successfully loaded a core file, now pretend we stopped so we can
2853 // show all of the threads in the core file and explore the crashed
2854 // state.
2855 SetPrivateState (eStateStopped);
2856
2857 }
2858 return error;
2859}
2860
Greg Clayton9ce95382012-02-13 23:10:39 +00002861DynamicLoader *
2862Process::GetDynamicLoader ()
2863{
2864 if (m_dyld_ap.get() == NULL)
2865 m_dyld_ap.reset (DynamicLoader::FindPlugin(this, NULL));
2866 return m_dyld_ap.get();
2867}
Greg Clayton46c9a352012-02-09 06:16:32 +00002868
2869
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002870Process::NextEventAction::EventActionResult
2871Process::AttachCompletionHandler::PerformAction (lldb::EventSP &event_sp)
Chris Lattner24943d22010-06-08 16:52:24 +00002872{
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002873 StateType state = ProcessEventData::GetStateFromEvent (event_sp.get());
2874 switch (state)
Greg Claytonc1d37752010-10-18 01:45:30 +00002875 {
Greg Clayton7e2f91c2011-01-29 07:10:55 +00002876 case eStateRunning:
Greg Claytona2f74232011-02-24 22:24:29 +00002877 case eStateConnected:
Greg Clayton7e2f91c2011-01-29 07:10:55 +00002878 return eEventActionRetry;
2879
2880 case eStateStopped:
2881 case eStateCrashed:
Greg Clayton2d9adb72011-11-12 02:10:56 +00002882 {
2883 // During attach, prior to sending the eStateStopped event,
Jim Ingham7fa7b2f2012-04-12 18:49:31 +00002884 // lldb_private::Process subclasses must set the new process ID.
Greg Clayton2d9adb72011-11-12 02:10:56 +00002885 assert (m_process->GetID() != LLDB_INVALID_PROCESS_ID);
2886 if (m_exec_count > 0)
2887 {
2888 --m_exec_count;
Jim Ingham027aaa72012-04-19 01:40:33 +00002889 m_process->PrivateResume ();
Jim Inghamf4928de2012-05-23 15:46:31 +00002890 Process::ProcessEventData::SetRestartedInEvent (event_sp.get(), true);
Greg Clayton2d9adb72011-11-12 02:10:56 +00002891 return eEventActionRetry;
2892 }
2893 else
2894 {
2895 m_process->CompleteAttach ();
2896 return eEventActionSuccess;
2897 }
2898 }
Greg Clayton7e2f91c2011-01-29 07:10:55 +00002899 break;
Greg Clayton2d9adb72011-11-12 02:10:56 +00002900
Greg Clayton7e2f91c2011-01-29 07:10:55 +00002901 default:
2902 case eStateExited:
2903 case eStateInvalid:
Greg Clayton7e2f91c2011-01-29 07:10:55 +00002904 break;
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002905 }
Greg Clayton2d9adb72011-11-12 02:10:56 +00002906
2907 m_exit_string.assign ("No valid Process");
2908 return eEventActionExit;
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002909}
Chris Lattner24943d22010-06-08 16:52:24 +00002910
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002911Process::NextEventAction::EventActionResult
2912Process::AttachCompletionHandler::HandleBeingInterrupted()
2913{
2914 return eEventActionSuccess;
2915}
2916
2917const char *
2918Process::AttachCompletionHandler::GetExitString ()
2919{
2920 return m_exit_string.c_str();
Chris Lattner24943d22010-06-08 16:52:24 +00002921}
2922
2923Error
Greg Clayton527154d2011-11-15 03:53:30 +00002924Process::Attach (ProcessAttachInfo &attach_info)
Chris Lattner24943d22010-06-08 16:52:24 +00002925{
Chris Lattner24943d22010-06-08 16:52:24 +00002926 m_abi_sp.reset();
Caroline Tice861efb32010-11-16 05:07:41 +00002927 m_process_input_reader.reset();
Greg Clayton75c703d2011-02-16 04:46:07 +00002928 m_dyld_ap.reset();
Greg Clayton37f962e2011-08-22 02:49:39 +00002929 m_os_ap.reset();
Jim Ingham7508e732010-08-09 23:31:02 +00002930
Greg Clayton527154d2011-11-15 03:53:30 +00002931 lldb::pid_t attach_pid = attach_info.GetProcessID();
Greg Claytone4b9c1f2011-03-08 22:40:15 +00002932 Error error;
Greg Clayton527154d2011-11-15 03:53:30 +00002933 if (attach_pid == LLDB_INVALID_PROCESS_ID)
Jim Ingham7508e732010-08-09 23:31:02 +00002934 {
Greg Clayton527154d2011-11-15 03:53:30 +00002935 char process_name[PATH_MAX];
Jim Ingham0d7f7772011-09-15 01:10:17 +00002936
Greg Clayton527154d2011-11-15 03:53:30 +00002937 if (attach_info.GetExecutableFile().GetPath (process_name, sizeof(process_name)))
Jim Inghamea294182010-08-17 21:54:19 +00002938 {
Greg Clayton527154d2011-11-15 03:53:30 +00002939 const bool wait_for_launch = attach_info.GetWaitForLaunch();
2940
2941 if (wait_for_launch)
Chris Lattner24943d22010-06-08 16:52:24 +00002942 {
Greg Clayton527154d2011-11-15 03:53:30 +00002943 error = WillAttachToProcessWithName(process_name, wait_for_launch);
2944 if (error.Success())
2945 {
Greg Claytond34a3b22012-10-12 16:10:12 +00002946 if (m_run_lock.WriteTryLock())
2947 {
2948 m_should_detach = true;
2949 SetPublicState (eStateAttaching);
2950 // Now attach using these arguments.
2951 error = DoAttachToProcessWithName (process_name, wait_for_launch, attach_info);
2952 }
2953 else
2954 {
2955 // This shouldn't happen
2956 error.SetErrorString("failed to acquire process run lock");
2957 }
Greg Claytonffa43a62011-11-17 04:46:02 +00002958
Greg Clayton527154d2011-11-15 03:53:30 +00002959 if (error.Fail())
2960 {
2961 if (GetID() != LLDB_INVALID_PROCESS_ID)
2962 {
2963 SetID (LLDB_INVALID_PROCESS_ID);
2964 if (error.AsCString() == NULL)
2965 error.SetErrorString("attach failed");
2966
2967 SetExitStatus(-1, error.AsCString());
2968 }
2969 }
2970 else
2971 {
2972 SetNextEventAction(new Process::AttachCompletionHandler(this, attach_info.GetResumeCount()));
2973 StartPrivateStateThread();
2974 }
2975 return error;
2976 }
Greg Claytone4b9c1f2011-03-08 22:40:15 +00002977 }
Greg Clayton527154d2011-11-15 03:53:30 +00002978 else
Greg Claytone4b9c1f2011-03-08 22:40:15 +00002979 {
Greg Clayton527154d2011-11-15 03:53:30 +00002980 ProcessInstanceInfoList process_infos;
2981 PlatformSP platform_sp (m_target.GetPlatform ());
2982
2983 if (platform_sp)
2984 {
2985 ProcessInstanceInfoMatch match_info;
2986 match_info.GetProcessInfo() = attach_info;
2987 match_info.SetNameMatchType (eNameMatchEquals);
2988 platform_sp->FindProcesses (match_info, process_infos);
2989 const uint32_t num_matches = process_infos.GetSize();
2990 if (num_matches == 1)
2991 {
2992 attach_pid = process_infos.GetProcessIDAtIndex(0);
2993 // Fall through and attach using the above process ID
2994 }
2995 else
2996 {
2997 match_info.GetProcessInfo().GetExecutableFile().GetPath (process_name, sizeof(process_name));
2998 if (num_matches > 1)
2999 error.SetErrorStringWithFormat ("more than one process named %s", process_name);
3000 else
3001 error.SetErrorStringWithFormat ("could not find a process named %s", process_name);
3002 }
3003 }
3004 else
3005 {
3006 error.SetErrorString ("invalid platform, can't find processes by name");
3007 return error;
3008 }
Greg Claytone4b9c1f2011-03-08 22:40:15 +00003009 }
Chris Lattner24943d22010-06-08 16:52:24 +00003010 }
3011 else
Greg Clayton527154d2011-11-15 03:53:30 +00003012 {
3013 error.SetErrorString ("invalid process name");
Greg Claytone4b9c1f2011-03-08 22:40:15 +00003014 }
3015 }
Greg Clayton527154d2011-11-15 03:53:30 +00003016
3017 if (attach_pid != LLDB_INVALID_PROCESS_ID)
Greg Claytone4b9c1f2011-03-08 22:40:15 +00003018 {
Greg Clayton527154d2011-11-15 03:53:30 +00003019 error = WillAttachToProcessWithID(attach_pid);
Greg Claytone4b9c1f2011-03-08 22:40:15 +00003020 if (error.Success())
Chris Lattner24943d22010-06-08 16:52:24 +00003021 {
Greg Clayton527154d2011-11-15 03:53:30 +00003022
Greg Claytond34a3b22012-10-12 16:10:12 +00003023 if (m_run_lock.WriteTryLock())
3024 {
3025 // Now attach using these arguments.
3026 m_should_detach = true;
3027 SetPublicState (eStateAttaching);
3028 error = DoAttachToProcessWithID (attach_pid, attach_info);
3029 }
3030 else
3031 {
3032 // This shouldn't happen
3033 error.SetErrorString("failed to acquire process run lock");
3034 }
3035
Greg Clayton527154d2011-11-15 03:53:30 +00003036 if (error.Success())
3037 {
3038
3039 SetNextEventAction(new Process::AttachCompletionHandler(this, attach_info.GetResumeCount()));
3040 StartPrivateStateThread();
3041 }
3042 else
Greg Claytone4b9c1f2011-03-08 22:40:15 +00003043 {
3044 if (GetID() != LLDB_INVALID_PROCESS_ID)
3045 {
3046 SetID (LLDB_INVALID_PROCESS_ID);
3047 const char *error_string = error.AsCString();
3048 if (error_string == NULL)
3049 error_string = "attach failed";
3050
3051 SetExitStatus(-1, error_string);
3052 }
3053 }
Chris Lattner24943d22010-06-08 16:52:24 +00003054 }
3055 }
3056 return error;
3057}
3058
Greg Clayton75c703d2011-02-16 04:46:07 +00003059void
3060Process::CompleteAttach ()
3061{
3062 // Let the process subclass figure out at much as it can about the process
3063 // before we go looking for a dynamic loader plug-in.
3064 DidAttach();
3065
Jim Ingham0d7f7772011-09-15 01:10:17 +00003066 // We just attached. If we have a platform, ask it for the process architecture, and if it isn't
3067 // the same as the one we've already set, switch architectures.
3068 PlatformSP platform_sp (m_target.GetPlatform ());
3069 assert (platform_sp.get());
3070 if (platform_sp)
3071 {
Greg Claytonb170aee2012-05-08 01:45:38 +00003072 const ArchSpec &target_arch = m_target.GetArchitecture();
Greg Claytonaad2b0f2013-01-11 20:49:54 +00003073 if (target_arch.IsValid() && !platform_sp->IsCompatibleArchitecture (target_arch, false, NULL))
Greg Claytonb170aee2012-05-08 01:45:38 +00003074 {
3075 ArchSpec platform_arch;
3076 platform_sp = platform_sp->GetPlatformForArchitecture (target_arch, &platform_arch);
3077 if (platform_sp)
3078 {
3079 m_target.SetPlatform (platform_sp);
3080 m_target.SetArchitecture(platform_arch);
3081 }
3082 }
3083 else
3084 {
3085 ProcessInstanceInfo process_info;
3086 platform_sp->GetProcessInfo (GetID(), process_info);
3087 const ArchSpec &process_arch = process_info.GetArchitecture();
Sean Callanan40e278c2012-12-13 22:07:14 +00003088 if (process_arch.IsValid() && !m_target.GetArchitecture().IsExactMatch(process_arch))
Greg Claytonb170aee2012-05-08 01:45:38 +00003089 m_target.SetArchitecture (process_arch);
3090 }
Jim Ingham0d7f7772011-09-15 01:10:17 +00003091 }
3092
3093 // We have completed the attach, now it is time to find the dynamic loader
Greg Clayton75c703d2011-02-16 04:46:07 +00003094 // plug-in
Greg Clayton9ce95382012-02-13 23:10:39 +00003095 DynamicLoader *dyld = GetDynamicLoader ();
3096 if (dyld)
3097 dyld->DidAttach();
Greg Clayton75c703d2011-02-16 04:46:07 +00003098
Greg Clayton37f962e2011-08-22 02:49:39 +00003099 m_os_ap.reset (OperatingSystem::FindPlugin (this, NULL));
Greg Clayton75c703d2011-02-16 04:46:07 +00003100 // Figure out which one is the executable, and set that in our target:
Enrico Granata146d9522012-11-08 02:22:02 +00003101 const ModuleList &target_modules = m_target.GetImages();
Jim Ingham93367902012-05-30 02:19:25 +00003102 Mutex::Locker modules_locker(target_modules.GetMutex());
3103 size_t num_modules = target_modules.GetSize();
3104 ModuleSP new_executable_module_sp;
Greg Clayton75c703d2011-02-16 04:46:07 +00003105
Greg Clayton75c703d2011-02-16 04:46:07 +00003106 for (int i = 0; i < num_modules; i++)
3107 {
Jim Ingham93367902012-05-30 02:19:25 +00003108 ModuleSP module_sp (target_modules.GetModuleAtIndexUnlocked (i));
Greg Claytonb72d0f02011-04-12 05:54:46 +00003109 if (module_sp && module_sp->IsExecutable())
Greg Clayton75c703d2011-02-16 04:46:07 +00003110 {
Greg Clayton5beb99d2011-08-11 02:48:45 +00003111 if (m_target.GetExecutableModulePointer() != module_sp.get())
Jim Ingham93367902012-05-30 02:19:25 +00003112 new_executable_module_sp = module_sp;
Greg Clayton75c703d2011-02-16 04:46:07 +00003113 break;
3114 }
3115 }
Jim Ingham93367902012-05-30 02:19:25 +00003116 if (new_executable_module_sp)
3117 m_target.SetExecutableModule (new_executable_module_sp, false);
Greg Clayton75c703d2011-02-16 04:46:07 +00003118}
3119
Chris Lattner24943d22010-06-08 16:52:24 +00003120Error
Jason Molendafac2e622012-09-29 04:02:01 +00003121Process::ConnectRemote (Stream *strm, const char *remote_url)
Greg Claytone71e2582011-02-04 01:58:07 +00003122{
Greg Claytone71e2582011-02-04 01:58:07 +00003123 m_abi_sp.reset();
3124 m_process_input_reader.reset();
3125
3126 // Find the process and its architecture. Make sure it matches the architecture
3127 // of the current Target, and if not adjust it.
3128
Jason Molendafac2e622012-09-29 04:02:01 +00003129 Error error (DoConnectRemote (strm, remote_url));
Greg Claytone71e2582011-02-04 01:58:07 +00003130 if (error.Success())
3131 {
Greg Claytona2f74232011-02-24 22:24:29 +00003132 if (GetID() != LLDB_INVALID_PROCESS_ID)
3133 {
Greg Clayton24bc5d92011-03-30 18:16:51 +00003134 EventSP event_sp;
3135 StateType state = WaitForProcessStopPrivate(NULL, event_sp);
3136
3137 if (state == eStateStopped || state == eStateCrashed)
3138 {
3139 // If we attached and actually have a process on the other end, then
3140 // this ended up being the equivalent of an attach.
3141 CompleteAttach ();
3142
3143 // This delays passing the stopped event to listeners till
3144 // CompleteAttach gets a chance to complete...
3145 HandlePrivateEvent (event_sp);
3146
3147 }
Greg Claytona2f74232011-02-24 22:24:29 +00003148 }
Greg Clayton24bc5d92011-03-30 18:16:51 +00003149
3150 if (PrivateStateThreadIsValid ())
3151 ResumePrivateStateThread ();
3152 else
3153 StartPrivateStateThread ();
Greg Claytone71e2582011-02-04 01:58:07 +00003154 }
3155 return error;
3156}
3157
3158
3159Error
Jim Ingham027aaa72012-04-19 01:40:33 +00003160Process::PrivateResume ()
Chris Lattner24943d22010-06-08 16:52:24 +00003161{
Jim Inghame1a654b2012-09-06 19:24:17 +00003162 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS|LIBLLDB_LOG_STEP));
Chris Lattner24943d22010-06-08 16:52:24 +00003163 if (log)
Jim Inghamac959662011-01-24 06:34:17 +00003164 log->Printf("Process::Resume() m_stop_id = %u, public state: %s private state: %s",
Jim Ingham21f37ad2011-08-09 02:12:22 +00003165 m_mod_id.GetStopID(),
Jim Inghamac959662011-01-24 06:34:17 +00003166 StateAsCString(m_public_state.GetValue()),
3167 StateAsCString(m_private_state.GetValue()));
Chris Lattner24943d22010-06-08 16:52:24 +00003168
3169 Error error (WillResume());
3170 // Tell the process it is about to resume before the thread list
3171 if (error.Success())
3172 {
Johnny Chen9c11d472010-12-02 20:53:05 +00003173 // Now let the thread list know we are about to resume so it
Chris Lattner24943d22010-06-08 16:52:24 +00003174 // can let all of our threads know that they are about to be
3175 // resumed. Threads will each be called with
3176 // Thread::WillResume(StateType) where StateType contains the state
3177 // that they are supposed to have when the process is resumed
3178 // (suspended/running/stepping). Threads should also check
3179 // their resume signal in lldb::Thread::GetResumeSignal()
3180 // to see if they are suppoed to start back up with a signal.
3181 if (m_thread_list.WillResume())
3182 {
Jim Ingham1831e782012-04-07 00:00:41 +00003183 // Last thing, do the PreResumeActions.
3184 if (!RunPreResumeActions())
Chris Lattner24943d22010-06-08 16:52:24 +00003185 {
Jim Ingham1831e782012-04-07 00:00:41 +00003186 error.SetErrorStringWithFormat ("Process::Resume PreResumeActions failed, not resuming.");
3187 }
3188 else
3189 {
3190 m_mod_id.BumpResumeID();
3191 error = DoResume();
3192 if (error.Success())
3193 {
3194 DidResume();
3195 m_thread_list.DidResume();
3196 if (log)
3197 log->Printf ("Process thinks the process has resumed.");
3198 }
Chris Lattner24943d22010-06-08 16:52:24 +00003199 }
3200 }
3201 else
3202 {
Jim Ingham0c8fa2d2012-09-01 01:02:41 +00003203 // Somebody wanted to run without running. So generate a continue & a stopped event,
3204 // and let the world handle them.
3205 if (log)
3206 log->Printf ("Process::PrivateResume() asked to simulate a start & stop.");
3207
3208 SetPrivateState(eStateRunning);
3209 SetPrivateState(eStateStopped);
Chris Lattner24943d22010-06-08 16:52:24 +00003210 }
3211 }
Jim Inghamac959662011-01-24 06:34:17 +00003212 else if (log)
3213 log->Printf ("Process::WillResume() got an error \"%s\".", error.AsCString("<unknown error>"));
Chris Lattner24943d22010-06-08 16:52:24 +00003214 return error;
3215}
3216
3217Error
3218Process::Halt ()
3219{
Jim Ingham43892562012-06-06 00:29:30 +00003220 // First make sure we aren't in the middle of handling an event, or we might restart. This is pretty weak, since
3221 // we could just straightaway get another event. It just narrows the window...
3222 m_currently_handling_event.WaitForValueEqualTo(false);
3223
3224
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003225 // Pause our private state thread so we can ensure no one else eats
3226 // the stop event out from under us.
Jim Inghamf9f40c22011-02-08 05:20:59 +00003227 Listener halt_listener ("lldb.process.halt_listener");
3228 HijackPrivateProcessEvents(&halt_listener);
Greg Clayton20d338f2010-11-18 05:57:03 +00003229
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003230 EventSP event_sp;
Greg Clayton7e2f91c2011-01-29 07:10:55 +00003231 Error error (WillHalt());
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003232
Greg Clayton7e2f91c2011-01-29 07:10:55 +00003233 if (error.Success())
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003234 {
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003235
Greg Clayton7e2f91c2011-01-29 07:10:55 +00003236 bool caused_stop = false;
3237
3238 // Ask the process subclass to actually halt our process
3239 error = DoHalt(caused_stop);
Chris Lattner24943d22010-06-08 16:52:24 +00003240 if (error.Success())
Jim Ingham3ae449a2010-11-17 02:32:00 +00003241 {
Greg Clayton7e2f91c2011-01-29 07:10:55 +00003242 if (m_public_state.GetValue() == eStateAttaching)
3243 {
3244 SetExitStatus(SIGKILL, "Cancelled async attach.");
3245 Destroy ();
3246 }
3247 else
Jim Ingham3ae449a2010-11-17 02:32:00 +00003248 {
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003249 // If "caused_stop" is true, then DoHalt stopped the process. If
3250 // "caused_stop" is false, the process was already stopped.
3251 // If the DoHalt caused the process to stop, then we want to catch
3252 // this event and set the interrupted bool to true before we pass
3253 // this along so clients know that the process was interrupted by
3254 // a halt command.
3255 if (caused_stop)
Greg Clayton20d338f2010-11-18 05:57:03 +00003256 {
Jim Inghamf9f40c22011-02-08 05:20:59 +00003257 // Wait for 1 second for the process to stop.
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003258 TimeValue timeout_time;
3259 timeout_time = TimeValue::Now();
3260 timeout_time.OffsetWithSeconds(1);
Jim Inghamf9f40c22011-02-08 05:20:59 +00003261 bool got_event = halt_listener.WaitForEvent (&timeout_time, event_sp);
3262 StateType state = ProcessEventData::GetStateFromEvent(event_sp.get());
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003263
Jim Inghamf9f40c22011-02-08 05:20:59 +00003264 if (!got_event || state == eStateInvalid)
Greg Clayton20d338f2010-11-18 05:57:03 +00003265 {
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003266 // We timeout out and didn't get a stop event...
Jim Inghamf9f40c22011-02-08 05:20:59 +00003267 error.SetErrorStringWithFormat ("Halt timed out. State = %s", StateAsCString(GetState()));
Greg Clayton20d338f2010-11-18 05:57:03 +00003268 }
3269 else
3270 {
Greg Clayton20206082011-11-17 01:23:07 +00003271 if (StateIsStoppedState (state, false))
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003272 {
3273 // We caused the process to interrupt itself, so mark this
3274 // as such in the stop event so clients can tell an interrupted
3275 // process from a natural stop
3276 ProcessEventData::SetInterruptedInEvent (event_sp.get(), true);
3277 }
3278 else
3279 {
3280 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3281 if (log)
3282 log->Printf("Process::Halt() failed to stop, state is: %s", StateAsCString(state));
3283 error.SetErrorString ("Did not get stopped event after halt.");
3284 }
Greg Clayton20d338f2010-11-18 05:57:03 +00003285 }
3286 }
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003287 DidHalt();
Jim Ingham3ae449a2010-11-17 02:32:00 +00003288 }
3289 }
Chris Lattner24943d22010-06-08 16:52:24 +00003290 }
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003291 // Resume our private state thread before we post the event (if any)
Jim Inghamf9f40c22011-02-08 05:20:59 +00003292 RestorePrivateProcessEvents();
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003293
3294 // Post any event we might have consumed. If all goes well, we will have
3295 // stopped the process, intercepted the event and set the interrupted
3296 // bool in the event. Post it to the private event queue and that will end up
3297 // correctly setting the state.
3298 if (event_sp)
3299 m_private_state_broadcaster.BroadcastEvent(event_sp);
3300
Chris Lattner24943d22010-06-08 16:52:24 +00003301 return error;
3302}
3303
3304Error
3305Process::Detach ()
3306{
3307 Error error (WillDetach());
3308
3309 if (error.Success())
3310 {
3311 DisableAllBreakpointSites();
3312 error = DoDetach();
3313 if (error.Success())
3314 {
3315 DidDetach();
3316 StopPrivateStateThread();
3317 }
3318 }
3319 return error;
3320}
3321
3322Error
3323Process::Destroy ()
3324{
3325 Error error (WillDestroy());
3326 if (error.Success())
3327 {
Greg Claytonbb1af9c2012-09-11 02:33:37 +00003328 EventSP exit_event_sp;
Jim Inghamf4928de2012-05-23 15:46:31 +00003329 if (m_public_state.GetValue() == eStateRunning)
3330 {
Greg Clayton38ae5b92012-09-05 00:37:58 +00003331 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Jim Ingham43892562012-06-06 00:29:30 +00003332 if (log)
3333 log->Printf("Process::Destroy() About to halt.");
Jim Inghamf4928de2012-05-23 15:46:31 +00003334 error = Halt();
3335 if (error.Success())
3336 {
3337 // Consume the halt event.
Jim Inghamf4928de2012-05-23 15:46:31 +00003338 TimeValue timeout (TimeValue::Now());
Jim Ingham43892562012-06-06 00:29:30 +00003339 timeout.OffsetWithSeconds(1);
Greg Claytonbb1af9c2012-09-11 02:33:37 +00003340 StateType state = WaitForProcessToStop (&timeout, &exit_event_sp);
3341 if (state != eStateExited)
3342 exit_event_sp.reset(); // It is ok to consume any non-exit stop events
3343
Jim Inghamf4928de2012-05-23 15:46:31 +00003344 if (state != eStateStopped)
3345 {
Jim Inghamf4928de2012-05-23 15:46:31 +00003346 if (log)
3347 log->Printf("Process::Destroy() Halt failed to stop, state is: %s", StateAsCString(state));
Jim Ingham43892562012-06-06 00:29:30 +00003348 // If we really couldn't stop the process then we should just error out here, but if the
3349 // lower levels just bobbled sending the event and we really are stopped, then continue on.
3350 StateType private_state = m_private_state.GetValue();
3351 if (private_state != eStateStopped && private_state != eStateExited)
3352 {
Greg Claytonbb1af9c2012-09-11 02:33:37 +00003353 // If we exited when we were waiting for a process to stop, then
3354 // forward the event here so we don't lose the event
Jim Ingham43892562012-06-06 00:29:30 +00003355 return error;
3356 }
Jim Inghamf4928de2012-05-23 15:46:31 +00003357 }
3358 }
3359 else
3360 {
Greg Claytonbb1af9c2012-09-11 02:33:37 +00003361 if (log)
3362 log->Printf("Process::Destroy() Halt got error: %s", error.AsCString());
3363 return error;
Jim Inghamf4928de2012-05-23 15:46:31 +00003364 }
3365 }
Jim Ingham43892562012-06-06 00:29:30 +00003366
3367 if (m_public_state.GetValue() != eStateRunning)
3368 {
3369 // Ditch all thread plans, and remove all our breakpoints: in case we have to restart the target to
3370 // kill it, we don't want it hitting a breakpoint...
3371 // Only do this if we've stopped, however, since if we didn't manage to halt it above, then
3372 // we're not going to have much luck doing this now.
3373 m_thread_list.DiscardThreadPlans();
3374 DisableAllBreakpointSites();
3375 }
Jim Inghamf4928de2012-05-23 15:46:31 +00003376
Chris Lattner24943d22010-06-08 16:52:24 +00003377 error = DoDestroy();
3378 if (error.Success())
3379 {
3380 DidDestroy();
3381 StopPrivateStateThread();
3382 }
Caroline Tice861efb32010-11-16 05:07:41 +00003383 m_stdio_communication.StopReadThread();
3384 m_stdio_communication.Disconnect();
3385 if (m_process_input_reader && m_process_input_reader->IsActive())
3386 m_target.GetDebugger().PopInputReader (m_process_input_reader);
3387 if (m_process_input_reader)
3388 m_process_input_reader.reset();
Greg Claytonbb1af9c2012-09-11 02:33:37 +00003389
3390 // If we exited when we were waiting for a process to stop, then
3391 // forward the event here so we don't lose the event
3392 if (exit_event_sp)
3393 {
3394 // Directly broadcast our exited event because we shut down our
3395 // private state thread above
3396 BroadcastEvent(exit_event_sp);
3397 }
3398
Jim Ingham7fa7b2f2012-04-12 18:49:31 +00003399 // If we have been interrupted (to kill us) in the middle of running, we may not end up propagating
3400 // the last events through the event system, in which case we might strand the write lock. Unlock
3401 // it here so when we do to tear down the process we don't get an error destroying the lock.
3402 m_run_lock.WriteUnlock();
Chris Lattner24943d22010-06-08 16:52:24 +00003403 }
3404 return error;
3405}
3406
3407Error
3408Process::Signal (int signal)
3409{
3410 Error error (WillSignal());
3411 if (error.Success())
3412 {
3413 error = DoSignal(signal);
3414 if (error.Success())
3415 DidSignal();
3416 }
3417 return error;
3418}
3419
Greg Clayton395fc332011-02-15 21:59:32 +00003420lldb::ByteOrder
3421Process::GetByteOrder () const
Chris Lattner24943d22010-06-08 16:52:24 +00003422{
Greg Clayton395fc332011-02-15 21:59:32 +00003423 return m_target.GetArchitecture().GetByteOrder();
Chris Lattner24943d22010-06-08 16:52:24 +00003424}
3425
3426uint32_t
Greg Clayton395fc332011-02-15 21:59:32 +00003427Process::GetAddressByteSize () const
Chris Lattner24943d22010-06-08 16:52:24 +00003428{
Greg Clayton395fc332011-02-15 21:59:32 +00003429 return m_target.GetArchitecture().GetAddressByteSize();
Chris Lattner24943d22010-06-08 16:52:24 +00003430}
3431
Greg Clayton395fc332011-02-15 21:59:32 +00003432
Chris Lattner24943d22010-06-08 16:52:24 +00003433bool
3434Process::ShouldBroadcastEvent (Event *event_ptr)
3435{
3436 const StateType state = Process::ProcessEventData::GetStateFromEvent (event_ptr);
3437 bool return_value = true;
Greg Claytone005f2c2010-11-06 01:53:30 +00003438 LogSP log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EVENTS));
Chris Lattner24943d22010-06-08 16:52:24 +00003439
3440 switch (state)
3441 {
Greg Claytone71e2582011-02-04 01:58:07 +00003442 case eStateConnected:
Chris Lattner24943d22010-06-08 16:52:24 +00003443 case eStateAttaching:
3444 case eStateLaunching:
3445 case eStateDetached:
3446 case eStateExited:
3447 case eStateUnloaded:
3448 // These events indicate changes in the state of the debugging session, always report them.
3449 return_value = true;
3450 break;
3451 case eStateInvalid:
3452 // We stopped for no apparent reason, don't report it.
3453 return_value = false;
3454 break;
3455 case eStateRunning:
3456 case eStateStepping:
3457 // If we've started the target running, we handle the cases where we
3458 // are already running and where there is a transition from stopped to
3459 // running differently.
3460 // running -> running: Automatically suppress extra running events
3461 // stopped -> running: Report except when there is one or more no votes
3462 // and no yes votes.
3463 SynchronouslyNotifyStateChanged (state);
3464 switch (m_public_state.GetValue())
3465 {
3466 case eStateRunning:
3467 case eStateStepping:
3468 // We always suppress multiple runnings with no PUBLIC stop in between.
3469 return_value = false;
3470 break;
3471 default:
3472 // TODO: make this work correctly. For now always report
3473 // run if we aren't running so we don't miss any runnning
3474 // events. If I run the lldb/test/thread/a.out file and
3475 // break at main.cpp:58, run and hit the breakpoints on
3476 // multiple threads, then somehow during the stepping over
3477 // of all breakpoints no run gets reported.
Chris Lattner24943d22010-06-08 16:52:24 +00003478
3479 // This is a transition from stop to run.
3480 switch (m_thread_list.ShouldReportRun (event_ptr))
3481 {
3482 case eVoteYes:
3483 case eVoteNoOpinion:
3484 return_value = true;
3485 break;
3486 case eVoteNo:
3487 return_value = false;
3488 break;
3489 }
3490 break;
3491 }
3492 break;
3493 case eStateStopped:
3494 case eStateCrashed:
3495 case eStateSuspended:
3496 {
3497 // We've stopped. First see if we're going to restart the target.
3498 // If we are going to stop, then we always broadcast the event.
3499 // If we aren't going to stop, let the thread plans decide if we're going to report this event.
Jim Ingham5a47e8b2010-06-19 04:45:32 +00003500 // If no thread has an opinion, we don't report it.
Jim Inghamf63f2ba2012-05-16 01:32:14 +00003501
3502 RefreshStateAfterStop ();
Jim Ingham3ae449a2010-11-17 02:32:00 +00003503 if (ProcessEventData::GetInterruptedFromEvent (event_ptr))
Chris Lattner24943d22010-06-08 16:52:24 +00003504 {
Greg Clayton20d338f2010-11-18 05:57:03 +00003505 if (log)
3506 log->Printf ("Process::ShouldBroadcastEvent (%p) stopped due to an interrupt, state: %s", event_ptr, StateAsCString(state));
Jim Ingham3ae449a2010-11-17 02:32:00 +00003507 return true;
3508 }
3509 else
3510 {
Chris Lattner24943d22010-06-08 16:52:24 +00003511
3512 if (m_thread_list.ShouldStop (event_ptr) == false)
3513 {
Jim Ingham8290bba2012-09-05 21:13:56 +00003514 // ShouldStop may have restarted the target already. If so, don't
3515 // resume it twice.
3516 bool was_restarted = ProcessEventData::GetRestartedFromEvent (event_ptr);
Chris Lattner24943d22010-06-08 16:52:24 +00003517 switch (m_thread_list.ShouldReportStop (event_ptr))
3518 {
3519 case eVoteYes:
3520 Process::ProcessEventData::SetRestartedInEvent (event_ptr, true);
Johnny Chen028784b2010-10-14 00:54:32 +00003521 // Intentional fall-through here.
Chris Lattner24943d22010-06-08 16:52:24 +00003522 case eVoteNoOpinion:
Chris Lattner24943d22010-06-08 16:52:24 +00003523 case eVoteNo:
3524 return_value = false;
3525 break;
3526 }
3527
3528 if (log)
Jim Ingham3ae449a2010-11-17 02:32:00 +00003529 log->Printf ("Process::ShouldBroadcastEvent (%p) Restarting process from state: %s", event_ptr, StateAsCString(state));
Jim Ingham8290bba2012-09-05 21:13:56 +00003530 if (!was_restarted)
3531 PrivateResume ();
Chris Lattner24943d22010-06-08 16:52:24 +00003532 }
3533 else
3534 {
3535 return_value = true;
3536 SynchronouslyNotifyStateChanged (state);
3537 }
3538 }
3539 }
3540 }
3541
3542 if (log)
Jason Molenda7e5fa7f2011-09-20 21:44:10 +00003543 log->Printf ("Process::ShouldBroadcastEvent (%p) => %s - %s", event_ptr, StateAsCString(state), return_value ? "YES" : "NO");
Chris Lattner24943d22010-06-08 16:52:24 +00003544 return return_value;
3545}
3546
Chris Lattner24943d22010-06-08 16:52:24 +00003547
3548bool
Jim Ingham1831e782012-04-07 00:00:41 +00003549Process::StartPrivateStateThread (bool force)
Chris Lattner24943d22010-06-08 16:52:24 +00003550{
Greg Claytone005f2c2010-11-06 01:53:30 +00003551 LogSP log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EVENTS));
Chris Lattner24943d22010-06-08 16:52:24 +00003552
Greg Claytonb72d0f02011-04-12 05:54:46 +00003553 bool already_running = PrivateStateThreadIsValid ();
Chris Lattner24943d22010-06-08 16:52:24 +00003554 if (log)
Greg Claytonb72d0f02011-04-12 05:54:46 +00003555 log->Printf ("Process::%s()%s ", __FUNCTION__, already_running ? " already running" : " starting private state thread");
3556
Jim Ingham1831e782012-04-07 00:00:41 +00003557 if (!force && already_running)
Greg Claytonb72d0f02011-04-12 05:54:46 +00003558 return true;
Chris Lattner24943d22010-06-08 16:52:24 +00003559
3560 // Create a thread that watches our internal state and controls which
3561 // events make it to clients (into the DCProcess event queue).
Greg Claytona875b642011-01-09 21:07:35 +00003562 char thread_name[1024];
Jim Ingham1831e782012-04-07 00:00:41 +00003563 if (already_running)
Daniel Malea5f35a4b2012-11-29 21:49:15 +00003564 snprintf(thread_name, sizeof(thread_name), "<lldb.process.internal-state-override(pid=%" PRIu64 ")>", GetID());
Jim Ingham1831e782012-04-07 00:00:41 +00003565 else
Daniel Malea5f35a4b2012-11-29 21:49:15 +00003566 snprintf(thread_name, sizeof(thread_name), "<lldb.process.internal-state(pid=%" PRIu64 ")>", GetID());
Jim Inghamd21d98b2012-04-10 01:21:57 +00003567
3568 // Create the private state thread, and start it running.
Greg Claytona875b642011-01-09 21:07:35 +00003569 m_private_state_thread = Host::ThreadCreate (thread_name, Process::PrivateStateThread, this, NULL);
Jim Inghamd21d98b2012-04-10 01:21:57 +00003570 bool success = IS_VALID_LLDB_HOST_THREAD(m_private_state_thread);
3571 if (success)
3572 {
3573 ResumePrivateStateThread();
3574 return true;
3575 }
3576 else
3577 return false;
Chris Lattner24943d22010-06-08 16:52:24 +00003578}
3579
3580void
3581Process::PausePrivateStateThread ()
3582{
3583 ControlPrivateStateThread (eBroadcastInternalStateControlPause);
3584}
3585
3586void
3587Process::ResumePrivateStateThread ()
3588{
3589 ControlPrivateStateThread (eBroadcastInternalStateControlResume);
3590}
3591
3592void
3593Process::StopPrivateStateThread ()
3594{
Greg Claytonb72d0f02011-04-12 05:54:46 +00003595 if (PrivateStateThreadIsValid ())
3596 ControlPrivateStateThread (eBroadcastInternalStateControlStop);
Jim Ingham7fa7b2f2012-04-12 18:49:31 +00003597 else
3598 {
3599 LogSP log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_PROCESS));
3600 if (log)
3601 printf ("Went to stop the private state thread, but it was already invalid.");
3602 }
Chris Lattner24943d22010-06-08 16:52:24 +00003603}
3604
3605void
3606Process::ControlPrivateStateThread (uint32_t signal)
3607{
Jim Ingham7fa7b2f2012-04-12 18:49:31 +00003608 LogSP log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_PROCESS));
Chris Lattner24943d22010-06-08 16:52:24 +00003609
3610 assert (signal == eBroadcastInternalStateControlStop ||
3611 signal == eBroadcastInternalStateControlPause ||
3612 signal == eBroadcastInternalStateControlResume);
3613
3614 if (log)
Greg Claytonf4fbc0b2011-01-22 17:43:17 +00003615 log->Printf ("Process::%s (signal = %d)", __FUNCTION__, signal);
Chris Lattner24943d22010-06-08 16:52:24 +00003616
Greg Claytonf4fbc0b2011-01-22 17:43:17 +00003617 // Signal the private state thread. First we should copy this is case the
3618 // thread starts exiting since the private state thread will NULL this out
3619 // when it exits
3620 const lldb::thread_t private_state_thread = m_private_state_thread;
Greg Clayton09c81ef2011-02-08 01:34:25 +00003621 if (IS_VALID_LLDB_HOST_THREAD(private_state_thread))
Chris Lattner24943d22010-06-08 16:52:24 +00003622 {
3623 TimeValue timeout_time;
3624 bool timed_out;
3625
3626 m_private_state_control_broadcaster.BroadcastEvent (signal, NULL);
3627
3628 timeout_time = TimeValue::Now();
3629 timeout_time.OffsetWithSeconds(2);
Jim Ingham7fa7b2f2012-04-12 18:49:31 +00003630 if (log)
3631 log->Printf ("Sending control event of type: %d.", signal);
Chris Lattner24943d22010-06-08 16:52:24 +00003632 m_private_state_control_wait.WaitForValueEqualTo (true, &timeout_time, &timed_out);
3633 m_private_state_control_wait.SetValue (false, eBroadcastNever);
3634
3635 if (signal == eBroadcastInternalStateControlStop)
3636 {
3637 if (timed_out)
Jim Ingham7fa7b2f2012-04-12 18:49:31 +00003638 {
3639 Error error;
3640 Host::ThreadCancel (private_state_thread, &error);
3641 if (log)
3642 log->Printf ("Timed out responding to the control event, cancel got error: \"%s\".", error.AsCString());
3643 }
3644 else
3645 {
3646 if (log)
3647 log->Printf ("The control event killed the private state thread without having to cancel.");
3648 }
Chris Lattner24943d22010-06-08 16:52:24 +00003649
3650 thread_result_t result = NULL;
Greg Claytonf4fbc0b2011-01-22 17:43:17 +00003651 Host::ThreadJoin (private_state_thread, &result, NULL);
Greg Claytonc607d862010-07-22 18:34:21 +00003652 m_private_state_thread = LLDB_INVALID_HOST_THREAD;
Chris Lattner24943d22010-06-08 16:52:24 +00003653 }
3654 }
Jim Ingham7fa7b2f2012-04-12 18:49:31 +00003655 else
3656 {
3657 if (log)
3658 log->Printf ("Private state thread already dead, no need to signal it to stop.");
3659 }
Chris Lattner24943d22010-06-08 16:52:24 +00003660}
3661
3662void
Jim Ingham5d90ade2012-07-27 23:57:19 +00003663Process::SendAsyncInterrupt ()
3664{
3665 if (PrivateStateThreadIsValid())
3666 m_private_state_broadcaster.BroadcastEvent (Process::eBroadcastBitInterrupt, NULL);
3667 else
3668 BroadcastEvent (Process::eBroadcastBitInterrupt, NULL);
3669}
3670
3671void
Chris Lattner24943d22010-06-08 16:52:24 +00003672Process::HandlePrivateEvent (EventSP &event_sp)
3673{
Greg Claytone005f2c2010-11-06 01:53:30 +00003674 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Jim Ingham43892562012-06-06 00:29:30 +00003675 m_currently_handling_event.SetValue(true, eBroadcastNever);
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003676
Greg Clayton68ca8232011-01-25 02:58:48 +00003677 const StateType new_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003678
3679 // First check to see if anybody wants a shot at this event:
Jim Ingham68bffc52011-01-29 04:05:41 +00003680 if (m_next_event_action_ap.get() != NULL)
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003681 {
Jim Ingham68bffc52011-01-29 04:05:41 +00003682 NextEventAction::EventActionResult action_result = m_next_event_action_ap->PerformAction(event_sp);
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003683 switch (action_result)
3684 {
3685 case NextEventAction::eEventActionSuccess:
3686 SetNextEventAction(NULL);
3687 break;
Greg Clayton2d9adb72011-11-12 02:10:56 +00003688
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003689 case NextEventAction::eEventActionRetry:
3690 break;
Greg Clayton2d9adb72011-11-12 02:10:56 +00003691
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003692 case NextEventAction::eEventActionExit:
Jim Ingham84c86382011-01-29 01:57:31 +00003693 // Handle Exiting Here. If we already got an exited event,
3694 // we should just propagate it. Otherwise, swallow this event,
3695 // and set our state to exit so the next event will kill us.
3696 if (new_state != eStateExited)
3697 {
3698 // FIXME: should cons up an exited event, and discard this one.
Jim Ingham68bffc52011-01-29 04:05:41 +00003699 SetExitStatus(0, m_next_event_action_ap->GetExitString());
Jim Ingham84c86382011-01-29 01:57:31 +00003700 SetNextEventAction(NULL);
3701 return;
3702 }
3703 SetNextEventAction(NULL);
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003704 break;
3705 }
3706 }
3707
Chris Lattner24943d22010-06-08 16:52:24 +00003708 // See if we should broadcast this state to external clients?
3709 const bool should_broadcast = ShouldBroadcastEvent (event_sp.get());
Chris Lattner24943d22010-06-08 16:52:24 +00003710
3711 if (should_broadcast)
3712 {
3713 if (log)
3714 {
Daniel Malea5f35a4b2012-11-29 21:49:15 +00003715 log->Printf ("Process::%s (pid = %" PRIu64 ") broadcasting new state %s (old state %s) to %s",
Greg Clayton68ca8232011-01-25 02:58:48 +00003716 __FUNCTION__,
3717 GetID(),
3718 StateAsCString(new_state),
3719 StateAsCString (GetState ()),
3720 IsHijackedForEvent(eBroadcastBitStateChanged) ? "hijacked" : "public");
Chris Lattner24943d22010-06-08 16:52:24 +00003721 }
Jim Inghamd60d94a2011-03-11 03:53:59 +00003722 Process::ProcessEventData::SetUpdateStateOnRemoval(event_sp.get());
Greg Clayton68ca8232011-01-25 02:58:48 +00003723 if (StateIsRunningState (new_state))
Caroline Tice861efb32010-11-16 05:07:41 +00003724 PushProcessInputReader ();
3725 else
3726 PopProcessInputReader ();
Jim Inghamd60d94a2011-03-11 03:53:59 +00003727
Chris Lattner24943d22010-06-08 16:52:24 +00003728 BroadcastEvent (event_sp);
3729 }
3730 else
3731 {
3732 if (log)
3733 {
Daniel Malea5f35a4b2012-11-29 21:49:15 +00003734 log->Printf ("Process::%s (pid = %" PRIu64 ") suppressing state %s (old state %s): should_broadcast == false",
Greg Clayton68ca8232011-01-25 02:58:48 +00003735 __FUNCTION__,
3736 GetID(),
3737 StateAsCString(new_state),
Jason Molenda7e5fa7f2011-09-20 21:44:10 +00003738 StateAsCString (GetState ()));
Chris Lattner24943d22010-06-08 16:52:24 +00003739 }
3740 }
Jim Ingham43892562012-06-06 00:29:30 +00003741 m_currently_handling_event.SetValue(false, eBroadcastAlways);
Chris Lattner24943d22010-06-08 16:52:24 +00003742}
3743
3744void *
3745Process::PrivateStateThread (void *arg)
3746{
3747 Process *proc = static_cast<Process*> (arg);
3748 void *result = proc->RunPrivateStateThread ();
Chris Lattner24943d22010-06-08 16:52:24 +00003749 return result;
3750}
3751
3752void *
3753Process::RunPrivateStateThread ()
3754{
Jim Inghamd21d98b2012-04-10 01:21:57 +00003755 bool control_only = true;
Jim Ingham7fa7b2f2012-04-12 18:49:31 +00003756 m_private_state_control_wait.SetValue (false, eBroadcastNever);
Chris Lattner24943d22010-06-08 16:52:24 +00003757
Greg Claytone005f2c2010-11-06 01:53:30 +00003758 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner24943d22010-06-08 16:52:24 +00003759 if (log)
Daniel Malea5f35a4b2012-11-29 21:49:15 +00003760 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") thread starting...", __FUNCTION__, this, GetID());
Chris Lattner24943d22010-06-08 16:52:24 +00003761
3762 bool exit_now = false;
3763 while (!exit_now)
3764 {
3765 EventSP event_sp;
3766 WaitForEventsPrivate (NULL, event_sp, control_only);
3767 if (event_sp->BroadcasterIs(&m_private_state_control_broadcaster))
3768 {
Jim Ingham7fa7b2f2012-04-12 18:49:31 +00003769 if (log)
Daniel Malea5f35a4b2012-11-29 21:49:15 +00003770 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") got a control event: %d", __FUNCTION__, this, GetID(), event_sp->GetType());
Jim Ingham7fa7b2f2012-04-12 18:49:31 +00003771
Chris Lattner24943d22010-06-08 16:52:24 +00003772 switch (event_sp->GetType())
3773 {
3774 case eBroadcastInternalStateControlStop:
3775 exit_now = true;
Chris Lattner24943d22010-06-08 16:52:24 +00003776 break; // doing any internal state managment below
3777
3778 case eBroadcastInternalStateControlPause:
3779 control_only = true;
3780 break;
3781
3782 case eBroadcastInternalStateControlResume:
3783 control_only = false;
3784 break;
3785 }
Jim Ingham3ae449a2010-11-17 02:32:00 +00003786
Chris Lattner24943d22010-06-08 16:52:24 +00003787 m_private_state_control_wait.SetValue (true, eBroadcastAlways);
Jim Ingham3ae449a2010-11-17 02:32:00 +00003788 continue;
Chris Lattner24943d22010-06-08 16:52:24 +00003789 }
Jim Ingham5d90ade2012-07-27 23:57:19 +00003790 else if (event_sp->GetType() == eBroadcastBitInterrupt)
3791 {
3792 if (m_public_state.GetValue() == eStateAttaching)
3793 {
3794 if (log)
Daniel Malea5f35a4b2012-11-29 21:49:15 +00003795 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") woke up with an interrupt while attaching - forwarding interrupt.", __FUNCTION__, this, GetID());
Jim Ingham5d90ade2012-07-27 23:57:19 +00003796 BroadcastEvent (eBroadcastBitInterrupt, NULL);
3797 }
3798 else
3799 {
3800 if (log)
Daniel Malea5f35a4b2012-11-29 21:49:15 +00003801 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") woke up with an interrupt - Halting.", __FUNCTION__, this, GetID());
Jim Ingham5d90ade2012-07-27 23:57:19 +00003802 Halt();
3803 }
3804 continue;
3805 }
Chris Lattner24943d22010-06-08 16:52:24 +00003806
3807 const StateType internal_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
3808
3809 if (internal_state != eStateInvalid)
3810 {
3811 HandlePrivateEvent (event_sp);
3812 }
3813
Greg Clayton3b2c41c2010-10-18 04:14:23 +00003814 if (internal_state == eStateInvalid ||
3815 internal_state == eStateExited ||
3816 internal_state == eStateDetached )
Jim Ingham3ae449a2010-11-17 02:32:00 +00003817 {
Jim Ingham3ae449a2010-11-17 02:32:00 +00003818 if (log)
Daniel Malea5f35a4b2012-11-29 21:49:15 +00003819 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") about to exit with internal state %s...", __FUNCTION__, this, GetID(), StateAsCString(internal_state));
Jim Ingham3ae449a2010-11-17 02:32:00 +00003820
Chris Lattner24943d22010-06-08 16:52:24 +00003821 break;
Jim Ingham3ae449a2010-11-17 02:32:00 +00003822 }
Chris Lattner24943d22010-06-08 16:52:24 +00003823 }
3824
Caroline Tice926060e2010-10-29 21:48:37 +00003825 // Verify log is still enabled before attempting to write to it...
Chris Lattner24943d22010-06-08 16:52:24 +00003826 if (log)
Daniel Malea5f35a4b2012-11-29 21:49:15 +00003827 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") thread exiting...", __FUNCTION__, this, GetID());
Chris Lattner24943d22010-06-08 16:52:24 +00003828
Greg Claytona4881d02011-01-22 07:12:45 +00003829 m_private_state_control_wait.SetValue (true, eBroadcastAlways);
3830 m_private_state_thread = LLDB_INVALID_HOST_THREAD;
Chris Lattner24943d22010-06-08 16:52:24 +00003831 return NULL;
3832}
3833
Chris Lattner24943d22010-06-08 16:52:24 +00003834//------------------------------------------------------------------
3835// Process Event Data
3836//------------------------------------------------------------------
3837
3838Process::ProcessEventData::ProcessEventData () :
3839 EventData (),
3840 m_process_sp (),
3841 m_state (eStateInvalid),
Greg Clayton54e7afa2010-07-09 20:39:50 +00003842 m_restarted (false),
Jim Ingham6cf4d2b2011-05-22 21:45:01 +00003843 m_update_state (0),
Jim Ingham3ae449a2010-11-17 02:32:00 +00003844 m_interrupted (false)
Chris Lattner24943d22010-06-08 16:52:24 +00003845{
3846}
3847
3848Process::ProcessEventData::ProcessEventData (const ProcessSP &process_sp, StateType state) :
3849 EventData (),
3850 m_process_sp (process_sp),
3851 m_state (state),
Greg Clayton54e7afa2010-07-09 20:39:50 +00003852 m_restarted (false),
Jim Ingham6cf4d2b2011-05-22 21:45:01 +00003853 m_update_state (0),
Jim Ingham3ae449a2010-11-17 02:32:00 +00003854 m_interrupted (false)
Chris Lattner24943d22010-06-08 16:52:24 +00003855{
3856}
3857
3858Process::ProcessEventData::~ProcessEventData()
3859{
3860}
3861
3862const ConstString &
3863Process::ProcessEventData::GetFlavorString ()
3864{
3865 static ConstString g_flavor ("Process::ProcessEventData");
3866 return g_flavor;
3867}
3868
3869const ConstString &
3870Process::ProcessEventData::GetFlavor () const
3871{
3872 return ProcessEventData::GetFlavorString ();
3873}
3874
Chris Lattner24943d22010-06-08 16:52:24 +00003875void
3876Process::ProcessEventData::DoOnRemoval (Event *event_ptr)
3877{
3878 // This function gets called twice for each event, once when the event gets pulled
Jim Ingham6cf4d2b2011-05-22 21:45:01 +00003879 // off of the private process event queue, and then any number of times, first when it gets pulled off of
3880 // the public event queue, then other times when we're pretending that this is where we stopped at the
3881 // end of expression evaluation. m_update_state is used to distinguish these
3882 // three cases; it is 0 when we're just pulling it off for private handling,
3883 // and > 1 for expression evaluation, and we don't want to do the breakpoint command handling then.
Chris Lattner24943d22010-06-08 16:52:24 +00003884
Jim Ingham6cf4d2b2011-05-22 21:45:01 +00003885 if (m_update_state != 1)
Chris Lattner24943d22010-06-08 16:52:24 +00003886 return;
3887
3888 m_process_sp->SetPublicState (m_state);
3889
3890 // If we're stopped and haven't restarted, then do the breakpoint commands here:
3891 if (m_state == eStateStopped && ! m_restarted)
Jim Ingham0296fe72011-11-08 03:00:11 +00003892 {
3893 ThreadList &curr_thread_list = m_process_sp->GetThreadList();
Greg Claytond9919d32011-12-01 23:28:38 +00003894 uint32_t num_threads = curr_thread_list.GetSize();
3895 uint32_t idx;
Greg Clayton643ee732010-08-04 01:40:35 +00003896
Jim Ingham21f37ad2011-08-09 02:12:22 +00003897 // The actions might change one of the thread's stop_info's opinions about whether we should
3898 // stop the process, so we need to query that as we go.
Jim Ingham0296fe72011-11-08 03:00:11 +00003899
3900 // One other complication here, is that we try to catch any case where the target has run (except for expressions)
3901 // and immediately exit, but if we get that wrong (which is possible) then the thread list might have changed, and
3902 // that would cause our iteration here to crash. We could make a copy of the thread list, but we'd really like
3903 // 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
3904 // against this list & bag out if anything differs.
Greg Claytond9919d32011-12-01 23:28:38 +00003905 std::vector<uint32_t> thread_index_array(num_threads);
Jim Ingham0296fe72011-11-08 03:00:11 +00003906 for (idx = 0; idx < num_threads; ++idx)
3907 thread_index_array[idx] = curr_thread_list.GetThreadAtIndex(idx)->GetIndexID();
3908
Jim Inghamb6059b22012-12-13 22:24:15 +00003909 // Use this to track whether we should continue from here. We will only continue the target running if
3910 // no thread says we should stop. Of course if some thread's PerformAction actually sets the target running,
3911 // then it doesn't matter what the other threads say...
3912
3913 bool still_should_stop = false;
Jim Ingham21f37ad2011-08-09 02:12:22 +00003914
Chris Lattner24943d22010-06-08 16:52:24 +00003915 for (idx = 0; idx < num_threads; ++idx)
3916 {
Jim Ingham0296fe72011-11-08 03:00:11 +00003917 curr_thread_list = m_process_sp->GetThreadList();
3918 if (curr_thread_list.GetSize() != num_threads)
3919 {
3920 lldb::LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STEP | LIBLLDB_LOG_PROCESS));
Jim Ingham60526c42011-12-01 20:26:15 +00003921 if (log)
Greg Claytond9919d32011-12-01 23:28:38 +00003922 log->Printf("Number of threads changed from %u to %u while processing event.", num_threads, curr_thread_list.GetSize());
Jim Ingham0296fe72011-11-08 03:00:11 +00003923 break;
3924 }
3925
3926 lldb::ThreadSP thread_sp = curr_thread_list.GetThreadAtIndex(idx);
3927
3928 if (thread_sp->GetIndexID() != thread_index_array[idx])
3929 {
3930 lldb::LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STEP | LIBLLDB_LOG_PROCESS));
Jim Ingham60526c42011-12-01 20:26:15 +00003931 if (log)
Greg Claytond9919d32011-12-01 23:28:38 +00003932 log->Printf("The thread at position %u changed from %u to %u while processing event.",
Jim Ingham60526c42011-12-01 20:26:15 +00003933 idx,
3934 thread_index_array[idx],
3935 thread_sp->GetIndexID());
Jim Ingham0296fe72011-11-08 03:00:11 +00003936 break;
3937 }
3938
Jim Ingham6297a3a2010-10-20 00:39:53 +00003939 StopInfoSP stop_info_sp = thread_sp->GetStopInfo ();
Jim Ingham6bc24c12012-10-16 00:09:33 +00003940 if (stop_info_sp && stop_info_sp->IsValid())
Chris Lattner24943d22010-06-08 16:52:24 +00003941 {
Jim Ingham6297a3a2010-10-20 00:39:53 +00003942 stop_info_sp->PerformAction(event_ptr);
Jim Ingham21f37ad2011-08-09 02:12:22 +00003943 // The stop action might restart the target. If it does, then we want to mark that in the
3944 // event so that whoever is receiving it will know to wait for the running event and reflect
3945 // that state appropriately.
3946 // We also need to stop processing actions, since they aren't expecting the target to be running.
Jim Ingham0296fe72011-11-08 03:00:11 +00003947
3948 // FIXME: we might have run.
3949 if (stop_info_sp->HasTargetRunSinceMe())
Jim Ingham21f37ad2011-08-09 02:12:22 +00003950 {
3951 SetRestarted (true);
3952 break;
3953 }
Jim Inghamb6059b22012-12-13 22:24:15 +00003954
3955 bool this_thread_wants_to_stop = stop_info_sp->ShouldStop(event_ptr);
3956 if (still_should_stop == false)
3957 still_should_stop = this_thread_wants_to_stop;
Chris Lattner24943d22010-06-08 16:52:24 +00003958 }
3959 }
Jim Ingham6fb8baa2010-08-10 00:59:59 +00003960
Jim Ingham21f37ad2011-08-09 02:12:22 +00003961
3962 if (m_process_sp->GetPrivateState() != eStateRunning)
Jim Inghamd60d94a2011-03-11 03:53:59 +00003963 {
Jim Ingham21f37ad2011-08-09 02:12:22 +00003964 if (!still_should_stop)
3965 {
3966 // We've been asked to continue, so do that here.
Jim Inghamd60d94a2011-03-11 03:53:59 +00003967 SetRestarted(true);
Jim Ingham027aaa72012-04-19 01:40:33 +00003968 // Use the public resume method here, since this is just
3969 // extending a public resume.
Jim Ingham21f37ad2011-08-09 02:12:22 +00003970 m_process_sp->Resume();
3971 }
3972 else
3973 {
3974 // If we didn't restart, run the Stop Hooks here:
3975 // They might also restart the target, so watch for that.
3976 m_process_sp->GetTarget().RunStopHooks();
3977 if (m_process_sp->GetPrivateState() == eStateRunning)
3978 SetRestarted(true);
3979 }
Jim Inghamd60d94a2011-03-11 03:53:59 +00003980 }
3981
Chris Lattner24943d22010-06-08 16:52:24 +00003982 }
3983}
3984
3985void
3986Process::ProcessEventData::Dump (Stream *s) const
3987{
3988 if (m_process_sp)
Daniel Malea5f35a4b2012-11-29 21:49:15 +00003989 s->Printf(" process = %p (pid = %" PRIu64 "), ", m_process_sp.get(), m_process_sp->GetID());
Chris Lattner24943d22010-06-08 16:52:24 +00003990
Greg Claytonb72d0f02011-04-12 05:54:46 +00003991 s->Printf("state = %s", StateAsCString(GetState()));
Chris Lattner24943d22010-06-08 16:52:24 +00003992}
3993
3994const Process::ProcessEventData *
3995Process::ProcessEventData::GetEventDataFromEvent (const Event *event_ptr)
3996{
3997 if (event_ptr)
3998 {
3999 const EventData *event_data = event_ptr->GetData();
4000 if (event_data && event_data->GetFlavor() == ProcessEventData::GetFlavorString())
4001 return static_cast <const ProcessEventData *> (event_ptr->GetData());
4002 }
4003 return NULL;
4004}
4005
4006ProcessSP
4007Process::ProcessEventData::GetProcessFromEvent (const Event *event_ptr)
4008{
4009 ProcessSP process_sp;
4010 const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
4011 if (data)
4012 process_sp = data->GetProcessSP();
4013 return process_sp;
4014}
4015
4016StateType
4017Process::ProcessEventData::GetStateFromEvent (const Event *event_ptr)
4018{
4019 const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
4020 if (data == NULL)
4021 return eStateInvalid;
4022 else
4023 return data->GetState();
4024}
4025
4026bool
4027Process::ProcessEventData::GetRestartedFromEvent (const Event *event_ptr)
4028{
4029 const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
4030 if (data == NULL)
4031 return false;
4032 else
4033 return data->GetRestarted();
4034}
4035
4036void
4037Process::ProcessEventData::SetRestartedInEvent (Event *event_ptr, bool new_value)
4038{
4039 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4040 if (data != NULL)
4041 data->SetRestarted(new_value);
4042}
4043
4044bool
Jim Ingham3ae449a2010-11-17 02:32:00 +00004045Process::ProcessEventData::GetInterruptedFromEvent (const Event *event_ptr)
4046{
4047 const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
4048 if (data == NULL)
4049 return false;
4050 else
4051 return data->GetInterrupted ();
4052}
4053
4054void
4055Process::ProcessEventData::SetInterruptedInEvent (Event *event_ptr, bool new_value)
4056{
4057 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4058 if (data != NULL)
4059 data->SetInterrupted(new_value);
4060}
4061
4062bool
Chris Lattner24943d22010-06-08 16:52:24 +00004063Process::ProcessEventData::SetUpdateStateOnRemoval (Event *event_ptr)
4064{
4065 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4066 if (data)
4067 {
4068 data->SetUpdateStateOnRemoval();
4069 return true;
4070 }
4071 return false;
4072}
4073
Greg Clayton289afcb2012-02-18 05:35:26 +00004074lldb::TargetSP
4075Process::CalculateTarget ()
4076{
4077 return m_target.shared_from_this();
4078}
4079
Chris Lattner24943d22010-06-08 16:52:24 +00004080void
Greg Claytona830adb2010-10-04 01:05:56 +00004081Process::CalculateExecutionContext (ExecutionContext &exe_ctx)
Chris Lattner24943d22010-06-08 16:52:24 +00004082{
Greg Clayton567e7f32011-09-22 04:58:26 +00004083 exe_ctx.SetTargetPtr (&m_target);
4084 exe_ctx.SetProcessPtr (this);
4085 exe_ctx.SetThreadPtr(NULL);
4086 exe_ctx.SetFramePtr (NULL);
Chris Lattner24943d22010-06-08 16:52:24 +00004087}
4088
Greg Claytone4b9c1f2011-03-08 22:40:15 +00004089//uint32_t
4090//Process::ListProcessesMatchingName (const char *name, StringList &matches, std::vector<lldb::pid_t> &pids)
4091//{
4092// return 0;
4093//}
4094//
4095//ArchSpec
4096//Process::GetArchSpecForExistingProcess (lldb::pid_t pid)
4097//{
4098// return Host::GetArchSpecForExistingProcess (pid);
4099//}
4100//
4101//ArchSpec
4102//Process::GetArchSpecForExistingProcess (const char *process_name)
4103//{
4104// return Host::GetArchSpecForExistingProcess (process_name);
4105//}
4106//
Caroline Tice861efb32010-11-16 05:07:41 +00004107void
4108Process::AppendSTDOUT (const char * s, size_t len)
4109{
Greg Clayton20d338f2010-11-18 05:57:03 +00004110 Mutex::Locker locker (m_stdio_communication_mutex);
Caroline Tice861efb32010-11-16 05:07:41 +00004111 m_stdout_data.append (s, len);
Greg Clayton84332782012-10-29 20:52:08 +00004112 BroadcastEventIfUnique (eBroadcastBitSTDOUT, new ProcessEventData (shared_from_this(), GetState()));
Caroline Tice861efb32010-11-16 05:07:41 +00004113}
4114
4115void
Greg Claytonbd06ff42011-11-13 04:45:22 +00004116Process::AppendSTDERR (const char * s, size_t len)
4117{
4118 Mutex::Locker locker (m_stdio_communication_mutex);
4119 m_stderr_data.append (s, len);
Greg Clayton84332782012-10-29 20:52:08 +00004120 BroadcastEventIfUnique (eBroadcastBitSTDERR, new ProcessEventData (shared_from_this(), GetState()));
Greg Claytonbd06ff42011-11-13 04:45:22 +00004121}
4122
Han Ming Ongfb9cee62012-11-17 00:21:04 +00004123void
4124Process::BroadcastAsyncProfileData(const char *s, size_t len)
4125{
4126 Mutex::Locker locker (m_profile_data_comm_mutex);
Han Ming Ongf14269a2012-11-29 22:14:45 +00004127 m_profile_data.push_back(s);
Han Ming Ongfb9cee62012-11-17 00:21:04 +00004128 BroadcastEventIfUnique (eBroadcastBitProfileData, new ProcessEventData (shared_from_this(), GetState()));
4129}
4130
4131size_t
4132Process::GetAsyncProfileData (char *buf, size_t buf_size, Error &error)
4133{
4134 Mutex::Locker locker(m_profile_data_comm_mutex);
Han Ming Ongf14269a2012-11-29 22:14:45 +00004135 if (m_profile_data.empty())
4136 return 0;
4137
4138 size_t bytes_available = m_profile_data.front().size();
Han Ming Ongfb9cee62012-11-17 00:21:04 +00004139 if (bytes_available > 0)
4140 {
4141 LogSP log (lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
4142 if (log)
Daniel Malea5f35a4b2012-11-29 21:49:15 +00004143 log->Printf ("Process::GetProfileData (buf = %p, size = %" PRIu64 ")", buf, (uint64_t)buf_size);
Han Ming Ongfb9cee62012-11-17 00:21:04 +00004144 if (bytes_available > buf_size)
4145 {
Han Ming Ongf14269a2012-11-29 22:14:45 +00004146 memcpy(buf, m_profile_data.front().data(), buf_size);
4147 m_profile_data.front().erase(0, buf_size);
Han Ming Ongfb9cee62012-11-17 00:21:04 +00004148 bytes_available = buf_size;
4149 }
4150 else
4151 {
Han Ming Ongf14269a2012-11-29 22:14:45 +00004152 memcpy(buf, m_profile_data.front().data(), bytes_available);
4153 m_profile_data.erase(m_profile_data.begin());
Han Ming Ongfb9cee62012-11-17 00:21:04 +00004154 }
4155 }
4156 return bytes_available;
4157}
4158
4159
Greg Claytonbd06ff42011-11-13 04:45:22 +00004160//------------------------------------------------------------------
4161// Process STDIO
4162//------------------------------------------------------------------
4163
4164size_t
4165Process::GetSTDOUT (char *buf, size_t buf_size, Error &error)
4166{
4167 Mutex::Locker locker(m_stdio_communication_mutex);
4168 size_t bytes_available = m_stdout_data.size();
4169 if (bytes_available > 0)
4170 {
4171 LogSP log (lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
4172 if (log)
Daniel Malea5f35a4b2012-11-29 21:49:15 +00004173 log->Printf ("Process::GetSTDOUT (buf = %p, size = %" PRIu64 ")", buf, (uint64_t)buf_size);
Greg Claytonbd06ff42011-11-13 04:45:22 +00004174 if (bytes_available > buf_size)
4175 {
4176 memcpy(buf, m_stdout_data.c_str(), buf_size);
4177 m_stdout_data.erase(0, buf_size);
4178 bytes_available = buf_size;
4179 }
4180 else
4181 {
4182 memcpy(buf, m_stdout_data.c_str(), bytes_available);
4183 m_stdout_data.clear();
4184 }
4185 }
4186 return bytes_available;
4187}
4188
4189
4190size_t
4191Process::GetSTDERR (char *buf, size_t buf_size, Error &error)
4192{
4193 Mutex::Locker locker(m_stdio_communication_mutex);
4194 size_t bytes_available = m_stderr_data.size();
4195 if (bytes_available > 0)
4196 {
4197 LogSP log (lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
4198 if (log)
Daniel Malea5f35a4b2012-11-29 21:49:15 +00004199 log->Printf ("Process::GetSTDERR (buf = %p, size = %" PRIu64 ")", buf, (uint64_t)buf_size);
Greg Claytonbd06ff42011-11-13 04:45:22 +00004200 if (bytes_available > buf_size)
4201 {
4202 memcpy(buf, m_stderr_data.c_str(), buf_size);
4203 m_stderr_data.erase(0, buf_size);
4204 bytes_available = buf_size;
4205 }
4206 else
4207 {
4208 memcpy(buf, m_stderr_data.c_str(), bytes_available);
4209 m_stderr_data.clear();
4210 }
4211 }
4212 return bytes_available;
4213}
4214
4215void
Caroline Tice861efb32010-11-16 05:07:41 +00004216Process::STDIOReadThreadBytesReceived (void *baton, const void *src, size_t src_len)
4217{
4218 Process *process = (Process *) baton;
4219 process->AppendSTDOUT (static_cast<const char *>(src), src_len);
4220}
4221
4222size_t
4223Process::ProcessInputReaderCallback (void *baton,
4224 InputReader &reader,
4225 lldb::InputReaderAction notification,
4226 const char *bytes,
4227 size_t bytes_len)
4228{
4229 Process *process = (Process *) baton;
4230
4231 switch (notification)
4232 {
4233 case eInputReaderActivate:
4234 break;
4235
4236 case eInputReaderDeactivate:
4237 break;
4238
4239 case eInputReaderReactivate:
4240 break;
4241
Caroline Tice4a348082011-05-02 20:41:46 +00004242 case eInputReaderAsynchronousOutputWritten:
4243 break;
4244
Caroline Tice861efb32010-11-16 05:07:41 +00004245 case eInputReaderGotToken:
4246 {
4247 Error error;
4248 process->PutSTDIN (bytes, bytes_len, error);
4249 }
4250 break;
4251
Caroline Ticec4f55fe2010-11-19 20:47:54 +00004252 case eInputReaderInterrupt:
4253 process->Halt ();
4254 break;
4255
4256 case eInputReaderEndOfFile:
4257 process->AppendSTDOUT ("^D", 2);
4258 break;
4259
Caroline Tice861efb32010-11-16 05:07:41 +00004260 case eInputReaderDone:
4261 break;
4262
4263 }
4264
4265 return bytes_len;
4266}
4267
4268void
4269Process::ResetProcessInputReader ()
4270{
4271 m_process_input_reader.reset();
4272}
4273
4274void
Greg Clayton464c6162011-11-17 22:14:31 +00004275Process::SetSTDIOFileDescriptor (int file_descriptor)
Caroline Tice861efb32010-11-16 05:07:41 +00004276{
4277 // First set up the Read Thread for reading/handling process I/O
4278
4279 std::auto_ptr<ConnectionFileDescriptor> conn_ap (new ConnectionFileDescriptor (file_descriptor, true));
4280
4281 if (conn_ap.get())
4282 {
4283 m_stdio_communication.SetConnection (conn_ap.release());
4284 if (m_stdio_communication.IsConnected())
4285 {
4286 m_stdio_communication.SetReadThreadBytesReceivedCallback (STDIOReadThreadBytesReceived, this);
4287 m_stdio_communication.StartReadThread();
4288
4289 // Now read thread is set up, set up input reader.
4290
4291 if (!m_process_input_reader.get())
4292 {
4293 m_process_input_reader.reset (new InputReader(m_target.GetDebugger()));
4294 Error err (m_process_input_reader->Initialize (Process::ProcessInputReaderCallback,
4295 this,
4296 eInputReaderGranularityByte,
4297 NULL,
4298 NULL,
4299 false));
4300
4301 if (err.Fail())
4302 m_process_input_reader.reset();
4303 }
4304 }
4305 }
4306}
4307
4308void
4309Process::PushProcessInputReader ()
4310{
4311 if (m_process_input_reader && !m_process_input_reader->IsActive())
4312 m_target.GetDebugger().PushInputReader (m_process_input_reader);
4313}
4314
4315void
4316Process::PopProcessInputReader ()
4317{
4318 if (m_process_input_reader && m_process_input_reader->IsActive())
4319 m_target.GetDebugger().PopInputReader (m_process_input_reader);
4320}
4321
Greg Claytond284b662011-02-18 01:44:25 +00004322// The process needs to know about installed plug-ins
Greg Clayton990de7b2010-11-18 23:32:35 +00004323void
Caroline Tice2a456812011-03-10 22:14:10 +00004324Process::SettingsInitialize ()
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00004325{
Greg Clayton73844aa2012-08-22 17:17:09 +00004326// static std::vector<OptionEnumValueElement> g_plugins;
4327//
4328// int i=0;
4329// const char *name;
4330// OptionEnumValueElement option_enum;
4331// while ((name = PluginManager::GetProcessPluginNameAtIndex (i)) != NULL)
4332// {
4333// if (name)
4334// {
4335// option_enum.value = i;
4336// option_enum.string_value = name;
4337// option_enum.usage = PluginManager::GetProcessPluginDescriptionAtIndex (i);
4338// g_plugins.push_back (option_enum);
4339// }
4340// ++i;
4341// }
4342// option_enum.value = 0;
4343// option_enum.string_value = NULL;
4344// option_enum.usage = NULL;
4345// g_plugins.push_back (option_enum);
4346//
4347// for (i=0; (name = SettingsController::instance_settings_table[i].var_name); ++i)
4348// {
4349// if (::strcmp (name, "plugin") == 0)
4350// {
4351// SettingsController::instance_settings_table[i].enum_values = &g_plugins[0];
4352// break;
4353// }
4354// }
Greg Clayton73844aa2012-08-22 17:17:09 +00004355//
Greg Claytonc6e82e42012-08-22 18:39:03 +00004356 Thread::SettingsInitialize ();
Greg Clayton990de7b2010-11-18 23:32:35 +00004357}
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00004358
Greg Clayton990de7b2010-11-18 23:32:35 +00004359void
Caroline Tice2a456812011-03-10 22:14:10 +00004360Process::SettingsTerminate ()
Greg Claytond284b662011-02-18 01:44:25 +00004361{
Greg Claytonc6e82e42012-08-22 18:39:03 +00004362 Thread::SettingsTerminate ();
Greg Clayton990de7b2010-11-18 23:32:35 +00004363}
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00004364
Greg Clayton427f2902010-12-14 02:59:59 +00004365ExecutionResults
Jim Ingham360f53f2010-11-30 02:22:11 +00004366Process::RunThreadPlan (ExecutionContext &exe_ctx,
Jim Ingham1831e782012-04-07 00:00:41 +00004367 lldb::ThreadPlanSP &thread_plan_sp,
Jim Ingham360f53f2010-11-30 02:22:11 +00004368 bool stop_others,
Jim Ingham47beabb2012-10-16 21:41:58 +00004369 bool run_others,
Jim Inghamb7940202013-01-15 02:47:48 +00004370 bool unwind_on_error,
4371 bool ignore_breakpoints,
Jim Ingham47beabb2012-10-16 21:41:58 +00004372 uint32_t timeout_usec,
Jim Ingham360f53f2010-11-30 02:22:11 +00004373 Stream &errors)
4374{
4375 ExecutionResults return_value = eExecutionSetupError;
4376
Jim Ingham15dcb7c2011-01-20 02:03:18 +00004377 if (thread_plan_sp.get() == NULL)
4378 {
4379 errors.Printf("RunThreadPlan called with empty thread plan.");
Greg Claytonb3448432011-03-24 21:19:54 +00004380 return eExecutionSetupError;
Jim Ingham15dcb7c2011-01-20 02:03:18 +00004381 }
Greg Clayton567e7f32011-09-22 04:58:26 +00004382
4383 if (exe_ctx.GetProcessPtr() != this)
4384 {
4385 errors.Printf("RunThreadPlan called on wrong process.");
4386 return eExecutionSetupError;
4387 }
4388
4389 Thread *thread = exe_ctx.GetThreadPtr();
4390 if (thread == NULL)
4391 {
4392 errors.Printf("RunThreadPlan called with invalid thread.");
4393 return eExecutionSetupError;
4394 }
Jim Ingham15dcb7c2011-01-20 02:03:18 +00004395
Jim Ingham5ab7fba2011-05-17 22:24:54 +00004396 // We rely on the thread plan we are running returning "PlanCompleted" if when it successfully completes.
4397 // For that to be true the plan can't be private - since private plans suppress themselves in the
4398 // GetCompletedPlan call.
4399
4400 bool orig_plan_private = thread_plan_sp->GetPrivate();
4401 thread_plan_sp->SetPrivate(false);
4402
Jim Inghamac959662011-01-24 06:34:17 +00004403 if (m_private_state.GetValue() != eStateStopped)
4404 {
4405 errors.Printf ("RunThreadPlan called while the private state was not stopped.");
Greg Claytonb3448432011-03-24 21:19:54 +00004406 return eExecutionSetupError;
Jim Inghamac959662011-01-24 06:34:17 +00004407 }
4408
Jim Ingham7bbebaf2011-08-13 00:56:10 +00004409 // Save the thread & frame from the exe_ctx for restoration after we run
Greg Clayton567e7f32011-09-22 04:58:26 +00004410 const uint32_t thread_idx_id = thread->GetIndexID();
4411 StackID ctx_frame_id = thread->GetSelectedFrame()->GetStackID();
Jim Ingham360f53f2010-11-30 02:22:11 +00004412
4413 // N.B. Running the target may unset the currently selected thread and frame. We don't want to do that either,
4414 // so we should arrange to reset them as well.
4415
Greg Clayton567e7f32011-09-22 04:58:26 +00004416 lldb::ThreadSP selected_thread_sp = GetThreadList().GetSelectedThread();
Jim Ingham360f53f2010-11-30 02:22:11 +00004417
Jim Ingham7bbebaf2011-08-13 00:56:10 +00004418 uint32_t selected_tid;
4419 StackID selected_stack_id;
Greg Claytone40b6422011-09-18 18:59:15 +00004420 if (selected_thread_sp)
Jim Ingham360f53f2010-11-30 02:22:11 +00004421 {
4422 selected_tid = selected_thread_sp->GetIndexID();
Jim Ingham7bbebaf2011-08-13 00:56:10 +00004423 selected_stack_id = selected_thread_sp->GetSelectedFrame()->GetStackID();
Jim Ingham360f53f2010-11-30 02:22:11 +00004424 }
4425 else
4426 {
4427 selected_tid = LLDB_INVALID_THREAD_ID;
4428 }
4429
Jim Ingham1831e782012-04-07 00:00:41 +00004430 lldb::thread_t backup_private_state_thread = LLDB_INVALID_HOST_THREAD;
Jim Inghamd21d98b2012-04-10 01:21:57 +00004431 lldb::StateType old_state;
4432 lldb::ThreadPlanSP stopper_base_plan_sp;
Jim Ingham1831e782012-04-07 00:00:41 +00004433
Jim Inghamd21d98b2012-04-10 01:21:57 +00004434 lldb::LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STEP | LIBLLDB_LOG_PROCESS));
Jim Ingham1831e782012-04-07 00:00:41 +00004435 if (Host::GetCurrentThread() == m_private_state_thread)
4436 {
Jim Inghamd21d98b2012-04-10 01:21:57 +00004437 // Yikes, we are running on the private state thread! So we can't wait for public events on this thread, since
4438 // we are the thread that is generating public events.
Jim Ingham1831e782012-04-07 00:00:41 +00004439 // The simplest thing to do is to spin up a temporary thread to handle private state thread events while
Jim Inghamd21d98b2012-04-10 01:21:57 +00004440 // we are fielding public events here.
4441 if (log)
Jason Molenda559cf6e2012-11-17 01:41:04 +00004442 log->Printf ("Running thread plan on private state thread, spinning up another state thread to handle the events.");
Jim Inghamd21d98b2012-04-10 01:21:57 +00004443
4444
Jim Ingham1831e782012-04-07 00:00:41 +00004445 backup_private_state_thread = m_private_state_thread;
Jim Inghamd21d98b2012-04-10 01:21:57 +00004446
4447 // One other bit of business: we want to run just this thread plan and anything it pushes, and then stop,
4448 // returning control here.
4449 // But in the normal course of things, the plan above us on the stack would be given a shot at the stop
4450 // event before deciding to stop, and we don't want that. So we insert a "stopper" base plan on the stack
4451 // before the plan we want to run. Since base plans always stop and return control to the user, that will
4452 // do just what we want.
4453 stopper_base_plan_sp.reset(new ThreadPlanBase (*thread));
4454 thread->QueueThreadPlan (stopper_base_plan_sp, false);
4455 // Have to make sure our public state is stopped, since otherwise the reporting logic below doesn't work correctly.
4456 old_state = m_public_state.GetValue();
4457 m_public_state.SetValueNoLock(eStateStopped);
4458
4459 // Now spin up the private state thread:
Jim Ingham1831e782012-04-07 00:00:41 +00004460 StartPrivateStateThread(true);
4461 }
4462
4463 thread->QueueThreadPlan(thread_plan_sp, false); // This used to pass "true" does that make sense?
Jim Ingham360f53f2010-11-30 02:22:11 +00004464
Jim Ingham6ae318c2011-01-23 21:14:08 +00004465 Listener listener("lldb.process.listener.run-thread-plan");
Jim Inghamf9f40c22011-02-08 05:20:59 +00004466
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004467 lldb::EventSP event_to_broadcast_sp;
Jim Inghamf9f40c22011-02-08 05:20:59 +00004468
Jim Ingham15dcb7c2011-01-20 02:03:18 +00004469 {
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004470 // This process event hijacker Hijacks the Public events and its destructor makes sure that the process events get
4471 // restored on exit to the function.
4472 //
4473 // If the event needs to propagate beyond the hijacker (e.g., the process exits during execution), then the event
4474 // is put into event_to_broadcast_sp for rebroadcasting.
Jim Ingham360f53f2010-11-30 02:22:11 +00004475
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004476 ProcessEventHijacker run_thread_plan_hijacker (*this, &listener);
Jim Inghamf9f40c22011-02-08 05:20:59 +00004477
Jim Ingham360f53f2010-11-30 02:22:11 +00004478 if (log)
Jim Inghamf9f40c22011-02-08 05:20:59 +00004479 {
4480 StreamString s;
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004481 thread_plan_sp->GetDescription(&s, lldb::eDescriptionLevelVerbose);
Daniel Malea5f35a4b2012-11-29 21:49:15 +00004482 log->Printf ("Process::RunThreadPlan(): Resuming thread %u - 0x%4.4" PRIx64 " to run thread plan \"%s\".",
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004483 thread->GetIndexID(),
4484 thread->GetID(),
4485 s.GetData());
4486 }
4487
4488 bool got_event;
4489 lldb::EventSP event_sp;
4490 lldb::StateType stop_state = lldb::eStateInvalid;
4491
4492 TimeValue* timeout_ptr = NULL;
4493 TimeValue real_timeout;
4494
4495 bool first_timeout = true;
4496 bool do_resume = true;
Jim Inghamb7940202013-01-15 02:47:48 +00004497 bool handle_running_event = true;
Jim Ingham47beabb2012-10-16 21:41:58 +00004498 const uint64_t default_one_thread_timeout_usec = 250000;
4499 uint64_t computed_timeout = 0;
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004500
Jim Ingham76b258d2012-11-26 23:52:18 +00004501 // This while loop must exit out the bottom, there's cleanup that we need to do when we are done.
4502 // So don't call return anywhere within it.
4503
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004504 while (1)
4505 {
4506 // We usually want to resume the process if we get to the top of the loop.
4507 // The only exception is if we get two running events with no intervening
4508 // stop, which can happen, we will just wait for then next stop event.
4509
Jim Inghamb7940202013-01-15 02:47:48 +00004510 if (do_resume || handle_running_event)
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004511 {
4512 // Do the initial resume and wait for the running event before going further.
4513
Jim Inghamb7940202013-01-15 02:47:48 +00004514 if (do_resume)
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004515 {
Jim Inghamb7940202013-01-15 02:47:48 +00004516 Error resume_error = PrivateResume ();
4517 if (!resume_error.Success())
4518 {
4519 errors.Printf("Error resuming inferior: \"%s\".\n", resume_error.AsCString());
4520 return_value = eExecutionSetupError;
4521 break;
4522 }
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004523 }
4524
4525 real_timeout = TimeValue::Now();
4526 real_timeout.OffsetWithMicroSeconds(500000);
4527 timeout_ptr = &real_timeout;
4528
4529 got_event = listener.WaitForEvent(timeout_ptr, event_sp);
4530 if (!got_event)
4531 {
4532 if (log)
4533 log->PutCString("Process::RunThreadPlan(): didn't get any event after initial resume, exiting.");
4534
4535 errors.Printf("Didn't get any event after initial resume, exiting.");
4536 return_value = eExecutionSetupError;
4537 break;
4538 }
4539
4540 stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
4541 if (stop_state != eStateRunning)
4542 {
4543 if (log)
Jim Ingham47beabb2012-10-16 21:41:58 +00004544 log->Printf("Process::RunThreadPlan(): didn't get running event after "
4545 "initial resume, got %s instead.",
4546 StateAsCString(stop_state));
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004547
Jim Ingham47beabb2012-10-16 21:41:58 +00004548 errors.Printf("Didn't get running event after initial resume, got %s instead.",
4549 StateAsCString(stop_state));
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004550 return_value = eExecutionSetupError;
4551 break;
4552 }
4553
4554 if (log)
4555 log->PutCString ("Process::RunThreadPlan(): resuming succeeded.");
4556 // We need to call the function synchronously, so spin waiting for it to return.
4557 // If we get interrupted while executing, we're going to lose our context, and
4558 // won't be able to gather the result at this point.
4559 // We set the timeout AFTER the resume, since the resume takes some time and we
4560 // don't want to charge that to the timeout.
4561
Jim Ingham47beabb2012-10-16 21:41:58 +00004562 if (first_timeout)
4563 {
4564 if (run_others)
4565 {
4566 // If we are running all threads then we take half the time to run all threads, bounded by
4567 // .25 sec.
4568 if (timeout_usec == 0)
4569 computed_timeout = default_one_thread_timeout_usec;
4570 else
4571 {
4572 computed_timeout = timeout_usec / 2;
4573 if (computed_timeout > default_one_thread_timeout_usec)
4574 {
4575 computed_timeout = default_one_thread_timeout_usec;
4576 }
4577 timeout_usec -= computed_timeout;
4578 }
4579 }
4580 else
4581 {
4582 computed_timeout = timeout_usec;
4583 }
4584 }
4585 else
4586 {
4587 computed_timeout = timeout_usec;
4588 }
4589
4590 if (computed_timeout != 0)
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004591 {
Enrico Granata6cca9692012-07-16 23:10:35 +00004592 // we have a > 0 timeout, let us set it so that we stop after the deadline
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004593 real_timeout = TimeValue::Now();
Jim Ingham47beabb2012-10-16 21:41:58 +00004594 real_timeout.OffsetWithMicroSeconds(computed_timeout);
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004595
4596 timeout_ptr = &real_timeout;
4597 }
Enrico Granata6cca9692012-07-16 23:10:35 +00004598 else
4599 {
Jim Ingham47beabb2012-10-16 21:41:58 +00004600 timeout_ptr = NULL;
Enrico Granata6cca9692012-07-16 23:10:35 +00004601 }
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004602 }
Jim Inghamf9f40c22011-02-08 05:20:59 +00004603 else
4604 {
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004605 if (log)
4606 log->PutCString ("Process::RunThreadPlan(): handled an extra running event.");
4607 do_resume = true;
Jim Inghamb7940202013-01-15 02:47:48 +00004608 handle_running_event = true;
Jim Inghamf9f40c22011-02-08 05:20:59 +00004609 }
Jim Inghamf9f40c22011-02-08 05:20:59 +00004610
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004611 // Now wait for the process to stop again:
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004612 event_sp.reset();
Jim Inghamf9f40c22011-02-08 05:20:59 +00004613
Jim Inghamf9f40c22011-02-08 05:20:59 +00004614 if (log)
Jim Inghamf6d3d792011-08-09 22:24:33 +00004615 {
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004616 if (timeout_ptr)
4617 {
4618 StreamString s;
4619 s.Printf ("about to wait - timeout is:\n ");
4620 timeout_ptr->Dump (&s, 120);
4621 s.Printf ("\nNow is:\n ");
4622 TimeValue::Now().Dump (&s, 120);
4623 log->Printf ("Process::RunThreadPlan(): %s", s.GetData());
4624 }
Jim Inghamf6d3d792011-08-09 22:24:33 +00004625 else
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004626 {
4627 log->Printf ("Process::RunThreadPlan(): about to wait forever.");
4628 }
4629 }
4630
4631 got_event = listener.WaitForEvent (timeout_ptr, event_sp);
4632
4633 if (got_event)
4634 {
4635 if (event_sp.get())
4636 {
4637 bool keep_going = false;
Jim Ingham5d90ade2012-07-27 23:57:19 +00004638 if (event_sp->GetType() == eBroadcastBitInterrupt)
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004639 {
Jim Ingham5d90ade2012-07-27 23:57:19 +00004640 Halt();
4641 keep_going = false;
4642 return_value = eExecutionInterrupted;
4643 errors.Printf ("Execution halted by user interrupt.");
4644 if (log)
4645 log->Printf ("Process::RunThreadPlan(): Got interrupted by eBroadcastBitInterrupted, exiting.");
4646 }
4647 else
4648 {
4649 stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
4650 if (log)
4651 log->Printf("Process::RunThreadPlan(): in while loop, got event: %s.", StateAsCString(stop_state));
4652
4653 switch (stop_state)
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004654 {
Jim Ingham5d90ade2012-07-27 23:57:19 +00004655 case lldb::eStateStopped:
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004656 {
Jim Ingham5d90ade2012-07-27 23:57:19 +00004657 // Yay, we're done. Now make sure that our thread plan actually completed.
4658 ThreadSP thread_sp = GetThreadList().FindThreadByIndexID (thread_idx_id);
4659 if (!thread_sp)
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004660 {
Jim Ingham5d90ade2012-07-27 23:57:19 +00004661 // Ooh, our thread has vanished. Unlikely that this was successful execution...
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004662 if (log)
Jim Ingham5d90ade2012-07-27 23:57:19 +00004663 log->Printf ("Process::RunThreadPlan(): execution completed but our thread (index-id=%u) has vanished.", thread_idx_id);
4664 return_value = eExecutionInterrupted;
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004665 }
4666 else
4667 {
Jim Ingham5d90ade2012-07-27 23:57:19 +00004668 StopInfoSP stop_info_sp (thread_sp->GetStopInfo ());
4669 StopReason stop_reason = eStopReasonInvalid;
4670 if (stop_info_sp)
4671 stop_reason = stop_info_sp->GetStopReason();
4672 if (stop_reason == eStopReasonPlanComplete)
4673 {
4674 if (log)
4675 log->PutCString ("Process::RunThreadPlan(): execution completed successfully.");
4676 // Now mark this plan as private so it doesn't get reported as the stop reason
4677 // after this point.
4678 if (thread_plan_sp)
4679 thread_plan_sp->SetPrivate (orig_plan_private);
4680 return_value = eExecutionCompleted;
4681 }
4682 else
4683 {
Jim Inghamb7940202013-01-15 02:47:48 +00004684 // Something restarted the target, so just wait for it to stop for real.
4685 if (Process::ProcessEventData::GetRestartedFromEvent(event_sp.get()))
4686 {
4687 if (log)
4688 log->PutCString ("Process::RunThreadPlan(): Somebody stopped and then restarted, we'll continue waiting.");
4689 keep_going = true;
4690 do_resume = false;
4691 handle_running_event = true;
4692 }
4693 else
4694 {
4695 if (log)
4696 log->PutCString ("Process::RunThreadPlan(): thread plan didn't successfully complete.");
4697 if (stop_reason == eStopReasonBreakpoint)
4698 return_value = eExecutionHitBreakpoint;
4699 else
4700 return_value = eExecutionInterrupted;
4701 }
Jim Ingham5d90ade2012-07-27 23:57:19 +00004702 }
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004703 }
Jim Ingham5d90ade2012-07-27 23:57:19 +00004704 }
4705 break;
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004706
Jim Ingham5d90ade2012-07-27 23:57:19 +00004707 case lldb::eStateCrashed:
4708 if (log)
4709 log->PutCString ("Process::RunThreadPlan(): execution crashed.");
4710 return_value = eExecutionInterrupted;
4711 break;
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004712
Jim Ingham5d90ade2012-07-27 23:57:19 +00004713 case lldb::eStateRunning:
4714 do_resume = false;
4715 keep_going = true;
Jim Inghamb7940202013-01-15 02:47:48 +00004716 handle_running_event = false;
Jim Ingham5d90ade2012-07-27 23:57:19 +00004717 break;
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004718
Jim Ingham5d90ade2012-07-27 23:57:19 +00004719 default:
4720 if (log)
4721 log->Printf("Process::RunThreadPlan(): execution stopped with unexpected state: %s.", StateAsCString(stop_state));
4722
4723 if (stop_state == eStateExited)
4724 event_to_broadcast_sp = event_sp;
4725
Sean Callanan96abc622012-08-08 17:35:10 +00004726 errors.Printf ("Execution stopped with unexpected state.\n");
Jim Ingham5d90ade2012-07-27 23:57:19 +00004727 return_value = eExecutionInterrupted;
4728 break;
4729 }
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004730 }
Jim Ingham5d90ade2012-07-27 23:57:19 +00004731
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004732 if (keep_going)
4733 continue;
4734 else
4735 break;
4736 }
4737 else
4738 {
4739 if (log)
4740 log->PutCString ("Process::RunThreadPlan(): got_event was true, but the event pointer was null. How odd...");
4741 return_value = eExecutionInterrupted;
4742 break;
4743 }
4744 }
4745 else
4746 {
4747 // If we didn't get an event that means we've timed out...
4748 // We will interrupt the process here. Depending on what we were asked to do we will
4749 // either exit, or try with all threads running for the same timeout.
4750 // Not really sure what to do if Halt fails here...
4751
4752 if (log) {
Jim Ingham47beabb2012-10-16 21:41:58 +00004753 if (run_others)
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004754 {
4755 if (first_timeout)
Daniel Malea5f35a4b2012-11-29 21:49:15 +00004756 log->Printf ("Process::RunThreadPlan(): Running function with timeout: %" PRId64 " timed out, "
Jim Ingham47beabb2012-10-16 21:41:58 +00004757 "trying for %d usec with all threads enabled.",
4758 computed_timeout, timeout_usec);
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004759 else
4760 log->Printf ("Process::RunThreadPlan(): Restarting function with all threads enabled "
Jim Ingham47beabb2012-10-16 21:41:58 +00004761 "and timeout: %d timed out, abandoning execution.",
4762 timeout_usec);
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004763 }
4764 else
4765 log->Printf ("Process::RunThreadPlan(): Running function with timeout: %d timed out, "
Jim Ingham47beabb2012-10-16 21:41:58 +00004766 "abandoning execution.",
4767 timeout_usec);
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004768 }
4769
4770 Error halt_error = Halt();
4771 if (halt_error.Success())
4772 {
4773 if (log)
4774 log->PutCString ("Process::RunThreadPlan(): Halt succeeded.");
4775
4776 // If halt succeeds, it always produces a stopped event. Wait for that:
4777
4778 real_timeout = TimeValue::Now();
4779 real_timeout.OffsetWithMicroSeconds(500000);
4780
4781 got_event = listener.WaitForEvent(&real_timeout, event_sp);
4782
4783 if (got_event)
4784 {
4785 stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
4786 if (log)
4787 {
4788 log->Printf ("Process::RunThreadPlan(): Stopped with event: %s", StateAsCString(stop_state));
4789 if (stop_state == lldb::eStateStopped
4790 && Process::ProcessEventData::GetInterruptedFromEvent(event_sp.get()))
4791 log->PutCString (" Event was the Halt interruption event.");
4792 }
4793
4794 if (stop_state == lldb::eStateStopped)
4795 {
4796 // Between the time we initiated the Halt and the time we delivered it, the process could have
4797 // already finished its job. Check that here:
4798
4799 if (thread->IsThreadPlanDone (thread_plan_sp.get()))
4800 {
4801 if (log)
4802 log->PutCString ("Process::RunThreadPlan(): Even though we timed out, the call plan was done. "
4803 "Exiting wait loop.");
4804 return_value = eExecutionCompleted;
4805 break;
4806 }
4807
Jim Ingham47beabb2012-10-16 21:41:58 +00004808 if (!run_others)
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004809 {
4810 if (log)
4811 log->PutCString ("Process::RunThreadPlan(): try_all_threads was false, we stopped so now we're quitting.");
4812 return_value = eExecutionInterrupted;
4813 break;
4814 }
4815
4816 if (first_timeout)
4817 {
4818 // Set all the other threads to run, and return to the top of the loop, which will continue;
4819 first_timeout = false;
4820 thread_plan_sp->SetStopOthers (false);
4821 if (log)
4822 log->PutCString ("Process::RunThreadPlan(): about to resume.");
4823
4824 continue;
4825 }
4826 else
4827 {
4828 // Running all threads failed, so return Interrupted.
4829 if (log)
4830 log->PutCString("Process::RunThreadPlan(): running all threads timed out.");
4831 return_value = eExecutionInterrupted;
4832 break;
4833 }
4834 }
4835 }
4836 else
4837 { if (log)
4838 log->PutCString("Process::RunThreadPlan(): halt said it succeeded, but I got no event. "
4839 "I'm getting out of here passing Interrupted.");
4840 return_value = eExecutionInterrupted;
4841 break;
4842 }
4843 }
4844 else
4845 {
4846 // This branch is to work around some problems with gdb-remote's Halt. It is a little racy, and can return
4847 // an error from halt, but if you wait a bit you'll get a stopped event anyway.
4848 if (log)
4849 log->Printf ("Process::RunThreadPlan(): halt failed: error = \"%s\", I'm just going to wait a little longer and see if I get a stopped event.",
4850 halt_error.AsCString());
4851 real_timeout = TimeValue::Now();
4852 real_timeout.OffsetWithMicroSeconds(500000);
4853 timeout_ptr = &real_timeout;
4854 got_event = listener.WaitForEvent(&real_timeout, event_sp);
4855 if (!got_event || event_sp.get() == NULL)
4856 {
4857 // This is not going anywhere, bag out.
4858 if (log)
4859 log->PutCString ("Process::RunThreadPlan(): halt failed: and waiting for the stopped event failed.");
4860 return_value = eExecutionInterrupted;
4861 break;
4862 }
4863 else
4864 {
4865 stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
4866 if (log)
4867 log->PutCString ("Process::RunThreadPlan(): halt failed: but then I got a stopped event. Whatever...");
4868 if (stop_state == lldb::eStateStopped)
4869 {
4870 // Between the time we initiated the Halt and the time we delivered it, the process could have
4871 // already finished its job. Check that here:
4872
4873 if (thread->IsThreadPlanDone (thread_plan_sp.get()))
4874 {
4875 if (log)
4876 log->PutCString ("Process::RunThreadPlan(): Even though we timed out, the call plan was done. "
4877 "Exiting wait loop.");
4878 return_value = eExecutionCompleted;
4879 break;
4880 }
4881
4882 if (first_timeout)
4883 {
4884 // Set all the other threads to run, and return to the top of the loop, which will continue;
4885 first_timeout = false;
4886 thread_plan_sp->SetStopOthers (false);
4887 if (log)
4888 log->PutCString ("Process::RunThreadPlan(): About to resume.");
4889
4890 continue;
4891 }
4892 else
4893 {
4894 // Running all threads failed, so return Interrupted.
4895 if (log)
4896 log->PutCString ("Process::RunThreadPlan(): running all threads timed out.");
4897 return_value = eExecutionInterrupted;
4898 break;
4899 }
4900 }
4901 else
4902 {
4903 if (log)
4904 log->Printf ("Process::RunThreadPlan(): halt failed, I waited and didn't get"
4905 " a stopped event, instead got %s.", StateAsCString(stop_state));
4906 return_value = eExecutionInterrupted;
4907 break;
4908 }
4909 }
4910 }
4911
4912 }
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004913 } // END WAIT LOOP
4914
4915 // If we had to start up a temporary private state thread to run this thread plan, shut it down now.
4916 if (IS_VALID_LLDB_HOST_THREAD(backup_private_state_thread))
4917 {
4918 StopPrivateStateThread();
4919 Error error;
4920 m_private_state_thread = backup_private_state_thread;
Sean Callananb386d822012-08-09 00:50:26 +00004921 if (stopper_base_plan_sp)
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004922 {
4923 thread->DiscardThreadPlansUpToPlan(stopper_base_plan_sp);
4924 }
4925 m_public_state.SetValueNoLock(old_state);
4926
4927 }
4928
Jim Inghamb7940202013-01-15 02:47:48 +00004929 // Restore the thread state if we are going to discard the plan execution. There are three cases where this
4930 // could happen:
4931 // 1) The execution successfully completed
4932 // 2) We hit a breakpoint, and ignore_breakpoints was true
4933 // 3) We got some other error, and discard_on_error was true
4934 bool should_unwind = (return_value == eExecutionInterrupted && unwind_on_error)
4935 || (return_value == eExecutionHitBreakpoint && ignore_breakpoints);
Jim Ingham76b258d2012-11-26 23:52:18 +00004936
Jim Inghamb7940202013-01-15 02:47:48 +00004937 if (return_value == eExecutionCompleted
4938 || should_unwind)
Jim Ingham76b258d2012-11-26 23:52:18 +00004939 {
4940 thread_plan_sp->RestoreThreadState();
4941 }
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004942
4943 // Now do some processing on the results of the run:
Jim Inghamb7940202013-01-15 02:47:48 +00004944 if (return_value == eExecutionInterrupted || return_value == eExecutionHitBreakpoint)
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004945 {
4946 if (log)
4947 {
4948 StreamString s;
4949 if (event_sp)
4950 event_sp->Dump (&s);
4951 else
4952 {
4953 log->PutCString ("Process::RunThreadPlan(): Stop event that interrupted us is NULL.");
4954 }
4955
4956 StreamString ts;
4957
4958 const char *event_explanation = NULL;
4959
4960 do
4961 {
Jim Ingham5d90ade2012-07-27 23:57:19 +00004962 if (!event_sp)
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004963 {
Jim Ingham5d90ade2012-07-27 23:57:19 +00004964 event_explanation = "<no event>";
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004965 break;
4966 }
Jim Ingham5d90ade2012-07-27 23:57:19 +00004967 else if (event_sp->GetType() == eBroadcastBitInterrupt)
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004968 {
Jim Ingham5d90ade2012-07-27 23:57:19 +00004969 event_explanation = "<user interrupt>";
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004970 break;
4971 }
Jim Ingham5d90ade2012-07-27 23:57:19 +00004972 else
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004973 {
Jim Ingham5d90ade2012-07-27 23:57:19 +00004974 const Process::ProcessEventData *event_data = Process::ProcessEventData::GetEventDataFromEvent (event_sp.get());
4975
4976 if (!event_data)
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004977 {
Jim Ingham5d90ade2012-07-27 23:57:19 +00004978 event_explanation = "<no event data>";
4979 break;
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004980 }
4981
Jim Ingham5d90ade2012-07-27 23:57:19 +00004982 Process *process = event_data->GetProcessSP().get();
4983
4984 if (!process)
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004985 {
Jim Ingham5d90ade2012-07-27 23:57:19 +00004986 event_explanation = "<no process>";
4987 break;
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004988 }
Jim Ingham5d90ade2012-07-27 23:57:19 +00004989
4990 ThreadList &thread_list = process->GetThreadList();
4991
4992 uint32_t num_threads = thread_list.GetSize();
4993 uint32_t thread_index;
4994
4995 ts.Printf("<%u threads> ", num_threads);
4996
4997 for (thread_index = 0;
4998 thread_index < num_threads;
4999 ++thread_index)
5000 {
5001 Thread *thread = thread_list.GetThreadAtIndex(thread_index).get();
5002
5003 if (!thread)
5004 {
5005 ts.Printf("<?> ");
5006 continue;
5007 }
5008
Daniel Malea5f35a4b2012-11-29 21:49:15 +00005009 ts.Printf("<0x%4.4" PRIx64 " ", thread->GetID());
Jim Ingham5d90ade2012-07-27 23:57:19 +00005010 RegisterContext *register_context = thread->GetRegisterContext().get();
5011
5012 if (register_context)
Daniel Malea5f35a4b2012-11-29 21:49:15 +00005013 ts.Printf("[ip 0x%" PRIx64 "] ", register_context->GetPC());
Jim Ingham5d90ade2012-07-27 23:57:19 +00005014 else
5015 ts.Printf("[ip unknown] ");
5016
5017 lldb::StopInfoSP stop_info_sp = thread->GetStopInfo();
5018 if (stop_info_sp)
5019 {
5020 const char *stop_desc = stop_info_sp->GetDescription();
5021 if (stop_desc)
5022 ts.PutCString (stop_desc);
5023 }
5024 ts.Printf(">");
5025 }
5026
5027 event_explanation = ts.GetData();
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00005028 }
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00005029 } while (0);
5030
Jim Ingham5d90ade2012-07-27 23:57:19 +00005031 if (event_explanation)
5032 log->Printf("Process::RunThreadPlan(): execution interrupted: %s %s", s.GetData(), event_explanation);
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00005033 else
Jim Ingham5d90ade2012-07-27 23:57:19 +00005034 log->Printf("Process::RunThreadPlan(): execution interrupted: %s", s.GetData());
5035 }
5036
Jim Inghamb7940202013-01-15 02:47:48 +00005037 if (should_unwind && thread_plan_sp)
Jim Ingham5d90ade2012-07-27 23:57:19 +00005038 {
5039 if (log)
5040 log->Printf ("Process::RunThreadPlan: ExecutionInterrupted - discarding thread plans up to %p.", thread_plan_sp.get());
5041 thread->DiscardThreadPlansUpToPlan (thread_plan_sp);
5042 thread_plan_sp->SetPrivate (orig_plan_private);
5043 }
5044 else
5045 {
5046 if (log)
5047 log->Printf ("Process::RunThreadPlan: ExecutionInterrupted - for plan: %p not discarding.", thread_plan_sp.get());
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00005048 }
5049 }
5050 else if (return_value == eExecutionSetupError)
5051 {
5052 if (log)
5053 log->PutCString("Process::RunThreadPlan(): execution set up error.");
Jim Inghamf9f40c22011-02-08 05:20:59 +00005054
Jim Inghamb7940202013-01-15 02:47:48 +00005055 if (unwind_on_error && thread_plan_sp)
Jim Inghamf9f40c22011-02-08 05:20:59 +00005056 {
Greg Clayton567e7f32011-09-22 04:58:26 +00005057 thread->DiscardThreadPlansUpToPlan (thread_plan_sp);
Jim Ingham21f37ad2011-08-09 02:12:22 +00005058 thread_plan_sp->SetPrivate (orig_plan_private);
Jim Inghamf9f40c22011-02-08 05:20:59 +00005059 }
Jim Ingham360f53f2010-11-30 02:22:11 +00005060 }
5061 else
5062 {
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00005063 if (thread->IsThreadPlanDone (thread_plan_sp.get()))
Jim Ingham360f53f2010-11-30 02:22:11 +00005064 {
Jim Inghamf9f40c22011-02-08 05:20:59 +00005065 if (log)
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00005066 log->PutCString("Process::RunThreadPlan(): thread plan is done");
5067 return_value = eExecutionCompleted;
5068 }
5069 else if (thread->WasThreadPlanDiscarded (thread_plan_sp.get()))
5070 {
5071 if (log)
5072 log->PutCString("Process::RunThreadPlan(): thread plan was discarded");
5073 return_value = eExecutionDiscarded;
5074 }
5075 else
5076 {
5077 if (log)
5078 log->PutCString("Process::RunThreadPlan(): thread plan stopped in mid course");
Jim Inghamb7940202013-01-15 02:47:48 +00005079 if (unwind_on_error && thread_plan_sp)
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00005080 {
5081 if (log)
Jim Inghamb7940202013-01-15 02:47:48 +00005082 log->PutCString("Process::RunThreadPlan(): discarding thread plan 'cause unwind_on_error is set.");
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00005083 thread->DiscardThreadPlansUpToPlan (thread_plan_sp);
5084 thread_plan_sp->SetPrivate (orig_plan_private);
5085 }
5086 }
5087 }
5088
5089 // Thread we ran the function in may have gone away because we ran the target
5090 // Check that it's still there, and if it is put it back in the context. Also restore the
5091 // frame in the context if it is still present.
5092 thread = GetThreadList().FindThreadByIndexID(thread_idx_id, true).get();
5093 if (thread)
5094 {
5095 exe_ctx.SetFrameSP (thread->GetFrameWithStackID (ctx_frame_id));
5096 }
5097
5098 // Also restore the current process'es selected frame & thread, since this function calling may
5099 // be done behind the user's back.
5100
5101 if (selected_tid != LLDB_INVALID_THREAD_ID)
5102 {
5103 if (GetThreadList().SetSelectedThreadByIndexID (selected_tid) && selected_stack_id.IsValid())
5104 {
5105 // We were able to restore the selected thread, now restore the frame:
5106 StackFrameSP old_frame_sp = GetThreadList().GetSelectedThread()->GetFrameWithStackID(selected_stack_id);
5107 if (old_frame_sp)
5108 GetThreadList().GetSelectedThread()->SetSelectedFrame(old_frame_sp.get());
Jim Ingham360f53f2010-11-30 02:22:11 +00005109 }
Jim Ingham360f53f2010-11-30 02:22:11 +00005110 }
5111 }
Jim Ingham360f53f2010-11-30 02:22:11 +00005112
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00005113 // If the process exited during the run of the thread plan, notify everyone.
Jim Ingham360f53f2010-11-30 02:22:11 +00005114
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00005115 if (event_to_broadcast_sp)
Jim Ingham360f53f2010-11-30 02:22:11 +00005116 {
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00005117 if (log)
5118 log->PutCString("Process::RunThreadPlan(): rebroadcasting event.");
5119 BroadcastEvent(event_to_broadcast_sp);
Jim Ingham360f53f2010-11-30 02:22:11 +00005120 }
5121
5122 return return_value;
5123}
5124
5125const char *
5126Process::ExecutionResultAsCString (ExecutionResults result)
5127{
5128 const char *result_name;
5129
5130 switch (result)
5131 {
Greg Claytonb3448432011-03-24 21:19:54 +00005132 case eExecutionCompleted:
Jim Ingham360f53f2010-11-30 02:22:11 +00005133 result_name = "eExecutionCompleted";
5134 break;
Greg Claytonb3448432011-03-24 21:19:54 +00005135 case eExecutionDiscarded:
Jim Ingham360f53f2010-11-30 02:22:11 +00005136 result_name = "eExecutionDiscarded";
5137 break;
Greg Claytonb3448432011-03-24 21:19:54 +00005138 case eExecutionInterrupted:
Jim Ingham360f53f2010-11-30 02:22:11 +00005139 result_name = "eExecutionInterrupted";
5140 break;
Jim Inghamb7940202013-01-15 02:47:48 +00005141 case eExecutionHitBreakpoint:
5142 result_name = "eExecutionHitBreakpoint";
5143 break;
Greg Claytonb3448432011-03-24 21:19:54 +00005144 case eExecutionSetupError:
Jim Ingham360f53f2010-11-30 02:22:11 +00005145 result_name = "eExecutionSetupError";
5146 break;
Greg Claytonb3448432011-03-24 21:19:54 +00005147 case eExecutionTimedOut:
Jim Ingham360f53f2010-11-30 02:22:11 +00005148 result_name = "eExecutionTimedOut";
5149 break;
5150 }
5151 return result_name;
5152}
5153
Greg Claytonabe0fed2011-04-18 08:33:37 +00005154void
5155Process::GetStatus (Stream &strm)
5156{
5157 const StateType state = GetState();
Greg Clayton20206082011-11-17 01:23:07 +00005158 if (StateIsStoppedState(state, false))
Greg Claytonabe0fed2011-04-18 08:33:37 +00005159 {
5160 if (state == eStateExited)
5161 {
5162 int exit_status = GetExitStatus();
5163 const char *exit_description = GetExitDescription();
Daniel Malea5f35a4b2012-11-29 21:49:15 +00005164 strm.Printf ("Process %" PRIu64 " exited with status = %i (0x%8.8x) %s\n",
Greg Claytonabe0fed2011-04-18 08:33:37 +00005165 GetID(),
5166 exit_status,
5167 exit_status,
5168 exit_description ? exit_description : "");
5169 }
5170 else
5171 {
5172 if (state == eStateConnected)
5173 strm.Printf ("Connected to remote target.\n");
5174 else
Daniel Malea5f35a4b2012-11-29 21:49:15 +00005175 strm.Printf ("Process %" PRIu64 " %s\n", GetID(), StateAsCString (state));
Greg Claytonabe0fed2011-04-18 08:33:37 +00005176 }
5177 }
5178 else
5179 {
Daniel Malea5f35a4b2012-11-29 21:49:15 +00005180 strm.Printf ("Process %" PRIu64 " is running.\n", GetID());
Greg Claytonabe0fed2011-04-18 08:33:37 +00005181 }
5182}
5183
5184size_t
5185Process::GetThreadStatus (Stream &strm,
5186 bool only_threads_with_stop_reason,
5187 uint32_t start_frame,
5188 uint32_t num_frames,
5189 uint32_t num_frames_with_source)
5190{
5191 size_t num_thread_infos_dumped = 0;
5192
Jim Inghamb9950592012-09-10 20:50:15 +00005193 Mutex::Locker locker (GetThreadList().GetMutex());
Greg Claytonabe0fed2011-04-18 08:33:37 +00005194 const size_t num_threads = GetThreadList().GetSize();
5195 for (uint32_t i = 0; i < num_threads; i++)
5196 {
5197 Thread *thread = GetThreadList().GetThreadAtIndex(i).get();
5198 if (thread)
5199 {
5200 if (only_threads_with_stop_reason)
5201 {
Jim Ingham6bc24c12012-10-16 00:09:33 +00005202 StopInfoSP stop_info_sp = thread->GetStopInfo();
5203 if (stop_info_sp.get() == NULL || !stop_info_sp->IsValid())
Greg Claytonabe0fed2011-04-18 08:33:37 +00005204 continue;
5205 }
5206 thread->GetStatus (strm,
5207 start_frame,
5208 num_frames,
5209 num_frames_with_source);
5210 ++num_thread_infos_dumped;
5211 }
5212 }
5213 return num_thread_infos_dumped;
5214}
5215
Greg Clayton76113302012-02-22 04:37:26 +00005216void
5217Process::AddInvalidMemoryRegion (const LoadRange &region)
5218{
5219 m_memory_cache.AddInvalidRange(region.GetRangeBase(), region.GetByteSize());
5220}
5221
5222bool
5223Process::RemoveInvalidMemoryRange (const LoadRange &region)
5224{
5225 return m_memory_cache.RemoveInvalidRange(region.GetRangeBase(), region.GetByteSize());
5226}
5227
Jim Ingham1831e782012-04-07 00:00:41 +00005228void
5229Process::AddPreResumeAction (PreResumeActionCallback callback, void *baton)
5230{
5231 m_pre_resume_actions.push_back(PreResumeCallbackAndBaton (callback, baton));
5232}
5233
5234bool
5235Process::RunPreResumeActions ()
5236{
5237 bool result = true;
5238 while (!m_pre_resume_actions.empty())
5239 {
5240 struct PreResumeCallbackAndBaton action = m_pre_resume_actions.back();
5241 m_pre_resume_actions.pop_back();
5242 bool this_result = action.callback (action.baton);
5243 if (result == true) result = this_result;
5244 }
5245 return result;
5246}
5247
5248void
5249Process::ClearPreResumeActions ()
5250{
5251 m_pre_resume_actions.clear();
5252}
Greg Clayton76113302012-02-22 04:37:26 +00005253
Greg Claytoncf5927e2012-05-18 02:38:05 +00005254void
5255Process::Flush ()
5256{
5257 m_thread_list.Flush();
5258}
Greg Clayton0bce9a22012-12-05 00:16:59 +00005259
5260void
5261Process::DidExec ()
5262{
5263 Target &target = GetTarget();
5264 target.CleanupProcess ();
5265 ModuleList unloaded_modules (target.GetImages());
5266 target.ModulesDidUnload (unloaded_modules);
5267 target.GetSectionLoadList().Clear();
5268 m_dynamic_checkers_ap.reset();
5269 m_abi_sp.reset();
5270 m_os_ap.reset();
5271 m_dyld_ap.reset();
5272 m_image_tokens.clear();
5273 m_allocated_memory_cache.Clear();
5274 m_language_runtimes.clear();
5275 DoDidExec();
5276 CompleteAttach ();
5277}