blob: b16a37de3d1b3dc1c3eb7f39353f3d3ef4e4043c [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
10#include "lldb/Target/Process.h"
11
12#include "lldb/lldb-private-log.h"
13
14#include "lldb/Breakpoint/StoppointCallbackContext.h"
15#include "lldb/Breakpoint/BreakpointLocation.h"
16#include "lldb/Core/Event.h"
Caroline Tice861efb32010-11-16 05:07:41 +000017#include "lldb/Core/ConnectionFileDescriptor.h"
Chris Lattner24943d22010-06-08 16:52:24 +000018#include "lldb/Core/Debugger.h"
Caroline Tice861efb32010-11-16 05:07:41 +000019#include "lldb/Core/InputReader.h"
Chris Lattner24943d22010-06-08 16:52:24 +000020#include "lldb/Core/Log.h"
Greg Clayton49ce8962012-08-29 21:13:06 +000021#include "lldb/Core/Module.h"
Chris Lattner24943d22010-06-08 16:52:24 +000022#include "lldb/Core/PluginManager.h"
23#include "lldb/Core/State.h"
Greg Claytonf15996e2011-04-07 22:46:35 +000024#include "lldb/Expression/ClangUserExpression.h"
Caroline Tice6e4c5ce2010-09-04 00:03:46 +000025#include "lldb/Interpreter/CommandInterpreter.h"
Chris Lattner24943d22010-06-08 16:52:24 +000026#include "lldb/Host/Host.h"
27#include "lldb/Target/ABI.h"
Greg Clayton0baa3942010-11-04 01:54:29 +000028#include "lldb/Target/DynamicLoader.h"
Greg Clayton37f962e2011-08-22 02:49:39 +000029#include "lldb/Target/OperatingSystem.h"
Jim Ingham642036f2010-09-23 02:01:19 +000030#include "lldb/Target/LanguageRuntime.h"
31#include "lldb/Target/CPPLanguageRuntime.h"
32#include "lldb/Target/ObjCLanguageRuntime.h"
Greg Claytone4b9c1f2011-03-08 22:40:15 +000033#include "lldb/Target/Platform.h"
Chris Lattner24943d22010-06-08 16:52:24 +000034#include "lldb/Target/RegisterContext.h"
Greg Clayton643ee732010-08-04 01:40:35 +000035#include "lldb/Target/StopInfo.h"
Chris Lattner24943d22010-06-08 16:52:24 +000036#include "lldb/Target/Target.h"
37#include "lldb/Target/TargetList.h"
38#include "lldb/Target/Thread.h"
39#include "lldb/Target/ThreadPlan.h"
Jim Inghamd21d98b2012-04-10 01:21:57 +000040#include "lldb/Target/ThreadPlanBase.h"
Chris Lattner24943d22010-06-08 16:52:24 +000041
42using namespace lldb;
43using namespace lldb_private;
44
Greg Clayton73844aa2012-08-22 17:17:09 +000045
46// Comment out line below to disable memory caching, overriding the process setting
47// target.process.disable-memory-cache
48#define ENABLE_MEMORY_CACHING
49
50#ifdef ENABLE_MEMORY_CACHING
51#define DISABLE_MEM_CACHE_DEFAULT false
52#else
53#define DISABLE_MEM_CACHE_DEFAULT true
54#endif
55
56class ProcessOptionValueProperties : public OptionValueProperties
57{
58public:
59 ProcessOptionValueProperties (const ConstString &name) :
60 OptionValueProperties (name)
61 {
62 }
63
64 // This constructor is used when creating ProcessOptionValueProperties when it
65 // is part of a new lldb_private::Process instance. It will copy all current
66 // global property values as needed
67 ProcessOptionValueProperties (ProcessProperties *global_properties) :
68 OptionValueProperties(*global_properties->GetValueProperties())
69 {
70 }
71
72 virtual const Property *
73 GetPropertyAtIndex (const ExecutionContext *exe_ctx, bool will_modify, uint32_t idx) const
74 {
75 // When gettings the value for a key from the process options, we will always
76 // try and grab the setting from the current process if there is one. Else we just
77 // use the one from this instance.
78 if (exe_ctx)
79 {
80 Process *process = exe_ctx->GetProcessPtr();
81 if (process)
82 {
83 ProcessOptionValueProperties *instance_properties = static_cast<ProcessOptionValueProperties *>(process->GetValueProperties().get());
84 if (this != instance_properties)
85 return instance_properties->ProtectedGetPropertyAtIndex (idx);
86 }
87 }
88 return ProtectedGetPropertyAtIndex (idx);
89 }
90};
91
92static PropertyDefinition
93g_properties[] =
94{
95 { "disable-memory-cache" , OptionValue::eTypeBoolean, false, DISABLE_MEM_CACHE_DEFAULT, NULL, NULL, "Disable reading and caching of memory in fixed-size units." },
96 { "extra-startup-command", OptionValue::eTypeArray , false, OptionValue::eTypeString, NULL, NULL, "A list containing extra commands understood by the particular process plugin used." },
97 { NULL , OptionValue::eTypeInvalid, false, 0, NULL, NULL, NULL }
98};
99
100enum {
101 ePropertyDisableMemCache,
102 ePropertyExtraStartCommand
103};
104
105ProcessProperties::ProcessProperties (bool is_global) :
106 Properties ()
107{
108 if (is_global)
109 {
110 m_collection_sp.reset (new ProcessOptionValueProperties(ConstString("process")));
111 m_collection_sp->Initialize(g_properties);
112 m_collection_sp->AppendProperty(ConstString("thread"),
113 ConstString("Settings specify to threads."),
114 true,
115 Thread::GetGlobalProperties()->GetValueProperties());
116 }
117 else
118 m_collection_sp.reset (new ProcessOptionValueProperties(Process::GetGlobalProperties().get()));
119}
120
121ProcessProperties::~ProcessProperties()
122{
123}
124
125bool
126ProcessProperties::GetDisableMemoryCache() const
127{
128 const uint32_t idx = ePropertyDisableMemCache;
129 return m_collection_sp->GetPropertyAtIndexAsBoolean (NULL, idx, g_properties[idx].default_uint_value != 0);
130}
131
132Args
133ProcessProperties::GetExtraStartupCommands () const
134{
135 Args args;
136 const uint32_t idx = ePropertyExtraStartCommand;
137 m_collection_sp->GetPropertyAtIndexAsArgs(NULL, idx, args);
138 return args;
139}
140
141void
142ProcessProperties::SetExtraStartupCommands (const Args &args)
143{
144 const uint32_t idx = ePropertyExtraStartCommand;
145 m_collection_sp->SetPropertyAtIndexFromArgs(NULL, idx, args);
146}
147
Greg Clayton24bc5d92011-03-30 18:16:51 +0000148void
Greg Claytonb72d0f02011-04-12 05:54:46 +0000149ProcessInstanceInfo::Dump (Stream &s, Platform *platform) const
Greg Clayton24bc5d92011-03-30 18:16:51 +0000150{
151 const char *cstr;
Greg Claytonff39f742011-04-01 00:29:43 +0000152 if (m_pid != LLDB_INVALID_PROCESS_ID)
Greg Claytond9919d32011-12-01 23:28:38 +0000153 s.Printf (" pid = %llu\n", m_pid);
Greg Claytonff39f742011-04-01 00:29:43 +0000154
155 if (m_parent_pid != LLDB_INVALID_PROCESS_ID)
Greg Claytond9919d32011-12-01 23:28:38 +0000156 s.Printf (" parent = %llu\n", m_parent_pid);
Greg Claytonff39f742011-04-01 00:29:43 +0000157
158 if (m_executable)
159 {
160 s.Printf (" name = %s\n", m_executable.GetFilename().GetCString());
161 s.PutCString (" file = ");
162 m_executable.Dump(&s);
163 s.EOL();
164 }
Greg Claytonb72d0f02011-04-12 05:54:46 +0000165 const uint32_t argc = m_arguments.GetArgumentCount();
Greg Claytonff39f742011-04-01 00:29:43 +0000166 if (argc > 0)
167 {
168 for (uint32_t i=0; i<argc; i++)
169 {
Greg Claytonb72d0f02011-04-12 05:54:46 +0000170 const char *arg = m_arguments.GetArgumentAtIndex(i);
Greg Claytonff39f742011-04-01 00:29:43 +0000171 if (i < 10)
Greg Claytonb72d0f02011-04-12 05:54:46 +0000172 s.Printf (" arg[%u] = %s\n", i, arg);
Greg Claytonff39f742011-04-01 00:29:43 +0000173 else
Greg Claytonb72d0f02011-04-12 05:54:46 +0000174 s.Printf ("arg[%u] = %s\n", i, arg);
Greg Claytonff39f742011-04-01 00:29:43 +0000175 }
176 }
Greg Claytonb72d0f02011-04-12 05:54:46 +0000177
178 const uint32_t envc = m_environment.GetArgumentCount();
179 if (envc > 0)
180 {
181 for (uint32_t i=0; i<envc; i++)
182 {
183 const char *env = m_environment.GetArgumentAtIndex(i);
184 if (i < 10)
185 s.Printf (" env[%u] = %s\n", i, env);
186 else
187 s.Printf ("env[%u] = %s\n", i, env);
188 }
189 }
190
Greg Claytonff39f742011-04-01 00:29:43 +0000191 if (m_arch.IsValid())
192 s.Printf (" arch = %s\n", m_arch.GetTriple().str().c_str());
193
Greg Claytonb72d0f02011-04-12 05:54:46 +0000194 if (m_uid != UINT32_MAX)
Greg Clayton24bc5d92011-03-30 18:16:51 +0000195 {
Greg Claytonb72d0f02011-04-12 05:54:46 +0000196 cstr = platform->GetUserName (m_uid);
197 s.Printf (" uid = %-5u (%s)\n", m_uid, cstr ? cstr : "");
Greg Clayton24bc5d92011-03-30 18:16:51 +0000198 }
Greg Claytonb72d0f02011-04-12 05:54:46 +0000199 if (m_gid != UINT32_MAX)
Greg Clayton24bc5d92011-03-30 18:16:51 +0000200 {
Greg Claytonb72d0f02011-04-12 05:54:46 +0000201 cstr = platform->GetGroupName (m_gid);
202 s.Printf (" gid = %-5u (%s)\n", m_gid, cstr ? cstr : "");
Greg Clayton24bc5d92011-03-30 18:16:51 +0000203 }
Greg Claytonb72d0f02011-04-12 05:54:46 +0000204 if (m_euid != UINT32_MAX)
Greg Clayton24bc5d92011-03-30 18:16:51 +0000205 {
Greg Claytonb72d0f02011-04-12 05:54:46 +0000206 cstr = platform->GetUserName (m_euid);
207 s.Printf (" euid = %-5u (%s)\n", m_euid, cstr ? cstr : "");
Greg Clayton24bc5d92011-03-30 18:16:51 +0000208 }
Greg Claytonb72d0f02011-04-12 05:54:46 +0000209 if (m_egid != UINT32_MAX)
Greg Clayton24bc5d92011-03-30 18:16:51 +0000210 {
Greg Claytonb72d0f02011-04-12 05:54:46 +0000211 cstr = platform->GetGroupName (m_egid);
212 s.Printf (" egid = %-5u (%s)\n", m_egid, cstr ? cstr : "");
Greg Clayton24bc5d92011-03-30 18:16:51 +0000213 }
214}
215
216void
Greg Claytonb72d0f02011-04-12 05:54:46 +0000217ProcessInstanceInfo::DumpTableHeader (Stream &s, Platform *platform, bool show_args, bool verbose)
Greg Clayton24bc5d92011-03-30 18:16:51 +0000218{
Greg Claytonb72d0f02011-04-12 05:54:46 +0000219 const char *label;
220 if (show_args || verbose)
221 label = "ARGUMENTS";
222 else
223 label = "NAME";
224
Greg Claytonff39f742011-04-01 00:29:43 +0000225 if (verbose)
226 {
Greg Claytonb72d0f02011-04-12 05:54:46 +0000227 s.Printf ("PID PARENT USER GROUP EFF USER EFF GROUP TRIPLE %s\n", label);
Greg Claytonff39f742011-04-01 00:29:43 +0000228 s.PutCString ("====== ====== ========== ========== ========== ========== ======================== ============================\n");
229 }
230 else
231 {
Greg Claytonb72d0f02011-04-12 05:54:46 +0000232 s.Printf ("PID PARENT USER ARCH %s\n", label);
Greg Claytonff39f742011-04-01 00:29:43 +0000233 s.PutCString ("====== ====== ========== ======= ============================\n");
234 }
Greg Clayton24bc5d92011-03-30 18:16:51 +0000235}
236
237void
Greg Claytonb72d0f02011-04-12 05:54:46 +0000238ProcessInstanceInfo::DumpAsTableRow (Stream &s, Platform *platform, bool show_args, bool verbose) const
Greg Clayton24bc5d92011-03-30 18:16:51 +0000239{
240 if (m_pid != LLDB_INVALID_PROCESS_ID)
241 {
242 const char *cstr;
Greg Claytond9919d32011-12-01 23:28:38 +0000243 s.Printf ("%-6llu %-6llu ", m_pid, m_parent_pid);
Greg Clayton24bc5d92011-03-30 18:16:51 +0000244
Greg Clayton24bc5d92011-03-30 18:16:51 +0000245
Greg Claytonff39f742011-04-01 00:29:43 +0000246 if (verbose)
247 {
Greg Claytonb72d0f02011-04-12 05:54:46 +0000248 cstr = platform->GetUserName (m_uid);
Greg Claytonff39f742011-04-01 00:29:43 +0000249 if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
250 s.Printf ("%-10s ", cstr);
251 else
Greg Claytonb72d0f02011-04-12 05:54:46 +0000252 s.Printf ("%-10u ", m_uid);
Greg Clayton24bc5d92011-03-30 18:16:51 +0000253
Greg Claytonb72d0f02011-04-12 05:54:46 +0000254 cstr = platform->GetGroupName (m_gid);
Greg Claytonff39f742011-04-01 00:29:43 +0000255 if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
256 s.Printf ("%-10s ", cstr);
257 else
Greg Claytonb72d0f02011-04-12 05:54:46 +0000258 s.Printf ("%-10u ", m_gid);
Greg Clayton24bc5d92011-03-30 18:16:51 +0000259
Greg Claytonb72d0f02011-04-12 05:54:46 +0000260 cstr = platform->GetUserName (m_euid);
Greg Claytonff39f742011-04-01 00:29:43 +0000261 if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
262 s.Printf ("%-10s ", cstr);
263 else
Greg Claytonb72d0f02011-04-12 05:54:46 +0000264 s.Printf ("%-10u ", m_euid);
Greg Claytonff39f742011-04-01 00:29:43 +0000265
Greg Claytonb72d0f02011-04-12 05:54:46 +0000266 cstr = platform->GetGroupName (m_egid);
Greg Claytonff39f742011-04-01 00:29:43 +0000267 if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
268 s.Printf ("%-10s ", cstr);
269 else
Greg Claytonb72d0f02011-04-12 05:54:46 +0000270 s.Printf ("%-10u ", m_egid);
Greg Claytonff39f742011-04-01 00:29:43 +0000271 s.Printf ("%-24s ", m_arch.IsValid() ? m_arch.GetTriple().str().c_str() : "");
272 }
273 else
274 {
Jason Molenda7e5fa7f2011-09-20 21:44:10 +0000275 s.Printf ("%-10s %-7d %s ",
Greg Claytonb72d0f02011-04-12 05:54:46 +0000276 platform->GetUserName (m_euid),
Greg Claytonff39f742011-04-01 00:29:43 +0000277 (int)m_arch.GetTriple().getArchName().size(),
278 m_arch.GetTriple().getArchName().data());
279 }
280
Greg Claytonb72d0f02011-04-12 05:54:46 +0000281 if (verbose || show_args)
Greg Claytonff39f742011-04-01 00:29:43 +0000282 {
Greg Claytonb72d0f02011-04-12 05:54:46 +0000283 const uint32_t argc = m_arguments.GetArgumentCount();
Greg Claytonff39f742011-04-01 00:29:43 +0000284 if (argc > 0)
285 {
286 for (uint32_t i=0; i<argc; i++)
287 {
288 if (i > 0)
289 s.PutChar (' ');
Greg Claytonb72d0f02011-04-12 05:54:46 +0000290 s.PutCString (m_arguments.GetArgumentAtIndex(i));
Greg Claytonff39f742011-04-01 00:29:43 +0000291 }
292 }
293 }
294 else
295 {
296 s.PutCString (GetName());
297 }
298
299 s.EOL();
Greg Clayton24bc5d92011-03-30 18:16:51 +0000300 }
301}
302
Greg Claytonb72d0f02011-04-12 05:54:46 +0000303
304void
Greg Clayton36bc5ea2011-11-03 21:22:33 +0000305ProcessInfo::SetArguments (char const **argv,
306 bool first_arg_is_executable,
307 bool first_arg_is_executable_and_argument)
308{
309 m_arguments.SetArguments (argv);
310
311 // Is the first argument the executable?
312 if (first_arg_is_executable)
313 {
314 const char *first_arg = m_arguments.GetArgumentAtIndex (0);
315 if (first_arg)
316 {
317 // Yes the first argument is an executable, set it as the executable
318 // in the launch options. Don't resolve the file path as the path
319 // could be a remote platform path
320 const bool resolve = false;
321 m_executable.SetFile(first_arg, resolve);
322
323 // If argument zero is an executable and shouldn't be included
324 // in the arguments, remove it from the front of the arguments
325 if (first_arg_is_executable_and_argument == false)
326 m_arguments.DeleteArgumentAtIndex (0);
327 }
328 }
329}
330void
331ProcessInfo::SetArguments (const Args& args,
332 bool first_arg_is_executable,
333 bool first_arg_is_executable_and_argument)
Greg Claytonb72d0f02011-04-12 05:54:46 +0000334{
335 // Copy all arguments
336 m_arguments = args;
337
338 // Is the first argument the executable?
339 if (first_arg_is_executable)
340 {
Greg Clayton36bc5ea2011-11-03 21:22:33 +0000341 const char *first_arg = m_arguments.GetArgumentAtIndex (0);
Greg Claytonb72d0f02011-04-12 05:54:46 +0000342 if (first_arg)
343 {
344 // Yes the first argument is an executable, set it as the executable
345 // in the launch options. Don't resolve the file path as the path
346 // could be a remote platform path
347 const bool resolve = false;
348 m_executable.SetFile(first_arg, resolve);
349
350 // If argument zero is an executable and shouldn't be included
351 // in the arguments, remove it from the front of the arguments
352 if (first_arg_is_executable_and_argument == false)
353 m_arguments.DeleteArgumentAtIndex (0);
354 }
355 }
356}
357
Greg Claytonabb33022011-11-08 02:43:13 +0000358void
Greg Clayton464c6162011-11-17 22:14:31 +0000359ProcessLaunchInfo::FinalizeFileActions (Target *target, bool default_to_use_pty)
Greg Claytonabb33022011-11-08 02:43:13 +0000360{
361 // If notthing was specified, then check the process for any default
362 // settings that were set with "settings set"
363 if (m_file_actions.empty())
364 {
Greg Claytonabb33022011-11-08 02:43:13 +0000365 if (m_flags.Test(eLaunchFlagDisableSTDIO))
366 {
Greg Clayton95ec1682012-03-06 04:01:04 +0000367 AppendSuppressFileAction (STDIN_FILENO , true, false);
368 AppendSuppressFileAction (STDOUT_FILENO, false, true);
369 AppendSuppressFileAction (STDERR_FILENO, false, true);
Greg Claytonabb33022011-11-08 02:43:13 +0000370 }
371 else
372 {
373 // Check for any values that might have gotten set with any of:
374 // (lldb) settings set target.input-path
375 // (lldb) settings set target.output-path
376 // (lldb) settings set target.error-path
Greg Clayton73844aa2012-08-22 17:17:09 +0000377 FileSpec in_path;
378 FileSpec out_path;
379 FileSpec err_path;
Greg Claytonabb33022011-11-08 02:43:13 +0000380 if (target)
381 {
Greg Clayton95ec1682012-03-06 04:01:04 +0000382 in_path = target->GetStandardInputPath();
383 out_path = target->GetStandardOutputPath();
384 err_path = target->GetStandardErrorPath();
Greg Clayton464c6162011-11-17 22:14:31 +0000385 }
386
Greg Clayton73844aa2012-08-22 17:17:09 +0000387 if (in_path || out_path || err_path)
388 {
389 char path[PATH_MAX];
390 if (in_path && in_path.GetPath(path, sizeof(path)))
391 AppendOpenFileAction(STDIN_FILENO, path, true, false);
392
393 if (out_path && out_path.GetPath(path, sizeof(path)))
394 AppendOpenFileAction(STDOUT_FILENO, path, false, true);
395
396 if (err_path && err_path.GetPath(path, sizeof(path)))
397 AppendOpenFileAction(STDERR_FILENO, path, false, true);
398 }
399 else if (default_to_use_pty)
Greg Clayton464c6162011-11-17 22:14:31 +0000400 {
401 if (m_pty.OpenFirstAvailableMaster (O_RDWR|O_NOCTTY, NULL, 0))
Greg Claytonabb33022011-11-08 02:43:13 +0000402 {
Greg Clayton73844aa2012-08-22 17:17:09 +0000403 const char *slave_path = m_pty.GetSlaveName (NULL, 0);
404 AppendOpenFileAction(STDIN_FILENO, slave_path, true, false);
405 AppendOpenFileAction(STDOUT_FILENO, slave_path, false, true);
406 AppendOpenFileAction(STDERR_FILENO, slave_path, false, true);
Greg Claytonabb33022011-11-08 02:43:13 +0000407 }
408 }
Greg Claytonabb33022011-11-08 02:43:13 +0000409 }
410 }
411}
412
Greg Clayton527154d2011-11-15 03:53:30 +0000413
414bool
Greg Clayton97471182012-04-14 01:42:46 +0000415ProcessLaunchInfo::ConvertArgumentsForLaunchingInShell (Error &error,
416 bool localhost,
417 bool will_debug,
418 bool first_arg_is_full_shell_command)
Greg Clayton527154d2011-11-15 03:53:30 +0000419{
420 error.Clear();
421
422 if (GetFlags().Test (eLaunchFlagLaunchInShell))
423 {
424 const char *shell_executable = GetShell();
425 if (shell_executable)
426 {
427 char shell_resolved_path[PATH_MAX];
428
429 if (localhost)
430 {
431 FileSpec shell_filespec (shell_executable, true);
432
433 if (!shell_filespec.Exists())
434 {
435 // Resolve the path in case we just got "bash", "sh" or "tcsh"
436 if (!shell_filespec.ResolveExecutableLocation ())
437 {
438 error.SetErrorStringWithFormat("invalid shell path '%s'", shell_executable);
439 return false;
440 }
441 }
442 shell_filespec.GetPath (shell_resolved_path, sizeof(shell_resolved_path));
443 shell_executable = shell_resolved_path;
444 }
445
446 Args shell_arguments;
447 std::string safe_arg;
448 shell_arguments.AppendArgument (shell_executable);
Greg Clayton527154d2011-11-15 03:53:30 +0000449 shell_arguments.AppendArgument ("-c");
Greg Clayton97471182012-04-14 01:42:46 +0000450
451 StreamString shell_command;
452 if (will_debug)
Greg Clayton527154d2011-11-15 03:53:30 +0000453 {
Greg Clayton97471182012-04-14 01:42:46 +0000454 shell_command.PutCString ("exec");
455 if (GetArchitecture().IsValid())
456 {
457 shell_command.Printf(" /usr/bin/arch -arch %s", GetArchitecture().GetArchitectureName());
458 // Set the resume count to 2:
459 // 1 - stop in shell
460 // 2 - stop in /usr/bin/arch
461 // 3 - then we will stop in our program
462 SetResumeCount(2);
463 }
464 else
465 {
466 // Set the resume count to 1:
467 // 1 - stop in shell
468 // 2 - then we will stop in our program
469 SetResumeCount(1);
470 }
Greg Clayton527154d2011-11-15 03:53:30 +0000471 }
472
473 const char **argv = GetArguments().GetConstArgumentVector ();
474 if (argv)
475 {
Greg Clayton97471182012-04-14 01:42:46 +0000476 if (first_arg_is_full_shell_command)
Greg Clayton527154d2011-11-15 03:53:30 +0000477 {
Greg Clayton97471182012-04-14 01:42:46 +0000478 // There should only be one argument that is the shell command itself to be used as is
479 if (argv[0] && !argv[1])
480 shell_command.Printf("%s", argv[0]);
481 else
482 return false;
Greg Clayton527154d2011-11-15 03:53:30 +0000483 }
Greg Clayton97471182012-04-14 01:42:46 +0000484 else
485 {
486 for (size_t i=0; argv[i] != NULL; ++i)
487 {
488 const char *arg = Args::GetShellSafeArgument (argv[i], safe_arg);
489 shell_command.Printf(" %s", arg);
490 }
491 }
492 shell_arguments.AppendArgument (shell_command.GetString().c_str());
Greg Clayton527154d2011-11-15 03:53:30 +0000493 }
Greg Clayton97471182012-04-14 01:42:46 +0000494 else
495 {
496 return false;
497 }
498
Greg Clayton527154d2011-11-15 03:53:30 +0000499 m_executable.SetFile(shell_executable, false);
500 m_arguments = shell_arguments;
501 return true;
502 }
503 else
504 {
505 error.SetErrorString ("invalid shell path");
506 }
507 }
508 else
509 {
510 error.SetErrorString ("not launching in shell");
511 }
512 return false;
513}
514
515
Greg Clayton24bc5d92011-03-30 18:16:51 +0000516bool
Greg Claytonb72d0f02011-04-12 05:54:46 +0000517ProcessLaunchInfo::FileAction::Open (int fd, const char *path, bool read, bool write)
518{
519 if ((read || write) && fd >= 0 && path && path[0])
520 {
521 m_action = eFileActionOpen;
522 m_fd = fd;
523 if (read && write)
Greg Clayton527154d2011-11-15 03:53:30 +0000524 m_arg = O_NOCTTY | O_CREAT | O_RDWR;
Greg Claytonb72d0f02011-04-12 05:54:46 +0000525 else if (read)
Greg Clayton527154d2011-11-15 03:53:30 +0000526 m_arg = O_NOCTTY | O_RDONLY;
Greg Claytonb72d0f02011-04-12 05:54:46 +0000527 else
Greg Clayton527154d2011-11-15 03:53:30 +0000528 m_arg = O_NOCTTY | O_CREAT | O_WRONLY;
Greg Claytonb72d0f02011-04-12 05:54:46 +0000529 m_path.assign (path);
530 return true;
531 }
532 else
533 {
534 Clear();
535 }
536 return false;
537}
538
539bool
540ProcessLaunchInfo::FileAction::Close (int fd)
541{
542 Clear();
543 if (fd >= 0)
544 {
545 m_action = eFileActionClose;
546 m_fd = fd;
547 }
548 return m_fd >= 0;
549}
550
551
552bool
553ProcessLaunchInfo::FileAction::Duplicate (int fd, int dup_fd)
554{
555 Clear();
556 if (fd >= 0 && dup_fd >= 0)
557 {
558 m_action = eFileActionDuplicate;
559 m_fd = fd;
560 m_arg = dup_fd;
561 }
562 return m_fd >= 0;
563}
564
565
566
567bool
568ProcessLaunchInfo::FileAction::AddPosixSpawnFileAction (posix_spawn_file_actions_t *file_actions,
569 const FileAction *info,
570 Log *log,
571 Error& error)
572{
573 if (info == NULL)
574 return false;
575
576 switch (info->m_action)
577 {
578 case eFileActionNone:
579 error.Clear();
580 break;
581
582 case eFileActionClose:
583 if (info->m_fd == -1)
584 error.SetErrorString ("invalid fd for posix_spawn_file_actions_addclose(...)");
585 else
586 {
587 error.SetError (::posix_spawn_file_actions_addclose (file_actions, info->m_fd),
588 eErrorTypePOSIX);
589 if (log && (error.Fail() || log))
590 error.PutToLog(log, "posix_spawn_file_actions_addclose (action=%p, fd=%i)",
591 file_actions, info->m_fd);
592 }
593 break;
594
595 case eFileActionDuplicate:
596 if (info->m_fd == -1)
597 error.SetErrorString ("invalid fd for posix_spawn_file_actions_adddup2(...)");
598 else if (info->m_arg == -1)
599 error.SetErrorString ("invalid duplicate fd for posix_spawn_file_actions_adddup2(...)");
600 else
601 {
602 error.SetError (::posix_spawn_file_actions_adddup2 (file_actions, info->m_fd, info->m_arg),
603 eErrorTypePOSIX);
604 if (log && (error.Fail() || log))
605 error.PutToLog(log, "posix_spawn_file_actions_adddup2 (action=%p, fd=%i, dup_fd=%i)",
606 file_actions, info->m_fd, info->m_arg);
607 }
608 break;
609
610 case eFileActionOpen:
611 if (info->m_fd == -1)
612 error.SetErrorString ("invalid fd in posix_spawn_file_actions_addopen(...)");
613 else
614 {
615 int oflag = info->m_arg;
Greg Clayton527154d2011-11-15 03:53:30 +0000616
Greg Claytonb72d0f02011-04-12 05:54:46 +0000617 mode_t mode = 0;
618
Greg Clayton527154d2011-11-15 03:53:30 +0000619 if (oflag & O_CREAT)
620 mode = 0640;
621
Greg Claytonb72d0f02011-04-12 05:54:46 +0000622 error.SetError (::posix_spawn_file_actions_addopen (file_actions,
623 info->m_fd,
624 info->m_path.c_str(),
625 oflag,
626 mode),
627 eErrorTypePOSIX);
628 if (error.Fail() || log)
629 error.PutToLog(log,
630 "posix_spawn_file_actions_addopen (action=%p, fd=%i, path='%s', oflag=%i, mode=%i)",
631 file_actions, info->m_fd, info->m_path.c_str(), oflag, mode);
632 }
633 break;
634
635 default:
636 error.SetErrorStringWithFormat ("invalid file action: %i", info->m_action);
637 break;
638 }
639 return error.Success();
640}
641
642Error
Greg Clayton143fcc32011-04-13 00:18:08 +0000643ProcessLaunchCommandOptions::SetOptionValue (uint32_t option_idx, const char *option_arg)
Greg Claytonb72d0f02011-04-12 05:54:46 +0000644{
645 Error error;
646 char short_option = (char) m_getopt_table[option_idx].val;
647
648 switch (short_option)
649 {
650 case 's': // Stop at program entry point
651 launch_info.GetFlags().Set (eLaunchFlagStopAtEntry);
652 break;
653
Greg Claytonb72d0f02011-04-12 05:54:46 +0000654 case 'i': // STDIN for read only
655 {
656 ProcessLaunchInfo::FileAction action;
Greg Clayton95ec1682012-03-06 04:01:04 +0000657 if (action.Open (STDIN_FILENO, option_arg, true, false))
Greg Claytonb72d0f02011-04-12 05:54:46 +0000658 launch_info.AppendFileAction (action);
659 }
660 break;
661
662 case 'o': // Open STDOUT for write only
663 {
664 ProcessLaunchInfo::FileAction action;
Greg Clayton95ec1682012-03-06 04:01:04 +0000665 if (action.Open (STDOUT_FILENO, option_arg, false, true))
666 launch_info.AppendFileAction (action);
667 }
668 break;
669
670 case 'e': // STDERR for write only
671 {
672 ProcessLaunchInfo::FileAction action;
673 if (action.Open (STDERR_FILENO, option_arg, false, true))
Greg Claytonb72d0f02011-04-12 05:54:46 +0000674 launch_info.AppendFileAction (action);
675 }
676 break;
677
Greg Clayton95ec1682012-03-06 04:01:04 +0000678
Greg Claytonb72d0f02011-04-12 05:54:46 +0000679 case 'p': // Process plug-in name
680 launch_info.SetProcessPluginName (option_arg);
681 break;
682
683 case 'n': // Disable STDIO
684 {
685 ProcessLaunchInfo::FileAction action;
Greg Clayton95ec1682012-03-06 04:01:04 +0000686 if (action.Open (STDIN_FILENO, "/dev/null", true, false))
Greg Claytonb72d0f02011-04-12 05:54:46 +0000687 launch_info.AppendFileAction (action);
Greg Clayton95ec1682012-03-06 04:01:04 +0000688 if (action.Open (STDOUT_FILENO, "/dev/null", false, true))
Greg Claytonb72d0f02011-04-12 05:54:46 +0000689 launch_info.AppendFileAction (action);
Greg Clayton95ec1682012-03-06 04:01:04 +0000690 if (action.Open (STDERR_FILENO, "/dev/null", false, true))
Greg Claytonb72d0f02011-04-12 05:54:46 +0000691 launch_info.AppendFileAction (action);
692 }
693 break;
694
695 case 'w':
696 launch_info.SetWorkingDirectory (option_arg);
697 break;
698
699 case 't': // Open process in new terminal window
700 launch_info.GetFlags().Set (eLaunchFlagLaunchInTTY);
701 break;
702
703 case 'a':
Greg Claytonb170aee2012-05-08 01:45:38 +0000704 if (!launch_info.GetArchitecture().SetTriple (option_arg, m_interpreter.GetPlatform(true).get()))
705 launch_info.GetArchitecture().SetTriple (option_arg);
Greg Claytonb72d0f02011-04-12 05:54:46 +0000706 break;
707
708 case 'A':
709 launch_info.GetFlags().Set (eLaunchFlagDisableASLR);
710 break;
711
Greg Clayton36bc5ea2011-11-03 21:22:33 +0000712 case 'c':
Greg Clayton527154d2011-11-15 03:53:30 +0000713 if (option_arg && option_arg[0])
714 launch_info.SetShell (option_arg);
715 else
716 launch_info.SetShell ("/bin/bash");
Greg Clayton36bc5ea2011-11-03 21:22:33 +0000717 break;
718
Greg Claytonb72d0f02011-04-12 05:54:46 +0000719 case 'v':
720 launch_info.GetEnvironmentEntries().AppendArgument(option_arg);
721 break;
722
723 default:
Greg Clayton9c236732011-10-26 00:56:27 +0000724 error.SetErrorStringWithFormat("unrecognized short option character '%c'", short_option);
Greg Claytonb72d0f02011-04-12 05:54:46 +0000725 break;
726
727 }
728 return error;
729}
730
731OptionDefinition
732ProcessLaunchCommandOptions::g_option_table[] =
733{
734{ 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."},
735{ LLDB_OPT_SET_ALL, false, "disable-aslr", 'A', no_argument, NULL, 0, eArgTypeNone, "Disable address space layout randomization when launching a process."},
736{ LLDB_OPT_SET_ALL, false, "plugin", 'p', required_argument, NULL, 0, eArgTypePlugin, "Name of the process plugin you want to use."},
737{ LLDB_OPT_SET_ALL, false, "working-dir", 'w', required_argument, NULL, 0, eArgTypePath, "Set the current working directory to <path> when running the inferior."},
738{ LLDB_OPT_SET_ALL, false, "arch", 'a', required_argument, NULL, 0, eArgTypeArchitecture, "Set the architecture for the process to launch when ambiguous."},
739{ 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."},
Greg Clayton527154d2011-11-15 03:53:30 +0000740{ LLDB_OPT_SET_ALL, false, "shell", 'c', optional_argument, NULL, 0, eArgTypePath, "Run the process in a shell (not supported on all platforms)."},
Greg Claytonb72d0f02011-04-12 05:54:46 +0000741
742{ LLDB_OPT_SET_1 , false, "stdin", 'i', required_argument, NULL, 0, eArgTypePath, "Redirect stdin for the process to <path>."},
743{ LLDB_OPT_SET_1 , false, "stdout", 'o', required_argument, NULL, 0, eArgTypePath, "Redirect stdout for the process to <path>."},
744{ LLDB_OPT_SET_1 , false, "stderr", 'e', required_argument, NULL, 0, eArgTypePath, "Redirect stderr for the process to <path>."},
745
746{ LLDB_OPT_SET_2 , false, "tty", 't', no_argument, NULL, 0, eArgTypeNone, "Start the process in a terminal (not supported on all platforms)."},
747
748{ 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."},
749
750{ 0 , false, NULL, 0, 0, NULL, 0, eArgTypeNone, NULL }
751};
752
753
754
755bool
756ProcessInstanceInfoMatch::NameMatches (const char *process_name) const
Greg Clayton24bc5d92011-03-30 18:16:51 +0000757{
758 if (m_name_match_type == eNameMatchIgnore || process_name == NULL)
759 return true;
760 const char *match_name = m_match_info.GetName();
761 if (!match_name)
762 return true;
763
764 return lldb_private::NameMatches (process_name, m_name_match_type, match_name);
765}
766
767bool
Greg Claytonb72d0f02011-04-12 05:54:46 +0000768ProcessInstanceInfoMatch::Matches (const ProcessInstanceInfo &proc_info) const
Greg Clayton24bc5d92011-03-30 18:16:51 +0000769{
770 if (!NameMatches (proc_info.GetName()))
771 return false;
772
773 if (m_match_info.ProcessIDIsValid() &&
774 m_match_info.GetProcessID() != proc_info.GetProcessID())
775 return false;
776
777 if (m_match_info.ParentProcessIDIsValid() &&
778 m_match_info.GetParentProcessID() != proc_info.GetParentProcessID())
779 return false;
780
Greg Claytonb72d0f02011-04-12 05:54:46 +0000781 if (m_match_info.UserIDIsValid () &&
782 m_match_info.GetUserID() != proc_info.GetUserID())
Greg Clayton24bc5d92011-03-30 18:16:51 +0000783 return false;
784
Greg Claytonb72d0f02011-04-12 05:54:46 +0000785 if (m_match_info.GroupIDIsValid () &&
786 m_match_info.GetGroupID() != proc_info.GetGroupID())
Greg Clayton24bc5d92011-03-30 18:16:51 +0000787 return false;
788
789 if (m_match_info.EffectiveUserIDIsValid () &&
790 m_match_info.GetEffectiveUserID() != proc_info.GetEffectiveUserID())
791 return false;
792
793 if (m_match_info.EffectiveGroupIDIsValid () &&
794 m_match_info.GetEffectiveGroupID() != proc_info.GetEffectiveGroupID())
795 return false;
796
797 if (m_match_info.GetArchitecture().IsValid() &&
798 m_match_info.GetArchitecture() != proc_info.GetArchitecture())
799 return false;
800 return true;
801}
802
803bool
Greg Claytonb72d0f02011-04-12 05:54:46 +0000804ProcessInstanceInfoMatch::MatchAllProcesses () const
Greg Clayton24bc5d92011-03-30 18:16:51 +0000805{
806 if (m_name_match_type != eNameMatchIgnore)
807 return false;
808
809 if (m_match_info.ProcessIDIsValid())
810 return false;
811
812 if (m_match_info.ParentProcessIDIsValid())
813 return false;
814
Greg Claytonb72d0f02011-04-12 05:54:46 +0000815 if (m_match_info.UserIDIsValid ())
Greg Clayton24bc5d92011-03-30 18:16:51 +0000816 return false;
817
Greg Claytonb72d0f02011-04-12 05:54:46 +0000818 if (m_match_info.GroupIDIsValid ())
Greg Clayton24bc5d92011-03-30 18:16:51 +0000819 return false;
820
821 if (m_match_info.EffectiveUserIDIsValid ())
822 return false;
823
824 if (m_match_info.EffectiveGroupIDIsValid ())
825 return false;
826
827 if (m_match_info.GetArchitecture().IsValid())
828 return false;
829
830 if (m_match_all_users)
831 return false;
832
833 return true;
834
835}
836
837void
Greg Claytonb72d0f02011-04-12 05:54:46 +0000838ProcessInstanceInfoMatch::Clear()
Greg Clayton24bc5d92011-03-30 18:16:51 +0000839{
840 m_match_info.Clear();
841 m_name_match_type = eNameMatchIgnore;
842 m_match_all_users = false;
843}
Greg Claytonfd119992011-01-07 06:08:19 +0000844
Greg Clayton46c9a352012-02-09 06:16:32 +0000845ProcessSP
846Process::FindPlugin (Target &target, const char *plugin_name, Listener &listener, const FileSpec *crash_file_path)
Chris Lattner24943d22010-06-08 16:52:24 +0000847{
Greg Clayton46c9a352012-02-09 06:16:32 +0000848 ProcessSP process_sp;
Chris Lattner24943d22010-06-08 16:52:24 +0000849 ProcessCreateInstance create_callback = NULL;
850 if (plugin_name)
851 {
852 create_callback = PluginManager::GetProcessCreateCallbackForPluginName (plugin_name);
853 if (create_callback)
854 {
Greg Clayton46c9a352012-02-09 06:16:32 +0000855 process_sp = create_callback(target, listener, crash_file_path);
856 if (process_sp)
857 {
858 if (!process_sp->CanDebug(target, true))
859 process_sp.reset();
860 }
Chris Lattner24943d22010-06-08 16:52:24 +0000861 }
862 }
863 else
864 {
Greg Clayton54e7afa2010-07-09 20:39:50 +0000865 for (uint32_t idx = 0; (create_callback = PluginManager::GetProcessCreateCallbackAtIndex(idx)) != NULL; ++idx)
Chris Lattner24943d22010-06-08 16:52:24 +0000866 {
Greg Clayton46c9a352012-02-09 06:16:32 +0000867 process_sp = create_callback(target, listener, crash_file_path);
868 if (process_sp)
869 {
870 if (!process_sp->CanDebug(target, false))
871 process_sp.reset();
872 else
873 break;
874 }
Chris Lattner24943d22010-06-08 16:52:24 +0000875 }
876 }
Greg Clayton46c9a352012-02-09 06:16:32 +0000877 return process_sp;
Chris Lattner24943d22010-06-08 16:52:24 +0000878}
879
Jim Ingham5a15e692012-02-16 06:50:00 +0000880ConstString &
881Process::GetStaticBroadcasterClass ()
882{
883 static ConstString class_name ("lldb.process");
884 return class_name;
885}
Chris Lattner24943d22010-06-08 16:52:24 +0000886
887//----------------------------------------------------------------------
888// Process constructor
889//----------------------------------------------------------------------
890Process::Process(Target &target, Listener &listener) :
Greg Clayton73844aa2012-08-22 17:17:09 +0000891 ProcessProperties (false),
Chris Lattner24943d22010-06-08 16:52:24 +0000892 UserID (LLDB_INVALID_PROCESS_ID),
Jim Ingham5a15e692012-02-16 06:50:00 +0000893 Broadcaster (&(target.GetDebugger()), "lldb.process"),
Chris Lattner24943d22010-06-08 16:52:24 +0000894 m_target (target),
Chris Lattner24943d22010-06-08 16:52:24 +0000895 m_public_state (eStateUnloaded),
896 m_private_state (eStateUnloaded),
Jim Ingham5a15e692012-02-16 06:50:00 +0000897 m_private_state_broadcaster (NULL, "lldb.process.internal_state_broadcaster"),
898 m_private_state_control_broadcaster (NULL, "lldb.process.internal_state_control_broadcaster"),
Chris Lattner24943d22010-06-08 16:52:24 +0000899 m_private_state_listener ("lldb.process.internal_state_listener"),
900 m_private_state_control_wait(),
901 m_private_state_thread (LLDB_INVALID_HOST_THREAD),
Jim Ingham21f37ad2011-08-09 02:12:22 +0000902 m_mod_id (),
Chris Lattner24943d22010-06-08 16:52:24 +0000903 m_thread_index_id (0),
904 m_exit_status (-1),
905 m_exit_string (),
906 m_thread_list (this),
907 m_notifications (),
Greg Clayton20d338f2010-11-18 05:57:03 +0000908 m_image_tokens (),
909 m_listener (listener),
910 m_breakpoint_site_list (),
Greg Clayton20d338f2010-11-18 05:57:03 +0000911 m_dynamic_checkers_ap (),
Caroline Tice861efb32010-11-16 05:07:41 +0000912 m_unix_signals (),
Greg Clayton20d338f2010-11-18 05:57:03 +0000913 m_abi_sp (),
Caroline Tice861efb32010-11-16 05:07:41 +0000914 m_process_input_reader (),
Greg Claytona875b642011-01-09 21:07:35 +0000915 m_stdio_communication ("process.stdio"),
Greg Clayton20d338f2010-11-18 05:57:03 +0000916 m_stdio_communication_mutex (Mutex::eMutexTypeRecursive),
Greg Claytonfd119992011-01-07 06:08:19 +0000917 m_stdout_data (),
Greg Claytonbd06ff42011-11-13 04:45:22 +0000918 m_stderr_data (),
Greg Clayton613b8732011-05-17 03:37:42 +0000919 m_memory_cache (*this),
920 m_allocated_memory_cache (*this),
Greg Claytonffa43a62011-11-17 04:46:02 +0000921 m_should_detach (false),
Sean Callanan6cf6c472011-09-20 23:01:51 +0000922 m_next_event_action_ap(),
Bill Wendlingce96dad2012-04-06 00:10:21 +0000923 m_run_lock (),
Jim Ingham43892562012-06-06 00:29:30 +0000924 m_currently_handling_event(false),
Jim Inghamd0bdddf2012-08-22 21:34:33 +0000925 m_finalize_called(false),
Bill Wendlingce96dad2012-04-06 00:10:21 +0000926 m_can_jit(eCanJITDontKnow)
Chris Lattner24943d22010-06-08 16:52:24 +0000927{
Jim Ingham5a15e692012-02-16 06:50:00 +0000928 CheckInWithManager ();
Caroline Tice1ebef442010-09-27 00:30:10 +0000929
Greg Claytone005f2c2010-11-06 01:53:30 +0000930 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_OBJECT));
Chris Lattner24943d22010-06-08 16:52:24 +0000931 if (log)
932 log->Printf ("%p Process::Process()", this);
933
Greg Clayton49ce6822010-10-31 03:01:06 +0000934 SetEventName (eBroadcastBitStateChanged, "state-changed");
935 SetEventName (eBroadcastBitInterrupt, "interrupt");
936 SetEventName (eBroadcastBitSTDOUT, "stdout-available");
937 SetEventName (eBroadcastBitSTDERR, "stderr-available");
938
Chris Lattner24943d22010-06-08 16:52:24 +0000939 listener.StartListeningForEvents (this,
940 eBroadcastBitStateChanged |
941 eBroadcastBitInterrupt |
942 eBroadcastBitSTDOUT |
943 eBroadcastBitSTDERR);
944
945 m_private_state_listener.StartListeningForEvents(&m_private_state_broadcaster,
Jim Ingham5d90ade2012-07-27 23:57:19 +0000946 eBroadcastBitStateChanged |
947 eBroadcastBitInterrupt);
Chris Lattner24943d22010-06-08 16:52:24 +0000948
949 m_private_state_listener.StartListeningForEvents(&m_private_state_control_broadcaster,
950 eBroadcastInternalStateControlStop |
951 eBroadcastInternalStateControlPause |
952 eBroadcastInternalStateControlResume);
953}
954
955//----------------------------------------------------------------------
956// Destructor
957//----------------------------------------------------------------------
958Process::~Process()
959{
Greg Claytone005f2c2010-11-06 01:53:30 +0000960 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_OBJECT));
Chris Lattner24943d22010-06-08 16:52:24 +0000961 if (log)
962 log->Printf ("%p Process::~Process()", this);
963 StopPrivateStateThread();
964}
965
Greg Clayton73844aa2012-08-22 17:17:09 +0000966const ProcessPropertiesSP &
967Process::GetGlobalProperties()
968{
969 static ProcessPropertiesSP g_settings_sp;
970 if (!g_settings_sp)
971 g_settings_sp.reset (new ProcessProperties (true));
972 return g_settings_sp;
973}
974
Chris Lattner24943d22010-06-08 16:52:24 +0000975void
976Process::Finalize()
977{
Greg Claytonffa43a62011-11-17 04:46:02 +0000978 switch (GetPrivateState())
979 {
980 case eStateConnected:
981 case eStateAttaching:
982 case eStateLaunching:
983 case eStateStopped:
984 case eStateRunning:
985 case eStateStepping:
986 case eStateCrashed:
987 case eStateSuspended:
988 if (GetShouldDetach())
989 Detach();
990 else
991 Destroy();
992 break;
993
994 case eStateInvalid:
995 case eStateUnloaded:
996 case eStateDetached:
997 case eStateExited:
998 break;
999 }
1000
Greg Clayton2f57db02011-10-01 00:45:15 +00001001 // Clear our broadcaster before we proceed with destroying
1002 Broadcaster::Clear();
1003
Chris Lattner24943d22010-06-08 16:52:24 +00001004 // Do any cleanup needed prior to being destructed... Subclasses
1005 // that override this method should call this superclass method as well.
Jim Ingham88fa7bd2011-02-16 17:54:55 +00001006
1007 // We need to destroy the loader before the derived Process class gets destroyed
1008 // since it is very likely that undoing the loader will require access to the real process.
Greg Clayton182be6a2012-01-20 23:08:34 +00001009 m_dynamic_checkers_ap.reset();
1010 m_abi_sp.reset();
Greg Clayton37f962e2011-08-22 02:49:39 +00001011 m_os_ap.reset();
Greg Clayton182be6a2012-01-20 23:08:34 +00001012 m_dyld_ap.reset();
Greg Clayton13d24fb2012-01-29 20:56:30 +00001013 m_thread_list.Destroy();
Greg Clayton182be6a2012-01-20 23:08:34 +00001014 std::vector<Notifications> empty_notifications;
1015 m_notifications.swap(empty_notifications);
1016 m_image_tokens.clear();
1017 m_memory_cache.Clear();
1018 m_allocated_memory_cache.Clear();
1019 m_language_runtimes.clear();
1020 m_next_event_action_ap.reset();
Jim Inghamd0bdddf2012-08-22 21:34:33 +00001021 m_finalize_called = true;
Chris Lattner24943d22010-06-08 16:52:24 +00001022}
1023
1024void
1025Process::RegisterNotificationCallbacks (const Notifications& callbacks)
1026{
1027 m_notifications.push_back(callbacks);
1028 if (callbacks.initialize != NULL)
1029 callbacks.initialize (callbacks.baton, this);
1030}
1031
1032bool
1033Process::UnregisterNotificationCallbacks(const Notifications& callbacks)
1034{
1035 std::vector<Notifications>::iterator pos, end = m_notifications.end();
1036 for (pos = m_notifications.begin(); pos != end; ++pos)
1037 {
1038 if (pos->baton == callbacks.baton &&
1039 pos->initialize == callbacks.initialize &&
1040 pos->process_state_changed == callbacks.process_state_changed)
1041 {
1042 m_notifications.erase(pos);
1043 return true;
1044 }
1045 }
1046 return false;
1047}
1048
1049void
1050Process::SynchronouslyNotifyStateChanged (StateType state)
1051{
1052 std::vector<Notifications>::iterator notification_pos, notification_end = m_notifications.end();
1053 for (notification_pos = m_notifications.begin(); notification_pos != notification_end; ++notification_pos)
1054 {
1055 if (notification_pos->process_state_changed)
1056 notification_pos->process_state_changed (notification_pos->baton, this, state);
1057 }
1058}
1059
1060// FIXME: We need to do some work on events before the general Listener sees them.
1061// For instance if we are continuing from a breakpoint, we need to ensure that we do
1062// the little "insert real insn, step & stop" trick. But we can't do that when the
1063// event is delivered by the broadcaster - since that is done on the thread that is
1064// waiting for new events, so if we needed more than one event for our handling, we would
1065// stall. So instead we do it when we fetch the event off of the queue.
1066//
1067
1068StateType
1069Process::GetNextEvent (EventSP &event_sp)
1070{
1071 StateType state = eStateInvalid;
1072
1073 if (m_listener.GetNextEventForBroadcaster (this, event_sp) && event_sp)
1074 state = Process::ProcessEventData::GetStateFromEvent (event_sp.get());
1075
1076 return state;
1077}
1078
1079
1080StateType
1081Process::WaitForProcessToStop (const TimeValue *timeout)
1082{
Jim Ingham21f37ad2011-08-09 02:12:22 +00001083 // We can't just wait for a "stopped" event, because the stopped event may have restarted the target.
1084 // We have to actually check each event, and in the case of a stopped event check the restarted flag
1085 // on the event.
1086 EventSP event_sp;
1087 StateType state = GetState();
1088 // If we are exited or detached, we won't ever get back to any
1089 // other valid state...
1090 if (state == eStateDetached || state == eStateExited)
1091 return state;
1092
1093 while (state != eStateInvalid)
1094 {
1095 state = WaitForStateChangedEvents (timeout, event_sp);
1096 switch (state)
1097 {
1098 case eStateCrashed:
1099 case eStateDetached:
1100 case eStateExited:
1101 case eStateUnloaded:
1102 return state;
1103 case eStateStopped:
1104 if (Process::ProcessEventData::GetRestartedFromEvent(event_sp.get()))
1105 continue;
1106 else
1107 return state;
1108 default:
1109 continue;
1110 }
1111 }
1112 return state;
Chris Lattner24943d22010-06-08 16:52:24 +00001113}
1114
1115
1116StateType
1117Process::WaitForState
1118(
1119 const TimeValue *timeout,
1120 const StateType *match_states, const uint32_t num_match_states
1121)
1122{
1123 EventSP event_sp;
1124 uint32_t i;
Greg Claytond8c62532010-10-07 04:19:01 +00001125 StateType state = GetState();
Chris Lattner24943d22010-06-08 16:52:24 +00001126 while (state != eStateInvalid)
1127 {
Greg Claytond8c62532010-10-07 04:19:01 +00001128 // If we are exited or detached, we won't ever get back to any
1129 // other valid state...
1130 if (state == eStateDetached || state == eStateExited)
1131 return state;
1132
Chris Lattner24943d22010-06-08 16:52:24 +00001133 state = WaitForStateChangedEvents (timeout, event_sp);
1134
1135 for (i=0; i<num_match_states; ++i)
1136 {
1137 if (match_states[i] == state)
1138 return state;
1139 }
1140 }
1141 return state;
1142}
1143
Jim Ingham63e24d72010-10-11 23:53:14 +00001144bool
1145Process::HijackProcessEvents (Listener *listener)
1146{
1147 if (listener != NULL)
1148 {
Jim Ingham5d90ade2012-07-27 23:57:19 +00001149 return HijackBroadcaster(listener, eBroadcastBitStateChanged | eBroadcastBitInterrupt);
Jim Ingham63e24d72010-10-11 23:53:14 +00001150 }
1151 else
1152 return false;
1153}
1154
1155void
1156Process::RestoreProcessEvents ()
1157{
1158 RestoreBroadcaster();
1159}
1160
Jim Inghamf9f40c22011-02-08 05:20:59 +00001161bool
1162Process::HijackPrivateProcessEvents (Listener *listener)
1163{
1164 if (listener != NULL)
1165 {
Jim Ingham5d90ade2012-07-27 23:57:19 +00001166 return m_private_state_broadcaster.HijackBroadcaster(listener, eBroadcastBitStateChanged | eBroadcastBitInterrupt);
Jim Inghamf9f40c22011-02-08 05:20:59 +00001167 }
1168 else
1169 return false;
1170}
1171
1172void
1173Process::RestorePrivateProcessEvents ()
1174{
1175 m_private_state_broadcaster.RestoreBroadcaster();
1176}
1177
Chris Lattner24943d22010-06-08 16:52:24 +00001178StateType
1179Process::WaitForStateChangedEvents (const TimeValue *timeout, EventSP &event_sp)
1180{
Greg Claytone005f2c2010-11-06 01:53:30 +00001181 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner24943d22010-06-08 16:52:24 +00001182
1183 if (log)
1184 log->Printf ("Process::%s (timeout = %p, event_sp)...", __FUNCTION__, timeout);
1185
1186 StateType state = eStateInvalid;
Greg Clayton36f63a92010-10-19 03:25:40 +00001187 if (m_listener.WaitForEventForBroadcasterWithType (timeout,
1188 this,
Jim Ingham5d90ade2012-07-27 23:57:19 +00001189 eBroadcastBitStateChanged | eBroadcastBitInterrupt,
Greg Clayton36f63a92010-10-19 03:25:40 +00001190 event_sp))
Jim Ingham5d90ade2012-07-27 23:57:19 +00001191 {
1192 if (event_sp && event_sp->GetType() == eBroadcastBitStateChanged)
1193 state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
1194 else if (log)
1195 log->Printf ("Process::%s got no event or was interrupted.", __FUNCTION__);
1196 }
Chris Lattner24943d22010-06-08 16:52:24 +00001197
1198 if (log)
1199 log->Printf ("Process::%s (timeout = %p, event_sp) => %s",
1200 __FUNCTION__,
1201 timeout,
1202 StateAsCString(state));
1203 return state;
1204}
1205
1206Event *
1207Process::PeekAtStateChangedEvents ()
1208{
Greg Claytone005f2c2010-11-06 01:53:30 +00001209 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner24943d22010-06-08 16:52:24 +00001210
1211 if (log)
1212 log->Printf ("Process::%s...", __FUNCTION__);
1213
1214 Event *event_ptr;
Greg Clayton36f63a92010-10-19 03:25:40 +00001215 event_ptr = m_listener.PeekAtNextEventForBroadcasterWithType (this,
1216 eBroadcastBitStateChanged);
Chris Lattner24943d22010-06-08 16:52:24 +00001217 if (log)
1218 {
1219 if (event_ptr)
1220 {
1221 log->Printf ("Process::%s (event_ptr) => %s",
1222 __FUNCTION__,
1223 StateAsCString(ProcessEventData::GetStateFromEvent (event_ptr)));
1224 }
1225 else
1226 {
1227 log->Printf ("Process::%s no events found",
1228 __FUNCTION__);
1229 }
1230 }
1231 return event_ptr;
1232}
1233
1234StateType
1235Process::WaitForStateChangedEventsPrivate (const TimeValue *timeout, EventSP &event_sp)
1236{
Greg Claytone005f2c2010-11-06 01:53:30 +00001237 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner24943d22010-06-08 16:52:24 +00001238
1239 if (log)
1240 log->Printf ("Process::%s (timeout = %p, event_sp)...", __FUNCTION__, timeout);
1241
1242 StateType state = eStateInvalid;
Greg Clayton72e1c782011-01-22 23:43:18 +00001243 if (m_private_state_listener.WaitForEventForBroadcasterWithType (timeout,
1244 &m_private_state_broadcaster,
Jim Ingham5d90ade2012-07-27 23:57:19 +00001245 eBroadcastBitStateChanged | eBroadcastBitInterrupt,
Greg Clayton72e1c782011-01-22 23:43:18 +00001246 event_sp))
Jim Ingham5d90ade2012-07-27 23:57:19 +00001247 if (event_sp && event_sp->GetType() == eBroadcastBitStateChanged)
1248 state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
Chris Lattner24943d22010-06-08 16:52:24 +00001249
1250 // This is a bit of a hack, but when we wait here we could very well return
1251 // to the command-line, and that could disable the log, which would render the
1252 // log we got above invalid.
Chris Lattner24943d22010-06-08 16:52:24 +00001253 if (log)
Greg Clayton72e1c782011-01-22 23:43:18 +00001254 {
1255 if (state == eStateInvalid)
1256 log->Printf ("Process::%s (timeout = %p, event_sp) => TIMEOUT", __FUNCTION__, timeout);
1257 else
1258 log->Printf ("Process::%s (timeout = %p, event_sp) => %s", __FUNCTION__, timeout, StateAsCString(state));
1259 }
Chris Lattner24943d22010-06-08 16:52:24 +00001260 return state;
1261}
1262
1263bool
1264Process::WaitForEventsPrivate (const TimeValue *timeout, EventSP &event_sp, bool control_only)
1265{
Greg Claytone005f2c2010-11-06 01:53:30 +00001266 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner24943d22010-06-08 16:52:24 +00001267
1268 if (log)
1269 log->Printf ("Process::%s (timeout = %p, event_sp)...", __FUNCTION__, timeout);
1270
1271 if (control_only)
1272 return m_private_state_listener.WaitForEventForBroadcaster(timeout, &m_private_state_control_broadcaster, event_sp);
1273 else
1274 return m_private_state_listener.WaitForEvent(timeout, event_sp);
1275}
1276
1277bool
1278Process::IsRunning () const
1279{
1280 return StateIsRunningState (m_public_state.GetValue());
1281}
1282
1283int
1284Process::GetExitStatus ()
1285{
1286 if (m_public_state.GetValue() == eStateExited)
1287 return m_exit_status;
1288 return -1;
1289}
1290
Greg Clayton638351a2010-12-04 00:10:17 +00001291
Chris Lattner24943d22010-06-08 16:52:24 +00001292const char *
1293Process::GetExitDescription ()
1294{
1295 if (m_public_state.GetValue() == eStateExited && !m_exit_string.empty())
1296 return m_exit_string.c_str();
1297 return NULL;
1298}
1299
Greg Clayton72e1c782011-01-22 23:43:18 +00001300bool
Chris Lattner24943d22010-06-08 16:52:24 +00001301Process::SetExitStatus (int status, const char *cstr)
1302{
Greg Clayton68ca8232011-01-25 02:58:48 +00001303 LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
1304 if (log)
1305 log->Printf("Process::SetExitStatus (status=%i (0x%8.8x), description=%s%s%s)",
1306 status, status,
1307 cstr ? "\"" : "",
1308 cstr ? cstr : "NULL",
1309 cstr ? "\"" : "");
1310
Greg Clayton72e1c782011-01-22 23:43:18 +00001311 // We were already in the exited state
1312 if (m_private_state.GetValue() == eStateExited)
Greg Clayton68ca8232011-01-25 02:58:48 +00001313 {
Greg Clayton644ddfb2011-01-26 23:47:29 +00001314 if (log)
1315 log->Printf("Process::SetExitStatus () ignoring exit status because state was already set to eStateExited");
Greg Clayton72e1c782011-01-22 23:43:18 +00001316 return false;
Greg Clayton68ca8232011-01-25 02:58:48 +00001317 }
Greg Clayton72e1c782011-01-22 23:43:18 +00001318
1319 m_exit_status = status;
1320 if (cstr)
1321 m_exit_string = cstr;
1322 else
1323 m_exit_string.clear();
Chris Lattner24943d22010-06-08 16:52:24 +00001324
Greg Clayton72e1c782011-01-22 23:43:18 +00001325 DidExit ();
Greg Clayton58e844b2010-12-08 05:08:21 +00001326
Greg Clayton72e1c782011-01-22 23:43:18 +00001327 SetPrivateState (eStateExited);
1328 return true;
Chris Lattner24943d22010-06-08 16:52:24 +00001329}
1330
1331// This static callback can be used to watch for local child processes on
1332// the current host. The the child process exits, the process will be
1333// found in the global target list (we want to be completely sure that the
1334// lldb_private::Process doesn't go away before we can deliver the signal.
1335bool
Greg Clayton1c4642c2011-11-16 05:37:56 +00001336Process::SetProcessExitStatus (void *callback_baton,
1337 lldb::pid_t pid,
1338 bool exited,
1339 int signo, // Zero for no signal
1340 int exit_status // Exit value of process if signal is zero
Chris Lattner24943d22010-06-08 16:52:24 +00001341)
1342{
Greg Clayton1c4642c2011-11-16 05:37:56 +00001343 LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_PROCESS));
1344 if (log)
Greg Claytond9919d32011-12-01 23:28:38 +00001345 log->Printf ("Process::SetProcessExitStatus (baton=%p, pid=%llu, exited=%i, signal=%i, exit_status=%i)\n",
Greg Clayton1c4642c2011-11-16 05:37:56 +00001346 callback_baton,
1347 pid,
1348 exited,
1349 signo,
1350 exit_status);
1351
1352 if (exited)
Chris Lattner24943d22010-06-08 16:52:24 +00001353 {
Greg Clayton63094e02010-06-23 01:19:29 +00001354 TargetSP target_sp(Debugger::FindTargetWithProcessID (pid));
Chris Lattner24943d22010-06-08 16:52:24 +00001355 if (target_sp)
1356 {
1357 ProcessSP process_sp (target_sp->GetProcessSP());
1358 if (process_sp)
1359 {
1360 const char *signal_cstr = NULL;
1361 if (signo)
1362 signal_cstr = process_sp->GetUnixSignals().GetSignalAsCString (signo);
1363
1364 process_sp->SetExitStatus (exit_status, signal_cstr);
1365 }
1366 }
1367 return true;
1368 }
1369 return false;
1370}
1371
1372
Greg Clayton37f962e2011-08-22 02:49:39 +00001373void
1374Process::UpdateThreadListIfNeeded ()
1375{
1376 const uint32_t stop_id = GetStopID();
1377 if (m_thread_list.GetSize(false) == 0 || stop_id != m_thread_list.GetStopID())
1378 {
Greg Clayton20206082011-11-17 01:23:07 +00001379 const StateType state = GetPrivateState();
1380 if (StateIsStoppedState (state, true))
1381 {
1382 Mutex::Locker locker (m_thread_list.GetMutex ());
Greg Claytonffa43a62011-11-17 04:46:02 +00001383 // m_thread_list does have its own mutex, but we need to
1384 // hold onto the mutex between the call to UpdateThreadList(...)
1385 // and the os->UpdateThreadList(...) so it doesn't change on us
Greg Clayton20206082011-11-17 01:23:07 +00001386 ThreadList new_thread_list(this);
1387 // Always update the thread list with the protocol specific
Greg Claytonae932352012-04-10 00:18:59 +00001388 // thread list, but only update if "true" is returned
1389 if (UpdateThreadList (m_thread_list, new_thread_list))
1390 {
1391 OperatingSystem *os = GetOperatingSystem ();
1392 if (os)
1393 os->UpdateThreadList (m_thread_list, new_thread_list);
1394 m_thread_list.Update (new_thread_list);
1395 m_thread_list.SetStopID (stop_id);
1396 }
Greg Clayton20206082011-11-17 01:23:07 +00001397 }
Greg Clayton37f962e2011-08-22 02:49:39 +00001398 }
1399}
1400
Chris Lattner24943d22010-06-08 16:52:24 +00001401uint32_t
1402Process::GetNextThreadIndexID ()
1403{
1404 return ++m_thread_index_id;
1405}
1406
1407StateType
1408Process::GetState()
1409{
1410 // If any other threads access this we will need a mutex for it
1411 return m_public_state.GetValue ();
1412}
1413
1414void
1415Process::SetPublicState (StateType new_state)
1416{
Greg Clayton68ca8232011-01-25 02:58:48 +00001417 LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
Chris Lattner24943d22010-06-08 16:52:24 +00001418 if (log)
1419 log->Printf("Process::SetPublicState (%s)", StateAsCString(new_state));
Greg Claytona894fe72012-04-05 16:12:35 +00001420 const StateType old_state = m_public_state.GetValue();
Chris Lattner24943d22010-06-08 16:52:24 +00001421 m_public_state.SetValue (new_state);
Jim Ingham027aaa72012-04-19 01:40:33 +00001422
1423 // On the transition from Run to Stopped, we unlock the writer end of the
1424 // run lock. The lock gets locked in Resume, which is the public API
1425 // to tell the program to run.
Greg Claytona894fe72012-04-05 16:12:35 +00001426 if (!IsHijackedForEvent(eBroadcastBitStateChanged))
1427 {
Sean Callanana3772862012-06-02 01:16:20 +00001428 if (new_state == eStateDetached)
Greg Claytona894fe72012-04-05 16:12:35 +00001429 {
Sean Callanana3772862012-06-02 01:16:20 +00001430 if (log)
1431 log->Printf("Process::SetPublicState (%s) -- unlocking run lock for detach", StateAsCString(new_state));
1432 m_run_lock.WriteUnlock();
1433 }
1434 else
1435 {
1436 const bool old_state_is_stopped = StateIsStoppedState(old_state, false);
1437 const bool new_state_is_stopped = StateIsStoppedState(new_state, false);
1438 if (old_state_is_stopped != new_state_is_stopped)
Greg Claytona894fe72012-04-05 16:12:35 +00001439 {
Sean Callanana3772862012-06-02 01:16:20 +00001440 if (new_state_is_stopped)
1441 {
1442 if (log)
1443 log->Printf("Process::SetPublicState (%s) -- unlocking run lock", StateAsCString(new_state));
1444 m_run_lock.WriteUnlock();
1445 }
Greg Claytona894fe72012-04-05 16:12:35 +00001446 }
Greg Claytona894fe72012-04-05 16:12:35 +00001447 }
1448 }
Chris Lattner24943d22010-06-08 16:52:24 +00001449}
1450
Jim Ingham027aaa72012-04-19 01:40:33 +00001451Error
1452Process::Resume ()
1453{
1454 LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
1455 if (log)
1456 log->Printf("Process::Resume -- locking run lock");
1457 if (!m_run_lock.WriteTryLock())
1458 {
1459 Error error("Resume request failed - process still running.");
1460 if (log)
1461 log->Printf ("Process::Resume: -- WriteTryLock failed, not resuming.");
1462 return error;
1463 }
1464 return PrivateResume();
1465}
1466
Chris Lattner24943d22010-06-08 16:52:24 +00001467StateType
1468Process::GetPrivateState ()
1469{
1470 return m_private_state.GetValue();
1471}
1472
1473void
1474Process::SetPrivateState (StateType new_state)
1475{
Greg Clayton68ca8232011-01-25 02:58:48 +00001476 LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
Chris Lattner24943d22010-06-08 16:52:24 +00001477 bool state_changed = false;
1478
1479 if (log)
1480 log->Printf("Process::SetPrivateState (%s)", StateAsCString(new_state));
1481
1482 Mutex::Locker locker(m_private_state.GetMutex());
1483
1484 const StateType old_state = m_private_state.GetValueNoLock ();
1485 state_changed = old_state != new_state;
Greg Claytona894fe72012-04-05 16:12:35 +00001486 // This code is left commented out in case we ever need to control
1487 // the private process state with another run lock. Right now it doesn't
1488 // seem like we need to do this, but if we ever do, we can uncomment and
1489 // use this code.
1490// const bool old_state_is_stopped = StateIsStoppedState(old_state, false);
1491// const bool new_state_is_stopped = StateIsStoppedState(new_state, false);
1492// if (old_state_is_stopped != new_state_is_stopped)
1493// {
1494// if (new_state_is_stopped)
1495// m_private_run_lock.WriteUnlock();
1496// else
1497// m_private_run_lock.WriteLock();
1498// }
1499
Chris Lattner24943d22010-06-08 16:52:24 +00001500 if (state_changed)
1501 {
1502 m_private_state.SetValueNoLock (new_state);
Greg Clayton20206082011-11-17 01:23:07 +00001503 if (StateIsStoppedState(new_state, false))
Chris Lattner24943d22010-06-08 16:52:24 +00001504 {
Jim Ingham21f37ad2011-08-09 02:12:22 +00001505 m_mod_id.BumpStopID();
Greg Claytonfd119992011-01-07 06:08:19 +00001506 m_memory_cache.Clear();
Chris Lattner24943d22010-06-08 16:52:24 +00001507 if (log)
Jim Ingham21f37ad2011-08-09 02:12:22 +00001508 log->Printf("Process::SetPrivateState (%s) stop_id = %u", StateAsCString(new_state), m_mod_id.GetStopID());
Chris Lattner24943d22010-06-08 16:52:24 +00001509 }
1510 // Use our target to get a shared pointer to ourselves...
1511 m_private_state_broadcaster.BroadcastEvent (eBroadcastBitStateChanged, new ProcessEventData (GetTarget().GetProcessSP(), new_state));
1512 }
1513 else
1514 {
1515 if (log)
Jason Molenda7e5fa7f2011-09-20 21:44:10 +00001516 log->Printf("Process::SetPrivateState (%s) state didn't change. Ignoring...", StateAsCString(new_state));
Chris Lattner24943d22010-06-08 16:52:24 +00001517 }
1518}
1519
Jim Ingham0296fe72011-11-08 03:00:11 +00001520void
1521Process::SetRunningUserExpression (bool on)
1522{
1523 m_mod_id.SetRunningUserExpression (on);
1524}
1525
Chris Lattner24943d22010-06-08 16:52:24 +00001526addr_t
1527Process::GetImageInfoAddress()
1528{
1529 return LLDB_INVALID_ADDRESS;
1530}
1531
Greg Clayton0baa3942010-11-04 01:54:29 +00001532//----------------------------------------------------------------------
1533// LoadImage
1534//
1535// This function provides a default implementation that works for most
1536// unix variants. Any Process subclasses that need to do shared library
1537// loading differently should override LoadImage and UnloadImage and
1538// do what is needed.
1539//----------------------------------------------------------------------
1540uint32_t
1541Process::LoadImage (const FileSpec &image_spec, Error &error)
1542{
Greg Clayton77d40712012-04-18 00:05:19 +00001543 char path[PATH_MAX];
1544 image_spec.GetPath(path, sizeof(path));
1545
Greg Clayton0baa3942010-11-04 01:54:29 +00001546 DynamicLoader *loader = GetDynamicLoader();
1547 if (loader)
1548 {
1549 error = loader->CanLoadImage();
1550 if (error.Fail())
1551 return LLDB_INVALID_IMAGE_TOKEN;
1552 }
1553
1554 if (error.Success())
1555 {
1556 ThreadSP thread_sp(GetThreadList ().GetSelectedThread());
Greg Clayton0baa3942010-11-04 01:54:29 +00001557
1558 if (thread_sp)
1559 {
1560 StackFrameSP frame_sp (thread_sp->GetStackFrameAtIndex (0));
1561
1562 if (frame_sp)
1563 {
1564 ExecutionContext exe_ctx;
1565 frame_sp->CalculateExecutionContext (exe_ctx);
Jim Inghamea9d4262010-11-05 19:25:48 +00001566 bool unwind_on_error = true;
Greg Clayton0baa3942010-11-04 01:54:29 +00001567 StreamString expr;
Greg Clayton0baa3942010-11-04 01:54:29 +00001568 expr.Printf("dlopen (\"%s\", 2)", path);
1569 const char *prefix = "extern \"C\" void* dlopen (const char *path, int mode);\n";
Jim Ingham360f53f2010-11-30 02:22:11 +00001570 lldb::ValueObjectSP result_valobj_sp;
Sean Callanandaa6efe2011-12-21 22:22:58 +00001571 ClangUserExpression::Evaluate (exe_ctx, eExecutionPolicyAlways, lldb::eLanguageTypeUnknown, ClangUserExpression::eResultTypeAny, unwind_on_error, expr.GetData(), prefix, result_valobj_sp);
Johnny Chenb14ec342011-09-09 00:01:43 +00001572 error = result_valobj_sp->GetError();
1573 if (error.Success())
Greg Clayton0baa3942010-11-04 01:54:29 +00001574 {
1575 Scalar scalar;
Jim Inghamfa3a16a2011-03-31 00:19:25 +00001576 if (result_valobj_sp->ResolveValue (scalar))
Greg Clayton0baa3942010-11-04 01:54:29 +00001577 {
1578 addr_t image_ptr = scalar.ULongLong(LLDB_INVALID_ADDRESS);
1579 if (image_ptr != 0 && image_ptr != LLDB_INVALID_ADDRESS)
1580 {
1581 uint32_t image_token = m_image_tokens.size();
1582 m_image_tokens.push_back (image_ptr);
1583 return image_token;
1584 }
1585 }
1586 }
1587 }
1588 }
1589 }
Greg Clayton77d40712012-04-18 00:05:19 +00001590 if (!error.AsCString())
1591 error.SetErrorStringWithFormat("unable to load '%s'", path);
Greg Clayton0baa3942010-11-04 01:54:29 +00001592 return LLDB_INVALID_IMAGE_TOKEN;
1593}
1594
1595//----------------------------------------------------------------------
1596// UnloadImage
1597//
1598// This function provides a default implementation that works for most
1599// unix variants. Any Process subclasses that need to do shared library
1600// loading differently should override LoadImage and UnloadImage and
1601// do what is needed.
1602//----------------------------------------------------------------------
1603Error
1604Process::UnloadImage (uint32_t image_token)
1605{
1606 Error error;
1607 if (image_token < m_image_tokens.size())
1608 {
1609 const addr_t image_addr = m_image_tokens[image_token];
1610 if (image_addr == LLDB_INVALID_ADDRESS)
1611 {
1612 error.SetErrorString("image already unloaded");
1613 }
1614 else
1615 {
1616 DynamicLoader *loader = GetDynamicLoader();
1617 if (loader)
1618 error = loader->CanLoadImage();
1619
1620 if (error.Success())
1621 {
1622 ThreadSP thread_sp(GetThreadList ().GetSelectedThread());
Greg Clayton0baa3942010-11-04 01:54:29 +00001623
1624 if (thread_sp)
1625 {
1626 StackFrameSP frame_sp (thread_sp->GetStackFrameAtIndex (0));
1627
1628 if (frame_sp)
1629 {
1630 ExecutionContext exe_ctx;
1631 frame_sp->CalculateExecutionContext (exe_ctx);
Jim Inghamea9d4262010-11-05 19:25:48 +00001632 bool unwind_on_error = true;
Greg Clayton0baa3942010-11-04 01:54:29 +00001633 StreamString expr;
1634 expr.Printf("dlclose ((void *)0x%llx)", image_addr);
1635 const char *prefix = "extern \"C\" int dlclose(void* handle);\n";
Jim Ingham360f53f2010-11-30 02:22:11 +00001636 lldb::ValueObjectSP result_valobj_sp;
Sean Callanandaa6efe2011-12-21 22:22:58 +00001637 ClangUserExpression::Evaluate (exe_ctx, eExecutionPolicyAlways, lldb::eLanguageTypeUnknown, ClangUserExpression::eResultTypeAny, unwind_on_error, expr.GetData(), prefix, result_valobj_sp);
Greg Clayton0baa3942010-11-04 01:54:29 +00001638 if (result_valobj_sp->GetError().Success())
1639 {
1640 Scalar scalar;
Jim Inghamfa3a16a2011-03-31 00:19:25 +00001641 if (result_valobj_sp->ResolveValue (scalar))
Greg Clayton0baa3942010-11-04 01:54:29 +00001642 {
1643 if (scalar.UInt(1))
1644 {
1645 error.SetErrorStringWithFormat("expression failed: \"%s\"", expr.GetData());
1646 }
1647 else
1648 {
1649 m_image_tokens[image_token] = LLDB_INVALID_ADDRESS;
1650 }
1651 }
1652 }
1653 else
1654 {
1655 error = result_valobj_sp->GetError();
1656 }
1657 }
1658 }
1659 }
1660 }
1661 }
1662 else
1663 {
1664 error.SetErrorString("invalid image token");
1665 }
1666 return error;
1667}
1668
Greg Clayton75906e42011-05-11 18:39:18 +00001669const lldb::ABISP &
Chris Lattner24943d22010-06-08 16:52:24 +00001670Process::GetABI()
1671{
Greg Clayton75906e42011-05-11 18:39:18 +00001672 if (!m_abi_sp)
1673 m_abi_sp = ABI::FindPlugin(m_target.GetArchitecture());
1674 return m_abi_sp;
Chris Lattner24943d22010-06-08 16:52:24 +00001675}
1676
Jim Ingham642036f2010-09-23 02:01:19 +00001677LanguageRuntime *
Jim Inghame3117662012-03-10 00:22:19 +00001678Process::GetLanguageRuntime(lldb::LanguageType language, bool retry_if_null)
Jim Ingham642036f2010-09-23 02:01:19 +00001679{
1680 LanguageRuntimeCollection::iterator pos;
1681 pos = m_language_runtimes.find (language);
Jim Inghame3117662012-03-10 00:22:19 +00001682 if (pos == m_language_runtimes.end() || (retry_if_null && !(*pos).second))
Jim Ingham642036f2010-09-23 02:01:19 +00001683 {
Jim Inghame3117662012-03-10 00:22:19 +00001684 lldb::LanguageRuntimeSP runtime_sp(LanguageRuntime::FindPlugin(this, language));
Jim Ingham642036f2010-09-23 02:01:19 +00001685
Jim Inghame3117662012-03-10 00:22:19 +00001686 m_language_runtimes[language] = runtime_sp;
1687 return runtime_sp.get();
Jim Ingham642036f2010-09-23 02:01:19 +00001688 }
1689 else
1690 return (*pos).second.get();
1691}
1692
1693CPPLanguageRuntime *
Jim Inghame3117662012-03-10 00:22:19 +00001694Process::GetCPPLanguageRuntime (bool retry_if_null)
Jim Ingham642036f2010-09-23 02:01:19 +00001695{
Jim Inghame3117662012-03-10 00:22:19 +00001696 LanguageRuntime *runtime = GetLanguageRuntime(eLanguageTypeC_plus_plus, retry_if_null);
Jim Ingham642036f2010-09-23 02:01:19 +00001697 if (runtime != NULL && runtime->GetLanguageType() == eLanguageTypeC_plus_plus)
1698 return static_cast<CPPLanguageRuntime *> (runtime);
1699 return NULL;
1700}
1701
1702ObjCLanguageRuntime *
Jim Inghame3117662012-03-10 00:22:19 +00001703Process::GetObjCLanguageRuntime (bool retry_if_null)
Jim Ingham642036f2010-09-23 02:01:19 +00001704{
Jim Inghame3117662012-03-10 00:22:19 +00001705 LanguageRuntime *runtime = GetLanguageRuntime(eLanguageTypeObjC, retry_if_null);
Jim Ingham642036f2010-09-23 02:01:19 +00001706 if (runtime != NULL && runtime->GetLanguageType() == eLanguageTypeObjC)
1707 return static_cast<ObjCLanguageRuntime *> (runtime);
1708 return NULL;
1709}
1710
Enrico Granata6b1763b2012-05-21 16:51:35 +00001711bool
1712Process::IsPossibleDynamicValue (ValueObject& in_value)
1713{
1714 if (in_value.IsDynamic())
1715 return false;
1716 LanguageType known_type = in_value.GetObjectRuntimeLanguage();
1717
1718 if (known_type != eLanguageTypeUnknown && known_type != eLanguageTypeC)
1719 {
1720 LanguageRuntime *runtime = GetLanguageRuntime (known_type);
1721 return runtime ? runtime->CouldHaveDynamicValue(in_value) : false;
1722 }
1723
1724 LanguageRuntime *cpp_runtime = GetLanguageRuntime (eLanguageTypeC_plus_plus);
1725 if (cpp_runtime && cpp_runtime->CouldHaveDynamicValue(in_value))
1726 return true;
1727
1728 LanguageRuntime *objc_runtime = GetLanguageRuntime (eLanguageTypeObjC);
1729 return objc_runtime ? objc_runtime->CouldHaveDynamicValue(in_value) : false;
1730}
1731
Chris Lattner24943d22010-06-08 16:52:24 +00001732BreakpointSiteList &
1733Process::GetBreakpointSiteList()
1734{
1735 return m_breakpoint_site_list;
1736}
1737
1738const BreakpointSiteList &
1739Process::GetBreakpointSiteList() const
1740{
1741 return m_breakpoint_site_list;
1742}
1743
1744
1745void
1746Process::DisableAllBreakpointSites ()
1747{
1748 m_breakpoint_site_list.SetEnabledForAll (false);
Jim Ingham06b84492012-07-04 00:35:43 +00001749 size_t num_sites = m_breakpoint_site_list.GetSize();
1750 for (size_t i = 0; i < num_sites; i++)
1751 {
1752 DisableBreakpoint (m_breakpoint_site_list.GetByIndex(i).get());
1753 }
Chris Lattner24943d22010-06-08 16:52:24 +00001754}
1755
1756Error
1757Process::ClearBreakpointSiteByID (lldb::user_id_t break_id)
1758{
1759 Error error (DisableBreakpointSiteByID (break_id));
1760
1761 if (error.Success())
1762 m_breakpoint_site_list.Remove(break_id);
1763
1764 return error;
1765}
1766
1767Error
1768Process::DisableBreakpointSiteByID (lldb::user_id_t break_id)
1769{
1770 Error error;
1771 BreakpointSiteSP bp_site_sp = m_breakpoint_site_list.FindByID (break_id);
1772 if (bp_site_sp)
1773 {
1774 if (bp_site_sp->IsEnabled())
1775 error = DisableBreakpoint (bp_site_sp.get());
1776 }
1777 else
1778 {
Greg Clayton444e35b2011-10-19 18:09:39 +00001779 error.SetErrorStringWithFormat("invalid breakpoint site ID: %llu", break_id);
Chris Lattner24943d22010-06-08 16:52:24 +00001780 }
1781
1782 return error;
1783}
1784
1785Error
1786Process::EnableBreakpointSiteByID (lldb::user_id_t break_id)
1787{
1788 Error error;
1789 BreakpointSiteSP bp_site_sp = m_breakpoint_site_list.FindByID (break_id);
1790 if (bp_site_sp)
1791 {
1792 if (!bp_site_sp->IsEnabled())
1793 error = EnableBreakpoint (bp_site_sp.get());
1794 }
1795 else
1796 {
Greg Clayton444e35b2011-10-19 18:09:39 +00001797 error.SetErrorStringWithFormat("invalid breakpoint site ID: %llu", break_id);
Chris Lattner24943d22010-06-08 16:52:24 +00001798 }
1799 return error;
1800}
1801
Stephen Wilson3fd1f362010-07-17 00:56:13 +00001802lldb::break_id_t
Greg Clayton13d24fb2012-01-29 20:56:30 +00001803Process::CreateBreakpointSite (const BreakpointLocationSP &owner, bool use_hardware)
Chris Lattner24943d22010-06-08 16:52:24 +00001804{
Greg Clayton265ab332011-05-19 18:17:41 +00001805 const addr_t load_addr = owner->GetAddress().GetOpcodeLoadAddress (&m_target);
Chris Lattner24943d22010-06-08 16:52:24 +00001806 if (load_addr != LLDB_INVALID_ADDRESS)
1807 {
1808 BreakpointSiteSP bp_site_sp;
1809
1810 // Look up this breakpoint site. If it exists, then add this new owner, otherwise
1811 // create a new breakpoint site and add it.
1812
1813 bp_site_sp = m_breakpoint_site_list.FindByAddress (load_addr);
1814
1815 if (bp_site_sp)
1816 {
1817 bp_site_sp->AddOwner (owner);
1818 owner->SetBreakpointSite (bp_site_sp);
1819 return bp_site_sp->GetID();
1820 }
1821 else
1822 {
1823 bp_site_sp.reset (new BreakpointSite (&m_breakpoint_site_list, owner, load_addr, LLDB_INVALID_THREAD_ID, use_hardware));
1824 if (bp_site_sp)
1825 {
1826 if (EnableBreakpoint (bp_site_sp.get()).Success())
1827 {
1828 owner->SetBreakpointSite (bp_site_sp);
1829 return m_breakpoint_site_list.Add (bp_site_sp);
1830 }
1831 }
1832 }
1833 }
1834 // We failed to enable the breakpoint
1835 return LLDB_INVALID_BREAK_ID;
1836
1837}
1838
1839void
1840Process::RemoveOwnerFromBreakpointSite (lldb::user_id_t owner_id, lldb::user_id_t owner_loc_id, BreakpointSiteSP &bp_site_sp)
1841{
1842 uint32_t num_owners = bp_site_sp->RemoveOwner (owner_id, owner_loc_id);
1843 if (num_owners == 0)
1844 {
1845 DisableBreakpoint(bp_site_sp.get());
1846 m_breakpoint_site_list.RemoveByAddress(bp_site_sp->GetLoadAddress());
1847 }
1848}
1849
1850
1851size_t
1852Process::RemoveBreakpointOpcodesFromBuffer (addr_t bp_addr, size_t size, uint8_t *buf) const
1853{
1854 size_t bytes_removed = 0;
1855 addr_t intersect_addr;
1856 size_t intersect_size;
1857 size_t opcode_offset;
1858 size_t idx;
Greg Clayton987c7eb2011-09-17 08:33:22 +00001859 BreakpointSiteSP bp_sp;
Jim Ingham82820f92011-06-29 19:42:28 +00001860 BreakpointSiteList bp_sites_in_range;
Chris Lattner24943d22010-06-08 16:52:24 +00001861
Jim Ingham82820f92011-06-29 19:42:28 +00001862 if (m_breakpoint_site_list.FindInRange (bp_addr, bp_addr + size, bp_sites_in_range))
Chris Lattner24943d22010-06-08 16:52:24 +00001863 {
Greg Clayton987c7eb2011-09-17 08:33:22 +00001864 for (idx = 0; (bp_sp = bp_sites_in_range.GetByIndex(idx)); ++idx)
Chris Lattner24943d22010-06-08 16:52:24 +00001865 {
Greg Clayton987c7eb2011-09-17 08:33:22 +00001866 if (bp_sp->GetType() == BreakpointSite::eSoftware)
Chris Lattner24943d22010-06-08 16:52:24 +00001867 {
Greg Clayton987c7eb2011-09-17 08:33:22 +00001868 if (bp_sp->IntersectsRange(bp_addr, size, &intersect_addr, &intersect_size, &opcode_offset))
Jim Ingham82820f92011-06-29 19:42:28 +00001869 {
1870 assert(bp_addr <= intersect_addr && intersect_addr < bp_addr + size);
1871 assert(bp_addr < intersect_addr + intersect_size && intersect_addr + intersect_size <= bp_addr + size);
Greg Clayton987c7eb2011-09-17 08:33:22 +00001872 assert(opcode_offset + intersect_size <= bp_sp->GetByteSize());
Jim Ingham82820f92011-06-29 19:42:28 +00001873 size_t buf_offset = intersect_addr - bp_addr;
Greg Clayton987c7eb2011-09-17 08:33:22 +00001874 ::memcpy(buf + buf_offset, bp_sp->GetSavedOpcodeBytes() + opcode_offset, intersect_size);
Jim Ingham82820f92011-06-29 19:42:28 +00001875 }
Chris Lattner24943d22010-06-08 16:52:24 +00001876 }
1877 }
1878 }
1879 return bytes_removed;
1880}
1881
1882
Greg Claytonb1888f22011-03-19 01:12:21 +00001883
1884size_t
1885Process::GetSoftwareBreakpointTrapOpcode (BreakpointSite* bp_site)
1886{
1887 PlatformSP platform_sp (m_target.GetPlatform());
1888 if (platform_sp)
1889 return platform_sp->GetSoftwareBreakpointTrapOpcode (m_target, bp_site);
1890 return 0;
1891}
1892
Chris Lattner24943d22010-06-08 16:52:24 +00001893Error
1894Process::EnableSoftwareBreakpoint (BreakpointSite *bp_site)
1895{
1896 Error error;
1897 assert (bp_site != NULL);
Greg Claytone005f2c2010-11-06 01:53:30 +00001898 LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_BREAKPOINTS));
Chris Lattner24943d22010-06-08 16:52:24 +00001899 const addr_t bp_addr = bp_site->GetLoadAddress();
1900 if (log)
1901 log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%llx", bp_site->GetID(), (uint64_t)bp_addr);
1902 if (bp_site->IsEnabled())
1903 {
1904 if (log)
1905 log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%llx -- already enabled", bp_site->GetID(), (uint64_t)bp_addr);
1906 return error;
1907 }
1908
1909 if (bp_addr == LLDB_INVALID_ADDRESS)
1910 {
1911 error.SetErrorString("BreakpointSite contains an invalid load address.");
1912 return error;
1913 }
1914 // Ask the lldb::Process subclass to fill in the correct software breakpoint
1915 // trap for the breakpoint site
1916 const size_t bp_opcode_size = GetSoftwareBreakpointTrapOpcode(bp_site);
1917
1918 if (bp_opcode_size == 0)
1919 {
Greg Clayton9c236732011-10-26 00:56:27 +00001920 error.SetErrorStringWithFormat ("Process::GetSoftwareBreakpointTrapOpcode() returned zero, unable to get breakpoint trap for address 0x%llx", bp_addr);
Chris Lattner24943d22010-06-08 16:52:24 +00001921 }
1922 else
1923 {
1924 const uint8_t * const bp_opcode_bytes = bp_site->GetTrapOpcodeBytes();
1925
1926 if (bp_opcode_bytes == NULL)
1927 {
1928 error.SetErrorString ("BreakpointSite doesn't contain a valid breakpoint trap opcode.");
1929 return error;
1930 }
1931
1932 // Save the original opcode by reading it
1933 if (DoReadMemory(bp_addr, bp_site->GetSavedOpcodeBytes(), bp_opcode_size, error) == bp_opcode_size)
1934 {
1935 // Write a software breakpoint in place of the original opcode
1936 if (DoWriteMemory(bp_addr, bp_opcode_bytes, bp_opcode_size, error) == bp_opcode_size)
1937 {
1938 uint8_t verify_bp_opcode_bytes[64];
1939 if (DoReadMemory(bp_addr, verify_bp_opcode_bytes, bp_opcode_size, error) == bp_opcode_size)
1940 {
1941 if (::memcmp(bp_opcode_bytes, verify_bp_opcode_bytes, bp_opcode_size) == 0)
1942 {
1943 bp_site->SetEnabled(true);
1944 bp_site->SetType (BreakpointSite::eSoftware);
1945 if (log)
1946 log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%llx -- SUCCESS",
1947 bp_site->GetID(),
1948 (uint64_t)bp_addr);
1949 }
1950 else
Greg Clayton9c236732011-10-26 00:56:27 +00001951 error.SetErrorString("failed to verify the breakpoint trap in memory.");
Chris Lattner24943d22010-06-08 16:52:24 +00001952 }
1953 else
1954 error.SetErrorString("Unable to read memory to verify breakpoint trap.");
1955 }
1956 else
1957 error.SetErrorString("Unable to write breakpoint trap to memory.");
1958 }
1959 else
1960 error.SetErrorString("Unable to read memory at breakpoint address.");
1961 }
Stephen Wilsonc2b98252011-01-12 04:20:03 +00001962 if (log && error.Fail())
Chris Lattner24943d22010-06-08 16:52:24 +00001963 log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%llx -- FAILED: %s",
1964 bp_site->GetID(),
1965 (uint64_t)bp_addr,
1966 error.AsCString());
1967 return error;
1968}
1969
1970Error
1971Process::DisableSoftwareBreakpoint (BreakpointSite *bp_site)
1972{
1973 Error error;
1974 assert (bp_site != NULL);
Greg Claytone005f2c2010-11-06 01:53:30 +00001975 LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_BREAKPOINTS));
Chris Lattner24943d22010-06-08 16:52:24 +00001976 addr_t bp_addr = bp_site->GetLoadAddress();
1977 lldb::user_id_t breakID = bp_site->GetID();
1978 if (log)
Greg Clayton444e35b2011-10-19 18:09:39 +00001979 log->Printf ("Process::DisableBreakpoint (breakID = %llu) addr = 0x%llx", breakID, (uint64_t)bp_addr);
Chris Lattner24943d22010-06-08 16:52:24 +00001980
1981 if (bp_site->IsHardware())
1982 {
1983 error.SetErrorString("Breakpoint site is a hardware breakpoint.");
1984 }
1985 else if (bp_site->IsEnabled())
1986 {
1987 const size_t break_op_size = bp_site->GetByteSize();
1988 const uint8_t * const break_op = bp_site->GetTrapOpcodeBytes();
1989 if (break_op_size > 0)
1990 {
1991 // Clear a software breakoint instruction
Greg Clayton54e7afa2010-07-09 20:39:50 +00001992 uint8_t curr_break_op[8];
Stephen Wilson141eeac2010-07-20 18:41:11 +00001993 assert (break_op_size <= sizeof(curr_break_op));
Chris Lattner24943d22010-06-08 16:52:24 +00001994 bool break_op_found = false;
1995
1996 // Read the breakpoint opcode
1997 if (DoReadMemory (bp_addr, curr_break_op, break_op_size, error) == break_op_size)
1998 {
1999 bool verify = false;
2000 // Make sure we have the a breakpoint opcode exists at this address
2001 if (::memcmp (curr_break_op, break_op, break_op_size) == 0)
2002 {
2003 break_op_found = true;
2004 // We found a valid breakpoint opcode at this address, now restore
2005 // the saved opcode.
2006 if (DoWriteMemory (bp_addr, bp_site->GetSavedOpcodeBytes(), break_op_size, error) == break_op_size)
2007 {
2008 verify = true;
2009 }
2010 else
2011 error.SetErrorString("Memory write failed when restoring original opcode.");
2012 }
2013 else
2014 {
2015 error.SetErrorString("Original breakpoint trap is no longer in memory.");
2016 // Set verify to true and so we can check if the original opcode has already been restored
2017 verify = true;
2018 }
2019
2020 if (verify)
2021 {
Greg Clayton54e7afa2010-07-09 20:39:50 +00002022 uint8_t verify_opcode[8];
Stephen Wilson141eeac2010-07-20 18:41:11 +00002023 assert (break_op_size < sizeof(verify_opcode));
Chris Lattner24943d22010-06-08 16:52:24 +00002024 // Verify that our original opcode made it back to the inferior
2025 if (DoReadMemory (bp_addr, verify_opcode, break_op_size, error) == break_op_size)
2026 {
2027 // compare the memory we just read with the original opcode
2028 if (::memcmp (bp_site->GetSavedOpcodeBytes(), verify_opcode, break_op_size) == 0)
2029 {
2030 // SUCCESS
2031 bp_site->SetEnabled(false);
2032 if (log)
2033 log->Printf ("Process::DisableSoftwareBreakpoint (site_id = %d) addr = 0x%llx -- SUCCESS", bp_site->GetID(), (uint64_t)bp_addr);
2034 return error;
2035 }
2036 else
2037 {
2038 if (break_op_found)
2039 error.SetErrorString("Failed to restore original opcode.");
2040 }
2041 }
2042 else
2043 error.SetErrorString("Failed to read memory to verify that breakpoint trap was restored.");
2044 }
2045 }
2046 else
2047 error.SetErrorString("Unable to read memory that should contain the breakpoint trap.");
2048 }
2049 }
2050 else
2051 {
2052 if (log)
2053 log->Printf ("Process::DisableSoftwareBreakpoint (site_id = %d) addr = 0x%llx -- already disabled", bp_site->GetID(), (uint64_t)bp_addr);
2054 return error;
2055 }
2056
2057 if (log)
2058 log->Printf ("Process::DisableSoftwareBreakpoint (site_id = %d) addr = 0x%llx -- FAILED: %s",
2059 bp_site->GetID(),
2060 (uint64_t)bp_addr,
2061 error.AsCString());
2062 return error;
2063
2064}
2065
Greg Claytonfd119992011-01-07 06:08:19 +00002066// Uncomment to verify memory caching works after making changes to caching code
2067//#define VERIFY_MEMORY_READS
2068
Sean Callananf90b5f32012-06-07 22:26:42 +00002069size_t
2070Process::ReadMemory (addr_t addr, void *buf, size_t size, Error &error)
2071{
2072 if (!GetDisableMemoryCache())
2073 {
Greg Claytonfd119992011-01-07 06:08:19 +00002074#if defined (VERIFY_MEMORY_READS)
Sean Callananf90b5f32012-06-07 22:26:42 +00002075 // Memory caching is enabled, with debug verification
2076
2077 if (buf && size)
2078 {
2079 // Uncomment the line below to make sure memory caching is working.
2080 // I ran this through the test suite and got no assertions, so I am
2081 // pretty confident this is working well. If any changes are made to
2082 // memory caching, uncomment the line below and test your changes!
2083
2084 // Verify all memory reads by using the cache first, then redundantly
2085 // reading the same memory from the inferior and comparing to make sure
2086 // everything is exactly the same.
2087 std::string verify_buf (size, '\0');
2088 assert (verify_buf.size() == size);
2089 const size_t cache_bytes_read = m_memory_cache.Read (this, addr, buf, size, error);
2090 Error verify_error;
2091 const size_t verify_bytes_read = ReadMemoryFromInferior (addr, const_cast<char *>(verify_buf.data()), verify_buf.size(), verify_error);
2092 assert (cache_bytes_read == verify_bytes_read);
2093 assert (memcmp(buf, verify_buf.data(), verify_buf.size()) == 0);
2094 assert (verify_error.Success() == error.Success());
2095 return cache_bytes_read;
2096 }
2097 return 0;
2098#else // !defined(VERIFY_MEMORY_READS)
2099 // Memory caching is enabled, without debug verification
2100
2101 return m_memory_cache.Read (addr, buf, size, error);
2102#endif // defined (VERIFY_MEMORY_READS)
Greg Claytonfd119992011-01-07 06:08:19 +00002103 }
Sean Callananf90b5f32012-06-07 22:26:42 +00002104 else
2105 {
2106 // Memory caching is disabled
2107
2108 return ReadMemoryFromInferior (addr, buf, size, error);
2109 }
Greg Claytonfd119992011-01-07 06:08:19 +00002110}
Greg Claytonfd119992011-01-07 06:08:19 +00002111
Greg Claytondd29b972012-05-18 23:20:01 +00002112size_t
2113Process::ReadCStringFromMemory (addr_t addr, std::string &out_str, Error &error)
2114{
Greg Claytoneeeb2af2012-05-19 00:18:00 +00002115 char buf[256];
Greg Claytondd29b972012-05-18 23:20:01 +00002116 out_str.clear();
2117 addr_t curr_addr = addr;
2118 while (1)
2119 {
2120 size_t length = ReadCStringFromMemory (curr_addr, buf, sizeof(buf), error);
2121 if (length == 0)
2122 break;
2123 out_str.append(buf, length);
2124 // If we got "length - 1" bytes, we didn't get the whole C string, we
2125 // need to read some more characters
2126 if (length == sizeof(buf) - 1)
2127 curr_addr += length;
2128 else
2129 break;
2130 }
2131 return out_str.size();
2132}
2133
Greg Claytonfd119992011-01-07 06:08:19 +00002134
2135size_t
Greg Clayton4a2e3372011-12-15 03:14:23 +00002136Process::ReadCStringFromMemory (addr_t addr, char *dst, size_t dst_max_len, Error &result_error)
Greg Claytonb72d0f02011-04-12 05:54:46 +00002137{
2138 size_t total_cstr_len = 0;
2139 if (dst && dst_max_len)
2140 {
Greg Clayton4a2e3372011-12-15 03:14:23 +00002141 result_error.Clear();
Greg Claytonb72d0f02011-04-12 05:54:46 +00002142 // NULL out everything just to be safe
2143 memset (dst, 0, dst_max_len);
2144 Error error;
2145 addr_t curr_addr = addr;
2146 const size_t cache_line_size = m_memory_cache.GetMemoryCacheLineSize();
2147 size_t bytes_left = dst_max_len - 1;
2148 char *curr_dst = dst;
2149
2150 while (bytes_left > 0)
2151 {
2152 addr_t cache_line_bytes_left = cache_line_size - (curr_addr % cache_line_size);
2153 addr_t bytes_to_read = std::min<addr_t>(bytes_left, cache_line_bytes_left);
2154 size_t bytes_read = ReadMemory (curr_addr, curr_dst, bytes_to_read, error);
2155
2156 if (bytes_read == 0)
2157 {
Greg Clayton4a2e3372011-12-15 03:14:23 +00002158 result_error = error;
Greg Claytonb72d0f02011-04-12 05:54:46 +00002159 dst[total_cstr_len] = '\0';
2160 break;
2161 }
2162 const size_t len = strlen(curr_dst);
2163
2164 total_cstr_len += len;
2165
2166 if (len < bytes_to_read)
2167 break;
2168
2169 curr_dst += bytes_read;
2170 curr_addr += bytes_read;
2171 bytes_left -= bytes_read;
2172 }
2173 }
Greg Clayton4a2e3372011-12-15 03:14:23 +00002174 else
2175 {
2176 if (dst == NULL)
2177 result_error.SetErrorString("invalid arguments");
2178 else
2179 result_error.Clear();
2180 }
Greg Claytonb72d0f02011-04-12 05:54:46 +00002181 return total_cstr_len;
2182}
2183
2184size_t
Greg Claytonfd119992011-01-07 06:08:19 +00002185Process::ReadMemoryFromInferior (addr_t addr, void *buf, size_t size, Error &error)
2186{
Chris Lattner24943d22010-06-08 16:52:24 +00002187 if (buf == NULL || size == 0)
2188 return 0;
2189
2190 size_t bytes_read = 0;
2191 uint8_t *bytes = (uint8_t *)buf;
2192
2193 while (bytes_read < size)
2194 {
2195 const size_t curr_size = size - bytes_read;
2196 const size_t curr_bytes_read = DoReadMemory (addr + bytes_read,
2197 bytes + bytes_read,
2198 curr_size,
2199 error);
2200 bytes_read += curr_bytes_read;
2201 if (curr_bytes_read == curr_size || curr_bytes_read == 0)
2202 break;
2203 }
2204
2205 // Replace any software breakpoint opcodes that fall into this range back
2206 // into "buf" before we return
2207 if (bytes_read > 0)
2208 RemoveBreakpointOpcodesFromBuffer (addr, bytes_read, (uint8_t *)buf);
2209 return bytes_read;
2210}
2211
Greg Claytonf72fdee2010-12-16 20:01:20 +00002212uint64_t
Greg Claytonc0fa5332011-05-22 22:46:53 +00002213Process::ReadUnsignedIntegerFromMemory (lldb::addr_t vm_addr, size_t integer_byte_size, uint64_t fail_value, Error &error)
Greg Claytonf72fdee2010-12-16 20:01:20 +00002214{
Greg Claytonc0fa5332011-05-22 22:46:53 +00002215 Scalar scalar;
2216 if (ReadScalarIntegerFromMemory(vm_addr, integer_byte_size, false, scalar, error))
2217 return scalar.ULongLong(fail_value);
2218 return fail_value;
2219}
2220
2221addr_t
2222Process::ReadPointerFromMemory (lldb::addr_t vm_addr, Error &error)
2223{
2224 Scalar scalar;
2225 if (ReadScalarIntegerFromMemory(vm_addr, GetAddressByteSize(), false, scalar, error))
2226 return scalar.ULongLong(LLDB_INVALID_ADDRESS);
2227 return LLDB_INVALID_ADDRESS;
2228}
2229
2230
2231bool
2232Process::WritePointerToMemory (lldb::addr_t vm_addr,
2233 lldb::addr_t ptr_value,
2234 Error &error)
2235{
2236 Scalar scalar;
2237 const uint32_t addr_byte_size = GetAddressByteSize();
2238 if (addr_byte_size <= 4)
2239 scalar = (uint32_t)ptr_value;
Greg Claytonf72fdee2010-12-16 20:01:20 +00002240 else
Greg Claytonc0fa5332011-05-22 22:46:53 +00002241 scalar = ptr_value;
2242 return WriteScalarToMemory(vm_addr, scalar, addr_byte_size, error) == addr_byte_size;
Greg Claytonf72fdee2010-12-16 20:01:20 +00002243}
2244
Chris Lattner24943d22010-06-08 16:52:24 +00002245size_t
2246Process::WriteMemoryPrivate (addr_t addr, const void *buf, size_t size, Error &error)
2247{
2248 size_t bytes_written = 0;
2249 const uint8_t *bytes = (const uint8_t *)buf;
2250
2251 while (bytes_written < size)
2252 {
2253 const size_t curr_size = size - bytes_written;
2254 const size_t curr_bytes_written = DoWriteMemory (addr + bytes_written,
2255 bytes + bytes_written,
2256 curr_size,
2257 error);
2258 bytes_written += curr_bytes_written;
2259 if (curr_bytes_written == curr_size || curr_bytes_written == 0)
2260 break;
2261 }
2262 return bytes_written;
2263}
2264
2265size_t
2266Process::WriteMemory (addr_t addr, const void *buf, size_t size, Error &error)
2267{
Greg Claytonfd119992011-01-07 06:08:19 +00002268#if defined (ENABLE_MEMORY_CACHING)
2269 m_memory_cache.Flush (addr, size);
2270#endif
2271
Chris Lattner24943d22010-06-08 16:52:24 +00002272 if (buf == NULL || size == 0)
2273 return 0;
Jim Inghame41494a2011-04-16 00:01:13 +00002274
Jim Ingham21f37ad2011-08-09 02:12:22 +00002275 m_mod_id.BumpMemoryID();
Jim Inghame41494a2011-04-16 00:01:13 +00002276
Chris Lattner24943d22010-06-08 16:52:24 +00002277 // We need to write any data that would go where any current software traps
2278 // (enabled software breakpoints) any software traps (breakpoints) that we
2279 // may have placed in our tasks memory.
2280
2281 BreakpointSiteList::collection::const_iterator iter = m_breakpoint_site_list.GetMap()->lower_bound (addr);
2282 BreakpointSiteList::collection::const_iterator end = m_breakpoint_site_list.GetMap()->end();
2283
2284 if (iter == end || iter->second->GetLoadAddress() > addr + size)
Greg Claytonc8bc1c32011-05-16 02:35:02 +00002285 return WriteMemoryPrivate (addr, buf, size, error);
Chris Lattner24943d22010-06-08 16:52:24 +00002286
2287 BreakpointSiteList::collection::const_iterator pos;
2288 size_t bytes_written = 0;
Greg Clayton54e7afa2010-07-09 20:39:50 +00002289 addr_t intersect_addr = 0;
2290 size_t intersect_size = 0;
2291 size_t opcode_offset = 0;
Chris Lattner24943d22010-06-08 16:52:24 +00002292 const uint8_t *ubuf = (const uint8_t *)buf;
2293
2294 for (pos = iter; pos != end; ++pos)
2295 {
2296 BreakpointSiteSP bp;
2297 bp = pos->second;
2298
2299 assert(bp->IntersectsRange(addr, size, &intersect_addr, &intersect_size, &opcode_offset));
2300 assert(addr <= intersect_addr && intersect_addr < addr + size);
2301 assert(addr < intersect_addr + intersect_size && intersect_addr + intersect_size <= addr + size);
2302 assert(opcode_offset + intersect_size <= bp->GetByteSize());
2303
2304 // Check for bytes before this breakpoint
2305 const addr_t curr_addr = addr + bytes_written;
2306 if (intersect_addr > curr_addr)
2307 {
2308 // There are some bytes before this breakpoint that we need to
2309 // just write to memory
2310 size_t curr_size = intersect_addr - curr_addr;
2311 size_t curr_bytes_written = WriteMemoryPrivate (curr_addr,
2312 ubuf + bytes_written,
2313 curr_size,
2314 error);
2315 bytes_written += curr_bytes_written;
2316 if (curr_bytes_written != curr_size)
2317 {
2318 // We weren't able to write all of the requested bytes, we
2319 // are done looping and will return the number of bytes that
2320 // we have written so far.
2321 break;
2322 }
2323 }
2324
2325 // Now write any bytes that would cover up any software breakpoints
2326 // directly into the breakpoint opcode buffer
2327 ::memcpy(bp->GetSavedOpcodeBytes() + opcode_offset, ubuf + bytes_written, intersect_size);
2328 bytes_written += intersect_size;
2329 }
2330
2331 // Write any remaining bytes after the last breakpoint if we have any left
2332 if (bytes_written < size)
2333 bytes_written += WriteMemoryPrivate (addr + bytes_written,
2334 ubuf + bytes_written,
2335 size - bytes_written,
2336 error);
Jim Inghame41494a2011-04-16 00:01:13 +00002337
Chris Lattner24943d22010-06-08 16:52:24 +00002338 return bytes_written;
2339}
Greg Claytonc0fa5332011-05-22 22:46:53 +00002340
2341size_t
2342Process::WriteScalarToMemory (addr_t addr, const Scalar &scalar, uint32_t byte_size, Error &error)
2343{
2344 if (byte_size == UINT32_MAX)
2345 byte_size = scalar.GetByteSize();
2346 if (byte_size > 0)
2347 {
2348 uint8_t buf[32];
2349 const size_t mem_size = scalar.GetAsMemoryData (buf, byte_size, GetByteOrder(), error);
2350 if (mem_size > 0)
2351 return WriteMemory(addr, buf, mem_size, error);
2352 else
2353 error.SetErrorString ("failed to get scalar as memory data");
2354 }
2355 else
2356 {
2357 error.SetErrorString ("invalid scalar value");
2358 }
2359 return 0;
2360}
2361
2362size_t
2363Process::ReadScalarIntegerFromMemory (addr_t addr,
2364 uint32_t byte_size,
2365 bool is_signed,
2366 Scalar &scalar,
2367 Error &error)
2368{
2369 uint64_t uval;
2370
2371 if (byte_size <= sizeof(uval))
2372 {
2373 size_t bytes_read = ReadMemory (addr, &uval, byte_size, error);
2374 if (bytes_read == byte_size)
2375 {
2376 DataExtractor data (&uval, sizeof(uval), GetByteOrder(), GetAddressByteSize());
2377 uint32_t offset = 0;
2378 if (byte_size <= 4)
2379 scalar = data.GetMaxU32 (&offset, byte_size);
2380 else
2381 scalar = data.GetMaxU64 (&offset, byte_size);
2382
2383 if (is_signed)
2384 scalar.SignExtend(byte_size * 8);
2385 return bytes_read;
2386 }
2387 }
2388 else
2389 {
2390 error.SetErrorStringWithFormat ("byte size of %u is too large for integer scalar type", byte_size);
2391 }
2392 return 0;
2393}
2394
Greg Clayton613b8732011-05-17 03:37:42 +00002395#define USE_ALLOCATE_MEMORY_CACHE 1
Chris Lattner24943d22010-06-08 16:52:24 +00002396addr_t
2397Process::AllocateMemory(size_t size, uint32_t permissions, Error &error)
2398{
Jim Inghame6bd1422011-06-20 17:32:44 +00002399 if (GetPrivateState() != eStateStopped)
2400 return LLDB_INVALID_ADDRESS;
2401
Greg Clayton613b8732011-05-17 03:37:42 +00002402#if defined (USE_ALLOCATE_MEMORY_CACHE)
2403 return m_allocated_memory_cache.AllocateMemory(size, permissions, error);
2404#else
Greg Clayton2860ba92011-01-23 19:58:49 +00002405 addr_t allocated_addr = DoAllocateMemory (size, permissions, error);
2406 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
2407 if (log)
Jim Ingham21f37ad2011-08-09 02:12:22 +00002408 log->Printf("Process::AllocateMemory(size=%4zu, permissions=%s) => 0x%16.16llx (m_stop_id = %u m_memory_id = %u)",
Greg Clayton2860ba92011-01-23 19:58:49 +00002409 size,
Greg Clayton613b8732011-05-17 03:37:42 +00002410 GetPermissionsAsCString (permissions),
Greg Clayton2860ba92011-01-23 19:58:49 +00002411 (uint64_t)allocated_addr,
Jim Ingham21f37ad2011-08-09 02:12:22 +00002412 m_mod_id.GetStopID(),
2413 m_mod_id.GetMemoryID());
Greg Clayton2860ba92011-01-23 19:58:49 +00002414 return allocated_addr;
Greg Clayton613b8732011-05-17 03:37:42 +00002415#endif
Chris Lattner24943d22010-06-08 16:52:24 +00002416}
2417
Sean Callanan6cf6c472011-09-20 23:01:51 +00002418bool
2419Process::CanJIT ()
2420{
Sean Callanan04200f62012-02-14 22:50:38 +00002421 if (m_can_jit == eCanJITDontKnow)
2422 {
2423 Error err;
2424
2425 uint64_t allocated_memory = AllocateMemory(8,
2426 ePermissionsReadable | ePermissionsWritable | ePermissionsExecutable,
2427 err);
2428
2429 if (err.Success())
2430 m_can_jit = eCanJITYes;
2431 else
2432 m_can_jit = eCanJITNo;
2433
2434 DeallocateMemory (allocated_memory);
2435 }
2436
Sean Callanan6cf6c472011-09-20 23:01:51 +00002437 return m_can_jit == eCanJITYes;
2438}
2439
2440void
2441Process::SetCanJIT (bool can_jit)
2442{
2443 m_can_jit = (can_jit ? eCanJITYes : eCanJITNo);
2444}
2445
Chris Lattner24943d22010-06-08 16:52:24 +00002446Error
2447Process::DeallocateMemory (addr_t ptr)
2448{
Greg Clayton613b8732011-05-17 03:37:42 +00002449 Error error;
2450#if defined (USE_ALLOCATE_MEMORY_CACHE)
2451 if (!m_allocated_memory_cache.DeallocateMemory(ptr))
2452 {
2453 error.SetErrorStringWithFormat ("deallocation of memory at 0x%llx failed.", (uint64_t)ptr);
2454 }
2455#else
2456 error = DoDeallocateMemory (ptr);
Greg Clayton2860ba92011-01-23 19:58:49 +00002457
2458 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
2459 if (log)
Jim Ingham21f37ad2011-08-09 02:12:22 +00002460 log->Printf("Process::DeallocateMemory(addr=0x%16.16llx) => err = %s (m_stop_id = %u, m_memory_id = %u)",
Greg Clayton2860ba92011-01-23 19:58:49 +00002461 ptr,
2462 error.AsCString("SUCCESS"),
Jim Ingham21f37ad2011-08-09 02:12:22 +00002463 m_mod_id.GetStopID(),
2464 m_mod_id.GetMemoryID());
Greg Clayton613b8732011-05-17 03:37:42 +00002465#endif
Greg Clayton2860ba92011-01-23 19:58:49 +00002466 return error;
Chris Lattner24943d22010-06-08 16:52:24 +00002467}
2468
Greg Claytonb5a8f142012-02-05 02:38:54 +00002469ModuleSP
Greg Clayton9ce95382012-02-13 23:10:39 +00002470Process::ReadModuleFromMemory (const FileSpec& file_spec,
2471 lldb::addr_t header_addr,
2472 bool add_image_to_target,
2473 bool load_sections_in_target)
Greg Claytonb5a8f142012-02-05 02:38:54 +00002474{
Greg Clayton6c5438b2012-02-24 21:55:59 +00002475 ModuleSP module_sp (new Module (file_spec, ArchSpec()));
Greg Claytonb5a8f142012-02-05 02:38:54 +00002476 if (module_sp)
2477 {
Greg Clayton6c5438b2012-02-24 21:55:59 +00002478 Error error;
2479 ObjectFile *objfile = module_sp->GetMemoryObjectFile (shared_from_this(), header_addr, error);
2480 if (objfile)
Greg Clayton9ce95382012-02-13 23:10:39 +00002481 {
Greg Clayton6c5438b2012-02-24 21:55:59 +00002482 if (add_image_to_target)
Greg Clayton9ce95382012-02-13 23:10:39 +00002483 {
Greg Clayton6c5438b2012-02-24 21:55:59 +00002484 m_target.GetImages().Append(module_sp);
2485 if (load_sections_in_target)
2486 {
2487 bool changed = false;
2488 module_sp->SetLoadAddress (m_target, 0, changed);
2489 }
Greg Clayton9ce95382012-02-13 23:10:39 +00002490 }
Greg Clayton6c5438b2012-02-24 21:55:59 +00002491 return module_sp;
Greg Clayton9ce95382012-02-13 23:10:39 +00002492 }
Greg Claytonb5a8f142012-02-05 02:38:54 +00002493 }
Greg Clayton6c5438b2012-02-24 21:55:59 +00002494 return ModuleSP();
Greg Claytonb5a8f142012-02-05 02:38:54 +00002495}
Chris Lattner24943d22010-06-08 16:52:24 +00002496
2497Error
Johnny Chenecd4feb2011-10-14 00:42:25 +00002498Process::EnableWatchpoint (Watchpoint *watchpoint)
Chris Lattner24943d22010-06-08 16:52:24 +00002499{
2500 Error error;
2501 error.SetErrorString("watchpoints are not supported");
2502 return error;
2503}
2504
2505Error
Johnny Chenecd4feb2011-10-14 00:42:25 +00002506Process::DisableWatchpoint (Watchpoint *watchpoint)
Chris Lattner24943d22010-06-08 16:52:24 +00002507{
2508 Error error;
2509 error.SetErrorString("watchpoints are not supported");
2510 return error;
2511}
2512
2513StateType
2514Process::WaitForProcessStopPrivate (const TimeValue *timeout, EventSP &event_sp)
2515{
2516 StateType state;
2517 // Now wait for the process to launch and return control to us, and then
2518 // call DidLaunch:
2519 while (1)
2520 {
Greg Clayton72e1c782011-01-22 23:43:18 +00002521 event_sp.reset();
2522 state = WaitForStateChangedEventsPrivate (timeout, event_sp);
2523
Greg Clayton20206082011-11-17 01:23:07 +00002524 if (StateIsStoppedState(state, false))
Chris Lattner24943d22010-06-08 16:52:24 +00002525 break;
Greg Clayton72e1c782011-01-22 23:43:18 +00002526
2527 // If state is invalid, then we timed out
2528 if (state == eStateInvalid)
2529 break;
2530
2531 if (event_sp)
Chris Lattner24943d22010-06-08 16:52:24 +00002532 HandlePrivateEvent (event_sp);
2533 }
2534 return state;
2535}
2536
2537Error
Greg Clayton36bc5ea2011-11-03 21:22:33 +00002538Process::Launch (const ProcessLaunchInfo &launch_info)
Chris Lattner24943d22010-06-08 16:52:24 +00002539{
2540 Error error;
Chris Lattner24943d22010-06-08 16:52:24 +00002541 m_abi_sp.reset();
Greg Clayton75c703d2011-02-16 04:46:07 +00002542 m_dyld_ap.reset();
Greg Clayton37f962e2011-08-22 02:49:39 +00002543 m_os_ap.reset();
Caroline Tice861efb32010-11-16 05:07:41 +00002544 m_process_input_reader.reset();
Chris Lattner24943d22010-06-08 16:52:24 +00002545
Greg Clayton5beb99d2011-08-11 02:48:45 +00002546 Module *exe_module = m_target.GetExecutableModulePointer();
Chris Lattner24943d22010-06-08 16:52:24 +00002547 if (exe_module)
2548 {
Greg Clayton180546b2011-04-30 01:09:13 +00002549 char local_exec_file_path[PATH_MAX];
2550 char platform_exec_file_path[PATH_MAX];
2551 exe_module->GetFileSpec().GetPath(local_exec_file_path, sizeof(local_exec_file_path));
2552 exe_module->GetPlatformFileSpec().GetPath(platform_exec_file_path, sizeof(platform_exec_file_path));
Chris Lattner24943d22010-06-08 16:52:24 +00002553 if (exe_module->GetFileSpec().Exists())
2554 {
Greg Claytona2f74232011-02-24 22:24:29 +00002555 if (PrivateStateThreadIsValid ())
2556 PausePrivateStateThread ();
2557
Chris Lattner24943d22010-06-08 16:52:24 +00002558 error = WillLaunch (exe_module);
2559 if (error.Success())
2560 {
Greg Claytond8c62532010-10-07 04:19:01 +00002561 SetPublicState (eStateLaunching);
Greg Claytonffa43a62011-11-17 04:46:02 +00002562 m_should_detach = false;
Chris Lattner24943d22010-06-08 16:52:24 +00002563
2564 // Now launch using these arguments.
Greg Clayton36bc5ea2011-11-03 21:22:33 +00002565 error = DoLaunch (exe_module, launch_info);
Chris Lattner24943d22010-06-08 16:52:24 +00002566
2567 if (error.Fail())
2568 {
2569 if (GetID() != LLDB_INVALID_PROCESS_ID)
2570 {
2571 SetID (LLDB_INVALID_PROCESS_ID);
2572 const char *error_string = error.AsCString();
2573 if (error_string == NULL)
2574 error_string = "launch failed";
2575 SetExitStatus (-1, error_string);
2576 }
2577 }
2578 else
2579 {
2580 EventSP event_sp;
Greg Clayton49859592011-06-22 01:42:17 +00002581 TimeValue timeout_time;
2582 timeout_time = TimeValue::Now();
2583 timeout_time.OffsetWithSeconds(10);
2584 StateType state = WaitForProcessStopPrivate(&timeout_time, event_sp);
Chris Lattner24943d22010-06-08 16:52:24 +00002585
Greg Clayton49859592011-06-22 01:42:17 +00002586 if (state == eStateInvalid || event_sp.get() == NULL)
2587 {
2588 // We were able to launch the process, but we failed to
2589 // catch the initial stop.
2590 SetExitStatus (0, "failed to catch stop after launch");
2591 Destroy();
2592 }
2593 else if (state == eStateStopped || state == eStateCrashed)
Chris Lattner24943d22010-06-08 16:52:24 +00002594 {
Greg Clayton75c703d2011-02-16 04:46:07 +00002595
Chris Lattner24943d22010-06-08 16:52:24 +00002596 DidLaunch ();
2597
Greg Clayton9ce95382012-02-13 23:10:39 +00002598 DynamicLoader *dyld = GetDynamicLoader ();
2599 if (dyld)
2600 dyld->DidLaunch();
Greg Clayton75c703d2011-02-16 04:46:07 +00002601
Greg Clayton37f962e2011-08-22 02:49:39 +00002602 m_os_ap.reset (OperatingSystem::FindPlugin (this, NULL));
Chris Lattner24943d22010-06-08 16:52:24 +00002603 // This delays passing the stopped event to listeners till DidLaunch gets
2604 // a chance to complete...
2605 HandlePrivateEvent (event_sp);
Greg Claytona2f74232011-02-24 22:24:29 +00002606
2607 if (PrivateStateThreadIsValid ())
2608 ResumePrivateStateThread ();
2609 else
2610 StartPrivateStateThread ();
Chris Lattner24943d22010-06-08 16:52:24 +00002611 }
2612 else if (state == eStateExited)
2613 {
2614 // We exited while trying to launch somehow. Don't call DidLaunch as that's
2615 // not likely to work, and return an invalid pid.
2616 HandlePrivateEvent (event_sp);
2617 }
2618 }
2619 }
2620 }
2621 else
2622 {
Greg Clayton9c236732011-10-26 00:56:27 +00002623 error.SetErrorStringWithFormat("file doesn't exist: '%s'", local_exec_file_path);
Chris Lattner24943d22010-06-08 16:52:24 +00002624 }
2625 }
2626 return error;
2627}
2628
Greg Clayton46c9a352012-02-09 06:16:32 +00002629
2630Error
2631Process::LoadCore ()
2632{
2633 Error error = DoLoadCore();
2634 if (error.Success())
2635 {
2636 if (PrivateStateThreadIsValid ())
2637 ResumePrivateStateThread ();
2638 else
2639 StartPrivateStateThread ();
2640
Greg Clayton9ce95382012-02-13 23:10:39 +00002641 DynamicLoader *dyld = GetDynamicLoader ();
2642 if (dyld)
2643 dyld->DidAttach();
2644
2645 m_os_ap.reset (OperatingSystem::FindPlugin (this, NULL));
Greg Clayton46c9a352012-02-09 06:16:32 +00002646 // We successfully loaded a core file, now pretend we stopped so we can
2647 // show all of the threads in the core file and explore the crashed
2648 // state.
2649 SetPrivateState (eStateStopped);
2650
2651 }
2652 return error;
2653}
2654
Greg Clayton9ce95382012-02-13 23:10:39 +00002655DynamicLoader *
2656Process::GetDynamicLoader ()
2657{
2658 if (m_dyld_ap.get() == NULL)
2659 m_dyld_ap.reset (DynamicLoader::FindPlugin(this, NULL));
2660 return m_dyld_ap.get();
2661}
Greg Clayton46c9a352012-02-09 06:16:32 +00002662
2663
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002664Process::NextEventAction::EventActionResult
2665Process::AttachCompletionHandler::PerformAction (lldb::EventSP &event_sp)
Chris Lattner24943d22010-06-08 16:52:24 +00002666{
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002667 StateType state = ProcessEventData::GetStateFromEvent (event_sp.get());
2668 switch (state)
Greg Claytonc1d37752010-10-18 01:45:30 +00002669 {
Greg Clayton7e2f91c2011-01-29 07:10:55 +00002670 case eStateRunning:
Greg Claytona2f74232011-02-24 22:24:29 +00002671 case eStateConnected:
Greg Clayton7e2f91c2011-01-29 07:10:55 +00002672 return eEventActionRetry;
2673
2674 case eStateStopped:
2675 case eStateCrashed:
Greg Clayton2d9adb72011-11-12 02:10:56 +00002676 {
2677 // During attach, prior to sending the eStateStopped event,
Jim Ingham7fa7b2f2012-04-12 18:49:31 +00002678 // lldb_private::Process subclasses must set the new process ID.
Greg Clayton2d9adb72011-11-12 02:10:56 +00002679 assert (m_process->GetID() != LLDB_INVALID_PROCESS_ID);
2680 if (m_exec_count > 0)
2681 {
2682 --m_exec_count;
Jim Ingham027aaa72012-04-19 01:40:33 +00002683 m_process->PrivateResume ();
Jim Inghamf4928de2012-05-23 15:46:31 +00002684 Process::ProcessEventData::SetRestartedInEvent (event_sp.get(), true);
Greg Clayton2d9adb72011-11-12 02:10:56 +00002685 return eEventActionRetry;
2686 }
2687 else
2688 {
2689 m_process->CompleteAttach ();
2690 return eEventActionSuccess;
2691 }
2692 }
Greg Clayton7e2f91c2011-01-29 07:10:55 +00002693 break;
Greg Clayton2d9adb72011-11-12 02:10:56 +00002694
Greg Clayton7e2f91c2011-01-29 07:10:55 +00002695 default:
2696 case eStateExited:
2697 case eStateInvalid:
Greg Clayton7e2f91c2011-01-29 07:10:55 +00002698 break;
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002699 }
Greg Clayton2d9adb72011-11-12 02:10:56 +00002700
2701 m_exit_string.assign ("No valid Process");
2702 return eEventActionExit;
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002703}
Chris Lattner24943d22010-06-08 16:52:24 +00002704
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002705Process::NextEventAction::EventActionResult
2706Process::AttachCompletionHandler::HandleBeingInterrupted()
2707{
2708 return eEventActionSuccess;
2709}
2710
2711const char *
2712Process::AttachCompletionHandler::GetExitString ()
2713{
2714 return m_exit_string.c_str();
Chris Lattner24943d22010-06-08 16:52:24 +00002715}
2716
2717Error
Greg Clayton527154d2011-11-15 03:53:30 +00002718Process::Attach (ProcessAttachInfo &attach_info)
Chris Lattner24943d22010-06-08 16:52:24 +00002719{
Chris Lattner24943d22010-06-08 16:52:24 +00002720 m_abi_sp.reset();
Caroline Tice861efb32010-11-16 05:07:41 +00002721 m_process_input_reader.reset();
Greg Clayton75c703d2011-02-16 04:46:07 +00002722 m_dyld_ap.reset();
Greg Clayton37f962e2011-08-22 02:49:39 +00002723 m_os_ap.reset();
Jim Ingham7508e732010-08-09 23:31:02 +00002724
Greg Clayton527154d2011-11-15 03:53:30 +00002725 lldb::pid_t attach_pid = attach_info.GetProcessID();
Greg Claytone4b9c1f2011-03-08 22:40:15 +00002726 Error error;
Greg Clayton527154d2011-11-15 03:53:30 +00002727 if (attach_pid == LLDB_INVALID_PROCESS_ID)
Jim Ingham7508e732010-08-09 23:31:02 +00002728 {
Greg Clayton527154d2011-11-15 03:53:30 +00002729 char process_name[PATH_MAX];
Jim Ingham0d7f7772011-09-15 01:10:17 +00002730
Greg Clayton527154d2011-11-15 03:53:30 +00002731 if (attach_info.GetExecutableFile().GetPath (process_name, sizeof(process_name)))
Jim Inghamea294182010-08-17 21:54:19 +00002732 {
Greg Clayton527154d2011-11-15 03:53:30 +00002733 const bool wait_for_launch = attach_info.GetWaitForLaunch();
2734
2735 if (wait_for_launch)
Chris Lattner24943d22010-06-08 16:52:24 +00002736 {
Greg Clayton527154d2011-11-15 03:53:30 +00002737 error = WillAttachToProcessWithName(process_name, wait_for_launch);
2738 if (error.Success())
2739 {
Greg Claytonffa43a62011-11-17 04:46:02 +00002740 m_should_detach = true;
2741
Greg Clayton527154d2011-11-15 03:53:30 +00002742 SetPublicState (eStateAttaching);
Han Ming Ongd1040dd2012-02-25 01:07:38 +00002743 error = DoAttachToProcessWithName (process_name, wait_for_launch, attach_info);
Greg Clayton527154d2011-11-15 03:53:30 +00002744 if (error.Fail())
2745 {
2746 if (GetID() != LLDB_INVALID_PROCESS_ID)
2747 {
2748 SetID (LLDB_INVALID_PROCESS_ID);
2749 if (error.AsCString() == NULL)
2750 error.SetErrorString("attach failed");
2751
2752 SetExitStatus(-1, error.AsCString());
2753 }
2754 }
2755 else
2756 {
2757 SetNextEventAction(new Process::AttachCompletionHandler(this, attach_info.GetResumeCount()));
2758 StartPrivateStateThread();
2759 }
2760 return error;
2761 }
Greg Claytone4b9c1f2011-03-08 22:40:15 +00002762 }
Greg Clayton527154d2011-11-15 03:53:30 +00002763 else
Greg Claytone4b9c1f2011-03-08 22:40:15 +00002764 {
Greg Clayton527154d2011-11-15 03:53:30 +00002765 ProcessInstanceInfoList process_infos;
2766 PlatformSP platform_sp (m_target.GetPlatform ());
2767
2768 if (platform_sp)
2769 {
2770 ProcessInstanceInfoMatch match_info;
2771 match_info.GetProcessInfo() = attach_info;
2772 match_info.SetNameMatchType (eNameMatchEquals);
2773 platform_sp->FindProcesses (match_info, process_infos);
2774 const uint32_t num_matches = process_infos.GetSize();
2775 if (num_matches == 1)
2776 {
2777 attach_pid = process_infos.GetProcessIDAtIndex(0);
2778 // Fall through and attach using the above process ID
2779 }
2780 else
2781 {
2782 match_info.GetProcessInfo().GetExecutableFile().GetPath (process_name, sizeof(process_name));
2783 if (num_matches > 1)
2784 error.SetErrorStringWithFormat ("more than one process named %s", process_name);
2785 else
2786 error.SetErrorStringWithFormat ("could not find a process named %s", process_name);
2787 }
2788 }
2789 else
2790 {
2791 error.SetErrorString ("invalid platform, can't find processes by name");
2792 return error;
2793 }
Greg Claytone4b9c1f2011-03-08 22:40:15 +00002794 }
Chris Lattner24943d22010-06-08 16:52:24 +00002795 }
2796 else
Greg Clayton527154d2011-11-15 03:53:30 +00002797 {
2798 error.SetErrorString ("invalid process name");
Greg Claytone4b9c1f2011-03-08 22:40:15 +00002799 }
2800 }
Greg Clayton527154d2011-11-15 03:53:30 +00002801
2802 if (attach_pid != LLDB_INVALID_PROCESS_ID)
Greg Claytone4b9c1f2011-03-08 22:40:15 +00002803 {
Greg Clayton527154d2011-11-15 03:53:30 +00002804 error = WillAttachToProcessWithID(attach_pid);
Greg Claytone4b9c1f2011-03-08 22:40:15 +00002805 if (error.Success())
Chris Lattner24943d22010-06-08 16:52:24 +00002806 {
Greg Claytonffa43a62011-11-17 04:46:02 +00002807 m_should_detach = true;
Greg Claytone4b9c1f2011-03-08 22:40:15 +00002808 SetPublicState (eStateAttaching);
Greg Clayton527154d2011-11-15 03:53:30 +00002809
Han Ming Ongd1040dd2012-02-25 01:07:38 +00002810 error = DoAttachToProcessWithID (attach_pid, attach_info);
Greg Clayton527154d2011-11-15 03:53:30 +00002811 if (error.Success())
2812 {
2813
2814 SetNextEventAction(new Process::AttachCompletionHandler(this, attach_info.GetResumeCount()));
2815 StartPrivateStateThread();
2816 }
2817 else
Greg Claytone4b9c1f2011-03-08 22:40:15 +00002818 {
2819 if (GetID() != LLDB_INVALID_PROCESS_ID)
2820 {
2821 SetID (LLDB_INVALID_PROCESS_ID);
2822 const char *error_string = error.AsCString();
2823 if (error_string == NULL)
2824 error_string = "attach failed";
2825
2826 SetExitStatus(-1, error_string);
2827 }
2828 }
Chris Lattner24943d22010-06-08 16:52:24 +00002829 }
2830 }
2831 return error;
2832}
2833
Greg Clayton75c703d2011-02-16 04:46:07 +00002834void
2835Process::CompleteAttach ()
2836{
2837 // Let the process subclass figure out at much as it can about the process
2838 // before we go looking for a dynamic loader plug-in.
2839 DidAttach();
2840
Jim Ingham0d7f7772011-09-15 01:10:17 +00002841 // We just attached. If we have a platform, ask it for the process architecture, and if it isn't
2842 // the same as the one we've already set, switch architectures.
2843 PlatformSP platform_sp (m_target.GetPlatform ());
2844 assert (platform_sp.get());
2845 if (platform_sp)
2846 {
Greg Claytonb170aee2012-05-08 01:45:38 +00002847 const ArchSpec &target_arch = m_target.GetArchitecture();
2848 if (target_arch.IsValid() && !platform_sp->IsCompatibleArchitecture (target_arch))
2849 {
2850 ArchSpec platform_arch;
2851 platform_sp = platform_sp->GetPlatformForArchitecture (target_arch, &platform_arch);
2852 if (platform_sp)
2853 {
2854 m_target.SetPlatform (platform_sp);
2855 m_target.SetArchitecture(platform_arch);
2856 }
2857 }
2858 else
2859 {
2860 ProcessInstanceInfo process_info;
2861 platform_sp->GetProcessInfo (GetID(), process_info);
2862 const ArchSpec &process_arch = process_info.GetArchitecture();
2863 if (process_arch.IsValid() && m_target.GetArchitecture() != process_arch)
2864 m_target.SetArchitecture (process_arch);
2865 }
Jim Ingham0d7f7772011-09-15 01:10:17 +00002866 }
2867
2868 // We have completed the attach, now it is time to find the dynamic loader
Greg Clayton75c703d2011-02-16 04:46:07 +00002869 // plug-in
Greg Clayton9ce95382012-02-13 23:10:39 +00002870 DynamicLoader *dyld = GetDynamicLoader ();
2871 if (dyld)
2872 dyld->DidAttach();
Greg Clayton75c703d2011-02-16 04:46:07 +00002873
Greg Clayton37f962e2011-08-22 02:49:39 +00002874 m_os_ap.reset (OperatingSystem::FindPlugin (this, NULL));
Greg Clayton75c703d2011-02-16 04:46:07 +00002875 // Figure out which one is the executable, and set that in our target:
Jim Ingham93367902012-05-30 02:19:25 +00002876 ModuleList &target_modules = m_target.GetImages();
2877 Mutex::Locker modules_locker(target_modules.GetMutex());
2878 size_t num_modules = target_modules.GetSize();
2879 ModuleSP new_executable_module_sp;
Greg Clayton75c703d2011-02-16 04:46:07 +00002880
Greg Clayton75c703d2011-02-16 04:46:07 +00002881 for (int i = 0; i < num_modules; i++)
2882 {
Jim Ingham93367902012-05-30 02:19:25 +00002883 ModuleSP module_sp (target_modules.GetModuleAtIndexUnlocked (i));
Greg Claytonb72d0f02011-04-12 05:54:46 +00002884 if (module_sp && module_sp->IsExecutable())
Greg Clayton75c703d2011-02-16 04:46:07 +00002885 {
Greg Clayton5beb99d2011-08-11 02:48:45 +00002886 if (m_target.GetExecutableModulePointer() != module_sp.get())
Jim Ingham93367902012-05-30 02:19:25 +00002887 new_executable_module_sp = module_sp;
Greg Clayton75c703d2011-02-16 04:46:07 +00002888 break;
2889 }
2890 }
Jim Ingham93367902012-05-30 02:19:25 +00002891 if (new_executable_module_sp)
2892 m_target.SetExecutableModule (new_executable_module_sp, false);
Greg Clayton75c703d2011-02-16 04:46:07 +00002893}
2894
Chris Lattner24943d22010-06-08 16:52:24 +00002895Error
Greg Claytone71e2582011-02-04 01:58:07 +00002896Process::ConnectRemote (const char *remote_url)
2897{
Greg Claytone71e2582011-02-04 01:58:07 +00002898 m_abi_sp.reset();
2899 m_process_input_reader.reset();
2900
2901 // Find the process and its architecture. Make sure it matches the architecture
2902 // of the current Target, and if not adjust it.
2903
2904 Error error (DoConnectRemote (remote_url));
2905 if (error.Success())
2906 {
Greg Claytona2f74232011-02-24 22:24:29 +00002907 if (GetID() != LLDB_INVALID_PROCESS_ID)
2908 {
Greg Clayton24bc5d92011-03-30 18:16:51 +00002909 EventSP event_sp;
2910 StateType state = WaitForProcessStopPrivate(NULL, event_sp);
2911
2912 if (state == eStateStopped || state == eStateCrashed)
2913 {
2914 // If we attached and actually have a process on the other end, then
2915 // this ended up being the equivalent of an attach.
2916 CompleteAttach ();
2917
2918 // This delays passing the stopped event to listeners till
2919 // CompleteAttach gets a chance to complete...
2920 HandlePrivateEvent (event_sp);
2921
2922 }
Greg Claytona2f74232011-02-24 22:24:29 +00002923 }
Greg Clayton24bc5d92011-03-30 18:16:51 +00002924
2925 if (PrivateStateThreadIsValid ())
2926 ResumePrivateStateThread ();
2927 else
2928 StartPrivateStateThread ();
Greg Claytone71e2582011-02-04 01:58:07 +00002929 }
2930 return error;
2931}
2932
2933
2934Error
Jim Ingham027aaa72012-04-19 01:40:33 +00002935Process::PrivateResume ()
Chris Lattner24943d22010-06-08 16:52:24 +00002936{
Greg Claytone005f2c2010-11-06 01:53:30 +00002937 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner24943d22010-06-08 16:52:24 +00002938 if (log)
Jim Inghamac959662011-01-24 06:34:17 +00002939 log->Printf("Process::Resume() m_stop_id = %u, public state: %s private state: %s",
Jim Ingham21f37ad2011-08-09 02:12:22 +00002940 m_mod_id.GetStopID(),
Jim Inghamac959662011-01-24 06:34:17 +00002941 StateAsCString(m_public_state.GetValue()),
2942 StateAsCString(m_private_state.GetValue()));
Chris Lattner24943d22010-06-08 16:52:24 +00002943
2944 Error error (WillResume());
2945 // Tell the process it is about to resume before the thread list
2946 if (error.Success())
2947 {
Johnny Chen9c11d472010-12-02 20:53:05 +00002948 // Now let the thread list know we are about to resume so it
Chris Lattner24943d22010-06-08 16:52:24 +00002949 // can let all of our threads know that they are about to be
2950 // resumed. Threads will each be called with
2951 // Thread::WillResume(StateType) where StateType contains the state
2952 // that they are supposed to have when the process is resumed
2953 // (suspended/running/stepping). Threads should also check
2954 // their resume signal in lldb::Thread::GetResumeSignal()
2955 // to see if they are suppoed to start back up with a signal.
2956 if (m_thread_list.WillResume())
2957 {
Jim Ingham1831e782012-04-07 00:00:41 +00002958 // Last thing, do the PreResumeActions.
2959 if (!RunPreResumeActions())
Chris Lattner24943d22010-06-08 16:52:24 +00002960 {
Jim Ingham1831e782012-04-07 00:00:41 +00002961 error.SetErrorStringWithFormat ("Process::Resume PreResumeActions failed, not resuming.");
2962 }
2963 else
2964 {
2965 m_mod_id.BumpResumeID();
2966 error = DoResume();
2967 if (error.Success())
2968 {
2969 DidResume();
2970 m_thread_list.DidResume();
2971 if (log)
2972 log->Printf ("Process thinks the process has resumed.");
2973 }
Chris Lattner24943d22010-06-08 16:52:24 +00002974 }
2975 }
2976 else
2977 {
Jim Inghamac959662011-01-24 06:34:17 +00002978 error.SetErrorStringWithFormat("Process::WillResume() thread list returned false after WillResume");
Chris Lattner24943d22010-06-08 16:52:24 +00002979 }
2980 }
Jim Inghamac959662011-01-24 06:34:17 +00002981 else if (log)
2982 log->Printf ("Process::WillResume() got an error \"%s\".", error.AsCString("<unknown error>"));
Chris Lattner24943d22010-06-08 16:52:24 +00002983 return error;
2984}
2985
2986Error
2987Process::Halt ()
2988{
Jim Ingham43892562012-06-06 00:29:30 +00002989 // First make sure we aren't in the middle of handling an event, or we might restart. This is pretty weak, since
2990 // we could just straightaway get another event. It just narrows the window...
2991 m_currently_handling_event.WaitForValueEqualTo(false);
2992
2993
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002994 // Pause our private state thread so we can ensure no one else eats
2995 // the stop event out from under us.
Jim Inghamf9f40c22011-02-08 05:20:59 +00002996 Listener halt_listener ("lldb.process.halt_listener");
2997 HijackPrivateProcessEvents(&halt_listener);
Greg Clayton20d338f2010-11-18 05:57:03 +00002998
Jim Inghamc2dc7c82011-01-29 01:49:25 +00002999 EventSP event_sp;
Greg Clayton7e2f91c2011-01-29 07:10:55 +00003000 Error error (WillHalt());
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003001
Greg Clayton7e2f91c2011-01-29 07:10:55 +00003002 if (error.Success())
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003003 {
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003004
Greg Clayton7e2f91c2011-01-29 07:10:55 +00003005 bool caused_stop = false;
3006
3007 // Ask the process subclass to actually halt our process
3008 error = DoHalt(caused_stop);
Chris Lattner24943d22010-06-08 16:52:24 +00003009 if (error.Success())
Jim Ingham3ae449a2010-11-17 02:32:00 +00003010 {
Greg Clayton7e2f91c2011-01-29 07:10:55 +00003011 if (m_public_state.GetValue() == eStateAttaching)
3012 {
3013 SetExitStatus(SIGKILL, "Cancelled async attach.");
3014 Destroy ();
3015 }
3016 else
Jim Ingham3ae449a2010-11-17 02:32:00 +00003017 {
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003018 // If "caused_stop" is true, then DoHalt stopped the process. If
3019 // "caused_stop" is false, the process was already stopped.
3020 // If the DoHalt caused the process to stop, then we want to catch
3021 // this event and set the interrupted bool to true before we pass
3022 // this along so clients know that the process was interrupted by
3023 // a halt command.
3024 if (caused_stop)
Greg Clayton20d338f2010-11-18 05:57:03 +00003025 {
Jim Inghamf9f40c22011-02-08 05:20:59 +00003026 // Wait for 1 second for the process to stop.
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003027 TimeValue timeout_time;
3028 timeout_time = TimeValue::Now();
3029 timeout_time.OffsetWithSeconds(1);
Jim Inghamf9f40c22011-02-08 05:20:59 +00003030 bool got_event = halt_listener.WaitForEvent (&timeout_time, event_sp);
3031 StateType state = ProcessEventData::GetStateFromEvent(event_sp.get());
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003032
Jim Inghamf9f40c22011-02-08 05:20:59 +00003033 if (!got_event || state == eStateInvalid)
Greg Clayton20d338f2010-11-18 05:57:03 +00003034 {
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003035 // We timeout out and didn't get a stop event...
Jim Inghamf9f40c22011-02-08 05:20:59 +00003036 error.SetErrorStringWithFormat ("Halt timed out. State = %s", StateAsCString(GetState()));
Greg Clayton20d338f2010-11-18 05:57:03 +00003037 }
3038 else
3039 {
Greg Clayton20206082011-11-17 01:23:07 +00003040 if (StateIsStoppedState (state, false))
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003041 {
3042 // We caused the process to interrupt itself, so mark this
3043 // as such in the stop event so clients can tell an interrupted
3044 // process from a natural stop
3045 ProcessEventData::SetInterruptedInEvent (event_sp.get(), true);
3046 }
3047 else
3048 {
3049 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3050 if (log)
3051 log->Printf("Process::Halt() failed to stop, state is: %s", StateAsCString(state));
3052 error.SetErrorString ("Did not get stopped event after halt.");
3053 }
Greg Clayton20d338f2010-11-18 05:57:03 +00003054 }
3055 }
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003056 DidHalt();
Jim Ingham3ae449a2010-11-17 02:32:00 +00003057 }
3058 }
Chris Lattner24943d22010-06-08 16:52:24 +00003059 }
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003060 // Resume our private state thread before we post the event (if any)
Jim Inghamf9f40c22011-02-08 05:20:59 +00003061 RestorePrivateProcessEvents();
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003062
3063 // Post any event we might have consumed. If all goes well, we will have
3064 // stopped the process, intercepted the event and set the interrupted
3065 // bool in the event. Post it to the private event queue and that will end up
3066 // correctly setting the state.
3067 if (event_sp)
3068 m_private_state_broadcaster.BroadcastEvent(event_sp);
3069
Chris Lattner24943d22010-06-08 16:52:24 +00003070 return error;
3071}
3072
3073Error
3074Process::Detach ()
3075{
3076 Error error (WillDetach());
3077
3078 if (error.Success())
3079 {
3080 DisableAllBreakpointSites();
3081 error = DoDetach();
3082 if (error.Success())
3083 {
3084 DidDetach();
3085 StopPrivateStateThread();
3086 }
3087 }
3088 return error;
3089}
3090
3091Error
3092Process::Destroy ()
3093{
3094 Error error (WillDestroy());
3095 if (error.Success())
3096 {
Jim Inghamf4928de2012-05-23 15:46:31 +00003097 if (m_public_state.GetValue() == eStateRunning)
3098 {
Jim Ingham43892562012-06-06 00:29:30 +00003099 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_TEMPORARY));
3100 if (log)
3101 log->Printf("Process::Destroy() About to halt.");
Jim Inghamf4928de2012-05-23 15:46:31 +00003102 error = Halt();
3103 if (error.Success())
3104 {
3105 // Consume the halt event.
3106 EventSP stop_event;
3107 TimeValue timeout (TimeValue::Now());
Jim Ingham43892562012-06-06 00:29:30 +00003108 timeout.OffsetWithSeconds(1);
Jim Inghamf4928de2012-05-23 15:46:31 +00003109 StateType state = WaitForProcessToStop (&timeout);
3110 if (state != eStateStopped)
3111 {
Jim Ingham43892562012-06-06 00:29:30 +00003112 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_TEMPORARY));
Jim Inghamf4928de2012-05-23 15:46:31 +00003113 if (log)
3114 log->Printf("Process::Destroy() Halt failed to stop, state is: %s", StateAsCString(state));
Jim Ingham43892562012-06-06 00:29:30 +00003115 // If we really couldn't stop the process then we should just error out here, but if the
3116 // lower levels just bobbled sending the event and we really are stopped, then continue on.
3117 StateType private_state = m_private_state.GetValue();
3118 if (private_state != eStateStopped && private_state != eStateExited)
3119 {
3120 return error;
3121 }
Jim Inghamf4928de2012-05-23 15:46:31 +00003122 }
3123 }
3124 else
3125 {
Jim Ingham43892562012-06-06 00:29:30 +00003126 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_TEMPORARY));
Jim Inghamf4928de2012-05-23 15:46:31 +00003127 if (log)
3128 log->Printf("Process::Destroy() Halt got error: %s", error.AsCString());
Jim Ingham43892562012-06-06 00:29:30 +00003129 return error;
Jim Inghamf4928de2012-05-23 15:46:31 +00003130 }
3131 }
Jim Ingham43892562012-06-06 00:29:30 +00003132
3133 if (m_public_state.GetValue() != eStateRunning)
3134 {
3135 // Ditch all thread plans, and remove all our breakpoints: in case we have to restart the target to
3136 // kill it, we don't want it hitting a breakpoint...
3137 // Only do this if we've stopped, however, since if we didn't manage to halt it above, then
3138 // we're not going to have much luck doing this now.
3139 m_thread_list.DiscardThreadPlans();
3140 DisableAllBreakpointSites();
3141 }
Jim Inghamf4928de2012-05-23 15:46:31 +00003142
Chris Lattner24943d22010-06-08 16:52:24 +00003143 error = DoDestroy();
3144 if (error.Success())
3145 {
3146 DidDestroy();
3147 StopPrivateStateThread();
3148 }
Caroline Tice861efb32010-11-16 05:07:41 +00003149 m_stdio_communication.StopReadThread();
3150 m_stdio_communication.Disconnect();
3151 if (m_process_input_reader && m_process_input_reader->IsActive())
3152 m_target.GetDebugger().PopInputReader (m_process_input_reader);
3153 if (m_process_input_reader)
3154 m_process_input_reader.reset();
Jim Ingham7fa7b2f2012-04-12 18:49:31 +00003155
3156 // If we have been interrupted (to kill us) in the middle of running, we may not end up propagating
3157 // the last events through the event system, in which case we might strand the write lock. Unlock
3158 // it here so when we do to tear down the process we don't get an error destroying the lock.
3159 m_run_lock.WriteUnlock();
Chris Lattner24943d22010-06-08 16:52:24 +00003160 }
3161 return error;
3162}
3163
3164Error
3165Process::Signal (int signal)
3166{
3167 Error error (WillSignal());
3168 if (error.Success())
3169 {
3170 error = DoSignal(signal);
3171 if (error.Success())
3172 DidSignal();
3173 }
3174 return error;
3175}
3176
Greg Clayton395fc332011-02-15 21:59:32 +00003177lldb::ByteOrder
3178Process::GetByteOrder () const
Chris Lattner24943d22010-06-08 16:52:24 +00003179{
Greg Clayton395fc332011-02-15 21:59:32 +00003180 return m_target.GetArchitecture().GetByteOrder();
Chris Lattner24943d22010-06-08 16:52:24 +00003181}
3182
3183uint32_t
Greg Clayton395fc332011-02-15 21:59:32 +00003184Process::GetAddressByteSize () const
Chris Lattner24943d22010-06-08 16:52:24 +00003185{
Greg Clayton395fc332011-02-15 21:59:32 +00003186 return m_target.GetArchitecture().GetAddressByteSize();
Chris Lattner24943d22010-06-08 16:52:24 +00003187}
3188
Greg Clayton395fc332011-02-15 21:59:32 +00003189
Chris Lattner24943d22010-06-08 16:52:24 +00003190bool
3191Process::ShouldBroadcastEvent (Event *event_ptr)
3192{
3193 const StateType state = Process::ProcessEventData::GetStateFromEvent (event_ptr);
3194 bool return_value = true;
Greg Claytone005f2c2010-11-06 01:53:30 +00003195 LogSP log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EVENTS));
Chris Lattner24943d22010-06-08 16:52:24 +00003196
3197 switch (state)
3198 {
Greg Claytone71e2582011-02-04 01:58:07 +00003199 case eStateConnected:
Chris Lattner24943d22010-06-08 16:52:24 +00003200 case eStateAttaching:
3201 case eStateLaunching:
3202 case eStateDetached:
3203 case eStateExited:
3204 case eStateUnloaded:
3205 // These events indicate changes in the state of the debugging session, always report them.
3206 return_value = true;
3207 break;
3208 case eStateInvalid:
3209 // We stopped for no apparent reason, don't report it.
3210 return_value = false;
3211 break;
3212 case eStateRunning:
3213 case eStateStepping:
3214 // If we've started the target running, we handle the cases where we
3215 // are already running and where there is a transition from stopped to
3216 // running differently.
3217 // running -> running: Automatically suppress extra running events
3218 // stopped -> running: Report except when there is one or more no votes
3219 // and no yes votes.
3220 SynchronouslyNotifyStateChanged (state);
3221 switch (m_public_state.GetValue())
3222 {
3223 case eStateRunning:
3224 case eStateStepping:
3225 // We always suppress multiple runnings with no PUBLIC stop in between.
3226 return_value = false;
3227 break;
3228 default:
3229 // TODO: make this work correctly. For now always report
3230 // run if we aren't running so we don't miss any runnning
3231 // events. If I run the lldb/test/thread/a.out file and
3232 // break at main.cpp:58, run and hit the breakpoints on
3233 // multiple threads, then somehow during the stepping over
3234 // of all breakpoints no run gets reported.
Chris Lattner24943d22010-06-08 16:52:24 +00003235
3236 // This is a transition from stop to run.
3237 switch (m_thread_list.ShouldReportRun (event_ptr))
3238 {
Greg Clayton4a379b12012-07-17 03:23:13 +00003239 default:
Chris Lattner24943d22010-06-08 16:52:24 +00003240 case eVoteYes:
3241 case eVoteNoOpinion:
3242 return_value = true;
3243 break;
3244 case eVoteNo:
3245 return_value = false;
3246 break;
3247 }
3248 break;
3249 }
3250 break;
3251 case eStateStopped:
3252 case eStateCrashed:
3253 case eStateSuspended:
3254 {
3255 // We've stopped. First see if we're going to restart the target.
3256 // If we are going to stop, then we always broadcast the event.
3257 // 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 +00003258 // If no thread has an opinion, we don't report it.
Jim Inghamf63f2ba2012-05-16 01:32:14 +00003259
3260 RefreshStateAfterStop ();
Jim Ingham3ae449a2010-11-17 02:32:00 +00003261 if (ProcessEventData::GetInterruptedFromEvent (event_ptr))
Chris Lattner24943d22010-06-08 16:52:24 +00003262 {
Greg Clayton20d338f2010-11-18 05:57:03 +00003263 if (log)
3264 log->Printf ("Process::ShouldBroadcastEvent (%p) stopped due to an interrupt, state: %s", event_ptr, StateAsCString(state));
Jim Ingham3ae449a2010-11-17 02:32:00 +00003265 return true;
3266 }
3267 else
3268 {
Chris Lattner24943d22010-06-08 16:52:24 +00003269
3270 if (m_thread_list.ShouldStop (event_ptr) == false)
3271 {
3272 switch (m_thread_list.ShouldReportStop (event_ptr))
3273 {
3274 case eVoteYes:
3275 Process::ProcessEventData::SetRestartedInEvent (event_ptr, true);
Johnny Chen028784b2010-10-14 00:54:32 +00003276 // Intentional fall-through here.
Chris Lattner24943d22010-06-08 16:52:24 +00003277 case eVoteNoOpinion:
Chris Lattner24943d22010-06-08 16:52:24 +00003278 case eVoteNo:
3279 return_value = false;
3280 break;
3281 }
3282
3283 if (log)
Jim Ingham3ae449a2010-11-17 02:32:00 +00003284 log->Printf ("Process::ShouldBroadcastEvent (%p) Restarting process from state: %s", event_ptr, StateAsCString(state));
Jim Ingham027aaa72012-04-19 01:40:33 +00003285 PrivateResume ();
Chris Lattner24943d22010-06-08 16:52:24 +00003286 }
3287 else
3288 {
3289 return_value = true;
3290 SynchronouslyNotifyStateChanged (state);
3291 }
3292 }
3293 }
3294 }
3295
3296 if (log)
Jason Molenda7e5fa7f2011-09-20 21:44:10 +00003297 log->Printf ("Process::ShouldBroadcastEvent (%p) => %s - %s", event_ptr, StateAsCString(state), return_value ? "YES" : "NO");
Chris Lattner24943d22010-06-08 16:52:24 +00003298 return return_value;
3299}
3300
Chris Lattner24943d22010-06-08 16:52:24 +00003301
3302bool
Jim Ingham1831e782012-04-07 00:00:41 +00003303Process::StartPrivateStateThread (bool force)
Chris Lattner24943d22010-06-08 16:52:24 +00003304{
Greg Claytone005f2c2010-11-06 01:53:30 +00003305 LogSP log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EVENTS));
Chris Lattner24943d22010-06-08 16:52:24 +00003306
Greg Claytonb72d0f02011-04-12 05:54:46 +00003307 bool already_running = PrivateStateThreadIsValid ();
Chris Lattner24943d22010-06-08 16:52:24 +00003308 if (log)
Greg Claytonb72d0f02011-04-12 05:54:46 +00003309 log->Printf ("Process::%s()%s ", __FUNCTION__, already_running ? " already running" : " starting private state thread");
3310
Jim Ingham1831e782012-04-07 00:00:41 +00003311 if (!force && already_running)
Greg Claytonb72d0f02011-04-12 05:54:46 +00003312 return true;
Chris Lattner24943d22010-06-08 16:52:24 +00003313
3314 // Create a thread that watches our internal state and controls which
3315 // events make it to clients (into the DCProcess event queue).
Greg Claytona875b642011-01-09 21:07:35 +00003316 char thread_name[1024];
Jim Ingham1831e782012-04-07 00:00:41 +00003317 if (already_running)
3318 snprintf(thread_name, sizeof(thread_name), "<lldb.process.internal-state-override(pid=%llu)>", GetID());
3319 else
3320 snprintf(thread_name, sizeof(thread_name), "<lldb.process.internal-state(pid=%llu)>", GetID());
Jim Inghamd21d98b2012-04-10 01:21:57 +00003321
3322 // Create the private state thread, and start it running.
Greg Claytona875b642011-01-09 21:07:35 +00003323 m_private_state_thread = Host::ThreadCreate (thread_name, Process::PrivateStateThread, this, NULL);
Jim Inghamd21d98b2012-04-10 01:21:57 +00003324 bool success = IS_VALID_LLDB_HOST_THREAD(m_private_state_thread);
3325 if (success)
3326 {
3327 ResumePrivateStateThread();
3328 return true;
3329 }
3330 else
3331 return false;
Chris Lattner24943d22010-06-08 16:52:24 +00003332}
3333
3334void
3335Process::PausePrivateStateThread ()
3336{
3337 ControlPrivateStateThread (eBroadcastInternalStateControlPause);
3338}
3339
3340void
3341Process::ResumePrivateStateThread ()
3342{
3343 ControlPrivateStateThread (eBroadcastInternalStateControlResume);
3344}
3345
3346void
3347Process::StopPrivateStateThread ()
3348{
Greg Claytonb72d0f02011-04-12 05:54:46 +00003349 if (PrivateStateThreadIsValid ())
3350 ControlPrivateStateThread (eBroadcastInternalStateControlStop);
Jim Ingham7fa7b2f2012-04-12 18:49:31 +00003351 else
3352 {
3353 LogSP log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_PROCESS));
3354 if (log)
3355 printf ("Went to stop the private state thread, but it was already invalid.");
3356 }
Chris Lattner24943d22010-06-08 16:52:24 +00003357}
3358
3359void
3360Process::ControlPrivateStateThread (uint32_t signal)
3361{
Jim Ingham7fa7b2f2012-04-12 18:49:31 +00003362 LogSP log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_PROCESS));
Chris Lattner24943d22010-06-08 16:52:24 +00003363
3364 assert (signal == eBroadcastInternalStateControlStop ||
3365 signal == eBroadcastInternalStateControlPause ||
3366 signal == eBroadcastInternalStateControlResume);
3367
3368 if (log)
Greg Claytonf4fbc0b2011-01-22 17:43:17 +00003369 log->Printf ("Process::%s (signal = %d)", __FUNCTION__, signal);
Chris Lattner24943d22010-06-08 16:52:24 +00003370
Greg Claytonf4fbc0b2011-01-22 17:43:17 +00003371 // Signal the private state thread. First we should copy this is case the
3372 // thread starts exiting since the private state thread will NULL this out
3373 // when it exits
3374 const lldb::thread_t private_state_thread = m_private_state_thread;
Greg Clayton09c81ef2011-02-08 01:34:25 +00003375 if (IS_VALID_LLDB_HOST_THREAD(private_state_thread))
Chris Lattner24943d22010-06-08 16:52:24 +00003376 {
3377 TimeValue timeout_time;
3378 bool timed_out;
3379
3380 m_private_state_control_broadcaster.BroadcastEvent (signal, NULL);
3381
3382 timeout_time = TimeValue::Now();
3383 timeout_time.OffsetWithSeconds(2);
Jim Ingham7fa7b2f2012-04-12 18:49:31 +00003384 if (log)
3385 log->Printf ("Sending control event of type: %d.", signal);
Chris Lattner24943d22010-06-08 16:52:24 +00003386 m_private_state_control_wait.WaitForValueEqualTo (true, &timeout_time, &timed_out);
3387 m_private_state_control_wait.SetValue (false, eBroadcastNever);
3388
3389 if (signal == eBroadcastInternalStateControlStop)
3390 {
3391 if (timed_out)
Jim Ingham7fa7b2f2012-04-12 18:49:31 +00003392 {
3393 Error error;
3394 Host::ThreadCancel (private_state_thread, &error);
3395 if (log)
3396 log->Printf ("Timed out responding to the control event, cancel got error: \"%s\".", error.AsCString());
3397 }
3398 else
3399 {
3400 if (log)
3401 log->Printf ("The control event killed the private state thread without having to cancel.");
3402 }
Chris Lattner24943d22010-06-08 16:52:24 +00003403
3404 thread_result_t result = NULL;
Greg Claytonf4fbc0b2011-01-22 17:43:17 +00003405 Host::ThreadJoin (private_state_thread, &result, NULL);
Greg Claytonc607d862010-07-22 18:34:21 +00003406 m_private_state_thread = LLDB_INVALID_HOST_THREAD;
Chris Lattner24943d22010-06-08 16:52:24 +00003407 }
3408 }
Jim Ingham7fa7b2f2012-04-12 18:49:31 +00003409 else
3410 {
3411 if (log)
3412 log->Printf ("Private state thread already dead, no need to signal it to stop.");
3413 }
Chris Lattner24943d22010-06-08 16:52:24 +00003414}
3415
3416void
Jim Ingham5d90ade2012-07-27 23:57:19 +00003417Process::SendAsyncInterrupt ()
3418{
3419 if (PrivateStateThreadIsValid())
3420 m_private_state_broadcaster.BroadcastEvent (Process::eBroadcastBitInterrupt, NULL);
3421 else
3422 BroadcastEvent (Process::eBroadcastBitInterrupt, NULL);
3423}
3424
3425void
Chris Lattner24943d22010-06-08 16:52:24 +00003426Process::HandlePrivateEvent (EventSP &event_sp)
3427{
Greg Claytone005f2c2010-11-06 01:53:30 +00003428 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Jim Ingham43892562012-06-06 00:29:30 +00003429 m_currently_handling_event.SetValue(true, eBroadcastNever);
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003430
Greg Clayton68ca8232011-01-25 02:58:48 +00003431 const StateType new_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003432
3433 // First check to see if anybody wants a shot at this event:
Jim Ingham68bffc52011-01-29 04:05:41 +00003434 if (m_next_event_action_ap.get() != NULL)
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003435 {
Jim Ingham68bffc52011-01-29 04:05:41 +00003436 NextEventAction::EventActionResult action_result = m_next_event_action_ap->PerformAction(event_sp);
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003437 switch (action_result)
3438 {
3439 case NextEventAction::eEventActionSuccess:
3440 SetNextEventAction(NULL);
3441 break;
Greg Clayton2d9adb72011-11-12 02:10:56 +00003442
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003443 case NextEventAction::eEventActionRetry:
3444 break;
Greg Clayton2d9adb72011-11-12 02:10:56 +00003445
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003446 case NextEventAction::eEventActionExit:
Jim Ingham84c86382011-01-29 01:57:31 +00003447 // Handle Exiting Here. If we already got an exited event,
3448 // we should just propagate it. Otherwise, swallow this event,
3449 // and set our state to exit so the next event will kill us.
3450 if (new_state != eStateExited)
3451 {
3452 // FIXME: should cons up an exited event, and discard this one.
Jim Ingham68bffc52011-01-29 04:05:41 +00003453 SetExitStatus(0, m_next_event_action_ap->GetExitString());
Jim Ingham84c86382011-01-29 01:57:31 +00003454 SetNextEventAction(NULL);
3455 return;
3456 }
3457 SetNextEventAction(NULL);
Jim Inghamc2dc7c82011-01-29 01:49:25 +00003458 break;
3459 }
3460 }
3461
Chris Lattner24943d22010-06-08 16:52:24 +00003462 // See if we should broadcast this state to external clients?
3463 const bool should_broadcast = ShouldBroadcastEvent (event_sp.get());
Chris Lattner24943d22010-06-08 16:52:24 +00003464
3465 if (should_broadcast)
3466 {
3467 if (log)
3468 {
Greg Clayton444e35b2011-10-19 18:09:39 +00003469 log->Printf ("Process::%s (pid = %llu) broadcasting new state %s (old state %s) to %s",
Greg Clayton68ca8232011-01-25 02:58:48 +00003470 __FUNCTION__,
3471 GetID(),
3472 StateAsCString(new_state),
3473 StateAsCString (GetState ()),
3474 IsHijackedForEvent(eBroadcastBitStateChanged) ? "hijacked" : "public");
Chris Lattner24943d22010-06-08 16:52:24 +00003475 }
Jim Inghamd60d94a2011-03-11 03:53:59 +00003476 Process::ProcessEventData::SetUpdateStateOnRemoval(event_sp.get());
Greg Clayton68ca8232011-01-25 02:58:48 +00003477 if (StateIsRunningState (new_state))
Caroline Tice861efb32010-11-16 05:07:41 +00003478 PushProcessInputReader ();
3479 else
3480 PopProcessInputReader ();
Jim Inghamd60d94a2011-03-11 03:53:59 +00003481
Chris Lattner24943d22010-06-08 16:52:24 +00003482 BroadcastEvent (event_sp);
3483 }
3484 else
3485 {
3486 if (log)
3487 {
Greg Clayton444e35b2011-10-19 18:09:39 +00003488 log->Printf ("Process::%s (pid = %llu) suppressing state %s (old state %s): should_broadcast == false",
Greg Clayton68ca8232011-01-25 02:58:48 +00003489 __FUNCTION__,
3490 GetID(),
3491 StateAsCString(new_state),
Jason Molenda7e5fa7f2011-09-20 21:44:10 +00003492 StateAsCString (GetState ()));
Chris Lattner24943d22010-06-08 16:52:24 +00003493 }
3494 }
Jim Ingham43892562012-06-06 00:29:30 +00003495 m_currently_handling_event.SetValue(false, eBroadcastAlways);
Chris Lattner24943d22010-06-08 16:52:24 +00003496}
3497
3498void *
3499Process::PrivateStateThread (void *arg)
3500{
3501 Process *proc = static_cast<Process*> (arg);
3502 void *result = proc->RunPrivateStateThread ();
Chris Lattner24943d22010-06-08 16:52:24 +00003503 return result;
3504}
3505
3506void *
3507Process::RunPrivateStateThread ()
3508{
Jim Inghamd21d98b2012-04-10 01:21:57 +00003509 bool control_only = true;
Jim Ingham7fa7b2f2012-04-12 18:49:31 +00003510 m_private_state_control_wait.SetValue (false, eBroadcastNever);
Chris Lattner24943d22010-06-08 16:52:24 +00003511
Greg Claytone005f2c2010-11-06 01:53:30 +00003512 LogSP log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner24943d22010-06-08 16:52:24 +00003513 if (log)
Greg Clayton444e35b2011-10-19 18:09:39 +00003514 log->Printf ("Process::%s (arg = %p, pid = %llu) thread starting...", __FUNCTION__, this, GetID());
Chris Lattner24943d22010-06-08 16:52:24 +00003515
3516 bool exit_now = false;
3517 while (!exit_now)
3518 {
3519 EventSP event_sp;
3520 WaitForEventsPrivate (NULL, event_sp, control_only);
3521 if (event_sp->BroadcasterIs(&m_private_state_control_broadcaster))
3522 {
Jim Ingham7fa7b2f2012-04-12 18:49:31 +00003523 if (log)
3524 log->Printf ("Process::%s (arg = %p, pid = %llu) got a control event: %d", __FUNCTION__, this, GetID(), event_sp->GetType());
3525
Chris Lattner24943d22010-06-08 16:52:24 +00003526 switch (event_sp->GetType())
3527 {
3528 case eBroadcastInternalStateControlStop:
3529 exit_now = true;
Chris Lattner24943d22010-06-08 16:52:24 +00003530 break; // doing any internal state managment below
3531
3532 case eBroadcastInternalStateControlPause:
3533 control_only = true;
3534 break;
3535
3536 case eBroadcastInternalStateControlResume:
3537 control_only = false;
3538 break;
3539 }
Jim Ingham3ae449a2010-11-17 02:32:00 +00003540
Chris Lattner24943d22010-06-08 16:52:24 +00003541 m_private_state_control_wait.SetValue (true, eBroadcastAlways);
Jim Ingham3ae449a2010-11-17 02:32:00 +00003542 continue;
Chris Lattner24943d22010-06-08 16:52:24 +00003543 }
Jim Ingham5d90ade2012-07-27 23:57:19 +00003544 else if (event_sp->GetType() == eBroadcastBitInterrupt)
3545 {
3546 if (m_public_state.GetValue() == eStateAttaching)
3547 {
3548 if (log)
3549 log->Printf ("Process::%s (arg = %p, pid = %llu) woke up with an interrupt while attaching - forwarding interrupt.", __FUNCTION__, this, GetID());
3550 BroadcastEvent (eBroadcastBitInterrupt, NULL);
3551 }
3552 else
3553 {
3554 if (log)
3555 log->Printf ("Process::%s (arg = %p, pid = %llu) woke up with an interrupt - Halting.", __FUNCTION__, this, GetID());
3556 Halt();
3557 }
3558 continue;
3559 }
Chris Lattner24943d22010-06-08 16:52:24 +00003560
3561 const StateType internal_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
3562
3563 if (internal_state != eStateInvalid)
3564 {
3565 HandlePrivateEvent (event_sp);
3566 }
3567
Greg Clayton3b2c41c2010-10-18 04:14:23 +00003568 if (internal_state == eStateInvalid ||
3569 internal_state == eStateExited ||
3570 internal_state == eStateDetached )
Jim Ingham3ae449a2010-11-17 02:32:00 +00003571 {
Jim Ingham3ae449a2010-11-17 02:32:00 +00003572 if (log)
Greg Clayton444e35b2011-10-19 18:09:39 +00003573 log->Printf ("Process::%s (arg = %p, pid = %llu) about to exit with internal state %s...", __FUNCTION__, this, GetID(), StateAsCString(internal_state));
Jim Ingham3ae449a2010-11-17 02:32:00 +00003574
Chris Lattner24943d22010-06-08 16:52:24 +00003575 break;
Jim Ingham3ae449a2010-11-17 02:32:00 +00003576 }
Chris Lattner24943d22010-06-08 16:52:24 +00003577 }
3578
Caroline Tice926060e2010-10-29 21:48:37 +00003579 // Verify log is still enabled before attempting to write to it...
Chris Lattner24943d22010-06-08 16:52:24 +00003580 if (log)
Greg Clayton444e35b2011-10-19 18:09:39 +00003581 log->Printf ("Process::%s (arg = %p, pid = %llu) thread exiting...", __FUNCTION__, this, GetID());
Chris Lattner24943d22010-06-08 16:52:24 +00003582
Greg Claytona4881d02011-01-22 07:12:45 +00003583 m_private_state_control_wait.SetValue (true, eBroadcastAlways);
3584 m_private_state_thread = LLDB_INVALID_HOST_THREAD;
Chris Lattner24943d22010-06-08 16:52:24 +00003585 return NULL;
3586}
3587
Chris Lattner24943d22010-06-08 16:52:24 +00003588//------------------------------------------------------------------
3589// Process Event Data
3590//------------------------------------------------------------------
3591
3592Process::ProcessEventData::ProcessEventData () :
3593 EventData (),
3594 m_process_sp (),
3595 m_state (eStateInvalid),
Greg Clayton54e7afa2010-07-09 20:39:50 +00003596 m_restarted (false),
Jim Ingham6cf4d2b2011-05-22 21:45:01 +00003597 m_update_state (0),
Jim Ingham3ae449a2010-11-17 02:32:00 +00003598 m_interrupted (false)
Chris Lattner24943d22010-06-08 16:52:24 +00003599{
3600}
3601
3602Process::ProcessEventData::ProcessEventData (const ProcessSP &process_sp, StateType state) :
3603 EventData (),
3604 m_process_sp (process_sp),
3605 m_state (state),
Greg Clayton54e7afa2010-07-09 20:39:50 +00003606 m_restarted (false),
Jim Ingham6cf4d2b2011-05-22 21:45:01 +00003607 m_update_state (0),
Jim Ingham3ae449a2010-11-17 02:32:00 +00003608 m_interrupted (false)
Chris Lattner24943d22010-06-08 16:52:24 +00003609{
3610}
3611
3612Process::ProcessEventData::~ProcessEventData()
3613{
3614}
3615
3616const ConstString &
3617Process::ProcessEventData::GetFlavorString ()
3618{
3619 static ConstString g_flavor ("Process::ProcessEventData");
3620 return g_flavor;
3621}
3622
3623const ConstString &
3624Process::ProcessEventData::GetFlavor () const
3625{
3626 return ProcessEventData::GetFlavorString ();
3627}
3628
Chris Lattner24943d22010-06-08 16:52:24 +00003629void
3630Process::ProcessEventData::DoOnRemoval (Event *event_ptr)
3631{
3632 // This function gets called twice for each event, once when the event gets pulled
Jim Ingham6cf4d2b2011-05-22 21:45:01 +00003633 // off of the private process event queue, and then any number of times, first when it gets pulled off of
3634 // the public event queue, then other times when we're pretending that this is where we stopped at the
3635 // end of expression evaluation. m_update_state is used to distinguish these
3636 // three cases; it is 0 when we're just pulling it off for private handling,
3637 // and > 1 for expression evaluation, and we don't want to do the breakpoint command handling then.
Chris Lattner24943d22010-06-08 16:52:24 +00003638
Jim Ingham6cf4d2b2011-05-22 21:45:01 +00003639 if (m_update_state != 1)
Chris Lattner24943d22010-06-08 16:52:24 +00003640 return;
3641
3642 m_process_sp->SetPublicState (m_state);
3643
3644 // If we're stopped and haven't restarted, then do the breakpoint commands here:
3645 if (m_state == eStateStopped && ! m_restarted)
Jim Ingham0296fe72011-11-08 03:00:11 +00003646 {
3647 ThreadList &curr_thread_list = m_process_sp->GetThreadList();
Greg Claytond9919d32011-12-01 23:28:38 +00003648 uint32_t num_threads = curr_thread_list.GetSize();
3649 uint32_t idx;
Greg Clayton643ee732010-08-04 01:40:35 +00003650
Jim Ingham21f37ad2011-08-09 02:12:22 +00003651 // The actions might change one of the thread's stop_info's opinions about whether we should
3652 // stop the process, so we need to query that as we go.
Jim Ingham0296fe72011-11-08 03:00:11 +00003653
3654 // One other complication here, is that we try to catch any case where the target has run (except for expressions)
3655 // and immediately exit, but if we get that wrong (which is possible) then the thread list might have changed, and
3656 // that would cause our iteration here to crash. We could make a copy of the thread list, but we'd really like
3657 // 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
3658 // against this list & bag out if anything differs.
Greg Claytond9919d32011-12-01 23:28:38 +00003659 std::vector<uint32_t> thread_index_array(num_threads);
Jim Ingham0296fe72011-11-08 03:00:11 +00003660 for (idx = 0; idx < num_threads; ++idx)
3661 thread_index_array[idx] = curr_thread_list.GetThreadAtIndex(idx)->GetIndexID();
3662
Jim Ingham21f37ad2011-08-09 02:12:22 +00003663 bool still_should_stop = true;
3664
Chris Lattner24943d22010-06-08 16:52:24 +00003665 for (idx = 0; idx < num_threads; ++idx)
3666 {
Jim Ingham0296fe72011-11-08 03:00:11 +00003667 curr_thread_list = m_process_sp->GetThreadList();
3668 if (curr_thread_list.GetSize() != num_threads)
3669 {
3670 lldb::LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STEP | LIBLLDB_LOG_PROCESS));
Jim Ingham60526c42011-12-01 20:26:15 +00003671 if (log)
Greg Claytond9919d32011-12-01 23:28:38 +00003672 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 +00003673 break;
3674 }
3675
3676 lldb::ThreadSP thread_sp = curr_thread_list.GetThreadAtIndex(idx);
3677
3678 if (thread_sp->GetIndexID() != thread_index_array[idx])
3679 {
3680 lldb::LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STEP | LIBLLDB_LOG_PROCESS));
Jim Ingham60526c42011-12-01 20:26:15 +00003681 if (log)
Greg Claytond9919d32011-12-01 23:28:38 +00003682 log->Printf("The thread at position %u changed from %u to %u while processing event.",
Jim Ingham60526c42011-12-01 20:26:15 +00003683 idx,
3684 thread_index_array[idx],
3685 thread_sp->GetIndexID());
Jim Ingham0296fe72011-11-08 03:00:11 +00003686 break;
3687 }
3688
Jim Ingham6297a3a2010-10-20 00:39:53 +00003689 StopInfoSP stop_info_sp = thread_sp->GetStopInfo ();
3690 if (stop_info_sp)
Chris Lattner24943d22010-06-08 16:52:24 +00003691 {
Jim Ingham6297a3a2010-10-20 00:39:53 +00003692 stop_info_sp->PerformAction(event_ptr);
Jim Ingham21f37ad2011-08-09 02:12:22 +00003693 // The stop action might restart the target. If it does, then we want to mark that in the
3694 // event so that whoever is receiving it will know to wait for the running event and reflect
3695 // that state appropriately.
3696 // We also need to stop processing actions, since they aren't expecting the target to be running.
Jim Ingham0296fe72011-11-08 03:00:11 +00003697
3698 // FIXME: we might have run.
3699 if (stop_info_sp->HasTargetRunSinceMe())
Jim Ingham21f37ad2011-08-09 02:12:22 +00003700 {
3701 SetRestarted (true);
3702 break;
3703 }
3704 else if (!stop_info_sp->ShouldStop(event_ptr))
3705 {
3706 still_should_stop = false;
3707 }
Chris Lattner24943d22010-06-08 16:52:24 +00003708 }
3709 }
Jim Ingham6fb8baa2010-08-10 00:59:59 +00003710
Jim Ingham21f37ad2011-08-09 02:12:22 +00003711
3712 if (m_process_sp->GetPrivateState() != eStateRunning)
Jim Inghamd60d94a2011-03-11 03:53:59 +00003713 {
Jim Ingham21f37ad2011-08-09 02:12:22 +00003714 if (!still_should_stop)
3715 {
3716 // We've been asked to continue, so do that here.
Jim Inghamd60d94a2011-03-11 03:53:59 +00003717 SetRestarted(true);
Jim Ingham027aaa72012-04-19 01:40:33 +00003718 // Use the public resume method here, since this is just
3719 // extending a public resume.
Jim Ingham21f37ad2011-08-09 02:12:22 +00003720 m_process_sp->Resume();
3721 }
3722 else
3723 {
3724 // If we didn't restart, run the Stop Hooks here:
3725 // They might also restart the target, so watch for that.
3726 m_process_sp->GetTarget().RunStopHooks();
3727 if (m_process_sp->GetPrivateState() == eStateRunning)
3728 SetRestarted(true);
3729 }
Jim Inghamd60d94a2011-03-11 03:53:59 +00003730 }
3731
Chris Lattner24943d22010-06-08 16:52:24 +00003732 }
3733}
3734
3735void
3736Process::ProcessEventData::Dump (Stream *s) const
3737{
3738 if (m_process_sp)
Greg Clayton444e35b2011-10-19 18:09:39 +00003739 s->Printf(" process = %p (pid = %llu), ", m_process_sp.get(), m_process_sp->GetID());
Chris Lattner24943d22010-06-08 16:52:24 +00003740
Greg Claytonb72d0f02011-04-12 05:54:46 +00003741 s->Printf("state = %s", StateAsCString(GetState()));
Chris Lattner24943d22010-06-08 16:52:24 +00003742}
3743
3744const Process::ProcessEventData *
3745Process::ProcessEventData::GetEventDataFromEvent (const Event *event_ptr)
3746{
3747 if (event_ptr)
3748 {
3749 const EventData *event_data = event_ptr->GetData();
3750 if (event_data && event_data->GetFlavor() == ProcessEventData::GetFlavorString())
3751 return static_cast <const ProcessEventData *> (event_ptr->GetData());
3752 }
3753 return NULL;
3754}
3755
3756ProcessSP
3757Process::ProcessEventData::GetProcessFromEvent (const Event *event_ptr)
3758{
3759 ProcessSP process_sp;
3760 const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
3761 if (data)
3762 process_sp = data->GetProcessSP();
3763 return process_sp;
3764}
3765
3766StateType
3767Process::ProcessEventData::GetStateFromEvent (const Event *event_ptr)
3768{
3769 const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
3770 if (data == NULL)
3771 return eStateInvalid;
3772 else
3773 return data->GetState();
3774}
3775
3776bool
3777Process::ProcessEventData::GetRestartedFromEvent (const Event *event_ptr)
3778{
3779 const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
3780 if (data == NULL)
3781 return false;
3782 else
3783 return data->GetRestarted();
3784}
3785
3786void
3787Process::ProcessEventData::SetRestartedInEvent (Event *event_ptr, bool new_value)
3788{
3789 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
3790 if (data != NULL)
3791 data->SetRestarted(new_value);
3792}
3793
3794bool
Jim Ingham3ae449a2010-11-17 02:32:00 +00003795Process::ProcessEventData::GetInterruptedFromEvent (const Event *event_ptr)
3796{
3797 const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
3798 if (data == NULL)
3799 return false;
3800 else
3801 return data->GetInterrupted ();
3802}
3803
3804void
3805Process::ProcessEventData::SetInterruptedInEvent (Event *event_ptr, bool new_value)
3806{
3807 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
3808 if (data != NULL)
3809 data->SetInterrupted(new_value);
3810}
3811
3812bool
Chris Lattner24943d22010-06-08 16:52:24 +00003813Process::ProcessEventData::SetUpdateStateOnRemoval (Event *event_ptr)
3814{
3815 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
3816 if (data)
3817 {
3818 data->SetUpdateStateOnRemoval();
3819 return true;
3820 }
3821 return false;
3822}
3823
Greg Clayton289afcb2012-02-18 05:35:26 +00003824lldb::TargetSP
3825Process::CalculateTarget ()
3826{
3827 return m_target.shared_from_this();
3828}
3829
Chris Lattner24943d22010-06-08 16:52:24 +00003830void
Greg Claytona830adb2010-10-04 01:05:56 +00003831Process::CalculateExecutionContext (ExecutionContext &exe_ctx)
Chris Lattner24943d22010-06-08 16:52:24 +00003832{
Greg Clayton567e7f32011-09-22 04:58:26 +00003833 exe_ctx.SetTargetPtr (&m_target);
3834 exe_ctx.SetProcessPtr (this);
3835 exe_ctx.SetThreadPtr(NULL);
3836 exe_ctx.SetFramePtr (NULL);
Chris Lattner24943d22010-06-08 16:52:24 +00003837}
3838
Greg Claytone4b9c1f2011-03-08 22:40:15 +00003839//uint32_t
3840//Process::ListProcessesMatchingName (const char *name, StringList &matches, std::vector<lldb::pid_t> &pids)
3841//{
3842// return 0;
3843//}
3844//
3845//ArchSpec
3846//Process::GetArchSpecForExistingProcess (lldb::pid_t pid)
3847//{
3848// return Host::GetArchSpecForExistingProcess (pid);
3849//}
3850//
3851//ArchSpec
3852//Process::GetArchSpecForExistingProcess (const char *process_name)
3853//{
3854// return Host::GetArchSpecForExistingProcess (process_name);
3855//}
3856//
Caroline Tice861efb32010-11-16 05:07:41 +00003857void
3858Process::AppendSTDOUT (const char * s, size_t len)
3859{
Greg Clayton20d338f2010-11-18 05:57:03 +00003860 Mutex::Locker locker (m_stdio_communication_mutex);
Caroline Tice861efb32010-11-16 05:07:41 +00003861 m_stdout_data.append (s, len);
Greg Claytonb3781332010-12-05 19:16:56 +00003862 BroadcastEventIfUnique (eBroadcastBitSTDOUT, new ProcessEventData (GetTarget().GetProcessSP(), GetState()));
Caroline Tice861efb32010-11-16 05:07:41 +00003863}
3864
3865void
Greg Claytonbd06ff42011-11-13 04:45:22 +00003866Process::AppendSTDERR (const char * s, size_t len)
3867{
3868 Mutex::Locker locker (m_stdio_communication_mutex);
3869 m_stderr_data.append (s, len);
3870 BroadcastEventIfUnique (eBroadcastBitSTDERR, new ProcessEventData (GetTarget().GetProcessSP(), GetState()));
3871}
3872
3873//------------------------------------------------------------------
3874// Process STDIO
3875//------------------------------------------------------------------
3876
3877size_t
3878Process::GetSTDOUT (char *buf, size_t buf_size, Error &error)
3879{
3880 Mutex::Locker locker(m_stdio_communication_mutex);
3881 size_t bytes_available = m_stdout_data.size();
3882 if (bytes_available > 0)
3883 {
3884 LogSP log (lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3885 if (log)
3886 log->Printf ("Process::GetSTDOUT (buf = %p, size = %zu)", buf, buf_size);
3887 if (bytes_available > buf_size)
3888 {
3889 memcpy(buf, m_stdout_data.c_str(), buf_size);
3890 m_stdout_data.erase(0, buf_size);
3891 bytes_available = buf_size;
3892 }
3893 else
3894 {
3895 memcpy(buf, m_stdout_data.c_str(), bytes_available);
3896 m_stdout_data.clear();
3897 }
3898 }
3899 return bytes_available;
3900}
3901
3902
3903size_t
3904Process::GetSTDERR (char *buf, size_t buf_size, Error &error)
3905{
3906 Mutex::Locker locker(m_stdio_communication_mutex);
3907 size_t bytes_available = m_stderr_data.size();
3908 if (bytes_available > 0)
3909 {
3910 LogSP log (lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3911 if (log)
3912 log->Printf ("Process::GetSTDERR (buf = %p, size = %zu)", buf, buf_size);
3913 if (bytes_available > buf_size)
3914 {
3915 memcpy(buf, m_stderr_data.c_str(), buf_size);
3916 m_stderr_data.erase(0, buf_size);
3917 bytes_available = buf_size;
3918 }
3919 else
3920 {
3921 memcpy(buf, m_stderr_data.c_str(), bytes_available);
3922 m_stderr_data.clear();
3923 }
3924 }
3925 return bytes_available;
3926}
3927
3928void
Caroline Tice861efb32010-11-16 05:07:41 +00003929Process::STDIOReadThreadBytesReceived (void *baton, const void *src, size_t src_len)
3930{
3931 Process *process = (Process *) baton;
3932 process->AppendSTDOUT (static_cast<const char *>(src), src_len);
3933}
3934
3935size_t
3936Process::ProcessInputReaderCallback (void *baton,
3937 InputReader &reader,
3938 lldb::InputReaderAction notification,
3939 const char *bytes,
3940 size_t bytes_len)
3941{
3942 Process *process = (Process *) baton;
3943
3944 switch (notification)
3945 {
3946 case eInputReaderActivate:
3947 break;
3948
3949 case eInputReaderDeactivate:
3950 break;
3951
3952 case eInputReaderReactivate:
3953 break;
3954
Caroline Tice4a348082011-05-02 20:41:46 +00003955 case eInputReaderAsynchronousOutputWritten:
3956 break;
3957
Caroline Tice861efb32010-11-16 05:07:41 +00003958 case eInputReaderGotToken:
3959 {
3960 Error error;
3961 process->PutSTDIN (bytes, bytes_len, error);
3962 }
3963 break;
3964
Caroline Ticec4f55fe2010-11-19 20:47:54 +00003965 case eInputReaderInterrupt:
3966 process->Halt ();
3967 break;
3968
3969 case eInputReaderEndOfFile:
3970 process->AppendSTDOUT ("^D", 2);
3971 break;
3972
Caroline Tice861efb32010-11-16 05:07:41 +00003973 case eInputReaderDone:
3974 break;
3975
3976 }
3977
3978 return bytes_len;
3979}
3980
3981void
3982Process::ResetProcessInputReader ()
3983{
3984 m_process_input_reader.reset();
3985}
3986
3987void
Greg Clayton464c6162011-11-17 22:14:31 +00003988Process::SetSTDIOFileDescriptor (int file_descriptor)
Caroline Tice861efb32010-11-16 05:07:41 +00003989{
3990 // First set up the Read Thread for reading/handling process I/O
3991
3992 std::auto_ptr<ConnectionFileDescriptor> conn_ap (new ConnectionFileDescriptor (file_descriptor, true));
3993
3994 if (conn_ap.get())
3995 {
3996 m_stdio_communication.SetConnection (conn_ap.release());
3997 if (m_stdio_communication.IsConnected())
3998 {
3999 m_stdio_communication.SetReadThreadBytesReceivedCallback (STDIOReadThreadBytesReceived, this);
4000 m_stdio_communication.StartReadThread();
4001
4002 // Now read thread is set up, set up input reader.
4003
4004 if (!m_process_input_reader.get())
4005 {
4006 m_process_input_reader.reset (new InputReader(m_target.GetDebugger()));
4007 Error err (m_process_input_reader->Initialize (Process::ProcessInputReaderCallback,
4008 this,
4009 eInputReaderGranularityByte,
4010 NULL,
4011 NULL,
4012 false));
4013
4014 if (err.Fail())
4015 m_process_input_reader.reset();
4016 }
4017 }
4018 }
4019}
4020
4021void
4022Process::PushProcessInputReader ()
4023{
4024 if (m_process_input_reader && !m_process_input_reader->IsActive())
4025 m_target.GetDebugger().PushInputReader (m_process_input_reader);
4026}
4027
4028void
4029Process::PopProcessInputReader ()
4030{
4031 if (m_process_input_reader && m_process_input_reader->IsActive())
4032 m_target.GetDebugger().PopInputReader (m_process_input_reader);
4033}
4034
Greg Claytond284b662011-02-18 01:44:25 +00004035// The process needs to know about installed plug-ins
Greg Clayton990de7b2010-11-18 23:32:35 +00004036void
Caroline Tice2a456812011-03-10 22:14:10 +00004037Process::SettingsInitialize ()
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00004038{
Greg Clayton73844aa2012-08-22 17:17:09 +00004039// static std::vector<OptionEnumValueElement> g_plugins;
4040//
4041// int i=0;
4042// const char *name;
4043// OptionEnumValueElement option_enum;
4044// while ((name = PluginManager::GetProcessPluginNameAtIndex (i)) != NULL)
4045// {
4046// if (name)
4047// {
4048// option_enum.value = i;
4049// option_enum.string_value = name;
4050// option_enum.usage = PluginManager::GetProcessPluginDescriptionAtIndex (i);
4051// g_plugins.push_back (option_enum);
4052// }
4053// ++i;
4054// }
4055// option_enum.value = 0;
4056// option_enum.string_value = NULL;
4057// option_enum.usage = NULL;
4058// g_plugins.push_back (option_enum);
4059//
4060// for (i=0; (name = SettingsController::instance_settings_table[i].var_name); ++i)
4061// {
4062// if (::strcmp (name, "plugin") == 0)
4063// {
4064// SettingsController::instance_settings_table[i].enum_values = &g_plugins[0];
4065// break;
4066// }
4067// }
Greg Clayton73844aa2012-08-22 17:17:09 +00004068//
Greg Claytonc6e82e42012-08-22 18:39:03 +00004069 Thread::SettingsInitialize ();
Greg Clayton990de7b2010-11-18 23:32:35 +00004070}
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00004071
Greg Clayton990de7b2010-11-18 23:32:35 +00004072void
Caroline Tice2a456812011-03-10 22:14:10 +00004073Process::SettingsTerminate ()
Greg Claytond284b662011-02-18 01:44:25 +00004074{
Greg Claytonc6e82e42012-08-22 18:39:03 +00004075 Thread::SettingsTerminate ();
Greg Clayton990de7b2010-11-18 23:32:35 +00004076}
Caroline Tice6e4c5ce2010-09-04 00:03:46 +00004077
Greg Clayton427f2902010-12-14 02:59:59 +00004078ExecutionResults
Jim Ingham360f53f2010-11-30 02:22:11 +00004079Process::RunThreadPlan (ExecutionContext &exe_ctx,
Jim Ingham1831e782012-04-07 00:00:41 +00004080 lldb::ThreadPlanSP &thread_plan_sp,
Jim Ingham360f53f2010-11-30 02:22:11 +00004081 bool stop_others,
4082 bool try_all_threads,
4083 bool discard_on_error,
4084 uint32_t single_thread_timeout_usec,
4085 Stream &errors)
4086{
4087 ExecutionResults return_value = eExecutionSetupError;
4088
Jim Ingham15dcb7c2011-01-20 02:03:18 +00004089 if (thread_plan_sp.get() == NULL)
4090 {
4091 errors.Printf("RunThreadPlan called with empty thread plan.");
Greg Claytonb3448432011-03-24 21:19:54 +00004092 return eExecutionSetupError;
Jim Ingham15dcb7c2011-01-20 02:03:18 +00004093 }
Greg Clayton567e7f32011-09-22 04:58:26 +00004094
4095 if (exe_ctx.GetProcessPtr() != this)
4096 {
4097 errors.Printf("RunThreadPlan called on wrong process.");
4098 return eExecutionSetupError;
4099 }
4100
4101 Thread *thread = exe_ctx.GetThreadPtr();
4102 if (thread == NULL)
4103 {
4104 errors.Printf("RunThreadPlan called with invalid thread.");
4105 return eExecutionSetupError;
4106 }
Jim Ingham15dcb7c2011-01-20 02:03:18 +00004107
Jim Ingham5ab7fba2011-05-17 22:24:54 +00004108 // We rely on the thread plan we are running returning "PlanCompleted" if when it successfully completes.
4109 // For that to be true the plan can't be private - since private plans suppress themselves in the
4110 // GetCompletedPlan call.
4111
4112 bool orig_plan_private = thread_plan_sp->GetPrivate();
4113 thread_plan_sp->SetPrivate(false);
4114
Jim Inghamac959662011-01-24 06:34:17 +00004115 if (m_private_state.GetValue() != eStateStopped)
4116 {
4117 errors.Printf ("RunThreadPlan called while the private state was not stopped.");
Greg Claytonb3448432011-03-24 21:19:54 +00004118 return eExecutionSetupError;
Jim Inghamac959662011-01-24 06:34:17 +00004119 }
4120
Jim Ingham7bbebaf2011-08-13 00:56:10 +00004121 // Save the thread & frame from the exe_ctx for restoration after we run
Greg Clayton567e7f32011-09-22 04:58:26 +00004122 const uint32_t thread_idx_id = thread->GetIndexID();
4123 StackID ctx_frame_id = thread->GetSelectedFrame()->GetStackID();
Jim Ingham360f53f2010-11-30 02:22:11 +00004124
4125 // N.B. Running the target may unset the currently selected thread and frame. We don't want to do that either,
4126 // so we should arrange to reset them as well.
4127
Greg Clayton567e7f32011-09-22 04:58:26 +00004128 lldb::ThreadSP selected_thread_sp = GetThreadList().GetSelectedThread();
Jim Ingham360f53f2010-11-30 02:22:11 +00004129
Jim Ingham7bbebaf2011-08-13 00:56:10 +00004130 uint32_t selected_tid;
4131 StackID selected_stack_id;
Greg Claytone40b6422011-09-18 18:59:15 +00004132 if (selected_thread_sp)
Jim Ingham360f53f2010-11-30 02:22:11 +00004133 {
4134 selected_tid = selected_thread_sp->GetIndexID();
Jim Ingham7bbebaf2011-08-13 00:56:10 +00004135 selected_stack_id = selected_thread_sp->GetSelectedFrame()->GetStackID();
Jim Ingham360f53f2010-11-30 02:22:11 +00004136 }
4137 else
4138 {
4139 selected_tid = LLDB_INVALID_THREAD_ID;
4140 }
4141
Jim Ingham1831e782012-04-07 00:00:41 +00004142 lldb::thread_t backup_private_state_thread = LLDB_INVALID_HOST_THREAD;
Jim Inghamd21d98b2012-04-10 01:21:57 +00004143 lldb::StateType old_state;
4144 lldb::ThreadPlanSP stopper_base_plan_sp;
Jim Ingham1831e782012-04-07 00:00:41 +00004145
Jim Inghamd21d98b2012-04-10 01:21:57 +00004146 lldb::LogSP log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STEP | LIBLLDB_LOG_PROCESS));
Jim Ingham1831e782012-04-07 00:00:41 +00004147 if (Host::GetCurrentThread() == m_private_state_thread)
4148 {
Jim Inghamd21d98b2012-04-10 01:21:57 +00004149 // Yikes, we are running on the private state thread! So we can't wait for public events on this thread, since
4150 // we are the thread that is generating public events.
Jim Ingham1831e782012-04-07 00:00:41 +00004151 // 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 +00004152 // we are fielding public events here.
4153 if (log)
4154 log->Printf ("Running thread plan on private state thread, spinning up another state thread to handle the events.");
4155
4156
Jim Ingham1831e782012-04-07 00:00:41 +00004157 backup_private_state_thread = m_private_state_thread;
Jim Inghamd21d98b2012-04-10 01:21:57 +00004158
4159 // One other bit of business: we want to run just this thread plan and anything it pushes, and then stop,
4160 // returning control here.
4161 // But in the normal course of things, the plan above us on the stack would be given a shot at the stop
4162 // event before deciding to stop, and we don't want that. So we insert a "stopper" base plan on the stack
4163 // before the plan we want to run. Since base plans always stop and return control to the user, that will
4164 // do just what we want.
4165 stopper_base_plan_sp.reset(new ThreadPlanBase (*thread));
4166 thread->QueueThreadPlan (stopper_base_plan_sp, false);
4167 // Have to make sure our public state is stopped, since otherwise the reporting logic below doesn't work correctly.
4168 old_state = m_public_state.GetValue();
4169 m_public_state.SetValueNoLock(eStateStopped);
4170
4171 // Now spin up the private state thread:
Jim Ingham1831e782012-04-07 00:00:41 +00004172 StartPrivateStateThread(true);
4173 }
4174
4175 thread->QueueThreadPlan(thread_plan_sp, false); // This used to pass "true" does that make sense?
Jim Ingham360f53f2010-11-30 02:22:11 +00004176
Jim Ingham6ae318c2011-01-23 21:14:08 +00004177 Listener listener("lldb.process.listener.run-thread-plan");
Jim Inghamf9f40c22011-02-08 05:20:59 +00004178
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004179 lldb::EventSP event_to_broadcast_sp;
Jim Inghamf9f40c22011-02-08 05:20:59 +00004180
Jim Ingham15dcb7c2011-01-20 02:03:18 +00004181 {
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004182 // This process event hijacker Hijacks the Public events and its destructor makes sure that the process events get
4183 // restored on exit to the function.
4184 //
4185 // If the event needs to propagate beyond the hijacker (e.g., the process exits during execution), then the event
4186 // is put into event_to_broadcast_sp for rebroadcasting.
Jim Ingham360f53f2010-11-30 02:22:11 +00004187
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004188 ProcessEventHijacker run_thread_plan_hijacker (*this, &listener);
Jim Inghamf9f40c22011-02-08 05:20:59 +00004189
Jim Ingham360f53f2010-11-30 02:22:11 +00004190 if (log)
Jim Inghamf9f40c22011-02-08 05:20:59 +00004191 {
4192 StreamString s;
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004193 thread_plan_sp->GetDescription(&s, lldb::eDescriptionLevelVerbose);
4194 log->Printf ("Process::RunThreadPlan(): Resuming thread %u - 0x%4.4llx to run thread plan \"%s\".",
4195 thread->GetIndexID(),
4196 thread->GetID(),
4197 s.GetData());
4198 }
4199
4200 bool got_event;
4201 lldb::EventSP event_sp;
4202 lldb::StateType stop_state = lldb::eStateInvalid;
4203
4204 TimeValue* timeout_ptr = NULL;
4205 TimeValue real_timeout;
4206
4207 bool first_timeout = true;
4208 bool do_resume = true;
4209
4210 while (1)
4211 {
4212 // We usually want to resume the process if we get to the top of the loop.
4213 // The only exception is if we get two running events with no intervening
4214 // stop, which can happen, we will just wait for then next stop event.
4215
4216 if (do_resume)
4217 {
4218 // Do the initial resume and wait for the running event before going further.
4219
4220 Error resume_error = PrivateResume ();
4221 if (!resume_error.Success())
4222 {
4223 errors.Printf("Error resuming inferior: \"%s\".\n", resume_error.AsCString());
4224 return_value = eExecutionSetupError;
4225 break;
4226 }
4227
4228 real_timeout = TimeValue::Now();
4229 real_timeout.OffsetWithMicroSeconds(500000);
4230 timeout_ptr = &real_timeout;
4231
4232 got_event = listener.WaitForEvent(timeout_ptr, event_sp);
4233 if (!got_event)
4234 {
4235 if (log)
4236 log->PutCString("Process::RunThreadPlan(): didn't get any event after initial resume, exiting.");
4237
4238 errors.Printf("Didn't get any event after initial resume, exiting.");
4239 return_value = eExecutionSetupError;
4240 break;
4241 }
4242
4243 stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
4244 if (stop_state != eStateRunning)
4245 {
4246 if (log)
4247 log->Printf("Process::RunThreadPlan(): didn't get running event after initial resume, got %s instead.", StateAsCString(stop_state));
4248
4249 errors.Printf("Didn't get running event after initial resume, got %s instead.", StateAsCString(stop_state));
4250 return_value = eExecutionSetupError;
4251 break;
4252 }
4253
4254 if (log)
4255 log->PutCString ("Process::RunThreadPlan(): resuming succeeded.");
4256 // We need to call the function synchronously, so spin waiting for it to return.
4257 // If we get interrupted while executing, we're going to lose our context, and
4258 // won't be able to gather the result at this point.
4259 // We set the timeout AFTER the resume, since the resume takes some time and we
4260 // don't want to charge that to the timeout.
4261
4262 if (single_thread_timeout_usec != 0)
4263 {
Enrico Granata6cca9692012-07-16 23:10:35 +00004264 // we have a > 0 timeout, let us set it so that we stop after the deadline
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004265 real_timeout = TimeValue::Now();
4266 real_timeout.OffsetWithMicroSeconds(single_thread_timeout_usec);
4267
4268 timeout_ptr = &real_timeout;
4269 }
Enrico Granata6cca9692012-07-16 23:10:35 +00004270 else if (first_timeout)
4271 {
4272 // if we are willing to wait "forever" we still need to have an initial timeout
4273 // this timeout is going to induce all threads to run when hit. we do this so that
4274 // we can avoid ending locked up because of multithreaded contention issues
4275 real_timeout = TimeValue::Now();
4276 real_timeout.OffsetWithNanoSeconds(500000000UL);
4277 timeout_ptr = &real_timeout;
4278 }
4279 else
4280 {
4281 timeout_ptr = NULL; // if we are in a no-timeout scenario, then we only need a fake timeout the first time through
4282 // at this point in the code, all threads will be running so we are willing to wait forever, and do not
4283 // need a timeout
4284 }
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004285 }
Jim Inghamf9f40c22011-02-08 05:20:59 +00004286 else
4287 {
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004288 if (log)
4289 log->PutCString ("Process::RunThreadPlan(): handled an extra running event.");
4290 do_resume = true;
Jim Inghamf9f40c22011-02-08 05:20:59 +00004291 }
Jim Inghamf9f40c22011-02-08 05:20:59 +00004292
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004293 // Now wait for the process to stop again:
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004294 event_sp.reset();
Jim Inghamf9f40c22011-02-08 05:20:59 +00004295
Jim Inghamf9f40c22011-02-08 05:20:59 +00004296 if (log)
Jim Inghamf6d3d792011-08-09 22:24:33 +00004297 {
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004298 if (timeout_ptr)
4299 {
4300 StreamString s;
4301 s.Printf ("about to wait - timeout is:\n ");
4302 timeout_ptr->Dump (&s, 120);
4303 s.Printf ("\nNow is:\n ");
4304 TimeValue::Now().Dump (&s, 120);
4305 log->Printf ("Process::RunThreadPlan(): %s", s.GetData());
4306 }
Jim Inghamf6d3d792011-08-09 22:24:33 +00004307 else
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004308 {
4309 log->Printf ("Process::RunThreadPlan(): about to wait forever.");
4310 }
4311 }
4312
4313 got_event = listener.WaitForEvent (timeout_ptr, event_sp);
4314
4315 if (got_event)
4316 {
4317 if (event_sp.get())
4318 {
4319 bool keep_going = false;
Jim Ingham5d90ade2012-07-27 23:57:19 +00004320 if (event_sp->GetType() == eBroadcastBitInterrupt)
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004321 {
Jim Ingham5d90ade2012-07-27 23:57:19 +00004322 Halt();
4323 keep_going = false;
4324 return_value = eExecutionInterrupted;
4325 errors.Printf ("Execution halted by user interrupt.");
4326 if (log)
4327 log->Printf ("Process::RunThreadPlan(): Got interrupted by eBroadcastBitInterrupted, exiting.");
4328 }
4329 else
4330 {
4331 stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
4332 if (log)
4333 log->Printf("Process::RunThreadPlan(): in while loop, got event: %s.", StateAsCString(stop_state));
4334
4335 switch (stop_state)
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004336 {
Jim Ingham5d90ade2012-07-27 23:57:19 +00004337 case lldb::eStateStopped:
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004338 {
Jim Ingham5d90ade2012-07-27 23:57:19 +00004339 // Yay, we're done. Now make sure that our thread plan actually completed.
4340 ThreadSP thread_sp = GetThreadList().FindThreadByIndexID (thread_idx_id);
4341 if (!thread_sp)
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004342 {
Jim Ingham5d90ade2012-07-27 23:57:19 +00004343 // Ooh, our thread has vanished. Unlikely that this was successful execution...
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004344 if (log)
Jim Ingham5d90ade2012-07-27 23:57:19 +00004345 log->Printf ("Process::RunThreadPlan(): execution completed but our thread (index-id=%u) has vanished.", thread_idx_id);
4346 return_value = eExecutionInterrupted;
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004347 }
4348 else
4349 {
Jim Ingham5d90ade2012-07-27 23:57:19 +00004350 StopInfoSP stop_info_sp (thread_sp->GetStopInfo ());
4351 StopReason stop_reason = eStopReasonInvalid;
4352 if (stop_info_sp)
4353 stop_reason = stop_info_sp->GetStopReason();
4354 if (stop_reason == eStopReasonPlanComplete)
4355 {
4356 if (log)
4357 log->PutCString ("Process::RunThreadPlan(): execution completed successfully.");
4358 // Now mark this plan as private so it doesn't get reported as the stop reason
4359 // after this point.
4360 if (thread_plan_sp)
4361 thread_plan_sp->SetPrivate (orig_plan_private);
4362 return_value = eExecutionCompleted;
4363 }
4364 else
4365 {
4366 if (log)
4367 log->PutCString ("Process::RunThreadPlan(): thread plan didn't successfully complete.");
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004368
Jim Ingham5d90ade2012-07-27 23:57:19 +00004369 return_value = eExecutionInterrupted;
4370 }
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004371 }
Jim Ingham5d90ade2012-07-27 23:57:19 +00004372 }
4373 break;
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004374
Jim Ingham5d90ade2012-07-27 23:57:19 +00004375 case lldb::eStateCrashed:
4376 if (log)
4377 log->PutCString ("Process::RunThreadPlan(): execution crashed.");
4378 return_value = eExecutionInterrupted;
4379 break;
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004380
Jim Ingham5d90ade2012-07-27 23:57:19 +00004381 case lldb::eStateRunning:
4382 do_resume = false;
4383 keep_going = true;
4384 break;
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004385
Jim Ingham5d90ade2012-07-27 23:57:19 +00004386 default:
4387 if (log)
4388 log->Printf("Process::RunThreadPlan(): execution stopped with unexpected state: %s.", StateAsCString(stop_state));
4389
4390 if (stop_state == eStateExited)
4391 event_to_broadcast_sp = event_sp;
4392
Sean Callanan96abc622012-08-08 17:35:10 +00004393 errors.Printf ("Execution stopped with unexpected state.\n");
Jim Ingham5d90ade2012-07-27 23:57:19 +00004394 return_value = eExecutionInterrupted;
4395 break;
4396 }
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004397 }
Jim Ingham5d90ade2012-07-27 23:57:19 +00004398
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004399 if (keep_going)
4400 continue;
4401 else
4402 break;
4403 }
4404 else
4405 {
4406 if (log)
4407 log->PutCString ("Process::RunThreadPlan(): got_event was true, but the event pointer was null. How odd...");
4408 return_value = eExecutionInterrupted;
4409 break;
4410 }
4411 }
4412 else
4413 {
4414 // If we didn't get an event that means we've timed out...
4415 // We will interrupt the process here. Depending on what we were asked to do we will
4416 // either exit, or try with all threads running for the same timeout.
4417 // Not really sure what to do if Halt fails here...
4418
4419 if (log) {
4420 if (try_all_threads)
4421 {
4422 if (first_timeout)
4423 log->Printf ("Process::RunThreadPlan(): Running function with timeout: %d timed out, "
4424 "trying with all threads enabled.",
4425 single_thread_timeout_usec);
4426 else
4427 log->Printf ("Process::RunThreadPlan(): Restarting function with all threads enabled "
4428 "and timeout: %d timed out.",
4429 single_thread_timeout_usec);
4430 }
4431 else
4432 log->Printf ("Process::RunThreadPlan(): Running function with timeout: %d timed out, "
4433 "halt and abandoning execution.",
4434 single_thread_timeout_usec);
4435 }
4436
4437 Error halt_error = Halt();
4438 if (halt_error.Success())
4439 {
4440 if (log)
4441 log->PutCString ("Process::RunThreadPlan(): Halt succeeded.");
4442
4443 // If halt succeeds, it always produces a stopped event. Wait for that:
4444
4445 real_timeout = TimeValue::Now();
4446 real_timeout.OffsetWithMicroSeconds(500000);
4447
4448 got_event = listener.WaitForEvent(&real_timeout, event_sp);
4449
4450 if (got_event)
4451 {
4452 stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
4453 if (log)
4454 {
4455 log->Printf ("Process::RunThreadPlan(): Stopped with event: %s", StateAsCString(stop_state));
4456 if (stop_state == lldb::eStateStopped
4457 && Process::ProcessEventData::GetInterruptedFromEvent(event_sp.get()))
4458 log->PutCString (" Event was the Halt interruption event.");
4459 }
4460
4461 if (stop_state == lldb::eStateStopped)
4462 {
4463 // Between the time we initiated the Halt and the time we delivered it, the process could have
4464 // already finished its job. Check that here:
4465
4466 if (thread->IsThreadPlanDone (thread_plan_sp.get()))
4467 {
4468 if (log)
4469 log->PutCString ("Process::RunThreadPlan(): Even though we timed out, the call plan was done. "
4470 "Exiting wait loop.");
4471 return_value = eExecutionCompleted;
4472 break;
4473 }
4474
4475 if (!try_all_threads)
4476 {
4477 if (log)
4478 log->PutCString ("Process::RunThreadPlan(): try_all_threads was false, we stopped so now we're quitting.");
4479 return_value = eExecutionInterrupted;
4480 break;
4481 }
4482
4483 if (first_timeout)
4484 {
4485 // Set all the other threads to run, and return to the top of the loop, which will continue;
4486 first_timeout = false;
4487 thread_plan_sp->SetStopOthers (false);
4488 if (log)
4489 log->PutCString ("Process::RunThreadPlan(): about to resume.");
4490
4491 continue;
4492 }
4493 else
4494 {
4495 // Running all threads failed, so return Interrupted.
4496 if (log)
4497 log->PutCString("Process::RunThreadPlan(): running all threads timed out.");
4498 return_value = eExecutionInterrupted;
4499 break;
4500 }
4501 }
4502 }
4503 else
4504 { if (log)
4505 log->PutCString("Process::RunThreadPlan(): halt said it succeeded, but I got no event. "
4506 "I'm getting out of here passing Interrupted.");
4507 return_value = eExecutionInterrupted;
4508 break;
4509 }
4510 }
4511 else
4512 {
4513 // This branch is to work around some problems with gdb-remote's Halt. It is a little racy, and can return
4514 // an error from halt, but if you wait a bit you'll get a stopped event anyway.
4515 if (log)
4516 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.",
4517 halt_error.AsCString());
4518 real_timeout = TimeValue::Now();
4519 real_timeout.OffsetWithMicroSeconds(500000);
4520 timeout_ptr = &real_timeout;
4521 got_event = listener.WaitForEvent(&real_timeout, event_sp);
4522 if (!got_event || event_sp.get() == NULL)
4523 {
4524 // This is not going anywhere, bag out.
4525 if (log)
4526 log->PutCString ("Process::RunThreadPlan(): halt failed: and waiting for the stopped event failed.");
4527 return_value = eExecutionInterrupted;
4528 break;
4529 }
4530 else
4531 {
4532 stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
4533 if (log)
4534 log->PutCString ("Process::RunThreadPlan(): halt failed: but then I got a stopped event. Whatever...");
4535 if (stop_state == lldb::eStateStopped)
4536 {
4537 // Between the time we initiated the Halt and the time we delivered it, the process could have
4538 // already finished its job. Check that here:
4539
4540 if (thread->IsThreadPlanDone (thread_plan_sp.get()))
4541 {
4542 if (log)
4543 log->PutCString ("Process::RunThreadPlan(): Even though we timed out, the call plan was done. "
4544 "Exiting wait loop.");
4545 return_value = eExecutionCompleted;
4546 break;
4547 }
4548
4549 if (first_timeout)
4550 {
4551 // Set all the other threads to run, and return to the top of the loop, which will continue;
4552 first_timeout = false;
4553 thread_plan_sp->SetStopOthers (false);
4554 if (log)
4555 log->PutCString ("Process::RunThreadPlan(): About to resume.");
4556
4557 continue;
4558 }
4559 else
4560 {
4561 // Running all threads failed, so return Interrupted.
4562 if (log)
4563 log->PutCString ("Process::RunThreadPlan(): running all threads timed out.");
4564 return_value = eExecutionInterrupted;
4565 break;
4566 }
4567 }
4568 else
4569 {
4570 if (log)
4571 log->Printf ("Process::RunThreadPlan(): halt failed, I waited and didn't get"
4572 " a stopped event, instead got %s.", StateAsCString(stop_state));
4573 return_value = eExecutionInterrupted;
4574 break;
4575 }
4576 }
4577 }
4578
4579 }
4580
4581 } // END WAIT LOOP
4582
4583 // If we had to start up a temporary private state thread to run this thread plan, shut it down now.
4584 if (IS_VALID_LLDB_HOST_THREAD(backup_private_state_thread))
4585 {
4586 StopPrivateStateThread();
4587 Error error;
4588 m_private_state_thread = backup_private_state_thread;
Sean Callananb386d822012-08-09 00:50:26 +00004589 if (stopper_base_plan_sp)
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004590 {
4591 thread->DiscardThreadPlansUpToPlan(stopper_base_plan_sp);
4592 }
4593 m_public_state.SetValueNoLock(old_state);
4594
4595 }
4596
4597
4598 // Now do some processing on the results of the run:
4599 if (return_value == eExecutionInterrupted)
4600 {
4601 if (log)
4602 {
4603 StreamString s;
4604 if (event_sp)
4605 event_sp->Dump (&s);
4606 else
4607 {
4608 log->PutCString ("Process::RunThreadPlan(): Stop event that interrupted us is NULL.");
4609 }
4610
4611 StreamString ts;
4612
4613 const char *event_explanation = NULL;
4614
4615 do
4616 {
Jim Ingham5d90ade2012-07-27 23:57:19 +00004617 if (!event_sp)
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004618 {
Jim Ingham5d90ade2012-07-27 23:57:19 +00004619 event_explanation = "<no event>";
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004620 break;
4621 }
Jim Ingham5d90ade2012-07-27 23:57:19 +00004622 else if (event_sp->GetType() == eBroadcastBitInterrupt)
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004623 {
Jim Ingham5d90ade2012-07-27 23:57:19 +00004624 event_explanation = "<user interrupt>";
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004625 break;
4626 }
Jim Ingham5d90ade2012-07-27 23:57:19 +00004627 else
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004628 {
Jim Ingham5d90ade2012-07-27 23:57:19 +00004629 const Process::ProcessEventData *event_data = Process::ProcessEventData::GetEventDataFromEvent (event_sp.get());
4630
4631 if (!event_data)
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004632 {
Jim Ingham5d90ade2012-07-27 23:57:19 +00004633 event_explanation = "<no event data>";
4634 break;
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004635 }
4636
Jim Ingham5d90ade2012-07-27 23:57:19 +00004637 Process *process = event_data->GetProcessSP().get();
4638
4639 if (!process)
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004640 {
Jim Ingham5d90ade2012-07-27 23:57:19 +00004641 event_explanation = "<no process>";
4642 break;
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004643 }
Jim Ingham5d90ade2012-07-27 23:57:19 +00004644
4645 ThreadList &thread_list = process->GetThreadList();
4646
4647 uint32_t num_threads = thread_list.GetSize();
4648 uint32_t thread_index;
4649
4650 ts.Printf("<%u threads> ", num_threads);
4651
4652 for (thread_index = 0;
4653 thread_index < num_threads;
4654 ++thread_index)
4655 {
4656 Thread *thread = thread_list.GetThreadAtIndex(thread_index).get();
4657
4658 if (!thread)
4659 {
4660 ts.Printf("<?> ");
4661 continue;
4662 }
4663
4664 ts.Printf("<0x%4.4llx ", thread->GetID());
4665 RegisterContext *register_context = thread->GetRegisterContext().get();
4666
4667 if (register_context)
4668 ts.Printf("[ip 0x%llx] ", register_context->GetPC());
4669 else
4670 ts.Printf("[ip unknown] ");
4671
4672 lldb::StopInfoSP stop_info_sp = thread->GetStopInfo();
4673 if (stop_info_sp)
4674 {
4675 const char *stop_desc = stop_info_sp->GetDescription();
4676 if (stop_desc)
4677 ts.PutCString (stop_desc);
4678 }
4679 ts.Printf(">");
4680 }
4681
4682 event_explanation = ts.GetData();
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004683 }
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004684 } while (0);
4685
Jim Ingham5d90ade2012-07-27 23:57:19 +00004686 if (event_explanation)
4687 log->Printf("Process::RunThreadPlan(): execution interrupted: %s %s", s.GetData(), event_explanation);
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004688 else
Jim Ingham5d90ade2012-07-27 23:57:19 +00004689 log->Printf("Process::RunThreadPlan(): execution interrupted: %s", s.GetData());
4690 }
4691
4692 if (discard_on_error && thread_plan_sp)
4693 {
4694 if (log)
4695 log->Printf ("Process::RunThreadPlan: ExecutionInterrupted - discarding thread plans up to %p.", thread_plan_sp.get());
4696 thread->DiscardThreadPlansUpToPlan (thread_plan_sp);
4697 thread_plan_sp->SetPrivate (orig_plan_private);
4698 }
4699 else
4700 {
4701 if (log)
4702 log->Printf ("Process::RunThreadPlan: ExecutionInterrupted - for plan: %p not discarding.", thread_plan_sp.get());
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004703 }
4704 }
4705 else if (return_value == eExecutionSetupError)
4706 {
4707 if (log)
4708 log->PutCString("Process::RunThreadPlan(): execution set up error.");
Jim Inghamf9f40c22011-02-08 05:20:59 +00004709
4710 if (discard_on_error && thread_plan_sp)
4711 {
Greg Clayton567e7f32011-09-22 04:58:26 +00004712 thread->DiscardThreadPlansUpToPlan (thread_plan_sp);
Jim Ingham21f37ad2011-08-09 02:12:22 +00004713 thread_plan_sp->SetPrivate (orig_plan_private);
Jim Inghamf9f40c22011-02-08 05:20:59 +00004714 }
Jim Ingham360f53f2010-11-30 02:22:11 +00004715 }
4716 else
4717 {
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004718 if (thread->IsThreadPlanDone (thread_plan_sp.get()))
Jim Ingham360f53f2010-11-30 02:22:11 +00004719 {
Jim Inghamf9f40c22011-02-08 05:20:59 +00004720 if (log)
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004721 log->PutCString("Process::RunThreadPlan(): thread plan is done");
4722 return_value = eExecutionCompleted;
4723 }
4724 else if (thread->WasThreadPlanDiscarded (thread_plan_sp.get()))
4725 {
4726 if (log)
4727 log->PutCString("Process::RunThreadPlan(): thread plan was discarded");
4728 return_value = eExecutionDiscarded;
4729 }
4730 else
4731 {
4732 if (log)
4733 log->PutCString("Process::RunThreadPlan(): thread plan stopped in mid course");
4734 if (discard_on_error && thread_plan_sp)
4735 {
4736 if (log)
4737 log->PutCString("Process::RunThreadPlan(): discarding thread plan 'cause discard_on_error is set.");
4738 thread->DiscardThreadPlansUpToPlan (thread_plan_sp);
4739 thread_plan_sp->SetPrivate (orig_plan_private);
4740 }
4741 }
4742 }
4743
4744 // Thread we ran the function in may have gone away because we ran the target
4745 // Check that it's still there, and if it is put it back in the context. Also restore the
4746 // frame in the context if it is still present.
4747 thread = GetThreadList().FindThreadByIndexID(thread_idx_id, true).get();
4748 if (thread)
4749 {
4750 exe_ctx.SetFrameSP (thread->GetFrameWithStackID (ctx_frame_id));
4751 }
4752
4753 // Also restore the current process'es selected frame & thread, since this function calling may
4754 // be done behind the user's back.
4755
4756 if (selected_tid != LLDB_INVALID_THREAD_ID)
4757 {
4758 if (GetThreadList().SetSelectedThreadByIndexID (selected_tid) && selected_stack_id.IsValid())
4759 {
4760 // We were able to restore the selected thread, now restore the frame:
4761 StackFrameSP old_frame_sp = GetThreadList().GetSelectedThread()->GetFrameWithStackID(selected_stack_id);
4762 if (old_frame_sp)
4763 GetThreadList().GetSelectedThread()->SetSelectedFrame(old_frame_sp.get());
Jim Ingham360f53f2010-11-30 02:22:11 +00004764 }
Jim Ingham360f53f2010-11-30 02:22:11 +00004765 }
4766 }
Jim Ingham360f53f2010-11-30 02:22:11 +00004767
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004768 // If the process exited during the run of the thread plan, notify everyone.
Jim Ingham360f53f2010-11-30 02:22:11 +00004769
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004770 if (event_to_broadcast_sp)
Jim Ingham360f53f2010-11-30 02:22:11 +00004771 {
Sean Callanan5b0a5ac2012-07-11 21:31:24 +00004772 if (log)
4773 log->PutCString("Process::RunThreadPlan(): rebroadcasting event.");
4774 BroadcastEvent(event_to_broadcast_sp);
Jim Ingham360f53f2010-11-30 02:22:11 +00004775 }
4776
4777 return return_value;
4778}
4779
4780const char *
4781Process::ExecutionResultAsCString (ExecutionResults result)
4782{
4783 const char *result_name;
4784
4785 switch (result)
4786 {
Greg Claytonb3448432011-03-24 21:19:54 +00004787 case eExecutionCompleted:
Jim Ingham360f53f2010-11-30 02:22:11 +00004788 result_name = "eExecutionCompleted";
4789 break;
Greg Claytonb3448432011-03-24 21:19:54 +00004790 case eExecutionDiscarded:
Jim Ingham360f53f2010-11-30 02:22:11 +00004791 result_name = "eExecutionDiscarded";
4792 break;
Greg Claytonb3448432011-03-24 21:19:54 +00004793 case eExecutionInterrupted:
Jim Ingham360f53f2010-11-30 02:22:11 +00004794 result_name = "eExecutionInterrupted";
4795 break;
Greg Claytonb3448432011-03-24 21:19:54 +00004796 case eExecutionSetupError:
Jim Ingham360f53f2010-11-30 02:22:11 +00004797 result_name = "eExecutionSetupError";
4798 break;
Greg Claytonb3448432011-03-24 21:19:54 +00004799 case eExecutionTimedOut:
Jim Ingham360f53f2010-11-30 02:22:11 +00004800 result_name = "eExecutionTimedOut";
4801 break;
4802 }
4803 return result_name;
4804}
4805
Greg Claytonabe0fed2011-04-18 08:33:37 +00004806void
4807Process::GetStatus (Stream &strm)
4808{
4809 const StateType state = GetState();
Greg Clayton20206082011-11-17 01:23:07 +00004810 if (StateIsStoppedState(state, false))
Greg Claytonabe0fed2011-04-18 08:33:37 +00004811 {
4812 if (state == eStateExited)
4813 {
4814 int exit_status = GetExitStatus();
4815 const char *exit_description = GetExitDescription();
Greg Clayton444e35b2011-10-19 18:09:39 +00004816 strm.Printf ("Process %llu exited with status = %i (0x%8.8x) %s\n",
Greg Claytonabe0fed2011-04-18 08:33:37 +00004817 GetID(),
4818 exit_status,
4819 exit_status,
4820 exit_description ? exit_description : "");
4821 }
4822 else
4823 {
4824 if (state == eStateConnected)
4825 strm.Printf ("Connected to remote target.\n");
4826 else
Greg Clayton444e35b2011-10-19 18:09:39 +00004827 strm.Printf ("Process %llu %s\n", GetID(), StateAsCString (state));
Greg Claytonabe0fed2011-04-18 08:33:37 +00004828 }
4829 }
4830 else
4831 {
Greg Clayton444e35b2011-10-19 18:09:39 +00004832 strm.Printf ("Process %llu is running.\n", GetID());
Greg Claytonabe0fed2011-04-18 08:33:37 +00004833 }
4834}
4835
4836size_t
4837Process::GetThreadStatus (Stream &strm,
4838 bool only_threads_with_stop_reason,
4839 uint32_t start_frame,
4840 uint32_t num_frames,
4841 uint32_t num_frames_with_source)
4842{
4843 size_t num_thread_infos_dumped = 0;
4844
4845 const size_t num_threads = GetThreadList().GetSize();
4846 for (uint32_t i = 0; i < num_threads; i++)
4847 {
4848 Thread *thread = GetThreadList().GetThreadAtIndex(i).get();
4849 if (thread)
4850 {
4851 if (only_threads_with_stop_reason)
4852 {
4853 if (thread->GetStopInfo().get() == NULL)
4854 continue;
4855 }
4856 thread->GetStatus (strm,
4857 start_frame,
4858 num_frames,
4859 num_frames_with_source);
4860 ++num_thread_infos_dumped;
4861 }
4862 }
4863 return num_thread_infos_dumped;
4864}
4865
Greg Clayton76113302012-02-22 04:37:26 +00004866void
4867Process::AddInvalidMemoryRegion (const LoadRange &region)
4868{
4869 m_memory_cache.AddInvalidRange(region.GetRangeBase(), region.GetByteSize());
4870}
4871
4872bool
4873Process::RemoveInvalidMemoryRange (const LoadRange &region)
4874{
4875 return m_memory_cache.RemoveInvalidRange(region.GetRangeBase(), region.GetByteSize());
4876}
4877
Jim Ingham1831e782012-04-07 00:00:41 +00004878void
4879Process::AddPreResumeAction (PreResumeActionCallback callback, void *baton)
4880{
4881 m_pre_resume_actions.push_back(PreResumeCallbackAndBaton (callback, baton));
4882}
4883
4884bool
4885Process::RunPreResumeActions ()
4886{
4887 bool result = true;
4888 while (!m_pre_resume_actions.empty())
4889 {
4890 struct PreResumeCallbackAndBaton action = m_pre_resume_actions.back();
4891 m_pre_resume_actions.pop_back();
4892 bool this_result = action.callback (action.baton);
4893 if (result == true) result = this_result;
4894 }
4895 return result;
4896}
4897
4898void
4899Process::ClearPreResumeActions ()
4900{
4901 m_pre_resume_actions.clear();
4902}
Greg Clayton76113302012-02-22 04:37:26 +00004903
Greg Claytoncf5927e2012-05-18 02:38:05 +00004904void
4905Process::Flush ()
4906{
4907 m_thread_list.Flush();
4908}