blob: 2c9b1e560fd03cc00b391bea36e7ec0bfcda129c [file] [log] [blame]
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001//===-- Process.cpp ---------------------------------------------*- C++ -*-===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9
Daniel Malea93a64302012-12-05 00:20:57 +000010#include "lldb/lldb-python.h"
11
Chris Lattner30fdc8d2010-06-08 16:52:24 +000012#include "lldb/Target/Process.h"
13
14#include "lldb/lldb-private-log.h"
15
16#include "lldb/Breakpoint/StoppointCallbackContext.h"
17#include "lldb/Breakpoint/BreakpointLocation.h"
18#include "lldb/Core/Event.h"
Caroline Ticeef5c6d02010-11-16 05:07:41 +000019#include "lldb/Core/ConnectionFileDescriptor.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000020#include "lldb/Core/Debugger.h"
21#include "lldb/Core/Log.h"
Greg Clayton1f746072012-08-29 21:13:06 +000022#include "lldb/Core/Module.h"
Jim Ingham1460e4b2014-01-10 23:46:59 +000023#include "lldb/Symbol/Symbol.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000024#include "lldb/Core/PluginManager.h"
25#include "lldb/Core/State.h"
Greg Clayton44d93782014-01-27 23:43:24 +000026#include "lldb/Core/StreamFile.h"
Greg Claytoneb0103f2011-04-07 22:46:35 +000027#include "lldb/Expression/ClangUserExpression.h"
Caroline Tice3df9a8d2010-09-04 00:03:46 +000028#include "lldb/Interpreter/CommandInterpreter.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000029#include "lldb/Host/Host.h"
Greg Clayton100eb932014-07-02 21:10:39 +000030#include "lldb/Host/Pipe.h"
Greg Clayton44d93782014-01-27 23:43:24 +000031#include "lldb/Host/Terminal.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000032#include "lldb/Target/ABI.h"
Greg Clayton8f343b02010-11-04 01:54:29 +000033#include "lldb/Target/DynamicLoader.h"
Andrew MacPherson17220c12014-03-05 10:12:43 +000034#include "lldb/Target/JITLoader.h"
Greg Clayton56d9a1b2011-08-22 02:49:39 +000035#include "lldb/Target/OperatingSystem.h"
Jim Ingham22777012010-09-23 02:01:19 +000036#include "lldb/Target/LanguageRuntime.h"
37#include "lldb/Target/CPPLanguageRuntime.h"
38#include "lldb/Target/ObjCLanguageRuntime.h"
Greg Claytone996fd32011-03-08 22:40:15 +000039#include "lldb/Target/Platform.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000040#include "lldb/Target/RegisterContext.h"
Greg Claytonf4b47e12010-08-04 01:40:35 +000041#include "lldb/Target/StopInfo.h"
Jason Molendaeef51062013-11-05 03:57:19 +000042#include "lldb/Target/SystemRuntime.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000043#include "lldb/Target/Target.h"
44#include "lldb/Target/TargetList.h"
45#include "lldb/Target/Thread.h"
46#include "lldb/Target/ThreadPlan.h"
Jim Ingham076b3042012-04-10 01:21:57 +000047#include "lldb/Target/ThreadPlanBase.h"
Jim Ingham1460e4b2014-01-10 23:46:59 +000048#include "Plugins/Process/Utility/InferiorCallPOSIX.h"
Chris Lattner30fdc8d2010-06-08 16:52:24 +000049
Charles Davis510938e2013-08-27 05:04:57 +000050#ifndef LLDB_DISABLE_POSIX
51#include <spawn.h>
52#endif
53
Chris Lattner30fdc8d2010-06-08 16:52:24 +000054using namespace lldb;
55using namespace lldb_private;
56
Greg Clayton67cc0632012-08-22 17:17:09 +000057
58// Comment out line below to disable memory caching, overriding the process setting
59// target.process.disable-memory-cache
60#define ENABLE_MEMORY_CACHING
61
62#ifdef ENABLE_MEMORY_CACHING
63#define DISABLE_MEM_CACHE_DEFAULT false
64#else
65#define DISABLE_MEM_CACHE_DEFAULT true
66#endif
67
68class ProcessOptionValueProperties : public OptionValueProperties
69{
70public:
71 ProcessOptionValueProperties (const ConstString &name) :
72 OptionValueProperties (name)
73 {
74 }
75
76 // This constructor is used when creating ProcessOptionValueProperties when it
77 // is part of a new lldb_private::Process instance. It will copy all current
78 // global property values as needed
79 ProcessOptionValueProperties (ProcessProperties *global_properties) :
80 OptionValueProperties(*global_properties->GetValueProperties())
81 {
82 }
83
84 virtual const Property *
85 GetPropertyAtIndex (const ExecutionContext *exe_ctx, bool will_modify, uint32_t idx) const
86 {
Bruce Mitchenerd93c4a32014-07-01 21:22:11 +000087 // When getting the value for a key from the process options, we will always
Greg Clayton67cc0632012-08-22 17:17:09 +000088 // try and grab the setting from the current process if there is one. Else we just
89 // use the one from this instance.
90 if (exe_ctx)
91 {
92 Process *process = exe_ctx->GetProcessPtr();
93 if (process)
94 {
95 ProcessOptionValueProperties *instance_properties = static_cast<ProcessOptionValueProperties *>(process->GetValueProperties().get());
96 if (this != instance_properties)
97 return instance_properties->ProtectedGetPropertyAtIndex (idx);
98 }
99 }
100 return ProtectedGetPropertyAtIndex (idx);
101 }
102};
103
104static PropertyDefinition
105g_properties[] =
106{
107 { "disable-memory-cache" , OptionValue::eTypeBoolean, false, DISABLE_MEM_CACHE_DEFAULT, NULL, NULL, "Disable reading and caching of memory in fixed-size units." },
Jim Ingham8c3f2762012-11-29 00:41:12 +0000108 { "extra-startup-command", OptionValue::eTypeArray , false, OptionValue::eTypeString, NULL, NULL, "A list containing extra commands understood by the particular process plugin used. "
109 "For instance, to turn on debugserver logging set this to \"QSetLogging:bitmask=LOG_DEFAULT;\"" },
Jim Inghamafc1b122013-01-31 19:48:57 +0000110 { "ignore-breakpoints-in-expressions", OptionValue::eTypeBoolean, true, true, NULL, NULL, "If true, breakpoints will be ignored during expression evaluation." },
111 { "unwind-on-error-in-expressions", OptionValue::eTypeBoolean, true, true, NULL, NULL, "If true, errors in expression evaluation will unwind the stack back to the state before the call." },
Greg Claytone1e835c2012-11-29 18:48:47 +0000112 { "python-os-plugin-path", OptionValue::eTypeFileSpec, false, true, NULL, NULL, "A path to a python OS plug-in module file that contains a OperatingSystemPlugIn class." },
Jim Ingham29950772013-01-26 02:19:28 +0000113 { "stop-on-sharedlibrary-events" , OptionValue::eTypeBoolean, true, false, NULL, NULL, "If true, stop when a shared library is loaded or unloaded." },
Jim Inghamacff8952013-05-02 00:27:30 +0000114 { "detach-keeps-stopped" , OptionValue::eTypeBoolean, true, false, NULL, NULL, "If true, detach will attempt to keep the process stopped." },
Greg Clayton67cc0632012-08-22 17:17:09 +0000115 { NULL , OptionValue::eTypeInvalid, false, 0, NULL, NULL, NULL }
116};
117
118enum {
119 ePropertyDisableMemCache,
Greg Claytonc9d645d2012-10-18 22:40:37 +0000120 ePropertyExtraStartCommand,
Jim Ingham184e9812013-01-15 02:47:48 +0000121 ePropertyIgnoreBreakpointsInExpressions,
122 ePropertyUnwindOnErrorInExpressions,
Jim Ingham29950772013-01-26 02:19:28 +0000123 ePropertyPythonOSPluginPath,
Jim Inghamacff8952013-05-02 00:27:30 +0000124 ePropertyStopOnSharedLibraryEvents,
125 ePropertyDetachKeepsStopped
Greg Clayton67cc0632012-08-22 17:17:09 +0000126};
127
128ProcessProperties::ProcessProperties (bool is_global) :
129 Properties ()
130{
131 if (is_global)
132 {
133 m_collection_sp.reset (new ProcessOptionValueProperties(ConstString("process")));
134 m_collection_sp->Initialize(g_properties);
135 m_collection_sp->AppendProperty(ConstString("thread"),
Jim Ingham29950772013-01-26 02:19:28 +0000136 ConstString("Settings specific to threads."),
Greg Clayton67cc0632012-08-22 17:17:09 +0000137 true,
138 Thread::GetGlobalProperties()->GetValueProperties());
139 }
140 else
141 m_collection_sp.reset (new ProcessOptionValueProperties(Process::GetGlobalProperties().get()));
142}
143
144ProcessProperties::~ProcessProperties()
145{
146}
147
148bool
149ProcessProperties::GetDisableMemoryCache() const
150{
151 const uint32_t idx = ePropertyDisableMemCache;
152 return m_collection_sp->GetPropertyAtIndexAsBoolean (NULL, idx, g_properties[idx].default_uint_value != 0);
153}
154
155Args
156ProcessProperties::GetExtraStartupCommands () const
157{
158 Args args;
159 const uint32_t idx = ePropertyExtraStartCommand;
160 m_collection_sp->GetPropertyAtIndexAsArgs(NULL, idx, args);
161 return args;
162}
163
164void
165ProcessProperties::SetExtraStartupCommands (const Args &args)
166{
167 const uint32_t idx = ePropertyExtraStartCommand;
168 m_collection_sp->SetPropertyAtIndexFromArgs(NULL, idx, args);
169}
170
Greg Claytonc9d645d2012-10-18 22:40:37 +0000171FileSpec
172ProcessProperties::GetPythonOSPluginPath () const
173{
174 const uint32_t idx = ePropertyPythonOSPluginPath;
175 return m_collection_sp->GetPropertyAtIndexAsFileSpec(NULL, idx);
176}
177
178void
179ProcessProperties::SetPythonOSPluginPath (const FileSpec &file)
180{
181 const uint32_t idx = ePropertyPythonOSPluginPath;
182 m_collection_sp->SetPropertyAtIndexAsFileSpec(NULL, idx, file);
183}
184
Jim Ingham184e9812013-01-15 02:47:48 +0000185
186bool
187ProcessProperties::GetIgnoreBreakpointsInExpressions () const
188{
189 const uint32_t idx = ePropertyIgnoreBreakpointsInExpressions;
190 return m_collection_sp->GetPropertyAtIndexAsBoolean(NULL, idx, g_properties[idx].default_uint_value != 0);
191}
192
193void
194ProcessProperties::SetIgnoreBreakpointsInExpressions (bool ignore)
195{
196 const uint32_t idx = ePropertyIgnoreBreakpointsInExpressions;
197 m_collection_sp->SetPropertyAtIndexAsBoolean(NULL, idx, ignore);
198}
199
200bool
201ProcessProperties::GetUnwindOnErrorInExpressions () const
202{
203 const uint32_t idx = ePropertyUnwindOnErrorInExpressions;
204 return m_collection_sp->GetPropertyAtIndexAsBoolean(NULL, idx, g_properties[idx].default_uint_value != 0);
205}
206
207void
208ProcessProperties::SetUnwindOnErrorInExpressions (bool ignore)
209{
210 const uint32_t idx = ePropertyUnwindOnErrorInExpressions;
211 m_collection_sp->SetPropertyAtIndexAsBoolean(NULL, idx, ignore);
212}
213
Jim Ingham29950772013-01-26 02:19:28 +0000214bool
215ProcessProperties::GetStopOnSharedLibraryEvents () const
216{
217 const uint32_t idx = ePropertyStopOnSharedLibraryEvents;
218 return m_collection_sp->GetPropertyAtIndexAsBoolean(NULL, idx, g_properties[idx].default_uint_value != 0);
219}
220
221void
222ProcessProperties::SetStopOnSharedLibraryEvents (bool stop)
223{
224 const uint32_t idx = ePropertyStopOnSharedLibraryEvents;
225 m_collection_sp->SetPropertyAtIndexAsBoolean(NULL, idx, stop);
226}
227
Jim Inghamacff8952013-05-02 00:27:30 +0000228bool
229ProcessProperties::GetDetachKeepsStopped () const
230{
231 const uint32_t idx = ePropertyDetachKeepsStopped;
232 return m_collection_sp->GetPropertyAtIndexAsBoolean(NULL, idx, g_properties[idx].default_uint_value != 0);
233}
234
235void
236ProcessProperties::SetDetachKeepsStopped (bool stop)
237{
238 const uint32_t idx = ePropertyDetachKeepsStopped;
239 m_collection_sp->SetPropertyAtIndexAsBoolean(NULL, idx, stop);
240}
241
Greg Clayton32e0a752011-03-30 18:16:51 +0000242void
Greg Clayton8b82f082011-04-12 05:54:46 +0000243ProcessInstanceInfo::Dump (Stream &s, Platform *platform) const
Greg Clayton32e0a752011-03-30 18:16:51 +0000244{
245 const char *cstr;
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000246 if (m_pid != LLDB_INVALID_PROCESS_ID)
Daniel Malead01b2952012-11-29 21:49:15 +0000247 s.Printf (" pid = %" PRIu64 "\n", m_pid);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000248
249 if (m_parent_pid != LLDB_INVALID_PROCESS_ID)
Daniel Malead01b2952012-11-29 21:49:15 +0000250 s.Printf (" parent = %" PRIu64 "\n", m_parent_pid);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000251
252 if (m_executable)
253 {
254 s.Printf (" name = %s\n", m_executable.GetFilename().GetCString());
255 s.PutCString (" file = ");
256 m_executable.Dump(&s);
257 s.EOL();
258 }
Greg Clayton8b82f082011-04-12 05:54:46 +0000259 const uint32_t argc = m_arguments.GetArgumentCount();
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000260 if (argc > 0)
261 {
262 for (uint32_t i=0; i<argc; i++)
263 {
Greg Clayton8b82f082011-04-12 05:54:46 +0000264 const char *arg = m_arguments.GetArgumentAtIndex(i);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000265 if (i < 10)
Greg Clayton8b82f082011-04-12 05:54:46 +0000266 s.Printf (" arg[%u] = %s\n", i, arg);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000267 else
Greg Clayton8b82f082011-04-12 05:54:46 +0000268 s.Printf ("arg[%u] = %s\n", i, arg);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000269 }
270 }
Greg Clayton8b82f082011-04-12 05:54:46 +0000271
272 const uint32_t envc = m_environment.GetArgumentCount();
273 if (envc > 0)
274 {
275 for (uint32_t i=0; i<envc; i++)
276 {
277 const char *env = m_environment.GetArgumentAtIndex(i);
278 if (i < 10)
279 s.Printf (" env[%u] = %s\n", i, env);
280 else
281 s.Printf ("env[%u] = %s\n", i, env);
282 }
283 }
284
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000285 if (m_arch.IsValid())
286 s.Printf (" arch = %s\n", m_arch.GetTriple().str().c_str());
287
Greg Clayton8b82f082011-04-12 05:54:46 +0000288 if (m_uid != UINT32_MAX)
Greg Clayton32e0a752011-03-30 18:16:51 +0000289 {
Greg Clayton8b82f082011-04-12 05:54:46 +0000290 cstr = platform->GetUserName (m_uid);
291 s.Printf (" uid = %-5u (%s)\n", m_uid, cstr ? cstr : "");
Greg Clayton32e0a752011-03-30 18:16:51 +0000292 }
Greg Clayton8b82f082011-04-12 05:54:46 +0000293 if (m_gid != UINT32_MAX)
Greg Clayton32e0a752011-03-30 18:16:51 +0000294 {
Greg Clayton8b82f082011-04-12 05:54:46 +0000295 cstr = platform->GetGroupName (m_gid);
296 s.Printf (" gid = %-5u (%s)\n", m_gid, cstr ? cstr : "");
Greg Clayton32e0a752011-03-30 18:16:51 +0000297 }
Greg Clayton8b82f082011-04-12 05:54:46 +0000298 if (m_euid != UINT32_MAX)
Greg Clayton32e0a752011-03-30 18:16:51 +0000299 {
Greg Clayton8b82f082011-04-12 05:54:46 +0000300 cstr = platform->GetUserName (m_euid);
301 s.Printf (" euid = %-5u (%s)\n", m_euid, cstr ? cstr : "");
Greg Clayton32e0a752011-03-30 18:16:51 +0000302 }
Greg Clayton8b82f082011-04-12 05:54:46 +0000303 if (m_egid != UINT32_MAX)
Greg Clayton32e0a752011-03-30 18:16:51 +0000304 {
Greg Clayton8b82f082011-04-12 05:54:46 +0000305 cstr = platform->GetGroupName (m_egid);
306 s.Printf (" egid = %-5u (%s)\n", m_egid, cstr ? cstr : "");
Greg Clayton32e0a752011-03-30 18:16:51 +0000307 }
308}
309
310void
Greg Clayton8b82f082011-04-12 05:54:46 +0000311ProcessInstanceInfo::DumpTableHeader (Stream &s, Platform *platform, bool show_args, bool verbose)
Greg Clayton32e0a752011-03-30 18:16:51 +0000312{
Greg Clayton8b82f082011-04-12 05:54:46 +0000313 const char *label;
314 if (show_args || verbose)
315 label = "ARGUMENTS";
316 else
317 label = "NAME";
318
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000319 if (verbose)
320 {
Greg Clayton8b82f082011-04-12 05:54:46 +0000321 s.Printf ("PID PARENT USER GROUP EFF USER EFF GROUP TRIPLE %s\n", label);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000322 s.PutCString ("====== ====== ========== ========== ========== ========== ======================== ============================\n");
323 }
324 else
325 {
Greg Clayton8b82f082011-04-12 05:54:46 +0000326 s.Printf ("PID PARENT USER ARCH %s\n", label);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000327 s.PutCString ("====== ====== ========== ======= ============================\n");
328 }
Greg Clayton32e0a752011-03-30 18:16:51 +0000329}
330
331void
Greg Clayton8b82f082011-04-12 05:54:46 +0000332ProcessInstanceInfo::DumpAsTableRow (Stream &s, Platform *platform, bool show_args, bool verbose) const
Greg Clayton32e0a752011-03-30 18:16:51 +0000333{
334 if (m_pid != LLDB_INVALID_PROCESS_ID)
335 {
336 const char *cstr;
Daniel Malead01b2952012-11-29 21:49:15 +0000337 s.Printf ("%-6" PRIu64 " %-6" PRIu64 " ", m_pid, m_parent_pid);
Greg Clayton32e0a752011-03-30 18:16:51 +0000338
Greg Clayton32e0a752011-03-30 18:16:51 +0000339
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000340 if (verbose)
341 {
Greg Clayton8b82f082011-04-12 05:54:46 +0000342 cstr = platform->GetUserName (m_uid);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000343 if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
344 s.Printf ("%-10s ", cstr);
345 else
Greg Clayton8b82f082011-04-12 05:54:46 +0000346 s.Printf ("%-10u ", m_uid);
Greg Clayton32e0a752011-03-30 18:16:51 +0000347
Greg Clayton8b82f082011-04-12 05:54:46 +0000348 cstr = platform->GetGroupName (m_gid);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000349 if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
350 s.Printf ("%-10s ", cstr);
351 else
Greg Clayton8b82f082011-04-12 05:54:46 +0000352 s.Printf ("%-10u ", m_gid);
Greg Clayton32e0a752011-03-30 18:16:51 +0000353
Greg Clayton8b82f082011-04-12 05:54:46 +0000354 cstr = platform->GetUserName (m_euid);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000355 if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
356 s.Printf ("%-10s ", cstr);
357 else
Greg Clayton8b82f082011-04-12 05:54:46 +0000358 s.Printf ("%-10u ", m_euid);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000359
Greg Clayton8b82f082011-04-12 05:54:46 +0000360 cstr = platform->GetGroupName (m_egid);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000361 if (cstr && cstr[0]) // Watch for empty string that indicates lookup failed
362 s.Printf ("%-10s ", cstr);
363 else
Greg Clayton8b82f082011-04-12 05:54:46 +0000364 s.Printf ("%-10u ", m_egid);
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000365 s.Printf ("%-24s ", m_arch.IsValid() ? m_arch.GetTriple().str().c_str() : "");
366 }
367 else
368 {
Jason Molendafd54b362011-09-20 21:44:10 +0000369 s.Printf ("%-10s %-7d %s ",
Greg Clayton8b82f082011-04-12 05:54:46 +0000370 platform->GetUserName (m_euid),
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000371 (int)m_arch.GetTriple().getArchName().size(),
372 m_arch.GetTriple().getArchName().data());
373 }
374
Greg Clayton8b82f082011-04-12 05:54:46 +0000375 if (verbose || show_args)
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000376 {
Greg Clayton8b82f082011-04-12 05:54:46 +0000377 const uint32_t argc = m_arguments.GetArgumentCount();
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000378 if (argc > 0)
379 {
380 for (uint32_t i=0; i<argc; i++)
381 {
382 if (i > 0)
383 s.PutChar (' ');
Greg Clayton8b82f082011-04-12 05:54:46 +0000384 s.PutCString (m_arguments.GetArgumentAtIndex(i));
Greg Clayton95bf0fd2011-04-01 00:29:43 +0000385 }
386 }
387 }
388 else
389 {
390 s.PutCString (GetName());
391 }
392
393 s.EOL();
Greg Clayton32e0a752011-03-30 18:16:51 +0000394 }
395}
396
Greg Clayton8b82f082011-04-12 05:54:46 +0000397Error
Greg Claytonf6b8b582011-04-13 00:18:08 +0000398ProcessLaunchCommandOptions::SetOptionValue (uint32_t option_idx, const char *option_arg)
Greg Clayton8b82f082011-04-12 05:54:46 +0000399{
400 Error error;
Greg Clayton3bcdfc02012-12-04 00:32:51 +0000401 const int short_option = m_getopt_table[option_idx].val;
Greg Clayton8b82f082011-04-12 05:54:46 +0000402
403 switch (short_option)
404 {
405 case 's': // Stop at program entry point
406 launch_info.GetFlags().Set (eLaunchFlagStopAtEntry);
407 break;
408
Greg Clayton8b82f082011-04-12 05:54:46 +0000409 case 'i': // STDIN for read only
410 {
411 ProcessLaunchInfo::FileAction action;
Greg Clayton9845a8d2012-03-06 04:01:04 +0000412 if (action.Open (STDIN_FILENO, option_arg, true, false))
Greg Clayton8b82f082011-04-12 05:54:46 +0000413 launch_info.AppendFileAction (action);
414 }
415 break;
416
417 case 'o': // Open STDOUT for write only
418 {
419 ProcessLaunchInfo::FileAction action;
Greg Clayton9845a8d2012-03-06 04:01:04 +0000420 if (action.Open (STDOUT_FILENO, option_arg, false, true))
421 launch_info.AppendFileAction (action);
422 }
423 break;
424
425 case 'e': // STDERR for write only
426 {
427 ProcessLaunchInfo::FileAction action;
428 if (action.Open (STDERR_FILENO, option_arg, false, true))
Greg Clayton8b82f082011-04-12 05:54:46 +0000429 launch_info.AppendFileAction (action);
430 }
431 break;
432
Greg Clayton9845a8d2012-03-06 04:01:04 +0000433
Greg Clayton8b82f082011-04-12 05:54:46 +0000434 case 'p': // Process plug-in name
435 launch_info.SetProcessPluginName (option_arg);
436 break;
437
438 case 'n': // Disable STDIO
439 {
440 ProcessLaunchInfo::FileAction action;
Greg Clayton9845a8d2012-03-06 04:01:04 +0000441 if (action.Open (STDIN_FILENO, "/dev/null", true, false))
Greg Clayton8b82f082011-04-12 05:54:46 +0000442 launch_info.AppendFileAction (action);
Greg Clayton9845a8d2012-03-06 04:01:04 +0000443 if (action.Open (STDOUT_FILENO, "/dev/null", false, true))
Greg Clayton8b82f082011-04-12 05:54:46 +0000444 launch_info.AppendFileAction (action);
Greg Clayton9845a8d2012-03-06 04:01:04 +0000445 if (action.Open (STDERR_FILENO, "/dev/null", false, true))
Greg Clayton8b82f082011-04-12 05:54:46 +0000446 launch_info.AppendFileAction (action);
447 }
448 break;
449
450 case 'w':
451 launch_info.SetWorkingDirectory (option_arg);
452 break;
453
454 case 't': // Open process in new terminal window
455 launch_info.GetFlags().Set (eLaunchFlagLaunchInTTY);
456 break;
457
458 case 'a':
Greg Clayton70512312012-05-08 01:45:38 +0000459 if (!launch_info.GetArchitecture().SetTriple (option_arg, m_interpreter.GetPlatform(true).get()))
460 launch_info.GetArchitecture().SetTriple (option_arg);
Greg Clayton8b82f082011-04-12 05:54:46 +0000461 break;
462
463 case 'A':
464 launch_info.GetFlags().Set (eLaunchFlagDisableASLR);
465 break;
466
Greg Clayton982c9762011-11-03 21:22:33 +0000467 case 'c':
Greg Clayton144f3a92011-11-15 03:53:30 +0000468 if (option_arg && option_arg[0])
469 launch_info.SetShell (option_arg);
470 else
Ed Masteb8ca4a22013-09-03 23:04:53 +0000471 launch_info.SetShell (LLDB_DEFAULT_SHELL);
Greg Clayton982c9762011-11-03 21:22:33 +0000472 break;
473
Greg Clayton8b82f082011-04-12 05:54:46 +0000474 case 'v':
475 launch_info.GetEnvironmentEntries().AppendArgument(option_arg);
476 break;
477
478 default:
Greg Clayton86edbf42011-10-26 00:56:27 +0000479 error.SetErrorStringWithFormat("unrecognized short option character '%c'", short_option);
Greg Clayton8b82f082011-04-12 05:54:46 +0000480 break;
481
482 }
483 return error;
484}
485
486OptionDefinition
487ProcessLaunchCommandOptions::g_option_table[] =
488{
Zachary Turnerd37221d2014-07-09 16:31:49 +0000489{ LLDB_OPT_SET_ALL, false, "stop-at-entry", 's', OptionParser::eNoArgument, NULL, NULL, 0, eArgTypeNone, "Stop at the entry point of the program when launching a process."},
490{ LLDB_OPT_SET_ALL, false, "disable-aslr", 'A', OptionParser::eNoArgument, NULL, NULL, 0, eArgTypeNone, "Disable address space layout randomization when launching a process."},
491{ LLDB_OPT_SET_ALL, false, "plugin", 'p', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypePlugin, "Name of the process plugin you want to use."},
492{ LLDB_OPT_SET_ALL, false, "working-dir", 'w', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypeDirectoryName, "Set the current working directory to <path> when running the inferior."},
493{ LLDB_OPT_SET_ALL, false, "arch", 'a', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypeArchitecture, "Set the architecture for the process to launch when ambiguous."},
494{ LLDB_OPT_SET_ALL, false, "environment", 'v', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypeNone, "Specify an environment variable name/value string (--environment NAME=VALUE). Can be specified multiple times for subsequent environment entries."},
495{ LLDB_OPT_SET_ALL, false, "shell", 'c', OptionParser::eOptionalArgument, NULL, NULL, 0, eArgTypeFilename, "Run the process in a shell (not supported on all platforms)."},
Greg Clayton8b82f082011-04-12 05:54:46 +0000496
Zachary Turnerd37221d2014-07-09 16:31:49 +0000497{ LLDB_OPT_SET_1 , false, "stdin", 'i', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypeFilename, "Redirect stdin for the process to <filename>."},
498{ LLDB_OPT_SET_1 , false, "stdout", 'o', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypeFilename, "Redirect stdout for the process to <filename>."},
499{ LLDB_OPT_SET_1 , false, "stderr", 'e', OptionParser::eRequiredArgument, NULL, NULL, 0, eArgTypeFilename, "Redirect stderr for the process to <filename>."},
Greg Clayton8b82f082011-04-12 05:54:46 +0000500
Zachary Turnerd37221d2014-07-09 16:31:49 +0000501{ LLDB_OPT_SET_2 , false, "tty", 't', OptionParser::eNoArgument, NULL, NULL, 0, eArgTypeNone, "Start the process in a terminal (not supported on all platforms)."},
Greg Clayton8b82f082011-04-12 05:54:46 +0000502
Zachary Turnerd37221d2014-07-09 16:31:49 +0000503{ LLDB_OPT_SET_3 , false, "no-stdio", 'n', OptionParser::eNoArgument, NULL, NULL, 0, eArgTypeNone, "Do not set up for terminal I/O to go to running process."},
Greg Clayton8b82f082011-04-12 05:54:46 +0000504
Zachary Turnerd37221d2014-07-09 16:31:49 +0000505{ 0 , false, NULL, 0, 0, NULL, NULL, 0, eArgTypeNone, NULL }
Greg Clayton8b82f082011-04-12 05:54:46 +0000506};
507
508
509
510bool
511ProcessInstanceInfoMatch::NameMatches (const char *process_name) const
Greg Clayton32e0a752011-03-30 18:16:51 +0000512{
513 if (m_name_match_type == eNameMatchIgnore || process_name == NULL)
514 return true;
515 const char *match_name = m_match_info.GetName();
516 if (!match_name)
517 return true;
518
519 return lldb_private::NameMatches (process_name, m_name_match_type, match_name);
520}
521
522bool
Greg Clayton8b82f082011-04-12 05:54:46 +0000523ProcessInstanceInfoMatch::Matches (const ProcessInstanceInfo &proc_info) const
Greg Clayton32e0a752011-03-30 18:16:51 +0000524{
525 if (!NameMatches (proc_info.GetName()))
526 return false;
527
528 if (m_match_info.ProcessIDIsValid() &&
529 m_match_info.GetProcessID() != proc_info.GetProcessID())
530 return false;
531
532 if (m_match_info.ParentProcessIDIsValid() &&
533 m_match_info.GetParentProcessID() != proc_info.GetParentProcessID())
534 return false;
535
Greg Clayton8b82f082011-04-12 05:54:46 +0000536 if (m_match_info.UserIDIsValid () &&
537 m_match_info.GetUserID() != proc_info.GetUserID())
Greg Clayton32e0a752011-03-30 18:16:51 +0000538 return false;
539
Greg Clayton8b82f082011-04-12 05:54:46 +0000540 if (m_match_info.GroupIDIsValid () &&
541 m_match_info.GetGroupID() != proc_info.GetGroupID())
Greg Clayton32e0a752011-03-30 18:16:51 +0000542 return false;
543
544 if (m_match_info.EffectiveUserIDIsValid () &&
545 m_match_info.GetEffectiveUserID() != proc_info.GetEffectiveUserID())
546 return false;
547
548 if (m_match_info.EffectiveGroupIDIsValid () &&
549 m_match_info.GetEffectiveGroupID() != proc_info.GetEffectiveGroupID())
550 return false;
551
552 if (m_match_info.GetArchitecture().IsValid() &&
Sean Callananbf4b7be2012-12-13 22:07:14 +0000553 !m_match_info.GetArchitecture().IsCompatibleMatch(proc_info.GetArchitecture()))
Greg Clayton32e0a752011-03-30 18:16:51 +0000554 return false;
555 return true;
556}
557
558bool
Greg Clayton8b82f082011-04-12 05:54:46 +0000559ProcessInstanceInfoMatch::MatchAllProcesses () const
Greg Clayton32e0a752011-03-30 18:16:51 +0000560{
561 if (m_name_match_type != eNameMatchIgnore)
562 return false;
563
564 if (m_match_info.ProcessIDIsValid())
565 return false;
566
567 if (m_match_info.ParentProcessIDIsValid())
568 return false;
569
Greg Clayton8b82f082011-04-12 05:54:46 +0000570 if (m_match_info.UserIDIsValid ())
Greg Clayton32e0a752011-03-30 18:16:51 +0000571 return false;
572
Greg Clayton8b82f082011-04-12 05:54:46 +0000573 if (m_match_info.GroupIDIsValid ())
Greg Clayton32e0a752011-03-30 18:16:51 +0000574 return false;
575
576 if (m_match_info.EffectiveUserIDIsValid ())
577 return false;
578
579 if (m_match_info.EffectiveGroupIDIsValid ())
580 return false;
581
582 if (m_match_info.GetArchitecture().IsValid())
583 return false;
584
585 if (m_match_all_users)
586 return false;
587
588 return true;
589
590}
591
592void
Greg Clayton8b82f082011-04-12 05:54:46 +0000593ProcessInstanceInfoMatch::Clear()
Greg Clayton32e0a752011-03-30 18:16:51 +0000594{
595 m_match_info.Clear();
596 m_name_match_type = eNameMatchIgnore;
597 m_match_all_users = false;
598}
Greg Clayton58be07b2011-01-07 06:08:19 +0000599
Greg Claytonc3776bf2012-02-09 06:16:32 +0000600ProcessSP
601Process::FindPlugin (Target &target, const char *plugin_name, Listener &listener, const FileSpec *crash_file_path)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000602{
Greg Clayton949e8222013-01-16 17:29:04 +0000603 static uint32_t g_process_unique_id = 0;
604
Greg Claytonc3776bf2012-02-09 06:16:32 +0000605 ProcessSP process_sp;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000606 ProcessCreateInstance create_callback = NULL;
607 if (plugin_name)
608 {
Greg Clayton57abc5d2013-05-10 21:47:16 +0000609 ConstString const_plugin_name(plugin_name);
610 create_callback = PluginManager::GetProcessCreateCallbackForPluginName (const_plugin_name);
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000611 if (create_callback)
612 {
Greg Claytonc3776bf2012-02-09 06:16:32 +0000613 process_sp = create_callback(target, listener, crash_file_path);
614 if (process_sp)
615 {
Greg Clayton949e8222013-01-16 17:29:04 +0000616 if (process_sp->CanDebug(target, true))
617 {
618 process_sp->m_process_unique_id = ++g_process_unique_id;
619 }
620 else
Greg Claytonc3776bf2012-02-09 06:16:32 +0000621 process_sp.reset();
622 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000623 }
624 }
625 else
626 {
Greg Claytonc982c762010-07-09 20:39:50 +0000627 for (uint32_t idx = 0; (create_callback = PluginManager::GetProcessCreateCallbackAtIndex(idx)) != NULL; ++idx)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000628 {
Greg Claytonc3776bf2012-02-09 06:16:32 +0000629 process_sp = create_callback(target, listener, crash_file_path);
630 if (process_sp)
631 {
Greg Clayton949e8222013-01-16 17:29:04 +0000632 if (process_sp->CanDebug(target, false))
633 {
634 process_sp->m_process_unique_id = ++g_process_unique_id;
Greg Claytonc3776bf2012-02-09 06:16:32 +0000635 break;
Greg Clayton949e8222013-01-16 17:29:04 +0000636 }
637 else
638 process_sp.reset();
Greg Claytonc3776bf2012-02-09 06:16:32 +0000639 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000640 }
641 }
Greg Claytonc3776bf2012-02-09 06:16:32 +0000642 return process_sp;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000643}
644
Jim Ingham4bddaeb2012-02-16 06:50:00 +0000645ConstString &
646Process::GetStaticBroadcasterClass ()
647{
648 static ConstString class_name ("lldb.process");
649 return class_name;
650}
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000651
652//----------------------------------------------------------------------
653// Process constructor
654//----------------------------------------------------------------------
655Process::Process(Target &target, Listener &listener) :
Greg Clayton67cc0632012-08-22 17:17:09 +0000656 ProcessProperties (false),
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000657 UserID (LLDB_INVALID_PROCESS_ID),
Jim Ingham4bddaeb2012-02-16 06:50:00 +0000658 Broadcaster (&(target.GetDebugger()), "lldb.process"),
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000659 m_target (target),
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000660 m_public_state (eStateUnloaded),
661 m_private_state (eStateUnloaded),
Jim Ingham4bddaeb2012-02-16 06:50:00 +0000662 m_private_state_broadcaster (NULL, "lldb.process.internal_state_broadcaster"),
663 m_private_state_control_broadcaster (NULL, "lldb.process.internal_state_control_broadcaster"),
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000664 m_private_state_listener ("lldb.process.internal_state_listener"),
665 m_private_state_control_wait(),
666 m_private_state_thread (LLDB_INVALID_HOST_THREAD),
Jim Ingham4b536182011-08-09 02:12:22 +0000667 m_mod_id (),
Greg Clayton949e8222013-01-16 17:29:04 +0000668 m_process_unique_id(0),
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000669 m_thread_index_id (0),
Han Ming Ongc2c423e2013-01-08 22:10:01 +0000670 m_thread_id_to_index_id_map (),
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000671 m_exit_status (-1),
672 m_exit_string (),
Andrew Kaylorba4e61d2013-05-07 18:35:34 +0000673 m_thread_mutex (Mutex::eMutexTypeRecursive),
674 m_thread_list_real (this),
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000675 m_thread_list (this),
Jason Molenda864f1cc2013-11-11 05:20:44 +0000676 m_extended_thread_list (this),
Jason Molenda4ff13262013-11-20 00:31:38 +0000677 m_extended_thread_stop_id (0),
Jason Molenda5e8dce42013-12-13 00:29:16 +0000678 m_queue_list (this),
679 m_queue_list_stop_id (0),
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000680 m_notifications (),
Greg Clayton3af9ea52010-11-18 05:57:03 +0000681 m_image_tokens (),
682 m_listener (listener),
683 m_breakpoint_site_list (),
Greg Clayton3af9ea52010-11-18 05:57:03 +0000684 m_dynamic_checkers_ap (),
Caroline Ticeef5c6d02010-11-16 05:07:41 +0000685 m_unix_signals (),
Greg Clayton3af9ea52010-11-18 05:57:03 +0000686 m_abi_sp (),
Caroline Ticeef5c6d02010-11-16 05:07:41 +0000687 m_process_input_reader (),
Greg Clayton3e06bd92011-01-09 21:07:35 +0000688 m_stdio_communication ("process.stdio"),
Greg Clayton3af9ea52010-11-18 05:57:03 +0000689 m_stdio_communication_mutex (Mutex::eMutexTypeRecursive),
Greg Clayton58be07b2011-01-07 06:08:19 +0000690 m_stdout_data (),
Greg Clayton93e86192011-11-13 04:45:22 +0000691 m_stderr_data (),
Han Ming Ongab3b8b22012-11-17 00:21:04 +0000692 m_profile_data_comm_mutex (Mutex::eMutexTypeRecursive),
693 m_profile_data (),
Greg Claytond495c532011-05-17 03:37:42 +0000694 m_memory_cache (*this),
695 m_allocated_memory_cache (*this),
Greg Claytone24c4ac2011-11-17 04:46:02 +0000696 m_should_detach (false),
Sean Callanan90539452011-09-20 23:01:51 +0000697 m_next_event_action_ap(),
Greg Clayton96249852013-04-18 16:57:27 +0000698 m_public_run_lock (),
Greg Clayton96249852013-04-18 16:57:27 +0000699 m_private_run_lock (),
Jim Inghamaacc3182012-06-06 00:29:30 +0000700 m_currently_handling_event(false),
Jim Ingham4fc6cb92012-08-22 21:34:33 +0000701 m_finalize_called(false),
Greg Claytonf9b57b92013-05-10 23:48:10 +0000702 m_clear_thread_plans_on_stop (false),
Jim Ingham1460e4b2014-01-10 23:46:59 +0000703 m_force_next_event_delivery(false),
Jim Ingham0161b492013-02-09 01:29:05 +0000704 m_last_broadcast_state (eStateInvalid),
Jason Molenda69b6b632013-03-05 03:33:59 +0000705 m_destroy_in_process (false),
706 m_can_jit(eCanJITDontKnow)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000707{
Jim Ingham4bddaeb2012-02-16 06:50:00 +0000708 CheckInWithManager ();
Caroline Tice1559a462010-09-27 00:30:10 +0000709
Greg Clayton5160ce52013-03-27 23:08:40 +0000710 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_OBJECT));
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000711 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +0000712 log->Printf ("%p Process::Process()", static_cast<void*>(this));
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000713
Greg Claytoncfd1ace2010-10-31 03:01:06 +0000714 SetEventName (eBroadcastBitStateChanged, "state-changed");
715 SetEventName (eBroadcastBitInterrupt, "interrupt");
716 SetEventName (eBroadcastBitSTDOUT, "stdout-available");
717 SetEventName (eBroadcastBitSTDERR, "stderr-available");
Han Ming Ongab3b8b22012-11-17 00:21:04 +0000718 SetEventName (eBroadcastBitProfileData, "profile-data-available");
Greg Claytoncfd1ace2010-10-31 03:01:06 +0000719
Greg Clayton35a4cc52012-10-29 20:52:08 +0000720 m_private_state_control_broadcaster.SetEventName (eBroadcastInternalStateControlStop , "control-stop" );
721 m_private_state_control_broadcaster.SetEventName (eBroadcastInternalStateControlPause , "control-pause" );
722 m_private_state_control_broadcaster.SetEventName (eBroadcastInternalStateControlResume, "control-resume");
723
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000724 listener.StartListeningForEvents (this,
725 eBroadcastBitStateChanged |
726 eBroadcastBitInterrupt |
727 eBroadcastBitSTDOUT |
Han Ming Ongab3b8b22012-11-17 00:21:04 +0000728 eBroadcastBitSTDERR |
729 eBroadcastBitProfileData);
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000730
731 m_private_state_listener.StartListeningForEvents(&m_private_state_broadcaster,
Jim Inghamcfc09352012-07-27 23:57:19 +0000732 eBroadcastBitStateChanged |
733 eBroadcastBitInterrupt);
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000734
735 m_private_state_listener.StartListeningForEvents(&m_private_state_control_broadcaster,
736 eBroadcastInternalStateControlStop |
737 eBroadcastInternalStateControlPause |
738 eBroadcastInternalStateControlResume);
739}
740
741//----------------------------------------------------------------------
742// Destructor
743//----------------------------------------------------------------------
744Process::~Process()
745{
Greg Clayton5160ce52013-03-27 23:08:40 +0000746 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_OBJECT));
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000747 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +0000748 log->Printf ("%p Process::~Process()", static_cast<void*>(this));
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000749 StopPrivateStateThread();
750}
751
Greg Clayton67cc0632012-08-22 17:17:09 +0000752const ProcessPropertiesSP &
753Process::GetGlobalProperties()
754{
755 static ProcessPropertiesSP g_settings_sp;
756 if (!g_settings_sp)
757 g_settings_sp.reset (new ProcessProperties (true));
758 return g_settings_sp;
759}
760
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000761void
762Process::Finalize()
763{
Greg Claytone24c4ac2011-11-17 04:46:02 +0000764 switch (GetPrivateState())
765 {
766 case eStateConnected:
767 case eStateAttaching:
768 case eStateLaunching:
769 case eStateStopped:
770 case eStateRunning:
771 case eStateStepping:
772 case eStateCrashed:
773 case eStateSuspended:
774 if (GetShouldDetach())
Jim Inghamacff8952013-05-02 00:27:30 +0000775 {
776 // FIXME: This will have to be a process setting:
777 bool keep_stopped = false;
778 Detach(keep_stopped);
779 }
Greg Claytone24c4ac2011-11-17 04:46:02 +0000780 else
781 Destroy();
782 break;
783
784 case eStateInvalid:
785 case eStateUnloaded:
786 case eStateDetached:
787 case eStateExited:
788 break;
789 }
790
Greg Clayton1ed54f52011-10-01 00:45:15 +0000791 // Clear our broadcaster before we proceed with destroying
792 Broadcaster::Clear();
793
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000794 // Do any cleanup needed prior to being destructed... Subclasses
795 // that override this method should call this superclass method as well.
Jim Inghamd0a3e122011-02-16 17:54:55 +0000796
797 // We need to destroy the loader before the derived Process class gets destroyed
798 // since it is very likely that undoing the loader will require access to the real process.
Greg Clayton894f82f2012-01-20 23:08:34 +0000799 m_dynamic_checkers_ap.reset();
800 m_abi_sp.reset();
Greg Clayton56d9a1b2011-08-22 02:49:39 +0000801 m_os_ap.reset();
Jason Molendaeef51062013-11-05 03:57:19 +0000802 m_system_runtime_ap.reset();
Greg Clayton894f82f2012-01-20 23:08:34 +0000803 m_dyld_ap.reset();
Andrew MacPherson17220c12014-03-05 10:12:43 +0000804 m_jit_loaders_ap.reset();
Andrew Kaylorba4e61d2013-05-07 18:35:34 +0000805 m_thread_list_real.Destroy();
Greg Claytone1cd1be2012-01-29 20:56:30 +0000806 m_thread_list.Destroy();
Jason Molenda864f1cc2013-11-11 05:20:44 +0000807 m_extended_thread_list.Destroy();
Jason Molenda5e8dce42013-12-13 00:29:16 +0000808 m_queue_list.Clear();
809 m_queue_list_stop_id = 0;
Greg Clayton894f82f2012-01-20 23:08:34 +0000810 std::vector<Notifications> empty_notifications;
811 m_notifications.swap(empty_notifications);
812 m_image_tokens.clear();
813 m_memory_cache.Clear();
814 m_allocated_memory_cache.Clear();
815 m_language_runtimes.clear();
816 m_next_event_action_ap.reset();
Greg Clayton35a4cc52012-10-29 20:52:08 +0000817//#ifdef LLDB_CONFIGURATION_DEBUG
818// StreamFile s(stdout, false);
819// EventSP event_sp;
820// while (m_private_state_listener.GetNextEvent(event_sp))
821// {
822// event_sp->Dump (&s);
823// s.EOL();
824// }
825//#endif
826 // We have to be very careful here as the m_private_state_listener might
827 // contain events that have ProcessSP values in them which can keep this
828 // process around forever. These events need to be cleared out.
829 m_private_state_listener.Clear();
Ed Maste64fad602013-07-29 20:58:06 +0000830 m_public_run_lock.TrySetRunning(); // This will do nothing if already locked
831 m_public_run_lock.SetStopped();
832 m_private_run_lock.TrySetRunning(); // This will do nothing if already locked
833 m_private_run_lock.SetStopped();
Jim Ingham4fc6cb92012-08-22 21:34:33 +0000834 m_finalize_called = true;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000835}
836
837void
838Process::RegisterNotificationCallbacks (const Notifications& callbacks)
839{
840 m_notifications.push_back(callbacks);
841 if (callbacks.initialize != NULL)
842 callbacks.initialize (callbacks.baton, this);
843}
844
845bool
846Process::UnregisterNotificationCallbacks(const Notifications& callbacks)
847{
848 std::vector<Notifications>::iterator pos, end = m_notifications.end();
849 for (pos = m_notifications.begin(); pos != end; ++pos)
850 {
851 if (pos->baton == callbacks.baton &&
852 pos->initialize == callbacks.initialize &&
853 pos->process_state_changed == callbacks.process_state_changed)
854 {
855 m_notifications.erase(pos);
856 return true;
857 }
858 }
859 return false;
860}
861
862void
863Process::SynchronouslyNotifyStateChanged (StateType state)
864{
865 std::vector<Notifications>::iterator notification_pos, notification_end = m_notifications.end();
866 for (notification_pos = m_notifications.begin(); notification_pos != notification_end; ++notification_pos)
867 {
868 if (notification_pos->process_state_changed)
869 notification_pos->process_state_changed (notification_pos->baton, this, state);
870 }
871}
872
873// FIXME: We need to do some work on events before the general Listener sees them.
874// For instance if we are continuing from a breakpoint, we need to ensure that we do
875// the little "insert real insn, step & stop" trick. But we can't do that when the
876// event is delivered by the broadcaster - since that is done on the thread that is
877// waiting for new events, so if we needed more than one event for our handling, we would
878// stall. So instead we do it when we fetch the event off of the queue.
879//
880
881StateType
882Process::GetNextEvent (EventSP &event_sp)
883{
884 StateType state = eStateInvalid;
885
886 if (m_listener.GetNextEventForBroadcaster (this, event_sp) && event_sp)
887 state = Process::ProcessEventData::GetStateFromEvent (event_sp.get());
888
889 return state;
890}
891
892
893StateType
Greg Clayton44d93782014-01-27 23:43:24 +0000894Process::WaitForProcessToStop (const TimeValue *timeout, lldb::EventSP *event_sp_ptr, bool wait_always, Listener *hijack_listener)
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000895{
Jim Ingham4b536182011-08-09 02:12:22 +0000896 // We can't just wait for a "stopped" event, because the stopped event may have restarted the target.
897 // We have to actually check each event, and in the case of a stopped event check the restarted flag
898 // on the event.
Greg Clayton85fb1b92012-09-11 02:33:37 +0000899 if (event_sp_ptr)
900 event_sp_ptr->reset();
Jim Ingham4b536182011-08-09 02:12:22 +0000901 StateType state = GetState();
902 // If we are exited or detached, we won't ever get back to any
903 // other valid state...
904 if (state == eStateDetached || state == eStateExited)
905 return state;
906
Daniel Malea9e9919f2013-10-09 16:56:28 +0000907 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
908 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +0000909 log->Printf ("Process::%s (timeout = %p)", __FUNCTION__,
910 static_cast<const void*>(timeout));
Daniel Malea9e9919f2013-10-09 16:56:28 +0000911
912 if (!wait_always &&
913 StateIsStoppedState(state, true) &&
914 StateIsStoppedState(GetPrivateState(), true)) {
915 if (log)
916 log->Printf("Process::%s returning without waiting for events; process private and public states are already 'stopped'.",
917 __FUNCTION__);
918 return state;
919 }
920
Jim Ingham4b536182011-08-09 02:12:22 +0000921 while (state != eStateInvalid)
922 {
Greg Clayton85fb1b92012-09-11 02:33:37 +0000923 EventSP event_sp;
Greg Clayton44d93782014-01-27 23:43:24 +0000924 state = WaitForStateChangedEvents (timeout, event_sp, hijack_listener);
Greg Clayton85fb1b92012-09-11 02:33:37 +0000925 if (event_sp_ptr && event_sp)
926 *event_sp_ptr = event_sp;
927
Jim Ingham4b536182011-08-09 02:12:22 +0000928 switch (state)
929 {
930 case eStateCrashed:
931 case eStateDetached:
932 case eStateExited:
933 case eStateUnloaded:
Greg Clayton44d93782014-01-27 23:43:24 +0000934 // We need to toggle the run lock as this won't get done in
935 // SetPublicState() if the process is hijacked.
936 if (hijack_listener)
937 m_public_run_lock.SetStopped();
Jim Ingham4b536182011-08-09 02:12:22 +0000938 return state;
939 case eStateStopped:
940 if (Process::ProcessEventData::GetRestartedFromEvent(event_sp.get()))
941 continue;
942 else
Greg Clayton44d93782014-01-27 23:43:24 +0000943 {
944 // We need to toggle the run lock as this won't get done in
945 // SetPublicState() if the process is hijacked.
946 if (hijack_listener)
947 m_public_run_lock.SetStopped();
Jim Ingham4b536182011-08-09 02:12:22 +0000948 return state;
Greg Clayton44d93782014-01-27 23:43:24 +0000949 }
Jim Ingham4b536182011-08-09 02:12:22 +0000950 default:
951 continue;
952 }
953 }
954 return state;
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000955}
956
957
958StateType
959Process::WaitForState
960(
961 const TimeValue *timeout,
Greg Clayton44d93782014-01-27 23:43:24 +0000962 const StateType *match_states,
963 const uint32_t num_match_states
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000964)
965{
966 EventSP event_sp;
967 uint32_t i;
Greg Clayton05faeb72010-10-07 04:19:01 +0000968 StateType state = GetState();
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000969 while (state != eStateInvalid)
970 {
Greg Clayton05faeb72010-10-07 04:19:01 +0000971 // If we are exited or detached, we won't ever get back to any
972 // other valid state...
973 if (state == eStateDetached || state == eStateExited)
974 return state;
975
Greg Clayton44d93782014-01-27 23:43:24 +0000976 state = WaitForStateChangedEvents (timeout, event_sp, NULL);
Chris Lattner30fdc8d2010-06-08 16:52:24 +0000977
978 for (i=0; i<num_match_states; ++i)
979 {
980 if (match_states[i] == state)
981 return state;
982 }
983 }
984 return state;
985}
986
Jim Ingham30f9b212010-10-11 23:53:14 +0000987bool
988Process::HijackProcessEvents (Listener *listener)
989{
990 if (listener != NULL)
991 {
Jim Inghamcfc09352012-07-27 23:57:19 +0000992 return HijackBroadcaster(listener, eBroadcastBitStateChanged | eBroadcastBitInterrupt);
Jim Ingham30f9b212010-10-11 23:53:14 +0000993 }
994 else
995 return false;
996}
997
998void
999Process::RestoreProcessEvents ()
1000{
1001 RestoreBroadcaster();
1002}
1003
Jim Ingham0f16e732011-02-08 05:20:59 +00001004bool
1005Process::HijackPrivateProcessEvents (Listener *listener)
1006{
1007 if (listener != NULL)
1008 {
Jim Inghamcfc09352012-07-27 23:57:19 +00001009 return m_private_state_broadcaster.HijackBroadcaster(listener, eBroadcastBitStateChanged | eBroadcastBitInterrupt);
Jim Ingham0f16e732011-02-08 05:20:59 +00001010 }
1011 else
1012 return false;
1013}
1014
1015void
1016Process::RestorePrivateProcessEvents ()
1017{
1018 m_private_state_broadcaster.RestoreBroadcaster();
1019}
1020
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001021StateType
Greg Clayton44d93782014-01-27 23:43:24 +00001022Process::WaitForStateChangedEvents (const TimeValue *timeout, EventSP &event_sp, Listener *hijack_listener)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001023{
Greg Clayton5160ce52013-03-27 23:08:40 +00001024 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001025
1026 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00001027 log->Printf ("Process::%s (timeout = %p, event_sp)...", __FUNCTION__,
1028 static_cast<const void*>(timeout));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001029
Greg Clayton44d93782014-01-27 23:43:24 +00001030 Listener *listener = hijack_listener;
1031 if (listener == NULL)
1032 listener = &m_listener;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00001033
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001034 StateType state = eStateInvalid;
Greg Clayton44d93782014-01-27 23:43:24 +00001035 if (listener->WaitForEventForBroadcasterWithType (timeout,
1036 this,
1037 eBroadcastBitStateChanged | eBroadcastBitInterrupt,
1038 event_sp))
Jim Inghamcfc09352012-07-27 23:57:19 +00001039 {
1040 if (event_sp && event_sp->GetType() == eBroadcastBitStateChanged)
1041 state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
1042 else if (log)
1043 log->Printf ("Process::%s got no event or was interrupted.", __FUNCTION__);
1044 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001045
1046 if (log)
1047 log->Printf ("Process::%s (timeout = %p, event_sp) => %s",
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00001048 __FUNCTION__, static_cast<const void*>(timeout),
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001049 StateAsCString(state));
1050 return state;
1051}
1052
1053Event *
1054Process::PeekAtStateChangedEvents ()
1055{
Greg Clayton5160ce52013-03-27 23:08:40 +00001056 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001057
1058 if (log)
1059 log->Printf ("Process::%s...", __FUNCTION__);
1060
1061 Event *event_ptr;
Greg Clayton3fcbed62010-10-19 03:25:40 +00001062 event_ptr = m_listener.PeekAtNextEventForBroadcasterWithType (this,
1063 eBroadcastBitStateChanged);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001064 if (log)
1065 {
1066 if (event_ptr)
1067 {
1068 log->Printf ("Process::%s (event_ptr) => %s",
1069 __FUNCTION__,
1070 StateAsCString(ProcessEventData::GetStateFromEvent (event_ptr)));
1071 }
1072 else
1073 {
1074 log->Printf ("Process::%s no events found",
1075 __FUNCTION__);
1076 }
1077 }
1078 return event_ptr;
1079}
1080
1081StateType
1082Process::WaitForStateChangedEventsPrivate (const TimeValue *timeout, EventSP &event_sp)
1083{
Greg Clayton5160ce52013-03-27 23:08:40 +00001084 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001085
1086 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00001087 log->Printf ("Process::%s (timeout = %p, event_sp)...", __FUNCTION__,
1088 static_cast<const void*>(timeout));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001089
1090 StateType state = eStateInvalid;
Greg Clayton6779606a2011-01-22 23:43:18 +00001091 if (m_private_state_listener.WaitForEventForBroadcasterWithType (timeout,
1092 &m_private_state_broadcaster,
Jim Inghamcfc09352012-07-27 23:57:19 +00001093 eBroadcastBitStateChanged | eBroadcastBitInterrupt,
Greg Clayton6779606a2011-01-22 23:43:18 +00001094 event_sp))
Jim Inghamcfc09352012-07-27 23:57:19 +00001095 if (event_sp && event_sp->GetType() == eBroadcastBitStateChanged)
1096 state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001097
1098 // This is a bit of a hack, but when we wait here we could very well return
1099 // to the command-line, and that could disable the log, which would render the
1100 // log we got above invalid.
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001101 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00001102 log->Printf ("Process::%s (timeout = %p, event_sp) => %s",
1103 __FUNCTION__, static_cast<const void *>(timeout),
1104 state == eStateInvalid ? "TIMEOUT" : StateAsCString(state));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001105 return state;
1106}
1107
1108bool
1109Process::WaitForEventsPrivate (const TimeValue *timeout, EventSP &event_sp, bool control_only)
1110{
Greg Clayton5160ce52013-03-27 23:08:40 +00001111 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001112
1113 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00001114 log->Printf ("Process::%s (timeout = %p, event_sp)...", __FUNCTION__,
1115 static_cast<const void*>(timeout));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001116
1117 if (control_only)
1118 return m_private_state_listener.WaitForEventForBroadcaster(timeout, &m_private_state_control_broadcaster, event_sp);
1119 else
1120 return m_private_state_listener.WaitForEvent(timeout, event_sp);
1121}
1122
1123bool
1124Process::IsRunning () const
1125{
1126 return StateIsRunningState (m_public_state.GetValue());
1127}
1128
1129int
1130Process::GetExitStatus ()
1131{
1132 if (m_public_state.GetValue() == eStateExited)
1133 return m_exit_status;
1134 return -1;
1135}
1136
Greg Clayton85851dd2010-12-04 00:10:17 +00001137
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001138const char *
1139Process::GetExitDescription ()
1140{
1141 if (m_public_state.GetValue() == eStateExited && !m_exit_string.empty())
1142 return m_exit_string.c_str();
1143 return NULL;
1144}
1145
Greg Clayton6779606a2011-01-22 23:43:18 +00001146bool
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001147Process::SetExitStatus (int status, const char *cstr)
1148{
Greg Clayton5160ce52013-03-27 23:08:40 +00001149 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
Greg Clayton414f5d32011-01-25 02:58:48 +00001150 if (log)
1151 log->Printf("Process::SetExitStatus (status=%i (0x%8.8x), description=%s%s%s)",
1152 status, status,
1153 cstr ? "\"" : "",
1154 cstr ? cstr : "NULL",
1155 cstr ? "\"" : "");
1156
Greg Clayton6779606a2011-01-22 23:43:18 +00001157 // We were already in the exited state
1158 if (m_private_state.GetValue() == eStateExited)
Greg Clayton414f5d32011-01-25 02:58:48 +00001159 {
Greg Clayton385d6032011-01-26 23:47:29 +00001160 if (log)
1161 log->Printf("Process::SetExitStatus () ignoring exit status because state was already set to eStateExited");
Greg Clayton6779606a2011-01-22 23:43:18 +00001162 return false;
Greg Clayton414f5d32011-01-25 02:58:48 +00001163 }
Greg Clayton6779606a2011-01-22 23:43:18 +00001164
1165 m_exit_status = status;
1166 if (cstr)
1167 m_exit_string = cstr;
1168 else
1169 m_exit_string.clear();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001170
Greg Clayton6779606a2011-01-22 23:43:18 +00001171 DidExit ();
Greg Clayton10177aa2010-12-08 05:08:21 +00001172
Greg Clayton6779606a2011-01-22 23:43:18 +00001173 SetPrivateState (eStateExited);
1174 return true;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001175}
1176
1177// This static callback can be used to watch for local child processes on
Bruce Mitchenerd93c4a32014-07-01 21:22:11 +00001178// the current host. The child process exits, the process will be
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001179// found in the global target list (we want to be completely sure that the
1180// lldb_private::Process doesn't go away before we can deliver the signal.
1181bool
Greg Claytone4e45922011-11-16 05:37:56 +00001182Process::SetProcessExitStatus (void *callback_baton,
1183 lldb::pid_t pid,
1184 bool exited,
1185 int signo, // Zero for no signal
1186 int exit_status // Exit value of process if signal is zero
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001187)
1188{
Greg Clayton5160ce52013-03-27 23:08:40 +00001189 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_PROCESS));
Greg Claytone4e45922011-11-16 05:37:56 +00001190 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00001191 log->Printf ("Process::SetProcessExitStatus (baton=%p, pid=%" PRIu64 ", exited=%i, signal=%i, exit_status=%i)\n",
Greg Claytone4e45922011-11-16 05:37:56 +00001192 callback_baton,
1193 pid,
1194 exited,
1195 signo,
1196 exit_status);
1197
1198 if (exited)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001199 {
Greg Clayton66111032010-06-23 01:19:29 +00001200 TargetSP target_sp(Debugger::FindTargetWithProcessID (pid));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001201 if (target_sp)
1202 {
1203 ProcessSP process_sp (target_sp->GetProcessSP());
1204 if (process_sp)
1205 {
1206 const char *signal_cstr = NULL;
1207 if (signo)
1208 signal_cstr = process_sp->GetUnixSignals().GetSignalAsCString (signo);
1209
1210 process_sp->SetExitStatus (exit_status, signal_cstr);
1211 }
1212 }
1213 return true;
1214 }
1215 return false;
1216}
1217
1218
Greg Clayton56d9a1b2011-08-22 02:49:39 +00001219void
1220Process::UpdateThreadListIfNeeded ()
1221{
1222 const uint32_t stop_id = GetStopID();
1223 if (m_thread_list.GetSize(false) == 0 || stop_id != m_thread_list.GetStopID())
1224 {
Greg Clayton2637f822011-11-17 01:23:07 +00001225 const StateType state = GetPrivateState();
1226 if (StateIsStoppedState (state, true))
1227 {
1228 Mutex::Locker locker (m_thread_list.GetMutex ());
Greg Claytone24c4ac2011-11-17 04:46:02 +00001229 // m_thread_list does have its own mutex, but we need to
1230 // hold onto the mutex between the call to UpdateThreadList(...)
1231 // and the os->UpdateThreadList(...) so it doesn't change on us
Andrew Kaylorba4e61d2013-05-07 18:35:34 +00001232 ThreadList &old_thread_list = m_thread_list;
1233 ThreadList real_thread_list(this);
Greg Clayton2637f822011-11-17 01:23:07 +00001234 ThreadList new_thread_list(this);
1235 // Always update the thread list with the protocol specific
Greg Clayton9fc13552012-04-10 00:18:59 +00001236 // thread list, but only update if "true" is returned
Andrew Kaylorba4e61d2013-05-07 18:35:34 +00001237 if (UpdateThreadList (m_thread_list_real, real_thread_list))
Greg Clayton9fc13552012-04-10 00:18:59 +00001238 {
Jim Ingham09437922013-03-01 20:04:25 +00001239 // Don't call into the OperatingSystem to update the thread list if we are shutting down, since
1240 // that may call back into the SBAPI's, requiring the API lock which is already held by whoever is
1241 // shutting us down, causing a deadlock.
1242 if (!m_destroy_in_process)
1243 {
1244 OperatingSystem *os = GetOperatingSystem ();
1245 if (os)
Greg Claytonb3ae8762013-04-12 20:07:46 +00001246 {
1247 // Clear any old backing threads where memory threads might have been
1248 // backed by actual threads from the lldb_private::Process subclass
Andrew Kaylorba4e61d2013-05-07 18:35:34 +00001249 size_t num_old_threads = old_thread_list.GetSize(false);
Greg Claytonb3ae8762013-04-12 20:07:46 +00001250 for (size_t i=0; i<num_old_threads; ++i)
Andrew Kaylorba4e61d2013-05-07 18:35:34 +00001251 old_thread_list.GetThreadAtIndex(i, false)->ClearBackingThread();
Greg Claytonb3ae8762013-04-12 20:07:46 +00001252
1253 // Now let the OperatingSystem plug-in update the thread list
Andrew Kaylorba4e61d2013-05-07 18:35:34 +00001254 os->UpdateThreadList (old_thread_list, // Old list full of threads created by OS plug-in
1255 real_thread_list, // The actual thread list full of threads created by each lldb_private::Process subclass
1256 new_thread_list); // The new thread list that we will show to the user that gets filled in
Greg Claytonb3ae8762013-04-12 20:07:46 +00001257 }
Andrew Kaylorba4e61d2013-05-07 18:35:34 +00001258 else
1259 {
1260 // No OS plug-in, the new thread list is the same as the real thread list
1261 new_thread_list = real_thread_list;
1262 }
Jim Ingham09437922013-03-01 20:04:25 +00001263 }
Jim Ingham02ff8e02013-06-22 00:55:02 +00001264
1265 m_thread_list_real.Update(real_thread_list);
Andrew Kaylorba4e61d2013-05-07 18:35:34 +00001266 m_thread_list.Update (new_thread_list);
1267 m_thread_list.SetStopID (stop_id);
Jason Molendaa6e91302013-11-19 05:44:41 +00001268
Jason Molenda4ff13262013-11-20 00:31:38 +00001269 if (GetLastNaturalStopID () != m_extended_thread_stop_id)
1270 {
1271 // Clear any extended threads that we may have accumulated previously
1272 m_extended_thread_list.Clear();
1273 m_extended_thread_stop_id = GetLastNaturalStopID ();
Jason Molenda5e8dce42013-12-13 00:29:16 +00001274
1275 m_queue_list.Clear();
1276 m_queue_list_stop_id = GetLastNaturalStopID ();
Jason Molenda4ff13262013-11-20 00:31:38 +00001277 }
Greg Clayton9fc13552012-04-10 00:18:59 +00001278 }
Greg Clayton2637f822011-11-17 01:23:07 +00001279 }
Greg Clayton56d9a1b2011-08-22 02:49:39 +00001280 }
1281}
1282
Jason Molenda5e8dce42013-12-13 00:29:16 +00001283void
1284Process::UpdateQueueListIfNeeded ()
1285{
1286 if (m_system_runtime_ap.get())
1287 {
1288 if (m_queue_list.GetSize() == 0 || m_queue_list_stop_id != GetLastNaturalStopID())
1289 {
1290 const StateType state = GetPrivateState();
1291 if (StateIsStoppedState (state, true))
1292 {
1293 m_system_runtime_ap->PopulateQueueList (m_queue_list);
1294 m_queue_list_stop_id = GetLastNaturalStopID();
1295 }
1296 }
1297 }
1298}
1299
Greg Claytona4d87472013-01-18 23:41:08 +00001300ThreadSP
1301Process::CreateOSPluginThread (lldb::tid_t tid, lldb::addr_t context)
1302{
1303 OperatingSystem *os = GetOperatingSystem ();
1304 if (os)
1305 return os->CreateThread(tid, context);
1306 return ThreadSP();
1307}
1308
Han Ming Ongc2c423e2013-01-08 22:10:01 +00001309uint32_t
1310Process::GetNextThreadIndexID (uint64_t thread_id)
1311{
1312 return AssignIndexIDToThread(thread_id);
1313}
1314
1315bool
1316Process::HasAssignedIndexIDToThread(uint64_t thread_id)
1317{
1318 std::map<uint64_t, uint32_t>::iterator iterator = m_thread_id_to_index_id_map.find(thread_id);
1319 if (iterator == m_thread_id_to_index_id_map.end())
1320 {
1321 return false;
1322 }
1323 else
1324 {
1325 return true;
1326 }
1327}
1328
1329uint32_t
1330Process::AssignIndexIDToThread(uint64_t thread_id)
1331{
1332 uint32_t result = 0;
1333 std::map<uint64_t, uint32_t>::iterator iterator = m_thread_id_to_index_id_map.find(thread_id);
1334 if (iterator == m_thread_id_to_index_id_map.end())
1335 {
1336 result = ++m_thread_index_id;
1337 m_thread_id_to_index_id_map[thread_id] = result;
1338 }
1339 else
1340 {
1341 result = iterator->second;
1342 }
1343
1344 return result;
1345}
1346
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001347StateType
1348Process::GetState()
1349{
1350 // If any other threads access this we will need a mutex for it
1351 return m_public_state.GetValue ();
1352}
1353
1354void
Jim Ingham221d51c2013-05-08 00:35:16 +00001355Process::SetPublicState (StateType new_state, bool restarted)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001356{
Greg Clayton5160ce52013-03-27 23:08:40 +00001357 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001358 if (log)
Jim Ingham221d51c2013-05-08 00:35:16 +00001359 log->Printf("Process::SetPublicState (state = %s, restarted = %i)", StateAsCString(new_state), restarted);
Greg Clayton7fdf9ef2012-04-05 16:12:35 +00001360 const StateType old_state = m_public_state.GetValue();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001361 m_public_state.SetValue (new_state);
Jim Ingham3b8285d2012-04-19 01:40:33 +00001362
1363 // On the transition from Run to Stopped, we unlock the writer end of the
1364 // run lock. The lock gets locked in Resume, which is the public API
1365 // to tell the program to run.
Greg Clayton7fdf9ef2012-04-05 16:12:35 +00001366 if (!IsHijackedForEvent(eBroadcastBitStateChanged))
1367 {
Sean Callanan8b0737f2012-06-02 01:16:20 +00001368 if (new_state == eStateDetached)
Greg Clayton7fdf9ef2012-04-05 16:12:35 +00001369 {
Sean Callanan8b0737f2012-06-02 01:16:20 +00001370 if (log)
1371 log->Printf("Process::SetPublicState (%s) -- unlocking run lock for detach", StateAsCString(new_state));
Ed Maste64fad602013-07-29 20:58:06 +00001372 m_public_run_lock.SetStopped();
Sean Callanan8b0737f2012-06-02 01:16:20 +00001373 }
1374 else
1375 {
1376 const bool old_state_is_stopped = StateIsStoppedState(old_state, false);
1377 const bool new_state_is_stopped = StateIsStoppedState(new_state, false);
Jim Ingham221d51c2013-05-08 00:35:16 +00001378 if ((old_state_is_stopped != new_state_is_stopped))
Greg Clayton7fdf9ef2012-04-05 16:12:35 +00001379 {
Jim Ingham221d51c2013-05-08 00:35:16 +00001380 if (new_state_is_stopped && !restarted)
Sean Callanan8b0737f2012-06-02 01:16:20 +00001381 {
1382 if (log)
1383 log->Printf("Process::SetPublicState (%s) -- unlocking run lock", StateAsCString(new_state));
Ed Maste64fad602013-07-29 20:58:06 +00001384 m_public_run_lock.SetStopped();
Sean Callanan8b0737f2012-06-02 01:16:20 +00001385 }
Greg Clayton7fdf9ef2012-04-05 16:12:35 +00001386 }
Greg Clayton7fdf9ef2012-04-05 16:12:35 +00001387 }
1388 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001389}
1390
Jim Ingham3b8285d2012-04-19 01:40:33 +00001391Error
1392Process::Resume ()
1393{
Greg Clayton5160ce52013-03-27 23:08:40 +00001394 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
Jim Ingham3b8285d2012-04-19 01:40:33 +00001395 if (log)
1396 log->Printf("Process::Resume -- locking run lock");
Ed Maste64fad602013-07-29 20:58:06 +00001397 if (!m_public_run_lock.TrySetRunning())
Jim Ingham3b8285d2012-04-19 01:40:33 +00001398 {
1399 Error error("Resume request failed - process still running.");
1400 if (log)
Ed Maste64fad602013-07-29 20:58:06 +00001401 log->Printf ("Process::Resume: -- TrySetRunning failed, not resuming.");
Jim Ingham3b8285d2012-04-19 01:40:33 +00001402 return error;
1403 }
1404 return PrivateResume();
1405}
1406
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001407StateType
1408Process::GetPrivateState ()
1409{
1410 return m_private_state.GetValue();
1411}
1412
1413void
1414Process::SetPrivateState (StateType new_state)
1415{
Greg Claytonfb8b37a2014-07-14 23:09:29 +00001416 if (m_finalize_called)
1417 return;
1418
Greg Clayton5160ce52013-03-27 23:08:40 +00001419 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STATE | LIBLLDB_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001420 bool state_changed = false;
1421
1422 if (log)
1423 log->Printf("Process::SetPrivateState (%s)", StateAsCString(new_state));
1424
Andrew Kaylor29d65742013-05-10 17:19:04 +00001425 Mutex::Locker thread_locker(m_thread_list.GetMutex());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001426 Mutex::Locker locker(m_private_state.GetMutex());
1427
1428 const StateType old_state = m_private_state.GetValueNoLock ();
1429 state_changed = old_state != new_state;
Ed Mastec29693f2013-07-02 16:35:47 +00001430
Greg Claytonaa49c832013-05-03 22:25:56 +00001431 const bool old_state_is_stopped = StateIsStoppedState(old_state, false);
1432 const bool new_state_is_stopped = StateIsStoppedState(new_state, false);
1433 if (old_state_is_stopped != new_state_is_stopped)
1434 {
1435 if (new_state_is_stopped)
Ed Maste64fad602013-07-29 20:58:06 +00001436 m_private_run_lock.SetStopped();
Greg Claytonaa49c832013-05-03 22:25:56 +00001437 else
Ed Maste64fad602013-07-29 20:58:06 +00001438 m_private_run_lock.SetRunning();
Greg Claytonaa49c832013-05-03 22:25:56 +00001439 }
Andrew Kaylor93132f52013-05-28 23:04:25 +00001440
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001441 if (state_changed)
1442 {
1443 m_private_state.SetValueNoLock (new_state);
Greg Clayton2637f822011-11-17 01:23:07 +00001444 if (StateIsStoppedState(new_state, false))
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001445 {
Andrew Kaylor29d65742013-05-10 17:19:04 +00001446 // Note, this currently assumes that all threads in the list
1447 // stop when the process stops. In the future we will want to
1448 // support a debugging model where some threads continue to run
1449 // while others are stopped. When that happens we will either need
1450 // a way for the thread list to identify which threads are stopping
1451 // or create a special thread list containing only threads which
1452 // actually stopped.
1453 //
1454 // The process plugin is responsible for managing the actual
1455 // behavior of the threads and should have stopped any threads
1456 // that are going to stop before we get here.
1457 m_thread_list.DidStop();
1458
Jim Ingham4b536182011-08-09 02:12:22 +00001459 m_mod_id.BumpStopID();
Greg Clayton58be07b2011-01-07 06:08:19 +00001460 m_memory_cache.Clear();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001461 if (log)
Jim Ingham4b536182011-08-09 02:12:22 +00001462 log->Printf("Process::SetPrivateState (%s) stop_id = %u", StateAsCString(new_state), m_mod_id.GetStopID());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001463 }
1464 // Use our target to get a shared pointer to ourselves...
Greg Clayton35a4cc52012-10-29 20:52:08 +00001465 if (m_finalize_called && PrivateStateThreadIsValid() == false)
1466 BroadcastEvent (eBroadcastBitStateChanged, new ProcessEventData (shared_from_this(), new_state));
1467 else
1468 m_private_state_broadcaster.BroadcastEvent (eBroadcastBitStateChanged, new ProcessEventData (shared_from_this(), new_state));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001469 }
1470 else
1471 {
1472 if (log)
Jason Molendafd54b362011-09-20 21:44:10 +00001473 log->Printf("Process::SetPrivateState (%s) state didn't change. Ignoring...", StateAsCString(new_state));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001474 }
1475}
1476
Jim Ingham0faa43f2011-11-08 03:00:11 +00001477void
1478Process::SetRunningUserExpression (bool on)
1479{
1480 m_mod_id.SetRunningUserExpression (on);
1481}
1482
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001483addr_t
1484Process::GetImageInfoAddress()
1485{
1486 return LLDB_INVALID_ADDRESS;
1487}
1488
Greg Clayton8f343b02010-11-04 01:54:29 +00001489//----------------------------------------------------------------------
1490// LoadImage
1491//
1492// This function provides a default implementation that works for most
1493// unix variants. Any Process subclasses that need to do shared library
1494// loading differently should override LoadImage and UnloadImage and
1495// do what is needed.
1496//----------------------------------------------------------------------
1497uint32_t
1498Process::LoadImage (const FileSpec &image_spec, Error &error)
1499{
Greg Claytonac7a3db2012-04-18 00:05:19 +00001500 char path[PATH_MAX];
1501 image_spec.GetPath(path, sizeof(path));
1502
Greg Clayton8f343b02010-11-04 01:54:29 +00001503 DynamicLoader *loader = GetDynamicLoader();
1504 if (loader)
1505 {
1506 error = loader->CanLoadImage();
1507 if (error.Fail())
1508 return LLDB_INVALID_IMAGE_TOKEN;
1509 }
1510
1511 if (error.Success())
1512 {
1513 ThreadSP thread_sp(GetThreadList ().GetSelectedThread());
Greg Clayton8f343b02010-11-04 01:54:29 +00001514
1515 if (thread_sp)
1516 {
Jason Molendab57e4a12013-11-04 09:33:30 +00001517 StackFrameSP frame_sp (thread_sp->GetStackFrameAtIndex (0));
Greg Clayton8f343b02010-11-04 01:54:29 +00001518
1519 if (frame_sp)
1520 {
1521 ExecutionContext exe_ctx;
1522 frame_sp->CalculateExecutionContext (exe_ctx);
Greg Clayton62afb9f2013-11-04 19:35:17 +00001523 EvaluateExpressionOptions expr_options;
1524 expr_options.SetUnwindOnError(true);
1525 expr_options.SetIgnoreBreakpoints(true);
1526 expr_options.SetExecutionPolicy(eExecutionPolicyAlways);
Greg Clayton8f343b02010-11-04 01:54:29 +00001527 StreamString expr;
Greg Clayton8f343b02010-11-04 01:54:29 +00001528 expr.Printf("dlopen (\"%s\", 2)", path);
1529 const char *prefix = "extern \"C\" void* dlopen (const char *path, int mode);\n";
Jim Inghamf48169b2010-11-30 02:22:11 +00001530 lldb::ValueObjectSP result_valobj_sp;
Greg Clayton62afb9f2013-11-04 19:35:17 +00001531 Error expr_error;
Greg Clayton26ab83d2012-10-31 20:49:04 +00001532 ClangUserExpression::Evaluate (exe_ctx,
Greg Clayton62afb9f2013-11-04 19:35:17 +00001533 expr_options,
Greg Clayton26ab83d2012-10-31 20:49:04 +00001534 expr.GetData(),
1535 prefix,
1536 result_valobj_sp,
Greg Clayton62afb9f2013-11-04 19:35:17 +00001537 expr_error);
1538 if (expr_error.Success())
Greg Clayton8f343b02010-11-04 01:54:29 +00001539 {
Greg Clayton62afb9f2013-11-04 19:35:17 +00001540 error = result_valobj_sp->GetError();
1541 if (error.Success())
Greg Clayton8f343b02010-11-04 01:54:29 +00001542 {
Greg Clayton62afb9f2013-11-04 19:35:17 +00001543 Scalar scalar;
1544 if (result_valobj_sp->ResolveValue (scalar))
Greg Clayton8f343b02010-11-04 01:54:29 +00001545 {
Greg Clayton62afb9f2013-11-04 19:35:17 +00001546 addr_t image_ptr = scalar.ULongLong(LLDB_INVALID_ADDRESS);
1547 if (image_ptr != 0 && image_ptr != LLDB_INVALID_ADDRESS)
1548 {
1549 uint32_t image_token = m_image_tokens.size();
1550 m_image_tokens.push_back (image_ptr);
1551 return image_token;
1552 }
Greg Clayton8f343b02010-11-04 01:54:29 +00001553 }
1554 }
1555 }
Jim Ingham6c9ed912014-04-03 01:26:14 +00001556 else
1557 error = expr_error;
Greg Clayton8f343b02010-11-04 01:54:29 +00001558 }
1559 }
1560 }
Greg Claytonac7a3db2012-04-18 00:05:19 +00001561 if (!error.AsCString())
1562 error.SetErrorStringWithFormat("unable to load '%s'", path);
Greg Clayton8f343b02010-11-04 01:54:29 +00001563 return LLDB_INVALID_IMAGE_TOKEN;
1564}
1565
1566//----------------------------------------------------------------------
1567// UnloadImage
1568//
1569// This function provides a default implementation that works for most
1570// unix variants. Any Process subclasses that need to do shared library
1571// loading differently should override LoadImage and UnloadImage and
1572// do what is needed.
1573//----------------------------------------------------------------------
1574Error
1575Process::UnloadImage (uint32_t image_token)
1576{
1577 Error error;
1578 if (image_token < m_image_tokens.size())
1579 {
1580 const addr_t image_addr = m_image_tokens[image_token];
1581 if (image_addr == LLDB_INVALID_ADDRESS)
1582 {
1583 error.SetErrorString("image already unloaded");
1584 }
1585 else
1586 {
1587 DynamicLoader *loader = GetDynamicLoader();
1588 if (loader)
1589 error = loader->CanLoadImage();
1590
1591 if (error.Success())
1592 {
1593 ThreadSP thread_sp(GetThreadList ().GetSelectedThread());
Greg Clayton8f343b02010-11-04 01:54:29 +00001594
1595 if (thread_sp)
1596 {
Jason Molendab57e4a12013-11-04 09:33:30 +00001597 StackFrameSP frame_sp (thread_sp->GetStackFrameAtIndex (0));
Greg Clayton8f343b02010-11-04 01:54:29 +00001598
1599 if (frame_sp)
1600 {
1601 ExecutionContext exe_ctx;
1602 frame_sp->CalculateExecutionContext (exe_ctx);
Greg Clayton62afb9f2013-11-04 19:35:17 +00001603 EvaluateExpressionOptions expr_options;
1604 expr_options.SetUnwindOnError(true);
1605 expr_options.SetIgnoreBreakpoints(true);
1606 expr_options.SetExecutionPolicy(eExecutionPolicyAlways);
Greg Clayton8f343b02010-11-04 01:54:29 +00001607 StreamString expr;
Daniel Malead01b2952012-11-29 21:49:15 +00001608 expr.Printf("dlclose ((void *)0x%" PRIx64 ")", image_addr);
Greg Clayton8f343b02010-11-04 01:54:29 +00001609 const char *prefix = "extern \"C\" int dlclose(void* handle);\n";
Jim Inghamf48169b2010-11-30 02:22:11 +00001610 lldb::ValueObjectSP result_valobj_sp;
Greg Clayton62afb9f2013-11-04 19:35:17 +00001611 Error expr_error;
Greg Clayton26ab83d2012-10-31 20:49:04 +00001612 ClangUserExpression::Evaluate (exe_ctx,
Greg Clayton62afb9f2013-11-04 19:35:17 +00001613 expr_options,
Greg Clayton26ab83d2012-10-31 20:49:04 +00001614 expr.GetData(),
1615 prefix,
1616 result_valobj_sp,
Greg Clayton62afb9f2013-11-04 19:35:17 +00001617 expr_error);
Greg Clayton8f343b02010-11-04 01:54:29 +00001618 if (result_valobj_sp->GetError().Success())
1619 {
1620 Scalar scalar;
Jim Ingham6035b672011-03-31 00:19:25 +00001621 if (result_valobj_sp->ResolveValue (scalar))
Greg Clayton8f343b02010-11-04 01:54:29 +00001622 {
1623 if (scalar.UInt(1))
1624 {
1625 error.SetErrorStringWithFormat("expression failed: \"%s\"", expr.GetData());
1626 }
1627 else
1628 {
1629 m_image_tokens[image_token] = LLDB_INVALID_ADDRESS;
1630 }
1631 }
1632 }
1633 else
1634 {
1635 error = result_valobj_sp->GetError();
1636 }
1637 }
1638 }
1639 }
1640 }
1641 }
1642 else
1643 {
1644 error.SetErrorString("invalid image token");
1645 }
1646 return error;
1647}
1648
Greg Clayton31f1d2f2011-05-11 18:39:18 +00001649const lldb::ABISP &
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001650Process::GetABI()
1651{
Greg Clayton31f1d2f2011-05-11 18:39:18 +00001652 if (!m_abi_sp)
1653 m_abi_sp = ABI::FindPlugin(m_target.GetArchitecture());
1654 return m_abi_sp;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001655}
1656
Jim Ingham22777012010-09-23 02:01:19 +00001657LanguageRuntime *
Jim Inghamab175242012-03-10 00:22:19 +00001658Process::GetLanguageRuntime(lldb::LanguageType language, bool retry_if_null)
Jim Ingham22777012010-09-23 02:01:19 +00001659{
1660 LanguageRuntimeCollection::iterator pos;
1661 pos = m_language_runtimes.find (language);
Jim Inghamab175242012-03-10 00:22:19 +00001662 if (pos == m_language_runtimes.end() || (retry_if_null && !(*pos).second))
Jim Ingham22777012010-09-23 02:01:19 +00001663 {
Jim Inghamab175242012-03-10 00:22:19 +00001664 lldb::LanguageRuntimeSP runtime_sp(LanguageRuntime::FindPlugin(this, language));
Jim Ingham22777012010-09-23 02:01:19 +00001665
Jim Inghamab175242012-03-10 00:22:19 +00001666 m_language_runtimes[language] = runtime_sp;
1667 return runtime_sp.get();
Jim Ingham22777012010-09-23 02:01:19 +00001668 }
1669 else
1670 return (*pos).second.get();
1671}
1672
1673CPPLanguageRuntime *
Jim Inghamab175242012-03-10 00:22:19 +00001674Process::GetCPPLanguageRuntime (bool retry_if_null)
Jim Ingham22777012010-09-23 02:01:19 +00001675{
Jim Inghamab175242012-03-10 00:22:19 +00001676 LanguageRuntime *runtime = GetLanguageRuntime(eLanguageTypeC_plus_plus, retry_if_null);
Jim Ingham22777012010-09-23 02:01:19 +00001677 if (runtime != NULL && runtime->GetLanguageType() == eLanguageTypeC_plus_plus)
1678 return static_cast<CPPLanguageRuntime *> (runtime);
1679 return NULL;
1680}
1681
1682ObjCLanguageRuntime *
Jim Inghamab175242012-03-10 00:22:19 +00001683Process::GetObjCLanguageRuntime (bool retry_if_null)
Jim Ingham22777012010-09-23 02:01:19 +00001684{
Jim Inghamab175242012-03-10 00:22:19 +00001685 LanguageRuntime *runtime = GetLanguageRuntime(eLanguageTypeObjC, retry_if_null);
Jim Ingham22777012010-09-23 02:01:19 +00001686 if (runtime != NULL && runtime->GetLanguageType() == eLanguageTypeObjC)
1687 return static_cast<ObjCLanguageRuntime *> (runtime);
1688 return NULL;
1689}
1690
Enrico Granatafd4c84e2012-05-21 16:51:35 +00001691bool
1692Process::IsPossibleDynamicValue (ValueObject& in_value)
1693{
1694 if (in_value.IsDynamic())
1695 return false;
1696 LanguageType known_type = in_value.GetObjectRuntimeLanguage();
1697
1698 if (known_type != eLanguageTypeUnknown && known_type != eLanguageTypeC)
1699 {
1700 LanguageRuntime *runtime = GetLanguageRuntime (known_type);
1701 return runtime ? runtime->CouldHaveDynamicValue(in_value) : false;
1702 }
1703
1704 LanguageRuntime *cpp_runtime = GetLanguageRuntime (eLanguageTypeC_plus_plus);
1705 if (cpp_runtime && cpp_runtime->CouldHaveDynamicValue(in_value))
1706 return true;
1707
1708 LanguageRuntime *objc_runtime = GetLanguageRuntime (eLanguageTypeObjC);
1709 return objc_runtime ? objc_runtime->CouldHaveDynamicValue(in_value) : false;
1710}
1711
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001712BreakpointSiteList &
1713Process::GetBreakpointSiteList()
1714{
1715 return m_breakpoint_site_list;
1716}
1717
1718const BreakpointSiteList &
1719Process::GetBreakpointSiteList() const
1720{
1721 return m_breakpoint_site_list;
1722}
1723
1724
1725void
1726Process::DisableAllBreakpointSites ()
1727{
Greg Claytond8cf1a12013-06-12 00:46:38 +00001728 m_breakpoint_site_list.ForEach([this](BreakpointSite *bp_site) -> void {
1729// bp_site->SetEnabled(true);
1730 DisableBreakpointSite(bp_site);
1731 });
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001732}
1733
1734Error
1735Process::ClearBreakpointSiteByID (lldb::user_id_t break_id)
1736{
1737 Error error (DisableBreakpointSiteByID (break_id));
1738
1739 if (error.Success())
1740 m_breakpoint_site_list.Remove(break_id);
1741
1742 return error;
1743}
1744
1745Error
1746Process::DisableBreakpointSiteByID (lldb::user_id_t break_id)
1747{
1748 Error error;
1749 BreakpointSiteSP bp_site_sp = m_breakpoint_site_list.FindByID (break_id);
1750 if (bp_site_sp)
1751 {
1752 if (bp_site_sp->IsEnabled())
Jim Ingham299c0c12013-02-15 02:06:30 +00001753 error = DisableBreakpointSite (bp_site_sp.get());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001754 }
1755 else
1756 {
Daniel Malead01b2952012-11-29 21:49:15 +00001757 error.SetErrorStringWithFormat("invalid breakpoint site ID: %" PRIu64, break_id);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001758 }
1759
1760 return error;
1761}
1762
1763Error
1764Process::EnableBreakpointSiteByID (lldb::user_id_t break_id)
1765{
1766 Error error;
1767 BreakpointSiteSP bp_site_sp = m_breakpoint_site_list.FindByID (break_id);
1768 if (bp_site_sp)
1769 {
1770 if (!bp_site_sp->IsEnabled())
Jim Ingham299c0c12013-02-15 02:06:30 +00001771 error = EnableBreakpointSite (bp_site_sp.get());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001772 }
1773 else
1774 {
Daniel Malead01b2952012-11-29 21:49:15 +00001775 error.SetErrorStringWithFormat("invalid breakpoint site ID: %" PRIu64, break_id);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001776 }
1777 return error;
1778}
1779
Stephen Wilson50bd94f2010-07-17 00:56:13 +00001780lldb::break_id_t
Greg Claytone1cd1be2012-01-29 20:56:30 +00001781Process::CreateBreakpointSite (const BreakpointLocationSP &owner, bool use_hardware)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001782{
Jim Ingham1460e4b2014-01-10 23:46:59 +00001783 addr_t load_addr = LLDB_INVALID_ADDRESS;
1784
1785 bool show_error = true;
1786 switch (GetState())
1787 {
1788 case eStateInvalid:
1789 case eStateUnloaded:
1790 case eStateConnected:
1791 case eStateAttaching:
1792 case eStateLaunching:
1793 case eStateDetached:
1794 case eStateExited:
1795 show_error = false;
1796 break;
1797
1798 case eStateStopped:
1799 case eStateRunning:
1800 case eStateStepping:
1801 case eStateCrashed:
1802 case eStateSuspended:
1803 show_error = IsAlive();
1804 break;
1805 }
1806
1807 // Reset the IsIndirect flag here, in case the location changes from
1808 // pointing to a indirect symbol to a regular symbol.
1809 owner->SetIsIndirect (false);
1810
1811 if (owner->ShouldResolveIndirectFunctions())
1812 {
1813 Symbol *symbol = owner->GetAddress().CalculateSymbolContextSymbol();
1814 if (symbol && symbol->IsIndirect())
1815 {
1816 Error error;
1817 load_addr = ResolveIndirectFunction (&symbol->GetAddress(), error);
1818 if (!error.Success() && show_error)
1819 {
Greg Clayton44d93782014-01-27 23:43:24 +00001820 m_target.GetDebugger().GetErrorFile()->Printf ("warning: failed to resolve indirect function at 0x%" PRIx64 " for breakpoint %i.%i: %s\n",
1821 symbol->GetAddress().GetLoadAddress(&m_target),
1822 owner->GetBreakpoint().GetID(),
1823 owner->GetID(),
1824 error.AsCString() ? error.AsCString() : "unkown error");
Jim Ingham1460e4b2014-01-10 23:46:59 +00001825 return LLDB_INVALID_BREAK_ID;
1826 }
1827 Address resolved_address(load_addr);
1828 load_addr = resolved_address.GetOpcodeLoadAddress (&m_target);
1829 owner->SetIsIndirect(true);
1830 }
1831 else
1832 load_addr = owner->GetAddress().GetOpcodeLoadAddress (&m_target);
1833 }
1834 else
1835 load_addr = owner->GetAddress().GetOpcodeLoadAddress (&m_target);
1836
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001837 if (load_addr != LLDB_INVALID_ADDRESS)
1838 {
1839 BreakpointSiteSP bp_site_sp;
1840
1841 // Look up this breakpoint site. If it exists, then add this new owner, otherwise
1842 // create a new breakpoint site and add it.
1843
1844 bp_site_sp = m_breakpoint_site_list.FindByAddress (load_addr);
1845
1846 if (bp_site_sp)
1847 {
1848 bp_site_sp->AddOwner (owner);
1849 owner->SetBreakpointSite (bp_site_sp);
1850 return bp_site_sp->GetID();
1851 }
1852 else
1853 {
Greg Claytonc7bece562013-01-25 18:06:21 +00001854 bp_site_sp.reset (new BreakpointSite (&m_breakpoint_site_list, owner, load_addr, use_hardware));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001855 if (bp_site_sp)
1856 {
Greg Claytoneb023e72013-10-11 19:48:25 +00001857 Error error = EnableBreakpointSite (bp_site_sp.get());
1858 if (error.Success())
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001859 {
1860 owner->SetBreakpointSite (bp_site_sp);
1861 return m_breakpoint_site_list.Add (bp_site_sp);
1862 }
Greg Claytoneb023e72013-10-11 19:48:25 +00001863 else
1864 {
Greg Claytonfbb76342013-11-20 21:07:01 +00001865 if (show_error)
1866 {
1867 // Report error for setting breakpoint...
Greg Clayton44d93782014-01-27 23:43:24 +00001868 m_target.GetDebugger().GetErrorFile()->Printf ("warning: failed to set breakpoint site at 0x%" PRIx64 " for breakpoint %i.%i: %s\n",
1869 load_addr,
1870 owner->GetBreakpoint().GetID(),
1871 owner->GetID(),
1872 error.AsCString() ? error.AsCString() : "unkown error");
Greg Claytonfbb76342013-11-20 21:07:01 +00001873 }
Greg Claytoneb023e72013-10-11 19:48:25 +00001874 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001875 }
1876 }
1877 }
1878 // We failed to enable the breakpoint
1879 return LLDB_INVALID_BREAK_ID;
1880
1881}
1882
1883void
1884Process::RemoveOwnerFromBreakpointSite (lldb::user_id_t owner_id, lldb::user_id_t owner_loc_id, BreakpointSiteSP &bp_site_sp)
1885{
1886 uint32_t num_owners = bp_site_sp->RemoveOwner (owner_id, owner_loc_id);
1887 if (num_owners == 0)
1888 {
Jim Inghamf1ff3bb2013-04-06 00:16:39 +00001889 // Don't try to disable the site if we don't have a live process anymore.
1890 if (IsAlive())
1891 DisableBreakpointSite (bp_site_sp.get());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001892 m_breakpoint_site_list.RemoveByAddress(bp_site_sp->GetLoadAddress());
1893 }
1894}
1895
1896
1897size_t
1898Process::RemoveBreakpointOpcodesFromBuffer (addr_t bp_addr, size_t size, uint8_t *buf) const
1899{
1900 size_t bytes_removed = 0;
Jim Ingham20c77192011-06-29 19:42:28 +00001901 BreakpointSiteList bp_sites_in_range;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001902
Jim Ingham20c77192011-06-29 19:42:28 +00001903 if (m_breakpoint_site_list.FindInRange (bp_addr, bp_addr + size, bp_sites_in_range))
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001904 {
Greg Claytond8cf1a12013-06-12 00:46:38 +00001905 bp_sites_in_range.ForEach([bp_addr, size, buf, &bytes_removed](BreakpointSite *bp_site) -> void {
1906 if (bp_site->GetType() == BreakpointSite::eSoftware)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001907 {
Greg Claytond8cf1a12013-06-12 00:46:38 +00001908 addr_t intersect_addr;
1909 size_t intersect_size;
1910 size_t opcode_offset;
1911 if (bp_site->IntersectsRange(bp_addr, size, &intersect_addr, &intersect_size, &opcode_offset))
Jim Ingham20c77192011-06-29 19:42:28 +00001912 {
1913 assert(bp_addr <= intersect_addr && intersect_addr < bp_addr + size);
1914 assert(bp_addr < intersect_addr + intersect_size && intersect_addr + intersect_size <= bp_addr + size);
Greg Claytond8cf1a12013-06-12 00:46:38 +00001915 assert(opcode_offset + intersect_size <= bp_site->GetByteSize());
Jim Ingham20c77192011-06-29 19:42:28 +00001916 size_t buf_offset = intersect_addr - bp_addr;
Greg Claytond8cf1a12013-06-12 00:46:38 +00001917 ::memcpy(buf + buf_offset, bp_site->GetSavedOpcodeBytes() + opcode_offset, intersect_size);
Jim Ingham20c77192011-06-29 19:42:28 +00001918 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001919 }
Greg Claytond8cf1a12013-06-12 00:46:38 +00001920 });
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001921 }
1922 return bytes_removed;
1923}
1924
1925
Greg Claytonded470d2011-03-19 01:12:21 +00001926
1927size_t
1928Process::GetSoftwareBreakpointTrapOpcode (BreakpointSite* bp_site)
1929{
1930 PlatformSP platform_sp (m_target.GetPlatform());
1931 if (platform_sp)
1932 return platform_sp->GetSoftwareBreakpointTrapOpcode (m_target, bp_site);
1933 return 0;
1934}
1935
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001936Error
1937Process::EnableSoftwareBreakpoint (BreakpointSite *bp_site)
1938{
1939 Error error;
1940 assert (bp_site != NULL);
Greg Clayton5160ce52013-03-27 23:08:40 +00001941 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_BREAKPOINTS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001942 const addr_t bp_addr = bp_site->GetLoadAddress();
1943 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00001944 log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64, bp_site->GetID(), (uint64_t)bp_addr);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001945 if (bp_site->IsEnabled())
1946 {
1947 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00001948 log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- already enabled", bp_site->GetID(), (uint64_t)bp_addr);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001949 return error;
1950 }
1951
1952 if (bp_addr == LLDB_INVALID_ADDRESS)
1953 {
1954 error.SetErrorString("BreakpointSite contains an invalid load address.");
1955 return error;
1956 }
1957 // Ask the lldb::Process subclass to fill in the correct software breakpoint
1958 // trap for the breakpoint site
1959 const size_t bp_opcode_size = GetSoftwareBreakpointTrapOpcode(bp_site);
1960
1961 if (bp_opcode_size == 0)
1962 {
Daniel Malead01b2952012-11-29 21:49:15 +00001963 error.SetErrorStringWithFormat ("Process::GetSoftwareBreakpointTrapOpcode() returned zero, unable to get breakpoint trap for address 0x%" PRIx64, bp_addr);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001964 }
1965 else
1966 {
1967 const uint8_t * const bp_opcode_bytes = bp_site->GetTrapOpcodeBytes();
1968
1969 if (bp_opcode_bytes == NULL)
1970 {
1971 error.SetErrorString ("BreakpointSite doesn't contain a valid breakpoint trap opcode.");
1972 return error;
1973 }
1974
1975 // Save the original opcode by reading it
1976 if (DoReadMemory(bp_addr, bp_site->GetSavedOpcodeBytes(), bp_opcode_size, error) == bp_opcode_size)
1977 {
1978 // Write a software breakpoint in place of the original opcode
1979 if (DoWriteMemory(bp_addr, bp_opcode_bytes, bp_opcode_size, error) == bp_opcode_size)
1980 {
1981 uint8_t verify_bp_opcode_bytes[64];
1982 if (DoReadMemory(bp_addr, verify_bp_opcode_bytes, bp_opcode_size, error) == bp_opcode_size)
1983 {
1984 if (::memcmp(bp_opcode_bytes, verify_bp_opcode_bytes, bp_opcode_size) == 0)
1985 {
1986 bp_site->SetEnabled(true);
1987 bp_site->SetType (BreakpointSite::eSoftware);
1988 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00001989 log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- SUCCESS",
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001990 bp_site->GetID(),
1991 (uint64_t)bp_addr);
1992 }
1993 else
Greg Clayton86edbf42011-10-26 00:56:27 +00001994 error.SetErrorString("failed to verify the breakpoint trap in memory.");
Chris Lattner30fdc8d2010-06-08 16:52:24 +00001995 }
1996 else
1997 error.SetErrorString("Unable to read memory to verify breakpoint trap.");
1998 }
1999 else
2000 error.SetErrorString("Unable to write breakpoint trap to memory.");
2001 }
2002 else
2003 error.SetErrorString("Unable to read memory at breakpoint address.");
2004 }
Stephen Wilson78a4feb2011-01-12 04:20:03 +00002005 if (log && error.Fail())
Daniel Malead01b2952012-11-29 21:49:15 +00002006 log->Printf ("Process::EnableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- FAILED: %s",
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002007 bp_site->GetID(),
2008 (uint64_t)bp_addr,
2009 error.AsCString());
2010 return error;
2011}
2012
2013Error
2014Process::DisableSoftwareBreakpoint (BreakpointSite *bp_site)
2015{
2016 Error error;
2017 assert (bp_site != NULL);
Greg Clayton5160ce52013-03-27 23:08:40 +00002018 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_BREAKPOINTS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002019 addr_t bp_addr = bp_site->GetLoadAddress();
2020 lldb::user_id_t breakID = bp_site->GetID();
2021 if (log)
Jim Ingham299c0c12013-02-15 02:06:30 +00002022 log->Printf ("Process::DisableSoftwareBreakpoint (breakID = %" PRIu64 ") addr = 0x%" PRIx64, breakID, (uint64_t)bp_addr);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002023
2024 if (bp_site->IsHardware())
2025 {
2026 error.SetErrorString("Breakpoint site is a hardware breakpoint.");
2027 }
2028 else if (bp_site->IsEnabled())
2029 {
2030 const size_t break_op_size = bp_site->GetByteSize();
2031 const uint8_t * const break_op = bp_site->GetTrapOpcodeBytes();
2032 if (break_op_size > 0)
2033 {
Bruce Mitchenerd93c4a32014-07-01 21:22:11 +00002034 // Clear a software breakpoint instruction
Greg Claytonc982c762010-07-09 20:39:50 +00002035 uint8_t curr_break_op[8];
Stephen Wilson4ab47682010-07-20 18:41:11 +00002036 assert (break_op_size <= sizeof(curr_break_op));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002037 bool break_op_found = false;
2038
2039 // Read the breakpoint opcode
2040 if (DoReadMemory (bp_addr, curr_break_op, break_op_size, error) == break_op_size)
2041 {
2042 bool verify = false;
2043 // Make sure we have the a breakpoint opcode exists at this address
2044 if (::memcmp (curr_break_op, break_op, break_op_size) == 0)
2045 {
2046 break_op_found = true;
2047 // We found a valid breakpoint opcode at this address, now restore
2048 // the saved opcode.
2049 if (DoWriteMemory (bp_addr, bp_site->GetSavedOpcodeBytes(), break_op_size, error) == break_op_size)
2050 {
2051 verify = true;
2052 }
2053 else
2054 error.SetErrorString("Memory write failed when restoring original opcode.");
2055 }
2056 else
2057 {
2058 error.SetErrorString("Original breakpoint trap is no longer in memory.");
2059 // Set verify to true and so we can check if the original opcode has already been restored
2060 verify = true;
2061 }
2062
2063 if (verify)
2064 {
Greg Claytonc982c762010-07-09 20:39:50 +00002065 uint8_t verify_opcode[8];
Stephen Wilson4ab47682010-07-20 18:41:11 +00002066 assert (break_op_size < sizeof(verify_opcode));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002067 // Verify that our original opcode made it back to the inferior
2068 if (DoReadMemory (bp_addr, verify_opcode, break_op_size, error) == break_op_size)
2069 {
2070 // compare the memory we just read with the original opcode
2071 if (::memcmp (bp_site->GetSavedOpcodeBytes(), verify_opcode, break_op_size) == 0)
2072 {
2073 // SUCCESS
2074 bp_site->SetEnabled(false);
2075 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00002076 log->Printf ("Process::DisableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- SUCCESS", bp_site->GetID(), (uint64_t)bp_addr);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002077 return error;
2078 }
2079 else
2080 {
2081 if (break_op_found)
2082 error.SetErrorString("Failed to restore original opcode.");
2083 }
2084 }
2085 else
2086 error.SetErrorString("Failed to read memory to verify that breakpoint trap was restored.");
2087 }
2088 }
2089 else
2090 error.SetErrorString("Unable to read memory that should contain the breakpoint trap.");
2091 }
2092 }
2093 else
2094 {
2095 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00002096 log->Printf ("Process::DisableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- already disabled", bp_site->GetID(), (uint64_t)bp_addr);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002097 return error;
2098 }
2099
2100 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00002101 log->Printf ("Process::DisableSoftwareBreakpoint (site_id = %d) addr = 0x%" PRIx64 " -- FAILED: %s",
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002102 bp_site->GetID(),
2103 (uint64_t)bp_addr,
2104 error.AsCString());
2105 return error;
2106
2107}
2108
Greg Clayton58be07b2011-01-07 06:08:19 +00002109// Uncomment to verify memory caching works after making changes to caching code
2110//#define VERIFY_MEMORY_READS
2111
Sean Callanan64c0cf22012-06-07 22:26:42 +00002112size_t
2113Process::ReadMemory (addr_t addr, void *buf, size_t size, Error &error)
2114{
Jason Molendaa7b5afa2013-11-15 00:17:32 +00002115 error.Clear();
Sean Callanan64c0cf22012-06-07 22:26:42 +00002116 if (!GetDisableMemoryCache())
2117 {
Greg Clayton58be07b2011-01-07 06:08:19 +00002118#if defined (VERIFY_MEMORY_READS)
Sean Callanan64c0cf22012-06-07 22:26:42 +00002119 // Memory caching is enabled, with debug verification
2120
2121 if (buf && size)
2122 {
2123 // Uncomment the line below to make sure memory caching is working.
2124 // I ran this through the test suite and got no assertions, so I am
2125 // pretty confident this is working well. If any changes are made to
2126 // memory caching, uncomment the line below and test your changes!
2127
2128 // Verify all memory reads by using the cache first, then redundantly
2129 // reading the same memory from the inferior and comparing to make sure
2130 // everything is exactly the same.
2131 std::string verify_buf (size, '\0');
2132 assert (verify_buf.size() == size);
2133 const size_t cache_bytes_read = m_memory_cache.Read (this, addr, buf, size, error);
2134 Error verify_error;
2135 const size_t verify_bytes_read = ReadMemoryFromInferior (addr, const_cast<char *>(verify_buf.data()), verify_buf.size(), verify_error);
2136 assert (cache_bytes_read == verify_bytes_read);
2137 assert (memcmp(buf, verify_buf.data(), verify_buf.size()) == 0);
2138 assert (verify_error.Success() == error.Success());
2139 return cache_bytes_read;
2140 }
2141 return 0;
2142#else // !defined(VERIFY_MEMORY_READS)
2143 // Memory caching is enabled, without debug verification
2144
2145 return m_memory_cache.Read (addr, buf, size, error);
2146#endif // defined (VERIFY_MEMORY_READS)
Greg Clayton58be07b2011-01-07 06:08:19 +00002147 }
Sean Callanan64c0cf22012-06-07 22:26:42 +00002148 else
2149 {
2150 // Memory caching is disabled
2151
2152 return ReadMemoryFromInferior (addr, buf, size, error);
2153 }
Greg Clayton58be07b2011-01-07 06:08:19 +00002154}
Greg Clayton58be07b2011-01-07 06:08:19 +00002155
Greg Clayton4c82d422012-05-18 23:20:01 +00002156size_t
2157Process::ReadCStringFromMemory (addr_t addr, std::string &out_str, Error &error)
2158{
Greg Claytonde87c0f2012-05-19 00:18:00 +00002159 char buf[256];
Greg Clayton4c82d422012-05-18 23:20:01 +00002160 out_str.clear();
2161 addr_t curr_addr = addr;
2162 while (1)
2163 {
2164 size_t length = ReadCStringFromMemory (curr_addr, buf, sizeof(buf), error);
2165 if (length == 0)
2166 break;
2167 out_str.append(buf, length);
2168 // If we got "length - 1" bytes, we didn't get the whole C string, we
2169 // need to read some more characters
2170 if (length == sizeof(buf) - 1)
2171 curr_addr += length;
2172 else
2173 break;
2174 }
2175 return out_str.size();
2176}
2177
Greg Clayton58be07b2011-01-07 06:08:19 +00002178
2179size_t
Ashok Thirumurthi6ac9d132013-04-19 15:58:38 +00002180Process::ReadStringFromMemory (addr_t addr, char *dst, size_t max_bytes, Error &error,
2181 size_t type_width)
2182{
2183 size_t total_bytes_read = 0;
2184 if (dst && max_bytes && type_width && max_bytes >= type_width)
2185 {
2186 // Ensure a null terminator independent of the number of bytes that is read.
2187 memset (dst, 0, max_bytes);
2188 size_t bytes_left = max_bytes - type_width;
2189
2190 const char terminator[4] = {'\0', '\0', '\0', '\0'};
2191 assert(sizeof(terminator) >= type_width &&
2192 "Attempting to validate a string with more than 4 bytes per character!");
2193
2194 addr_t curr_addr = addr;
2195 const size_t cache_line_size = m_memory_cache.GetMemoryCacheLineSize();
2196 char *curr_dst = dst;
2197
2198 error.Clear();
2199 while (bytes_left > 0 && error.Success())
2200 {
2201 addr_t cache_line_bytes_left = cache_line_size - (curr_addr % cache_line_size);
2202 addr_t bytes_to_read = std::min<addr_t>(bytes_left, cache_line_bytes_left);
2203 size_t bytes_read = ReadMemory (curr_addr, curr_dst, bytes_to_read, error);
2204
2205 if (bytes_read == 0)
2206 break;
2207
2208 // Search for a null terminator of correct size and alignment in bytes_read
2209 size_t aligned_start = total_bytes_read - total_bytes_read % type_width;
2210 for (size_t i = aligned_start; i + type_width <= total_bytes_read + bytes_read; i += type_width)
2211 if (::strncmp(&dst[i], terminator, type_width) == 0)
2212 {
2213 error.Clear();
2214 return i;
2215 }
2216
2217 total_bytes_read += bytes_read;
2218 curr_dst += bytes_read;
2219 curr_addr += bytes_read;
2220 bytes_left -= bytes_read;
2221 }
2222 }
2223 else
2224 {
2225 if (max_bytes)
2226 error.SetErrorString("invalid arguments");
2227 }
2228 return total_bytes_read;
2229}
2230
2231// Deprecated in favor of ReadStringFromMemory which has wchar support and correct code to find
2232// null terminators.
2233size_t
Greg Claytone91b7952011-12-15 03:14:23 +00002234Process::ReadCStringFromMemory (addr_t addr, char *dst, size_t dst_max_len, Error &result_error)
Greg Clayton8b82f082011-04-12 05:54:46 +00002235{
2236 size_t total_cstr_len = 0;
2237 if (dst && dst_max_len)
2238 {
Greg Claytone91b7952011-12-15 03:14:23 +00002239 result_error.Clear();
Greg Clayton8b82f082011-04-12 05:54:46 +00002240 // NULL out everything just to be safe
2241 memset (dst, 0, dst_max_len);
2242 Error error;
2243 addr_t curr_addr = addr;
2244 const size_t cache_line_size = m_memory_cache.GetMemoryCacheLineSize();
2245 size_t bytes_left = dst_max_len - 1;
2246 char *curr_dst = dst;
2247
2248 while (bytes_left > 0)
2249 {
2250 addr_t cache_line_bytes_left = cache_line_size - (curr_addr % cache_line_size);
2251 addr_t bytes_to_read = std::min<addr_t>(bytes_left, cache_line_bytes_left);
2252 size_t bytes_read = ReadMemory (curr_addr, curr_dst, bytes_to_read, error);
2253
2254 if (bytes_read == 0)
2255 {
Greg Claytone91b7952011-12-15 03:14:23 +00002256 result_error = error;
Greg Clayton8b82f082011-04-12 05:54:46 +00002257 dst[total_cstr_len] = '\0';
2258 break;
2259 }
2260 const size_t len = strlen(curr_dst);
2261
2262 total_cstr_len += len;
2263
2264 if (len < bytes_to_read)
2265 break;
2266
2267 curr_dst += bytes_read;
2268 curr_addr += bytes_read;
2269 bytes_left -= bytes_read;
2270 }
2271 }
Greg Claytone91b7952011-12-15 03:14:23 +00002272 else
2273 {
2274 if (dst == NULL)
2275 result_error.SetErrorString("invalid arguments");
2276 else
2277 result_error.Clear();
2278 }
Greg Clayton8b82f082011-04-12 05:54:46 +00002279 return total_cstr_len;
2280}
2281
2282size_t
Greg Clayton58be07b2011-01-07 06:08:19 +00002283Process::ReadMemoryFromInferior (addr_t addr, void *buf, size_t size, Error &error)
2284{
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002285 if (buf == NULL || size == 0)
2286 return 0;
2287
2288 size_t bytes_read = 0;
2289 uint8_t *bytes = (uint8_t *)buf;
2290
2291 while (bytes_read < size)
2292 {
2293 const size_t curr_size = size - bytes_read;
2294 const size_t curr_bytes_read = DoReadMemory (addr + bytes_read,
2295 bytes + bytes_read,
2296 curr_size,
2297 error);
2298 bytes_read += curr_bytes_read;
2299 if (curr_bytes_read == curr_size || curr_bytes_read == 0)
2300 break;
2301 }
2302
2303 // Replace any software breakpoint opcodes that fall into this range back
2304 // into "buf" before we return
2305 if (bytes_read > 0)
2306 RemoveBreakpointOpcodesFromBuffer (addr, bytes_read, (uint8_t *)buf);
2307 return bytes_read;
2308}
2309
Greg Clayton58a4c462010-12-16 20:01:20 +00002310uint64_t
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002311Process::ReadUnsignedIntegerFromMemory (lldb::addr_t vm_addr, size_t integer_byte_size, uint64_t fail_value, Error &error)
Greg Clayton58a4c462010-12-16 20:01:20 +00002312{
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002313 Scalar scalar;
2314 if (ReadScalarIntegerFromMemory(vm_addr, integer_byte_size, false, scalar, error))
2315 return scalar.ULongLong(fail_value);
2316 return fail_value;
2317}
2318
2319addr_t
2320Process::ReadPointerFromMemory (lldb::addr_t vm_addr, Error &error)
2321{
2322 Scalar scalar;
2323 if (ReadScalarIntegerFromMemory(vm_addr, GetAddressByteSize(), false, scalar, error))
2324 return scalar.ULongLong(LLDB_INVALID_ADDRESS);
2325 return LLDB_INVALID_ADDRESS;
2326}
2327
2328
2329bool
2330Process::WritePointerToMemory (lldb::addr_t vm_addr,
2331 lldb::addr_t ptr_value,
2332 Error &error)
2333{
2334 Scalar scalar;
2335 const uint32_t addr_byte_size = GetAddressByteSize();
2336 if (addr_byte_size <= 4)
2337 scalar = (uint32_t)ptr_value;
Greg Clayton58a4c462010-12-16 20:01:20 +00002338 else
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002339 scalar = ptr_value;
2340 return WriteScalarToMemory(vm_addr, scalar, addr_byte_size, error) == addr_byte_size;
Greg Clayton58a4c462010-12-16 20:01:20 +00002341}
2342
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002343size_t
2344Process::WriteMemoryPrivate (addr_t addr, const void *buf, size_t size, Error &error)
2345{
2346 size_t bytes_written = 0;
2347 const uint8_t *bytes = (const uint8_t *)buf;
2348
2349 while (bytes_written < size)
2350 {
2351 const size_t curr_size = size - bytes_written;
2352 const size_t curr_bytes_written = DoWriteMemory (addr + bytes_written,
2353 bytes + bytes_written,
2354 curr_size,
2355 error);
2356 bytes_written += curr_bytes_written;
2357 if (curr_bytes_written == curr_size || curr_bytes_written == 0)
2358 break;
2359 }
2360 return bytes_written;
2361}
2362
2363size_t
2364Process::WriteMemory (addr_t addr, const void *buf, size_t size, Error &error)
2365{
Greg Clayton58be07b2011-01-07 06:08:19 +00002366#if defined (ENABLE_MEMORY_CACHING)
2367 m_memory_cache.Flush (addr, size);
2368#endif
2369
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002370 if (buf == NULL || size == 0)
2371 return 0;
Jim Ingham78a685a2011-04-16 00:01:13 +00002372
Jim Ingham4b536182011-08-09 02:12:22 +00002373 m_mod_id.BumpMemoryID();
Jim Ingham78a685a2011-04-16 00:01:13 +00002374
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002375 // We need to write any data that would go where any current software traps
2376 // (enabled software breakpoints) any software traps (breakpoints) that we
2377 // may have placed in our tasks memory.
2378
Greg Claytond8cf1a12013-06-12 00:46:38 +00002379 BreakpointSiteList bp_sites_in_range;
2380
2381 if (m_breakpoint_site_list.FindInRange (addr, addr + size, bp_sites_in_range))
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002382 {
Greg Claytond8cf1a12013-06-12 00:46:38 +00002383 // No breakpoint sites overlap
2384 if (bp_sites_in_range.IsEmpty())
2385 return WriteMemoryPrivate (addr, buf, size, error);
2386 else
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002387 {
Greg Claytond8cf1a12013-06-12 00:46:38 +00002388 const uint8_t *ubuf = (const uint8_t *)buf;
2389 uint64_t bytes_written = 0;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002390
Greg Claytond8cf1a12013-06-12 00:46:38 +00002391 bp_sites_in_range.ForEach([this, addr, size, &bytes_written, &ubuf, &error](BreakpointSite *bp) -> void {
2392
2393 if (error.Success())
2394 {
2395 addr_t intersect_addr;
2396 size_t intersect_size;
2397 size_t opcode_offset;
2398 const bool intersects = bp->IntersectsRange(addr, size, &intersect_addr, &intersect_size, &opcode_offset);
2399 assert(intersects);
2400 assert(addr <= intersect_addr && intersect_addr < addr + size);
2401 assert(addr < intersect_addr + intersect_size && intersect_addr + intersect_size <= addr + size);
2402 assert(opcode_offset + intersect_size <= bp->GetByteSize());
2403
2404 // Check for bytes before this breakpoint
2405 const addr_t curr_addr = addr + bytes_written;
2406 if (intersect_addr > curr_addr)
2407 {
2408 // There are some bytes before this breakpoint that we need to
2409 // just write to memory
2410 size_t curr_size = intersect_addr - curr_addr;
2411 size_t curr_bytes_written = WriteMemoryPrivate (curr_addr,
2412 ubuf + bytes_written,
2413 curr_size,
2414 error);
2415 bytes_written += curr_bytes_written;
2416 if (curr_bytes_written != curr_size)
2417 {
2418 // We weren't able to write all of the requested bytes, we
2419 // are done looping and will return the number of bytes that
2420 // we have written so far.
2421 if (error.Success())
2422 error.SetErrorToGenericError();
2423 }
2424 }
2425 // Now write any bytes that would cover up any software breakpoints
2426 // directly into the breakpoint opcode buffer
2427 ::memcpy(bp->GetSavedOpcodeBytes() + opcode_offset, ubuf + bytes_written, intersect_size);
2428 bytes_written += intersect_size;
2429 }
2430 });
2431
2432 if (bytes_written < size)
2433 bytes_written += WriteMemoryPrivate (addr + bytes_written,
2434 ubuf + bytes_written,
2435 size - bytes_written,
2436 error);
2437 }
2438 }
2439 else
2440 {
2441 return WriteMemoryPrivate (addr, buf, size, error);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002442 }
2443
2444 // Write any remaining bytes after the last breakpoint if we have any left
Greg Claytond8cf1a12013-06-12 00:46:38 +00002445 return 0; //bytes_written;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002446}
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002447
2448size_t
Greg Claytonc7bece562013-01-25 18:06:21 +00002449Process::WriteScalarToMemory (addr_t addr, const Scalar &scalar, size_t byte_size, Error &error)
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002450{
2451 if (byte_size == UINT32_MAX)
2452 byte_size = scalar.GetByteSize();
2453 if (byte_size > 0)
2454 {
2455 uint8_t buf[32];
2456 const size_t mem_size = scalar.GetAsMemoryData (buf, byte_size, GetByteOrder(), error);
2457 if (mem_size > 0)
2458 return WriteMemory(addr, buf, mem_size, error);
2459 else
2460 error.SetErrorString ("failed to get scalar as memory data");
2461 }
2462 else
2463 {
2464 error.SetErrorString ("invalid scalar value");
2465 }
2466 return 0;
2467}
2468
2469size_t
2470Process::ReadScalarIntegerFromMemory (addr_t addr,
2471 uint32_t byte_size,
2472 bool is_signed,
2473 Scalar &scalar,
2474 Error &error)
2475{
Greg Clayton7060f892013-05-01 23:41:30 +00002476 uint64_t uval = 0;
2477 if (byte_size == 0)
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002478 {
Greg Clayton7060f892013-05-01 23:41:30 +00002479 error.SetErrorString ("byte size is zero");
2480 }
2481 else if (byte_size & (byte_size - 1))
2482 {
2483 error.SetErrorStringWithFormat ("byte size %u is not a power of 2", byte_size);
2484 }
2485 else if (byte_size <= sizeof(uval))
2486 {
2487 const size_t bytes_read = ReadMemory (addr, &uval, byte_size, error);
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002488 if (bytes_read == byte_size)
2489 {
2490 DataExtractor data (&uval, sizeof(uval), GetByteOrder(), GetAddressByteSize());
Greg Claytonc7bece562013-01-25 18:06:21 +00002491 lldb::offset_t offset = 0;
Greg Clayton7060f892013-05-01 23:41:30 +00002492 if (byte_size <= 4)
2493 scalar = data.GetMaxU32 (&offset, byte_size);
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002494 else
Greg Clayton7060f892013-05-01 23:41:30 +00002495 scalar = data.GetMaxU64 (&offset, byte_size);
Greg Claytonf3ef3d22011-05-22 22:46:53 +00002496 if (is_signed)
2497 scalar.SignExtend(byte_size * 8);
2498 return bytes_read;
2499 }
2500 }
2501 else
2502 {
2503 error.SetErrorStringWithFormat ("byte size of %u is too large for integer scalar type", byte_size);
2504 }
2505 return 0;
2506}
2507
Greg Claytond495c532011-05-17 03:37:42 +00002508#define USE_ALLOCATE_MEMORY_CACHE 1
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002509addr_t
2510Process::AllocateMemory(size_t size, uint32_t permissions, Error &error)
2511{
Jim Inghamf72ce3a2011-06-20 17:32:44 +00002512 if (GetPrivateState() != eStateStopped)
2513 return LLDB_INVALID_ADDRESS;
2514
Greg Claytond495c532011-05-17 03:37:42 +00002515#if defined (USE_ALLOCATE_MEMORY_CACHE)
2516 return m_allocated_memory_cache.AllocateMemory(size, permissions, error);
2517#else
Greg Claytonb2daec92011-01-23 19:58:49 +00002518 addr_t allocated_addr = DoAllocateMemory (size, permissions, error);
Greg Clayton5160ce52013-03-27 23:08:40 +00002519 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Greg Claytonb2daec92011-01-23 19:58:49 +00002520 if (log)
Greg Clayton45989072013-10-23 18:24:30 +00002521 log->Printf("Process::AllocateMemory(size=%" PRIu64 ", permissions=%s) => 0x%16.16" PRIx64 " (m_stop_id = %u m_memory_id = %u)",
Deepak Panickald66b50c2013-10-22 12:27:43 +00002522 (uint64_t)size,
Greg Claytond495c532011-05-17 03:37:42 +00002523 GetPermissionsAsCString (permissions),
Greg Claytonb2daec92011-01-23 19:58:49 +00002524 (uint64_t)allocated_addr,
Jim Ingham4b536182011-08-09 02:12:22 +00002525 m_mod_id.GetStopID(),
2526 m_mod_id.GetMemoryID());
Greg Claytonb2daec92011-01-23 19:58:49 +00002527 return allocated_addr;
Greg Claytond495c532011-05-17 03:37:42 +00002528#endif
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002529}
2530
Sean Callanan90539452011-09-20 23:01:51 +00002531bool
2532Process::CanJIT ()
2533{
Sean Callanana7b443a2012-02-14 22:50:38 +00002534 if (m_can_jit == eCanJITDontKnow)
2535 {
Todd Fialaaf245d12014-06-30 21:05:18 +00002536 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Sean Callanana7b443a2012-02-14 22:50:38 +00002537 Error err;
2538
2539 uint64_t allocated_memory = AllocateMemory(8,
2540 ePermissionsReadable | ePermissionsWritable | ePermissionsExecutable,
2541 err);
2542
2543 if (err.Success())
Todd Fialaaf245d12014-06-30 21:05:18 +00002544 {
Sean Callanana7b443a2012-02-14 22:50:38 +00002545 m_can_jit = eCanJITYes;
Todd Fialaaf245d12014-06-30 21:05:18 +00002546 if (log)
2547 log->Printf ("Process::%s pid %" PRIu64 " allocation test passed, CanJIT () is true", __FUNCTION__, GetID ());
2548 }
Sean Callanana7b443a2012-02-14 22:50:38 +00002549 else
Todd Fialaaf245d12014-06-30 21:05:18 +00002550 {
Sean Callanana7b443a2012-02-14 22:50:38 +00002551 m_can_jit = eCanJITNo;
Todd Fialaaf245d12014-06-30 21:05:18 +00002552 if (log)
2553 log->Printf ("Process::%s pid %" PRIu64 " allocation test failed, CanJIT () is false: %s", __FUNCTION__, GetID (), err.AsCString ());
2554 }
Sean Callanana7b443a2012-02-14 22:50:38 +00002555
2556 DeallocateMemory (allocated_memory);
2557 }
2558
Sean Callanan90539452011-09-20 23:01:51 +00002559 return m_can_jit == eCanJITYes;
2560}
2561
2562void
2563Process::SetCanJIT (bool can_jit)
2564{
2565 m_can_jit = (can_jit ? eCanJITYes : eCanJITNo);
2566}
2567
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002568Error
2569Process::DeallocateMemory (addr_t ptr)
2570{
Greg Claytond495c532011-05-17 03:37:42 +00002571 Error error;
2572#if defined (USE_ALLOCATE_MEMORY_CACHE)
2573 if (!m_allocated_memory_cache.DeallocateMemory(ptr))
2574 {
Daniel Malead01b2952012-11-29 21:49:15 +00002575 error.SetErrorStringWithFormat ("deallocation of memory at 0x%" PRIx64 " failed.", (uint64_t)ptr);
Greg Claytond495c532011-05-17 03:37:42 +00002576 }
2577#else
2578 error = DoDeallocateMemory (ptr);
Greg Claytonb2daec92011-01-23 19:58:49 +00002579
Greg Clayton5160ce52013-03-27 23:08:40 +00002580 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Greg Claytonb2daec92011-01-23 19:58:49 +00002581 if (log)
Daniel Malead01b2952012-11-29 21:49:15 +00002582 log->Printf("Process::DeallocateMemory(addr=0x%16.16" PRIx64 ") => err = %s (m_stop_id = %u, m_memory_id = %u)",
Greg Claytonb2daec92011-01-23 19:58:49 +00002583 ptr,
2584 error.AsCString("SUCCESS"),
Jim Ingham4b536182011-08-09 02:12:22 +00002585 m_mod_id.GetStopID(),
2586 m_mod_id.GetMemoryID());
Greg Claytond495c532011-05-17 03:37:42 +00002587#endif
Greg Claytonb2daec92011-01-23 19:58:49 +00002588 return error;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002589}
2590
Han Ming Ongc811d382012-11-17 00:33:14 +00002591
Greg Claytonc9660542012-02-05 02:38:54 +00002592ModuleSP
Greg Claytonc859e2d2012-02-13 23:10:39 +00002593Process::ReadModuleFromMemory (const FileSpec& file_spec,
Andrew MacPherson17220c12014-03-05 10:12:43 +00002594 lldb::addr_t header_addr,
2595 size_t size_to_read)
Greg Claytonc9660542012-02-05 02:38:54 +00002596{
Greg Claytonc7f09cc2012-02-24 21:55:59 +00002597 ModuleSP module_sp (new Module (file_spec, ArchSpec()));
Greg Claytonc9660542012-02-05 02:38:54 +00002598 if (module_sp)
2599 {
Greg Claytonc7f09cc2012-02-24 21:55:59 +00002600 Error error;
Andrew MacPherson17220c12014-03-05 10:12:43 +00002601 ObjectFile *objfile = module_sp->GetMemoryObjectFile (shared_from_this(), header_addr, error, size_to_read);
Greg Claytonc7f09cc2012-02-24 21:55:59 +00002602 if (objfile)
Greg Claytonc7f09cc2012-02-24 21:55:59 +00002603 return module_sp;
Greg Claytonc9660542012-02-05 02:38:54 +00002604 }
Greg Claytonc7f09cc2012-02-24 21:55:59 +00002605 return ModuleSP();
Greg Claytonc9660542012-02-05 02:38:54 +00002606}
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002607
2608Error
Jim Ingham1b5792e2012-12-18 02:03:49 +00002609Process::EnableWatchpoint (Watchpoint *watchpoint, bool notify)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002610{
2611 Error error;
2612 error.SetErrorString("watchpoints are not supported");
2613 return error;
2614}
2615
2616Error
Jim Ingham1b5792e2012-12-18 02:03:49 +00002617Process::DisableWatchpoint (Watchpoint *watchpoint, bool notify)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002618{
2619 Error error;
2620 error.SetErrorString("watchpoints are not supported");
2621 return error;
2622}
2623
2624StateType
2625Process::WaitForProcessStopPrivate (const TimeValue *timeout, EventSP &event_sp)
2626{
2627 StateType state;
2628 // Now wait for the process to launch and return control to us, and then
2629 // call DidLaunch:
2630 while (1)
2631 {
Greg Clayton6779606a2011-01-22 23:43:18 +00002632 event_sp.reset();
2633 state = WaitForStateChangedEventsPrivate (timeout, event_sp);
2634
Greg Clayton2637f822011-11-17 01:23:07 +00002635 if (StateIsStoppedState(state, false))
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002636 break;
Greg Clayton6779606a2011-01-22 23:43:18 +00002637
2638 // If state is invalid, then we timed out
2639 if (state == eStateInvalid)
2640 break;
2641
2642 if (event_sp)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002643 HandlePrivateEvent (event_sp);
2644 }
2645 return state;
2646}
2647
2648Error
Greg Claytonfbb76342013-11-20 21:07:01 +00002649Process::Launch (ProcessLaunchInfo &launch_info)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002650{
2651 Error error;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002652 m_abi_sp.reset();
Greg Clayton93d3c8332011-02-16 04:46:07 +00002653 m_dyld_ap.reset();
Andrew MacPherson17220c12014-03-05 10:12:43 +00002654 m_jit_loaders_ap.reset();
Jason Molendaeef51062013-11-05 03:57:19 +00002655 m_system_runtime_ap.reset();
Greg Clayton56d9a1b2011-08-22 02:49:39 +00002656 m_os_ap.reset();
Caroline Ticeef5c6d02010-11-16 05:07:41 +00002657 m_process_input_reader.reset();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002658
Greg Claytonaa149cb2011-08-11 02:48:45 +00002659 Module *exe_module = m_target.GetExecutableModulePointer();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002660 if (exe_module)
2661 {
Greg Clayton2289fa42011-04-30 01:09:13 +00002662 char local_exec_file_path[PATH_MAX];
2663 char platform_exec_file_path[PATH_MAX];
2664 exe_module->GetFileSpec().GetPath(local_exec_file_path, sizeof(local_exec_file_path));
2665 exe_module->GetPlatformFileSpec().GetPath(platform_exec_file_path, sizeof(platform_exec_file_path));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002666 if (exe_module->GetFileSpec().Exists())
2667 {
Greg Claytonfbb76342013-11-20 21:07:01 +00002668 // Install anything that might need to be installed prior to launching.
2669 // For host systems, this will do nothing, but if we are connected to a
2670 // remote platform it will install any needed binaries
2671 error = GetTarget().Install(&launch_info);
2672 if (error.Fail())
2673 return error;
2674
Greg Clayton71337622011-02-24 22:24:29 +00002675 if (PrivateStateThreadIsValid ())
2676 PausePrivateStateThread ();
2677
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002678 error = WillLaunch (exe_module);
2679 if (error.Success())
2680 {
Jim Ingham221d51c2013-05-08 00:35:16 +00002681 const bool restarted = false;
2682 SetPublicState (eStateLaunching, restarted);
Greg Claytone24c4ac2011-11-17 04:46:02 +00002683 m_should_detach = false;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002684
Ed Maste64fad602013-07-29 20:58:06 +00002685 if (m_public_run_lock.TrySetRunning())
Greg Clayton69fd4be2012-09-04 20:29:05 +00002686 {
2687 // Now launch using these arguments.
2688 error = DoLaunch (exe_module, launch_info);
2689 }
2690 else
2691 {
2692 // This shouldn't happen
2693 error.SetErrorString("failed to acquire process run lock");
2694 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002695
2696 if (error.Fail())
2697 {
2698 if (GetID() != LLDB_INVALID_PROCESS_ID)
2699 {
2700 SetID (LLDB_INVALID_PROCESS_ID);
2701 const char *error_string = error.AsCString();
2702 if (error_string == NULL)
2703 error_string = "launch failed";
2704 SetExitStatus (-1, error_string);
2705 }
2706 }
2707 else
2708 {
2709 EventSP event_sp;
Greg Clayton1a38ea72011-06-22 01:42:17 +00002710 TimeValue timeout_time;
2711 timeout_time = TimeValue::Now();
2712 timeout_time.OffsetWithSeconds(10);
2713 StateType state = WaitForProcessStopPrivate(&timeout_time, event_sp);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002714
Greg Clayton1a38ea72011-06-22 01:42:17 +00002715 if (state == eStateInvalid || event_sp.get() == NULL)
2716 {
2717 // We were able to launch the process, but we failed to
2718 // catch the initial stop.
2719 SetExitStatus (0, "failed to catch stop after launch");
2720 Destroy();
2721 }
2722 else if (state == eStateStopped || state == eStateCrashed)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002723 {
Greg Clayton93d3c8332011-02-16 04:46:07 +00002724
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002725 DidLaunch ();
2726
Greg Claytonc859e2d2012-02-13 23:10:39 +00002727 DynamicLoader *dyld = GetDynamicLoader ();
2728 if (dyld)
2729 dyld->DidLaunch();
Greg Clayton93d3c8332011-02-16 04:46:07 +00002730
Andrew MacPhersoneb4d0602014-03-13 09:37:02 +00002731 GetJITLoaders().DidLaunch();
Andrew MacPherson17220c12014-03-05 10:12:43 +00002732
Jason Molendaeef51062013-11-05 03:57:19 +00002733 SystemRuntime *system_runtime = GetSystemRuntime ();
2734 if (system_runtime)
2735 system_runtime->DidLaunch();
2736
Greg Clayton56d9a1b2011-08-22 02:49:39 +00002737 m_os_ap.reset (OperatingSystem::FindPlugin (this, NULL));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002738 // This delays passing the stopped event to listeners till DidLaunch gets
2739 // a chance to complete...
2740 HandlePrivateEvent (event_sp);
Greg Clayton71337622011-02-24 22:24:29 +00002741
2742 if (PrivateStateThreadIsValid ())
2743 ResumePrivateStateThread ();
2744 else
2745 StartPrivateStateThread ();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002746 }
2747 else if (state == eStateExited)
2748 {
2749 // We exited while trying to launch somehow. Don't call DidLaunch as that's
2750 // not likely to work, and return an invalid pid.
2751 HandlePrivateEvent (event_sp);
2752 }
2753 }
2754 }
2755 }
2756 else
2757 {
Greg Clayton86edbf42011-10-26 00:56:27 +00002758 error.SetErrorStringWithFormat("file doesn't exist: '%s'", local_exec_file_path);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002759 }
2760 }
2761 return error;
2762}
2763
Greg Claytonc3776bf2012-02-09 06:16:32 +00002764
2765Error
2766Process::LoadCore ()
2767{
2768 Error error = DoLoadCore();
2769 if (error.Success())
2770 {
2771 if (PrivateStateThreadIsValid ())
2772 ResumePrivateStateThread ();
2773 else
2774 StartPrivateStateThread ();
2775
Greg Claytonc859e2d2012-02-13 23:10:39 +00002776 DynamicLoader *dyld = GetDynamicLoader ();
2777 if (dyld)
2778 dyld->DidAttach();
Andrew MacPherson17220c12014-03-05 10:12:43 +00002779
Andrew MacPhersoneb4d0602014-03-13 09:37:02 +00002780 GetJITLoaders().DidAttach();
Greg Claytonc859e2d2012-02-13 23:10:39 +00002781
Jason Molendaeef51062013-11-05 03:57:19 +00002782 SystemRuntime *system_runtime = GetSystemRuntime ();
2783 if (system_runtime)
2784 system_runtime->DidAttach();
2785
Greg Claytonc859e2d2012-02-13 23:10:39 +00002786 m_os_ap.reset (OperatingSystem::FindPlugin (this, NULL));
Greg Claytonc3776bf2012-02-09 06:16:32 +00002787 // We successfully loaded a core file, now pretend we stopped so we can
2788 // show all of the threads in the core file and explore the crashed
2789 // state.
2790 SetPrivateState (eStateStopped);
2791
2792 }
2793 return error;
2794}
2795
Greg Claytonc859e2d2012-02-13 23:10:39 +00002796DynamicLoader *
2797Process::GetDynamicLoader ()
2798{
2799 if (m_dyld_ap.get() == NULL)
2800 m_dyld_ap.reset (DynamicLoader::FindPlugin(this, NULL));
2801 return m_dyld_ap.get();
2802}
Greg Claytonc3776bf2012-02-09 06:16:32 +00002803
Todd Fialaaf245d12014-06-30 21:05:18 +00002804const lldb::DataBufferSP
2805Process::GetAuxvData()
2806{
2807 return DataBufferSP ();
2808}
2809
Andrew MacPherson17220c12014-03-05 10:12:43 +00002810JITLoaderList &
2811Process::GetJITLoaders ()
2812{
2813 if (!m_jit_loaders_ap)
2814 {
2815 m_jit_loaders_ap.reset(new JITLoaderList());
2816 JITLoader::LoadPlugins(this, *m_jit_loaders_ap);
2817 }
2818 return *m_jit_loaders_ap;
2819}
2820
Jason Molendaeef51062013-11-05 03:57:19 +00002821SystemRuntime *
2822Process::GetSystemRuntime ()
2823{
2824 if (m_system_runtime_ap.get() == NULL)
2825 m_system_runtime_ap.reset (SystemRuntime::FindPlugin(this));
2826 return m_system_runtime_ap.get();
2827}
2828
Greg Claytonc3776bf2012-02-09 06:16:32 +00002829
Jim Inghambb3a2832011-01-29 01:49:25 +00002830Process::NextEventAction::EventActionResult
2831Process::AttachCompletionHandler::PerformAction (lldb::EventSP &event_sp)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002832{
Jim Inghambb3a2832011-01-29 01:49:25 +00002833 StateType state = ProcessEventData::GetStateFromEvent (event_sp.get());
2834 switch (state)
Greg Clayton19388cf2010-10-18 01:45:30 +00002835 {
Greg Clayton513c26c2011-01-29 07:10:55 +00002836 case eStateRunning:
Greg Clayton71337622011-02-24 22:24:29 +00002837 case eStateConnected:
Greg Clayton513c26c2011-01-29 07:10:55 +00002838 return eEventActionRetry;
2839
2840 case eStateStopped:
2841 case eStateCrashed:
Greg Claytonc9ed4782011-11-12 02:10:56 +00002842 {
2843 // During attach, prior to sending the eStateStopped event,
Jim Inghamb1e2e842012-04-12 18:49:31 +00002844 // lldb_private::Process subclasses must set the new process ID.
Greg Claytonc9ed4782011-11-12 02:10:56 +00002845 assert (m_process->GetID() != LLDB_INVALID_PROCESS_ID);
Jim Ingham221d51c2013-05-08 00:35:16 +00002846 // We don't want these events to be reported, so go set the ShouldReportStop here:
2847 m_process->GetThreadList().SetShouldReportStop (eVoteNo);
2848
Greg Claytonc9ed4782011-11-12 02:10:56 +00002849 if (m_exec_count > 0)
2850 {
2851 --m_exec_count;
Jim Ingham221d51c2013-05-08 00:35:16 +00002852 RequestResume();
Greg Claytonc9ed4782011-11-12 02:10:56 +00002853 return eEventActionRetry;
2854 }
2855 else
2856 {
2857 m_process->CompleteAttach ();
2858 return eEventActionSuccess;
2859 }
2860 }
Greg Clayton513c26c2011-01-29 07:10:55 +00002861 break;
Greg Claytonc9ed4782011-11-12 02:10:56 +00002862
Greg Clayton513c26c2011-01-29 07:10:55 +00002863 default:
2864 case eStateExited:
2865 case eStateInvalid:
Greg Clayton513c26c2011-01-29 07:10:55 +00002866 break;
Jim Inghambb3a2832011-01-29 01:49:25 +00002867 }
Greg Claytonc9ed4782011-11-12 02:10:56 +00002868
2869 m_exit_string.assign ("No valid Process");
2870 return eEventActionExit;
Jim Inghambb3a2832011-01-29 01:49:25 +00002871}
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002872
Jim Inghambb3a2832011-01-29 01:49:25 +00002873Process::NextEventAction::EventActionResult
2874Process::AttachCompletionHandler::HandleBeingInterrupted()
2875{
2876 return eEventActionSuccess;
2877}
2878
2879const char *
2880Process::AttachCompletionHandler::GetExitString ()
2881{
2882 return m_exit_string.c_str();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002883}
2884
2885Error
Greg Clayton144f3a92011-11-15 03:53:30 +00002886Process::Attach (ProcessAttachInfo &attach_info)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002887{
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002888 m_abi_sp.reset();
Caroline Ticeef5c6d02010-11-16 05:07:41 +00002889 m_process_input_reader.reset();
Greg Clayton93d3c8332011-02-16 04:46:07 +00002890 m_dyld_ap.reset();
Andrew MacPherson17220c12014-03-05 10:12:43 +00002891 m_jit_loaders_ap.reset();
Jason Molendaeef51062013-11-05 03:57:19 +00002892 m_system_runtime_ap.reset();
Greg Clayton56d9a1b2011-08-22 02:49:39 +00002893 m_os_ap.reset();
Jim Ingham5aee1622010-08-09 23:31:02 +00002894
Greg Clayton144f3a92011-11-15 03:53:30 +00002895 lldb::pid_t attach_pid = attach_info.GetProcessID();
Greg Claytone996fd32011-03-08 22:40:15 +00002896 Error error;
Greg Clayton144f3a92011-11-15 03:53:30 +00002897 if (attach_pid == LLDB_INVALID_PROCESS_ID)
Jim Ingham5aee1622010-08-09 23:31:02 +00002898 {
Greg Clayton144f3a92011-11-15 03:53:30 +00002899 char process_name[PATH_MAX];
Jim Ingham4299fdb2011-09-15 01:10:17 +00002900
Greg Clayton144f3a92011-11-15 03:53:30 +00002901 if (attach_info.GetExecutableFile().GetPath (process_name, sizeof(process_name)))
Jim Ingham2ecb7422010-08-17 21:54:19 +00002902 {
Greg Clayton144f3a92011-11-15 03:53:30 +00002903 const bool wait_for_launch = attach_info.GetWaitForLaunch();
2904
2905 if (wait_for_launch)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002906 {
Greg Clayton144f3a92011-11-15 03:53:30 +00002907 error = WillAttachToProcessWithName(process_name, wait_for_launch);
2908 if (error.Success())
2909 {
Ed Maste64fad602013-07-29 20:58:06 +00002910 if (m_public_run_lock.TrySetRunning())
Greg Clayton926cce72012-10-12 16:10:12 +00002911 {
2912 m_should_detach = true;
Jim Ingham221d51c2013-05-08 00:35:16 +00002913 const bool restarted = false;
2914 SetPublicState (eStateAttaching, restarted);
Greg Clayton926cce72012-10-12 16:10:12 +00002915 // Now attach using these arguments.
Jean-Daniel Dupas9c517c02013-12-23 22:32:54 +00002916 error = DoAttachToProcessWithName (process_name, attach_info);
Greg Clayton926cce72012-10-12 16:10:12 +00002917 }
2918 else
2919 {
2920 // This shouldn't happen
2921 error.SetErrorString("failed to acquire process run lock");
2922 }
Greg Claytone24c4ac2011-11-17 04:46:02 +00002923
Greg Clayton144f3a92011-11-15 03:53:30 +00002924 if (error.Fail())
2925 {
2926 if (GetID() != LLDB_INVALID_PROCESS_ID)
2927 {
2928 SetID (LLDB_INVALID_PROCESS_ID);
2929 if (error.AsCString() == NULL)
2930 error.SetErrorString("attach failed");
2931
2932 SetExitStatus(-1, error.AsCString());
2933 }
2934 }
2935 else
2936 {
2937 SetNextEventAction(new Process::AttachCompletionHandler(this, attach_info.GetResumeCount()));
2938 StartPrivateStateThread();
2939 }
2940 return error;
2941 }
Greg Claytone996fd32011-03-08 22:40:15 +00002942 }
Greg Clayton144f3a92011-11-15 03:53:30 +00002943 else
Greg Claytone996fd32011-03-08 22:40:15 +00002944 {
Greg Clayton144f3a92011-11-15 03:53:30 +00002945 ProcessInstanceInfoList process_infos;
2946 PlatformSP platform_sp (m_target.GetPlatform ());
2947
2948 if (platform_sp)
2949 {
2950 ProcessInstanceInfoMatch match_info;
2951 match_info.GetProcessInfo() = attach_info;
2952 match_info.SetNameMatchType (eNameMatchEquals);
2953 platform_sp->FindProcesses (match_info, process_infos);
2954 const uint32_t num_matches = process_infos.GetSize();
2955 if (num_matches == 1)
2956 {
2957 attach_pid = process_infos.GetProcessIDAtIndex(0);
2958 // Fall through and attach using the above process ID
2959 }
2960 else
2961 {
2962 match_info.GetProcessInfo().GetExecutableFile().GetPath (process_name, sizeof(process_name));
2963 if (num_matches > 1)
2964 error.SetErrorStringWithFormat ("more than one process named %s", process_name);
2965 else
2966 error.SetErrorStringWithFormat ("could not find a process named %s", process_name);
2967 }
2968 }
2969 else
2970 {
2971 error.SetErrorString ("invalid platform, can't find processes by name");
2972 return error;
2973 }
Greg Claytone996fd32011-03-08 22:40:15 +00002974 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002975 }
2976 else
Greg Clayton144f3a92011-11-15 03:53:30 +00002977 {
2978 error.SetErrorString ("invalid process name");
Greg Claytone996fd32011-03-08 22:40:15 +00002979 }
2980 }
Greg Clayton144f3a92011-11-15 03:53:30 +00002981
2982 if (attach_pid != LLDB_INVALID_PROCESS_ID)
Greg Claytone996fd32011-03-08 22:40:15 +00002983 {
Greg Clayton144f3a92011-11-15 03:53:30 +00002984 error = WillAttachToProcessWithID(attach_pid);
Greg Claytone996fd32011-03-08 22:40:15 +00002985 if (error.Success())
Chris Lattner30fdc8d2010-06-08 16:52:24 +00002986 {
Greg Clayton144f3a92011-11-15 03:53:30 +00002987
Ed Maste64fad602013-07-29 20:58:06 +00002988 if (m_public_run_lock.TrySetRunning())
Greg Clayton926cce72012-10-12 16:10:12 +00002989 {
2990 // Now attach using these arguments.
2991 m_should_detach = true;
Jim Ingham221d51c2013-05-08 00:35:16 +00002992 const bool restarted = false;
2993 SetPublicState (eStateAttaching, restarted);
Greg Clayton926cce72012-10-12 16:10:12 +00002994 error = DoAttachToProcessWithID (attach_pid, attach_info);
2995 }
2996 else
2997 {
2998 // This shouldn't happen
2999 error.SetErrorString("failed to acquire process run lock");
3000 }
3001
Greg Clayton144f3a92011-11-15 03:53:30 +00003002 if (error.Success())
3003 {
3004
3005 SetNextEventAction(new Process::AttachCompletionHandler(this, attach_info.GetResumeCount()));
3006 StartPrivateStateThread();
3007 }
3008 else
Greg Claytone996fd32011-03-08 22:40:15 +00003009 {
3010 if (GetID() != LLDB_INVALID_PROCESS_ID)
3011 {
3012 SetID (LLDB_INVALID_PROCESS_ID);
3013 const char *error_string = error.AsCString();
3014 if (error_string == NULL)
3015 error_string = "attach failed";
3016
3017 SetExitStatus(-1, error_string);
3018 }
3019 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003020 }
3021 }
3022 return error;
3023}
3024
Greg Clayton93d3c8332011-02-16 04:46:07 +00003025void
3026Process::CompleteAttach ()
3027{
3028 // Let the process subclass figure out at much as it can about the process
3029 // before we go looking for a dynamic loader plug-in.
3030 DidAttach();
3031
Jim Ingham4299fdb2011-09-15 01:10:17 +00003032 // We just attached. If we have a platform, ask it for the process architecture, and if it isn't
3033 // the same as the one we've already set, switch architectures.
3034 PlatformSP platform_sp (m_target.GetPlatform ());
3035 assert (platform_sp.get());
3036 if (platform_sp)
3037 {
Greg Clayton70512312012-05-08 01:45:38 +00003038 const ArchSpec &target_arch = m_target.GetArchitecture();
Greg Clayton1e0c8842013-01-11 20:49:54 +00003039 if (target_arch.IsValid() && !platform_sp->IsCompatibleArchitecture (target_arch, false, NULL))
Greg Clayton70512312012-05-08 01:45:38 +00003040 {
3041 ArchSpec platform_arch;
3042 platform_sp = platform_sp->GetPlatformForArchitecture (target_arch, &platform_arch);
3043 if (platform_sp)
3044 {
3045 m_target.SetPlatform (platform_sp);
3046 m_target.SetArchitecture(platform_arch);
3047 }
3048 }
3049 else
3050 {
3051 ProcessInstanceInfo process_info;
3052 platform_sp->GetProcessInfo (GetID(), process_info);
3053 const ArchSpec &process_arch = process_info.GetArchitecture();
Sean Callananbf4b7be2012-12-13 22:07:14 +00003054 if (process_arch.IsValid() && !m_target.GetArchitecture().IsExactMatch(process_arch))
Greg Clayton70512312012-05-08 01:45:38 +00003055 m_target.SetArchitecture (process_arch);
3056 }
Jim Ingham4299fdb2011-09-15 01:10:17 +00003057 }
3058
3059 // We have completed the attach, now it is time to find the dynamic loader
Greg Clayton93d3c8332011-02-16 04:46:07 +00003060 // plug-in
Greg Claytonc859e2d2012-02-13 23:10:39 +00003061 DynamicLoader *dyld = GetDynamicLoader ();
3062 if (dyld)
3063 dyld->DidAttach();
Greg Clayton93d3c8332011-02-16 04:46:07 +00003064
Andrew MacPhersoneb4d0602014-03-13 09:37:02 +00003065 GetJITLoaders().DidAttach();
Andrew MacPherson17220c12014-03-05 10:12:43 +00003066
Jason Molendaeef51062013-11-05 03:57:19 +00003067 SystemRuntime *system_runtime = GetSystemRuntime ();
3068 if (system_runtime)
3069 system_runtime->DidAttach();
3070
Greg Clayton56d9a1b2011-08-22 02:49:39 +00003071 m_os_ap.reset (OperatingSystem::FindPlugin (this, NULL));
Greg Clayton93d3c8332011-02-16 04:46:07 +00003072 // Figure out which one is the executable, and set that in our target:
Enrico Granata17598482012-11-08 02:22:02 +00003073 const ModuleList &target_modules = m_target.GetImages();
Jim Ingham3ee12ef2012-05-30 02:19:25 +00003074 Mutex::Locker modules_locker(target_modules.GetMutex());
3075 size_t num_modules = target_modules.GetSize();
3076 ModuleSP new_executable_module_sp;
Greg Clayton93d3c8332011-02-16 04:46:07 +00003077
Andy Gibbsa297a972013-06-19 19:04:53 +00003078 for (size_t i = 0; i < num_modules; i++)
Greg Clayton93d3c8332011-02-16 04:46:07 +00003079 {
Jim Ingham3ee12ef2012-05-30 02:19:25 +00003080 ModuleSP module_sp (target_modules.GetModuleAtIndexUnlocked (i));
Greg Clayton8b82f082011-04-12 05:54:46 +00003081 if (module_sp && module_sp->IsExecutable())
Greg Clayton93d3c8332011-02-16 04:46:07 +00003082 {
Greg Claytonaa149cb2011-08-11 02:48:45 +00003083 if (m_target.GetExecutableModulePointer() != module_sp.get())
Jim Ingham3ee12ef2012-05-30 02:19:25 +00003084 new_executable_module_sp = module_sp;
Greg Clayton93d3c8332011-02-16 04:46:07 +00003085 break;
3086 }
3087 }
Jim Ingham3ee12ef2012-05-30 02:19:25 +00003088 if (new_executable_module_sp)
3089 m_target.SetExecutableModule (new_executable_module_sp, false);
Greg Clayton93d3c8332011-02-16 04:46:07 +00003090}
3091
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003092Error
Jason Molenda4bd4e7e2012-09-29 04:02:01 +00003093Process::ConnectRemote (Stream *strm, const char *remote_url)
Greg Claytonb766a732011-02-04 01:58:07 +00003094{
Greg Claytonb766a732011-02-04 01:58:07 +00003095 m_abi_sp.reset();
3096 m_process_input_reader.reset();
3097
3098 // Find the process and its architecture. Make sure it matches the architecture
3099 // of the current Target, and if not adjust it.
3100
Jason Molenda4bd4e7e2012-09-29 04:02:01 +00003101 Error error (DoConnectRemote (strm, remote_url));
Greg Claytonb766a732011-02-04 01:58:07 +00003102 if (error.Success())
3103 {
Greg Clayton71337622011-02-24 22:24:29 +00003104 if (GetID() != LLDB_INVALID_PROCESS_ID)
3105 {
Greg Clayton32e0a752011-03-30 18:16:51 +00003106 EventSP event_sp;
3107 StateType state = WaitForProcessStopPrivate(NULL, event_sp);
3108
3109 if (state == eStateStopped || state == eStateCrashed)
3110 {
3111 // If we attached and actually have a process on the other end, then
3112 // this ended up being the equivalent of an attach.
3113 CompleteAttach ();
3114
3115 // This delays passing the stopped event to listeners till
3116 // CompleteAttach gets a chance to complete...
3117 HandlePrivateEvent (event_sp);
3118
3119 }
Greg Clayton71337622011-02-24 22:24:29 +00003120 }
Greg Clayton32e0a752011-03-30 18:16:51 +00003121
3122 if (PrivateStateThreadIsValid ())
3123 ResumePrivateStateThread ();
3124 else
3125 StartPrivateStateThread ();
Greg Claytonb766a732011-02-04 01:58:07 +00003126 }
3127 return error;
3128}
3129
3130
3131Error
Jim Ingham3b8285d2012-04-19 01:40:33 +00003132Process::PrivateResume ()
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003133{
Greg Clayton5160ce52013-03-27 23:08:40 +00003134 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_PROCESS|LIBLLDB_LOG_STEP));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003135 if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00003136 log->Printf("Process::PrivateResume() m_stop_id = %u, public state: %s private state: %s",
Jim Ingham4b536182011-08-09 02:12:22 +00003137 m_mod_id.GetStopID(),
Jim Ingham444586b2011-01-24 06:34:17 +00003138 StateAsCString(m_public_state.GetValue()),
3139 StateAsCString(m_private_state.GetValue()));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003140
3141 Error error (WillResume());
3142 // Tell the process it is about to resume before the thread list
3143 if (error.Success())
3144 {
Johnny Chenc4221e42010-12-02 20:53:05 +00003145 // Now let the thread list know we are about to resume so it
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003146 // can let all of our threads know that they are about to be
3147 // resumed. Threads will each be called with
3148 // Thread::WillResume(StateType) where StateType contains the state
3149 // that they are supposed to have when the process is resumed
3150 // (suspended/running/stepping). Threads should also check
3151 // their resume signal in lldb::Thread::GetResumeSignal()
Jim Ingham221d51c2013-05-08 00:35:16 +00003152 // to see if they are supposed to start back up with a signal.
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003153 if (m_thread_list.WillResume())
3154 {
Jim Ingham372787f2012-04-07 00:00:41 +00003155 // Last thing, do the PreResumeActions.
3156 if (!RunPreResumeActions())
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003157 {
Jim Ingham0161b492013-02-09 01:29:05 +00003158 error.SetErrorStringWithFormat ("Process::PrivateResume PreResumeActions failed, not resuming.");
Jim Ingham372787f2012-04-07 00:00:41 +00003159 }
3160 else
3161 {
3162 m_mod_id.BumpResumeID();
3163 error = DoResume();
3164 if (error.Success())
3165 {
3166 DidResume();
3167 m_thread_list.DidResume();
3168 if (log)
3169 log->Printf ("Process thinks the process has resumed.");
3170 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003171 }
3172 }
3173 else
3174 {
Jim Ingham513c6bb2012-09-01 01:02:41 +00003175 // Somebody wanted to run without running. So generate a continue & a stopped event,
3176 // and let the world handle them.
3177 if (log)
3178 log->Printf ("Process::PrivateResume() asked to simulate a start & stop.");
3179
3180 SetPrivateState(eStateRunning);
3181 SetPrivateState(eStateStopped);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003182 }
3183 }
Jim Ingham444586b2011-01-24 06:34:17 +00003184 else if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00003185 log->Printf ("Process::PrivateResume() got an error \"%s\".", error.AsCString("<unknown error>"));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003186 return error;
3187}
3188
3189Error
Greg Claytonf9b57b92013-05-10 23:48:10 +00003190Process::Halt (bool clear_thread_plans)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003191{
Greg Claytonf9b57b92013-05-10 23:48:10 +00003192 // Don't clear the m_clear_thread_plans_on_stop, only set it to true if
3193 // in case it was already set and some thread plan logic calls halt on its
3194 // own.
3195 m_clear_thread_plans_on_stop |= clear_thread_plans;
3196
Jim Inghamaacc3182012-06-06 00:29:30 +00003197 // First make sure we aren't in the middle of handling an event, or we might restart. This is pretty weak, since
3198 // we could just straightaway get another event. It just narrows the window...
3199 m_currently_handling_event.WaitForValueEqualTo(false);
3200
3201
Jim Inghambb3a2832011-01-29 01:49:25 +00003202 // Pause our private state thread so we can ensure no one else eats
3203 // the stop event out from under us.
Jim Ingham0f16e732011-02-08 05:20:59 +00003204 Listener halt_listener ("lldb.process.halt_listener");
3205 HijackPrivateProcessEvents(&halt_listener);
Greg Clayton3af9ea52010-11-18 05:57:03 +00003206
Jim Inghambb3a2832011-01-29 01:49:25 +00003207 EventSP event_sp;
Greg Clayton513c26c2011-01-29 07:10:55 +00003208 Error error (WillHalt());
Jim Inghambb3a2832011-01-29 01:49:25 +00003209
Greg Clayton513c26c2011-01-29 07:10:55 +00003210 if (error.Success())
Jim Inghambb3a2832011-01-29 01:49:25 +00003211 {
Jim Inghambb3a2832011-01-29 01:49:25 +00003212
Greg Clayton513c26c2011-01-29 07:10:55 +00003213 bool caused_stop = false;
3214
3215 // Ask the process subclass to actually halt our process
3216 error = DoHalt(caused_stop);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003217 if (error.Success())
Jim Ingham0d8bcc72010-11-17 02:32:00 +00003218 {
Greg Clayton513c26c2011-01-29 07:10:55 +00003219 if (m_public_state.GetValue() == eStateAttaching)
3220 {
3221 SetExitStatus(SIGKILL, "Cancelled async attach.");
3222 Destroy ();
3223 }
3224 else
Jim Ingham0d8bcc72010-11-17 02:32:00 +00003225 {
Jim Inghambb3a2832011-01-29 01:49:25 +00003226 // If "caused_stop" is true, then DoHalt stopped the process. If
3227 // "caused_stop" is false, the process was already stopped.
3228 // If the DoHalt caused the process to stop, then we want to catch
3229 // this event and set the interrupted bool to true before we pass
3230 // this along so clients know that the process was interrupted by
3231 // a halt command.
3232 if (caused_stop)
Greg Clayton3af9ea52010-11-18 05:57:03 +00003233 {
Jim Ingham0f16e732011-02-08 05:20:59 +00003234 // Wait for 1 second for the process to stop.
Jim Inghambb3a2832011-01-29 01:49:25 +00003235 TimeValue timeout_time;
3236 timeout_time = TimeValue::Now();
Andrew MacPherson17220c12014-03-05 10:12:43 +00003237 timeout_time.OffsetWithSeconds(10);
Jim Ingham0f16e732011-02-08 05:20:59 +00003238 bool got_event = halt_listener.WaitForEvent (&timeout_time, event_sp);
3239 StateType state = ProcessEventData::GetStateFromEvent(event_sp.get());
Jim Inghambb3a2832011-01-29 01:49:25 +00003240
Jim Ingham0f16e732011-02-08 05:20:59 +00003241 if (!got_event || state == eStateInvalid)
Greg Clayton3af9ea52010-11-18 05:57:03 +00003242 {
Jim Inghambb3a2832011-01-29 01:49:25 +00003243 // We timeout out and didn't get a stop event...
Jim Ingham0f16e732011-02-08 05:20:59 +00003244 error.SetErrorStringWithFormat ("Halt timed out. State = %s", StateAsCString(GetState()));
Greg Clayton3af9ea52010-11-18 05:57:03 +00003245 }
3246 else
3247 {
Greg Clayton2637f822011-11-17 01:23:07 +00003248 if (StateIsStoppedState (state, false))
Jim Inghambb3a2832011-01-29 01:49:25 +00003249 {
3250 // We caused the process to interrupt itself, so mark this
3251 // as such in the stop event so clients can tell an interrupted
3252 // process from a natural stop
3253 ProcessEventData::SetInterruptedInEvent (event_sp.get(), true);
3254 }
3255 else
3256 {
Greg Clayton5160ce52013-03-27 23:08:40 +00003257 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Jim Inghambb3a2832011-01-29 01:49:25 +00003258 if (log)
3259 log->Printf("Process::Halt() failed to stop, state is: %s", StateAsCString(state));
3260 error.SetErrorString ("Did not get stopped event after halt.");
3261 }
Greg Clayton3af9ea52010-11-18 05:57:03 +00003262 }
3263 }
Jim Inghambb3a2832011-01-29 01:49:25 +00003264 DidHalt();
Jim Ingham0d8bcc72010-11-17 02:32:00 +00003265 }
3266 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003267 }
Jim Inghambb3a2832011-01-29 01:49:25 +00003268 // Resume our private state thread before we post the event (if any)
Jim Ingham0f16e732011-02-08 05:20:59 +00003269 RestorePrivateProcessEvents();
Jim Inghambb3a2832011-01-29 01:49:25 +00003270
3271 // Post any event we might have consumed. If all goes well, we will have
3272 // stopped the process, intercepted the event and set the interrupted
3273 // bool in the event. Post it to the private event queue and that will end up
3274 // correctly setting the state.
3275 if (event_sp)
3276 m_private_state_broadcaster.BroadcastEvent(event_sp);
3277
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003278 return error;
3279}
3280
3281Error
Jim Ingham8af3b9c2013-03-29 01:18:12 +00003282Process::HaltForDestroyOrDetach(lldb::EventSP &exit_event_sp)
3283{
3284 Error error;
3285 if (m_public_state.GetValue() == eStateRunning)
3286 {
3287 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
3288 if (log)
3289 log->Printf("Process::Destroy() About to halt.");
3290 error = Halt();
3291 if (error.Success())
3292 {
3293 // Consume the halt event.
3294 TimeValue timeout (TimeValue::Now());
3295 timeout.OffsetWithSeconds(1);
3296 StateType state = WaitForProcessToStop (&timeout, &exit_event_sp);
3297
3298 // If the process exited while we were waiting for it to stop, put the exited event into
3299 // the shared pointer passed in and return. Our caller doesn't need to do anything else, since
3300 // they don't have a process anymore...
3301
3302 if (state == eStateExited || m_private_state.GetValue() == eStateExited)
3303 {
3304 if (log)
3305 log->Printf("Process::HaltForDestroyOrDetach() Process exited while waiting to Halt.");
3306 return error;
3307 }
3308 else
3309 exit_event_sp.reset(); // It is ok to consume any non-exit stop events
3310
3311 if (state != eStateStopped)
3312 {
3313 if (log)
3314 log->Printf("Process::HaltForDestroyOrDetach() Halt failed to stop, state is: %s", StateAsCString(state));
3315 // If we really couldn't stop the process then we should just error out here, but if the
3316 // lower levels just bobbled sending the event and we really are stopped, then continue on.
3317 StateType private_state = m_private_state.GetValue();
3318 if (private_state != eStateStopped)
3319 {
3320 return error;
3321 }
3322 }
3323 }
3324 else
3325 {
3326 if (log)
3327 log->Printf("Process::HaltForDestroyOrDetach() Halt got error: %s", error.AsCString());
3328 }
3329 }
3330 return error;
3331}
3332
3333Error
Jim Inghamacff8952013-05-02 00:27:30 +00003334Process::Detach (bool keep_stopped)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003335{
Jim Ingham8af3b9c2013-03-29 01:18:12 +00003336 EventSP exit_event_sp;
3337 Error error;
3338 m_destroy_in_process = true;
3339
3340 error = WillDetach();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003341
3342 if (error.Success())
3343 {
Jim Ingham8af3b9c2013-03-29 01:18:12 +00003344 if (DetachRequiresHalt())
3345 {
3346 error = HaltForDestroyOrDetach (exit_event_sp);
3347 if (!error.Success())
3348 {
3349 m_destroy_in_process = false;
3350 return error;
3351 }
3352 else if (exit_event_sp)
3353 {
3354 // We shouldn't need to do anything else here. There's no process left to detach from...
3355 StopPrivateStateThread();
3356 m_destroy_in_process = false;
3357 return error;
3358 }
3359 }
3360
Andrew MacPhersonc3826b52014-03-25 19:59:36 +00003361 m_thread_list.DiscardThreadPlans();
3362 DisableAllBreakpointSites();
3363
Jim Inghamacff8952013-05-02 00:27:30 +00003364 error = DoDetach(keep_stopped);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003365 if (error.Success())
3366 {
3367 DidDetach();
3368 StopPrivateStateThread();
3369 }
Jim Inghamacff8952013-05-02 00:27:30 +00003370 else
3371 {
3372 return error;
3373 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003374 }
Jim Ingham8af3b9c2013-03-29 01:18:12 +00003375 m_destroy_in_process = false;
3376
3377 // If we exited when we were waiting for a process to stop, then
3378 // forward the event here so we don't lose the event
3379 if (exit_event_sp)
3380 {
3381 // Directly broadcast our exited event because we shut down our
3382 // private state thread above
3383 BroadcastEvent(exit_event_sp);
3384 }
3385
3386 // If we have been interrupted (to kill us) in the middle of running, we may not end up propagating
3387 // the last events through the event system, in which case we might strand the write lock. Unlock
3388 // it here so when we do to tear down the process we don't get an error destroying the lock.
3389
Ed Maste64fad602013-07-29 20:58:06 +00003390 m_public_run_lock.SetStopped();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003391 return error;
3392}
3393
3394Error
3395Process::Destroy ()
3396{
Jim Ingham09437922013-03-01 20:04:25 +00003397
3398 // Tell ourselves we are in the process of destroying the process, so that we don't do any unnecessary work
3399 // that might hinder the destruction. Remember to set this back to false when we are done. That way if the attempt
3400 // failed and the process stays around for some reason it won't be in a confused state.
3401
3402 m_destroy_in_process = true;
3403
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003404 Error error (WillDestroy());
3405 if (error.Success())
3406 {
Greg Clayton85fb1b92012-09-11 02:33:37 +00003407 EventSP exit_event_sp;
Jim Ingham8af3b9c2013-03-29 01:18:12 +00003408 if (DestroyRequiresHalt())
Jim Ingham04e0a222012-05-23 15:46:31 +00003409 {
Jim Ingham8af3b9c2013-03-29 01:18:12 +00003410 error = HaltForDestroyOrDetach(exit_event_sp);
Jim Ingham04e0a222012-05-23 15:46:31 +00003411 }
Jim Ingham8af3b9c2013-03-29 01:18:12 +00003412
Jim Inghamaacc3182012-06-06 00:29:30 +00003413 if (m_public_state.GetValue() != eStateRunning)
3414 {
3415 // Ditch all thread plans, and remove all our breakpoints: in case we have to restart the target to
3416 // kill it, we don't want it hitting a breakpoint...
3417 // Only do this if we've stopped, however, since if we didn't manage to halt it above, then
3418 // we're not going to have much luck doing this now.
3419 m_thread_list.DiscardThreadPlans();
3420 DisableAllBreakpointSites();
3421 }
Jim Ingham8af3b9c2013-03-29 01:18:12 +00003422
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003423 error = DoDestroy();
3424 if (error.Success())
3425 {
3426 DidDestroy();
3427 StopPrivateStateThread();
3428 }
Caroline Ticeef5c6d02010-11-16 05:07:41 +00003429 m_stdio_communication.StopReadThread();
3430 m_stdio_communication.Disconnect();
Greg Claytonb4874f12014-02-28 18:22:24 +00003431
Caroline Ticeef5c6d02010-11-16 05:07:41 +00003432 if (m_process_input_reader)
Greg Claytonb4874f12014-02-28 18:22:24 +00003433 {
3434 m_process_input_reader->SetIsDone(true);
3435 m_process_input_reader->Cancel();
Caroline Ticeef5c6d02010-11-16 05:07:41 +00003436 m_process_input_reader.reset();
Greg Claytonb4874f12014-02-28 18:22:24 +00003437 }
3438
Greg Clayton85fb1b92012-09-11 02:33:37 +00003439 // If we exited when we were waiting for a process to stop, then
3440 // forward the event here so we don't lose the event
3441 if (exit_event_sp)
3442 {
3443 // Directly broadcast our exited event because we shut down our
3444 // private state thread above
3445 BroadcastEvent(exit_event_sp);
3446 }
3447
Jim Inghamb1e2e842012-04-12 18:49:31 +00003448 // If we have been interrupted (to kill us) in the middle of running, we may not end up propagating
3449 // the last events through the event system, in which case we might strand the write lock. Unlock
3450 // it here so when we do to tear down the process we don't get an error destroying the lock.
Ed Maste64fad602013-07-29 20:58:06 +00003451 m_public_run_lock.SetStopped();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003452 }
Jim Ingham09437922013-03-01 20:04:25 +00003453
3454 m_destroy_in_process = false;
3455
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003456 return error;
3457}
3458
3459Error
3460Process::Signal (int signal)
3461{
3462 Error error (WillSignal());
3463 if (error.Success())
3464 {
3465 error = DoSignal(signal);
3466 if (error.Success())
3467 DidSignal();
3468 }
3469 return error;
3470}
3471
Greg Clayton514487e2011-02-15 21:59:32 +00003472lldb::ByteOrder
3473Process::GetByteOrder () const
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003474{
Greg Clayton514487e2011-02-15 21:59:32 +00003475 return m_target.GetArchitecture().GetByteOrder();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003476}
3477
3478uint32_t
Greg Clayton514487e2011-02-15 21:59:32 +00003479Process::GetAddressByteSize () const
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003480{
Greg Clayton514487e2011-02-15 21:59:32 +00003481 return m_target.GetArchitecture().GetAddressByteSize();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003482}
3483
Greg Clayton514487e2011-02-15 21:59:32 +00003484
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003485bool
3486Process::ShouldBroadcastEvent (Event *event_ptr)
3487{
3488 const StateType state = Process::ProcessEventData::GetStateFromEvent (event_ptr);
3489 bool return_value = true;
Greg Clayton5160ce52013-03-27 23:08:40 +00003490 Log *log(lldb_private::GetLogIfAnyCategoriesSet(LIBLLDB_LOG_EVENTS | LIBLLDB_LOG_PROCESS));
Jim Ingham0161b492013-02-09 01:29:05 +00003491
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003492 switch (state)
3493 {
Greg Claytonb766a732011-02-04 01:58:07 +00003494 case eStateConnected:
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003495 case eStateAttaching:
3496 case eStateLaunching:
3497 case eStateDetached:
3498 case eStateExited:
3499 case eStateUnloaded:
3500 // These events indicate changes in the state of the debugging session, always report them.
3501 return_value = true;
3502 break;
3503 case eStateInvalid:
3504 // We stopped for no apparent reason, don't report it.
3505 return_value = false;
3506 break;
3507 case eStateRunning:
3508 case eStateStepping:
3509 // If we've started the target running, we handle the cases where we
3510 // are already running and where there is a transition from stopped to
3511 // running differently.
3512 // running -> running: Automatically suppress extra running events
3513 // stopped -> running: Report except when there is one or more no votes
3514 // and no yes votes.
3515 SynchronouslyNotifyStateChanged (state);
Jim Ingham1460e4b2014-01-10 23:46:59 +00003516 if (m_force_next_event_delivery)
3517 return_value = true;
3518 else
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003519 {
Jim Ingham1460e4b2014-01-10 23:46:59 +00003520 switch (m_last_broadcast_state)
3521 {
3522 case eStateRunning:
3523 case eStateStepping:
3524 // We always suppress multiple runnings with no PUBLIC stop in between.
3525 return_value = false;
3526 break;
3527 default:
3528 // TODO: make this work correctly. For now always report
Bruce Mitchenerd93c4a32014-07-01 21:22:11 +00003529 // run if we aren't running so we don't miss any running
Jim Ingham1460e4b2014-01-10 23:46:59 +00003530 // events. If I run the lldb/test/thread/a.out file and
3531 // break at main.cpp:58, run and hit the breakpoints on
3532 // multiple threads, then somehow during the stepping over
3533 // of all breakpoints no run gets reported.
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003534
Jim Ingham1460e4b2014-01-10 23:46:59 +00003535 // This is a transition from stop to run.
3536 switch (m_thread_list.ShouldReportRun (event_ptr))
3537 {
3538 case eVoteYes:
3539 case eVoteNoOpinion:
3540 return_value = true;
3541 break;
3542 case eVoteNo:
3543 return_value = false;
3544 break;
3545 }
3546 break;
3547 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003548 }
3549 break;
3550 case eStateStopped:
3551 case eStateCrashed:
3552 case eStateSuspended:
3553 {
3554 // We've stopped. First see if we're going to restart the target.
3555 // If we are going to stop, then we always broadcast the event.
3556 // If we aren't going to stop, let the thread plans decide if we're going to report this event.
Jim Inghamb01e7422010-06-19 04:45:32 +00003557 // If no thread has an opinion, we don't report it.
Jim Ingham221d51c2013-05-08 00:35:16 +00003558
Jim Inghamcb4ca112012-05-16 01:32:14 +00003559 RefreshStateAfterStop ();
Jim Ingham0d8bcc72010-11-17 02:32:00 +00003560 if (ProcessEventData::GetInterruptedFromEvent (event_ptr))
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003561 {
Greg Clayton3af9ea52010-11-18 05:57:03 +00003562 if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00003563 log->Printf ("Process::ShouldBroadcastEvent (%p) stopped due to an interrupt, state: %s",
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00003564 static_cast<void*>(event_ptr),
Jim Ingham0161b492013-02-09 01:29:05 +00003565 StateAsCString(state));
Jim Ingham35878c42014-04-08 21:33:21 +00003566 // Even though we know we are going to stop, we should let the threads have a look at the stop,
3567 // so they can properly set their state.
3568 m_thread_list.ShouldStop (event_ptr);
Jim Ingham0161b492013-02-09 01:29:05 +00003569 return_value = true;
Jim Ingham0d8bcc72010-11-17 02:32:00 +00003570 }
3571 else
3572 {
Jim Ingham221d51c2013-05-08 00:35:16 +00003573 bool was_restarted = ProcessEventData::GetRestartedFromEvent (event_ptr);
3574 bool should_resume = false;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00003575
Jim Ingham0161b492013-02-09 01:29:05 +00003576 // It makes no sense to ask "ShouldStop" if we've already been restarted...
3577 // Asking the thread list is also not likely to go well, since we are running again.
3578 // So in that case just report the event.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00003579
Jim Ingham0161b492013-02-09 01:29:05 +00003580 if (!was_restarted)
3581 should_resume = m_thread_list.ShouldStop (event_ptr) == false;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00003582
Jim Ingham221d51c2013-05-08 00:35:16 +00003583 if (was_restarted || should_resume || m_resume_requested)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003584 {
Jim Ingham0161b492013-02-09 01:29:05 +00003585 Vote stop_vote = m_thread_list.ShouldReportStop (event_ptr);
3586 if (log)
3587 log->Printf ("Process::ShouldBroadcastEvent: should_stop: %i state: %s was_restarted: %i stop_vote: %d.",
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00003588 should_resume, StateAsCString(state),
3589 was_restarted, stop_vote);
3590
Jim Ingham0161b492013-02-09 01:29:05 +00003591 switch (stop_vote)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003592 {
3593 case eVoteYes:
Jim Ingham0161b492013-02-09 01:29:05 +00003594 return_value = true;
3595 break;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003596 case eVoteNoOpinion:
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003597 case eVoteNo:
3598 return_value = false;
3599 break;
3600 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00003601
Jim Inghamcb95f342012-09-05 21:13:56 +00003602 if (!was_restarted)
Jim Ingham0161b492013-02-09 01:29:05 +00003603 {
3604 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00003605 log->Printf ("Process::ShouldBroadcastEvent (%p) Restarting process from state: %s",
3606 static_cast<void*>(event_ptr),
3607 StateAsCString(state));
Jim Ingham0161b492013-02-09 01:29:05 +00003608 ProcessEventData::SetRestartedInEvent(event_ptr, true);
Jim Inghamcb95f342012-09-05 21:13:56 +00003609 PrivateResume ();
Jim Ingham0161b492013-02-09 01:29:05 +00003610 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00003611
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003612 }
3613 else
3614 {
3615 return_value = true;
3616 SynchronouslyNotifyStateChanged (state);
3617 }
3618 }
3619 }
Jim Ingham0161b492013-02-09 01:29:05 +00003620 break;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003621 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00003622
Jim Ingham1460e4b2014-01-10 23:46:59 +00003623 // Forcing the next event delivery is a one shot deal. So reset it here.
3624 m_force_next_event_delivery = false;
3625
Jim Ingham0161b492013-02-09 01:29:05 +00003626 // We do some coalescing of events (for instance two consecutive running events get coalesced.)
3627 // But we only coalesce against events we actually broadcast. So we use m_last_broadcast_state
3628 // to track that. NB - you can't use "m_public_state.GetValue()" for that purpose, as was originally done,
3629 // because the PublicState reflects the last event pulled off the queue, and there may be several
3630 // events stacked up on the queue unserviced. So the PublicState may not reflect the last broadcasted event
3631 // yet. m_last_broadcast_state gets updated here.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00003632
Jim Ingham0161b492013-02-09 01:29:05 +00003633 if (return_value)
3634 m_last_broadcast_state = state;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00003635
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003636 if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00003637 log->Printf ("Process::ShouldBroadcastEvent (%p) => new state: %s, last broadcast state: %s - %s",
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00003638 static_cast<void*>(event_ptr), StateAsCString(state),
Jim Ingham0161b492013-02-09 01:29:05 +00003639 StateAsCString(m_last_broadcast_state),
3640 return_value ? "YES" : "NO");
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003641 return return_value;
3642}
3643
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003644
3645bool
Jim Ingham372787f2012-04-07 00:00:41 +00003646Process::StartPrivateStateThread (bool force)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003647{
Greg Clayton5160ce52013-03-27 23:08:40 +00003648 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EVENTS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003649
Greg Clayton8b82f082011-04-12 05:54:46 +00003650 bool already_running = PrivateStateThreadIsValid ();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003651 if (log)
Greg Clayton8b82f082011-04-12 05:54:46 +00003652 log->Printf ("Process::%s()%s ", __FUNCTION__, already_running ? " already running" : " starting private state thread");
3653
Jim Ingham372787f2012-04-07 00:00:41 +00003654 if (!force && already_running)
Greg Clayton8b82f082011-04-12 05:54:46 +00003655 return true;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003656
3657 // Create a thread that watches our internal state and controls which
3658 // events make it to clients (into the DCProcess event queue).
Greg Clayton3e06bd92011-01-09 21:07:35 +00003659 char thread_name[1024];
Todd Fiala17096d72014-07-16 19:03:16 +00003660
3661 if (Host::MAX_THREAD_NAME_LENGTH <= 16)
3662 {
3663 // On platforms with abbreviated thread name lengths, choose thread names that fit within the limit.
3664 if (already_running)
3665 snprintf(thread_name, sizeof(thread_name), "intern-state-OV");
3666 else
3667 snprintf(thread_name, sizeof(thread_name), "intern-state");
3668 }
Jim Ingham372787f2012-04-07 00:00:41 +00003669 else
Todd Fiala17096d72014-07-16 19:03:16 +00003670 {
3671 if (already_running)
3672 snprintf(thread_name, sizeof(thread_name), "<lldb.process.internal-state-override(pid=%" PRIu64 ")>", GetID());
3673 else
3674 snprintf(thread_name, sizeof(thread_name), "<lldb.process.internal-state(pid=%" PRIu64 ")>", GetID());
3675 }
3676
Jim Ingham076b3042012-04-10 01:21:57 +00003677 // Create the private state thread, and start it running.
Greg Clayton3e06bd92011-01-09 21:07:35 +00003678 m_private_state_thread = Host::ThreadCreate (thread_name, Process::PrivateStateThread, this, NULL);
Jim Ingham076b3042012-04-10 01:21:57 +00003679 bool success = IS_VALID_LLDB_HOST_THREAD(m_private_state_thread);
3680 if (success)
3681 {
3682 ResumePrivateStateThread();
3683 return true;
3684 }
3685 else
3686 return false;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003687}
3688
3689void
3690Process::PausePrivateStateThread ()
3691{
3692 ControlPrivateStateThread (eBroadcastInternalStateControlPause);
3693}
3694
3695void
3696Process::ResumePrivateStateThread ()
3697{
3698 ControlPrivateStateThread (eBroadcastInternalStateControlResume);
3699}
3700
3701void
3702Process::StopPrivateStateThread ()
3703{
Greg Clayton8b82f082011-04-12 05:54:46 +00003704 if (PrivateStateThreadIsValid ())
3705 ControlPrivateStateThread (eBroadcastInternalStateControlStop);
Jim Inghamb1e2e842012-04-12 18:49:31 +00003706 else
3707 {
Greg Clayton5160ce52013-03-27 23:08:40 +00003708 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_PROCESS));
Jim Inghamb1e2e842012-04-12 18:49:31 +00003709 if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00003710 log->Printf ("Went to stop the private state thread, but it was already invalid.");
Jim Inghamb1e2e842012-04-12 18:49:31 +00003711 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003712}
3713
3714void
3715Process::ControlPrivateStateThread (uint32_t signal)
3716{
Greg Clayton5160ce52013-03-27 23:08:40 +00003717 Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003718
3719 assert (signal == eBroadcastInternalStateControlStop ||
3720 signal == eBroadcastInternalStateControlPause ||
3721 signal == eBroadcastInternalStateControlResume);
3722
3723 if (log)
Greg Clayton7ecb3a02011-01-22 17:43:17 +00003724 log->Printf ("Process::%s (signal = %d)", __FUNCTION__, signal);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003725
Greg Clayton7ecb3a02011-01-22 17:43:17 +00003726 // Signal the private state thread. First we should copy this is case the
3727 // thread starts exiting since the private state thread will NULL this out
3728 // when it exits
3729 const lldb::thread_t private_state_thread = m_private_state_thread;
Greg Clayton2da6d492011-02-08 01:34:25 +00003730 if (IS_VALID_LLDB_HOST_THREAD(private_state_thread))
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003731 {
3732 TimeValue timeout_time;
3733 bool timed_out;
3734
3735 m_private_state_control_broadcaster.BroadcastEvent (signal, NULL);
3736
3737 timeout_time = TimeValue::Now();
3738 timeout_time.OffsetWithSeconds(2);
Jim Inghamb1e2e842012-04-12 18:49:31 +00003739 if (log)
3740 log->Printf ("Sending control event of type: %d.", signal);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003741 m_private_state_control_wait.WaitForValueEqualTo (true, &timeout_time, &timed_out);
3742 m_private_state_control_wait.SetValue (false, eBroadcastNever);
3743
3744 if (signal == eBroadcastInternalStateControlStop)
3745 {
3746 if (timed_out)
Jim Inghamb1e2e842012-04-12 18:49:31 +00003747 {
3748 Error error;
3749 Host::ThreadCancel (private_state_thread, &error);
3750 if (log)
3751 log->Printf ("Timed out responding to the control event, cancel got error: \"%s\".", error.AsCString());
3752 }
3753 else
3754 {
3755 if (log)
3756 log->Printf ("The control event killed the private state thread without having to cancel.");
3757 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003758
3759 thread_result_t result = NULL;
Greg Clayton7ecb3a02011-01-22 17:43:17 +00003760 Host::ThreadJoin (private_state_thread, &result, NULL);
Greg Clayton49182ed2010-07-22 18:34:21 +00003761 m_private_state_thread = LLDB_INVALID_HOST_THREAD;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003762 }
3763 }
Jim Inghamb1e2e842012-04-12 18:49:31 +00003764 else
3765 {
3766 if (log)
3767 log->Printf ("Private state thread already dead, no need to signal it to stop.");
3768 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003769}
3770
3771void
Jim Inghamcfc09352012-07-27 23:57:19 +00003772Process::SendAsyncInterrupt ()
3773{
3774 if (PrivateStateThreadIsValid())
3775 m_private_state_broadcaster.BroadcastEvent (Process::eBroadcastBitInterrupt, NULL);
3776 else
3777 BroadcastEvent (Process::eBroadcastBitInterrupt, NULL);
3778}
3779
3780void
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003781Process::HandlePrivateEvent (EventSP &event_sp)
3782{
Greg Clayton5160ce52013-03-27 23:08:40 +00003783 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Jim Ingham221d51c2013-05-08 00:35:16 +00003784 m_resume_requested = false;
3785
Jim Inghamaacc3182012-06-06 00:29:30 +00003786 m_currently_handling_event.SetValue(true, eBroadcastNever);
Jim Inghambb3a2832011-01-29 01:49:25 +00003787
Greg Clayton414f5d32011-01-25 02:58:48 +00003788 const StateType new_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
Jim Inghambb3a2832011-01-29 01:49:25 +00003789
3790 // First check to see if anybody wants a shot at this event:
Jim Ingham754ab982011-01-29 04:05:41 +00003791 if (m_next_event_action_ap.get() != NULL)
Jim Inghambb3a2832011-01-29 01:49:25 +00003792 {
Jim Ingham754ab982011-01-29 04:05:41 +00003793 NextEventAction::EventActionResult action_result = m_next_event_action_ap->PerformAction(event_sp);
Jim Ingham0161b492013-02-09 01:29:05 +00003794 if (log)
3795 log->Printf ("Ran next event action, result was %d.", action_result);
3796
Jim Inghambb3a2832011-01-29 01:49:25 +00003797 switch (action_result)
3798 {
3799 case NextEventAction::eEventActionSuccess:
3800 SetNextEventAction(NULL);
3801 break;
Greg Claytonc9ed4782011-11-12 02:10:56 +00003802
Jim Inghambb3a2832011-01-29 01:49:25 +00003803 case NextEventAction::eEventActionRetry:
3804 break;
Greg Claytonc9ed4782011-11-12 02:10:56 +00003805
Jim Inghambb3a2832011-01-29 01:49:25 +00003806 case NextEventAction::eEventActionExit:
Jim Ingham2a5fdd42011-01-29 01:57:31 +00003807 // Handle Exiting Here. If we already got an exited event,
3808 // we should just propagate it. Otherwise, swallow this event,
3809 // and set our state to exit so the next event will kill us.
3810 if (new_state != eStateExited)
3811 {
3812 // FIXME: should cons up an exited event, and discard this one.
Jim Ingham754ab982011-01-29 04:05:41 +00003813 SetExitStatus(0, m_next_event_action_ap->GetExitString());
Jim Ingham221d51c2013-05-08 00:35:16 +00003814 m_currently_handling_event.SetValue(false, eBroadcastAlways);
Jim Ingham2a5fdd42011-01-29 01:57:31 +00003815 SetNextEventAction(NULL);
3816 return;
3817 }
3818 SetNextEventAction(NULL);
Jim Inghambb3a2832011-01-29 01:49:25 +00003819 break;
3820 }
3821 }
3822
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003823 // See if we should broadcast this state to external clients?
3824 const bool should_broadcast = ShouldBroadcastEvent (event_sp.get());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003825
3826 if (should_broadcast)
3827 {
Greg Claytonb4874f12014-02-28 18:22:24 +00003828 const bool is_hijacked = IsHijackedForEvent(eBroadcastBitStateChanged);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003829 if (log)
3830 {
Daniel Malead01b2952012-11-29 21:49:15 +00003831 log->Printf ("Process::%s (pid = %" PRIu64 ") broadcasting new state %s (old state %s) to %s",
Greg Clayton414f5d32011-01-25 02:58:48 +00003832 __FUNCTION__,
3833 GetID(),
3834 StateAsCString(new_state),
3835 StateAsCString (GetState ()),
Greg Claytonb4874f12014-02-28 18:22:24 +00003836 is_hijacked ? "hijacked" : "public");
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003837 }
Jim Ingham9575d842011-03-11 03:53:59 +00003838 Process::ProcessEventData::SetUpdateStateOnRemoval(event_sp.get());
Greg Clayton414f5d32011-01-25 02:58:48 +00003839 if (StateIsRunningState (new_state))
Greg Clayton44d93782014-01-27 23:43:24 +00003840 {
3841 // Only push the input handler if we aren't fowarding events,
3842 // as this means the curses GUI is in use...
3843 if (!GetTarget().GetDebugger().IsForwardingEvents())
3844 PushProcessIOHandler ();
3845 }
Greg Claytonb4874f12014-02-28 18:22:24 +00003846 else if (StateIsStoppedState(new_state, false))
3847 {
3848 if (!Process::ProcessEventData::GetRestartedFromEvent(event_sp.get()))
3849 {
3850 // If the lldb_private::Debugger is handling the events, we don't
3851 // want to pop the process IOHandler here, we want to do it when
3852 // we receive the stopped event so we can carefully control when
3853 // the process IOHandler is popped because when we stop we want to
3854 // display some text stating how and why we stopped, then maybe some
3855 // process/thread/frame info, and then we want the "(lldb) " prompt
3856 // to show up. If we pop the process IOHandler here, then we will
3857 // cause the command interpreter to become the top IOHandler after
3858 // the process pops off and it will update its prompt right away...
3859 // See the Debugger.cpp file where it calls the function as
3860 // "process_sp->PopProcessIOHandler()" to see where I am talking about.
3861 // Otherwise we end up getting overlapping "(lldb) " prompts and
3862 // garbled output.
3863 //
3864 // If we aren't handling the events in the debugger (which is indicated
3865 // by "m_target.GetDebugger().IsHandlingEvents()" returning false) or we
3866 // are hijacked, then we always pop the process IO handler manually.
3867 // Hijacking happens when the internal process state thread is running
3868 // thread plans, or when commands want to run in synchronous mode
3869 // and they call "process->WaitForProcessToStop()". An example of something
3870 // that will hijack the events is a simple expression:
3871 //
3872 // (lldb) expr (int)puts("hello")
3873 //
3874 // This will cause the internal process state thread to resume and halt
3875 // the process (and _it_ will hijack the eBroadcastBitStateChanged
3876 // events) and we do need the IO handler to be pushed and popped
3877 // correctly.
3878
3879 if (is_hijacked || m_target.GetDebugger().IsHandlingEvents() == false)
3880 PopProcessIOHandler ();
3881 }
3882 }
Jim Ingham9575d842011-03-11 03:53:59 +00003883
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003884 BroadcastEvent (event_sp);
3885 }
3886 else
3887 {
3888 if (log)
3889 {
Daniel Malead01b2952012-11-29 21:49:15 +00003890 log->Printf ("Process::%s (pid = %" PRIu64 ") suppressing state %s (old state %s): should_broadcast == false",
Greg Clayton414f5d32011-01-25 02:58:48 +00003891 __FUNCTION__,
3892 GetID(),
3893 StateAsCString(new_state),
Jason Molendafd54b362011-09-20 21:44:10 +00003894 StateAsCString (GetState ()));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003895 }
3896 }
Jim Inghamaacc3182012-06-06 00:29:30 +00003897 m_currently_handling_event.SetValue(false, eBroadcastAlways);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003898}
3899
Virgile Bellob2f1fb22013-08-23 12:44:05 +00003900thread_result_t
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003901Process::PrivateStateThread (void *arg)
3902{
3903 Process *proc = static_cast<Process*> (arg);
Virgile Bellob2f1fb22013-08-23 12:44:05 +00003904 thread_result_t result = proc->RunPrivateStateThread();
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003905 return result;
3906}
3907
Virgile Bellob2f1fb22013-08-23 12:44:05 +00003908thread_result_t
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003909Process::RunPrivateStateThread ()
3910{
Jim Ingham076b3042012-04-10 01:21:57 +00003911 bool control_only = true;
Jim Inghamb1e2e842012-04-12 18:49:31 +00003912 m_private_state_control_wait.SetValue (false, eBroadcastNever);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003913
Greg Clayton5160ce52013-03-27 23:08:40 +00003914 Log *log(lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003915 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00003916 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") thread starting...",
3917 __FUNCTION__, static_cast<void*>(this), GetID());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003918
3919 bool exit_now = false;
3920 while (!exit_now)
3921 {
3922 EventSP event_sp;
3923 WaitForEventsPrivate (NULL, event_sp, control_only);
3924 if (event_sp->BroadcasterIs(&m_private_state_control_broadcaster))
3925 {
Jim Inghamb1e2e842012-04-12 18:49:31 +00003926 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00003927 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") got a control event: %d",
3928 __FUNCTION__, static_cast<void*>(this), GetID(),
3929 event_sp->GetType());
Jim Inghamb1e2e842012-04-12 18:49:31 +00003930
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003931 switch (event_sp->GetType())
3932 {
3933 case eBroadcastInternalStateControlStop:
3934 exit_now = true;
Bruce Mitchenerd93c4a32014-07-01 21:22:11 +00003935 break; // doing any internal state management below
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003936
3937 case eBroadcastInternalStateControlPause:
3938 control_only = true;
3939 break;
3940
3941 case eBroadcastInternalStateControlResume:
3942 control_only = false;
3943 break;
3944 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00003945
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003946 m_private_state_control_wait.SetValue (true, eBroadcastAlways);
Jim Ingham0d8bcc72010-11-17 02:32:00 +00003947 continue;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003948 }
Jim Inghamcfc09352012-07-27 23:57:19 +00003949 else if (event_sp->GetType() == eBroadcastBitInterrupt)
3950 {
3951 if (m_public_state.GetValue() == eStateAttaching)
3952 {
3953 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00003954 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") woke up with an interrupt while attaching - forwarding interrupt.",
3955 __FUNCTION__, static_cast<void*>(this),
3956 GetID());
Jim Inghamcfc09352012-07-27 23:57:19 +00003957 BroadcastEvent (eBroadcastBitInterrupt, NULL);
3958 }
3959 else
3960 {
3961 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00003962 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") woke up with an interrupt - Halting.",
3963 __FUNCTION__, static_cast<void*>(this),
3964 GetID());
Jim Inghamcfc09352012-07-27 23:57:19 +00003965 Halt();
3966 }
3967 continue;
3968 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003969
3970 const StateType internal_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
3971
3972 if (internal_state != eStateInvalid)
3973 {
Greg Claytonf9b57b92013-05-10 23:48:10 +00003974 if (m_clear_thread_plans_on_stop &&
3975 StateIsStoppedState(internal_state, true))
3976 {
3977 m_clear_thread_plans_on_stop = false;
3978 m_thread_list.DiscardThreadPlans();
3979 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003980 HandlePrivateEvent (event_sp);
3981 }
3982
Greg Clayton58d1c9a2010-10-18 04:14:23 +00003983 if (internal_state == eStateInvalid ||
3984 internal_state == eStateExited ||
3985 internal_state == eStateDetached )
Jim Ingham0d8bcc72010-11-17 02:32:00 +00003986 {
Jim Ingham0d8bcc72010-11-17 02:32:00 +00003987 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00003988 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") about to exit with internal state %s...",
3989 __FUNCTION__, static_cast<void*>(this), GetID(),
3990 StateAsCString(internal_state));
Jim Ingham0d8bcc72010-11-17 02:32:00 +00003991
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003992 break;
Jim Ingham0d8bcc72010-11-17 02:32:00 +00003993 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003994 }
3995
Caroline Tice20ad3c42010-10-29 21:48:37 +00003996 // Verify log is still enabled before attempting to write to it...
Chris Lattner30fdc8d2010-06-08 16:52:24 +00003997 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00003998 log->Printf ("Process::%s (arg = %p, pid = %" PRIu64 ") thread exiting...",
3999 __FUNCTION__, static_cast<void*>(this), GetID());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004000
Ed Maste64fad602013-07-29 20:58:06 +00004001 m_public_run_lock.SetStopped();
Greg Clayton6ed95942011-01-22 07:12:45 +00004002 m_private_state_control_wait.SetValue (true, eBroadcastAlways);
4003 m_private_state_thread = LLDB_INVALID_HOST_THREAD;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004004 return NULL;
4005}
4006
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004007//------------------------------------------------------------------
4008// Process Event Data
4009//------------------------------------------------------------------
4010
4011Process::ProcessEventData::ProcessEventData () :
4012 EventData (),
4013 m_process_sp (),
4014 m_state (eStateInvalid),
Greg Claytonc982c762010-07-09 20:39:50 +00004015 m_restarted (false),
Jim Inghama8604692011-05-22 21:45:01 +00004016 m_update_state (0),
Jim Ingham0d8bcc72010-11-17 02:32:00 +00004017 m_interrupted (false)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004018{
4019}
4020
4021Process::ProcessEventData::ProcessEventData (const ProcessSP &process_sp, StateType state) :
4022 EventData (),
4023 m_process_sp (process_sp),
4024 m_state (state),
Greg Claytonc982c762010-07-09 20:39:50 +00004025 m_restarted (false),
Jim Inghama8604692011-05-22 21:45:01 +00004026 m_update_state (0),
Jim Ingham0d8bcc72010-11-17 02:32:00 +00004027 m_interrupted (false)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004028{
4029}
4030
4031Process::ProcessEventData::~ProcessEventData()
4032{
4033}
4034
4035const ConstString &
4036Process::ProcessEventData::GetFlavorString ()
4037{
4038 static ConstString g_flavor ("Process::ProcessEventData");
4039 return g_flavor;
4040}
4041
4042const ConstString &
4043Process::ProcessEventData::GetFlavor () const
4044{
4045 return ProcessEventData::GetFlavorString ();
4046}
4047
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004048void
4049Process::ProcessEventData::DoOnRemoval (Event *event_ptr)
4050{
4051 // This function gets called twice for each event, once when the event gets pulled
Jim Inghama8604692011-05-22 21:45:01 +00004052 // off of the private process event queue, and then any number of times, first when it gets pulled off of
4053 // the public event queue, then other times when we're pretending that this is where we stopped at the
4054 // end of expression evaluation. m_update_state is used to distinguish these
4055 // three cases; it is 0 when we're just pulling it off for private handling,
Jim Ingham221d51c2013-05-08 00:35:16 +00004056 // and > 1 for expression evaluation, and we don't want to do the breakpoint command handling then.
Jim Inghama8604692011-05-22 21:45:01 +00004057 if (m_update_state != 1)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004058 return;
Jim Ingham0161b492013-02-09 01:29:05 +00004059
Jim Ingham221d51c2013-05-08 00:35:16 +00004060 m_process_sp->SetPublicState (m_state, Process::ProcessEventData::GetRestartedFromEvent(event_ptr));
Jim Ingham35878c42014-04-08 21:33:21 +00004061
4062 // If this is a halt event, even if the halt stopped with some reason other than a plain interrupt (e.g. we had
4063 // already stopped for a breakpoint when the halt request came through) don't do the StopInfo actions, as they may
4064 // end up restarting the process.
4065 if (m_interrupted)
4066 return;
4067
4068 // If we're stopped and haven't restarted, then do the StopInfo actions here:
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004069 if (m_state == eStateStopped && ! m_restarted)
Jim Ingham0faa43f2011-11-08 03:00:11 +00004070 {
4071 ThreadList &curr_thread_list = m_process_sp->GetThreadList();
Greg Clayton61e7a582011-12-01 23:28:38 +00004072 uint32_t num_threads = curr_thread_list.GetSize();
4073 uint32_t idx;
Greg Claytonf4b47e12010-08-04 01:40:35 +00004074
Jim Ingham4b536182011-08-09 02:12:22 +00004075 // The actions might change one of the thread's stop_info's opinions about whether we should
4076 // stop the process, so we need to query that as we go.
Jim Ingham0faa43f2011-11-08 03:00:11 +00004077
4078 // One other complication here, is that we try to catch any case where the target has run (except for expressions)
4079 // and immediately exit, but if we get that wrong (which is possible) then the thread list might have changed, and
4080 // that would cause our iteration here to crash. We could make a copy of the thread list, but we'd really like
4081 // 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
4082 // against this list & bag out if anything differs.
Greg Clayton61e7a582011-12-01 23:28:38 +00004083 std::vector<uint32_t> thread_index_array(num_threads);
Jim Ingham0faa43f2011-11-08 03:00:11 +00004084 for (idx = 0; idx < num_threads; ++idx)
4085 thread_index_array[idx] = curr_thread_list.GetThreadAtIndex(idx)->GetIndexID();
4086
Jim Inghamc7078c22012-12-13 22:24:15 +00004087 // Use this to track whether we should continue from here. We will only continue the target running if
4088 // no thread says we should stop. Of course if some thread's PerformAction actually sets the target running,
4089 // then it doesn't matter what the other threads say...
4090
4091 bool still_should_stop = false;
Jim Ingham4b536182011-08-09 02:12:22 +00004092
Jim Ingham0ad7e052013-04-25 02:04:59 +00004093 // Sometimes - for instance if we have a bug in the stub we are talking to, we stop but no thread has a
4094 // valid stop reason. In that case we should just stop, because we have no way of telling what the right
4095 // thing to do is, and it's better to let the user decide than continue behind their backs.
4096
4097 bool does_anybody_have_an_opinion = false;
4098
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004099 for (idx = 0; idx < num_threads; ++idx)
4100 {
Jim Ingham0faa43f2011-11-08 03:00:11 +00004101 curr_thread_list = m_process_sp->GetThreadList();
4102 if (curr_thread_list.GetSize() != num_threads)
4103 {
Greg Clayton5160ce52013-03-27 23:08:40 +00004104 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STEP | LIBLLDB_LOG_PROCESS));
Jim Ingham87c665f2011-12-01 20:26:15 +00004105 if (log)
Greg Clayton61e7a582011-12-01 23:28:38 +00004106 log->Printf("Number of threads changed from %u to %u while processing event.", num_threads, curr_thread_list.GetSize());
Jim Ingham0faa43f2011-11-08 03:00:11 +00004107 break;
4108 }
4109
4110 lldb::ThreadSP thread_sp = curr_thread_list.GetThreadAtIndex(idx);
4111
4112 if (thread_sp->GetIndexID() != thread_index_array[idx])
4113 {
Greg Clayton5160ce52013-03-27 23:08:40 +00004114 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STEP | LIBLLDB_LOG_PROCESS));
Jim Ingham87c665f2011-12-01 20:26:15 +00004115 if (log)
Greg Clayton61e7a582011-12-01 23:28:38 +00004116 log->Printf("The thread at position %u changed from %u to %u while processing event.",
Jim Ingham87c665f2011-12-01 20:26:15 +00004117 idx,
4118 thread_index_array[idx],
4119 thread_sp->GetIndexID());
Jim Ingham0faa43f2011-11-08 03:00:11 +00004120 break;
4121 }
4122
Jim Inghamb15bfc72010-10-20 00:39:53 +00004123 StopInfoSP stop_info_sp = thread_sp->GetStopInfo ();
Jim Ingham5d88a062012-10-16 00:09:33 +00004124 if (stop_info_sp && stop_info_sp->IsValid())
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004125 {
Jim Ingham0ad7e052013-04-25 02:04:59 +00004126 does_anybody_have_an_opinion = true;
Jim Ingham0161b492013-02-09 01:29:05 +00004127 bool this_thread_wants_to_stop;
4128 if (stop_info_sp->GetOverrideShouldStop())
Jim Ingham4b536182011-08-09 02:12:22 +00004129 {
Jim Ingham0161b492013-02-09 01:29:05 +00004130 this_thread_wants_to_stop = stop_info_sp->GetOverriddenShouldStopValue();
4131 }
4132 else
4133 {
4134 stop_info_sp->PerformAction(event_ptr);
4135 // The stop action might restart the target. If it does, then we want to mark that in the
4136 // event so that whoever is receiving it will know to wait for the running event and reflect
4137 // that state appropriately.
4138 // We also need to stop processing actions, since they aren't expecting the target to be running.
4139
4140 // FIXME: we might have run.
4141 if (stop_info_sp->HasTargetRunSinceMe())
4142 {
4143 SetRestarted (true);
4144 break;
4145 }
4146
4147 this_thread_wants_to_stop = stop_info_sp->ShouldStop(event_ptr);
Jim Ingham4b536182011-08-09 02:12:22 +00004148 }
Jim Inghamc7078c22012-12-13 22:24:15 +00004149
Jim Inghamc7078c22012-12-13 22:24:15 +00004150 if (still_should_stop == false)
4151 still_should_stop = this_thread_wants_to_stop;
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004152 }
4153 }
Jim Ingham3ebcf7f2010-08-10 00:59:59 +00004154
Ashok Thirumurthicf7c55e2013-04-18 14:38:20 +00004155
Jim Inghama8ca6e22013-05-03 23:04:37 +00004156 if (!GetRestarted())
Jim Ingham9575d842011-03-11 03:53:59 +00004157 {
Jim Ingham0ad7e052013-04-25 02:04:59 +00004158 if (!still_should_stop && does_anybody_have_an_opinion)
Jim Ingham4b536182011-08-09 02:12:22 +00004159 {
4160 // We've been asked to continue, so do that here.
Jim Ingham9575d842011-03-11 03:53:59 +00004161 SetRestarted(true);
Jim Ingham3b8285d2012-04-19 01:40:33 +00004162 // Use the public resume method here, since this is just
4163 // extending a public resume.
Jim Ingham0161b492013-02-09 01:29:05 +00004164 m_process_sp->PrivateResume();
Jim Ingham4b536182011-08-09 02:12:22 +00004165 }
4166 else
4167 {
4168 // If we didn't restart, run the Stop Hooks here:
4169 // They might also restart the target, so watch for that.
4170 m_process_sp->GetTarget().RunStopHooks();
4171 if (m_process_sp->GetPrivateState() == eStateRunning)
4172 SetRestarted(true);
4173 }
Jim Ingham9575d842011-03-11 03:53:59 +00004174 }
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004175 }
4176}
4177
4178void
4179Process::ProcessEventData::Dump (Stream *s) const
4180{
4181 if (m_process_sp)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004182 s->Printf(" process = %p (pid = %" PRIu64 "), ",
4183 static_cast<void*>(m_process_sp.get()), m_process_sp->GetID());
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004184
Greg Clayton8b82f082011-04-12 05:54:46 +00004185 s->Printf("state = %s", StateAsCString(GetState()));
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004186}
4187
4188const Process::ProcessEventData *
4189Process::ProcessEventData::GetEventDataFromEvent (const Event *event_ptr)
4190{
4191 if (event_ptr)
4192 {
4193 const EventData *event_data = event_ptr->GetData();
4194 if (event_data && event_data->GetFlavor() == ProcessEventData::GetFlavorString())
4195 return static_cast <const ProcessEventData *> (event_ptr->GetData());
4196 }
4197 return NULL;
4198}
4199
4200ProcessSP
4201Process::ProcessEventData::GetProcessFromEvent (const Event *event_ptr)
4202{
4203 ProcessSP process_sp;
4204 const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
4205 if (data)
4206 process_sp = data->GetProcessSP();
4207 return process_sp;
4208}
4209
4210StateType
4211Process::ProcessEventData::GetStateFromEvent (const Event *event_ptr)
4212{
4213 const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
4214 if (data == NULL)
4215 return eStateInvalid;
4216 else
4217 return data->GetState();
4218}
4219
4220bool
4221Process::ProcessEventData::GetRestartedFromEvent (const Event *event_ptr)
4222{
4223 const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
4224 if (data == NULL)
4225 return false;
4226 else
4227 return data->GetRestarted();
4228}
4229
4230void
4231Process::ProcessEventData::SetRestartedInEvent (Event *event_ptr, bool new_value)
4232{
4233 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4234 if (data != NULL)
4235 data->SetRestarted(new_value);
4236}
4237
Jim Ingham0161b492013-02-09 01:29:05 +00004238size_t
4239Process::ProcessEventData::GetNumRestartedReasons(const Event *event_ptr)
4240{
4241 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4242 if (data != NULL)
4243 return data->GetNumRestartedReasons();
4244 else
4245 return 0;
4246}
4247
4248const char *
4249Process::ProcessEventData::GetRestartedReasonAtIndex(const Event *event_ptr, size_t idx)
4250{
4251 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4252 if (data != NULL)
4253 return data->GetRestartedReasonAtIndex(idx);
4254 else
4255 return NULL;
4256}
4257
4258void
4259Process::ProcessEventData::AddRestartedReason (Event *event_ptr, const char *reason)
4260{
4261 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4262 if (data != NULL)
4263 data->AddRestartedReason(reason);
4264}
4265
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004266bool
Jim Ingham0d8bcc72010-11-17 02:32:00 +00004267Process::ProcessEventData::GetInterruptedFromEvent (const Event *event_ptr)
4268{
4269 const ProcessEventData *data = GetEventDataFromEvent (event_ptr);
4270 if (data == NULL)
4271 return false;
4272 else
4273 return data->GetInterrupted ();
4274}
4275
4276void
4277Process::ProcessEventData::SetInterruptedInEvent (Event *event_ptr, bool new_value)
4278{
4279 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4280 if (data != NULL)
4281 data->SetInterrupted(new_value);
4282}
4283
4284bool
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004285Process::ProcessEventData::SetUpdateStateOnRemoval (Event *event_ptr)
4286{
4287 ProcessEventData *data = const_cast<ProcessEventData *>(GetEventDataFromEvent (event_ptr));
4288 if (data)
4289 {
4290 data->SetUpdateStateOnRemoval();
4291 return true;
4292 }
4293 return false;
4294}
4295
Greg Claytond9e416c2012-02-18 05:35:26 +00004296lldb::TargetSP
4297Process::CalculateTarget ()
4298{
4299 return m_target.shared_from_this();
4300}
4301
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004302void
Greg Clayton0603aa92010-10-04 01:05:56 +00004303Process::CalculateExecutionContext (ExecutionContext &exe_ctx)
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004304{
Greg Claytonc14ee322011-09-22 04:58:26 +00004305 exe_ctx.SetTargetPtr (&m_target);
4306 exe_ctx.SetProcessPtr (this);
4307 exe_ctx.SetThreadPtr(NULL);
4308 exe_ctx.SetFramePtr (NULL);
Chris Lattner30fdc8d2010-06-08 16:52:24 +00004309}
4310
Greg Claytone996fd32011-03-08 22:40:15 +00004311//uint32_t
4312//Process::ListProcessesMatchingName (const char *name, StringList &matches, std::vector<lldb::pid_t> &pids)
4313//{
4314// return 0;
4315//}
4316//
4317//ArchSpec
4318//Process::GetArchSpecForExistingProcess (lldb::pid_t pid)
4319//{
4320// return Host::GetArchSpecForExistingProcess (pid);
4321//}
4322//
4323//ArchSpec
4324//Process::GetArchSpecForExistingProcess (const char *process_name)
4325//{
4326// return Host::GetArchSpecForExistingProcess (process_name);
4327//}
4328//
Caroline Ticeef5c6d02010-11-16 05:07:41 +00004329void
4330Process::AppendSTDOUT (const char * s, size_t len)
4331{
Greg Clayton3af9ea52010-11-18 05:57:03 +00004332 Mutex::Locker locker (m_stdio_communication_mutex);
Caroline Ticeef5c6d02010-11-16 05:07:41 +00004333 m_stdout_data.append (s, len);
Greg Clayton35a4cc52012-10-29 20:52:08 +00004334 BroadcastEventIfUnique (eBroadcastBitSTDOUT, new ProcessEventData (shared_from_this(), GetState()));
Caroline Ticeef5c6d02010-11-16 05:07:41 +00004335}
4336
4337void
Greg Clayton93e86192011-11-13 04:45:22 +00004338Process::AppendSTDERR (const char * s, size_t len)
4339{
4340 Mutex::Locker locker (m_stdio_communication_mutex);
4341 m_stderr_data.append (s, len);
Greg Clayton35a4cc52012-10-29 20:52:08 +00004342 BroadcastEventIfUnique (eBroadcastBitSTDERR, new ProcessEventData (shared_from_this(), GetState()));
Greg Clayton93e86192011-11-13 04:45:22 +00004343}
4344
Han Ming Ongab3b8b22012-11-17 00:21:04 +00004345void
Han Ming Ong91ed6b82013-06-24 18:15:05 +00004346Process::BroadcastAsyncProfileData(const std::string &one_profile_data)
Han Ming Ongab3b8b22012-11-17 00:21:04 +00004347{
4348 Mutex::Locker locker (m_profile_data_comm_mutex);
Han Ming Ong91ed6b82013-06-24 18:15:05 +00004349 m_profile_data.push_back(one_profile_data);
Han Ming Ongab3b8b22012-11-17 00:21:04 +00004350 BroadcastEventIfUnique (eBroadcastBitProfileData, new ProcessEventData (shared_from_this(), GetState()));
4351}
4352
4353size_t
4354Process::GetAsyncProfileData (char *buf, size_t buf_size, Error &error)
4355{
4356 Mutex::Locker locker(m_profile_data_comm_mutex);
Han Ming Ong929a94f2012-11-29 22:14:45 +00004357 if (m_profile_data.empty())
4358 return 0;
Han Ming Ong91ed6b82013-06-24 18:15:05 +00004359
4360 std::string &one_profile_data = m_profile_data.front();
4361 size_t bytes_available = one_profile_data.size();
Han Ming Ongab3b8b22012-11-17 00:21:04 +00004362 if (bytes_available > 0)
4363 {
Greg Clayton5160ce52013-03-27 23:08:40 +00004364 Log *log (lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Han Ming Ongab3b8b22012-11-17 00:21:04 +00004365 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004366 log->Printf ("Process::GetProfileData (buf = %p, size = %" PRIu64 ")",
4367 static_cast<void*>(buf),
4368 static_cast<uint64_t>(buf_size));
Han Ming Ongab3b8b22012-11-17 00:21:04 +00004369 if (bytes_available > buf_size)
4370 {
Han Ming Ong91ed6b82013-06-24 18:15:05 +00004371 memcpy(buf, one_profile_data.c_str(), buf_size);
4372 one_profile_data.erase(0, buf_size);
Han Ming Ongab3b8b22012-11-17 00:21:04 +00004373 bytes_available = buf_size;
4374 }
4375 else
4376 {
Han Ming Ong91ed6b82013-06-24 18:15:05 +00004377 memcpy(buf, one_profile_data.c_str(), bytes_available);
Han Ming Ong929a94f2012-11-29 22:14:45 +00004378 m_profile_data.erase(m_profile_data.begin());
Han Ming Ongab3b8b22012-11-17 00:21:04 +00004379 }
4380 }
4381 return bytes_available;
4382}
4383
4384
Greg Clayton93e86192011-11-13 04:45:22 +00004385//------------------------------------------------------------------
4386// Process STDIO
4387//------------------------------------------------------------------
4388
4389size_t
4390Process::GetSTDOUT (char *buf, size_t buf_size, Error &error)
4391{
4392 Mutex::Locker locker(m_stdio_communication_mutex);
4393 size_t bytes_available = m_stdout_data.size();
4394 if (bytes_available > 0)
4395 {
Greg Clayton5160ce52013-03-27 23:08:40 +00004396 Log *log (lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Greg Clayton93e86192011-11-13 04:45:22 +00004397 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004398 log->Printf ("Process::GetSTDOUT (buf = %p, size = %" PRIu64 ")",
4399 static_cast<void*>(buf),
4400 static_cast<uint64_t>(buf_size));
Greg Clayton93e86192011-11-13 04:45:22 +00004401 if (bytes_available > buf_size)
4402 {
4403 memcpy(buf, m_stdout_data.c_str(), buf_size);
4404 m_stdout_data.erase(0, buf_size);
4405 bytes_available = buf_size;
4406 }
4407 else
4408 {
4409 memcpy(buf, m_stdout_data.c_str(), bytes_available);
4410 m_stdout_data.clear();
4411 }
4412 }
4413 return bytes_available;
4414}
4415
4416
4417size_t
4418Process::GetSTDERR (char *buf, size_t buf_size, Error &error)
4419{
4420 Mutex::Locker locker(m_stdio_communication_mutex);
4421 size_t bytes_available = m_stderr_data.size();
4422 if (bytes_available > 0)
4423 {
Greg Clayton5160ce52013-03-27 23:08:40 +00004424 Log *log (lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_PROCESS));
Greg Clayton93e86192011-11-13 04:45:22 +00004425 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004426 log->Printf ("Process::GetSTDERR (buf = %p, size = %" PRIu64 ")",
4427 static_cast<void*>(buf),
4428 static_cast<uint64_t>(buf_size));
Greg Clayton93e86192011-11-13 04:45:22 +00004429 if (bytes_available > buf_size)
4430 {
4431 memcpy(buf, m_stderr_data.c_str(), buf_size);
4432 m_stderr_data.erase(0, buf_size);
4433 bytes_available = buf_size;
4434 }
4435 else
4436 {
4437 memcpy(buf, m_stderr_data.c_str(), bytes_available);
4438 m_stderr_data.clear();
4439 }
4440 }
4441 return bytes_available;
4442}
4443
4444void
Caroline Ticeef5c6d02010-11-16 05:07:41 +00004445Process::STDIOReadThreadBytesReceived (void *baton, const void *src, size_t src_len)
4446{
4447 Process *process = (Process *) baton;
4448 process->AppendSTDOUT (static_cast<const char *>(src), src_len);
4449}
4450
Greg Clayton44d93782014-01-27 23:43:24 +00004451class IOHandlerProcessSTDIO :
4452 public IOHandler
4453{
4454public:
4455 IOHandlerProcessSTDIO (Process *process,
4456 int write_fd) :
4457 IOHandler(process->GetTarget().GetDebugger()),
4458 m_process (process),
4459 m_read_file (),
4460 m_write_file (write_fd, false),
Greg Clayton100eb932014-07-02 21:10:39 +00004461 m_pipe ()
Greg Clayton44d93782014-01-27 23:43:24 +00004462 {
4463 m_read_file.SetDescriptor(GetInputFD(), false);
4464 }
4465
4466 virtual
4467 ~IOHandlerProcessSTDIO ()
4468 {
4469
4470 }
4471
4472 bool
4473 OpenPipes ()
4474 {
Greg Clayton100eb932014-07-02 21:10:39 +00004475 if (m_pipe.IsValid())
Greg Clayton44d93782014-01-27 23:43:24 +00004476 return true;
Greg Clayton100eb932014-07-02 21:10:39 +00004477 return m_pipe.Open();
Greg Clayton44d93782014-01-27 23:43:24 +00004478 }
4479
4480 void
4481 ClosePipes()
4482 {
Greg Clayton100eb932014-07-02 21:10:39 +00004483 m_pipe.Close();
Greg Clayton44d93782014-01-27 23:43:24 +00004484 }
4485
4486 // Each IOHandler gets to run until it is done. It should read data
4487 // from the "in" and place output into "out" and "err and return
4488 // when done.
4489 virtual void
4490 Run ()
4491 {
4492 if (m_read_file.IsValid() && m_write_file.IsValid())
4493 {
4494 SetIsDone(false);
4495 if (OpenPipes())
4496 {
4497 const int read_fd = m_read_file.GetDescriptor();
Greg Clayton100eb932014-07-02 21:10:39 +00004498 const int pipe_read_fd = m_pipe.GetReadFileDescriptor();
Greg Clayton44d93782014-01-27 23:43:24 +00004499 TerminalState terminal_state;
4500 terminal_state.Save (read_fd, false);
4501 Terminal terminal(read_fd);
4502 terminal.SetCanonical(false);
4503 terminal.SetEcho(false);
Deepak Panickal914b8d92014-01-31 18:48:46 +00004504// FD_ZERO, FD_SET are not supported on windows
Hafiz Abid Qadeer6eff1012014-03-12 10:45:23 +00004505#ifndef _WIN32
Greg Clayton44d93782014-01-27 23:43:24 +00004506 while (!GetIsDone())
4507 {
4508 fd_set read_fdset;
4509 FD_ZERO (&read_fdset);
4510 FD_SET (read_fd, &read_fdset);
4511 FD_SET (pipe_read_fd, &read_fdset);
4512 const int nfds = std::max<int>(read_fd, pipe_read_fd) + 1;
4513 int num_set_fds = select (nfds, &read_fdset, NULL, NULL, NULL);
4514 if (num_set_fds < 0)
4515 {
4516 const int select_errno = errno;
4517
4518 if (select_errno != EINTR)
4519 SetIsDone(true);
4520 }
4521 else if (num_set_fds > 0)
4522 {
4523 char ch = 0;
4524 size_t n;
4525 if (FD_ISSET (read_fd, &read_fdset))
4526 {
4527 n = 1;
4528 if (m_read_file.Read(&ch, n).Success() && n == 1)
4529 {
4530 if (m_write_file.Write(&ch, n).Fail() || n != 1)
4531 SetIsDone(true);
4532 }
4533 else
4534 SetIsDone(true);
4535 }
4536 if (FD_ISSET (pipe_read_fd, &read_fdset))
4537 {
4538 // Consume the interrupt byte
Greg Clayton100eb932014-07-02 21:10:39 +00004539 if (m_pipe.Read (&ch, 1) == 1)
Greg Clayton19e11352014-02-26 22:47:33 +00004540 {
Greg Clayton100eb932014-07-02 21:10:39 +00004541 switch (ch)
4542 {
4543 case 'q':
4544 SetIsDone(true);
4545 break;
4546 case 'i':
4547 if (StateIsRunningState(m_process->GetState()))
4548 m_process->Halt();
4549 break;
4550 }
Greg Clayton19e11352014-02-26 22:47:33 +00004551 }
Greg Clayton44d93782014-01-27 23:43:24 +00004552 }
4553 }
4554 }
Deepak Panickal914b8d92014-01-31 18:48:46 +00004555#endif
Greg Clayton44d93782014-01-27 23:43:24 +00004556 terminal_state.Restore();
4557
4558 }
4559 else
4560 SetIsDone(true);
4561 }
4562 else
4563 SetIsDone(true);
4564 }
4565
4566 // Hide any characters that have been displayed so far so async
4567 // output can be displayed. Refresh() will be called after the
4568 // output has been displayed.
4569 virtual void
4570 Hide ()
4571 {
4572
4573 }
4574 // Called when the async output has been received in order to update
4575 // the input reader (refresh the prompt and redisplay any current
4576 // line(s) that are being edited
4577 virtual void
4578 Refresh ()
4579 {
4580
4581 }
Greg Claytone68f5d62014-02-24 22:50:57 +00004582
Greg Clayton44d93782014-01-27 23:43:24 +00004583 virtual void
Greg Claytone68f5d62014-02-24 22:50:57 +00004584 Cancel ()
Greg Clayton44d93782014-01-27 23:43:24 +00004585 {
Greg Clayton19e11352014-02-26 22:47:33 +00004586 char ch = 'q'; // Send 'q' for quit
Greg Clayton100eb932014-07-02 21:10:39 +00004587 m_pipe.Write (&ch, 1);
Greg Clayton44d93782014-01-27 23:43:24 +00004588 }
Greg Claytone68f5d62014-02-24 22:50:57 +00004589
Greg Claytonf0066ad2014-05-02 00:45:31 +00004590 virtual bool
Greg Claytone68f5d62014-02-24 22:50:57 +00004591 Interrupt ()
4592 {
Greg Clayton19e11352014-02-26 22:47:33 +00004593 // Do only things that are safe to do in an interrupt context (like in
4594 // a SIGINT handler), like write 1 byte to a file descriptor. This will
4595 // interrupt the IOHandlerProcessSTDIO::Run() and we can look at the byte
4596 // that was written to the pipe and then call m_process->Halt() from a
4597 // much safer location in code.
Greg Clayton0fdd3ae2014-07-16 21:05:41 +00004598 if (m_active)
4599 {
4600 char ch = 'i'; // Send 'i' for interrupt
4601 return m_pipe.Write (&ch, 1) == 1;
4602 }
4603 else
4604 {
4605 // This IOHandler might be pushed on the stack, but not being run currently
4606 // so do the right thing if we aren't actively watching for STDIN by sending
4607 // the interrupt to the process. Otherwise the write to the pipe above would
4608 // do nothing. This can happen when the command interpreter is running and
4609 // gets a "expression ...". It will be on the IOHandler thread and sending
4610 // the input is complete to the delegate which will cause the expression to
4611 // run, which will push the process IO handler, but not run it.
4612
4613 if (StateIsRunningState(m_process->GetState()))
4614 {
4615 m_process->SendAsyncInterrupt();
4616 return true;
4617 }
4618 }
4619 return false;
Greg Claytone68f5d62014-02-24 22:50:57 +00004620 }
Greg Clayton44d93782014-01-27 23:43:24 +00004621
4622 virtual void
4623 GotEOF()
4624 {
4625
4626 }
4627
4628protected:
4629 Process *m_process;
4630 File m_read_file; // Read from this file (usually actual STDIN for LLDB
4631 File m_write_file; // Write to this file (usually the master pty for getting io to debuggee)
Greg Clayton100eb932014-07-02 21:10:39 +00004632 Pipe m_pipe;
Greg Clayton44d93782014-01-27 23:43:24 +00004633};
4634
Caroline Ticeef5c6d02010-11-16 05:07:41 +00004635void
Greg Clayton44d93782014-01-27 23:43:24 +00004636Process::SetSTDIOFileDescriptor (int fd)
Caroline Ticeef5c6d02010-11-16 05:07:41 +00004637{
4638 // First set up the Read Thread for reading/handling process I/O
4639
Greg Clayton44d93782014-01-27 23:43:24 +00004640 std::unique_ptr<ConnectionFileDescriptor> conn_ap (new ConnectionFileDescriptor (fd, true));
Caroline Ticeef5c6d02010-11-16 05:07:41 +00004641
4642 if (conn_ap.get())
4643 {
4644 m_stdio_communication.SetConnection (conn_ap.release());
4645 if (m_stdio_communication.IsConnected())
4646 {
4647 m_stdio_communication.SetReadThreadBytesReceivedCallback (STDIOReadThreadBytesReceived, this);
4648 m_stdio_communication.StartReadThread();
4649
4650 // Now read thread is set up, set up input reader.
4651
4652 if (!m_process_input_reader.get())
Greg Clayton44d93782014-01-27 23:43:24 +00004653 m_process_input_reader.reset (new IOHandlerProcessSTDIO (this, fd));
Caroline Ticeef5c6d02010-11-16 05:07:41 +00004654 }
4655 }
4656}
4657
Greg Claytonb4874f12014-02-28 18:22:24 +00004658bool
Greg Clayton6fea17e2014-03-03 19:15:20 +00004659Process::ProcessIOHandlerIsActive ()
4660{
4661 IOHandlerSP io_handler_sp (m_process_input_reader);
4662 if (io_handler_sp)
4663 return m_target.GetDebugger().IsTopIOHandler (io_handler_sp);
4664 return false;
4665}
4666bool
Greg Clayton44d93782014-01-27 23:43:24 +00004667Process::PushProcessIOHandler ()
Caroline Ticeef5c6d02010-11-16 05:07:41 +00004668{
Greg Clayton44d93782014-01-27 23:43:24 +00004669 IOHandlerSP io_handler_sp (m_process_input_reader);
4670 if (io_handler_sp)
4671 {
4672 io_handler_sp->SetIsDone(false);
4673 m_target.GetDebugger().PushIOHandler (io_handler_sp);
Greg Claytonb4874f12014-02-28 18:22:24 +00004674 return true;
Greg Clayton44d93782014-01-27 23:43:24 +00004675 }
Greg Claytonb4874f12014-02-28 18:22:24 +00004676 return false;
Caroline Ticeef5c6d02010-11-16 05:07:41 +00004677}
4678
Greg Claytonb4874f12014-02-28 18:22:24 +00004679bool
Greg Clayton44d93782014-01-27 23:43:24 +00004680Process::PopProcessIOHandler ()
Caroline Ticeef5c6d02010-11-16 05:07:41 +00004681{
Greg Clayton44d93782014-01-27 23:43:24 +00004682 IOHandlerSP io_handler_sp (m_process_input_reader);
4683 if (io_handler_sp)
Greg Claytonb4874f12014-02-28 18:22:24 +00004684 return m_target.GetDebugger().PopIOHandler (io_handler_sp);
4685 return false;
Caroline Ticeef5c6d02010-11-16 05:07:41 +00004686}
4687
Greg Claytonbfe5f3b2011-02-18 01:44:25 +00004688// The process needs to know about installed plug-ins
Greg Clayton99d0faf2010-11-18 23:32:35 +00004689void
Caroline Tice20bd37f2011-03-10 22:14:10 +00004690Process::SettingsInitialize ()
Caroline Tice3df9a8d2010-09-04 00:03:46 +00004691{
Greg Clayton6920b522012-08-22 18:39:03 +00004692 Thread::SettingsInitialize ();
Greg Clayton99d0faf2010-11-18 23:32:35 +00004693}
Caroline Tice3df9a8d2010-09-04 00:03:46 +00004694
Greg Clayton99d0faf2010-11-18 23:32:35 +00004695void
Caroline Tice20bd37f2011-03-10 22:14:10 +00004696Process::SettingsTerminate ()
Greg Claytonbfe5f3b2011-02-18 01:44:25 +00004697{
Greg Clayton6920b522012-08-22 18:39:03 +00004698 Thread::SettingsTerminate ();
Greg Clayton99d0faf2010-11-18 23:32:35 +00004699}
Caroline Tice3df9a8d2010-09-04 00:03:46 +00004700
Jim Ingham1624a2d2014-05-05 02:26:40 +00004701ExpressionResults
Jim Inghamf48169b2010-11-30 02:22:11 +00004702Process::RunThreadPlan (ExecutionContext &exe_ctx,
Jim Ingham372787f2012-04-07 00:00:41 +00004703 lldb::ThreadPlanSP &thread_plan_sp,
Jim Ingham6fbc48b2013-11-07 00:11:47 +00004704 const EvaluateExpressionOptions &options,
Jim Inghamf48169b2010-11-30 02:22:11 +00004705 Stream &errors)
4706{
Jim Ingham8646d3c2014-05-05 02:47:44 +00004707 ExpressionResults return_value = eExpressionSetupError;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004708
Jim Ingham77787032011-01-20 02:03:18 +00004709 if (thread_plan_sp.get() == NULL)
4710 {
4711 errors.Printf("RunThreadPlan called with empty thread plan.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00004712 return eExpressionSetupError;
Jim Ingham77787032011-01-20 02:03:18 +00004713 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004714
Jim Ingham7d7931d2013-03-28 00:05:34 +00004715 if (!thread_plan_sp->ValidatePlan(NULL))
4716 {
4717 errors.Printf ("RunThreadPlan called with an invalid thread plan.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00004718 return eExpressionSetupError;
Jim Ingham7d7931d2013-03-28 00:05:34 +00004719 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004720
Greg Claytonc14ee322011-09-22 04:58:26 +00004721 if (exe_ctx.GetProcessPtr() != this)
4722 {
4723 errors.Printf("RunThreadPlan called on wrong process.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00004724 return eExpressionSetupError;
Greg Claytonc14ee322011-09-22 04:58:26 +00004725 }
4726
4727 Thread *thread = exe_ctx.GetThreadPtr();
4728 if (thread == NULL)
4729 {
4730 errors.Printf("RunThreadPlan called with invalid thread.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00004731 return eExpressionSetupError;
Greg Claytonc14ee322011-09-22 04:58:26 +00004732 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004733
Jim Ingham17e5c4e2011-05-17 22:24:54 +00004734 // We rely on the thread plan we are running returning "PlanCompleted" if when it successfully completes.
4735 // For that to be true the plan can't be private - since private plans suppress themselves in the
4736 // GetCompletedPlan call.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004737
Jim Ingham17e5c4e2011-05-17 22:24:54 +00004738 bool orig_plan_private = thread_plan_sp->GetPrivate();
4739 thread_plan_sp->SetPrivate(false);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004740
Jim Ingham444586b2011-01-24 06:34:17 +00004741 if (m_private_state.GetValue() != eStateStopped)
4742 {
4743 errors.Printf ("RunThreadPlan called while the private state was not stopped.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00004744 return eExpressionSetupError;
Jim Ingham444586b2011-01-24 06:34:17 +00004745 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004746
Jim Ingham66243842011-08-13 00:56:10 +00004747 // Save the thread & frame from the exe_ctx for restoration after we run
Greg Claytonc14ee322011-09-22 04:58:26 +00004748 const uint32_t thread_idx_id = thread->GetIndexID();
Jason Molendab57e4a12013-11-04 09:33:30 +00004749 StackFrameSP selected_frame_sp = thread->GetSelectedFrame();
Jim Ingham11b0e052013-02-19 23:22:45 +00004750 if (!selected_frame_sp)
4751 {
4752 thread->SetSelectedFrame(0);
4753 selected_frame_sp = thread->GetSelectedFrame();
4754 if (!selected_frame_sp)
4755 {
4756 errors.Printf("RunThreadPlan called without a selected frame on thread %d", thread_idx_id);
Jim Ingham8646d3c2014-05-05 02:47:44 +00004757 return eExpressionSetupError;
Jim Ingham11b0e052013-02-19 23:22:45 +00004758 }
4759 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004760
Jim Ingham11b0e052013-02-19 23:22:45 +00004761 StackID ctx_frame_id = selected_frame_sp->GetStackID();
Jim Inghamf48169b2010-11-30 02:22:11 +00004762
4763 // N.B. Running the target may unset the currently selected thread and frame. We don't want to do that either,
4764 // so we should arrange to reset them as well.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004765
Greg Claytonc14ee322011-09-22 04:58:26 +00004766 lldb::ThreadSP selected_thread_sp = GetThreadList().GetSelectedThread();
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004767
Jim Ingham66243842011-08-13 00:56:10 +00004768 uint32_t selected_tid;
4769 StackID selected_stack_id;
Greg Clayton762f7132011-09-18 18:59:15 +00004770 if (selected_thread_sp)
Jim Inghamf48169b2010-11-30 02:22:11 +00004771 {
4772 selected_tid = selected_thread_sp->GetIndexID();
Jim Ingham66243842011-08-13 00:56:10 +00004773 selected_stack_id = selected_thread_sp->GetSelectedFrame()->GetStackID();
Jim Inghamf48169b2010-11-30 02:22:11 +00004774 }
4775 else
4776 {
4777 selected_tid = LLDB_INVALID_THREAD_ID;
4778 }
4779
Jim Ingham372787f2012-04-07 00:00:41 +00004780 lldb::thread_t backup_private_state_thread = LLDB_INVALID_HOST_THREAD;
Jim Ingham076b3042012-04-10 01:21:57 +00004781 lldb::StateType old_state;
4782 lldb::ThreadPlanSP stopper_base_plan_sp;
Jim Ingham372787f2012-04-07 00:00:41 +00004783
Greg Clayton5160ce52013-03-27 23:08:40 +00004784 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_STEP | LIBLLDB_LOG_PROCESS));
Jim Ingham372787f2012-04-07 00:00:41 +00004785 if (Host::GetCurrentThread() == m_private_state_thread)
4786 {
Jim Ingham076b3042012-04-10 01:21:57 +00004787 // Yikes, we are running on the private state thread! So we can't wait for public events on this thread, since
4788 // we are the thread that is generating public events.
Jim Ingham372787f2012-04-07 00:00:41 +00004789 // The simplest thing to do is to spin up a temporary thread to handle private state thread events while
Jim Ingham076b3042012-04-10 01:21:57 +00004790 // we are fielding public events here.
4791 if (log)
Jason Molendad251c9d2012-11-17 01:41:04 +00004792 log->Printf ("Running thread plan on private state thread, spinning up another state thread to handle the events.");
Jim Ingham076b3042012-04-10 01:21:57 +00004793
Jim Ingham372787f2012-04-07 00:00:41 +00004794 backup_private_state_thread = m_private_state_thread;
Jim Ingham076b3042012-04-10 01:21:57 +00004795
4796 // One other bit of business: we want to run just this thread plan and anything it pushes, and then stop,
4797 // returning control here.
4798 // But in the normal course of things, the plan above us on the stack would be given a shot at the stop
4799 // event before deciding to stop, and we don't want that. So we insert a "stopper" base plan on the stack
4800 // before the plan we want to run. Since base plans always stop and return control to the user, that will
4801 // do just what we want.
4802 stopper_base_plan_sp.reset(new ThreadPlanBase (*thread));
4803 thread->QueueThreadPlan (stopper_base_plan_sp, false);
4804 // Have to make sure our public state is stopped, since otherwise the reporting logic below doesn't work correctly.
4805 old_state = m_public_state.GetValue();
4806 m_public_state.SetValueNoLock(eStateStopped);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004807
Jim Ingham076b3042012-04-10 01:21:57 +00004808 // Now spin up the private state thread:
Jim Ingham372787f2012-04-07 00:00:41 +00004809 StartPrivateStateThread(true);
4810 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004811
Jim Ingham372787f2012-04-07 00:00:41 +00004812 thread->QueueThreadPlan(thread_plan_sp, false); // This used to pass "true" does that make sense?
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004813
Jim Ingham6fbc48b2013-11-07 00:11:47 +00004814 if (options.GetDebug())
4815 {
4816 // In this case, we aren't actually going to run, we just want to stop right away.
4817 // Flush this thread so we will refetch the stacks and show the correct backtrace.
4818 // FIXME: To make this prettier we should invent some stop reason for this, but that
4819 // is only cosmetic, and this functionality is only of use to lldb developers who can
4820 // live with not pretty...
4821 thread->Flush();
Jim Ingham8646d3c2014-05-05 02:47:44 +00004822 return eExpressionStoppedForDebug;
Jim Ingham6fbc48b2013-11-07 00:11:47 +00004823 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004824
Jim Ingham1e7a9ee2011-01-23 21:14:08 +00004825 Listener listener("lldb.process.listener.run-thread-plan");
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004826
Sean Callanana46ec452012-07-11 21:31:24 +00004827 lldb::EventSP event_to_broadcast_sp;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004828
Jim Ingham77787032011-01-20 02:03:18 +00004829 {
Sean Callanana46ec452012-07-11 21:31:24 +00004830 // This process event hijacker Hijacks the Public events and its destructor makes sure that the process events get
4831 // restored on exit to the function.
4832 //
4833 // If the event needs to propagate beyond the hijacker (e.g., the process exits during execution), then the event
4834 // is put into event_to_broadcast_sp for rebroadcasting.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004835
Sean Callanana46ec452012-07-11 21:31:24 +00004836 ProcessEventHijacker run_thread_plan_hijacker (*this, &listener);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004837
Jim Inghamf48169b2010-11-30 02:22:11 +00004838 if (log)
Jim Ingham0f16e732011-02-08 05:20:59 +00004839 {
4840 StreamString s;
Sean Callanana46ec452012-07-11 21:31:24 +00004841 thread_plan_sp->GetDescription(&s, lldb::eDescriptionLevelVerbose);
Daniel Malead01b2952012-11-29 21:49:15 +00004842 log->Printf ("Process::RunThreadPlan(): Resuming thread %u - 0x%4.4" PRIx64 " to run thread plan \"%s\".",
Sean Callanana46ec452012-07-11 21:31:24 +00004843 thread->GetIndexID(),
4844 thread->GetID(),
4845 s.GetData());
4846 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004847
Sean Callanana46ec452012-07-11 21:31:24 +00004848 bool got_event;
4849 lldb::EventSP event_sp;
4850 lldb::StateType stop_state = lldb::eStateInvalid;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004851
Sean Callanana46ec452012-07-11 21:31:24 +00004852 TimeValue* timeout_ptr = NULL;
4853 TimeValue real_timeout;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004854
Jim Ingham0161b492013-02-09 01:29:05 +00004855 bool before_first_timeout = true; // This is set to false the first time that we have to halt the target.
Sean Callanana46ec452012-07-11 21:31:24 +00004856 bool do_resume = true;
Jim Ingham184e9812013-01-15 02:47:48 +00004857 bool handle_running_event = true;
Jim Ingham35e1bda2012-10-16 21:41:58 +00004858 const uint64_t default_one_thread_timeout_usec = 250000;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004859
Jim Ingham0161b492013-02-09 01:29:05 +00004860 // This is just for accounting:
4861 uint32_t num_resumes = 0;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004862
Jim Ingham6fbc48b2013-11-07 00:11:47 +00004863 uint32_t timeout_usec = options.GetTimeoutUsec();
Jim Inghamfd95f892014-04-22 01:41:52 +00004864 uint32_t one_thread_timeout_usec;
4865 uint32_t all_threads_timeout_usec = 0;
Jim Inghamfe1c3422014-04-16 02:24:48 +00004866
4867 // If we are going to run all threads the whole time, or if we are only going to run one thread,
4868 // then we don't need the first timeout. So we set the final timeout, and pretend we are after the
4869 // first timeout already.
4870
4871 if (!options.GetStopOthers() || !options.GetTryAllThreads())
Jim Ingham286fb1e2014-02-28 02:52:06 +00004872 {
4873 before_first_timeout = false;
Jim Inghamfd95f892014-04-22 01:41:52 +00004874 one_thread_timeout_usec = 0;
4875 all_threads_timeout_usec = timeout_usec;
Jim Ingham286fb1e2014-02-28 02:52:06 +00004876 }
Jim Inghamfe1c3422014-04-16 02:24:48 +00004877 else
Jim Ingham0161b492013-02-09 01:29:05 +00004878 {
Jim Inghamfd95f892014-04-22 01:41:52 +00004879 uint32_t option_one_thread_timeout = options.GetOneThreadTimeoutUsec();
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004880
Jim Ingham914f4e72014-03-28 21:58:28 +00004881 // If the overall wait is forever, then we only need to set the one thread timeout:
4882 if (timeout_usec == 0)
4883 {
Ed Maste801335c2014-03-31 19:28:14 +00004884 if (option_one_thread_timeout != 0)
Jim Inghamfd95f892014-04-22 01:41:52 +00004885 one_thread_timeout_usec = option_one_thread_timeout;
Jim Ingham914f4e72014-03-28 21:58:28 +00004886 else
Jim Inghamfd95f892014-04-22 01:41:52 +00004887 one_thread_timeout_usec = default_one_thread_timeout_usec;
Jim Ingham914f4e72014-03-28 21:58:28 +00004888 }
Jim Ingham0161b492013-02-09 01:29:05 +00004889 else
4890 {
Jim Ingham914f4e72014-03-28 21:58:28 +00004891 // Otherwise, if the one thread timeout is set, make sure it isn't longer than the overall timeout,
4892 // and use it, otherwise use half the total timeout, bounded by the default_one_thread_timeout_usec.
4893 uint64_t computed_one_thread_timeout;
4894 if (option_one_thread_timeout != 0)
4895 {
4896 if (timeout_usec < option_one_thread_timeout)
4897 {
4898 errors.Printf("RunThreadPlan called without one thread timeout greater than total timeout");
Jim Ingham8646d3c2014-05-05 02:47:44 +00004899 return eExpressionSetupError;
Jim Ingham914f4e72014-03-28 21:58:28 +00004900 }
4901 computed_one_thread_timeout = option_one_thread_timeout;
4902 }
4903 else
4904 {
4905 computed_one_thread_timeout = timeout_usec / 2;
4906 if (computed_one_thread_timeout > default_one_thread_timeout_usec)
4907 computed_one_thread_timeout = default_one_thread_timeout_usec;
4908 }
Jim Inghamfd95f892014-04-22 01:41:52 +00004909 one_thread_timeout_usec = computed_one_thread_timeout;
4910 all_threads_timeout_usec = timeout_usec - one_thread_timeout_usec;
4911
Jim Ingham0161b492013-02-09 01:29:05 +00004912 }
Jim Ingham0161b492013-02-09 01:29:05 +00004913 }
Jim Inghamfe1c3422014-04-16 02:24:48 +00004914
4915 if (log)
Jim Inghamfd95f892014-04-22 01:41:52 +00004916 log->Printf ("Stop others: %u, try all: %u, before_first: %u, one thread: %" PRIu32 " - all threads: %" PRIu32 ".\n",
Jim Inghamfe1c3422014-04-16 02:24:48 +00004917 options.GetStopOthers(),
4918 options.GetTryAllThreads(),
Jim Inghamfd95f892014-04-22 01:41:52 +00004919 before_first_timeout,
4920 one_thread_timeout_usec,
4921 all_threads_timeout_usec);
Jim Ingham0161b492013-02-09 01:29:05 +00004922
Jim Ingham1460e4b2014-01-10 23:46:59 +00004923 // This isn't going to work if there are unfetched events on the queue.
4924 // Are there cases where we might want to run the remaining events here, and then try to
4925 // call the function? That's probably being too tricky for our own good.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004926
Jim Ingham1460e4b2014-01-10 23:46:59 +00004927 Event *other_events = listener.PeekAtNextEvent();
4928 if (other_events != NULL)
4929 {
4930 errors.Printf("Calling RunThreadPlan with pending events on the queue.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00004931 return eExpressionSetupError;
Jim Ingham1460e4b2014-01-10 23:46:59 +00004932 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004933
Jim Ingham1460e4b2014-01-10 23:46:59 +00004934 // We also need to make sure that the next event is delivered. We might be calling a function as part of
4935 // a thread plan, in which case the last delivered event could be the running event, and we don't want
4936 // event coalescing to cause us to lose OUR running event...
4937 ForceNextEventDelivery();
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004938
Jim Ingham8559a352012-11-26 23:52:18 +00004939 // This while loop must exit out the bottom, there's cleanup that we need to do when we are done.
4940 // So don't call return anywhere within it.
Jim Ingham35878c42014-04-08 21:33:21 +00004941
4942#ifdef LLDB_RUN_THREAD_HALT_WITH_EVENT
4943 // It's pretty much impossible to write test cases for things like:
4944 // One thread timeout expires, I go to halt, but the process already stopped
4945 // on the function call stop breakpoint. Turning on this define will make us not
4946 // fetch the first event till after the halt. So if you run a quick function, it will have
4947 // completed, and the completion event will be waiting, when you interrupt for halt.
4948 // The expression evaluation should still succeed.
4949 bool miss_first_event = true;
4950#endif
Jim Inghamfd95f892014-04-22 01:41:52 +00004951 TimeValue one_thread_timeout;
4952 TimeValue final_timeout;
4953
Jim Ingham35878c42014-04-08 21:33:21 +00004954
Sean Callanana46ec452012-07-11 21:31:24 +00004955 while (1)
4956 {
4957 // We usually want to resume the process if we get to the top of the loop.
4958 // The only exception is if we get two running events with no intervening
4959 // stop, which can happen, we will just wait for then next stop event.
Jim Ingham0161b492013-02-09 01:29:05 +00004960 if (log)
4961 log->Printf ("Top of while loop: do_resume: %i handle_running_event: %i before_first_timeout: %i.",
4962 do_resume,
4963 handle_running_event,
4964 before_first_timeout);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004965
Jim Ingham184e9812013-01-15 02:47:48 +00004966 if (do_resume || handle_running_event)
Sean Callanana46ec452012-07-11 21:31:24 +00004967 {
4968 // Do the initial resume and wait for the running event before going further.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004969
Jim Ingham184e9812013-01-15 02:47:48 +00004970 if (do_resume)
Sean Callanana46ec452012-07-11 21:31:24 +00004971 {
Jim Ingham0161b492013-02-09 01:29:05 +00004972 num_resumes++;
Jim Ingham184e9812013-01-15 02:47:48 +00004973 Error resume_error = PrivateResume ();
4974 if (!resume_error.Success())
4975 {
Jim Ingham0161b492013-02-09 01:29:05 +00004976 errors.Printf("Error resuming inferior the %d time: \"%s\".\n",
4977 num_resumes,
4978 resume_error.AsCString());
Jim Ingham8646d3c2014-05-05 02:47:44 +00004979 return_value = eExpressionSetupError;
Jim Ingham184e9812013-01-15 02:47:48 +00004980 break;
4981 }
Sean Callanana46ec452012-07-11 21:31:24 +00004982 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004983
Jim Ingham0161b492013-02-09 01:29:05 +00004984 TimeValue resume_timeout = TimeValue::Now();
4985 resume_timeout.OffsetWithMicroSeconds(500000);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004986
Jim Ingham0161b492013-02-09 01:29:05 +00004987 got_event = listener.WaitForEvent(&resume_timeout, event_sp);
Sean Callanana46ec452012-07-11 21:31:24 +00004988 if (!got_event)
4989 {
4990 if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00004991 log->Printf ("Process::RunThreadPlan(): didn't get any event after resume %d, exiting.",
4992 num_resumes);
Sean Callanana46ec452012-07-11 21:31:24 +00004993
Jim Ingham0161b492013-02-09 01:29:05 +00004994 errors.Printf("Didn't get any event after resume %d, exiting.", num_resumes);
Jim Ingham8646d3c2014-05-05 02:47:44 +00004995 return_value = eExpressionSetupError;
Sean Callanana46ec452012-07-11 21:31:24 +00004996 break;
4997 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00004998
Sean Callanana46ec452012-07-11 21:31:24 +00004999 stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
Jim Ingham0161b492013-02-09 01:29:05 +00005000
Sean Callanana46ec452012-07-11 21:31:24 +00005001 if (stop_state != eStateRunning)
5002 {
Jim Ingham0161b492013-02-09 01:29:05 +00005003 bool restarted = false;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005004
Jim Ingham0161b492013-02-09 01:29:05 +00005005 if (stop_state == eStateStopped)
5006 {
5007 restarted = Process::ProcessEventData::GetRestartedFromEvent(event_sp.get());
5008 if (log)
5009 log->Printf("Process::RunThreadPlan(): didn't get running event after "
5010 "resume %d, got %s instead (restarted: %i, do_resume: %i, handle_running_event: %i).",
5011 num_resumes,
5012 StateAsCString(stop_state),
5013 restarted,
5014 do_resume,
5015 handle_running_event);
5016 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005017
Jim Ingham0161b492013-02-09 01:29:05 +00005018 if (restarted)
5019 {
5020 // This is probably an overabundance of caution, I don't think I should ever get a stopped & restarted
5021 // event here. But if I do, the best thing is to Halt and then get out of here.
5022 Halt();
5023 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005024
Jim Ingham35e1bda2012-10-16 21:41:58 +00005025 errors.Printf("Didn't get running event after initial resume, got %s instead.",
5026 StateAsCString(stop_state));
Jim Ingham8646d3c2014-05-05 02:47:44 +00005027 return_value = eExpressionSetupError;
Sean Callanana46ec452012-07-11 21:31:24 +00005028 break;
5029 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005030
Sean Callanana46ec452012-07-11 21:31:24 +00005031 if (log)
5032 log->PutCString ("Process::RunThreadPlan(): resuming succeeded.");
5033 // We need to call the function synchronously, so spin waiting for it to return.
5034 // If we get interrupted while executing, we're going to lose our context, and
5035 // won't be able to gather the result at this point.
5036 // We set the timeout AFTER the resume, since the resume takes some time and we
5037 // don't want to charge that to the timeout.
Sean Callanana46ec452012-07-11 21:31:24 +00005038 }
Jim Ingham0f16e732011-02-08 05:20:59 +00005039 else
5040 {
Sean Callanana46ec452012-07-11 21:31:24 +00005041 if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00005042 log->PutCString ("Process::RunThreadPlan(): waiting for next event.");
Jim Ingham0f16e732011-02-08 05:20:59 +00005043 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005044
Jim Ingham0161b492013-02-09 01:29:05 +00005045 if (before_first_timeout)
5046 {
Jim Ingham6fbc48b2013-11-07 00:11:47 +00005047 if (options.GetTryAllThreads())
Jim Inghamfd95f892014-04-22 01:41:52 +00005048 {
5049 one_thread_timeout = TimeValue::Now();
5050 one_thread_timeout.OffsetWithMicroSeconds(one_thread_timeout_usec);
Jim Ingham0161b492013-02-09 01:29:05 +00005051 timeout_ptr = &one_thread_timeout;
Jim Inghamfd95f892014-04-22 01:41:52 +00005052 }
Jim Ingham0161b492013-02-09 01:29:05 +00005053 else
5054 {
5055 if (timeout_usec == 0)
5056 timeout_ptr = NULL;
5057 else
Jim Inghamfd95f892014-04-22 01:41:52 +00005058 {
5059 final_timeout = TimeValue::Now();
5060 final_timeout.OffsetWithMicroSeconds (timeout_usec);
Jim Ingham0161b492013-02-09 01:29:05 +00005061 timeout_ptr = &final_timeout;
Jim Inghamfd95f892014-04-22 01:41:52 +00005062 }
Jim Ingham0161b492013-02-09 01:29:05 +00005063 }
5064 }
5065 else
5066 {
5067 if (timeout_usec == 0)
5068 timeout_ptr = NULL;
5069 else
Jim Inghamfd95f892014-04-22 01:41:52 +00005070 {
5071 final_timeout = TimeValue::Now();
5072 final_timeout.OffsetWithMicroSeconds (all_threads_timeout_usec);
Jim Ingham0161b492013-02-09 01:29:05 +00005073 timeout_ptr = &final_timeout;
Jim Inghamfd95f892014-04-22 01:41:52 +00005074 }
Jim Ingham0161b492013-02-09 01:29:05 +00005075 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005076
Jim Ingham0161b492013-02-09 01:29:05 +00005077 do_resume = true;
5078 handle_running_event = true;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005079
Sean Callanana46ec452012-07-11 21:31:24 +00005080 // Now wait for the process to stop again:
Sean Callanana46ec452012-07-11 21:31:24 +00005081 event_sp.reset();
Jim Ingham0f16e732011-02-08 05:20:59 +00005082
Jim Ingham0f16e732011-02-08 05:20:59 +00005083 if (log)
Jim Ingham20829ac2011-08-09 22:24:33 +00005084 {
Sean Callanana46ec452012-07-11 21:31:24 +00005085 if (timeout_ptr)
5086 {
Matt Kopec676a4872013-02-21 23:55:31 +00005087 log->Printf ("Process::RunThreadPlan(): about to wait - now is %" PRIu64 " - endpoint is %" PRIu64,
Jim Ingham0161b492013-02-09 01:29:05 +00005088 TimeValue::Now().GetAsMicroSecondsSinceJan1_1970(),
5089 timeout_ptr->GetAsMicroSecondsSinceJan1_1970());
Sean Callanana46ec452012-07-11 21:31:24 +00005090 }
Jim Ingham20829ac2011-08-09 22:24:33 +00005091 else
Sean Callanana46ec452012-07-11 21:31:24 +00005092 {
5093 log->Printf ("Process::RunThreadPlan(): about to wait forever.");
5094 }
5095 }
Jim Ingham35878c42014-04-08 21:33:21 +00005096
5097#ifdef LLDB_RUN_THREAD_HALT_WITH_EVENT
5098 // See comment above...
5099 if (miss_first_event)
5100 {
5101 usleep(1000);
5102 miss_first_event = false;
5103 got_event = false;
5104 }
5105 else
5106#endif
Sean Callanana46ec452012-07-11 21:31:24 +00005107 got_event = listener.WaitForEvent (timeout_ptr, event_sp);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005108
Sean Callanana46ec452012-07-11 21:31:24 +00005109 if (got_event)
5110 {
5111 if (event_sp.get())
5112 {
5113 bool keep_going = false;
Jim Inghamcfc09352012-07-27 23:57:19 +00005114 if (event_sp->GetType() == eBroadcastBitInterrupt)
Sean Callanana46ec452012-07-11 21:31:24 +00005115 {
Jim Inghamcfc09352012-07-27 23:57:19 +00005116 Halt();
Jim Ingham8646d3c2014-05-05 02:47:44 +00005117 return_value = eExpressionInterrupted;
Jim Inghamcfc09352012-07-27 23:57:19 +00005118 errors.Printf ("Execution halted by user interrupt.");
5119 if (log)
5120 log->Printf ("Process::RunThreadPlan(): Got interrupted by eBroadcastBitInterrupted, exiting.");
Jim Ingham0161b492013-02-09 01:29:05 +00005121 break;
Jim Inghamcfc09352012-07-27 23:57:19 +00005122 }
5123 else
5124 {
5125 stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
5126 if (log)
5127 log->Printf("Process::RunThreadPlan(): in while loop, got event: %s.", StateAsCString(stop_state));
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005128
Jim Inghamcfc09352012-07-27 23:57:19 +00005129 switch (stop_state)
Sean Callanana46ec452012-07-11 21:31:24 +00005130 {
Jim Inghamcfc09352012-07-27 23:57:19 +00005131 case lldb::eStateStopped:
Sean Callanana46ec452012-07-11 21:31:24 +00005132 {
Jim Ingham0161b492013-02-09 01:29:05 +00005133 // We stopped, figure out what we are going to do now.
Jim Inghamcfc09352012-07-27 23:57:19 +00005134 ThreadSP thread_sp = GetThreadList().FindThreadByIndexID (thread_idx_id);
5135 if (!thread_sp)
Sean Callanana46ec452012-07-11 21:31:24 +00005136 {
Jim Inghamcfc09352012-07-27 23:57:19 +00005137 // Ooh, our thread has vanished. Unlikely that this was successful execution...
Sean Callanana46ec452012-07-11 21:31:24 +00005138 if (log)
Jim Inghamcfc09352012-07-27 23:57:19 +00005139 log->Printf ("Process::RunThreadPlan(): execution completed but our thread (index-id=%u) has vanished.", thread_idx_id);
Jim Ingham8646d3c2014-05-05 02:47:44 +00005140 return_value = eExpressionInterrupted;
Sean Callanana46ec452012-07-11 21:31:24 +00005141 }
5142 else
5143 {
Jim Ingham0161b492013-02-09 01:29:05 +00005144 // If we were restarted, we just need to go back up to fetch another event.
5145 if (Process::ProcessEventData::GetRestartedFromEvent(event_sp.get()))
Jim Inghamcfc09352012-07-27 23:57:19 +00005146 {
5147 if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00005148 {
5149 log->Printf ("Process::RunThreadPlan(): Got a stop and restart, so we'll continue waiting.");
5150 }
5151 keep_going = true;
5152 do_resume = false;
5153 handle_running_event = true;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005154
Jim Inghamcfc09352012-07-27 23:57:19 +00005155 }
5156 else
5157 {
Jim Ingham0161b492013-02-09 01:29:05 +00005158 StopInfoSP stop_info_sp (thread_sp->GetStopInfo ());
5159 StopReason stop_reason = eStopReasonInvalid;
5160 if (stop_info_sp)
5161 stop_reason = stop_info_sp->GetStopReason();
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005162
Jim Ingham0161b492013-02-09 01:29:05 +00005163 // FIXME: We only check if the stop reason is plan complete, should we make sure that
5164 // it is OUR plan that is complete?
5165 if (stop_reason == eStopReasonPlanComplete)
Jim Ingham184e9812013-01-15 02:47:48 +00005166 {
5167 if (log)
Jim Ingham0161b492013-02-09 01:29:05 +00005168 log->PutCString ("Process::RunThreadPlan(): execution completed successfully.");
5169 // Now mark this plan as private so it doesn't get reported as the stop reason
5170 // after this point.
5171 if (thread_plan_sp)
5172 thread_plan_sp->SetPrivate (orig_plan_private);
Jim Ingham8646d3c2014-05-05 02:47:44 +00005173 return_value = eExpressionCompleted;
Jim Ingham184e9812013-01-15 02:47:48 +00005174 }
5175 else
5176 {
Jim Ingham0161b492013-02-09 01:29:05 +00005177 // Something restarted the target, so just wait for it to stop for real.
Jim Ingham184e9812013-01-15 02:47:48 +00005178 if (stop_reason == eStopReasonBreakpoint)
Jim Ingham0161b492013-02-09 01:29:05 +00005179 {
5180 if (log)
5181 log->Printf ("Process::RunThreadPlan() stopped for breakpoint: %s.", stop_info_sp->GetDescription());
Jim Ingham8646d3c2014-05-05 02:47:44 +00005182 return_value = eExpressionHitBreakpoint;
Jim Ingham6fbc48b2013-11-07 00:11:47 +00005183 if (!options.DoesIgnoreBreakpoints())
Sean Callanan4b388c92013-07-30 19:54:09 +00005184 {
5185 event_to_broadcast_sp = event_sp;
5186 }
Jim Ingham0161b492013-02-09 01:29:05 +00005187 }
Jim Ingham184e9812013-01-15 02:47:48 +00005188 else
Jim Ingham0161b492013-02-09 01:29:05 +00005189 {
5190 if (log)
5191 log->PutCString ("Process::RunThreadPlan(): thread plan didn't successfully complete.");
Jim Ingham6fbc48b2013-11-07 00:11:47 +00005192 if (!options.DoesUnwindOnError())
Sean Callanan4b388c92013-07-30 19:54:09 +00005193 event_to_broadcast_sp = event_sp;
Jim Ingham8646d3c2014-05-05 02:47:44 +00005194 return_value = eExpressionInterrupted;
Jim Ingham0161b492013-02-09 01:29:05 +00005195 }
Jim Ingham184e9812013-01-15 02:47:48 +00005196 }
Jim Inghamcfc09352012-07-27 23:57:19 +00005197 }
Sean Callanana46ec452012-07-11 21:31:24 +00005198 }
Jim Inghamcfc09352012-07-27 23:57:19 +00005199 }
5200 break;
Sean Callanana46ec452012-07-11 21:31:24 +00005201
Jim Inghamcfc09352012-07-27 23:57:19 +00005202 case lldb::eStateRunning:
Jim Ingham0161b492013-02-09 01:29:05 +00005203 // This shouldn't really happen, but sometimes we do get two running events without an
5204 // intervening stop, and in that case we should just go back to waiting for the stop.
Jim Inghamcfc09352012-07-27 23:57:19 +00005205 do_resume = false;
5206 keep_going = true;
Jim Ingham184e9812013-01-15 02:47:48 +00005207 handle_running_event = false;
Jim Inghamcfc09352012-07-27 23:57:19 +00005208 break;
Sean Callanana46ec452012-07-11 21:31:24 +00005209
Jim Inghamcfc09352012-07-27 23:57:19 +00005210 default:
5211 if (log)
5212 log->Printf("Process::RunThreadPlan(): execution stopped with unexpected state: %s.", StateAsCString(stop_state));
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005213
Jim Inghamcfc09352012-07-27 23:57:19 +00005214 if (stop_state == eStateExited)
5215 event_to_broadcast_sp = event_sp;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005216
Sean Callananbf154da2012-08-08 17:35:10 +00005217 errors.Printf ("Execution stopped with unexpected state.\n");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005218 return_value = eExpressionInterrupted;
Jim Inghamcfc09352012-07-27 23:57:19 +00005219 break;
5220 }
Sean Callanana46ec452012-07-11 21:31:24 +00005221 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005222
Sean Callanana46ec452012-07-11 21:31:24 +00005223 if (keep_going)
5224 continue;
5225 else
5226 break;
5227 }
5228 else
5229 {
5230 if (log)
5231 log->PutCString ("Process::RunThreadPlan(): got_event was true, but the event pointer was null. How odd...");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005232 return_value = eExpressionInterrupted;
Sean Callanana46ec452012-07-11 21:31:24 +00005233 break;
5234 }
5235 }
5236 else
5237 {
5238 // If we didn't get an event that means we've timed out...
5239 // We will interrupt the process here. Depending on what we were asked to do we will
5240 // either exit, or try with all threads running for the same timeout.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005241
Sean Callanana46ec452012-07-11 21:31:24 +00005242 if (log) {
Jim Ingham6fbc48b2013-11-07 00:11:47 +00005243 if (options.GetTryAllThreads())
Sean Callanana46ec452012-07-11 21:31:24 +00005244 {
Jim Ingham0161b492013-02-09 01:29:05 +00005245 if (before_first_timeout)
Jim Inghamfe1c3422014-04-16 02:24:48 +00005246 {
5247 if (timeout_usec != 0)
5248 {
Jim Inghamfe1c3422014-04-16 02:24:48 +00005249 log->Printf ("Process::RunThreadPlan(): Running function with one thread timeout timed out, "
Jim Inghamfd95f892014-04-22 01:41:52 +00005250 "running for %" PRIu32 " usec with all threads enabled.",
5251 all_threads_timeout_usec);
Jim Inghamfe1c3422014-04-16 02:24:48 +00005252 }
5253 else
5254 {
5255 log->Printf ("Process::RunThreadPlan(): Running function with one thread timeout timed out, "
Ed Mastee61c7b02014-04-29 17:48:06 +00005256 "running forever with all threads enabled.");
Jim Inghamfe1c3422014-04-16 02:24:48 +00005257 }
5258 }
Sean Callanana46ec452012-07-11 21:31:24 +00005259 else
5260 log->Printf ("Process::RunThreadPlan(): Restarting function with all threads enabled "
Jason Molenda6a8658a2013-10-27 02:32:23 +00005261 "and timeout: %u timed out, abandoning execution.",
Jim Ingham35e1bda2012-10-16 21:41:58 +00005262 timeout_usec);
Sean Callanana46ec452012-07-11 21:31:24 +00005263 }
5264 else
Jason Molenda6a8658a2013-10-27 02:32:23 +00005265 log->Printf ("Process::RunThreadPlan(): Running function with timeout: %u timed out, "
Jim Ingham35e1bda2012-10-16 21:41:58 +00005266 "abandoning execution.",
5267 timeout_usec);
Sean Callanana46ec452012-07-11 21:31:24 +00005268 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005269
Jim Ingham0161b492013-02-09 01:29:05 +00005270 // It is possible that between the time we issued the Halt, and we get around to calling Halt the target
5271 // could have stopped. That's fine, Halt will figure that out and send the appropriate Stopped event.
5272 // BUT it is also possible that we stopped & restarted (e.g. hit a signal with "stop" set to false.) In
5273 // that case, we'll get the stopped & restarted event, and we should go back to waiting for the Halt's
5274 // stopped event. That's what this while loop does.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005275
Jim Ingham0161b492013-02-09 01:29:05 +00005276 bool back_to_top = true;
5277 uint32_t try_halt_again = 0;
5278 bool do_halt = true;
5279 const uint32_t num_retries = 5;
5280 while (try_halt_again < num_retries)
Sean Callanana46ec452012-07-11 21:31:24 +00005281 {
Jim Ingham0161b492013-02-09 01:29:05 +00005282 Error halt_error;
5283 if (do_halt)
5284 {
5285 if (log)
5286 log->Printf ("Process::RunThreadPlan(): Running Halt.");
5287 halt_error = Halt();
5288 }
5289 if (halt_error.Success())
5290 {
5291 if (log)
5292 log->PutCString ("Process::RunThreadPlan(): Halt succeeded.");
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005293
Jim Ingham0161b492013-02-09 01:29:05 +00005294 real_timeout = TimeValue::Now();
5295 real_timeout.OffsetWithMicroSeconds(500000);
5296
5297 got_event = listener.WaitForEvent(&real_timeout, event_sp);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005298
Jim Ingham0161b492013-02-09 01:29:05 +00005299 if (got_event)
Sean Callanana46ec452012-07-11 21:31:24 +00005300 {
Jim Ingham0161b492013-02-09 01:29:05 +00005301 stop_state = Process::ProcessEventData::GetStateFromEvent(event_sp.get());
5302 if (log)
Sean Callanana46ec452012-07-11 21:31:24 +00005303 {
Jim Ingham0161b492013-02-09 01:29:05 +00005304 log->Printf ("Process::RunThreadPlan(): Stopped with event: %s", StateAsCString(stop_state));
5305 if (stop_state == lldb::eStateStopped
5306 && Process::ProcessEventData::GetInterruptedFromEvent(event_sp.get()))
5307 log->PutCString (" Event was the Halt interruption event.");
Sean Callanana46ec452012-07-11 21:31:24 +00005308 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005309
Jim Ingham0161b492013-02-09 01:29:05 +00005310 if (stop_state == lldb::eStateStopped)
Sean Callanana46ec452012-07-11 21:31:24 +00005311 {
Jim Ingham0161b492013-02-09 01:29:05 +00005312 // Between the time we initiated the Halt and the time we delivered it, the process could have
5313 // already finished its job. Check that here:
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005314
Jim Ingham0161b492013-02-09 01:29:05 +00005315 if (thread->IsThreadPlanDone (thread_plan_sp.get()))
5316 {
5317 if (log)
5318 log->PutCString ("Process::RunThreadPlan(): Even though we timed out, the call plan was done. "
5319 "Exiting wait loop.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005320 return_value = eExpressionCompleted;
Jim Ingham0161b492013-02-09 01:29:05 +00005321 back_to_top = false;
5322 break;
5323 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005324
Jim Ingham0161b492013-02-09 01:29:05 +00005325 if (Process::ProcessEventData::GetRestartedFromEvent(event_sp.get()))
5326 {
5327 if (log)
5328 log->PutCString ("Process::RunThreadPlan(): Went to halt but got a restarted event, there must be an un-restarted stopped event so try again... "
5329 "Exiting wait loop.");
5330 try_halt_again++;
5331 do_halt = false;
5332 continue;
5333 }
Sean Callanana46ec452012-07-11 21:31:24 +00005334
Jim Ingham6fbc48b2013-11-07 00:11:47 +00005335 if (!options.GetTryAllThreads())
Jim Ingham0161b492013-02-09 01:29:05 +00005336 {
5337 if (log)
5338 log->PutCString ("Process::RunThreadPlan(): try_all_threads was false, we stopped so now we're quitting.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005339 return_value = eExpressionInterrupted;
Jim Ingham0161b492013-02-09 01:29:05 +00005340 back_to_top = false;
5341 break;
5342 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005343
Jim Ingham0161b492013-02-09 01:29:05 +00005344 if (before_first_timeout)
5345 {
5346 // Set all the other threads to run, and return to the top of the loop, which will continue;
5347 before_first_timeout = false;
5348 thread_plan_sp->SetStopOthers (false);
5349 if (log)
5350 log->PutCString ("Process::RunThreadPlan(): about to resume.");
Sean Callanana46ec452012-07-11 21:31:24 +00005351
Jim Ingham0161b492013-02-09 01:29:05 +00005352 back_to_top = true;
5353 break;
5354 }
5355 else
5356 {
5357 // Running all threads failed, so return Interrupted.
5358 if (log)
5359 log->PutCString("Process::RunThreadPlan(): running all threads timed out.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005360 return_value = eExpressionInterrupted;
Jim Ingham0161b492013-02-09 01:29:05 +00005361 back_to_top = false;
5362 break;
5363 }
Sean Callanana46ec452012-07-11 21:31:24 +00005364 }
5365 }
5366 else
Jim Ingham0161b492013-02-09 01:29:05 +00005367 { if (log)
5368 log->PutCString("Process::RunThreadPlan(): halt said it succeeded, but I got no event. "
5369 "I'm getting out of here passing Interrupted.");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005370 return_value = eExpressionInterrupted;
Jim Ingham0161b492013-02-09 01:29:05 +00005371 back_to_top = false;
5372 break;
Sean Callanana46ec452012-07-11 21:31:24 +00005373 }
5374 }
Jim Ingham0161b492013-02-09 01:29:05 +00005375 else
5376 {
5377 try_halt_again++;
5378 continue;
5379 }
Sean Callanana46ec452012-07-11 21:31:24 +00005380 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005381
Jim Ingham0161b492013-02-09 01:29:05 +00005382 if (!back_to_top || try_halt_again > num_retries)
5383 break;
5384 else
5385 continue;
Sean Callanana46ec452012-07-11 21:31:24 +00005386 }
Sean Callanana46ec452012-07-11 21:31:24 +00005387 } // END WAIT LOOP
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005388
Sean Callanana46ec452012-07-11 21:31:24 +00005389 // If we had to start up a temporary private state thread to run this thread plan, shut it down now.
5390 if (IS_VALID_LLDB_HOST_THREAD(backup_private_state_thread))
5391 {
5392 StopPrivateStateThread();
5393 Error error;
5394 m_private_state_thread = backup_private_state_thread;
Sean Callanan9a028512012-08-09 00:50:26 +00005395 if (stopper_base_plan_sp)
Sean Callanana46ec452012-07-11 21:31:24 +00005396 {
5397 thread->DiscardThreadPlansUpToPlan(stopper_base_plan_sp);
5398 }
5399 m_public_state.SetValueNoLock(old_state);
5400
5401 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005402
Jim Ingham184e9812013-01-15 02:47:48 +00005403 // Restore the thread state if we are going to discard the plan execution. There are three cases where this
5404 // could happen:
5405 // 1) The execution successfully completed
5406 // 2) We hit a breakpoint, and ignore_breakpoints was true
5407 // 3) We got some other error, and discard_on_error was true
Jim Ingham8646d3c2014-05-05 02:47:44 +00005408 bool should_unwind = (return_value == eExpressionInterrupted && options.DoesUnwindOnError())
5409 || (return_value == eExpressionHitBreakpoint && options.DoesIgnoreBreakpoints());
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005410
Jim Ingham8646d3c2014-05-05 02:47:44 +00005411 if (return_value == eExpressionCompleted
Jim Ingham184e9812013-01-15 02:47:48 +00005412 || should_unwind)
Jim Ingham8559a352012-11-26 23:52:18 +00005413 {
5414 thread_plan_sp->RestoreThreadState();
5415 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005416
Sean Callanana46ec452012-07-11 21:31:24 +00005417 // Now do some processing on the results of the run:
Jim Ingham8646d3c2014-05-05 02:47:44 +00005418 if (return_value == eExpressionInterrupted || return_value == eExpressionHitBreakpoint)
Sean Callanana46ec452012-07-11 21:31:24 +00005419 {
5420 if (log)
5421 {
5422 StreamString s;
5423 if (event_sp)
5424 event_sp->Dump (&s);
5425 else
5426 {
5427 log->PutCString ("Process::RunThreadPlan(): Stop event that interrupted us is NULL.");
5428 }
5429
5430 StreamString ts;
5431
5432 const char *event_explanation = NULL;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005433
Sean Callanana46ec452012-07-11 21:31:24 +00005434 do
5435 {
Jim Inghamcfc09352012-07-27 23:57:19 +00005436 if (!event_sp)
Sean Callanana46ec452012-07-11 21:31:24 +00005437 {
Jim Inghamcfc09352012-07-27 23:57:19 +00005438 event_explanation = "<no event>";
Sean Callanana46ec452012-07-11 21:31:24 +00005439 break;
5440 }
Jim Inghamcfc09352012-07-27 23:57:19 +00005441 else if (event_sp->GetType() == eBroadcastBitInterrupt)
Sean Callanana46ec452012-07-11 21:31:24 +00005442 {
Jim Inghamcfc09352012-07-27 23:57:19 +00005443 event_explanation = "<user interrupt>";
Sean Callanana46ec452012-07-11 21:31:24 +00005444 break;
5445 }
Jim Inghamcfc09352012-07-27 23:57:19 +00005446 else
Sean Callanana46ec452012-07-11 21:31:24 +00005447 {
Jim Inghamcfc09352012-07-27 23:57:19 +00005448 const Process::ProcessEventData *event_data = Process::ProcessEventData::GetEventDataFromEvent (event_sp.get());
5449
5450 if (!event_data)
Sean Callanana46ec452012-07-11 21:31:24 +00005451 {
Jim Inghamcfc09352012-07-27 23:57:19 +00005452 event_explanation = "<no event data>";
5453 break;
Sean Callanana46ec452012-07-11 21:31:24 +00005454 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005455
Jim Inghamcfc09352012-07-27 23:57:19 +00005456 Process *process = event_data->GetProcessSP().get();
5457
5458 if (!process)
Sean Callanana46ec452012-07-11 21:31:24 +00005459 {
Jim Inghamcfc09352012-07-27 23:57:19 +00005460 event_explanation = "<no process>";
5461 break;
Sean Callanana46ec452012-07-11 21:31:24 +00005462 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005463
Jim Inghamcfc09352012-07-27 23:57:19 +00005464 ThreadList &thread_list = process->GetThreadList();
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005465
Jim Inghamcfc09352012-07-27 23:57:19 +00005466 uint32_t num_threads = thread_list.GetSize();
5467 uint32_t thread_index;
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005468
Jim Inghamcfc09352012-07-27 23:57:19 +00005469 ts.Printf("<%u threads> ", num_threads);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005470
Jim Inghamcfc09352012-07-27 23:57:19 +00005471 for (thread_index = 0;
5472 thread_index < num_threads;
5473 ++thread_index)
5474 {
5475 Thread *thread = thread_list.GetThreadAtIndex(thread_index).get();
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005476
Jim Inghamcfc09352012-07-27 23:57:19 +00005477 if (!thread)
5478 {
5479 ts.Printf("<?> ");
5480 continue;
5481 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005482
Daniel Malead01b2952012-11-29 21:49:15 +00005483 ts.Printf("<0x%4.4" PRIx64 " ", thread->GetID());
Jim Inghamcfc09352012-07-27 23:57:19 +00005484 RegisterContext *register_context = thread->GetRegisterContext().get();
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005485
Jim Inghamcfc09352012-07-27 23:57:19 +00005486 if (register_context)
Daniel Malead01b2952012-11-29 21:49:15 +00005487 ts.Printf("[ip 0x%" PRIx64 "] ", register_context->GetPC());
Jim Inghamcfc09352012-07-27 23:57:19 +00005488 else
5489 ts.Printf("[ip unknown] ");
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005490
Jim Inghamcfc09352012-07-27 23:57:19 +00005491 lldb::StopInfoSP stop_info_sp = thread->GetStopInfo();
5492 if (stop_info_sp)
5493 {
5494 const char *stop_desc = stop_info_sp->GetDescription();
5495 if (stop_desc)
5496 ts.PutCString (stop_desc);
5497 }
5498 ts.Printf(">");
5499 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005500
Jim Inghamcfc09352012-07-27 23:57:19 +00005501 event_explanation = ts.GetData();
Sean Callanana46ec452012-07-11 21:31:24 +00005502 }
Sean Callanana46ec452012-07-11 21:31:24 +00005503 } while (0);
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005504
Jim Inghamcfc09352012-07-27 23:57:19 +00005505 if (event_explanation)
5506 log->Printf("Process::RunThreadPlan(): execution interrupted: %s %s", s.GetData(), event_explanation);
Sean Callanana46ec452012-07-11 21:31:24 +00005507 else
Jim Inghamcfc09352012-07-27 23:57:19 +00005508 log->Printf("Process::RunThreadPlan(): execution interrupted: %s", s.GetData());
5509 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005510
Jim Inghame4483cf2013-09-27 01:13:01 +00005511 if (should_unwind)
Jim Inghamcfc09352012-07-27 23:57:19 +00005512 {
5513 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005514 log->Printf ("Process::RunThreadPlan: ExecutionInterrupted - discarding thread plans up to %p.",
5515 static_cast<void*>(thread_plan_sp.get()));
Jim Inghamcfc09352012-07-27 23:57:19 +00005516 thread->DiscardThreadPlansUpToPlan (thread_plan_sp);
5517 thread_plan_sp->SetPrivate (orig_plan_private);
5518 }
5519 else
5520 {
5521 if (log)
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005522 log->Printf ("Process::RunThreadPlan: ExecutionInterrupted - for plan: %p not discarding.",
5523 static_cast<void*>(thread_plan_sp.get()));
Sean Callanana46ec452012-07-11 21:31:24 +00005524 }
5525 }
Jim Ingham8646d3c2014-05-05 02:47:44 +00005526 else if (return_value == eExpressionSetupError)
Sean Callanana46ec452012-07-11 21:31:24 +00005527 {
5528 if (log)
5529 log->PutCString("Process::RunThreadPlan(): execution set up error.");
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005530
Jim Ingham6fbc48b2013-11-07 00:11:47 +00005531 if (options.DoesUnwindOnError())
Jim Ingham0f16e732011-02-08 05:20:59 +00005532 {
Greg Claytonc14ee322011-09-22 04:58:26 +00005533 thread->DiscardThreadPlansUpToPlan (thread_plan_sp);
Jim Ingham4b536182011-08-09 02:12:22 +00005534 thread_plan_sp->SetPrivate (orig_plan_private);
Jim Ingham0f16e732011-02-08 05:20:59 +00005535 }
Jim Inghamf48169b2010-11-30 02:22:11 +00005536 }
5537 else
5538 {
Sean Callanana46ec452012-07-11 21:31:24 +00005539 if (thread->IsThreadPlanDone (thread_plan_sp.get()))
Jim Inghamf48169b2010-11-30 02:22:11 +00005540 {
Jim Ingham0f16e732011-02-08 05:20:59 +00005541 if (log)
Sean Callanana46ec452012-07-11 21:31:24 +00005542 log->PutCString("Process::RunThreadPlan(): thread plan is done");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005543 return_value = eExpressionCompleted;
Sean Callanana46ec452012-07-11 21:31:24 +00005544 }
5545 else if (thread->WasThreadPlanDiscarded (thread_plan_sp.get()))
5546 {
5547 if (log)
5548 log->PutCString("Process::RunThreadPlan(): thread plan was discarded");
Jim Ingham8646d3c2014-05-05 02:47:44 +00005549 return_value = eExpressionDiscarded;
Sean Callanana46ec452012-07-11 21:31:24 +00005550 }
5551 else
5552 {
5553 if (log)
5554 log->PutCString("Process::RunThreadPlan(): thread plan stopped in mid course");
Jim Ingham6fbc48b2013-11-07 00:11:47 +00005555 if (options.DoesUnwindOnError() && thread_plan_sp)
Sean Callanana46ec452012-07-11 21:31:24 +00005556 {
5557 if (log)
Jim Ingham184e9812013-01-15 02:47:48 +00005558 log->PutCString("Process::RunThreadPlan(): discarding thread plan 'cause unwind_on_error is set.");
Sean Callanana46ec452012-07-11 21:31:24 +00005559 thread->DiscardThreadPlansUpToPlan (thread_plan_sp);
5560 thread_plan_sp->SetPrivate (orig_plan_private);
5561 }
5562 }
5563 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005564
Sean Callanana46ec452012-07-11 21:31:24 +00005565 // Thread we ran the function in may have gone away because we ran the target
5566 // Check that it's still there, and if it is put it back in the context. Also restore the
5567 // frame in the context if it is still present.
5568 thread = GetThreadList().FindThreadByIndexID(thread_idx_id, true).get();
5569 if (thread)
5570 {
5571 exe_ctx.SetFrameSP (thread->GetFrameWithStackID (ctx_frame_id));
5572 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005573
Sean Callanana46ec452012-07-11 21:31:24 +00005574 // Also restore the current process'es selected frame & thread, since this function calling may
5575 // be done behind the user's back.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005576
Sean Callanana46ec452012-07-11 21:31:24 +00005577 if (selected_tid != LLDB_INVALID_THREAD_ID)
5578 {
5579 if (GetThreadList().SetSelectedThreadByIndexID (selected_tid) && selected_stack_id.IsValid())
5580 {
5581 // We were able to restore the selected thread, now restore the frame:
Daniel Maleaa012d3a2013-07-31 20:21:20 +00005582 Mutex::Locker lock(GetThreadList().GetMutex());
Jason Molendab57e4a12013-11-04 09:33:30 +00005583 StackFrameSP old_frame_sp = GetThreadList().GetSelectedThread()->GetFrameWithStackID(selected_stack_id);
Sean Callanana46ec452012-07-11 21:31:24 +00005584 if (old_frame_sp)
5585 GetThreadList().GetSelectedThread()->SetSelectedFrame(old_frame_sp.get());
Jim Inghamf48169b2010-11-30 02:22:11 +00005586 }
Jim Inghamf48169b2010-11-30 02:22:11 +00005587 }
5588 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005589
Sean Callanana46ec452012-07-11 21:31:24 +00005590 // If the process exited during the run of the thread plan, notify everyone.
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005591
Sean Callanana46ec452012-07-11 21:31:24 +00005592 if (event_to_broadcast_sp)
Jim Inghamf48169b2010-11-30 02:22:11 +00005593 {
Sean Callanana46ec452012-07-11 21:31:24 +00005594 if (log)
5595 log->PutCString("Process::RunThreadPlan(): rebroadcasting event.");
5596 BroadcastEvent(event_to_broadcast_sp);
Jim Inghamf48169b2010-11-30 02:22:11 +00005597 }
Saleem Abdulrasool324a1032014-04-04 04:06:10 +00005598
Jim Inghamf48169b2010-11-30 02:22:11 +00005599 return return_value;
5600}
5601
5602const char *
Jim Ingham1624a2d2014-05-05 02:26:40 +00005603Process::ExecutionResultAsCString (ExpressionResults result)
Jim Inghamf48169b2010-11-30 02:22:11 +00005604{
5605 const char *result_name;
5606
5607 switch (result)
5608 {
Jim Ingham8646d3c2014-05-05 02:47:44 +00005609 case eExpressionCompleted:
5610 result_name = "eExpressionCompleted";
Jim Inghamf48169b2010-11-30 02:22:11 +00005611 break;
Jim Ingham8646d3c2014-05-05 02:47:44 +00005612 case eExpressionDiscarded:
5613 result_name = "eExpressionDiscarded";
Jim Inghamf48169b2010-11-30 02:22:11 +00005614 break;
Jim Ingham8646d3c2014-05-05 02:47:44 +00005615 case eExpressionInterrupted:
5616 result_name = "eExpressionInterrupted";
Jim Inghamf48169b2010-11-30 02:22:11 +00005617 break;
Jim Ingham8646d3c2014-05-05 02:47:44 +00005618 case eExpressionHitBreakpoint:
5619 result_name = "eExpressionHitBreakpoint";
Jim Ingham184e9812013-01-15 02:47:48 +00005620 break;
Jim Ingham8646d3c2014-05-05 02:47:44 +00005621 case eExpressionSetupError:
5622 result_name = "eExpressionSetupError";
Jim Inghamf48169b2010-11-30 02:22:11 +00005623 break;
Jim Ingham8646d3c2014-05-05 02:47:44 +00005624 case eExpressionParseError:
5625 result_name = "eExpressionParseError";
Jim Ingham1624a2d2014-05-05 02:26:40 +00005626 break;
Jim Ingham8646d3c2014-05-05 02:47:44 +00005627 case eExpressionResultUnavailable:
5628 result_name = "eExpressionResultUnavailable";
Jim Ingham1624a2d2014-05-05 02:26:40 +00005629 break;
Jim Ingham8646d3c2014-05-05 02:47:44 +00005630 case eExpressionTimedOut:
5631 result_name = "eExpressionTimedOut";
Jim Inghamf48169b2010-11-30 02:22:11 +00005632 break;
Jim Ingham8646d3c2014-05-05 02:47:44 +00005633 case eExpressionStoppedForDebug:
5634 result_name = "eExpressionStoppedForDebug";
Jim Ingham6fbc48b2013-11-07 00:11:47 +00005635 break;
Jim Inghamf48169b2010-11-30 02:22:11 +00005636 }
5637 return result_name;
5638}
5639
Greg Clayton7260f622011-04-18 08:33:37 +00005640void
5641Process::GetStatus (Stream &strm)
5642{
5643 const StateType state = GetState();
Greg Clayton2637f822011-11-17 01:23:07 +00005644 if (StateIsStoppedState(state, false))
Greg Clayton7260f622011-04-18 08:33:37 +00005645 {
5646 if (state == eStateExited)
5647 {
5648 int exit_status = GetExitStatus();
5649 const char *exit_description = GetExitDescription();
Daniel Malead01b2952012-11-29 21:49:15 +00005650 strm.Printf ("Process %" PRIu64 " exited with status = %i (0x%8.8x) %s\n",
Greg Clayton7260f622011-04-18 08:33:37 +00005651 GetID(),
5652 exit_status,
5653 exit_status,
5654 exit_description ? exit_description : "");
5655 }
5656 else
5657 {
5658 if (state == eStateConnected)
5659 strm.Printf ("Connected to remote target.\n");
5660 else
Daniel Malead01b2952012-11-29 21:49:15 +00005661 strm.Printf ("Process %" PRIu64 " %s\n", GetID(), StateAsCString (state));
Greg Clayton7260f622011-04-18 08:33:37 +00005662 }
5663 }
5664 else
5665 {
Daniel Malead01b2952012-11-29 21:49:15 +00005666 strm.Printf ("Process %" PRIu64 " is running.\n", GetID());
Greg Clayton7260f622011-04-18 08:33:37 +00005667 }
5668}
5669
5670size_t
5671Process::GetThreadStatus (Stream &strm,
5672 bool only_threads_with_stop_reason,
5673 uint32_t start_frame,
5674 uint32_t num_frames,
5675 uint32_t num_frames_with_source)
5676{
5677 size_t num_thread_infos_dumped = 0;
5678
Jim Ingham4a65fb12014-03-07 11:20:03 +00005679 // You can't hold the thread list lock while calling Thread::GetStatus. That very well might run code (e.g. if we need it
5680 // to get return values or arguments.) For that to work the process has to be able to acquire it. So instead copy the thread
5681 // ID's, and look them up one by one:
5682
5683 uint32_t num_threads;
5684 std::vector<uint32_t> thread_index_array;
5685 //Scope for thread list locker;
5686 {
5687 Mutex::Locker locker (GetThreadList().GetMutex());
5688 ThreadList &curr_thread_list = GetThreadList();
5689 num_threads = curr_thread_list.GetSize();
5690 uint32_t idx;
5691 thread_index_array.resize(num_threads);
5692 for (idx = 0; idx < num_threads; ++idx)
5693 thread_index_array[idx] = curr_thread_list.GetThreadAtIndex(idx)->GetID();
5694 }
5695
Greg Clayton7260f622011-04-18 08:33:37 +00005696 for (uint32_t i = 0; i < num_threads; i++)
5697 {
Jim Ingham4a65fb12014-03-07 11:20:03 +00005698 ThreadSP thread_sp(GetThreadList().FindThreadByID(thread_index_array[i]));
5699 if (thread_sp)
Greg Clayton7260f622011-04-18 08:33:37 +00005700 {
5701 if (only_threads_with_stop_reason)
5702 {
Jim Ingham4a65fb12014-03-07 11:20:03 +00005703 StopInfoSP stop_info_sp = thread_sp->GetStopInfo();
Jim Ingham5d88a062012-10-16 00:09:33 +00005704 if (stop_info_sp.get() == NULL || !stop_info_sp->IsValid())
Greg Clayton7260f622011-04-18 08:33:37 +00005705 continue;
5706 }
Jim Ingham4a65fb12014-03-07 11:20:03 +00005707 thread_sp->GetStatus (strm,
Greg Clayton7260f622011-04-18 08:33:37 +00005708 start_frame,
5709 num_frames,
5710 num_frames_with_source);
5711 ++num_thread_infos_dumped;
5712 }
Jim Ingham4a65fb12014-03-07 11:20:03 +00005713 else
5714 {
5715 Log *log(lldb_private::GetLogIfAnyCategoriesSet (LIBLLDB_LOG_PROCESS));
5716 if (log)
5717 log->Printf("Process::GetThreadStatus - thread 0x" PRIu64 " vanished while running Thread::GetStatus.");
5718
5719 }
Greg Clayton7260f622011-04-18 08:33:37 +00005720 }
5721 return num_thread_infos_dumped;
5722}
5723
Greg Claytona9f40ad2012-02-22 04:37:26 +00005724void
5725Process::AddInvalidMemoryRegion (const LoadRange &region)
5726{
5727 m_memory_cache.AddInvalidRange(region.GetRangeBase(), region.GetByteSize());
5728}
5729
5730bool
5731Process::RemoveInvalidMemoryRange (const LoadRange &region)
5732{
5733 return m_memory_cache.RemoveInvalidRange(region.GetRangeBase(), region.GetByteSize());
5734}
5735
Jim Ingham372787f2012-04-07 00:00:41 +00005736void
5737Process::AddPreResumeAction (PreResumeActionCallback callback, void *baton)
5738{
5739 m_pre_resume_actions.push_back(PreResumeCallbackAndBaton (callback, baton));
5740}
5741
5742bool
5743Process::RunPreResumeActions ()
5744{
5745 bool result = true;
5746 while (!m_pre_resume_actions.empty())
5747 {
5748 struct PreResumeCallbackAndBaton action = m_pre_resume_actions.back();
5749 m_pre_resume_actions.pop_back();
5750 bool this_result = action.callback (action.baton);
5751 if (result == true) result = this_result;
5752 }
5753 return result;
5754}
5755
5756void
5757Process::ClearPreResumeActions ()
5758{
5759 m_pre_resume_actions.clear();
5760}
Greg Claytona9f40ad2012-02-22 04:37:26 +00005761
Greg Claytonfa559e52012-05-18 02:38:05 +00005762void
5763Process::Flush ()
5764{
5765 m_thread_list.Flush();
Jason Molenda5e8dce42013-12-13 00:29:16 +00005766 m_extended_thread_list.Flush();
5767 m_extended_thread_stop_id = 0;
5768 m_queue_list.Clear();
5769 m_queue_list_stop_id = 0;
Greg Claytonfa559e52012-05-18 02:38:05 +00005770}
Greg Clayton90ba8112012-12-05 00:16:59 +00005771
5772void
5773Process::DidExec ()
5774{
5775 Target &target = GetTarget();
5776 target.CleanupProcess ();
Greg Claytonb35db632013-11-09 00:03:31 +00005777 target.ClearModules(false);
Greg Clayton90ba8112012-12-05 00:16:59 +00005778 m_dynamic_checkers_ap.reset();
5779 m_abi_sp.reset();
Jason Molendaeef51062013-11-05 03:57:19 +00005780 m_system_runtime_ap.reset();
Greg Clayton90ba8112012-12-05 00:16:59 +00005781 m_os_ap.reset();
Greg Clayton15fc2be2013-05-21 01:00:52 +00005782 m_dyld_ap.reset();
Andrew MacPherson17220c12014-03-05 10:12:43 +00005783 m_jit_loaders_ap.reset();
Greg Clayton90ba8112012-12-05 00:16:59 +00005784 m_image_tokens.clear();
5785 m_allocated_memory_cache.Clear();
5786 m_language_runtimes.clear();
Greg Clayton15fc2be2013-05-21 01:00:52 +00005787 m_thread_list.DiscardThreadPlans();
Greg Clayton15fc2be2013-05-21 01:00:52 +00005788 m_memory_cache.Clear(true);
Greg Clayton90ba8112012-12-05 00:16:59 +00005789 DoDidExec();
5790 CompleteAttach ();
Greg Clayton095eeaa2013-11-05 23:28:00 +00005791 // Flush the process (threads and all stack frames) after running CompleteAttach()
5792 // in case the dynamic loader loaded things in new locations.
5793 Flush();
Greg Claytonb35db632013-11-09 00:03:31 +00005794
5795 // After we figure out what was loaded/unloaded in CompleteAttach,
5796 // we need to let the target know so it can do any cleanup it needs to.
5797 target.DidExec();
Greg Clayton90ba8112012-12-05 00:16:59 +00005798}
Greg Clayton095eeaa2013-11-05 23:28:00 +00005799
Jim Ingham1460e4b2014-01-10 23:46:59 +00005800addr_t
5801Process::ResolveIndirectFunction(const Address *address, Error &error)
5802{
5803 if (address == nullptr)
5804 {
Jean-Daniel Dupasef37711f2014-02-08 20:22:05 +00005805 error.SetErrorString("Invalid address argument");
Jim Ingham1460e4b2014-01-10 23:46:59 +00005806 return LLDB_INVALID_ADDRESS;
5807 }
5808
5809 addr_t function_addr = LLDB_INVALID_ADDRESS;
5810
5811 addr_t addr = address->GetLoadAddress(&GetTarget());
5812 std::map<addr_t,addr_t>::const_iterator iter = m_resolved_indirect_addresses.find(addr);
5813 if (iter != m_resolved_indirect_addresses.end())
5814 {
5815 function_addr = (*iter).second;
5816 }
5817 else
5818 {
5819 if (!InferiorCall(this, address, function_addr))
5820 {
5821 Symbol *symbol = address->CalculateSymbolContextSymbol();
5822 error.SetErrorStringWithFormat ("Unable to call resolver for indirect function %s",
5823 symbol ? symbol->GetName().AsCString() : "<UNKNOWN>");
5824 function_addr = LLDB_INVALID_ADDRESS;
5825 }
5826 else
5827 {
5828 m_resolved_indirect_addresses.insert(std::pair<addr_t, addr_t>(addr, function_addr));
5829 }
5830 }
5831 return function_addr;
5832}
5833
Andrew MacPhersoneb4d0602014-03-13 09:37:02 +00005834void
5835Process::ModulesDidLoad (ModuleList &module_list)
5836{
5837 SystemRuntime *sys_runtime = GetSystemRuntime();
5838 if (sys_runtime)
5839 {
5840 sys_runtime->ModulesDidLoad (module_list);
5841 }
5842
5843 GetJITLoaders().ModulesDidLoad (module_list);
5844}